app-tester 0.0.1 → 0.1.0

data/README.md

@@ -1,14 +1,16 @@
 # Application Tester (app-tester)
 
-* http://github.com/joseairosa/app-tester
+* This page: http://github.com/joseairosa/app-tester
+* Rubygems: http://rubygems.org/gems/app-tester
+* Documentation: http://i.am.joseairosa.com/gems/app-tester/
 
 [![Build Status](https://secure.travis-ci.org/joseairosa/app-tester.png)](http://travis-ci.org/joseairosa/app-tester)
 
-## DESCRIPTION:
+## Description
 
 This Gem will provide a framework to build command line functional tests against a web application (API, Website, etc)
 
-## FEATURES/PROBLEMS:
+## Features
 
 * Easily create functional tests with just a few lines of code
 * Since tests are built as command line tools they can be easily integrated with automatic tools
@@ -16,7 +18,7 @@ This Gem will provide a framework to build command line functional tests against
 * Add colors to make your tests more readable and easier to understand
 * Use pre-built tools to analyse your output or build your own
 
-## SYNOPSIS:
+## Introduction
 
 ```ruby
 require "app-tester"
@@ -29,16 +31,21 @@ apptester = AppTester.new do |options|
 end
 
 # Define your tests
-apptester.define_test "my test" do |cmd_options, connection|
-  result = connection.get do |request|
-    request.url "/"
-  end
+apptester.define_test "my test" do |arguments, connection|
+  # Perform a get request to "/"
+  result1 = get "/"
+  # Perform a post request to "/" with token as parameter
+  result2 = get "/", :token => "hello"
+  # Perform a post request to "/"
+  result3 = post "/"
+  # Perform a post request to "/" with token as parameter
+  result4 = post "/", :token => "hello"
 
   # Check if we have a 200 OK or not
-  AppTester::Checker.status result
+  AppTester::Checker.status result1
 
   # Convert a file to an array
-  p AppTester::Utils.file_to_array cmd_options[:file] unless cmd_options[:file].nil?
+  p AppTester::Utils.file_to_array arguments[:file] unless arguments[:file].nil?
 end
 
 apptester.set_options_for "my test" do |options_parser|
@@ -78,13 +85,13 @@ Connecting to https://github.com...
 [SUCCESS] got status 200
 ```
 
-## REQUIREMENTS:
+## Requirements
 
 * json >= 1.7.5
 * faraday >= 0.8.4
 * optparse
 
-## INSTALL:
+## Intall
 
 It's very easy to install.
 
@@ -109,10 +116,8 @@ apptester = AppTester.new do |options|
 end
 
 # Define your tests
-apptester.define_test "my test" do |cmd_options, connection|
-  result = connection.get do |request|
-    request.url "/"
-  end
+apptester.define_test "my test" do |arguments, connection|
+  result = get "/"
 
   puts "#{AppTester::Utils::Colours.red("Hello")} #{AppTester::Utils::Colours.green("World")}"
 end
@@ -144,7 +149,7 @@ Available colours are:
 You can benchmark your test. This is very useful to understand if anything is underperforming.
 Tests can be nested inside each other.
 
-```
+```ruby
 require "app-tester"
 
 # Initialize framework with test environments
@@ -154,10 +159,8 @@ apptester = AppTester.new do |options|
 end
 
 # Define your tests
-apptester.define_test "my test" do |cmd_options, connection|
-  result = connection.get do |request|
-    request.url "/"
-  end
+apptester.define_test "my test" do |arguments, connection|
+  result = get "/"
 
   AppTester::Timer.new("test timer 1") do
     sleep 1
@@ -191,7 +194,7 @@ We can have, for example, a functional test to an API where we want to run 100 s
 
 Here is an example:
 
-```
+```ruby
 require "app-tester"
 
 apptester = AppTester.new do |options|
@@ -200,13 +203,12 @@ apptester = AppTester.new do |options|
   options.default_environment = :google
 end
 
-apptester.define_test "my test" do |cmd_options, connection|
-  result = connection.get do |request|
-    request.url "/"
-  end
+apptester.define_test "my test" do |arguments, connection|
+  result = get "/"
+
   AppTester::Checker.status result
 
-  my_file = AppTester::Utils.file_to_array cmd_options[:file]
+  my_file = AppTester::Utils.file_to_array arguments[:file]
 
   my_file.each do |line|
     # do awesome stuff with line

data/Rakefile

@@ -1,28 +1,13 @@
 require 'rubygems'
-gem 'hoe', '>= 2.1.0'
 gem "json", "~> 1.7.5"
 gem "faraday", "~> 0.8.4"
-require 'hoe'
 require 'fileutils'
 require './lib/app-tester'
 
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
-
 # Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'app-tester' do
-  self.developer 'Jose P. Airosa', 'me@joseairosa.com'
-  #self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  self.rubyforge_name       = self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-
-end
+# Run 'rake -T' to see list of generated tasks (from gem root direct
 
-require 'newgem/tasks'
 Dir['tasks/**/*.rake'].each { |t| load t }
 
 # TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
 task :default => [:rspec]

data/lib/app-tester/test.rb

@@ -1,3 +1,6 @@
+require "rspec"
+require "rspec-expectations"
+
 module AppTester
   # @abstract Main object that hold all the data needed to run a test
   # @attr_reader parser [AppTester::Parser] user selected options on command line
@@ -13,10 +16,14 @@ module AppTester
     attr_reader :connection
     attr_reader :options
 
-    def initialize name, options={ }
+    attr_writer :self_before_instance_eval
+
+    include RSpec::Matchers
+
+    def initialize name, options={ }, &block
       @name = name
       @options = options
-      @source = Proc.new { |parser_options, connection| yield(parser_options, connection) }
+      @source = block
       @parser = AppTester::Parser.new(options)
       @parser.banner = @name
     end
@@ -26,6 +33,22 @@ module AppTester
       yield(@parser) if block_given?
     end
 
+    def arguments
+      @parser.options
+    end
+
+    def get url="", parameters={}
+      connection.get do |request|
+        request.url "/", parameters
+      end
+    end
+
+    def post url="", parameters={}
+      connection.post do |request|
+        request.url url, parameters
+      end
+    end
+
     # Run test
     def run(arguments=ARGV)
       append_help_option
@@ -33,7 +56,22 @@ module AppTester
       # Make sure we have enough arguments
       raise OptionParser::MissingArgument if @parser.mandatory_options + 2 > @parser.options.size + 1
       @connection = AppTester::Connection.new @parser.options[:server], @options
-      @source.call(@parser.options, @connection)
+      @self_before_instance_eval = eval "self", @source.binding
+      begin
+        self.instance_eval &@source
+      rescue RSpec::Expectations::ExpectationNotMetError => excp
+        unless defined? IS_RSPEC
+          backtrace = excp.backtrace.map { |x|
+            x.match(/^(.+?):(\d+)(|:in `(.+)')$/);
+            [$1, $2, $4]
+          }
+          line_number = 0
+          backtrace.each do |array|
+            line_number = array[1] if array[2] == "block in <main>"
+          end
+          puts "#{AppTester::Utils::Strings::FAILED} #{excp.message} on line #{line_number}"
+        end
+      end
     end
 
     private

data/lib/app-tester.rb

@@ -3,7 +3,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 # @abstract AppTester main module and namespace
 module AppTester
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 
   # @abstract AppTester main class
   # @attr_reader [AppTester::Options] Options container. This will be shared across other classes
@@ -36,9 +36,7 @@ module AppTester
     #
     # @param name [String] name for this test
     #
-    # @yield [cmd_options, connection] code snippet that will be executed when AppTester::Test.run is issued
-    # @yieldparam cmd_options [AppTester::Parser] user selected options on command line
-    # @yieldparam connection [Faraday::Connection] the connection handler to the server selected on command line (or default fallback)
+    # @yield code snippet that will be executed when AppTester::Test.run is issued
     #
     # @return [AppTester::Test] if the creation of this test was successfull with a block
     # @return [NilClass] if the creation of this test was successfull with no block
@@ -54,14 +52,12 @@ module AppTester
     #
     #     p AppTester::Utils.file_to_array cmd_options[:file] unless cmd_options[:file].nil?
     #   end
-    def define_test name=""
+    def define_test name="", &block
       if name.empty?
         raise AppTester::Error::NameEmptyError, "Attempted to define a test without a name"
       else
         if block_given?
-          @tests[name.to_sym] = AppTester::Test.new(name, @options) do |cmd_options, connection|
-            yield cmd_options, connection
-          end
+          @tests[name.to_sym] = AppTester::Test.new(name, @options, &block)
         else
           @tests[name.to_sym] = nil
         end

data/spec/app-tester_spec.rb

@@ -25,7 +25,7 @@ describe "App Tester framework" do
   it "should return help when asked for it" do
     apptester = start_app_tester
 
-    apptester.define_test "my test" do |options, connection|
+    apptester.define_test "my test" do
       # blergh!
     end
 
@@ -37,12 +37,12 @@ describe "App Tester framework" do
 
     mock_arguments "-s" => "production"
 
-    apptester.define_test("test 1") do |options, connection|
-      options.should be_a(Hash)
+    apptester.define_test("test 1") do
+      arguments.should be_a(Hash)
       connection.should be_a(Faraday::Connection)
     end
-    apptester.define_test("test 2") do |options, connection|
-      options.should be_a(Hash)
+    apptester.define_test("test 2") do
+      arguments.should be_a(Hash)
       connection.should be_a(Faraday::Connection)
     end
     apptester.tests.size.should eq(2)
@@ -53,8 +53,8 @@ describe "App Tester framework" do
   it "should define a test without a default environment" do
     apptester = start_app_tester
 
-    apptester.define_test "my test" do |options, connection|
-      options[:server].should eq("localhost://production")
+    apptester.define_test "my test" do
+      arguments[:server].should eq("localhost://production")
     end
 
     apptester.run_test("my test", [])
@@ -63,8 +63,8 @@ describe "App Tester framework" do
   it "should define a test with a default environment" do
     apptester = start_app_tester nil, :staging
 
-    apptester.define_test "my test" do |options, connection|
-      options[:server].should eq("localhost://staging")
+    apptester.define_test "my test" do
+      arguments[:server].should eq("localhost://staging")
     end
 
     apptester.run_test("my test", [])
@@ -73,12 +73,12 @@ describe "App Tester framework" do
   it "should define a test, set custom options and run" do
     apptester = start_app_tester
 
-    apptester.define_test "my test" do |options, connection|
-      options.should be_a(Hash)
+    apptester.define_test "my test" do
+      arguments.should be_a(Hash)
       connection.should be_a(Faraday::Connection)
-      options.size.should be(2)
-      options[:server].should_not be_empty
-      options[:smiles_file].should_not be_empty
+      arguments.size.should be(2)
+      arguments[:server].should_not be_empty
+      arguments[:smiles_file].should_not be_empty
     end
 
     apptester.set_options_for "my test" do |test_options|
@@ -93,7 +93,7 @@ describe "App Tester framework" do
   it "should define a test, set custom options, define number mandatory options and run" do
     apptester = start_app_tester
 
-    apptester.define_test "my test" do |options, connection|
+    apptester.define_test "my test" do
 
     end
 
@@ -110,7 +110,7 @@ describe "App Tester framework" do
   it "should create a connection" do
     apptester = start_app_tester :production => "http://www.google.com"
 
-    apptester.define_test "my test" do |options, connection|
+    apptester.define_test "my test" do
       connection.should be_a(Faraday::Connection)
     end
 
@@ -122,12 +122,12 @@ describe "App Tester framework" do
   it "should fetch contents of a connection" do
     apptester = start_app_tester :production => "https://github.com"
 
-    apptester.define_test "my test" do |options, connection|
-      response = connection.get do |req|
-        req.url "/"
-      end
+    apptester.define_test "my test" do
+      response = get "/"
       response.status.should eq(200)
       response.body.should include("github")
+      response = post "/"
+      response.status.should eq(403)
     end
 
     mocked_arguments = mock_arguments "-s" => "production"
@@ -138,11 +138,9 @@ describe "App Tester framework" do
   it "should return exception on connection failed" do
     apptester = start_app_tester :production => "http://aoisjdioasjdioasjod"
 
-    apptester.define_test "my test" do |options, connection|
+    apptester.define_test "my test" do
       begin
-        response = connection.get do |req|
-          req.url "/"
-        end
+        response = get "/"
       rescue Exception => e
         e.should be_a(Faraday::Error::ConnectionFailed)
       end
@@ -156,10 +154,8 @@ describe "App Tester framework" do
   it "should check status" do
     apptester = start_app_tester :production => "https://github.com"
 
-    apptester.define_test "my test" do |options, connection|
-      response = connection.get do |req|
-        req.url "/"
-      end
+    apptester.define_test "my test" do
+      response = get "/"
       AppTester::Checker.status response
     end
 
@@ -173,10 +169,8 @@ describe "App Tester framework" do
   it "should log connections if asked for" do
     apptester = start_app_tester({ :production => "https://github.com" }, nil, true)
 
-    apptester.define_test "my test" do |options, connection|
-      response = connection.get do |req|
-        req.url "/"
-      end
+    apptester.define_test "my test" do
+      response = get "/"
     end
 
     mocked_arguments = mock_arguments "-s" => "production"
@@ -219,7 +213,7 @@ describe "App Tester framework" do
   it "should time the execution" do
     apptester = start_app_tester
 
-    apptester.define_test "my test" do |options, connection|
+    apptester.define_test "my test" do
       AppTester::Timer.new("test timer") do
         sleep 1
       end
@@ -233,13 +227,13 @@ describe "App Tester framework" do
   it "should time the execution with threshold" do
     apptester = start_app_tester
 
-    apptester.define_test "my test 400 threshold" do |options, connection|
+    apptester.define_test "my test 400 threshold" do
       AppTester::Timer.new("test timer", 400) do
         sleep 0.5
       end
     end
 
-    apptester.define_test "my test 600 threshold" do |options, connection|
+    apptester.define_test "my test 600 threshold" do
       AppTester::Timer.new("test timer", 600) do
         sleep 0.5
       end

data/spec/spec_helper.rb

@@ -6,5 +6,7 @@ rescue LoadError
   require 'rspec'
 end
 
+IS_RSPEC = true
+
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'app-tester'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app-tester
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -43,6 +43,70 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Command-line Framework to run functional tests against a web application
   (API, Website, etc)
 email: me@joseairosa.com
@@ -72,7 +136,7 @@ files:
 homepage: https://github.com/joseairosa/app-tester
 licenses:
 - MIT
-post_install_message: ! "\e[0;32mThanks for installing! You're awesome ^_^\e[0m"
+post_install_message: ! "\e[0;32mThanks for installing! You're awesome! ^_^\e[0m"
 rdoc_options: []
 require_paths:
 - lib