Add nested steps support and custom step methods (#6)

andrcuns · web-flow · commit 68cc813f680a · 2019-05-30T11:28:12.000+03:00
diff --git a/allure-ruby-commons/lib/allure-ruby-commons.rb b/allure-ruby-commons/lib/allure-ruby-commons.rb
@@ -137,6 +137,32 @@ def add_link(url:, name: nil, type: "custom")
     def add_attachment(name:, source:, type:, test_case: false)
       lifecycle.add_attachment(name: name, source: source, type: type, test_case: test_case)
     end
+
+    # Add step with provided name and optional status to current test step, fixture or test case
+    # @param [String] name
+    # @param [Symbol] status <Allure::Status>, <Allure::Status::PASSED> by default
+    # @return [void]
+    def step(name:, status: nil)
+      lifecycle.add_test_step(StepResult.new(name: name, status: status || Status::PASSED, stage: Stage::FINISHED))
+    end
+
+    # Run passed block as step with given name
+    # @param [String] name
+    # @yield [] step block
+    # @return [void]
+    def run_step(name)
+      lifecycle.start_test_step(StepResult.new(name: name, stage: Stage::RUNNING))
+      yield
+      lifecycle.update_test_step { |step| step.status = Status::PASSED }
+    rescue => e
+      lifecycle.update_test_step do |step|
+        step.status = ResultUtils.status(e)
+        step.status_details = ResultUtils.status_details(e)
+      end
+      raise(e)
+    ensure
+      lifecycle.stop_test_step
+    end
   end
 end
 # rubocop:enable Naming/FileName
diff --git a/allure-ruby-commons/lib/allure_ruby_commons/allure_lifecycle.rb b/allure-ruby-commons/lib/allure_ruby_commons/allure_lifecycle.rb
@@ -3,6 +3,10 @@
 module Allure
   # Main class for creating and writing allure results
   class AllureLifecycle
+    def initialize
+      @step_context = []
+    end
+
     # Start test result container
     # @param [Allure::TestResultContainer] test_result_container
     # @return [Allure::TestResultContainer]
@@ -42,6 +46,7 @@ def stop_test_container
     # @param [Allure::TestResult] test_result
     # @return [Allure::TestResult]
     def start_test_case(test_result)
+      clear_step_context
       unless @current_test_result_container
         return logger.error("Could not start test case, test container is not started")
       end
@@ -75,6 +80,7 @@ def stop_test_case
       @current_test_case.stage = Stage::FINISHED
       file_writer.write_test_result(@current_test_case)
       clear_current_test_case
+      clear_step_context
     end
 
     # Start test step and add to current test case
@@ -85,8 +91,8 @@ def start_test_step(step_result)
 
       step_result.start = ResultUtils.timestamp
       step_result.stage = Stage::RUNNING
-      @current_test_case.steps.push(step_result)
-      @current_test_step = step_result
+      add_test_step(step_result)
+      step_result
     end
 
     # @example Update current test step
@@ -97,19 +103,19 @@ def start_test_step(step_result)
     # @yieldreturn [void]
     # @return [void]
     def update_test_step
-      return logger.error("Could not update test step, no step is running") unless @current_test_step
+      return logger.error("Could not update test step, no step is running") unless current_test_step
 
-      yield(@current_test_step)
+      yield(current_test_step)
     end
 
     # Stop current test step
     # @return [void]
     def stop_test_step
-      return logger.error("Could not stop test step, no step is running") unless @current_test_step
+      return logger.error("Could not stop test step, no step is running") unless current_test_step
 
-      @current_test_step.stop = ResultUtils.timestamp
-      @current_test_step.stage = Stage::FINISHED
-      clear_current_test_step
+      current_test_step.stop = ResultUtils.timestamp
+      current_test_step.stage = Stage::FINISHED
+      clear_last_test_step
     end
 
     # Start prepare fixture
@@ -134,6 +140,7 @@ def start_tear_down_fixture(fixture_result)
     # @param [Allure::FixtureResult] fixture_result
     # @return [Allure::FixtureResult]
     def start_fixture(fixture_result)
+      clear_step_context
       unless @current_test_result_container
         logger.error("Could not start fixture, test container is not started")
         return false
@@ -162,6 +169,7 @@ def stop_fixture
       @current_fixture.stop = ResultUtils.timestamp
       @current_fixture.stage = Stage::FINISHED
       clear_current_fixture
+      clear_step_context
     end
 
     # Add attachment to current test or step
@@ -199,6 +207,15 @@ def write_attachment(source, attachment)
       file_writer.write_attachment(source, attachment)
     end
 
+    # Add step to current fixture|step|test case
+    # @param [Allure::StepResult] step_result
+    # @return [Allure::StepResult]
+    def add_test_step(step_result)
+      current_executable.steps.push(step_result)
+      @step_context.push(step_result)
+      step_result
+    end
+
     private
 
     def logger
@@ -210,7 +227,7 @@ def file_writer
     end
 
     def current_executable
-      @current_test_step || @current_fixture || @current_test_case
+      current_test_step || @current_fixture || @current_test_case
     end
 
     def clear_current_test_container
@@ -221,8 +238,16 @@ def clear_current_test_case
       @current_test_case = nil
     end
 
-    def clear_current_test_step
-      @current_test_step = nil
+    def current_test_step
+      @step_context.last
+    end
+
+    def clear_last_test_step
+      @step_context.pop
+    end
+
+    def clear_step_context
+      @step_context.clear
     end
 
     def clear_current_fixture
diff --git a/allure-ruby-commons/lib/allure_ruby_commons/result_utils.rb b/allure-ruby-commons/lib/allure_ruby_commons/result_utils.rb
@@ -127,7 +127,7 @@ def status(exception)
       # @param [Exception] exception
       # @return [Hash<Symbol, String>]
       def status_details(exception)
-        { message: exception.message, trace: exception.backtrace&.join("\n") }
+        StatusDetails.new(message: exception.message, trace: exception.backtrace&.join("\n"))
       end
 
       private
diff --git a/allure-ruby-commons/spec/unit/allure_spec.rb b/allure-ruby-commons/spec/unit/allure_spec.rb
@@ -81,5 +81,36 @@
         expect(attachment.source).to include(".txt")
       end
     end
+
+    it "adds custom step" do
+      test_step = Allure.step(name: "Custom step", status: Allure::Status::FAILED)
+      expect(@test_case.steps.last).to eq(test_step)
+    end
+
+    it "runs custom step" do
+      Allure.run_step("Custom step") do
+        1 + 1
+      end
+      test_step = @test_case.steps.last
+      aggregate_failures "custom step should be handled correctly" do
+        expect(test_step.name).to eq("Custom step")
+        expect(test_step.status).to eq(Allure::Status::PASSED)
+        expect(test_step.stage).to eq(Allure::Stage::FINISHED)
+      end
+    end
+
+    it "correctly handles custom step failure" do
+      Allure.run_step("Custom step") do
+        raise StandardError.new("Error")
+      end
+    rescue
+      test_step = @test_case.steps.last
+      aggregate_failures "custom step should be handled correctly" do
+        expect(test_step.name).to eq("Custom step")
+        expect(test_step.status).to eq(Allure::Status::BROKEN)
+        expect(test_step.stage).to eq(Allure::Stage::FINISHED)
+        expect(test_step.status_details.message).to eq("Error")
+      end
+    end
   end
 end
diff --git a/allure-ruby-commons/spec/unit/result_utils_spec.rb b/allure-ruby-commons/spec/unit/result_utils_spec.rb
@@ -16,7 +16,7 @@
     raise error
   rescue => e
     status_details = Allure::ResultUtils.status_details(e)
-    expect(status_details[:message]).to eq("Error")
-    expect(status_details[:message]).not_to be_empty
+    expect(status_details.message).to eq("Error")
+    expect(status_details.message).not_to be_empty
   end
 end
diff --git a/allure-ruby-commons/spec/unit/test_step_spec.rb b/allure-ruby-commons/spec/unit/test_step_spec.rb
@@ -20,12 +20,27 @@
       end
     end
 
+    it "starts nested step" do
+      start_test_step(name: "Nested step name", descrption: "step description")
+      expect(@test_step.steps.last.name).to eq("Nested step name")
+    end
+
     it "updates test step" do
       lifecycle.update_test_step { |step| step.status = Allure::Status::SKIPPED }
 
       expect(@test_step.status).to eq(Allure::Status::SKIPPED)
     end
 
+    it "updates nested step" do
+      start_test_step(name: "Nested step name", descrption: "step description")
+      lifecycle.update_test_step { |step| step.status = Allure::Status::SKIPPED }
+
+      aggregate_failures "steps should have correct status" do
+        expect(@test_step.steps.last.status).to eq(Allure::Status::SKIPPED)
+        expect(@test_step.status).to eq(Allure::Status::BROKEN) # default status for unfinished step
+      end
+    end
+
     it "stops test step" do
       lifecycle.stop_test_step
 
@@ -34,6 +49,27 @@
         expect(@test_step.stage).to eq(Allure::Stage::FINISHED)
       end
     end
+
+    it "stops nested step" do
+      start_test_step(name: "Nested step name", descrption: "step description")
+      lifecycle.stop_test_step
+
+      aggregate_failures "should have stopped only nested step" do
+        expect(@test_step.steps.last.stage).to eq(Allure::Stage::FINISHED)
+        expect(@test_step.stage).to eq(Allure::Stage::RUNNING)
+      end
+    end
+
+    it "stops parent step" do
+      start_test_step(name: "Nested step name", descrption: "step description")
+      lifecycle.stop_test_step
+      lifecycle.stop_test_step
+
+      aggregate_failures "should have stopped both step" do
+        expect(@test_step.steps.last.stage).to eq(Allure::Stage::FINISHED)
+        expect(@test_step.stage).to eq(Allure::Stage::FINISHED)
+      end
+    end
   end
 
   context "logs error" do
