foreman-tasks 0.7.20 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d050fd7d55d78ed330c5da74b31f7a340f652d85
-  data.tar.gz: 35e4c705611f00c5323dcdcca943d41a71dc988a
+  metadata.gz: 9309d18f9110a2295d933c2464788a8cceb42161
+  data.tar.gz: 94bc5fd42d4c176312d80ca1a45733593a23a395
 SHA512:
-  metadata.gz: 962203d2e16abf60f2b3b491bc3e14a1c229241609ff0701b3a736058d4bcd257ec2ec0174ffabdd938e7e1da60264ae118fc399ebd1d1f550d1d28142db0265
-  data.tar.gz: 612fa5a8838f36dd8b5cb4ad2321791ecf450d6bc5c6872092ad730f94a8da36ff660b3644887377307cebe0b070e9dc267d32e2562f933651c0816a71e84d3c
+  metadata.gz: 7536f877ffa338b8195477b8c2e14ca9856a0b3f125941ad1fda48383cf5c883c9061f3934e6b3ec68de7ffb706d69faa08709edc88c821139ac76765e3e5c48
+  data.tar.gz: f6285300dd2b63c27705c6a2fdc7f0e263e1f52faf62a4d0d40e41fa2566367df994daae4eaaebece8635b8ca0e62d9a07ab7643c04117bcc4915acbc8bfbf9a

data/README.md

@@ -178,13 +178,15 @@ override the default configuration inside the configuration
 The `foreman_tasks:cleanup` script also accepts additional parameters
 to specify the search criteria for the cleanup manually:
 
-* `FILTER`: scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')
+* `TASK_SEARCH`: scoped search filter (example: 'label =
+  "Actions::Foreman::Host::ImportFacts"')
 * `AFTER`: delete tasks created after `AFTER` period. Expected format
   is a number followed by the time unit (`s`, `h`, `m`, `y`), such as
-  `10d` for 10 days (applicable only when the `FILTER` option is specified)
+  `10d` for 10 days (applicable only when the `TASK_SEARCH` option is
+  specified)
 * `STATES`: comma separated list of task states to touch with the
   cleanup, by default only stopped tasks are affected
-  (applicable only when the `FILTER` option is specified)
+  (applicable only when the `TASK_SEARCH` option is specified)
 * `NOOP`: set to "true" if the task should not actuall perform the
   deletion, only report the actions the script would perform
 * `VERBOSE`: set to "true" for more verbose output

data/app/controllers/foreman_tasks/concerns/parameters/triggering.rb

@@ -0,0 +1,26 @@
+module ForemanTasks
+  module Concerns
+    module Parameters
+      module Triggering
+        extend ActiveSupport::Concern
+        include Foreman::Controller::Parameters::KeepParam
+
+        class_methods do
+          def triggering_params_filter
+            Foreman::ParameterFilter.new(::ForemanTasks::Triggering).tap do |filter|
+              filter.permit_by_context(:mode, :start_at, :start_before,
+                                       *::ForemanTasks::Triggering::PARAMS,
+                                       :nested => true)
+            end
+          end
+        end
+
+        def triggering_params
+          keep_param(params, :triggering, :days_of_week, :time, :end_time) do
+            self.class.triggering_params_filter.filter_params(params, parameter_filter_context, :triggering)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/foreman_tasks/triggering.rb

@@ -4,7 +4,6 @@ module ForemanTasks
               :cronline, :days, :days_of_week, :time, :end_time_limited,
               :end_time]
     attr_accessor *PARAMS
-    attr_accessible *PARAMS
 
     before_save do
       if future?

data/foreman-tasks.gemspec

@@ -26,7 +26,7 @@ DESC
   s.test_files = `git ls-files test`.split("\n")
   s.extra_rdoc_files = Dir['README*', 'LICENSE']
 
-  s.add_dependency "dynflow", '~> 0.8.8'
+  s.add_dependency "dynflow", '~> 0.8.13'
   s.add_dependency "sequel" # for Dynflow process persistence
   s.add_dependency "sinatra" # for Dynflow web console
   s.add_dependency "daemons" # for running remote executor

data/lib/foreman_tasks/tasks/cleanup.rake

@@ -3,21 +3,21 @@ namespace :foreman_tasks do
     desc <<DESC
 Clean tasks based on filter and age. ENV variables:
 
-  * FILTER     : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')
-  * AFTER      : delete tasks created after *AFTER* period. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days
-  * STATES     : comma separated list of task states to touch with the cleanup, by default only stopped tasks are covered
-  * NOOP       : set to "true" if the task should not actuall perform the deletion
-  * VERBOSE    : set to "true" for more verbose output
-  * BATCH_SIZE : the size of batches the tasks get processed in (1000 by default)
+  * TASK_SEARCH : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')
+  * AFTER       : delete tasks created after *AFTER* period. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days
+  * STATES      : comma separated list of task states to touch with the cleanup, by default only stopped tasks are covered
+  * NOOP        : set to "true" if the task should not actuall perform the deletion
+  * VERBOSE     : set to "true" for more verbose output
+  * BATCH_SIZE  : the size of batches the tasks get processed in (1000 by default)
 
-If none of FILTER, BEFORE, STATES is specified, the tasks will be cleaned based
+If none of TASK_SEARCH, BEFORE, STATES is specified, the tasks will be cleaned based
 configuration in settings
 DESC
     task :run => 'environment' do
       options = {}
 
-      if ENV['FILTER']
-        options[:filter] = ENV['FILTER']
+      if ENV['TASK_SEARCH']
+        options[:filter] = ENV['TASK_SEARCH']
       end
 
       if ENV['AFTER']
@@ -40,6 +40,10 @@ DESC
         options[:batch_size] = ENV['BATCH_SIZE'].to_i
       end
 
+      if ENV['FILTER']
+        fail "FILTER has been deprecated. Please use TASK_SEARCH instead."
+      end
+
       ForemanTasks::Cleaner.run(options)
     end
 

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -2,15 +2,31 @@
 # export_tasks.rake is a debugging tool to extract tasks from the
 # current foreman instance.
 #
-# Run "foreman-rake export_tasks" to export tasks whcih are not listed
-# as successful.
-# To export all tasks "foreman-rake export_tasks tasks=all"
-#   to specify the number of days of tasks to gather:  days=60 (defaults to 60)
+# Run "foreman-rake foreman_tasks:export_tasks" to export tasks
 
-namespace :foreman_tasks do
-  desc 'Export Dynflow Tasks'
+require 'csv'
 
+namespace :foreman_tasks do
+  desc <<DESC
+Export dynflow tasks based on filter. ENV variables:
+
+  * 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_DAYS       : number of days to go back
+
+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
+which requires a tar.gz file extension.
+DESC
   task :export_tasks => :environment do
+    deprecated_options = {:tasks => "TASK_SEARCH",
+                          :days => "TASK_DAYS",
+                          :export => "TASK_FILE"
+    }
+    deprecated_options.each do |option, new_option|
+      fail "The #{option} option is deprecated. Please use #{new_option} instead" if ENV.include?(option.to_s)
+    end
 
     class TaskRender
       def initialize
@@ -218,35 +234,50 @@ namespace :foreman_tasks do
       end
     end
 
-
-    if ENV['tasks'] == 'all'
-      tasks = ForemanTasks::Task
+    if ENV['TASK_SEARCH'].nil? && ENV['TASK_DAYS'].nil?
+      filter = "started_at > \"#{7.days.ago.to_s(:db)}\" || " \
+        "(result != success && started_at > \"#{60.days.ago.to_s(:db)})\""
     else
-      tasks = ForemanTasks::Task.where("result != 'success'")
+      filter = ENV['TASK_SEARCH'] || ''
     end
 
-    days = ENV['days'].try(:to_i) || 60
-    tasks = tasks.where('started_at > ?', days.days.ago)
-    export_filename = ENV['export'] || "/tmp/task-export-#{DateTime.now.to_i}.tar.gz"
+    if (days = ENV['TASK_DAYS'])
+      filter += " && " unless filter == ''
+      filter += "started_at > \"#{days.to_i.days.ago.to_s(:db)}\""
+    end
 
-    puts _("Gathering last #{days} days of tasks.")
-    Dir.mktmpdir('task-export') do |tmp_dir|
-      PageHelper.copy_assets(tmp_dir)
+    format = ENV['TASK_FORMAT'] || 'html'
+    export_filename = ENV['TASK_FILE'] || "/tmp/task-export-#{DateTime.now.to_i}.#{format == 'csv' ? 'csv' : 'tar.gz'}"
 
+    tasks = ForemanTasks::Task.search_for(filter)
 
-      renderer = TaskRender.new
-      count = 1
-      total = tasks.count
+    puts _("Gathering #{tasks.count} tasks.")
+    if format == 'html'
+      Dir.mktmpdir('task-export') do |tmp_dir|
+        PageHelper.copy_assets(tmp_dir)
 
-      tasks.all.each do |task|
-        File.open(File.join(tmp_dir, "#{task.id}.html"), 'w') {|file| file.write(PageHelper.pagify(renderer.render_task(task)))}
-        puts "#{count}/#{total}"
-        count += 1
-      end
 
-      File.open(File.join(tmp_dir, "index.html"), 'w') {|file| file.write(PageHelper.pagify(PageHelper.generate_index(tasks)))}
+        renderer = TaskRender.new
+        total = tasks.count
 
-      sh("tar cvzf #{export_filename} #{tmp_dir} > /dev/null")
+        tasks.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}"
+          count += 1
+        end
+
+        File.open(File.join(tmp_dir, "index.html"), 'w') {|file| file.write(PageHelper.pagify(PageHelper.generate_index(tasks)))}
+
+        sh("tar cvzf #{export_filename} #{tmp_dir} > /dev/null")
+      end
+    elsif format == 'csv'
+      CSV.open(export_filename, 'wb') do |csv|
+        csv << ['id', 'state', 'type', 'label', 'result', 'parent_task_id', 'started_at', 'ended_at']
+        tasks.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
     end
 
     puts "Created #{export_filename}"

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = "0.7.20"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.7.20
+  version: 0.8.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.8.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.8.13
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +105,7 @@ files:
 - app/controllers/foreman_tasks/api/tasks_controller.rb
 - app/controllers/foreman_tasks/concerns/environments_extension.rb
 - app/controllers/foreman_tasks/concerns/hosts_controller_extension.rb
+- app/controllers/foreman_tasks/concerns/parameters/triggering.rb
 - app/controllers/foreman_tasks/recurring_logics_controller.rb
 - app/controllers/foreman_tasks/tasks_controller.rb
 - app/helpers/foreman_tasks/foreman_tasks_helper.rb