cem_acpt 0.3.3-universal-java-17 → 0.3.5-universal-java-17

data/lib/cem_acpt/test_runner/workflow/step.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require_relative '../logging'
+
+module CemAcpt
+  module TestRunner
+    module Workflow
+      # Error used to wrap fatal errors raised in Runner steps
+      # @!attribute [r] step
+      #   @return [Step] The step that raised the error
+      class StepError < StandardError
+        attr_reader :step
+
+        def initialize(step, err)
+          @step = step
+          @original_error = err
+          super err
+          set_backtrace err.backtrace if err.respond_to?(:backtrace)
+        end
+      end
+
+      # Step is a class that defines a single step in a Workflow.
+      # Step objects are created by the Workflow class and are not intended to be created directly.
+      # @!attribute [r] name
+      #   @return [Symbol] The name of the step
+      # @!attribute [r] opts
+      #   @return [Hash] The options passed to the step
+      # @!attribute [r] result
+      #   @return [Object] The result of the step
+      class Step
+        include CemAcpt::TestRunner::Logging
+
+        attr_reader :logger, :name, :opts, :result
+
+        # @param name [Symbol] The name of the step
+        # @param opts [Hash] The options passed to the step
+        # @param block [Proc] The block to execute when the step is run
+        # @yieldparam step [Step] This step object is yielded to the block
+        def initialize(name, **opts, &block)
+          @name = name
+          @opts = opts
+          @block = block
+          @result = :not_run
+          @failed = false
+          @logger = use_logger(opts[:logger], step: name.to_s.capitalize)
+        end
+
+        # @return [Boolean] True if the step has been run and failed
+        def failed?
+          @failed
+        end
+
+        # Run the step. This calls and executes the block passed to the constructor.
+        # @param start_log [String] The message to log when the step starts
+        # @return [Object] The result of the step
+        def run(start_log = 'starting step')
+          @logger.info(start_log)
+          @result = @block.call(self)
+          @logger.debug('SUCCESS')
+          @result
+        rescue StandardError => e
+          @logger.debug("FAILED: #{e.message}")
+          @result = StepError.new(@name, e)
+          @failed = true
+          @result
+        ensure
+          Thread.pass # Be kind to the scheduler
+        end
+      end
+
+      # StepState is a class that holds the state of a Step.
+      # StepState objects are created by the Workflow class and are not intended to be created directly.
+      # @!attribute [r] step
+      #   @return [Step] The step object
+      # @!attribute [r] position
+      #   @return [Integer] The position of the step in the workflow
+      # @!attribute [r] opts
+      #   @return [Hash] The options passed to the step
+      # @!attribute [r] run_count
+      #   @return [Integer] The number of times the step has been run
+      # @!attribute [r] results
+      #   @return [Array<Object>] The results of all runs of the step
+      # @!attribute [r] last_error
+      #   @return [StepError] The last error raised by the step
+      # @!attribute [r] last_result
+      #   @return [Object] The result of the last run of the step
+      class StepState
+        attr_reader :step, :position, :opts, :run_count, :results, :last_error, :last_result
+
+        # @param step [Step] The step object
+        # @param position [Integer] The position of the step in the workflow
+        # @param opts [Hash] The options passed to the step
+        def initialize(step, position, **opts)
+          @step = step
+          @position = position
+          @retryable = opts[:retryable] || false
+          @retry_max = opts[:retry_max] || 3
+          @retry_delay = opts[:retry_delay] || 0
+          @retry_workflow_on_fail = opts[:retry_workflow_on_fail] || false
+          @run_count = 0
+          @results = []
+          @last_error = nil
+          @last_result = nil
+        end
+
+        # Proxy any methods not defined in this class to the Step
+        def method_missing(method, *args, &block)
+          if @step.respond_to?(method)
+            @step.send(method, *args, &block)
+          else
+            super
+          end
+        end
+
+        # Proxy any methods not defined in this class to the Step
+        def respond_to_missing?(method, include_private = false)
+          @step.respond_to?(method) || super
+        end
+
+        # @return [Object] The result of the last run of the step
+        def result
+          @last_result || :not_run
+        end
+
+        # @return [Boolean] If the step is retryable
+        def retryable?
+          @retryable
+        end
+
+        # @return [Boolean] If the workflow should be retried if the step fails
+        def retry_workflow_on_fail?
+          @retry_workflow_on_fail
+        end
+
+        # @return [Boolean] True if the step has been run and failed
+        def failed?
+          @results.last.is_a?(StepError)
+        end
+
+        # Run the step. This wraps the Step#run method and handles updating the state of the step.
+        # @param start_log [String] The message to log when the step starts
+        # @return [Object] The result of the step
+        def run(start_log = 'starting step')
+          @run_count += 1
+          @last_result = @step.run(start_log)
+          @results << @last_result
+          if @last_result.is_a?(StepError)
+            handle_error(@last_result)
+          end
+          @last_result
+        end
+
+        private
+
+        # Handle the error raised by the step
+        # @param result [StepError] The result of the step
+        def handle_error(result)
+          @last_error = result
+          if retry_workflow_on_fail?
+            @last_result = :retry_workflow
+          elsif retry?
+            retry_step
+          else
+            @last_result = :fail
+          end
+        end
+
+        # @return [Boolean] True if the step should be retried
+        def retry?
+          @retryable && @run_count < @retry_max
+        end
+
+        # Retry running the step
+        def retry_step
+          sleep @retry_delay if @retry_delay.positive?
+          run("retrying step (attempt #{@run_count + 1} of #{@retry_max})")
+        end
+      end
+    end
+  end
+end

data/lib/cem_acpt/test_runner/workflow.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'workflow/manager'
+require_relative 'workflow/step'
+
+module CemAcpt
+  module TestRunner
+    # Namespace for workflow classes
+    module Workflow; end
+  end
+end

data/lib/cem_acpt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CemAcpt
-  VERSION = '0.3.3'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: universal-java-17
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Litmus-like library focusing on CEM Acceptance Tests
 email:
 - abide-team@puppet.com
@@ -140,6 +154,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/spec.yml"
 - ".gitignore"
 - ".rspec"
 - CODEOWNERS
@@ -167,6 +182,7 @@ files:
 - lib/cem_acpt/platform/gcp.rb
 - lib/cem_acpt/platform/gcp/cmd.rb
 - lib/cem_acpt/platform/gcp/compute.rb
+- lib/cem_acpt/platform/utils/linux.rb
 - lib/cem_acpt/platform/vmpooler.rb
 - lib/cem_acpt/puppet_helpers.rb
 - lib/cem_acpt/rspec_utils.rb
@@ -174,9 +190,14 @@ files:
 - lib/cem_acpt/spec_helper_acceptance.rb
 - lib/cem_acpt/test_data.rb
 - lib/cem_acpt/test_runner.rb
+- lib/cem_acpt/test_runner/logging.rb
 - lib/cem_acpt/test_runner/run_handler.rb
 - lib/cem_acpt/test_runner/runner.rb
 - lib/cem_acpt/test_runner/runner_result.rb
+- lib/cem_acpt/test_runner/runner_workflow_builder.rb
+- lib/cem_acpt/test_runner/workflow.rb
+- lib/cem_acpt/test_runner/workflow/manager.rb
+- lib/cem_acpt/test_runner/workflow/step.rb
 - lib/cem_acpt/utils.rb
 - lib/cem_acpt/version.rb
 - sample_config.yaml