Module: AppTester Abstract

Defined in:
lib/app-tester.rb,
lib/app-tester/core.rb,
lib/app-tester/test.rb,
lib/app-tester/timer.rb,
lib/app-tester/utils.rb,
lib/app-tester/parser.rb,
lib/app-tester/checker.rb,
lib/app-tester/options.rb,
lib/app-tester/connection.rb,
lib/app-tester/exceptions.rb,
lib/app-tester/utils/colors.rb,
lib/app-tester/utils/strings.rb

Overview

This module is abstract.

AppTester main module and namespace

Defined Under Namespace

Modules: Checker, Error, Utils Classes: Connection, Core, Options, Parser, Test, Timer

Constant Summary collapse

VERSION = 
'0.1.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.options ⇒ Object (readonly)

Returns the value of attribute options.



13
14
15
 
# File 'lib/app-tester.rb', line 13

def options
  @options
end

.tests ⇒ Object (readonly)

Returns the value of attribute tests.



14
15
16
 
# File 'lib/app-tester.rb', line 14

def tests
  @tests
end

Class Method Details

.define_test(name = "") { ... } ⇒ AppTester::Test, NilClass

Create a new test object

Examples:

Define a new test

apptester.define_test "my test" do |cmd_options, connection|
  result = connection.get do |request|
    request.url "/"
  end
  AppTester::Checker.status result

  p AppTester::Utils.file_to_array cmd_options[:file] unless cmd_options[:file].nil?
end

Parameters:

  • name (String) (defaults to: "") —

    name for this test

Yields:

  • code snippet that will be executed when AppTester::Test.run is issued

Returns:

  • (AppTester::Test) —

    if the creation of this test was successfull with a block

  • (NilClass) —

    if the creation of this test was successfull with no block

Raises:



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/app-tester.rb', line 55

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, &block)
    else
      @tests[name.to_sym] = nil
    end
  end
end

.get_test(name) ⇒ AppTester::Test

Retrieve a test by name

Examples:

Get a pre-defined test

apptester = AppTester.new do |options|
  options.add_environment :github => "https://github.com"
  options.add_environment :google => "https://google.com"
  options.default_environment = :google
end

apptester.define_test "my test"
my_test = apptester.get_test "my test"

Parameters:

  • name (String) —

    test to retrieve

Returns:

Raises:



84
85
86
87
 
# File 'lib/app-tester.rb', line 84

def get_test name
  raise AppTester::Error::TestNotFoundError, "Could not find test #{name}" unless @tests.keys.include?(name.to_sym)
  @tests[name.to_sym]
end

.load_libraries(*libs) ⇒ NilClass Also known as: load_library

Load libraries to be used under this namespace

Parameters:

  • libs (String) —

    list of libraries to load

Returns:

  • (NilClass) 


155
156
157
158
159
 
# File 'lib/app-tester.rb', line 155

def load_libraries *libs
  libs.each do |lib|
    require_relative "app-tester/#{lib}"
  end
end

.new {|options| ... } ⇒ AppTester

Construct AppTester framework

Examples:

Start AppTester handler

apptester = AppTester.new do |options|
  options.add_environment :github => "https://github.com"
  options.add_environment :google => "https://google.com"
  options.default_environment = :google
  options.log_connection = true
end

Yields:

  • (options) —

    Gives the user the possibility to set generic options for the framework

Yield Parameters:

Returns:



28
29
30
31
32
33
 
# File 'lib/app-tester.rb', line 28

def new
  @tests = {}
  @options = AppTester::Options.new
  yield @options if block_given?
  self
end

.run_test(name, arguments = ARGV) ⇒ AppTester::Test

Run a test

Examples:

Run a test

apptester = AppTester.new do |options|
  options.add_environment :github => "https://github.com"
  options.add_environment :google => "https://google.com"
  options.default_environment = :google
end
apptester.define_test "my test" do |cmd_options, connection|
  result = connection.get do |request|
    request.url "/"
  end
  AppTester::Checker.status result

  p AppTester::Utils.file_to_array cmd_options[:file] unless cmd_options[:file].nil?
end

my_test = apptester.run_test

Parameters:

  • name (String) —

    test name that we want to run

  • arguments (Array) (defaults to: ARGV) —

    overwrite ARGV array with a custom one, useful for unit tests

Returns:

Raises:

  • (AppTester::Error::TestNotFoundError) —

    if no test was found

  • (OptionParser::MissingArgument) —

    if there’s a argument missing from a missmatch in the number of arguments given and mandatory_options on set_options_for method

  • (Faraday::Error::ConnectionFailed) —

    if there was a problem connecting to the selected server



144
145
146
147
148
 
# File 'lib/app-tester.rb', line 144

def run_test name, arguments=ARGV
  the_test = get_test(name)
  the_test.run(arguments)
  the_test
end

.set_options_for(name) {|options_parser| ... } ⇒ AppTester::Test

Defines command line options for a given test

Examples:

Set options for a test

apptester = AppTester.new do |options|
  options.add_environment :github => "https://github.com"
  options.add_environment :google => "https://google.com"
  options.default_environment = :google
end

apptester.define_test "my test"

apptester.set_options_for "my test" do |options_parser|
  options_parser.set_option(:file, "-f", "--file FILE", "File to load")
  options_parser.mandatory_options = 0
end

Parameters:

  • name (String) —

    test name to which we want to define the command line options

Yields:

  • (options_parser) —

    set the command line options for this test

Yield Parameters:

Returns:



111
112
113
114
115
 
# File 'lib/app-tester.rb', line 111

def set_options_for name
  test = get_test name
  yield test.parser
  test
end