foreman-tasks 4.1.5 → 5.2.0

data/extra/foreman-tasks-cleanup.sh

@@ -0,0 +1,127 @@
+#!/bin/bash
+
+PROGNAME="$0"
+EXECUTE=0
+RAKE_COMMAND="${RAKE_COMMAND:-"foreman-rake"}"
+
+function die() {
+    local code="$1"
+    local message="$2"
+    echo "$message" >&2
+    exit $code
+}
+
+function build_rake() {
+    echo -n "$RAKE_COMMAND "
+    echo -n 'foreman_tasks:cleanup '
+    for env in AFTER TASK_BACKUP BATCH_SIZE NOOP TASK_SEARCH STATES VERBOSE; do
+        local value="${!env}"
+        [ -n "${value}" ] && echo -n "${env}=$(printf '%q' "$value") "
+    done
+    echo
+}
+
+function usage() {
+        cat << EOF
+Usage: $PROGNAME [script_options...] [options...]
+
+An interface script for setting environment variables properly
+for foreman-tasks:cleanup rake task. By default only prints
+the command to run, with -E|--execute flag performs the cleanup.
+
+Environment variables:
+RAKE_COMMAND: can be used to redefine path to rake, by default foreman-rake
+
+Script options:
+EOF
+        cat <<EOF | column -s\& -t
+-E|--execute & execute the created rake command
+-h|--help & show this output
+EOF
+
+        echo
+        echo Cleanup options:
+        cat <<EOF | column -s\& -t
+-B|--batch-size BATCH_SIZE & process tasks in batches of BATCH_SIZE, 1000 by default
+-S|--states STATES & operate on tasks in STATES, comma separated list of states, set to all to operate on tasks in any state
+-a|--after AGE & operate on tasks older than AGE. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days
+-b|--backup & backup deleted tasks
+-n|--noop & do a dry run, print what would be done
+-s|--search QUERY & use QUERY in scoped search format to match tasks to delete
+-v|--verbose & be verbose
+EOF
+}
+
+SHORTOPTS="a:bB:Ehns:S:v"
+LONGOPTS="after:,backup,batch-size:,execute,help,noop,search:,states:,verbose"
+
+ARGS=$(getopt -s bash \
+              --options $SHORTOPTS \
+              --longoptions $LONGOPTS \
+              --name $PROGNAME \
+              -- "$@" )
+
+if [ $? -gt 0 ]; then
+    die 1 "getopt failed"
+fi
+
+eval set -- "$ARGS"
+
+while true; do
+    case $1 in
+        -a|--after)
+            shift
+            AFTER="$1"
+            ;;
+        -b|--backup)
+            TASK_BACKUP=true
+            ;;
+        -B|--batch-size)
+            shift
+            BATCH_SIZE="$1"
+            ;;
+        -n|--noop)
+            NOOP=1
+            ;;
+        -s|--search)
+            shift
+            TASK_SEARCH="$1"
+            ;;
+        -S|--states)
+            shift
+            if [ "$1" == "all" ]; then
+                STATES=","
+            else
+                STATES="$1"
+            fi
+            ;;
+        -v|--verbose)
+            VERBOSE=1
+            ;;
+        -h|--help)
+            usage
+            exit 0
+            ;;
+        -E|--execute)
+            EXECUTE=1
+            ;;
+        \?)
+            die 1 "Invalid option: -$OPTARG"
+            ;;
+        --)
+            ;;
+        *)
+            [ -n "$1" ] || break
+            die 1 "Unaccepted parameter: $1"
+            shift
+            ;;
+    esac
+    shift
+done
+
+if [ "$EXECUTE" -eq 1 ]; then
+    build_rake | sh
+else
+    build_rake
+fi
+

data/extra/foreman-tasks-export.sh

@@ -0,0 +1,121 @@
+#!/bin/bash
+
+PROGNAME="$0"
+EXECUTE=0
+RAKE_COMMAND="${RAKE_COMMAND:-"foreman-rake"}"
+
+function die() {
+    local code="$1"
+    local message="$2"
+    echo "$message" >&2
+    exit $code
+}
+
+function build_rake() {
+    echo -n "$RAKE_COMMAND "
+    echo -n 'foreman_tasks:export_tasks '
+    for env in TASK_SEARCH TASK_FILE TASK_FORMAT TASK_DAYS SKIP_FAILED; do
+        local value="${!env}"
+        [ -n "${value}" ] && echo -n "${env}=$(printf '%q' "$value") "
+    done
+    echo
+}
+
+function usage() {
+        cat << EOF
+Usage: $PROGNAME [options]
+
+An interface script for setting environment variables properly
+for foreman-tasks:export_tasks rake task. By default only prints
+the command to run, with -E|--execute flag performs the export.
+
+Environment variables:
+RAKE_COMMAND: can be used to redefine path to rake, by default foreman-rake
+
+Script options:
+EOF
+        cat <<EOF | column -s\& -t
+-E|--execute & execute the created rake command
+-h|--help & show this output
+EOF
+
+        echo
+        echo Export options:
+        cat <<EOF | column -s\& -t
+-d|--days DAYS & export only tasks started within the last DAYS days
+-f|--format FORMAT & export tasks in FORMAT, one of html, html-dir, csv
+-o|--output FILE & export tasks into FILE, a random file will be used if not provided
+-s|--search QUERY & use QUERY in scoped search format to match tasks to export
+-S|--skip-failed & skip tasks that fail to export
+EOF
+}
+
+SHORTOPTS="d:Ehs:o:f:S"
+LONGOPTS="days:,execute,help,search:,output:,format:,skip-failed"
+
+ARGS=$(getopt -s bash \
+              --options $SHORTOPTS \
+              --longoptions $LONGOPTS \
+              --name $PROGNAME \
+              -- "$@" )
+
+if [ $? -gt 0 ]; then
+    die 1 "getopt failed"
+fi
+
+eval set -- "$ARGS"
+
+while true; do
+    case $1 in
+        -d|--days)
+            shift
+            TASK_DAYS="$1"
+            ;;
+        -s|--search)
+            shift
+            TASK_SEARCH="$1"
+            ;;
+        -o|--output)
+            shift
+            TASK_FILE="$1"
+            ;;
+        -f|--format)
+            case "$2" in
+                "html" | "html-dir" | "csv")
+                    shift
+                    TASK_FORMAT="$1"
+                    ;;
+                *)
+                    die 1 "Value for $1 must be one of html, csv. Given $2"
+                    ;;
+            esac
+            ;;
+        -h|--help)
+            usage
+            exit 0
+            ;;
+        -E|--execute)
+            EXECUTE=1
+            ;;
+        -S|--skip-failed)
+            SKIP_FAILED=1
+            ;;
+        \?)
+            die 1 "Invalid option: -$OPTARG"
+            ;;
+        --)
+            ;;
+        *)
+            [ -n "$1" ] || break
+            die 1 "Unaccepted parameter: $1"
+            shift
+            ;;
+    esac
+    shift
+done
+
+if [ "$EXECUTE" -eq 1 ]; then
+    build_rake | sh
+else
+    build_rake
+fi

data/foreman-tasks.gemspec

@@ -20,16 +20,13 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
   DESC
 
   s.files = `git ls-files`.split("\n").reject do |file|
-    file.end_with?("test.rake") ||
-      file.start_with?('lib/foreman_tasks_core') ||
-      file == 'foreman-tasks-core.gemspec'
+    file.end_with?("test.rake")
   end
 
   s.test_files = `git ls-files test`.split("\n")
   s.extra_rdoc_files = Dir['README*', 'LICENSE']
 
   s.add_dependency "dynflow", '>= 1.2.3'
-  s.add_dependency "foreman-tasks-core"
   s.add_dependency "get_process_mem" # for memory polling
   s.add_dependency "parse-cron", '~> 0.1.4'
   s.add_dependency "sinatra" # for Dynflow web console

data/lib/foreman_tasks/continuous_output.rb

@@ -0,0 +1,50 @@
+module ForemanTasks
+  class ContinuousOutput
+    attr_accessor :raw_outputs
+
+    def initialize(raw_outputs = [])
+      @raw_outputs = []
+      raw_outputs.each { |raw_output| add_raw_output(raw_output) }
+    end
+
+    def add_raw_output(raw_output)
+      missing_args = %w[output_type output timestamp] - raw_output.keys
+      unless missing_args.empty?
+        raise ArgumentError, "Missing args for raw output: #{missing_args.inspect}"
+      end
+      @raw_outputs << raw_output
+    end
+
+    def empty?
+      @raw_outputs.empty?
+    end
+
+    def last_timestamp
+      return if @raw_outputs.empty?
+      @raw_outputs.last.fetch('timestamp')
+    end
+
+    def sort!
+      @raw_outputs.sort_by! { |record| record['timestamp'].to_f }
+    end
+
+    def humanize
+      sort!
+      raw_outputs.map { |output| output['output'] }.join("\n")
+    end
+
+    def add_exception(context, exception, timestamp = Time.now.getlocal)
+      add_output(context + ": #{exception.class} - #{exception.message}", 'debug', timestamp)
+    end
+
+    def add_output(*args)
+      add_raw_output(self.class.format_output(*args))
+    end
+
+    def self.format_output(message, type = 'debug', timestamp = Time.now.getlocal)
+      { 'output_type' => type,
+        'output' => message,
+        'timestamp' => timestamp.to_f }
+    end
+  end
+end

data/lib/foreman_tasks/engine.rb

@@ -1,4 +1,3 @@
-require 'foreman_tasks_core'
 require 'fast_gettext'
 require 'gettext_i18n_rails'
 
@@ -34,7 +33,7 @@ module ForemanTasks
 
     initializer 'foreman_tasks.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :"foreman-tasks" do
-        requires_foreman '>= 2.4.0'
+        requires_foreman '>= 2.6.0'
         divider :top_menu, :parent => :monitor_menu, :last => true, :caption => N_('Foreman Tasks')
         menu :top_menu, :tasks,
              :url_hash => { :controller => 'foreman_tasks/tasks', :action => :index },
@@ -66,6 +65,13 @@ module ForemanTasks
 
         add_all_permissions_to_default_roles
 
+        register_graphql_query_field :task, '::Types::Task', :record_field
+        register_graphql_query_field :tasks, '::Types::Task', :collection_field
+        register_graphql_query_field :recurring_logic, '::Types::RecurringLogic', :record_field
+        register_graphql_query_field :recurring_logics, '::Types::RecurringLogic', :collection_field
+
+        register_graphql_mutation_field :cancel_recurring_logic, ::Mutations::RecurringLogics::Cancel
+
         logger :dynflow, :enabled => true
         logger :action, :enabled => true
 
@@ -116,19 +122,6 @@ module ForemanTasks
         world.middleware.use Actions::Middleware::KeepCurrentRequestID
         world.middleware.use ::Actions::Middleware::LoadSettingValues if Gem::Version.new(::SETTINGS[:version]) >= Gem::Version.new('2.5')
       end
-
-      ::ForemanTasks.dynflow.config.on_init do |world|
-        ForemanTasksCore.dynflow_setup(world)
-      end
-    end
-
-    initializer 'foreman_tasks.set_core_settings' do
-      ForemanTasksCore::SettingsLoader.settings_registry.each_key do |settings_keys|
-        settings = settings_keys.inject({}) do |h, settings_key|
-          h.merge(SETTINGS[settings_key] || {})
-        end
-        ForemanTasksCore::SettingsLoader.setup_settings(settings_keys.first, settings)
-      end
     end
 
     # to enable async Foreman operations using Dynflow

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -14,6 +14,7 @@ namespace :foreman_tasks do
       * TASK_FILE       : file to export to
       * TASK_FORMAT     : format to use for the export (either html, html-dir or csv)
       * TASK_DAYS       : number of days to go back
+      * SKIP_FAILED     : skip tasks that fail to export (true or false[default])
 
     If TASK_SEARCH is not defined, it defaults to all tasks in the past 7 days and
     all unsuccessful tasks in the past 60 days. The default TASK_FORMAT is html
@@ -232,6 +233,7 @@ namespace :foreman_tasks do
           <tr>
             <td><a href=\"#{task.id}.html\">#{task.label}</a></td>
             <td>#{task.started_at}</td>
+            <td>#{task.duration}</td>
             <td>#{task.state}</td>
             <td>#{task.result}</td>
           </tr>
@@ -241,10 +243,12 @@ namespace :foreman_tasks do
 
     def csv_export(export_filename, tasks)
       CSV.open(export_filename, 'wb') do |csv|
-        csv << %w[id state type label result parent_task_id started_at ended_at]
+        csv << %w[id state type label result parent_task_id started_at ended_at duration]
         tasks.find_each do |task|
-          csv << [task.id, task.state, task.type, task.label, task.result,
-                  task.parent_task_id, task.started_at, task.ended_at]
+          with_error_handling(task) do
+            csv << [task.id, task.state, task.type, task.label, task.result,
+                    task.parent_task_id, task.started_at, task.ended_at, task.duration]
+          end
         end
       end
     end
@@ -253,15 +257,18 @@ namespace :foreman_tasks do
       PageHelper.copy_assets(workdir)
 
       renderer = TaskRender.new
-      total = tasks.count
+      total = tasks.count(:all)
       index = File.open(File.join(workdir, 'index.html'), 'w')
 
       File.open(File.join(workdir, 'index.html'), 'w') do |index|
         PageHelper.pagify(index) do |io|
           PageHelper.generate_with_index(io) do |index|
             tasks.find_each.each_with_index do |task, count|
-              File.open(File.join(workdir, "#{task.id}.html"), 'w') { |file| PageHelper.pagify(file, renderer.render_task(task)) }
-              PageHelper.generate_index_entry(index, task)
+              content = with_error_handling(task) { renderer.render_task(task) }
+              if content
+                File.open(File.join(workdir, "#{task.id}.html"), 'w') { |file| PageHelper.pagify(file, content) }
+                with_error_handling(task, _('task index entry')) { PageHelper.generate_index_entry(index, task) }
+              end
               puts "#{count + 1}/#{total}"
             end
           end
@@ -281,6 +288,20 @@ namespace :foreman_tasks do
       end
     end
 
+    def with_error_handling(task, what = _('task'))
+      yield
+    rescue StandardError => e
+      resolution = SKIP_ERRORS ? _(', skipping') : ''
+      puts _("WARNING: %{what} failed to export%{resolution}. Additional task details below.") % { :what => what, :resolution => resolution }
+      puts task.inspect
+      unless SKIP_ERRORS
+        puts _("Re-run with SKIP_FAILED=true if you want to simply skip any tasks that fail to export.")
+        raise e
+      end
+    end
+
+    SKIP_ERRORS = ['true', '1', 'y', 'yes'].include? ENV['SKIP_FAILED'].downcase
+
     filter = if ENV['TASK_SEARCH'].nil? && ENV['TASK_DAYS'].nil?
                "started_at > \"#{7.days.ago.to_s(:db)}\" || " \
                  "(result != success && started_at > \"#{60.days.ago.to_s(:db)})\""
@@ -296,10 +317,10 @@ namespace :foreman_tasks do
     format = ENV['TASK_FORMAT'] || 'html'
     export_filename = ENV['TASK_FILE'] || generate_filename(format)
 
-    tasks = ForemanTasks::Task.search_for(filter).order(:started_at => :desc)
+    tasks = ForemanTasks::Task.search_for(filter).order(:started_at => :desc).with_duration.distinct
 
     puts _("Exporting all tasks matching filter #{filter}")
-    puts _("Gathering #{tasks.count} tasks.")
+    puts _("Gathering #{tasks.count(:all)} tasks.")
     case format
     when 'html'
       Dir.mktmpdir('task-export') do |tmp_dir|

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '4.1.5'.freeze
+  VERSION = '5.2.0'.freeze
 end

data/lib/foreman_tasks.rb

@@ -6,17 +6,14 @@ require 'foreman_tasks/dynflow/configuration'
 require 'foreman_tasks/triggers'
 require 'foreman_tasks/authorizer_ext'
 require 'foreman_tasks/cleaner'
+require 'foreman_tasks/continuous_output'
 
 module ForemanTasks
   extend Algebrick::TypeCheck
   extend Algebrick::Matching
 
   def self.dynflow
-    @dynflow ||= begin
-                   world = ForemanTasks::Dynflow.new(nil, ForemanTasks::Dynflow::Configuration.new)
-                   ForemanTasksCore.dynflow_setup(world) if defined?(ForemanTasksCore)
-                   world
-                 end
+    @dynflow ||= ForemanTasks::Dynflow.new(nil, ForemanTasks::Dynflow::Configuration.new)
   end
 
   def self.trigger(action, *args, &block)

data/package.json

@@ -23,20 +23,18 @@
     "url": "http://projects.theforeman.org/projects/foreman-tasks/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 6.0.0"
+    "@theforeman/vendor": "^8.15.0"
   },
   "dependencies": {
-    "c3": "^0.4.11",
-    "humanize-duration": "^3.20.1",
-    "react-intl": "^2.8.0"
+    "c3": "^0.4.11"
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": "^6.0.0",
-    "@theforeman/eslint-plugin-foreman": "6.0.0",
-    "@theforeman/stories": "^6.0.0",
-    "@theforeman/test": "^6.0.0",
-    "@theforeman/vendor-dev": "^6.0.0",
+    "@theforeman/builder": "^8.15.0",
+    "@theforeman/eslint-plugin-foreman": "^8.15.0",
+    "@theforeman/stories": "^8.15.0",
+    "@theforeman/test": "^8.15.0",
+    "@theforeman/vendor-dev": "^8.15.0",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "jed": "^1.1.1",

data/test/controllers/api/tasks_controller_test.rb

@@ -102,6 +102,24 @@ module ForemanTasks
                      session: set_session_user(User.current)
           assert_response :not_found
         end
+
+        it 'shows duration column' do
+          task = ForemanTasks::Task.with_duration.find(FactoryBot.create(:dynflow_task).id)
+          get :show, params: { id: task.id }, session: set_session_user
+          assert_response :success
+          data = JSON.parse(response.body)
+          _(data['duration']).must_equal task.duration
+        end
+      end
+
+      describe 'GET /api/tasks/index' do
+        it 'shows duration column' do
+          task = ForemanTasks::Task.with_duration.find(FactoryBot.create(:dynflow_task).id)
+          get :index, session: set_session_user
+          assert_response :success
+          data = JSON.parse(response.body)
+          _(data['results'][0]['duration']).must_equal task.duration
+        end
       end
 
       describe 'GET /api/tasks/summary' do
@@ -174,7 +192,7 @@ module ForemanTasks
           _(task.state).must_equal 'running'
           _(task.result).must_equal 'pending'
 
-          callback = Support::DummyProxyAction.proxy.log[:trigger_task].first[1][:callback]
+          callback = Support::DummyProxyAction.proxy.log[:trigger_task].first[1][:action_input][:callback]
           post :callback, params: { 'callback' => callback, 'data' => { 'result' => 'success' } }
           triggered.finished.wait(5)
 

data/test/controllers/tasks_controller_test.rb

@@ -91,6 +91,15 @@ module ForemanTasks
         end
       end
 
+      describe 'index' do
+        it 'shows duration column' do
+          task = ForemanTasks::Task.with_duration.find(FactoryBot.create(:some_task).id)
+          get(:index, params: {}, session: set_session_user)
+          assert_response :success
+          assert_include response.body.lines[1], task.duration
+        end
+      end
+
       describe 'sub_tasks' do
         it 'does not allow user without permissions to see task details' do
           setup_user('view', 'foreman_tasks', 'owner.id = current_user')
@@ -109,6 +118,16 @@ module ForemanTasks
           assert_equal 2, response.body.lines.size
           assert_include response.body.lines[1], 'Child action'
         end
+
+        it 'shows duration column' do
+          parent = ForemanTasks::Task.find(FactoryBot.create(:some_task).id)
+          child = ForemanTasks::Task.with_duration.find(FactoryBot.create(:some_task).id)
+          child.parent_task_id = parent.id
+          child.save!
+          get(:sub_tasks, params: { id: parent.id }, session: set_session_user)
+          assert_response :success
+          assert_include response.body.lines[1], child.duration
+        end
       end
 
       describe 'taxonomy scoping' do

data/test/factories/recurring_logic_factory.rb

@@ -1,8 +1,14 @@
 FactoryBot.define do
   factory :recurring_logic, :class => ForemanTasks::RecurringLogic do
     cron_line { '* * * * *' }
-    after(:build) { |logic| logic.task_group = build(:recurring_logic_task_group) }
+    association :task_group
   end
 
+  factory :task_group, :class => ::ForemanTasks::TaskGroup do
+    type { "ForemanTasks::TaskGroups::RecurringLogicTaskGroup" }
+  end
   factory :recurring_logic_task_group, :class => ::ForemanTasks::TaskGroups::RecurringLogicTaskGroup
+  factory :task_group_member, :class => ::ForemanTasks::TaskGroupMember do
+    association :task_group, :task
+  end
 end

data/test/graphql/mutations/recurring_logics/cancel_mutation_test.rb

@@ -0,0 +1,66 @@
+require 'foreman_tasks_test_helper'
+
+module Mutations
+  module RecurringLogics
+    class CancelMutationTest < ActiveSupport::TestCase
+      setup do
+        @task = FactoryBot.create(:dynflow_task, state: 'pending')
+        @task_group = FactoryBot.create(:recurring_logic_task_group)
+        @task_group_member = FactoryBot.create(:task_group_member, task: @task, task_group: @task_group)
+        @recurring_logic = FactoryBot.create(:recurring_logic, task_group: @task_group)
+        @id = Foreman::GlobalId.for(@recurring_logic)
+        @variables = { id: @id }
+        @query =
+          <<-GRAPHQL
+          mutation CancelRecurringLogic($id:ID!) {
+            cancelRecurringLogic(input: { id: $id }){
+              recurringLogic {
+                id
+                state
+                cronLine
+              }
+              errors {
+                message
+                path
+              }
+            }
+          }
+          GRAPHQL
+      end
+
+      context 'as admin' do
+        setup do
+          @context = { current_user: FactoryBot.create(:user, :admin) }
+        end
+
+        test 'should cancel recurring logic' do
+          assert_not_equal 'cancelled', @recurring_logic.state
+          result = ForemanGraphqlSchema.execute(@query, variables: @variables, context: @context)
+          assert_empty result['errors']
+          assert_empty result['data']['cancelRecurringLogic']['errors']
+          assert_equal 'cancelled', result['data']['cancelRecurringLogic']['recurringLogic']['state']
+          @recurring_logic.reload
+          assert_equal 'cancelled', @recurring_logic.state
+        end
+
+        test 'should handle errors on execution plan load failure' do
+          invalid_plan = ::Dynflow::ExecutionPlan::InvalidPlan.new(StandardError.new('This is a failure'), 'xyz', 'test-label', 'invalid')
+          ::Dynflow::Persistence.any_instance.stubs(:load_execution_plan).returns(invalid_plan)
+          result = ForemanGraphqlSchema.execute(@query, variables: @variables, context: @context)
+          assert_equal "There has been an error when canceling one of the tasks: This is a failure", result['data']['cancelRecurringLogic']['errors'].first['message']
+        end
+      end
+
+      context 'as viewer' do
+        setup do
+          @context = { current_user: setup_user('view', 'recurring_logics') }
+        end
+
+        test 'should not allow to cancel recurring logic' do
+          result = ForemanGraphqlSchema.execute(@query, variables: @variables, context: @context)
+          assert_includes result['errors'].first['message'], 'Unauthorized.'
+        end
+      end
+    end
+  end
+end