api_mini_tester 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab778aea0e70140ad7987422ea3cc84423ca3c83
+  data.tar.gz: 482db1276239fca74afb2b54a490e464f1529ccb
+SHA512:
+  metadata.gz: f75c1d2e8af06c2629da0c2e52f8b63f154871df0c3a0fb950e03dd2adf8f485f99161cbeb22f385d7869c5460341893a3f65ed366c9f217b1ecf4a8c3bf7bae
+  data.tar.gz: d72335d77cab38d7f09a0171914b2a56323a59ae057c9ef2acac8a38ae9c5b6a1b176aa0de9889d675988eeceb4c9bbe099d2258b49a8cd2eaad04bf0dcbcb09

data/lib/api_mini_tester.rb

@@ -0,0 +1,6 @@
+module ApiMiniTester
+end
+
+require 'api_mini_tester/test_step'
+require 'api_mini_tester/test_scenario'
+require 'api_mini_tester/test_suite'

data/lib/api_mini_tester/test_formatter.rb

@@ -0,0 +1,209 @@
+require 'builder'
+require 'socket'
+
+class TestFormatter
+
+  RESULT_SECTIONS = %i[status headers body timing].freeze
+  SECTION_TRANSLATE = {
+    status: "Status",
+    headers: "Headers",
+    body: "Body",
+    timing: "Timing"
+  }.freeze
+
+  attr_accessor :results
+
+  def initialize(results)
+    @results = results
+  end
+
+  def to_json
+    clean_up_infinity.to_json
+  end
+
+  def to_yaml
+    clean_up_infinity.to_yaml
+  end
+
+  def to_junit_xml
+    xml = Builder::XmlMarkup.new(indent: 2)
+    xml.instruct! :xml, encoding: "UTF-8"
+    xml.testsuites do
+      results[:scenarios].each do |scenario|
+        xml.testsuite name: scenario[:name],
+                      timestamp: timestamp,
+                      hostname: hostname,
+                      tests: tests_in_scenario(scenario),
+                      skipped: 0,
+                      failures: failed_in_scenario(scenario),
+                      errors: 0,
+                      time: time_in_scenario(scenario) do
+          scenario[:steps].each do |step|
+            classname = name_to_camelcase(step[:name])
+            RESULT_SECTIONS.each do |section|
+              step[section].each do |s|
+                xml.testcase classname: classname,
+                             name: s[:name],
+                             time: step_timing(step),
+                             file: "./#{classname}.rb"  do
+                  s[:result] ? nil : xml.failure(message: s[:desc])
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def timestamp
+    Time.now.strftime("%FT%T%:z")
+  end
+
+  def scenarios_count
+    results[:scenarios].size
+  end
+
+  def steps_count(scenario)
+    scenario[:steps].size
+  end
+
+  def test_count(step)
+    count = 0
+    [:status, :headers, :body, :timing].each do |section|
+      count += step[section].size
+    end
+    count
+  end
+
+  def tests_in_scenario(scenario)
+    count = 0
+    scenario[:steps].each do |step|
+      count += test_count(step)
+    end
+    count
+  end
+
+  def time_in_scenario(scenario)
+    time = 0.0
+    scenario[:steps].each do |step|
+      time += step[:timing].first[:real]
+    end
+    time
+  end
+
+  def failed_in_scenario(scenario)
+    count = 0
+    scenario[:steps].each do |step|
+      [:status, :headers, :body, :timing].each do |section|
+        count += step[section].map { |res| res[:result] }.select(&:!).size
+      end
+    end
+    count
+  end
+
+  def hostname
+    Socket.gethostname
+  end
+
+  def name_to_camelcase(name)
+    name.gsub(/[[:space:]]+/, '_').downcase.gsub(/(?:^|_)([a-z])/) { $1.upcase }
+  end
+
+  def step_timing(step)
+    step[:timing].first ? step[:timing].first[:real] : 0
+  end
+
+  def clean_up_infinity
+    res = results.dup
+    res[:scenarios].each do |scenario|
+      scenario[:steps].each do |step|
+        step[:timing].each do |timing|
+          timing[:exp] = "Not Specified" if timing.is_a?(Hash) && timing[:exp] && timing[:exp] == Float::INFINITY
+        end
+      end
+    end
+    res
+  end
+
+  def array_in(array)
+    list = ''
+    array.each do |item|
+      if item.instance_of?(Array)
+        list << array_in(item)
+      elsif item.instance_of?(Hash)
+        list << hash_in(item)
+      end
+    end
+    list
+  end
+
+  def hash_in(hash)
+    list = ''
+    hash.each do |k, v|
+      if v.instance_of?(Hash)
+        list << hash_in(v)
+      elsif v.instance_of?(Array)
+        list << array_in(v)
+      elsif k == :result
+        list << (v ? '.' : 'E')
+      end
+    end
+    list
+  end
+
+  def to_simple
+    hash_in results
+  end
+
+  def md_section_header(header, desc, level)
+    output = []
+    output << "#{'#' * level} #{header}"
+    output << ""
+    if desc
+      output << "Desc: #{desc}"
+      output << ""
+    end
+    output
+  end
+
+  def md_step_header(step)
+    output = []
+    output.push(*md_section_header(step[:name], step[:desc], 3))
+    output.push(*md_section_header("Call", nil, 4))
+    step[:url].each do |url|
+      output << "* #{url[:desc]}"
+    end
+    step[:method].each do |method|
+      output << "* #{method[:desc]}"
+    end
+    output << ""
+    output
+  end
+
+  def md_section_content(step, section)
+    output = []
+    output << md_section_header(SECTION_TRANSLATE[section], nil, 4)
+    step[section].each do |status|
+      output << "* `#{status[:result]}`: #{status[:desc]}"
+    end
+    output << ""
+    output
+  end
+
+  def to_markdown
+    output = []
+    output << md_section_header(results[:name], results[:desc], 1)
+    results[:scenarios].each do |scenario|
+      output << md_section_header(scenario[:name], scenario[:desc], 2)
+      scenario[:steps].each do |step|
+        output.push(*md_step_header(step))
+        RESULT_SECTIONS.each do |section|
+          output.push(*md_section_content(step, section))
+        end
+      end
+    end
+    output.join("\n")
+  end
+
+end

data/lib/api_mini_tester/test_scenario.rb

@@ -0,0 +1,44 @@
+require_relative 'test_step'
+
+module ApiMiniTester
+  class TestScenario
+
+    attr_accessor :base_uri, :scenario, :data, :results, :name
+
+    def initialize(base_uri, scenario, data)
+      @base_uri = base_uri
+      @scenario = scenario
+      @data = data
+      @name = scenario['name']
+      @results = {name: scenario['name'], desc: scenario['desc'], steps: []}
+    end
+
+    def valid?
+      return false if scenario.nil? || scenario['steps'].nil?
+      return false unless scenario['steps'].is_a?(Array) || scenario['steps'].empty?
+      return false if name.nil? || name.empty?
+      return false if base_uri.nil? || base_uri.empty?
+      true
+    end
+
+    def add_result(result)
+      @results.steps << result
+    end
+
+    def print_results
+      @results.each do |line|
+        puts line
+      end
+    end
+
+    def run_scenario
+      @context = []
+      scenario['steps'].each do |step|
+        step = TestStep.new(base_uri, step, @context, data)
+        step_result, context = step.run_step
+        @results[:steps] << step_result
+        @context << context
+      end
+    end
+  end
+end

data/lib/api_mini_tester/test_step.rb

@@ -0,0 +1,199 @@
+require 'httparty'
+require 'liquid'
+require 'hash_parser'
+require 'uri'
+require 'faker'
+require 'json'
+
+module ApiMiniTester
+  class TestStep
+
+    include HTTParty
+
+    SUPPORTED_METHODS = %i[ get post put delete ].freeze
+
+    attr_accessor :uri, :method, :name, :input, :output
+    attr_reader :results
+
+    def initialize(base_uri, step, context = nil, data = nil)
+      @context = context
+      uri_template = Liquid::Template.parse([base_uri, step['uri']].join("/"), error_mode: :strict)
+      @name = step['name']
+      @uri = uri_template.render({'context' => context, 'data' => data}, { strict_variables: true })
+      @method = step['method'].downcase.to_sym
+
+      input_template = Liquid::Template.parse(step['input'].to_yaml.to_s, error_mode: :strict)
+      @input = YAML.load(input_template.render({'context' => context, 'data' => data}, { strict_variables: true }))
+
+      output_template = Liquid::Template.parse(step['output'].to_yaml.to_s, error_mode: :strict)
+      @output = YAML.load(output_template.render({'context' => context, 'data' => data}, { strict_variables: true }))
+
+      @results = { name: step['name'], desc: step['desc'], status: [], headers: [], body: [], url: [], method: [], timing: [] }
+    end
+
+    def valid?
+      return false if uri.nil? || uri.empty?
+      return false unless URI.parse(uri) rescue false
+      return false unless SUPPORTED_METHODS.include? method
+      return false if @name.nil? || @name.empty?
+      true
+    end
+
+    def content_type
+      @input['content_type'] || 'application/json'
+    end
+
+    def headers
+      @input['header']['Content-type'] = content_type if content_type == 'application/json'
+      @input['header']
+    end
+
+    def body
+      case content_type
+      when 'application/x-www-form-urlencoded'
+        body_to_form_data
+      when 'multipart/form-data'
+        body_to_form_data
+      else
+        @input["body"].to_json
+      end
+    end
+
+    def body_to_form_data
+      body = {}
+      @input["body"].each do |item|
+        body[item['name']] = item['value'] if item['type'] == 'input'
+        body[item['name']] = File.open(item['value'], 'r') if item['type'] == 'file'
+      end
+      body
+    end
+
+    def test_headers
+      @output['header']
+    end
+
+    def test_body
+      @output['body']
+    end
+
+    def test_status
+      @output['status']
+    end
+
+    def test_timing
+      @output['timing']
+    end
+
+    def run_step
+      @timing = Time.now
+      case method
+      when :get
+        response = HTTParty.get(uri, headers: headers)
+      when :post
+        response = HTTParty.post(uri, headers: headers, body: body)
+      when :put
+        response = HTTParty.put(uri, headers: headers, body: body)
+      when :delete
+        response = HTTParty.delete(uri, headers: headers)
+      end
+      @timing = Time.now - @timing
+
+      add_result :url, { result: true, desc: "Url: #{uri}" }
+      add_result :method, { result: true, desc: "Method: #{method}" }
+
+      assert_status(response.code, test_status)
+      assert_headers(response.headers, test_headers)
+      assert_body(response.parsed_response, test_body)
+      assert_timing(@timing, test_timing)
+
+      [ results, response ]
+    end
+
+    def print_results
+      @results.each do |line|
+        puts line
+      end
+    end
+
+    def add_result(section, result)
+      @results[section] << result
+    end
+
+    def assert_timing(runtime, limit = nil)
+      limit ||= Float::INFINITY
+      add_result :timing, { result: (runtime < limit),
+                            name: "Request time < #{limit}",
+                            desc: "Expected request time #{limit}, real time #{runtime}",
+                            exp: limit, real: runtime }
+    end
+
+    def assert_status(response, output)
+      add_result :status, { result: (response == output),
+                            name: "Response code == #{output}",
+                            desc: "Expected response #{output}, got response #{response}",
+                            exp: output, real: response }
+    end
+
+    def assert_headers(response, output)
+      return if output.nil?
+      output.each do |k, v|
+        add_result :headers, { result: (v == response[k]),
+                               name: "Header value: #{k} == #{v}",
+                               desc: "Header #{k} expected: #{v}, got #{response[k]}",
+                               exp: v, real: response[k] }
+      end
+    end
+
+    def assert_body(response, output)
+      if output.instance_of?(Hash)
+        hash_diff(output, response)
+      elsif output.instance_of?(Array)
+        array_diff(output, response)
+      end
+    end
+
+    def array_diff(a, b, path = nil, section = :body)
+      a.each do |a_item|
+        if a_item.instance_of?(Hash)
+          found = false
+          b.each do |b_item|
+            matching = true
+            a_item.each_key do |k, v|
+              matching = (b_item[k] == a_item[k]) if matching
+            end
+            found = true if matching
+          end
+          add_result section, { result: found,
+                                name: "Response body value: #{[path].join(".")}",
+                                desc: "Assert #{[path].join(".")} #{found ? 'contains' : 'does not contains'} #{a_item}" }
+        elsif a_item.instance_of?(Array)
+          # TODO: Add support for array of array it isn't so needed to compate so deep structures
+        else
+          add_result section, { result: b.include?(a_item),
+                                name: "Response boby value: #{[path].join(".")}",
+                                desc: "Assert #{[path].join(".")} #{b.include?(a_item) ? 'contains' : 'does not contains'} #{a_item}" }
+        end
+      end
+    end
+
+    def hash_diff(a, b, path = nil, section = :body)
+      return nil if a.nil? || b.nil?
+      a.each_key do |k, v|
+        current_path = [path, k].join('.')
+        if b[k].nil?
+          add_result section, { result: false,
+                                name: "Reponse value: #{[path, k].join(".")}",
+                                desc: "Missing #{current_path}" }
+        elsif v.instance_of?(Hash)
+          hash_diff(a[k], b[k], current_path, section)
+        elsif v.instance_of?(Array)
+          array_diff(a[k], b[k], current_path, section)
+        else
+          add_result section, { result: (a[k] == b[k]),
+                                name: "Reponse body value: #{[path, k].join(".")}",
+                                desc: "Assert #{[path, k].join(".")}: #{a[k]} #{a[k] == b[k] ? '==' : '!='} #{b[k]}" }
+        end
+      end
+    end
+  end
+end

data/lib/api_mini_tester/test_suite.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+require_relative 'test_scenario'
+require_relative 'test_formatter'
+
+module ApiMiniTester
+  class TestSuite
+
+    attr_accessor :base_uri, :scenarios, :data, :results
+
+    def initialize(suite_def)
+      if suite_def.is_a?(String)
+        @test = YAML.load(File.open(suite_def))
+      elsif suite_def.is_a?(Hash)
+        @test = suite_def
+      end
+      setup
+    end
+
+    def valid?
+      return false if base_uri.nil? || base_uri.empty?
+      return false if scenarios.nil? || scenarios.empty?
+      true
+    end
+
+    def setup
+      @base_uri = @test['settings']['baseurl']
+      @scenarios = @test['tests']
+      @data = @test['data']
+      @results = {name: @test['name'], desc: @test['desc'], scenarios: []}
+    end
+
+    def run_scenarios
+      scenarios.each do |scenario|
+        runner = TestScenario.new(base_uri, scenario, data)
+        runner.run_scenario
+        @results[:scenarios] << runner.results
+      end
+      @results
+    end
+
+    def print_results(format)
+      formatter = TestFormatter.new(results)
+      formatter.send("to_#{format}")
+    end
+
+  end
+end

metadata

@@ -0,0 +1,268 @@
+--- !ruby/object:Gem::Specification
+name: api_mini_tester
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Jindrich Skupa (@eMan)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: hash_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters-json_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: nexus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+description: Runs automated REST API based on YAML definiti
+email: jindrich.skupa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/api_mini_tester.rb
+- lib/api_mini_tester/test_formatter.rb
+- lib/api_mini_tester/test_scenario.rb
+- lib/api_mini_tester/test_step.rb
+- lib/api_mini_tester/test_suite.rb
+homepage: http://rubygems.org/gems/api_mini_tester
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Runs automated REST API based on YAML definition
+test_files: []