foreman_maintain 0.0.1

data/lib/foreman_maintain/runner.rb

@@ -0,0 +1,39 @@
+module ForemanMaintain
+  # Class responsible for running the scenario
+  class Runner
+    require 'foreman_maintain/runner/execution'
+    def initialize(reporter, scenario)
+      @reporter = reporter
+      @scenario = scenario
+      @executions = []
+      @steps_to_run = @scenario.steps.dup
+      @quit = false
+    end
+
+    def run
+      @reporter.before_scenario_starts(@scenario)
+      while !@quit && !@steps_to_run.empty?
+        step = @steps_to_run.shift
+        execution = Execution.new(step, @reporter)
+        execution.run
+        @executions << execution
+        ask_about_offered_steps(step.next_steps)
+      end
+      @reporter.after_scenario_finishes(@scenario)
+    end
+
+    def ask_to_quit
+      @quit = true
+    end
+
+    def add_step(step)
+      @steps_to_run.unshift(step)
+    end
+
+    private
+
+    def ask_about_offered_steps(steps)
+      @reporter.on_next_steps(self, steps) if steps
+    end
+  end
+end

data/lib/foreman_maintain/runner/execution.rb

@@ -0,0 +1,74 @@
+module ForemanMaintain
+  class Runner
+    # Class representing an execution of a single step in scenario
+    class Execution
+      include Concerns::Logger
+
+      # Step performed as part of the execution
+      attr_reader :step
+
+      # Information about timings, collected automatically
+      attr_reader :started_at, :ended_at
+
+      # One of :pending, :running, :success, :fail, :skipped
+      attr_accessor :status
+
+      # Output of the execution, to be filled by execution step
+      attr_accessor :output
+
+      def initialize(step, reporter)
+        @step = step
+        @reporter = reporter
+        @status = :pending
+        @output = ''
+      end
+
+      def name
+        @step.description
+      end
+
+      def success?
+        @status == :success
+      end
+
+      def fail?
+        @status == :fail
+      end
+
+      def run
+        @status = :running
+        @reporter.before_execution_starts(self)
+        with_metadata_calculation do
+          capture_errors do
+            step.__run__(self)
+          end
+        end
+        # change the state only when not modified
+        @status = :success if @status == :running
+      ensure
+        @reporter.after_execution_finishes(self)
+      end
+
+      def update(line)
+        @reporter.on_execution_update(self, line)
+      end
+
+      private
+
+      def with_metadata_calculation
+        @started_at = Time.now
+        yield
+      ensure
+        @ended_at = Time.now
+      end
+
+      def capture_errors
+        yield
+      rescue => e
+        @status = :fail
+        @output << e.message
+        logger.error(e)
+      end
+    end
+  end
+end

data/lib/foreman_maintain/scenario.rb

@@ -0,0 +1,46 @@
+module ForemanMaintain
+  class Scenario
+    include Concerns::Logger
+    include Concerns::SystemHelpers
+    include Concerns::Metadata
+    include Concerns::Finders
+
+    attr_reader :steps
+
+    class ChecksScenario < Scenario
+      manual_detection
+      attr_reader :filter_tags
+
+      def initialize(filter_tags)
+        @filter_tags = filter_tags
+        @steps = ForemanMaintain.available_checks(:tags => filter_tags)
+      end
+
+      def description
+        "checks with tags #{tag_string(@filter_tags)}"
+      end
+
+      private
+
+      def tag_string(tags)
+        tags.map { |tag| "[#{tag}]" }.join(' ')
+      end
+    end
+
+    def initialize
+      @steps = []
+      compose
+    end
+
+    # Override to compose steps for the scenario
+    def compose; end
+
+    def self.inspect
+      "Scenario Class #{metadata[:description]}<#{name}>"
+    end
+
+    def inspect
+      "#{self.class.metadata[:description]}<#{self.class.name}>"
+    end
+  end
+end

data/lib/foreman_maintain/top_level_modules.rb

@@ -0,0 +1,13 @@
+# This are the top-level modules to be used in definitions
+
+module Features
+end
+
+module Checks
+end
+
+module Procedures
+end
+
+module Scenarios
+end

data/lib/foreman_maintain/version.rb

@@ -0,0 +1,3 @@
+module ForemanMaintain
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: foreman_maintain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ivan Nečas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Provides various features that helps keeping the Foreman/Satellite up and
+  running.
+email: inecas@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/foreman-maintain
+- definitions/checks/foreman_tasks_not_paused.rb
+- definitions/checks/foreman_tasks_not_running.rb
+- definitions/features/downstream.rb
+- definitions/features/foreman_1_11_x.rb
+- definitions/features/foreman_1_7_x.rb
+- definitions/features/foreman_database.rb
+- definitions/features/foreman_tasks.rb
+- definitions/features/upstream.rb
+- definitions/procedures/foreman_tasks_resume.rb
+- definitions/scenarios/pre_upgrade_check_foreman_1_14.rb
+- definitions/scenarios/pre_upgrade_check_satellite_6_0_z.rb
+- definitions/scenarios/pre_upgrade_check_satellite_6_1.rb
+- definitions/scenarios/pre_upgrade_check_satellite_6_1_z.rb
+- definitions/scenarios/pre_upgrade_check_satellite_6_2.rb
+- definitions/scenarios/pre_upgrade_check_satellite_6_2_z.rb
+- definitions/scenarios/pre_upgrade_check_satellite_6_3.rb
+- lib/foreman_maintain.rb
+- lib/foreman_maintain/check.rb
+- lib/foreman_maintain/cli.rb
+- lib/foreman_maintain/cli/base.rb
+- lib/foreman_maintain/cli/health_command.rb
+- lib/foreman_maintain/cli/upgrade_command.rb
+- lib/foreman_maintain/concerns/finders.rb
+- lib/foreman_maintain/concerns/logger.rb
+- lib/foreman_maintain/concerns/metadata.rb
+- lib/foreman_maintain/concerns/system_helpers.rb
+- lib/foreman_maintain/config.rb
+- lib/foreman_maintain/detector.rb
+- lib/foreman_maintain/executable.rb
+- lib/foreman_maintain/feature.rb
+- lib/foreman_maintain/logger.rb
+- lib/foreman_maintain/procedure.rb
+- lib/foreman_maintain/reporter.rb
+- lib/foreman_maintain/reporter/cli_reporter.rb
+- lib/foreman_maintain/runner.rb
+- lib/foreman_maintain/runner/execution.rb
+- lib/foreman_maintain/scenario.rb
+- lib/foreman_maintain/top_level_modules.rb
+- lib/foreman_maintain/version.rb
+homepage: https://github.com/theforeman/foreman_maintain
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Foreman maintenance tool belt
+test_files: []