lopata 0.1.9 → 0.1.14

data/lib/lopata/role.rb

@@ -1,91 +1,110 @@
-module Lopata
-  # Adds ability to run scenarios by given user roles
-  #
-  # @example Usage
-  #     require 'lopata/role'
-  #     Lopata.configure do |c|
-  #       c.role_descriptions = {
-  #         user: 'User',
-  #         admin: 'Admin'
-  #       }
-  #       c.default_role = :user
-  #       c.before_scenaro 'setup user'
-  #     end
-  #     Lopata.shared_step 'setup user' do
-  #       setup { @user = User.create(role: current_role) if current_role }
-  #       cleanup :user
-  #     end
-  #     Lopata.define 'login' do
-  #       # will generate 2 scenarios, one for :user and one for :admin
-  #       as :user, :admin
-  #       action 'login'
-  #       # verify the user is logged in
-  #     end
-  #
-  # @see Lopata::Configuration#role_descriptions
-  # @see Lopata::Configuration#default_role
-  module Role
-    # To be included in Lopata::Scenario
-    module Methods
-      # @return [Symbol, nil] user role for current scenario or nil, if scenario is running without user.
-      def current_role
-        metadata[:as]
-      end
-    end
-
-    # To be included in Lopata::ScenarioBuilder
-    module DSL
-      # Enumerate the roles the scenario to be runned under.
-      # If not invoked the default role only will be used.
-      #
-      # The scenario should be set to use the role via before_scenario step using #current_role param.
-      #
-      # @param args [Array<Symbol>] list of roles the scenario to be runned with.
-      # @param block [Block] the block to calculate role from scenario metadata.
-      def as(*args, &block)
-        @roles = args.flatten
-        @roles << Lopata::ScenarioBuilder::CalculatedValue.new(&block) if block_given?
-        @role_options = nil
-      end
-
-      # @private
-      def role_options
-        @role_options ||= build_role_options
-      end
-
-      # Marks scenario to be runned without user.
-      #
-      # @example
-      #     Lopata.define 'scenario withou user' do
-      #       without_user
-      #       it 'does not define the user' do
-      #         expect(current_role).to be_nil
-      #       end
-      #     end
-      def without_user
-        @without_user = true
-      end
-
-      # @private
-      def build_role_options
-        return [] unless roles
-        [Lopata::ScenarioBuilder::Diagonal.new(:as, roles.map { |r| [Lopata.configuration.role_descriptions[r], r] })]
-      end
-
-      # @private
-      def roles
-        return false if @without_user
-        @roles ||= [Lopata.configuration.default_role].compact
-      end
-
-      # @private
-      def diagonals
-        super + role_options
-      end
-    end
-  end
-end
-
-Lopata::Scenario.include Lopata::Role::Methods
-# Prepend the module to overload #diagonals method
+module Lopata
+  # Adds ability to run scenarios by given user roles
+  #
+  # @example Usage
+  #     require 'lopata/role'
+  #     Lopata.configure do |c|
+  #       c.role_descriptions = {
+  #         user: 'User',
+  #         admin: 'Admin'
+  #       }
+  #       c.default_role = :user
+  #       c.before_scenaro 'setup user'
+  #     end
+  #     Lopata.shared_step 'setup user' do
+  #       setup { @user = User.create(role: current_role) if current_role }
+  #       cleanup :user
+  #     end
+  #     Lopata.define 'login' do
+  #       # will generate 2 scenarios, one for :user and one for :admin
+  #       as :user, :admin
+  #       action 'login'
+  #       # verify the user is logged in
+  #     end
+  #
+  # @see Lopata::Configuration#role_descriptions
+  # @see Lopata::Configuration#default_role
+  module Role
+    # To be included in Lopata::Scenario
+    module Methods
+      # @return [Symbol, nil] user role for current scenario or nil, if scenario is running without user.
+      def current_role
+        metadata[:as]
+      end
+    end
+
+    # To be included in Lopata::ScenarioBuilder
+    module DSL
+      # Enumerate the roles the scenario to be runned under.
+      # If not invoked the default role only will be used.
+      #
+      # The scenario should be set to use the role via before_scenario step using #current_role param.
+      #
+      # @param args [Array<Symbol>] list of roles the scenario to be runned with.
+      # @param block [Block] the block to calculate role from scenario metadata.
+      def as(*args, &block)
+        @roles = args.flatten
+        @roles << Lopata::ScenarioBuilder::CalculatedValue.new(&block) if block_given?
+        @use_all_roles = true
+        @role_options = nil
+      end
+
+      # Enumerate the roles the scenario can be run.
+      #
+      # The scenario should be set to use the role via before_scenario step using #current_role param.
+      #
+      # Only first role will be used if scenario has no options or diagonales. Some first roles will be used if
+      # options or diagonales are declared, in order of appearence.
+      #
+      # Use this to describe possible roles, but not needed to run scenario with all of them in order to save time
+      # of running.
+      #
+      # @param args [Array<Symbol>] list of roles the scenario to be runned with.
+      def as_first(*args, &block)
+        @roles = args.flatten
+        @use_all_roles = false
+        @role_options = nil
+      end
+
+      # @private
+      def role_options
+        @role_options ||= build_role_options
+      end
+
+      # Marks scenario to be runned without user.
+      #
+      # @example
+      #     Lopata.define 'scenario withou user' do
+      #       without_user
+      #       it 'does not define the user' do
+      #         expect(current_role).to be_nil
+      #       end
+      #     end
+      def without_user
+        @without_user = true
+      end
+
+      # @private
+      def build_role_options
+        return [] unless roles
+        role_variants = roles.map { |r| [Lopata.configuration.role_descriptions[r], r] }
+        [Lopata::ScenarioBuilder::Diagonal.new(:as, role_variants, @use_all_roles)]
+      end
+
+      # @private
+      def roles
+        return false if @without_user
+        @roles ||= [Lopata.configuration.default_role].compact
+      end
+
+      # @private
+      def diagonals
+        super + role_options
+      end
+    end
+  end
+end
+
+Lopata::Scenario.include Lopata::Role::Methods
+# Prepend the module to overload #diagonals method
 Lopata::ScenarioBuilder.prepend Lopata::Role::DSL

data/lib/lopata/runner.rb

@@ -1,67 +1,67 @@
-require 'thor'
-require_relative 'generators/app'
-require_relative 'world'
-require_relative 'loader'
-require_relative '../lopata'
-require_relative 'observers'
-require_relative 'condition'
-
-module Lopata
-  # @private
-  class Runner < Thor
-    desc 'test', 'Run tests'
-    option :env, default: :qa, aliases: 'e'
-    option :rerun, type: :boolean, aliases: 'r'
-    option :keep, type: :boolean, aliases: 'k'
-    option :text, aliases: 't'
-    def test(*args)
-      trap_interrupt
-      configure_from_options
-      Lopata::Loader.load_shared_steps
-      Lopata::Loader.load_scenarios(*args)
-      world = Lopata.world
-      world.notify_observers(:started, world)
-      world.scenarios.each { |s| s.run }
-      world.notify_observers(:finished, world)
-    end
-
-    default_task :test
-
-    register Generators::App, :new, 'lopata new project-name', 'Init new lopata projects'
-
-    def self.exit_on_failure?
-      true
-    end
-
-    no_commands do
-      def configure_from_options
-        Lopata.configure do |c|
-          c.env = options[:env].to_sym
-          c.keep = options[:keep]
-          c.load_environment
-          c.run_before_start_hooks
-        end
-        add_text_filter(options[:text]) if options[:text]
-        add_rerun_filter if options[:rerun]
-      end
-
-      def add_text_filter(text)
-        Lopata.configuration.filters << -> (scenario) { scenario.title.include?(text) }
-      end
-
-      def add_rerun_filter
-        to_rerun = Lopata::Client.new.to_rerun
-        Lopata.configuration.filters << -> (scenario) { to_rerun.include?(scenario.title) }
-      end
-
-      def trap_interrupt
-        trap('INT') { exit!(1) }
-      end
-    end
-  end
-end
-
-unless ARGV.first == 'new'
-  eval File.binread('./Lopatafile') if File.exists?('./Lopatafile')
-end
-
+require 'thor'
+require_relative 'generators/app'
+require_relative 'world'
+require_relative 'loader'
+require_relative '../lopata'
+require_relative 'observers'
+require_relative 'condition'
+
+module Lopata
+  # @private
+  class Runner < Thor
+    desc 'test', 'Run tests'
+    option :env, default: :qa, aliases: 'e'
+    option :rerun, type: :boolean, aliases: 'r'
+    option :keep, type: :boolean, aliases: 'k'
+    option :text, aliases: 't'
+    def test(*args)
+      trap_interrupt
+      configure_from_options
+      Lopata::Loader.load_shared_steps
+      Lopata::Loader.load_scenarios(*args)
+      world = Lopata.world
+      world.notify_observers(:started, world)
+      world.scenarios.each { |s| s.run }
+      world.notify_observers(:finished, world)
+    end
+
+    default_task :test
+
+    register Generators::App, :new, 'lopata new project-name', 'Init new lopata projects'
+
+    def self.exit_on_failure?
+      true
+    end
+
+    no_commands do
+      def configure_from_options
+        Lopata.configure do |c|
+          c.env = options[:env].to_sym
+          c.keep = options[:keep]
+          c.load_environment
+          c.run_before_start_hooks
+        end
+        add_text_filter(options[:text]) if options[:text]
+        add_rerun_filter if options[:rerun]
+      end
+
+      def add_text_filter(text)
+        Lopata.configuration.filters << -> (scenario) { scenario.title.include?(text) }
+      end
+
+      def add_rerun_filter
+        to_rerun = Lopata::Client.new.to_rerun
+        Lopata.configuration.filters << -> (scenario) { to_rerun.include?(scenario.title) }
+      end
+
+      def trap_interrupt
+        trap('INT') { exit!(1) }
+      end
+    end
+  end
+end
+
+unless ARGV.first == 'new'
+  eval File.binread('./Lopatafile') if File.exists?('./Lopatafile')
+end
+

data/lib/lopata/scenario.rb

@@ -1,136 +1,136 @@
-require 'rspec/expectations'
-
-# Scenario runtime class.
-#
-# All the scenarios are running in context of separate Lopata::Scenario object.
-#
-class Lopata::Scenario
-  include RSpec::Matchers
-
-  # @private
-  attr_reader :execution
-
-  # @private
-  def initialize(execution)
-    @execution = execution
-  end
-
-  # Marks current step as pending
-  # @example
-  #     it 'pending step' do
-  #       pending
-  #       expect(1).to eq 2
-  #     end
-  #
-  # Pending steps wont be failed
-  def pending(message = nil)
-    execution.current_step.pending!(message)
-  end
-
-  # @return [Hash] metadata available for current step
-  # @note The metadata keys also availalbe as methods (via method_missing)
-  def metadata
-    execution.metadata
-  end
-
-  private
-
-  # @private
-  def method_missing(method, *args, &block)
-    if execution.let_methods.include?(method)
-      instance_exec(*args, &execution.let_methods[method])
-    elsif metadata.keys.include?(method)
-      metadata[method]
-    else
-      super
-    end
-  end
-
-  # @private
-  def respond_to_missing?(method, *)
-    execution.let_methods.include?(method) or metadata.keys.include?(method) or super
-  end
-
-  # @private
-  # Scenario execution and live-cycle information
-  class Execution
-    attr_reader :scenario, :status, :steps, :title, :current_step
-
-    def initialize(title, options_title, metadata = {})
-      @title = [title, options_title].compact.reject(&:empty?).join(' ')
-      @metadata = metadata
-      @let_methods = {}
-      @status = :not_runned
-      @steps = []
-      @scenario = Lopata::Scenario.new(self)
-    end
-
-    def run
-      @status = :running
-      sort_steps
-      world.notify_observers(:scenario_started, self)
-      steps.each(&method(:run_step))
-      @status = steps.any?(&:failed?) ? :failed : :passed
-      world.notify_observers(:scenario_finished, self)
-      cleanup
-    end
-
-    def run_step(step)
-      return if step.skipped?
-      @current_step = step
-      step.run(scenario)
-      skip_rest if step.failed? && step.skip_rest_on_failure?
-      @current_step = nil
-    end
-
-    def world
-      Lopata.world
-    end
-
-    def failed?
-      status == :failed
-    end
-
-    def sort_steps
-      @steps = steps.reject(&:teardown_group?) + steps.select(&:teardown_group?)
-    end
-
-    def skip_rest
-      steps.select { |s| s.status == :not_runned && !s.teardown? }.each(&:skip!)
-    end
-
-    def metadata
-      if current_step
-        @metadata.merge(current_step.metadata)
-      else
-        @metadata
-      end
-    end
-
-    def let_methods
-      if current_step
-        @let_methods.merge(current_step.let_methods)
-      else
-        @let_methods
-      end
-    end
-
-    def let(method_name, &block)
-      # define_singleton_method method_name, &block
-      base =
-        if current_step && !current_step.groups.empty?
-          current_step.groups.last.let_methods
-        else
-          @let_methods
-        end
-      base[method_name] = block
-    end
-
-    def cleanup
-      @title = nil
-      @metadata = nil
-      @steps = nil
-      @scenario = nil
-    end
-  end
-end
+require 'rspec/expectations'
+
+# Scenario runtime class.
+#
+# All the scenarios are running in context of separate Lopata::Scenario object.
+#
+class Lopata::Scenario
+  include RSpec::Matchers
+
+  # @private
+  attr_reader :execution
+
+  # @private
+  def initialize(execution)
+    @execution = execution
+  end
+
+  # Marks current step as pending
+  # @example
+  #     it 'pending step' do
+  #       pending
+  #       expect(1).to eq 2
+  #     end
+  #
+  # Pending steps wont be failed
+  def pending(message = nil)
+    execution.current_step.pending!(message)
+  end
+
+  # @return [Hash] metadata available for current step
+  # @note The metadata keys also availalbe as methods (via method_missing)
+  def metadata
+    execution.metadata
+  end
+
+  private
+
+  # @private
+  def method_missing(method, *args, &block)
+    if execution.let_methods.include?(method)
+      instance_exec(*args, &execution.let_methods[method])
+    elsif metadata.keys.include?(method)
+      metadata[method]
+    else
+      super
+    end
+  end
+
+  # @private
+  def respond_to_missing?(method, *)
+    execution.let_methods.include?(method) or metadata.keys.include?(method) or super
+  end
+
+  # @private
+  # Scenario execution and live-cycle information
+  class Execution
+    attr_reader :scenario, :status, :steps, :title, :current_step
+
+    def initialize(title, options_title, metadata = {})
+      @title = [title, options_title].compact.reject(&:empty?).join(' ')
+      @metadata = metadata
+      @let_methods = {}
+      @status = :not_runned
+      @steps = []
+      @scenario = Lopata::Scenario.new(self)
+    end
+
+    def run
+      @status = :running
+      sort_steps
+      world.notify_observers(:scenario_started, self)
+      steps.each(&method(:run_step))
+      @status = steps.any?(&:failed?) ? :failed : :passed
+      world.notify_observers(:scenario_finished, self)
+      cleanup
+    end
+
+    def run_step(step)
+      return if step.skipped?
+      @current_step = step
+      step.run(scenario)
+      skip_rest if step.failed? && step.skip_rest_on_failure?
+      @current_step = nil
+    end
+
+    def world
+      Lopata.world
+    end
+
+    def failed?
+      status == :failed
+    end
+
+    def sort_steps
+      @steps = steps.reject(&:teardown_group?) + steps.select(&:teardown_group?)
+    end
+
+    def skip_rest
+      steps.select { |s| s.status == :not_runned && !s.teardown? }.each(&:skip!)
+    end
+
+    def metadata
+      if current_step
+        @metadata.merge(current_step.metadata)
+      else
+        @metadata
+      end
+    end
+
+    def let_methods
+      if current_step
+        @let_methods.merge(current_step.let_methods)
+      else
+        @let_methods
+      end
+    end
+
+    def let(method_name, &block)
+      # define_singleton_method method_name, &block
+      base =
+        if current_step && !current_step.groups.empty?
+          current_step.groups.last.let_methods
+        else
+          @let_methods
+        end
+      base[method_name] = block
+    end
+
+    def cleanup
+      @title = nil
+      @metadata = nil
+      @steps = nil
+      @scenario = nil
+    end
+  end
+end