cem_acpt 0.3.2-universal-java-17 → 0.3.4-universal-java-17

data/lib/cem_acpt/test_runner/workflow.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+require_relative '../logging'
+require_relative 'workflow/manager'
+require_relative 'workflow/step'
+
+module CemAcpt
+  module TestRunner
+    # Namespace for workflow classes
+    module Workflow; end
+  end
+end
+
+# module CemAcpt
+#   module TestRunner
+    
+
+#     # Workflow is a class that manages how steps are executed.
+#     class Workflow
+#       include CemAcpt::LoggingAsync
+
+#       attr_reader :steps, :groups, :group_retry_max, :completed_steps
+
+#       def initialize(init_steps: [], **opts)
+#         raise ArgumentError, 'init_steps must be an Array' unless init_steps.is_a?(Array)
+#         raise ArgumentError, 'init_steps must be an Array of Step objects' unless init_steps.all? { |step| step.is_a?(Step) }
+
+#         @steps = init_steps
+#         @groups = @steps.map(&:group).compact.uniq
+#         @group_retry_max = opts[:group_retry_max] || 3
+#         @group_tries = {}
+#         @last_error = nil
+#         @completed_steps = []
+#       end
+
+#       def add_step(step, order = nil)
+#         raise ArgumentError, 'step must be a Step object' unless step.is_a?(Step)
+
+#         unless order.nil?
+#           @steps.insert(order, step)
+#         else
+#           @steps << step
+#         end
+#       end
+
+#       def add_step_with(name, order = nil, **kwargs, &block)
+#         raise ArgumentError, 'order must be an Integer' unless order.is_a?(Integer) || order.nil?
+#         raise ArgumentError, 'name must be a Symbol' unless name.is_a?(Symbol)
+
+#         unless order.nil?
+#           @steps.insert(order, Step.new(name, **kwargs, &block))
+#         else
+#           @steps << Step.new(name, **kwargs, &block)
+#         end
+#       end
+
+#       def run
+#         current_run_groups = []
+#         @steps.each do |step|
+#           next if step.name == :clean_up
+
+#           group_run_increment(step, current_run_groups)
+#           step.run
+#           @completed_steps << step
+#         end
+#         @completed_steps
+#       rescue StandardError => e
+#         async_error("Workflow failed with error: #{e}")
+#         @last_error = e
+#         raise e
+#       ensure
+#         clean_up
+#       end
+
+#       def success?
+#         (@completed_steps.length == @steps.length) && @completed_steps.none? { |step| step.result.is_a?(StepError) }
+#       end
+
+#       private
+
+#       def group_run_increment(step, current_run_groups = [])
+#         if step.grouped? && !current_run_groups.include?(step.group)
+#           current_run_groups << step.group
+#           if @group_tries[step.group].nil? || @group_tries[step.group].zero?
+#             @group_tries[step.group] = 1
+#           elsif @group_tries[step.group] >= @group_retry_max
+#             raise StepError.new(step, @last_error)
+#           else
+#             @group_tries[step.group] += 1
+#           end
+#         end
+#       end
+
+#       def run_step(step)
+#         result = step.run
+#         #handle_result(step, result)
+#         @completed_steps << step
+#         result
+#       end
+
+#       def handle_result(step, result)
+#         if result.is_a?(StepError)
+#           handle_error(step, result)
+#         else
+#           async_info("Step '#{step.name}' completed successfully")
+#         end
+#       end
+
+#       def handle_error(step, err)
+#         if step.retryable? && step.runs < @retry_max
+#           async_info("Retrying step '#{step.name}' (attempt #{step.runs + 1} of #{@retry_max})")
+#           sleep step.retry_delay if step.retry_delay > 0
+#           run_step(step)
+#         else
+#           async_debug("Step '#{step.name}' is not retryable or has exceeded the maximum number of retries")
+#           raise err if step.raise_on_fail?
+#         end
+#       end
+
+#       def default_clean_up
+#         Step.new(:clean_up, retryable: false, raise_on_fail: true) do
+#           async_info('No clean_up step defined, skipping')
+#         end
+#       end
+
+#       def clean_up
+#         cleanup_step = @steps.find { |step| step.name == :clean_up } || default_clean_up
+#         unless cleanup_step.nil?
+#           cleanup_step.retryable = false # clean_up steps should not be retried
+#           cleanup_step.raise_on_fail = true # clean_up steps should always raise on failure
+#           run_step(cleanup_step)
+#         end
+#       end
+#     end
+
+#     # Step is a class that defines a single step in a Workflow.
+#     class Step
+#       include CemAcpt::LoggingAsync
+
+#       attr_reader :group, :name, :opts, :result, :retry_delay, :retry_max, :runs
+
+#       def initialize(name, **opts, &logic)
+#         @name = name
+#         @logic = logic
+#         @group = opts[:group] || nil
+#         @retryable = opts[:retryable] || false
+#         @retry_delay = opts[:retry_delay] || 0
+#         @retry_max = opts[:retry_max] || 3
+#         @retry_group_on_fail = opts[:retry_group_on_fail] || false
+#         @raise_on_fail = opts[:raise_on_fail] || true
+#         @runs = 0
+#         @opts = opts
+#         @result = :not_run
+#       end
+
+#       def grouped?
+#         !@group.nil?
+#       end
+
+#       def retryable?
+#         @retryable
+#       end
+
+#       def retry_group_on_fail?
+#         @retry_group_on_fail
+#       end
+
+#       def raise_on_fail?
+#         @raise_on_fail
+#       end
+
+#       def retryable=(val)
+#         raise ArgumentError, 'retryable must be a Boolean' unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
+
+#         @retryable = val
+#       end
+
+#       def retry_delay=(val)
+#         raise ArgumentError, 'retry_delay must be an Integer' unless val.is_a?(Integer)
+
+#         @retry_delay = val
+#       end
+
+#       def retry_group_on_fail=(val)
+#         raise ArgumentError, 'retry_group_on_fail must be a Boolean' unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
+
+#         @retry_group_on_fail = val
+#       end
+
+#       def raise_on_fail=(val)
+#         raise ArgumentError, 'raise_on_fail must be a Boolean' unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
+
+#         @raise_on_fail = val
+#       end
+
+#       def run
+#         begin
+#           @runs += 1
+#           async_info("Running step #{@name}...") if @runs == 1
+#           @result = @logic.call(@opts)
+#         rescue StandardError => e
+#           if retryable? && @runs < @retry_max
+#             sleep @retry_delay if @retry_delay > 0
+#             async_info("Retrying step #{@name} (attempt #{@runs + 1} of #{@retry_max})")
+#             run
+#           else
+#             @result = CemAcpt::TestRunner::StepError.new(@name, e)
+#             raise @result if raise_on_fail?
+#           end
+#         end
+#         @result
+#       end
+#     end
+#   end
+# end

data/lib/cem_acpt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cem_acpt
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: universal-java-17
 authors:
 - puppetlabs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2023-01-30 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
@@ -177,6 +193,10 @@ files:
 - 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