fitting 2.18.2 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4939d5e53f11ac3b5f28fa3088b20acefd5613b3c7ea8b075917ce9fa5703acd
-  data.tar.gz: 694aadc94e89341395c72cf1f26baeb065f7e10f6d0a7e305f4190ddc3e50d22
+  metadata.gz: af3cbf8a5fa59f9d3f9e38008397af27d784ca682cbe9a25b33b17bf671cabc1
+  data.tar.gz: fbee4660c1c6e26e85420c76ea7c924fcc9aa5b0eadea53beacead3f3c00a44e
 SHA512:
-  metadata.gz: bd7f9bfe0f22b4110e304e80daf8f843d6eba3bdf32598767b6da1e294ff83867593402eaaaa9665649162789aa3485f64ee3af066688dec0af0e96edb52caf8
-  data.tar.gz: 4ebe7ebf8d3f629b66f0378016fbd99a42d9d9907e911fe754732cb0c25761ebfe16cb095b4b76d11f24261b1f5213a6800e433998f225fd20b6bf9d7c0974e6
+  metadata.gz: afdbc7965db9bd5dcfe8267ddbb69e6bddb1229baa66a6ed723a4fac7468a35ff1ec5766b6ef1f9ae511d5e08b10f72efaa60237fb29da2c174e172ff4b3b7f6
+  data.tar.gz: 2567a2ec55744422f59979b67cf94ff0deb32740ed69001f47c28634bf851a77df41c4a1499b9bc5f1365456cd483851dff44e9deedb0df31265386ba6470063

data/.rubocop.yml

@@ -13,27 +13,18 @@ Style/FrozenStringLiteralComment:
 Metrics/BlockLength:
   Enabled: false
 
-Style/CaseEquality:
-  Enabled: false
-
-Style/NilComparison:
-  Enabled: false
-
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 
-Lint/UnreachableCode:
-  Enabled: false
-
 Metrics/MethodLength:
-  Max: 50
+  Max: 60
 
 # FIXME
 Metrics/AbcSize:
   Max: 50
 
 Metrics/PerceivedComplexity:
-  Max: 20
+  Max: 30
 
 Metrics/CyclomaticComplexity:
   Max: 20

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change log
 
+### 3.0.2 - 2022-01-25
+
+* patch
+  * fix require
+
+### 3.0.1 - 2021-12-09
+
+* patch
+  * fix init prefixes
+
+### 3.0.0 - 2021-12-09
+
+* features
+  * update configuration
+  * support outgoing WebMock request
+
+### 2.18.3 - 2021-11-12
+
+* patch
+  * added print table console [#121](https://github.com/funbox/fitting/issues/121)
+
 ### 2.18.2 - 2021-11-09
 
 * patch

data/README.md

@@ -48,7 +48,9 @@ Also Swagger
 ```yaml
 prefixes:
   - name: /api/v1
-    openapi2_json_path: doc.json
+    type: openapi2
+    schema_paths:
+      - doc.json
 ```
 
 ### OpenAPI 3.0
@@ -57,7 +59,9 @@ Also OpenAPI
 ```yaml
 prefixes:
   - name: /api/v1
-    openapi3_yaml_path: doc.yaml
+    type: openapi3
+    schema_paths:
+      - doc.yaml
 ```
 
 ### API Blueprint
@@ -75,7 +79,9 @@ and then
 ```yaml
 prefixes:
   - name: /api/v1
-    drafter_yaml_path: doc.yaml
+    type: drafter
+    schema_paths:
+      - doc.yaml
 ```
 
 ### Tomograph
@@ -85,7 +91,9 @@ To use additional features of the pre-converted [tomograph](https://github.com/f
 ```yaml
 prefixes:
   - name: /api/v1
-    tomogram_json_path: doc.json
+    type: tomogram
+    schema_paths:
+      - doc.json
 ```
 
 ## Run
@@ -99,6 +107,11 @@ and then
 bundle e rake fitting:report
 ```
 
+Run tests by outgoing request first to get run artifacts
+```bash
+bundle e rake fitting_out:report
+```
+
 Console ouptut
 
 ```text
@@ -144,7 +157,9 @@ Setting the prefix name is optional. For example, you can do this:
 
 ```yaml
 prefixes:
-  - openapi2_json_path: doc.json
+  - type: openapi2
+    schema_paths:
+      - doc.json
 ```
 
 ## prefix skip
@@ -153,11 +168,36 @@ It is not necessary to immediately describe each prefix in detail, you can only
 ```yaml
 prefixes:
 - name: /api/v1
-  openapi2_json_path: doc.json
+  type: openapi2
+  schema_paths:
+    - doc.json
+- name: /api/v3
+  skip: true
+```
+
+For work with WebMock outgoing request, you should set up outgoing prefixes
+```yaml
+outgoing_prefixes:
+- name: /api/v1
+  type: openapi2
+  schema_paths:
+    - doc.json
 - name: /api/v3
   skip: true
 ```
 
+You can choose location that must be teste
+
+```yaml
+prefixes:
+  - type: openapi2
+    schema_paths:
+      - doc.json
+    only:
+      - POST /api/v1/users
+      - GET /api/v1/user/{id}
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [github.com/funbox/fitting](https://github.com/funbox/fitting).

data/fitting.gemspec

@@ -20,11 +20,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6.0'
   spec.add_runtime_dependency 'json-schema', '~> 2.6', '>= 2.6.2'
+  spec.add_runtime_dependency 'terminal-table', '~> 3.0', '>= 3.0.2'
   spec.add_runtime_dependency 'tomograph', '~> 3.1', '>= 3.1.0'
+
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.22.0'
+  spec.add_development_dependency 'rubocop', '>= 1.22.0'
   spec.add_development_dependency 'simplecov', '~> 0.21'
 end

data/lib/fitting/configuration.rb

@@ -1,11 +1,17 @@
-require 'fitting/configuration/yaml'
-require 'yaml'
-
 module Fitting
   class Configuration
-    def self.craft
-      yaml = YAML.safe_load(File.read('.fitting.yml'))
-      Fitting::Configuration::Yaml.new(yaml)
+    attr_accessor :rspec_json_path,
+                  :webmock_json_path,
+                  :fitting_report_path,
+                  :prefixes,
+                  :outgoing_prefixes
+
+    def initialize(config)
+      @rspec_json_path = config['rspec_json_path'] || './fitting_tests'
+      @fitting_report_path = config['fitting_report_path'] || './fitting'
+      @prefixes = config['prefixes'] || []
+      @webmock_json_path = config['webmock_json_path'] || './outgoing_request_tests'
+      @outgoing_prefixes = config['outgoing_prefixes'] || []
     end
   end
 end

data/lib/fitting/cover/json_schema.rb

@@ -1,14 +1,16 @@
 module Fitting
   class Cover
     class JSONSchema
+      attr_reader :json_schema, :combinations
+
       def initialize(json_schema)
         @json_schema = json_schema
         @combinations = []
       end
 
       def combi
-        inception(@json_schema, @combinations).each do |combination|
-          combination[0] = @json_schema.merge(combination[0])
+        inception(json_schema, combinations).each do |combination|
+          combination[0] = json_schema.merge(combination[0])
           combination[1] = ['required', combination[1]]
         end
       end

data/lib/fitting/cover/json_schema_enum.rb

@@ -1,14 +1,16 @@
 module Fitting
   class Cover
     class JSONSchemaEnum
+      attr_reader :json_schema, :combinations
+
       def initialize(json_schema)
         @json_schema = json_schema
         @combinations = []
       end
 
       def combi
-        inception(@json_schema, @combinations).each do |combination|
-          combination[0] = @json_schema.merge(combination[0])
+        inception(json_schema, combinations).each do |combination|
+          combination[0] = json_schema.merge(combination[0])
           combination[1] = ['enum', combination[1]]
         end
       end

data/lib/fitting/cover/json_schema_one_of.rb

@@ -1,14 +1,16 @@
 module Fitting
   class Cover
     class JSONSchemaOneOf
+      attr_reader :json_schema, :combinations
+
       def initialize(json_schema)
         @json_schema = json_schema
         @combinations = []
       end
 
       def combi
-        inception(@json_schema, @combinations).each do |combination|
-          combination[0] = @json_schema.merge(combination[0])
+        inception(json_schema, combinations).each do |combination|
+          combination[0] = json_schema.merge(combination[0])
           combination[1] = ['one_of', combination[1]]
         end
       end

data/lib/fitting/railtie.rb

@@ -4,6 +4,7 @@ module Fitting
   class MyRailtie < Rails::Railtie
     rake_tasks do
       load 'tasks/fitting.rake'
+      load 'tasks/fitting_outgoing.rake'
     end
   end
 end

data/lib/fitting/records/documented/request.rb

@@ -2,9 +2,8 @@ module Fitting
   class Records
     class Documented
       class Request
-        def initialize(tomogram_request, white_list)
+        def initialize(tomogram_request)
           @tomogram_request = tomogram_request
-          @white_list = white_list
         end
 
         def method
@@ -24,21 +23,8 @@ module Fitting
           end
         end
 
-        def white
-          @white ||= white?
-        end
-
         private
 
-        def white?
-          return true if @white_list == nil
-          return false if @white_list[path.to_s] == nil
-          return true if @white_list[path.to_s] == []
-          return true if @white_list[path.to_s].include?(method)
-
-          false
-        end
-
         def groups
           @groups ||= @tomogram_request.responses.group_by do |tomogram_response|
             tomogram_response['status']

data/lib/fitting/records/spherical/requests.rb

@@ -10,7 +10,7 @@ module Fitting
 
           array = []
           Dir['fitting_tests/*.json'].each do |file|
-            array += JSON.parse(File.read(file))
+            array += JSON.parse(file)
           end
           @to_a = array.inject([]) do |res, tested_request|
             request = Fitting::Records::Spherical::Request.load(tested_request)

data/lib/fitting/records/tested/request.rb

@@ -6,33 +6,33 @@ module Fitting
   class Records
     class Tested
       class Request
-        def initialize(env_response, metadata)
-          @env_response = env_response
-          @metadata = metadata
+        def initialize(response, example)
+          @example = example
+          @response = response
         end
 
         def method
-          @method ||= @env_response.request.request_method
+          @method ||= @response.request.request_method
         end
 
         def path
-          @path ||= Tomograph::Path.new(@env_response.request.env['PATH_INFO'] || @env_response.request.fullpath)
+          @path ||= Tomograph::Path.new(@response.request.fullpath)
         end
 
         def body
-          @body ||= @env_response.request.env['action_dispatch.request.request_parameters']
+          @body ||= @response.request.request_parameters
         end
 
-        def response
-          @response ||= Fitting::Records::Tested::Response.new(@env_response)
+        def fitting_response
+          @fitting_response ||= Fitting::Records::Tested::Response.new(@response)
         end
 
         def test_path
-          @test_path ||= @metadata.fetch(:location)
+          @test_path ||= @example.location
         end
 
         def test_file_path
-          @test_file_path ||= @metadata.fetch(:file_path)
+          @test_file_path ||= @example.file_path
         end
 
         def to_spherical
@@ -40,7 +40,7 @@ module Fitting
             method: method,
             path: path,
             body: body,
-            response: response.to_spherical,
+            response: fitting_response.to_spherical,
             title: test_path,
             group: test_file_path
           )

data/lib/fitting/records/tested/response.rb

@@ -4,16 +4,16 @@ module Fitting
   class Records
     class Tested
       class Response
-        def initialize(env_response)
-          @env_response = env_response
+        def initialize(response)
+          @response = response
         end
 
         def status
-          @status ||= @env_response.status
+          @status ||= @response.status
         end
 
         def body
-          @body ||= @env_response.body
+          @body ||= @response.body
         end
 
         def to_spherical

data/lib/fitting/report/actions.rb

@@ -14,6 +14,10 @@ module Fitting
         @actions
       end
 
+      def push(actions)
+        @actions += actions.to_a
+      end
+
       def join(tests)
         tests.to_a.map do |test|
           if there_a_suitable_action?(test)

data/lib/fitting/report/console.rb

@@ -1,30 +1,50 @@
+require 'terminal-table'
+
 module Fitting
   module Report
     class Console
       def initialize(tests_without_prefixes, prefixes_details)
         @tests_without_prefixes = tests_without_prefixes
         @prefixes_details = prefixes_details
+
         @good = true
         @tests_without_actions = []
         @tests_without_responses = []
       end
 
       def output
-        doc_res = @prefixes_details.inject('') do |res, prefix_details|
-          res += "#{prefix_details[:name]}\n"
-          @tests_without_actions += prefix_details[:actions][:tests_without_actions]
-          res += prefix_details[:actions][:actions_details].inject('') do |res_actions, action|
-            res_actions += "#{action[:method]}\t#{action[:path]}"
-            tab = "\t" * (8 - action[:path].size / 8)
-            @tests_without_responses += action[:responses][:tests_without_responses]
-            res_actions += tab + action[:responses][:responses_details].inject('') do |res_responses, response|
-              @good = false if response[:combinations][:cover_percent] != '100%'
-              res_responses += " #{response[:combinations][:cover_percent]} #{response[:method]}"
+        tables = []
+
+        @prefixes_details.each do |prefix_details|
+          title = prefix_details[:name]
+          @tests_without_actions += prefix_details[:actions][:tests_without_actions] # непонятно что такое
+
+          next if prefix_details[:actions][:actions_details].count.zero?
+
+          tables << Terminal::Table.new do |t|
+            t.title = title
+            t.headings = %w[method path cover]
+
+            prefix_details[:actions][:actions_details].each do |action|
+              @tests_without_responses += action[:responses][:tests_without_responses]
+
+              path_details = action[:responses][:responses_details].map do |responses_detail|
+                @good = false if responses_detail[:combinations][:cover_percent] != '100%'
+                [responses_detail[:combinations][:cover_percent], responses_detail[:method]]
+              end.join(' ')
+
+              t.add_row [action[:method], action[:path], path_details]
             end
-            res_actions += "\n"
+
+            t.style = { all_separators: true, border: :unicode }
           end
         end
-        doc_res += "\n"
+
+        tables
+      end
+
+      def output_sum
+        doc_res = ''
         doc_res += "tests_without_prefixes: #{@tests_without_prefixes.size}\n"
         doc_res += "tests_without_actions: #{@tests_without_actions.size}\n"
         doc_res += "tests_without_responses: #{@tests_without_responses.size}\n"

data/lib/fitting/report/prefix.rb

@@ -3,53 +3,32 @@ require 'fitting/report/actions'
 module Fitting
   module Report
     class Prefix
-      def initialize(name: '', openapi2_json_path: nil, openapi3_yaml_path: nil,
-                     drafter_yaml_path: nil, tomogram_json_path: nil, crafter_yaml_path: nil, skip: false)
+      KEYS = {
+        'openapi2' => :openapi2_json_path,
+        'openapi3' => :openapi3_yaml_path,
+        'drafter' => :drafter_yaml_path,
+        'crafter' => :crafter_yaml_path,
+        'tomogram' => :tomogram_json_path
+      }.freeze
+
+      attr_reader :name, :tests, :actions
+
+      def initialize(schema_paths: nil, type: nil, name: '', skip: false, only: [])
         @name = name
-        @tomogram_json_path = tomogram_json_path
         @tests = Fitting::Report::Tests.new([])
         @skip = skip
         return if skip
 
-        @actions = if openapi2_json_path
-                     Fitting::Report::Actions.new(
-                       Tomograph::Tomogram.new(
-                         prefix: name,
-                         openapi2_json_path: openapi2_json_path
-                       )
-                     )
-                   elsif openapi3_yaml_path
-                     Fitting::Report::Actions.new(
-                       Tomograph::Tomogram.new(
-                         prefix: name,
-                         openapi3_yaml_path: openapi3_yaml_path
-                       )
-                     )
-                   elsif drafter_yaml_path
-                     Fitting::Report::Actions.new(
-                       Tomograph::Tomogram.new(
-                         prefix: name,
-                         drafter_yaml_path: drafter_yaml_path
-                       )
-                     )
-                   elsif crafter_yaml_path
-                     Fitting::Report::Actions.new(
-                       Tomograph::Tomogram.new(
-                         prefix: name,
-                         crafter_yaml_path: crafter_yaml_path
-                       )
-                     )
-                   else
-                     Fitting::Report::Actions.new(
-                       Tomograph::Tomogram.new(
-                         prefix: name,
-                         tomogram_json_path: tomogram_json_path
-                       )
-                     )
-                   end
-      end
+        @actions = Fitting::Report::Actions.new([])
 
-      attr_reader :name, :tests, :actions
+        schema_paths.each do |path|
+          tomogram = Tomograph::Tomogram.new(prefix: name, KEYS[type] => path)
+
+          tomogram.to_a.filter! { |action| only.include?("#{action.method} #{action.path}") } if only.present?
+
+          @actions.push(Fitting::Report::Actions.new(tomogram))
+        end
+      end
 
       def skip?
         @skip

data/lib/fitting/report/prefixes.rb

@@ -3,18 +3,17 @@ require 'fitting/report/prefix'
 module Fitting
   module Report
     class Prefixes
-      def initialize(config_path)
+      def initialize(configuration_prefixes)
         @prefixes = []
-        YAML.safe_load(File.read(config_path))['prefixes'].map do |prefix|
+
+        configuration_prefixes.map do |prefix|
           @prefixes.push(
             Fitting::Report::Prefix.new(
+              schema_paths: prefix['schema_paths'],
+              type: prefix['type'],
               name: prefix['name'],
-              openapi2_json_path: prefix['openapi2_json_path'],
-              openapi3_yaml_path: prefix['openapi3_yaml_path'],
-              drafter_yaml_path: prefix['drafter_yaml_path'],
-              tomogram_json_path: prefix['tomogram_json_path'],
-              crafter_yaml_path: prefix['crafter_yaml_path'],
-              skip: prefix['skip']
+              skip: prefix['skip'],
+              only: prefix['only']
             )
           )
         end

data/lib/fitting/report/response.rb

@@ -1,6 +1,3 @@
-require 'fitting/statistics/template_cover_error'
-require 'fitting/statistics/template_cover_error_enum'
-require 'fitting/statistics/template_cover_error_one_of'
 require 'fitting/report/combinations'
 require 'fitting/report/combination'
 

data/lib/fitting/report/tests.rb

@@ -3,13 +3,26 @@ require 'fitting/report/test'
 module Fitting
   module Report
     class Tests
+      attr_reader :tests
+
       def initialize(tests)
         @tests = tests
       end
 
-      def self.new_from_config(tests_path)
+      def self.new_from_config
+        tests = []
+        Dir["#{Fitting.configuration.rspec_json_path}/*.json"].each do |file|
+          JSON.parse(File.read(file)).map do |test|
+            tests.push(Fitting::Report::Test.new(test))
+          end
+        end
+        tests.sort { |a, b| b.path <=> a.path }
+        new(tests)
+      end
+
+      def self.new_from_outgoing_config
         tests = []
-        Dir[tests_path].each do |file|
+        Dir["#{Fitting.configuration.webmock_json_path}/*.json"].each do |file|
           JSON.parse(File.read(file)).map do |test|
             tests.push(Fitting::Report::Test.new(test))
           end
@@ -19,45 +32,45 @@ module Fitting
       end
 
       def without_prefixes
-        @tests.each_with_object([]) do |test, result|
+        tests.each_with_object([]) do |test, result|
           result.push(test.path) unless test.there_a_prefix?
         end
       end
 
       def without_actions
-        @tests.each_with_object([]) do |test, result|
+        tests.each_with_object([]) do |test, result|
           result.push("#{test.method} #{test.path}") unless test.there_an_actions?
         end
       end
 
       def without_responses
-        @tests.each_with_object([]) do |test, result|
+        tests.each_with_object([]) do |test, result|
           result.push(test.id) unless test.there_an_responses?
         end
       end
 
       def without_combinations
-        @tests.each_with_object([]) do |test, result|
+        tests.each_with_object([]) do |test, result|
           result.push(test.path) unless test.there_an_combinations?
         end
       end
 
       def push(test)
-        @tests.push(test)
+        tests.push(test)
       end
 
       def size
-        @tests.size
+        tests.size
       end
 
       def to_a
-        @tests
+        tests
       end
 
       def to_h
         return @hash if @hash
 
-        @hash = @tests.inject({}) do |res, test|
+        @hash = tests.inject({}) do |res, test|
           res.merge!(test.id => test.to_h)
         end
       end