okapi 0.0.6 → 0.0.7

data/{test_files → examples}/apiary.apib

@@ -35,7 +35,7 @@ This resource allows you to submit payment information to process your *shopping
 POST /payment
 { "cc": "12345678900", "cvc": "123", "expiry": "0112" }
 < 200
-{ "receipt": "/payment/receipt/1aaa" }
+{ "receipt": "/payment/receipt/1" }
 
 -- JSON Schema Validations --
 

data/examples/apiary.yaml

@@ -0,0 +1,5 @@
+tests:
+  host: http://aptest.apiary.io
+  specs:
+    - tests.spec
+    - tests2.spec

data/examples/tests.spec

@@ -0,0 +1,6 @@
+VARS {"id2": "eee", "id": "5"}
+POST /shopping-cart/{id2} {"id2": "eee2"}
+POST 
+CONTINUE
+
+

data/{test_files/tests.spec → examples/tests2.spec}

@@ -1,4 +1,3 @@
 POST /shopping-cart/{id2} {"id2": "eee2"}
 POST /payment
 
-

data/lib/okapi/apiary_connector.rb

@@ -14,30 +14,46 @@ module Apiary
         @res_path  = res_path
       end
 
-      def get_requests(resources, blueprint)
+      def get_response(raw_resp, json_data, error, code)
+        { :resp => raw_resp,
+          :data => json_data ? json_data['requests'] : nil,
+          :status => json_data ? json_data['status'] : nil ,
+          :error => json_data ? json_data['error'] || error : error,
+          :code => code
+          }
+      end
+
+      def get_requests(resources, blueprint, all_resources = false, global_vars = {})
 
         resources_list = []
 
         resources.each() do |res|
           resources_list << {
-            :resource =>  res.uri,
-            :method =>  res.method,
-            :params =>  res.params,
+            :resource =>  res['resource'],
+            :method =>  res['method'],
+            :params =>  res['params']
           }
         end
 
         data = {
           :resources => resources_list,
-          :blueprint => blueprint
+          :blueprint => blueprint,
+          :all_resources => all_resources,
+          :global_vars => global_vars
         }.to_json()
-
+        
         begin
           response = RestClient.post @apiary_url + @req_path, data, :content_type => :json, :accept => :json
-          data = JSON.parse(response.to_str)
-
-          {:resp => response, :data => data['requests'], :status => data['status'], :error => data['error']}
-        rescue Exception  => e
-          {:resp => nil, :data => nil, :status => nil, :error => e}
+          get_response(response, JSON.parse(response.to_str), nil, response.code.to_i)
+        rescue RestClient::BadRequest, RestClient::InternalServerError  => e
+          begin
+            data = JSON.parse(e.http_body)
+            get_response(nil, JSON.parse(e.http_body), data['error'], e.http_code.to_i)
+          rescue
+            get_response(nil, nil, e.to_s, e.http_code.to_i)
+          end
+        rescue Exception => e
+          get_response(nil, nil, e.to_s, nil)
         end
 
       end
@@ -69,12 +85,15 @@ module Apiary
 
         begin
           response = RestClient.post @apiary_url + @res_path, data, :content_type => :json, :accept => :json
-
-          data = JSON.parse(response.to_str)
-
-          {:resp => response, :data => data['requests'], :status => data['status'], :error => data['error']}
-        rescue Exception  => e
-          {:resp => nil, :data => nil, :status => nil, :error => e}
+          get_response(response, JSON.parse(response.to_str), nil, response.code.to_i)
+        rescue RestClient::BadRequest, RestClient::InternalServerError  => e
+          begin
+            get_response(nil, JSON.parse(e.http_body), data['error'], e.http_code.to_i)
+          rescue
+            get_response(nil, nil, e.to_s, e.http_code.to_i)
+          end
+        rescue Exception => e
+          get_response(nil, nil, e.to_s, nil)
         end
       end
     end

data/lib/okapi/cli.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'optparse'
+require 'yaml'
 
 module Apiary
   module Okapi
@@ -9,67 +10,111 @@ module Apiary
         case args.first
           when 'help'
             puts Apiary::Okapi::Help.show
+            exit 0
           when 'version'
             puts VERSION
+            exit 0
           when 'okapi'
             puts Apiary::Okapi::Help.okapi
+            exit 0
           else
-            run(parse_options!(args))
-        end
+            parse_options!(args)
+            parse_config
+            @options[:blueprint]   ||= BLUEPRINT_PATH
+            @options[:test_spec]   ||= TEST_SPEC_PATHS
+            @options[:output]      ||= OUTPUT
+            @options[:test_url]    ||= TEST_URL
+            @options[:apiary_url]  ||= APIARY_URL
+
+            @options[:test_spec] ||= TEST_SPEC_PATHS.gsub(' ','').split(',')
 
-        
+            if @options[:params]
+              puts "running with :"
+              p @options
+              puts "\n"
+            end
+
+            exit run
+        end    
       end
 
-      def run(options)
-        Apiary::Okapi::Test.new(options[:blueprint], options[:test_spec], options[:test_url], options[:output], options[:apiary_url]).run()
+      def run
+        pass = true
+        @options[:test_spec].each { |spec|
+          pass = Apiary::Okapi::Test.new(@options[:blueprint], spec, @options[:test_url], @options[:output], @options[:apiary_url]).run()
+          }
+        if pass
+          0
+        else
+          1
+        end
+      end
 
+      def parse_config
+        begin
+          if tests = YAML.load_file(@options[:config_path])['tests']
+            @options[:test_url] ||= tests['host'] if tests['host']
+            @options[:test_spec] ||= tests['specs'] if tests['specs']
+          end
+        rescue Errno::ENOENT  => e          
+          puts "Config file (#{@options[:config_path]}) not accessible ... skiping"
+        rescue Exception => e
+          puts "Config file (#{@options[:config_path]}) loading problem :#{e}"
+          exit 1
+        end
       end
 
       def parse_options!(args)
-        options = {}
+        @options = {}
         options_parser = OptionParser.new do |opts|
+          opts.on("-c", "--config CONFIG",
+                  "path config file (default: " + CONFIG_PATH + " )") do |config|
+            @options[:config_path] = config
+          end
+
           opts.on("-b", "--blueprint BLUEPRINT",
                   "path to the blueprint (default: " + BLUEPRINT_PATH + " )") do |blueprint|            
-            options[:blueprint] = blueprint
+            @options[:blueprint] = blueprint
           end
 
           opts.on("-t","--test_spec TEST_SPEC",
-                  "path to the test specification (default: " + TEST_SPEC_PATH + " )") do |test_spec|            
-            options[:test_spec] = test_spec
+                  "comma separated paths to the test specifications (default: " + TEST_SPEC_PATHS + " )") do |test_spec|
+            @options[:test_spec] = test_spec
           end
 
           opts.on("-o","--output OUTPUT",
                   "output format (default" + OUTPUT + ")") do |output|
-            options[:output] = output
+            @options[:output] = output
           end
 
           opts.on("-u","--test_url TEST_URL",
                   "url to test (default" + TEST_URL + ")") do |test_url|
-            options[:test_url] = test_url
+            @options[:test_url] = test_url
           end
 
           opts.on("-a","--apiary APIARY",
                   "apiary url  (default" + APIARY_URL + ")") do |apiary|
-            options[:apiary_url] = apiary
-          end          
+            @options[:apiary_url] = apiary
+          end
 
+          opts.on("-p","--params [PARAMS]",
+                  "show parameters" ) do |params|
+            @options[:params] = true
+          end          
         end
 
         options_parser.parse!
-        options[:blueprint]   ||= BLUEPRINT_PATH
-        options[:test_spec]   ||= TEST_SPEC_PATH
-        options[:output]      ||= OUTPUT
-        options[:test_url]    ||= TEST_URL
-        options[:apiary_url]  ||= APIARY_URL
 
-        raise OptionParser::InvalidOption, 'Blueprint file "' + options[:blueprint] + '" does not exist' if not File.file?(options[:blueprint])
-        raise OptionParser::InvalidOption, 'Test specification file "' + options[:test_spec] + '" does not exist' if not File.file?(options[:test_spec])
-        
-        options
+        @options[:config_path]  ||= CONFIG_PATH
+        @options[:test_spec] = @options[:test_spec].gsub(' ','').split(',') if @options[:test_spec]
+
+        @options
 
       rescue OptionParser::InvalidOption => e
+        puts "\n"
         puts e
-        puts Apiary::Okapi::Help.banner
+        Apiary::Okapi::Help.banner
+        puts "\n"
         exit 1
       end
 

data/lib/okapi/config.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 module Apiary
   module Okapi
+    CONFIG_PATH = "apiary.yaml"
     APIARY_URL = "https://api.apiary.io"
     GET_REQUESTS_PATH = "/tests/get-requests"
     GET_RESULTS_PATH = "/tests/get-test-results"
     BLUEPRINT_PATH = "apiary.apib"
-    TEST_SPEC_PATH = "tests.spec"
-    OUTPUT = 'tap'
-    TEST_URL = "127.0.0.1"
+    TEST_SPEC_PATHS = "tests.spec"
+    TEST_URL = "http://127.0.0.1"
+    OUTPUT = 'tap'    
   end
 end

data/lib/okapi/output.rb

@@ -4,7 +4,9 @@ module Apiary
   module Okapi
     class Output
       def self.get(output,resources, error)
-        Apiary::Okapi::Outputs.const_get(output.to_s.capitalize).send(:new, resources, error).get()
+        output = Apiary::Okapi::Outputs.const_get(output.to_s.capitalize).send(:new, resources, error)
+        output.get()
+        output.status
       end
     end
   end

data/lib/okapi/outputs/base.rb

@@ -2,6 +2,9 @@ module Apiary
   module Okapi
     module Outputs
       class BaseOutput
+
+        attr_reader :status
+
         def initialize(resources, error)
           @resources = resources
           @error = error
@@ -9,15 +12,15 @@ module Apiary
             :count => 0,
             :give_up => false,
           }
+          @status = true
           get_results
         end
 
-        def get          
-          p '------------------------------------------------------------------'
+        def get
           p @results[:count].to_s + ' tests'
           p @results[:give_up][:error].to_s if @results[:give_up]
           @results[:tests].each { |test|
-            p '########################################'
+            p '-------------------------------------------------'
             p test[:test_no]
             p test[:description]
             if test[:pass]
@@ -30,11 +33,11 @@ module Apiary
         end
 
         def get_results
-
           @results[:count] = @resources.count
           @results[:tests] = []
           if @error
             @results[:give_up] = {:error => @error}
+            @status = false
           else
             counter = 0
             @resources.each { |res|
@@ -42,7 +45,7 @@ module Apiary
               test_res = {
                 :test_no=> counter,
                 :pass => (res.validation_result.status and res.response.validation_result.status),
-                :description => res.method + ' ' + res.uri
+                :description => (res.method + ' ' + res.uri) + ((res.expanded_uri and res.uri != res.expanded_uri['url']) ? " (#{res.expanded_uri['url']}) " : '')
                 }
               if not test_res[:pass]
                 test_res[:exp] = {:request => {:pass => false}, :response => {:pass => false}}
@@ -50,12 +53,14 @@ module Apiary
                   test_res[:exp][:request][:pass] = true
                 else
                   test_res[:exp][:request][:reasons] = get_fail_result(res.validation_result)
+                  @status = false
                 end
 
                 if res.response.validation_result.status
                   test_res[:exp][:response][:pass] = true
                 else
                   test_res[:exp][:response][:reasons] = get_fail_result(res.response.validation_result)
+                  @status = false
                 end              
               end
             @results[:tests] << test_res

data/lib/okapi/outputs/tap.rb

@@ -7,6 +7,11 @@ module Apiary
      class Tap < Apiary::Okapi::Outputs::BaseOutput
 
        def get
+         get_int
+         puts "\n\n"
+       end
+       
+       def get_int
          puts "TAP version 13"
          puts "1..#{@results[:count].to_s}"
          if @results[:give_up]
@@ -23,7 +28,7 @@ module Apiary
            if not test[:pass]
              error_block(test)
            end
-         }
+         }      
        end
 
        def error_block(test)

data/lib/okapi/spec_parser.rb

@@ -5,34 +5,58 @@ module Apiary
   module Okapi
     class Parser
 
-      attr_reader :data, :resources
+      attr_reader :data, :resources, :proces_all_bp_resources, :global_vars
 
       def initialize(spec_path)
+        if not File.exist? spec_path
+          raise Exception, "Test spec. file '#{spec_path}' not found"
+        end
         @data = read_file(spec_path)
+        @proces_all_bp_resources = false
       end
 
       def resources
-        @resources ||= begin
-          parse_data { |res|
-            raise Exception, 'resource not defined' unless res["resource"]
-            raise Exception, 'method not defined' unless res["method"]
-
-            (@resources ||= []) << Apiary::Okapi::Resource.new(res["resource"], res["method"], res["params"])
-          }
-        @resources
-        end
+        @resources ||= parse_data
       end
 
       def read_file(path)
         @data = []
-        File.open(path).each do |line|
-          @data << line if line.strip != ""
-        end
+          File.open(path).each do |line|
+            @data << line if line.strip != ""
+          end
         @data
       end
 
+      def substituite_vars(local, global)
+        tmp = {}
+        global.each {|k,v|
+          tmp[k] = v
+        }
+        local.each {|k,v|
+          tmp[k] = v
+        }
+        tmp
+      end
+
       def parse_data
+        global_vars = {}
+        resources = []
         @data.each { |res|
+          if res.index('CONTINUE') == 0
+            @proces_all_bp_resources = true
+            next
+          end
+
+          if res.index('VARS') == 0
+            splited = res.split(' ',2)
+            begin
+              global_vars = JSON.parse splited[1] if splited[1] and splited[1] != ''
+            rescue Exception => e
+              raise Exception, "can not parse global parameters (#{e})"
+            end
+            next
+          end
+
           splited = res.split(' ',3)
 
           begin
@@ -40,13 +64,18 @@ module Apiary
           rescue Exception => e
             raise Exception, 'can not parse parameters for resource:' + res + "(#{e})"
           end
-          out = {
-            'resource' => splited[1],
-            'method' => splited[0],
-            'params' => splited[2] || {}
-            }
-          yield out
+          
+          if splited[1] and splited[1] != '' and splited[0] and splited[0] != ''
+            out = {
+              'resource' => splited[1],
+              'method' => splited[0],
+              'params' => substituite_vars(splited[2] || {}, global_vars)
+              }
+            resources << out
+          end
         }
+        @global_vars = global_vars
+        resources
       end
 
     end

data/lib/okapi/test.rb

@@ -5,31 +5,31 @@ module Apiary
   module Okapi
     class Test
       def initialize(blueprint_path, test_spec_path, test_url, output, apiary_url)
-        @blueprint_path = blueprint_path || BLUEPRINT_PATH
-        @test_spec_path = test_spec_path || TEST_SPEC_PATH
-        @test_url       = test_url || TEST_URL
-        @output_format         = output || OUTPUT
-        @apiary_url     = apiary_url || APIARY_URL
+        @blueprint_path = blueprint_path
+        @test_spec_path = test_spec_path
+        @test_url       = test_url
+        @output_format  = output
+        @apiary_url     = apiary_url
         @req_path       = GET_REQUESTS_PATH
         @res_path       = GET_RESULTS_PATH
         @connector = Apiary::Okapi::ApiaryConnector.new(@apiary_url, @req_path, @res_path)
+        @proces_all_bp_resources = false
         @output = []
         @resources = []
-        @error = nil
-        
+        @error = nil        
       end
 
       def run
         begin
           test()
         rescue Exception => e
+          p e
+          @resources = []
           @error = e
-        end
-
+        end        
         Apiary::Okapi::Output.get(@output_format, @resources, @error)
       end
 
-
       def test
         prepare()
         if not @resources.empty?
@@ -41,25 +41,30 @@ module Apiary
       end
 
       def prepare
-        resources = parse_test_spec(@test_spec_path)
-        
-        data = get_requests_spec(resources)
+        @resources = []
+        parser = get_test_spec_parser(@test_spec_path)
+        resources = parser.resources
+        counter = 0
+
+        resources.each { |res|
+          counter += 1
+          raise Exception, "Rresource not defined for item #{counter.to_d} in #{@test_spec_path}" unless res["resource"]
+          raise Exception, "Method not defined for resource #{res["resource"].to_s} in #{@test_spec_path}" unless res["method"]
+        }
 
-        raise Exception, 'Can not get request data from Apiary: ' + data[:error]  || '' if data[:error] or data[:resp].code.to_i != 200
+        @proces_all_bp_resources = parser.proces_all_bp_resources
+        data = get_requests_spec(resources, parser.global_vars)
+        
+        if data[:error] or data[:code] != 200
+          raise Exception, 'Can not get request data from Apiary: ' + data[:error] ? data[:error] : ''
+        end
          
         data[:data].each do |res|
           raise Exception, 'Resource error "' + res['error'] + '" for resource "' + res["method"] + ' ' + res["uri"]  + '"' if res['error']
-
-          resources.each do |resource|
-            if resource.uri == res["uri"] and resource.method == res["method"]
-              resource.expanded_uri = res["expandedUri"]
-              resource.body = res["body"]
-              resource.headers = res["headers"]
-              break
-            end
-          end
+          @resources << Apiary::Okapi::Resource.new(res["uri"], res["method"], res["params"], res["expandedUri"], res["headers"], res["body"])          
         end
-        @resources = resources
+
+        @resources      
       end
 
       def blueprint
@@ -88,9 +93,10 @@ module Apiary
       def evaluate
 
         data = @connector.get_results(@resources, blueprint)
-
-        raise Exception, 'Can not get evaluation data from apiary' + data[:error] || '' if data[:resp].code.to_i != 200 or data[:error]
-
+        if data[:error] or data[:code] != 200
+          raise Exception, 'Can not get evaluation data from apiary: ' + data[:error] ? data[:error] : ''
+        end
+        
         data[:data].each { |validation|
           @resources.each { |resource|
             if validation['resource']['uri'] == resource.uri and validation['resource']['method'] == resource.method
@@ -115,16 +121,19 @@ module Apiary
         }
       end      
 
-      def parse_test_spec(test_spec)
-        Apiary::Okapi::Parser.new(test_spec).resources
+      def get_test_spec_parser(test_spec)
+        Apiary::Okapi::Parser.new(test_spec)                
       end
 
       def parse_blueprint(blueprint_path)
+        if not File.exist? blueprint_path
+          raise Exception, "Blueprint file '#{blueprint_path}' not found"
+        end
         File.read(blueprint_path)
       end
 
-      def get_requests_spec(resources)
-        @connector.get_requests(resources, blueprint)
+      def get_requests_spec(resources, global_vars)
+        @connector.get_requests(resources, blueprint, @proces_all_bp_resources, global_vars)
       end
 
     end

data/lib/okapi/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Apiary
   module Okapi
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: okapi
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Tu1ly
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-06 00:00:00 +02:00
+date: 2013-05-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,11 @@ files:
 - README.md
 - Rakefile
 - bin/okapi
+- examples/apiary.apib
+- examples/apiary.yaml
+- examples/tests.spec
+- examples/tests2.spec
+- examples/tests_1.spec
 - lib/okapi.rb
 - lib/okapi/apiary_connector.rb
 - lib/okapi/cli.rb
@@ -77,9 +82,6 @@ files:
 - lib/okapi/test.rb
 - lib/okapi/version.rb
 - okapi.gemspec
-- test_files/apiary.apib
-- test_files/tests.spec
-- test_files/tests_1.spec
 has_rdoc: true
 homepage: http://apiary.io
 licenses: