create_tests 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adf779b9d966308976925449218e2f71071441bc665a7c5ecdd79c9ec25c477e
-  data.tar.gz: 49cd07ebd23c1dd406ee5db3af61c3a761615ecec746c451d059717ad8a668dd
+  metadata.gz: 4ca29473a6da1f495ae3bb61fc97638c049f03a7e7093f54db1ac5a1e602b97b
+  data.tar.gz: 829f1a5085c49bc9339095d6fbb9d6f603f6badaa0691f9344e8c0f173ca58f1
 SHA512:
-  metadata.gz: 948a204d7595c2b5e5ddbd42e18029b870f0fd9212df3a20dd970b29416d69306332b2f31ecd57fc9b82d8a1ad3b6e15424312248a5c80d26f9ae0ca14e90f00
-  data.tar.gz: 9510e4c3f35eba997841db074bd32b8ef07712bacd88cda7bb49581deea70d1381148d833e3791c5b3c8b21a2d7259fb2fffacfae157dfd15080ad46ca9e5d9c
+  metadata.gz: 99a571060b7ab3971fff6ee6b0e8c67db21df52cc0ae00dbc57da0a26517aa94c8b63e8e606926bccb07a83c7d92e5f2a639495daf0c530f6bc6fe5b2189abfb
+  data.tar.gz: 785a8211a25f007e77b961868208081065b0f04e4d962382aa4b644acb757a6f6fc37b9c48e06b032e637906dcebac7127fabdfb0599a44e2719d65811bb7a3d

data/README.md

@@ -75,7 +75,7 @@ CreateTests.from "./requests/uber.yaml.rb"
 
 For each API endpoint, `create_tests` generates up to 7 test types:
 
-1. **"has correct structure in successful response"** -- Calls the endpoint and validates the response structure using `NiceHttp.validate_response` with diff details on failure.
+1. **"has correct structure in successful response"** -- Calls the endpoint and validates the response structure using `NiceHttp.validate_response` with diff details on failure. The expected status is the first 2xx response key, else `default`, else the first key. When `:data_default` is present, missing (or nil) keys in `:data` are filled before the call; existing example values are not overwritten.
 
 2. **"doesn't retrieve data if not authenticated"** -- Calls with empty headers and asserts a 4xx response.
 
@@ -85,9 +85,9 @@ For each API endpoint, `create_tests` generates up to 7 test types:
 
 5. **"handles multiple valid data variations"** -- For POST/PUT/PATCH endpoints with a payload source, uses `generate_n(5, :correct)` from nice_hash to test 5 different valid payload variations. Prefers `:data_pattern` when present (real string_pattern / enum / range values from open_api_import); otherwise uses `:data`. Generated values are assigned to `request[:data]` before the call.
 
-6. **"returns error when individual data fields are invalid"** -- Uses `NiceHash.change_one_by_one` on `:data_pattern` (preferred) or `:data` to systematically test each field being wrong one at a time, asserting the server rejects each one.
+6. **"returns error when individual data fields are invalid"** -- Uses `NiceHash.change_one_by_one` on `:data_pattern` (preferred) or `:data` to systematically test each field being wrong one at a time, asserting the server rejects each one. Fields listed in `:data_read_only` are skipped.
 
-7. **"returns error if required parameter on data empty/missing"** -- For endpoints with `data_required`, tests both empty and missing values for each required data field. When `:data` is absent but `:data_examples` is present (common for form uploads), the first example is used as the body for success and required-data tests.
+7. **"returns error if required parameter on data empty/missing"** -- For endpoints with `data_required`, tests both empty and missing values for each required data field. When `:data` is absent but `:data_examples` is present (common for form uploads), the first example is used as the body for success and required-data tests. Otherwise `:data_default` can seed missing body fields the same way as the success example.
 
 Required keyword parameters from open_api_import `create_constants: true` (e.g. `def self.get_item(id: ID)`) get Helper stubs and are called as keywords (`id: @id`), same as positional required args.
 

data/lib/create-tests/create_test.rb

@@ -149,6 +149,16 @@ class CreateTests
       has_data_examples = request.key?(:data_examples) &&
                           request[:data_examples].is_a?(Array) &&
                           !request[:data_examples].empty?
+      has_data_default = request.key?(:data_default) &&
+                         request[:data_default].is_a?(Hash) &&
+                         !request[:data_default].empty?
+      # Prefer data_examples over defaults when :data is absent
+      apply_data_default = has_data_default && (request.key?(:data) || !has_data_examples)
+      apply_defaults_txt = if apply_data_default
+                             "@request[:data] ||= {}\n                @request[:data_default].each do |k, v|\n                  @request[:data][k] = v if !@request[:data].key?(k) || @request[:data][k].nil?\n                end\n                "
+                           else
+                             ""
+                           end
       # Prefer data_pattern for variation/invalid-field tests; fall back to :data
       payload_source = if request.key?(:data_pattern)
                          ":data_pattern"
@@ -156,16 +166,17 @@ class CreateTests
                          ":data"
                        end
 
-      # first response on responses is the one expected to be returned when success
+      # Success code: first 2xx key, else "default", else first key
       if include_kind?(only_kinds, :success) && request.key?(:responses) and request[:responses].size > 0
-        code = request[:responses].keys[0]
+        code = success_response_code(request[:responses])
+        code_src = format_response_code(code)
         title = example_title("has correct structure in successful response", test, trailing_space: true)
         if !request.key?(:data) && has_data_examples
           tests[title] = "do
                 request = @request.deep_copy
                 request[:data] = @request[:data_examples].first
                 resp = @http.#{request[:method]}(request)
-                #{assert_eq('resp.code', code, test)}\n"
+                #{assert_eq('resp.code', code_src, test)}\n"
           if request[:responses][code].is_a?(Hash) and request[:responses][code].key?(:data)
             tests[title] +="result = NiceHttp.validate_response(resp, @request.responses._#{code}.data, include_diff: true)\n"
             tests[title] += "#{assert_be_true('result[:ok]', 'Structure mismatch: #{result[:diff]}', test)}\n"
@@ -173,8 +184,8 @@ class CreateTests
           tests[title] += "end\n"
         else
           tests[title] = "do
-                resp = @http.#{request[:method]}(@request)
-                #{assert_eq('resp.code', code, test)}\n"
+                #{apply_defaults_txt}resp = @http.#{request[:method]}(@request)
+                #{assert_eq('resp.code', code_src, test)}\n"
 
           if request[:responses][code].is_a?(Hash) and request[:responses][code].key?(:data)
             tests[title] +="result = NiceHttp.validate_response(resp, @request.responses._#{code}.data, include_diff: true)\n"
@@ -253,8 +264,20 @@ class CreateTests
       end
 
       if include_kind?(only_kinds, :invalid_fields) && payload_source
-        title = example_title("returns error when individual data fields are invalid", test, trailing_space: true)
-        tests[title] = "do
+        payload_key = payload_source == ":data_pattern" ? :data_pattern : :data
+        read_only_names = Array(request[:data_read_only]).map(&:to_s)
+        payload_for_invalid = request[payload_key]
+        if payload_for_invalid.is_a?(Hash) && !read_only_names.empty?
+          payload_for_invalid = payload_for_invalid.deep_copy
+          read_only_names.each do |name|
+            payload_for_invalid.delete(name.to_sym)
+            payload_for_invalid.delete(name)
+          end
+        end
+        unless payload_for_invalid.nil? || (payload_for_invalid.respond_to?(:empty?) && payload_for_invalid.empty?)
+          title = example_title("returns error when individual data fields are invalid", test, trailing_space: true)
+          if read_only_names.empty?
+            tests[title] = "do
                 wrong = @request[#{payload_source}].generate(:correct, errors: :min_length)
                 NiceHash.change_one_by_one([@request[#{payload_source}], :correct], wrong).each do |one_wrong|
                   request = @request.deep_copy
@@ -263,11 +286,32 @@ class CreateTests
                   #{assert_between('resp.code.to_i', '200', '299', test, negate: true)}
                 end
               end\n"
+          else
+            read_only_lit = request[:data_read_only].map(&:inspect).join(", ")
+            tests[title] = "do
+                payload = @request[#{payload_source}].deep_copy
+                [#{read_only_lit}].each do |f|
+                  payload.delete(f)
+                  payload.delete(f.to_s)
+                  payload.delete(f.to_s.to_sym)
+                end
+                wrong = payload.generate(:correct, errors: :min_length)
+                NiceHash.change_one_by_one([payload, :correct], wrong).each do |one_wrong|
+                  request = @request.deep_copy
+                  request[:data] = one_wrong
+                  resp = @http.#{request[:method]}(request)
+                  #{assert_between('resp.code.to_i', '200', '299', test, negate: true)}
+                end
+              end\n"
+          end
+        end
       end
 
-      if include_kind?(only_kinds, :required_data) && request.key?(:data_required) && (request.key?(:data) || has_data_examples)
+      if include_kind?(only_kinds, :required_data) && request.key?(:data_required) && (request.key?(:data) || has_data_examples || apply_data_default)
         seed_data_line = if !request.key?(:data) && has_data_examples
                            "request[:data] = request[:data_examples].first\n                  "
+                         elsif apply_data_default
+                           "request[:data] ||= {}\n                  request[:data_default].each do |k, v|\n                    request[:data][k] = v if !request[:data].key?(k) || request[:data][k].nil?\n                  end\n                  "
                          else
                            ""
                          end
@@ -334,6 +378,30 @@ class CreateTests
       return modified, output
     end
 
+    private def success_response_code(responses)
+      keys = responses.keys
+      twoxx = keys.find do |k|
+        n = k.to_s
+        n.match?(/\A\d+\z/) && (200..299).include?(n.to_i)
+      end
+      return twoxx if twoxx
+
+      default_key = keys.find { |k| k.to_s == "default" }
+      return default_key if default_key
+
+      keys[0]
+    end
+
+    # Numeric status codes stay unquoted (eq 200); non-numeric keys use inspect.
+    private def format_response_code(code)
+      s = code.to_s
+      if s.match?(/\A\d+\z/)
+        s
+      else
+        code.inspect
+      end
+    end
+
     private def normalize_only(only)
       return nil if only.nil?
       list = case only

data/lib/create-tests/version.rb

@@ -1,3 +1,3 @@
 class CreateTests
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: create_tests
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Mario Ruiz