lopata 0.1.13 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19371c76dcc39807c50470e95f365a09c1c33a8193a25b9d98d4d5648f5eaa59
-  data.tar.gz: 25c3b8ea2efe44f5cf31f51cea04aa05f2ea35f364ed2167f9cdd466fa6a5e46
+  metadata.gz: b016b2963faca94942b2f9800c37be27e85221241a00c3f888775380983ebd13
+  data.tar.gz: 100227eb53c7642def09cf3c9edc64b0036ba2ddb766feeb441d159ca02e73d0
 SHA512:
-  metadata.gz: 7b7378f73bd4fe3c7ce18bcd7e7a0d5f45b05cafac689d764ad3030f879ad1e0c1843e67ddd886ba68643632c33eea9824efbe0b370dea76fe911e03d95fc355
-  data.tar.gz: af7ba11d74022ab03a11a62bec31291edba71e6b5c93f1229b765a159e2ce3d14813af5f2967c1d054d7f5e2fc656b593bdce876fbcb9a03cade19a0fbcb3753
+  metadata.gz: 646a6432a265c98966b2938564a57fb06e321a3b6cc67722b3021815586002e26e27fa4282eb5647404e5ca8582453747ee669b015e3e3ae666f3e706cbf3bfd
+  data.tar.gz: 9e4d413066ed6714024fa3df2252eb8c6256892036e1a9a89ab36f391a21db211b9c82d8b5afb3b89b293b4926e9af028527fa7360aa9ca17fe61d0b6796e2cd

data/README.md

@@ -1,26 +1,26 @@
-# Lopata
-
-Functional acceptance testing using Ruby.
-
-## Installation
-
-    gem install lopata
-
-## Usage
-
-Create new lopata project:
-
-    lopata new <project-name>
-
-Setup environment: edit <project-name>/config/environments/qa.yml for setup project for testing.
-
-Write tests: puts tests in <project-name>/scenarios folder. Define shared steps in <project-name>/shared_steps folder.
-
-Run tests:
-
-    cd <project-name>
-    lopata
-
-## Documentation
-
+# Lopata
+
+Functional acceptance testing using Ruby.
+
+## Installation
+
+    gem install lopata
+
+## Usage
+
+Create new lopata project:
+
+    lopata new <project-name>
+
+Setup environment: edit <project-name>/config/environments/qa.yml for setup project for testing.
+
+Write tests: puts tests in <project-name>/scenarios folder. Define shared steps in <project-name>/shared_steps folder.
+
+Run tests:
+
+    cd <project-name>
+    lopata
+
+## Documentation
+
 See [features description](https://github.com/avolochnev/lopata/tree/master/features) for documentation.

data/exe/lopata

@@ -1,11 +1,11 @@
-#!/usr/bin/env ruby
-require 'bundler/setup'
-require 'lopata/runner'
-
-# use default command with arguments if given command is unknown.
-argv = ARGV.dup
-unless Lopata::Runner.all_commands.keys.map(&:to_s).include? argv.first
-  argv.unshift 'test'
-end
-
-Lopata::Runner.start argv
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'lopata/runner'
+
+# use default command with arguments if given command is unknown.
+argv = ARGV.dup
+unless Lopata::Runner.all_commands.keys.map(&:to_s).include? argv.first
+  argv.unshift 'test'
+end
+
+Lopata::Runner.start argv

data/lib/lopata/active_record.rb

@@ -1,136 +1,136 @@
-module Lopata
-  # Helpers for ActiveRecord usage in tests.
-  #
-  # Make helpers available in scenarios by
-  #
-  #     require 'lopata/active_record'
-  #
-  # @example
-  #
-  #     # Configure db connection at config/environments/qa.yml like rails:
-  #     # db:
-  #     #   adapter: postgresql
-  #     #   host: your.database.host
-  #     #   username: username
-  #     #   password: password
-  #     #   database: database
-  #     require 'active_record'
-  #     require 'lopata/active_record'
-  #
-  #     class User < ActiveRecord::Base; end
-  #
-  #     Lopata.define 'User creation' do
-  #       setup do
-  #         @user = User.create!(username: 'testuser')
-  #       end
-  #       # Remove user from database after scenario
-  #       cleanup :user
-  #
-  #       it 'works' do
-  #         expect(@user).to_not be_nil
-  #       end
-  #     end
-  #
-  module ActiveRecord
-    # To be included in Lopata::Scenario. The methods may be used in runtime.
-    module Methods
-      # Destroy ActiveRecord objects.
-      #
-      # Does nothing if 'keep' mode is enabled:
-      #
-      #     Lopata.configure do |c|
-      #       c.keep = true
-      #     end
-      #
-      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be destroyed
-      # @see Lopata::Configuration#keep
-      def cleanup(*objects)
-        return if Lopata.configuration.keep
-        objects.flatten.compact.each do |o|
-          begin
-            o.reload.destroy!
-          rescue ::ActiveRecord::RecordNotFound
-            # Already destroyed - skip
-          rescue ::ActiveRecord::InvalidForeignKey
-            # Possible async job created new relationships (e.g. history records). Try again once.
-            o.reload.destroy!
-          end
-        end
-      end
-
-      # Reload ActiveRecord objects
-      #
-      # @example
-      #
-      #     # use in steps
-      #     reload @a, @b
-      #     # instead of
-      #     @a.reload; @b.reload
-      #
-      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be reloaded
-      def reload(*objects)
-        objects.flatten.compact.each(&:reload)
-      end
-
-      # Marks object to be destroyed at the end of scenario
-      #
-      # @param object [ActiveRecord::Base] the object to be destoryed at the end of scenario
-      # @return the given object, so chains can be build
-      def cleanup_later(object)
-        return nil unless object
-        @created_objects ||= []
-        @created_objects << object
-        object
-      end
-
-      # Find ActiveRecord object of given class by params.
-      # Marks the returned object to be destroyed at the end of scenario.
-      #
-      # @example
-      #     action do
-      #       # UI actions creating the user
-      #       @user = find_created(User, username: 'testuser')
-      #     end
-      #     it 'created' do
-      #       expect(@user).to_not be_nil
-      #     end
-      #     # No cleanup needed
-      #     # cleanup :user
-      #
-      # @param cls [Class] active record model class
-      # @param params [Hash] options for record finding
-      # @return [ActiveRecord::Base, nil] the object or nil if not found
-      # @see #cleanup_later called on the hood
-      def find_created(cls, params)
-        cleanup_later cls.where(params).take
-      end
-    end
-
-    # To be included in Lopata::ScenarioBuilder. The methods may be used in build time.
-    module DSL
-      # Mark instance variables to call #destroy at teardown phase of scenario or context running.
-      #
-      # Does nothing if 'keep' mode is enabled.
-      #
-      # @param vars [Array<Symbol, String>] instance variable names to be destroyed on teardown phase.
-      def cleanup(*vars, &block)
-        unless vars.empty?
-          teardown do
-            cleanup vars.map { |v| instance_variable_get "@#{v}" }
-          end
-        end
-        teardown &block if block_given?
-      end
-    end
-  end
-end
-
-Lopata.configure do |c|
-  c.after_scenario { cleanup @created_objects }
-end
-
-params = Lopata.environment['db']
-ActiveRecord::Base.establish_connection(params) if params
-
-Lopata::Scenario.include Lopata::ActiveRecord::Methods
+module Lopata
+  # Helpers for ActiveRecord usage in tests.
+  #
+  # Make helpers available in scenarios by
+  #
+  #     require 'lopata/active_record'
+  #
+  # @example
+  #
+  #     # Configure db connection at config/environments/qa.yml like rails:
+  #     # db:
+  #     #   adapter: postgresql
+  #     #   host: your.database.host
+  #     #   username: username
+  #     #   password: password
+  #     #   database: database
+  #     require 'active_record'
+  #     require 'lopata/active_record'
+  #
+  #     class User < ActiveRecord::Base; end
+  #
+  #     Lopata.define 'User creation' do
+  #       setup do
+  #         @user = User.create!(username: 'testuser')
+  #       end
+  #       # Remove user from database after scenario
+  #       cleanup :user
+  #
+  #       it 'works' do
+  #         expect(@user).to_not be_nil
+  #       end
+  #     end
+  #
+  module ActiveRecord
+    # To be included in Lopata::Scenario. The methods may be used in runtime.
+    module Methods
+      # Destroy ActiveRecord objects.
+      #
+      # Does nothing if 'keep' mode is enabled:
+      #
+      #     Lopata.configure do |c|
+      #       c.keep = true
+      #     end
+      #
+      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be destroyed
+      # @see Lopata::Configuration#keep
+      def cleanup(*objects)
+        return if Lopata.configuration.keep
+        objects.flatten.compact.each do |o|
+          begin
+            o.reload.destroy!
+          rescue ::ActiveRecord::RecordNotFound
+            # Already destroyed - skip
+          rescue ::ActiveRecord::InvalidForeignKey
+            # Possible async job created new relationships (e.g. history records). Try again once.
+            o.reload.destroy!
+          end
+        end
+      end
+
+      # Reload ActiveRecord objects
+      #
+      # @example
+      #
+      #     # use in steps
+      #     reload @a, @b
+      #     # instead of
+      #     @a.reload; @b.reload
+      #
+      # @param objects [Array<ActiveRecord::Base, Array<ActiveRecord::Base>, nil>] to be reloaded
+      def reload(*objects)
+        objects.flatten.compact.each(&:reload)
+      end
+
+      # Marks object to be destroyed at the end of scenario
+      #
+      # @param object [ActiveRecord::Base] the object to be destoryed at the end of scenario
+      # @return the given object, so chains can be build
+      def cleanup_later(object)
+        return nil unless object
+        @created_objects ||= []
+        @created_objects << object
+        object
+      end
+
+      # Find ActiveRecord object of given class by params.
+      # Marks the returned object to be destroyed at the end of scenario.
+      #
+      # @example
+      #     action do
+      #       # UI actions creating the user
+      #       @user = find_created(User, username: 'testuser')
+      #     end
+      #     it 'created' do
+      #       expect(@user).to_not be_nil
+      #     end
+      #     # No cleanup needed
+      #     # cleanup :user
+      #
+      # @param cls [Class] active record model class
+      # @param params [Hash] options for record finding
+      # @return [ActiveRecord::Base, nil] the object or nil if not found
+      # @see #cleanup_later called on the hood
+      def find_created(cls, params)
+        cleanup_later cls.where(params).take
+      end
+    end
+
+    # To be included in Lopata::ScenarioBuilder. The methods may be used in build time.
+    module DSL
+      # Mark instance variables to call #destroy at teardown phase of scenario or context running.
+      #
+      # Does nothing if 'keep' mode is enabled.
+      #
+      # @param vars [Array<Symbol, String>] instance variable names to be destroyed on teardown phase.
+      def cleanup(*vars, &block)
+        unless vars.empty?
+          teardown do
+            cleanup vars.map { |v| instance_variable_get "@#{v}" }
+          end
+        end
+        teardown &block if block_given?
+      end
+    end
+  end
+end
+
+Lopata.configure do |c|
+  c.after_scenario { cleanup @created_objects }
+end
+
+params = Lopata.environment['db']
+ActiveRecord::Base.establish_connection(params) if params
+
+Lopata::Scenario.include Lopata::ActiveRecord::Methods
 Lopata::ScenarioBuilder.include Lopata::ActiveRecord::DSL

data/lib/lopata/condition.rb

@@ -1,31 +1,31 @@
-module Lopata
-  # @private
-  class Condition
-    attr_reader :condition, :positive
-    def initialize(condition, positive: true)
-      @condition, @positive = condition, positive
-    end
-
-    alias positive? positive
-
-    def match?(scenario)
-      matched = match_metadata?(scenario)
-      positive? ? matched : !matched
-    end
-
-    def match_metadata?(scenario)
-      metadata = scenario.metadata
-      case condition
-      when Hash
-        condition.keys.all? { |k| metadata[k] == condition[k] }
-      when Array
-        condition.map { |key| metadata[key] }.all?
-      when TrueClass, FalseClass
-        condition
-      else
-        metadata[condition]
-      end
-    end
-
-  end
+module Lopata
+  # @private
+  class Condition
+    attr_reader :condition, :positive
+    def initialize(condition, positive: true)
+      @condition, @positive = condition, positive
+    end
+
+    alias positive? positive
+
+    def match?(scenario)
+      matched = match_metadata?(scenario)
+      positive? ? matched : !matched
+    end
+
+    def match_metadata?(scenario)
+      metadata = scenario.metadata
+      case condition
+      when Hash
+        condition.keys.all? { |k| metadata[k] == condition[k] }
+      when Array
+        condition.map { |key| metadata[key] }.all?
+      when TrueClass, FalseClass
+        condition
+      else
+        metadata[condition]
+      end
+    end
+
+  end
 end

data/lib/lopata/configuration.rb

@@ -1,126 +1,126 @@
-module Lopata
-  # Stores runtime configuration information
-  #
-  # @see Lopata.configure
-  # @see Lopata.configuration
-  class Configuration
-    # Build an object to store runtime configuration options and set defaults
-    def initialize
-      @before_start_hooks = []
-      @before_scenario_steps = []
-      @after_scenario_steps = []
-      @observers = [Lopata::Observers::ConsoleOutputObserver.new]
-      @role_descriptions = {}
-      @env = :qa
-    end
-
-    # Add the hook to be called before scenarios running
-    # The block will be called after framework initialization and before scenarios parsing.
-    # It usually allow to require and initialize the libraries used for project testing.
-    #
-    # @example
-    #     Lopata.configure do |c|
-    #       c.before_start do
-    #         require 'active_record'
-    #       end
-    #     end
-    def before_start(&block)
-      @before_start_hooks << block
-    end
-
-    # @private
-    def run_before_start_hooks
-      @before_start_hooks.each(&:call)
-    end
-
-    # Defines 'before scenario' steps.
-    # Given steps will be runned before each scenario in context of scenario.
-    # It may be shared step names, and|or block.
-    #
-    # @example
-    #     Lopata.configure do |c|
-    #       c.before_scenario 'setup test user'
-    #     end
-    #
-    # @param steps [Array<String>] name of shared steps
-    # @param block [Proc] block of code
-    def before_scenario(*steps, &block)
-      before_scenario_steps.append(*steps) unless steps.empty?
-      before_scenario_steps.append(block) if block_given?
-    end
-
-    # Defines 'after scenario' steps.
-    # Given steps will be runned after each scenario in context of scenario.
-    # It may be shared step names, and|or block.
-    #
-    # @example
-    #     Lopata.configure do |c|
-    #       c.after_scenario 'cleanup test user'
-    #     end
-    #
-    # @param steps [Array<String>] name of shared steps
-    # @param block [Proc] block of code
-    def after_scenario(*steps, &block)
-      after_scenario_steps.append(*steps) unless steps.empty?
-      after_scenario_steps.append(block) if block_given?
-    end
-
-    # @private
-    attr_reader :before_scenario_steps, :after_scenario_steps
-
-    # Add an observer to the set Lopata to be used for this run.
-    #
-    # @param observer [Lopata::Observers::BaseObserver] a observer instance.
-    #
-    # @see Lopata::Observers::BaseObserver
-    def add_observer(observer)
-      @observers << observer
-    end
-
-    # @private
-    attr_reader :observers
-
-    # @private
-    def filters
-      @filters ||= []
-    end
-
-    # @private
-    attr_accessor :web_logging_params
-
-    # @private
-    def init_lopata_logging(url, project_code, build_number)
-      require 'lopata/observers/web_logger'
-      self.web_logging_params = { url: url, project_code: project_code, build_number: build_number }
-      add_observer Lopata::Observers::WebLogger.new
-    end
-
-    # @return [Hash{Symbol => String}] map or role codes to role name.
-    # @see Lopata::Role
-    attr_accessor :role_descriptions
-
-    # @return [Symbol,nil] user role to be used in scenario if not specified
-    # @see Lopata::Role
-    attr_accessor :default_role
-
-    # @return [Symbol] environment code.
-    #   Default is :qa
-    # @see Lopata::Environment
-    attr_accessor :env
-
-    # @return [Boolean] keep generated test data after scenarios running.
-    #   Default is false
-    #   Set to true for keeping generated data.
-    #   Use 'lopata --keep' modifier to set keep mode on running.
-    # @see Lopata::ActiveRecord::Methods#cleanup
-    attr_accessor :keep
-
-    # @private
-    attr_accessor :environment
-
-    # @private
-    def load_environment
-      self.environment = Lopata::Environment.new(env)
-    end
-  end
+module Lopata
+  # Stores runtime configuration information
+  #
+  # @see Lopata.configure
+  # @see Lopata.configuration
+  class Configuration
+    # Build an object to store runtime configuration options and set defaults
+    def initialize
+      @before_start_hooks = []
+      @before_scenario_steps = []
+      @after_scenario_steps = []
+      @observers = [Lopata::Observers::ConsoleOutputObserver.new]
+      @role_descriptions = {}
+      @env = :qa
+    end
+
+    # Add the hook to be called before scenarios running
+    # The block will be called after framework initialization and before scenarios parsing.
+    # It usually allow to require and initialize the libraries used for project testing.
+    #
+    # @example
+    #     Lopata.configure do |c|
+    #       c.before_start do
+    #         require 'active_record'
+    #       end
+    #     end
+    def before_start(&block)
+      @before_start_hooks << block
+    end
+
+    # @private
+    def run_before_start_hooks
+      @before_start_hooks.each(&:call)
+    end
+
+    # Defines 'before scenario' steps.
+    # Given steps will be runned before each scenario in context of scenario.
+    # It may be shared step names, and|or block.
+    #
+    # @example
+    #     Lopata.configure do |c|
+    #       c.before_scenario 'setup test user'
+    #     end
+    #
+    # @param steps [Array<String>] name of shared steps
+    # @param block [Proc] block of code
+    def before_scenario(*steps, &block)
+      before_scenario_steps.append(*steps) unless steps.empty?
+      before_scenario_steps.append(block) if block_given?
+    end
+
+    # Defines 'after scenario' steps.
+    # Given steps will be runned after each scenario in context of scenario.
+    # It may be shared step names, and|or block.
+    #
+    # @example
+    #     Lopata.configure do |c|
+    #       c.after_scenario 'cleanup test user'
+    #     end
+    #
+    # @param steps [Array<String>] name of shared steps
+    # @param block [Proc] block of code
+    def after_scenario(*steps, &block)
+      after_scenario_steps.append(*steps) unless steps.empty?
+      after_scenario_steps.append(block) if block_given?
+    end
+
+    # @private
+    attr_reader :before_scenario_steps, :after_scenario_steps
+
+    # Add an observer to the set Lopata to be used for this run.
+    #
+    # @param observer [Lopata::Observers::BaseObserver] a observer instance.
+    #
+    # @see Lopata::Observers::BaseObserver
+    def add_observer(observer)
+      @observers << observer
+    end
+
+    # @private
+    attr_reader :observers
+
+    # @private
+    def filters
+      @filters ||= []
+    end
+
+    # @private
+    attr_accessor :web_logging_params
+
+    # @private
+    def init_lopata_logging(url, project_code, build_number)
+      require 'lopata/observers/web_logger'
+      self.web_logging_params = { url: url, project_code: project_code, build_number: build_number }
+      add_observer Lopata::Observers::WebLogger.new
+    end
+
+    # @return [Hash{Symbol => String}] map or role codes to role name.
+    # @see Lopata::Role
+    attr_accessor :role_descriptions
+
+    # @return [Symbol,nil] user role to be used in scenario if not specified
+    # @see Lopata::Role
+    attr_accessor :default_role
+
+    # @return [Symbol] environment code.
+    #   Default is :qa
+    # @see Lopata::Environment
+    attr_accessor :env
+
+    # @return [Boolean] keep generated test data after scenarios running.
+    #   Default is false
+    #   Set to true for keeping generated data.
+    #   Use 'lopata --keep' modifier to set keep mode on running.
+    # @see Lopata::ActiveRecord::Methods#cleanup
+    attr_accessor :keep
+
+    # @private
+    attr_accessor :environment
+
+    # @private
+    def load_environment
+      self.environment = Lopata::Environment.new(env)
+    end
+  end
 end