RubyGems - foreman-tasks - Versions diffs - 5.0.0 → 5.1.0 - Mend

foreman-tasks 5.0.0 → 5.1.0

Files changed (43) hide show

data/extra/foreman-tasks-export.sh ADDED Viewed

@@ -0,0 +1,117 @@
+#!/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; 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
+EOF
+}
+SHORTOPTS="d:Ehs:o:f:"
+LONGOPTS="days:,execute,help,search:,output:,format:"
+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
+            ;;
+        \?)
+            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/lib/foreman_tasks/tasks/export_tasks.rake CHANGED Viewed

@@ -12,7 +12,7 @@ namespace :foreman_tasks do
       * TASK_SEARCH     : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')
       * TASK_FILE       : file to export to
-      * TASK_FORMAT     : format to use for the export (either html or csv)
+      * TASK_FORMAT     : format to use for the export (either html, html-dir or csv)
       * TASK_DAYS       : number of days to go back
     If TASK_SEARCH is not defined, it defaults to all tasks in the past 7 days and
@@ -185,23 +185,27 @@ namespace :foreman_tasks do
     end
     class PageHelper
-      def self.pagify(template)
-        pre = <<-HTML
-       <html>
-       <head>
-       <title>Dynflow Console</title>
-       <script src="jquery.js"></script>
-       <link rel="stylesheet" type="text/css" href="bootstrap.css">
-       <link rel="stylesheet" type="text/css" href="application.css">
-       <script src="bootstrap.js"></script>
-       <script src="run_prettify.js"></script>
-       <script src="application.js"></script>
-       </head>
-       <body>
-          #{template}
-       <body>
-       </html>
+      def self.pagify(io, template = nil)
+        io.write <<~HTML
+          <html>
+            <head>
+              <title>Dynflow Console</title>
+              <script src="jquery.js"></script>
+              <link rel="stylesheet" type="text/css" href="bootstrap.css">
+              <link rel="stylesheet" type="text/css" href="application.css">
+              <script src="bootstrap.js"></script>
+              <script src="run_prettify.js"></script>
+              <script src="application.js"></script>
+            </head>
+          <body>
         HTML
+        if block_given?
+          yield io
+        else
+          io.write template
+        end
+      ensure
+        io.write '</body></html>'
       end
       def self.copy_assets(tmp_dir)
@@ -216,13 +220,65 @@ namespace :foreman_tasks do
         end
       end
-      def self.generate_index(tasks)
-        html = '<div><table class="table">'
-        tasks.order('started_at desc').all.each do |task|
-          html << "<tr><td><a href=\"#{task.id}.html\">#{task.label}</a></td><td>#{task.started_at}</td>\
-                   <td>#{task.state}</td><td>#{task.result}</td></tr>"
+      def self.generate_with_index(io)
+        io.write '<div><table class="table">'
+        yield io
+      ensure
+        io.write '</table></div>'
+      end
+      def self.generate_index_entry(io, task)
+        io << <<~HTML
+          <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>
+        HTML
+      end
+    end
+    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 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, task.duration]
         end
-        html << '</table></div>'
+      end
+    end
+    def html_export(workdir, tasks)
+      PageHelper.copy_assets(workdir)
+      renderer = TaskRender.new
+      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)
+              puts "#{count + 1}/#{total}"
+            end
+          end
+        end
+      end
+    end
+    def generate_filename(format)
+      base = "/tmp/task-export-#{Time.now.to_i}"
+      case format
+      when 'html'
+        base + '.tar.gz'
+      when 'csv'
+        base + '.csv'
+      when 'html-dir'
+        base
       end
     end
@@ -239,36 +295,25 @@ namespace :foreman_tasks do
     end
     format = ENV['TASK_FORMAT'] || 'html'
-    export_filename = ENV['TASK_FILE'] || "/tmp/task-export-#{Time.now.to_i}.#{format == 'csv' ? 'csv' : 'tar.gz'}"
+    export_filename = ENV['TASK_FILE'] || generate_filename(format)
-    tasks = ForemanTasks::Task.search_for(filter)
+    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.")
-    if format == 'html'
+    puts _("Gathering #{tasks.count(:all)} tasks.")
+    case format
+    when 'html'
       Dir.mktmpdir('task-export') do |tmp_dir|
-        PageHelper.copy_assets(tmp_dir)
-        renderer = TaskRender.new
-        total = tasks.count
-        tasks.find_each.with_index do |task, count|
-          File.open(File.join(tmp_dir, "#{task.id}.html"), 'w') { |file| file.write(PageHelper.pagify(renderer.render_task(task))) }
-          puts "#{count + 1}/#{total}"
-        end
-        File.open(File.join(tmp_dir, 'index.html'), 'w') { |file| file.write(PageHelper.pagify(PageHelper.generate_index(tasks))) }
+        html_export(tmp_dir, tasks)
         system("tar", "czf", export_filename, tmp_dir)
       end
-    elsif format == 'csv'
-      CSV.open(export_filename, 'wb') do |csv|
-        csv << %w[id state type label result parent_task_id started_at ended_at]
-        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]
-        end
-      end
+    when 'html-dir'
+      FileUtils.mkdir_p(export_filename)
+      html_export(export_filename, tasks)
+    when 'csv'
+      csv_export(export_filename, tasks)
+    else
+      raise "Unkonwn export format '#{format}'"
     end
     puts "Created #{export_filename}"

data/lib/foreman_tasks/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '5.0.0'.freeze
+  VERSION = '5.1.0'.freeze
 end

data/test/controllers/api/tasks_controller_test.rb CHANGED Viewed

@@ -68,6 +68,17 @@ module ForemanTasks
           data = JSON.parse(response.body)
           _(data[0]['results'][0]['id']).must_equal task.id
         end
+        it 'can search for a specific resource' do
+          org = FactoryBot.create(:organization)
+          task = FactoryBot.create(:task_with_links, resource_id: org.id, resource_type: 'Organization')
+          post :bulk_search, params: { :searches => [{ :type => 'resource', :resource_id => org.id, :resource_type => 'Organization' }] }
+          assert_response :success
+          data = JSON.parse(response.body)
+          _(data[0]['results'][0]['id']).must_equal task.id
+        end
       end
       describe 'GET /api/tasks/show' do
@@ -91,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

data/test/controllers/tasks_controller_test.rb CHANGED Viewed

@@ -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/unit/actions/trigger_proxy_batch_test.rb ADDED Viewed

@@ -0,0 +1,59 @@
+require 'foreman_tasks_test_helper'
+module ForemanTasks
+  class TriggerProxyBatchTest < ActiveSupport::TestCase
+    describe Actions::TriggerProxyBatch do
+      include ::Dynflow::Testing
+      let(:batch_size) { 20 }
+      let(:total_count) { 100 }
+      let(:action) { create_and_plan_action(Actions::TriggerProxyBatch, total_count: total_count, batch_size: batch_size) }
+      let(:triggered) { run_action(action) }
+      describe 'triggering' do
+        it 'doesnt run anything on trigger' do
+          Actions::TriggerProxyBatch.any_instance.expects(:trigger_remote_tasks_batch).never
+          _(triggered.state).must_equal :suspended
+          _(triggered.output[:planned_count]).must_equal 0
+        end
+        it 'triggers remote tasks on TriggerNextBatch' do
+          Actions::TriggerProxyBatch.any_instance.expects(:trigger_remote_tasks_batch).once
+          run_action(triggered, Actions::TriggerProxyBatch::TriggerNextBatch[1])
+        end
+        it 'triggers remote tasks on TriggerNextBatch defined number of times' do
+          Actions::TriggerProxyBatch.any_instance.expects(:trigger_remote_tasks_batch).twice
+          run_action(triggered, Actions::TriggerProxyBatch::TriggerNextBatch[2])
+        end
+        it 'triggers the last batch on resume' do
+          Actions::TriggerProxyBatch.any_instance.expects(:trigger_remote_tasks_batch).once
+          triggered.output[:planned_count] = ((total_count - 1) / batch_size) * batch_size
+          run_action(triggered)
+        end
+      end
+      describe '#trigger_remote_tasks_batch' do
+        let(:proxy_operation_name) { 'ansible_runner' }
+        let(:grouped_remote_batch) { Array.new(batch_size).map { |i| mock("RemoteTask#{i}") } }
+        let(:remote_tasks) do
+          m = mock('RemoteTaskARScope')
+          m.stubs(pending: m, order: m)
+          m.stubs(group_by: { proxy_operation_name => grouped_remote_batch })
+          m
+        end
+        it 'fetches batch_size of tasks and triggers them' do
+          remote_tasks.expects(:first).with(batch_size).returns(remote_tasks)
+          remote_tasks.expects(:size).returns(batch_size)
+          triggered.expects(:remote_tasks).returns(remote_tasks)
+          ForemanTasks::RemoteTask.expects(:batch_trigger).with(proxy_operation_name, grouped_remote_batch)
+          triggered.trigger_remote_tasks_batch
+          _(triggered.output[:planned_count]).must_equal(batch_size)
+        end
+      end
+    end
+  end
+end

data/test/unit/triggering_test.rb CHANGED Viewed

@@ -19,6 +19,28 @@ class TriggeringTest < ActiveSupport::TestCase
       triggering.recurring_logic.stubs(:valid?).returns(false)
       _(triggering).wont_be :valid?
     end
+    it 'is valid when recurring logic has purpose' do
+      logic = FactoryBot.build(:recurring_logic, :purpose => 'test', :state => 'active')
+      triggering = FactoryBot.build(:triggering, :recurring_logic => logic, :mode => :recurring, :input_type => :cronline, :cronline => '* * * * *')
+      _(triggering).must_be :valid?
+    end
+    it 'is invalid when recurring logic with given purpose exists' do
+      FactoryBot.create(:recurring_logic, :purpose => 'test', :state => 'active')
+      logic = FactoryBot.build(:recurring_logic, :purpose => 'test', :state => 'active')
+      triggering = FactoryBot.build(:triggering, :recurring_logic => logic, :mode => :recurring, :input_type => :cronline, :cronline => '* * * * *')
+      _(triggering).wont_be :valid?
+    end
+    it 'is valid when recurring logic with given purpose exists and is not active or disabled' do
+      ['finished', 'cancelled', 'failed'].each do |item|
+        FactoryBot.create(:recurring_logic, :purpose => 'test', :state => item)
+      end
+      logic = FactoryBot.build(:recurring_logic, :purpose => 'test')
+      triggering = FactoryBot.build(:triggering, :recurring_logic => logic, :mode => :recurring, :input_type => :cronline, :cronline => '* * * * *')
+      _(triggering).must_be :valid?
+    end
   end
   it 'cannot have mode set to arbitrary value' do