foreman-tasks 0.7.6 → 0.7.7

data/app/models/foreman_tasks/task.rb

@@ -13,6 +13,10 @@ module ForemanTasks
     has_many :sub_tasks, :class_name => 'ForemanTasks::Task', :foreign_key => :parent_task_id
     has_many :locks
 
+    has_many :task_group_members
+    has_many :task_groups, :through => :task_group_members
+    has_many :recurring_logic_task_groups, :through => :task_group_members, :conditions => { :type => 'ForemanTasks::TaskGroups::RecurringLogicTaskGroup' }, :source => :task_group
+
     # in fact, the task has only one owner but Rails don't let you to
     # specify has_one relation though has_many relation
     has_many :owners, :through => :locks, :source => :resource, :source_type => 'User',
@@ -30,6 +34,7 @@ module ForemanTasks
     scoped_search :in => :owners,  :on => :id, :complete_value => true, :rename => "owner.id", :ext_method => :search_by_owner
     scoped_search :in => :owners,  :on => :login, :complete_value => true, :rename => "owner.login", :ext_method => :search_by_owner
     scoped_search :in => :owners,  :on => :firstname, :complete_value => true, :rename => "owner.firstname", :ext_method => :search_by_owner
+    scoped_search :in => :task_groups, :on => :id, :complete_value => true, :rename => "task_group.id"
 
     scope :active, -> {  where('foreman_tasks_tasks.state != ?', :stopped) }
     scope :running, -> {  where("foreman_tasks_tasks.state NOT IN ('stopped', 'paused')") }
@@ -141,6 +146,11 @@ module ForemanTasks
       'ForemanTasks::Task'
     end
 
+    def add_missing_task_groups(groups)
+      groups = [groups] unless groups.is_a? Array
+      (groups - task_groups).each { |group| task_groups << group }
+    end
+
     protected
 
     def generate_id

data/app/models/foreman_tasks/task_group.rb

@@ -0,0 +1,16 @@
+module ForemanTasks
+  class TaskGroup < ActiveRecord::Base
+
+    has_many :task_group_members
+    has_many :tasks, :through => :task_group_members
+
+    def resource_name
+      raise NotImplementedError
+    end
+
+    def resource
+      raise NotImplementedError
+    end
+
+  end
+end

data/app/models/foreman_tasks/task_group_member.rb

@@ -0,0 +1,8 @@
+module ForemanTasks
+  class TaskGroupMember < ActiveRecord::Base
+
+    belongs_to :task_group
+    belongs_to :task
+    
+  end
+end

data/app/models/foreman_tasks/task_groups/recurring_logic_task_group.rb

@@ -0,0 +1,16 @@
+module ForemanTasks
+  module TaskGroups
+    class RecurringLogicTaskGroup < ::ForemanTasks::TaskGroup
+
+      has_one :recurring_logic, :foreign_key => :task_group_id
+
+      alias_method :resource, :recurring_logic
+
+      def resource_name
+        N_('Recurring logic')
+      end
+
+    end
+  end
+end
+

data/app/models/foreman_tasks/triggering.rb

@@ -0,0 +1,99 @@
+module ForemanTasks
+  class Triggering < ActiveRecord::Base
+
+    attr_accessor :start_at_raw, :start_before_raw, :max_iteration, :input_type,
+                  :cronline, :days, :days_of_week, :time, :end_time_limited,
+                  :end_time
+
+    before_save do
+      if future?
+        parse_start_at!
+        parse_start_before!
+      end
+    end
+
+    after_find do |triggering|
+      triggering.mode = triggering.mode.to_sym
+    end
+
+    ALLOWED_MODES = [:immediate, :future, :recurring]
+    ALLOWED_INPUT_TYPES = [:cronline, :monthly, :weekly, :daily, :hourly]
+
+    TIME_FORMAT = "%Y-%m-%d %H:%M"
+    TIME_REGEXP = /\A\d{4}-\d{2}-\d{2} \d{2}:\d{2}\Z/
+    DAYS_REGEXP = /\A(\s*\d{1,2}\s*)(,\s*\d{1,2}\s*)*\Z/
+
+    has_one :recurring_logic, :foreign_key => :triggering_id
+
+    validates :mode, :inclusion => { :in => ALLOWED_MODES,
+                                     :message => _("%{value} is not allowed triggering mode")  }
+    validates :input_type, :if => :recurring?,
+              :inclusion => { :in => ALLOWED_INPUT_TYPES,
+                              :message => _("%{value} is not allowed input type") }
+    validates_format_of :start_at_raw, :with => TIME_REGEXP, :if => :future?,
+                        :message => _("%{value} is wrong format")
+    validates_format_of :start_before_raw, :with => TIME_REGEXP, :if => :future?,
+                        :message => _("%{value} is wrong format"), :allow_blank => true
+    validates_format_of :days, :with => DAYS_REGEXP,
+                        :if => Proc.new { |t| t.recurring? && t.input_type == :monthly }
+    validate :correct_cronline, :if => Proc.new { |t| t.recurring? && t.input_type == :cronline }
+
+    def self.new_from_params(params = {})
+      self.new(params).tap do |targeting|
+        targeting.mode = params.fetch(:mode, :immediate).to_sym
+        targeting.input_type = params.fetch(:input_type, :cronline).to_sym
+        targeting.end_time_limited = params[:end_time_limited] == "true"
+        targeting.start_at_raw = Time.now.strftime(TIME_FORMAT)
+      end
+    end
+
+    def trigger(action, *args)
+      case mode
+      when :immediate
+        ::ForemanTasks.async_task action, *args
+      when :future
+        ::ForemanTasks.delay action,
+                             delay_options,
+                             *args
+      when :recurring
+        ::ForemanTasks::RecurringLogic.new_from_triggering(self)
+        .start(action, *args)
+      end
+    end
+
+    def delay_options
+      {
+        :start_at => start_at,
+        :start_before => start_before
+      }
+    end
+
+    def future?
+      mode == :future
+    end
+
+    def immediate?
+      mode == :immediate
+    end
+
+    def recurring?
+      mode == :recurring
+    end
+
+    def parse_start_at!
+      self.start_at ||= Time.strptime(start_at_raw, TIME_FORMAT)
+    end
+
+    def parse_start_before!
+      self.start_before ||= Time.strptime(start_before_raw, TIME_FORMAT) unless start_before_raw.blank?
+    end
+
+    private
+
+    def correct_cronline
+      ForemanTasks::RecurringLogic.new_from_cronline(cronline).next_occurrence_time
+    rescue ArgumentError => _
+      self.errors.add(:cronline, _("#{cronline} is not valid format of cronline"))
+    end
+  end
+end

data/app/views/common/_trigger_form.html.erb

@@ -0,0 +1,14 @@
+<div class="form-group trigger_mode">
+  <% javascript 'trigger_form' %>
+  <%= javascript_tag do %>
+  $(function() { trigger_form_selector_binds('<%= f.options[:html][:id] %>','<%= f.object_name %>') });
+  <% end %>
+  <%= fields_for :triggering, triggering do |trigger_fields| %>
+  <legend><%= _('Schedule Job') %></legend>
+  <%= radio_button_f trigger_fields, :mode, :class => 'trigger_mode_selector', :value => 'immediate', :text => _("Execute now") %>
+  <%= radio_button_f trigger_fields, :mode, :class => 'trigger_mode_selector', :value => 'future',    :text => _("Schedule future execution") %>
+  <%= radio_button_f trigger_fields, :mode, :class => 'trigger_mode_selector', :value => 'recurring', :text => _("Set up recurring execution") %>
+  <%= future_mode_fieldset trigger_fields, triggering %>
+  <%= recurring_mode_fieldset trigger_fields, triggering %>
+  <% end %>
+</div>

data/app/views/foreman_tasks/recurring_logics/_tab_related.html.erb

@@ -0,0 +1,3 @@
+<div>
+  <%= render 'foreman_tasks/task_groups/tab_related', :source => source %>
+</div>

data/app/views/foreman_tasks/recurring_logics/index.html.erb

@@ -0,0 +1,34 @@
+<% title _("Recurring logics") %>
+<% title_actions help_path %>
+
+<table class="table table-fixed table-bordered table-striped table-condensed">
+  <thead>
+    <th><%= N_("Cronline") %></th>
+    <th><%= N_("Task count") %></th>
+    <th><%= N_("Action") %></th>
+    <th><%= N_("Last occurrence") %></th>
+    <th><%= N_("Next occurrence") %></th>
+    <th><%= N_("Current iteration") %></th>
+    <th><%= N_("Iteration limit") %></th>
+    <th><%= N_("Repeat until") %></th>
+    <th><%= N_("State") %></th>
+    <th/>
+  </thead>
+  <% @recurring_logics.each do |recurring_logic| %>
+    <tr>
+      <td><%= link_to(recurring_logic.cron_line, foreman_tasks_recurring_logic_path(recurring_logic)) %></td>
+      <td><%= link_to(recurring_logic.tasks.count, foreman_tasks_tasks_url(:search => "task_group.id = #{recurring_logic.task_group.id}")) %></td>
+      <td><%= format_task_input(recurring_logic.tasks.first, true) %></td>
+      <td><%= recurring_logic.tasks.order(:started_at).where('started_at IS NOT NULL').last.try(:started_at) || N_("-") %></td>
+      <td><%= recurring_logic_next_occurrence recurring_logic %></td>
+      <td><%= recurring_logic.iteration %></td>
+      <td><%= format_recurring_logic_limit recurring_logic.max_iteration %></td>
+      <td><%= format_recurring_logic_limit recurring_logic.end_time.try(:in_time_zone) %></td>
+      <td><%= recurring_logic_state(recurring_logic) %></td>
+      <td><%= recurring_logic_action_buttons(recurring_logic) %></td>
+    </tr>
+  <% end %>
+</table>
+
+<%= page_entries_info @recurring_logics %>
+<%= will_paginate @recurring_logics %>

data/app/views/foreman_tasks/recurring_logics/show.html.erb

@@ -0,0 +1,12 @@
+<% title N_('Recurring logic') %>
+
+<% title_actions(button_group(recurring_logic_action_buttons(@recurring_logic))) %>
+
+<div class="tab-content col-md-6">
+  <legend><%= _('Details') %></legend>
+  <%= render @recurring_logic.task_group, :task_group => @recurring_logic.task_group %>
+</div>
+
+<div class="tab-content col-md-6">
+  <%= render 'tab_related', :source => @recurring_logic %>
+</div>

data/app/views/foreman_tasks/task_groups/_common.html.erb

@@ -0,0 +1,12 @@
+<div>
+  <table class='table table-condensed'>
+    <tr>
+      <th><%= N_('ID') %></th>
+      <td><%= link_to(task_group.id, foreman_tasks_task_group_url(task_group)) %></td>
+    </tr>
+    <tr>
+      <th><%= N_('Task count') %></th>
+      <td><%= link_to(task_group.tasks.count, foreman_tasks_tasks_url(:search => "task_group.id = #{task_group.id}")) %></td>
+    </tr>
+  </table>
+</div>

data/app/views/foreman_tasks/task_groups/_detail.html.erb

@@ -0,0 +1,7 @@
+<legend><%= N_('Task group common') %></legend>
+<%= render 'foreman_tasks/task_groups/common', :task_group => task_group %>
+<legend><%= task_group.humanized_name %> specific</legend>
+<div>
+  <%= begin; render task_group.to_partial_path.dup, :task_group => task_group; rescue ActionView::MissingTemplate => e; end %>
+</div>
+

data/app/views/foreman_tasks/task_groups/_tab_related.html.erb

@@ -0,0 +1,17 @@
+<div>
+  <legend><%= _("Associated resources") %></legend>
+  <ul>
+    <% source.task_groups.pluck(:type).uniq.each do |type| %>
+      <% next if type == source.task_group.type %>
+      <% groups = source.task_groups.where(:type => type) %>
+      <% begin %>
+        <%= render groups.first.to_partial_path.pluralize.dup, :source => source, :task_groups => groups %>
+      <% rescue ActionView::MissingTemplate => _ %>
+        <% groups.each do |group| %>
+          <%= render 'foreman_tasks/task_groups/common', :source => source, :task_group => group %>
+        <% end %>
+      <% end %>
+    <% end %>
+  </ul>
+</div>
+

data/app/views/foreman_tasks/task_groups/recurring_logic_task_groups/_recurring_logic_task_group.html.erb

@@ -0,0 +1,39 @@
+<% recurring_logic = task_group.recurring_logic -%>
+<table class='table table-condensed'>
+  <tr>
+    <th>ID</th>
+    <td><%= link_to(recurring_logic.id, recurring_logic) %></td>
+  </tr>
+  <tr>
+    <th><%= N_("Cronline") %></th>
+    <td><%= recurring_logic.cron_line %></td>
+  </tr>
+  <tr>
+    <th><%= N_("Action") %></th>
+    <td><%= format_task_input(recurring_logic.tasks.first, true) %></td>
+  </tr>
+  <tr>
+    <th><%= N_("Last occurrence") %></th>
+    <td><%= recurring_logic.tasks.order(:started_at).where('started_at IS NOT NULL').last.try(:started_at) || N_('-') %></td>
+  </tr>
+  <tr>
+    <th><%= N_("Next occurrence") %></th>
+    <td><%= recurring_logic_next_occurrence recurring_logic %></td>
+  </tr>
+  <tr>
+    <th><%= N_("Current iteration") %></th>
+    <td><%= recurring_logic.iteration %></td>
+  </tr>
+  <tr>
+    <th><%= N_("Iteration limit") %></th>
+    <td><%= format_recurring_logic_limit recurring_logic.max_iteration %></td>
+  </tr>
+  <tr>
+    <th><%= N_("Repeat until") %></th>
+    <td><%= format_recurring_logic_limit recurring_logic.end_time.try(:in_time_zone) %></td>
+  </tr>
+  <tr>
+    <th><%= N_("State") %></th>
+    <td><%= recurring_logic_state(recurring_logic) %></td>
+  </tr>
+</table>

data/config/routes.rb

@@ -1,5 +1,11 @@
 Foreman::Application.routes.draw do
   namespace :foreman_tasks do
+    resources :recurring_logics, :only => [:index, :show] do
+      member do
+        post :cancel
+      end
+    end
+
     resources :tasks, :only => [:index, :show] do
       collection do
         get 'auto_complete_search'

data/db/migrate/20150814204140_add_task_type_value_index.rb

@@ -0,0 +1,5 @@
+class AddTaskTypeValueIndex < ActiveRecord::Migration
+  def change
+     add_index :foreman_tasks_tasks, [:type, :label]
+  end
+end

data/db/migrate/20150907124936_create_recurring_logic.rb

@@ -0,0 +1,11 @@
+class CreateRecurringLogic < ActiveRecord::Migration
+  def change
+    create_table :foreman_tasks_recurring_logics do |t|
+      t.string :cron_line, :null => false
+      t.datetime :end_time
+      t.integer :max_iteration
+      t.integer :iteration, :default => 0
+      t.integer :task_group_id, :index => true, :null => false
+    end
+  end
+end

data/db/migrate/20150907131503_create_task_groups.rb

@@ -0,0 +1,19 @@
+class CreateTaskGroups < ActiveRecord::Migration
+  def up
+    create_table :foreman_tasks_task_groups do |t|
+      t.string :type, index: true, null: false
+    end
+
+    create_table :foreman_tasks_task_group_members do |t|
+      t.string :task_id, null: false
+      t.integer :task_group_id, null: false
+    end
+
+    add_index :foreman_tasks_task_group_members, [:task_id, :task_group_id], unique: true, name: 'foreman_tasks_task_group_members_index'
+  end
+
+  def down
+    drop_table :foreman_tasks_task_groups
+    drop_table :foreman_tasks_task_group_members
+  end
+end

data/db/migrate/20151022123457_add_recurring_logic_state.rb

@@ -0,0 +1,9 @@
+class AddRecurringLogicState < ActiveRecord::Migration
+  def up
+    add_column :foreman_tasks_recurring_logics, :state, :string, :index => true
+  end
+
+  def down
+    remove_column :foreman_tasks_recurring_logics, :state
+  end
+end

data/db/migrate/20151112152108_create_triggerings.rb

@@ -0,0 +1,18 @@
+class CreateTriggerings < ActiveRecord::Migration
+  def up
+    create_table :foreman_tasks_triggerings do |t|
+      t.string :mode, null: false
+      t.datetime :start_at
+      t.datetime :start_before
+    end
+
+    change_table :foreman_tasks_recurring_logics do |t|
+      t.integer :triggering_id
+    end
+  end
+
+  def down
+    drop_table :foreman_tasks_triggerings
+    remove_column :foreman_tasks_recurring_logics, :triggering_id
+  end
+end

data/lib/foreman_tasks/engine.rb

@@ -15,11 +15,23 @@ module ForemanTasks
              :caption  => N_('Tasks'),
              :parent   => :monitor_menu
 
+        menu :top_menu, :recurring_logics, :after => :tasks,
+             :url_hash => { :controller => 'foreman_tasks/recurring_logics', :action => :index },
+             :caption  => N_('Recurring logics'),
+             :parent   => :monitor_menu
+
         security_block :foreman_tasks do |map|
           permission :view_foreman_tasks, {:'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :show],
                                            :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary] }, :resource_type => ForemanTasks::Task.name
           permission :edit_foreman_tasks, {:'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel],
                                            :'foreman_tasks/api/tasks' => [:bulk_resume]}, :resource_type => ForemanTasks::Task.name
+
+          permission :create_recurring_logics, { }, :resource_type => ForemanTasks::RecurringLogic
+
+          permission :view_recurring_logics, { :'foreman_tasks/recurring_logics' => [:index, :show] }, :resource_type => ForemanTasks::RecurringLogic
+
+          permission :edit_recurring_logics, { :'foreman_tasks/recurring_logics' => [:cancel] }, :resource_type => ForemanTasks::RecurringLogic
+                                                                                                                                 
         end
 
         logger :dynflow, :enabled => true

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -27,7 +27,7 @@ namespace :foreman_tasks do
 
       def render_task(task)
         @plan = task.execution_plan
-        erb('show', {})
+        erb('show')
       end
 
       def world
@@ -38,7 +38,7 @@ namespace :foreman_tasks do
         File.join(Gem::Specification.find_by_name("dynflow").gem_dir, 'web', 'views', "#{filename}.erb")
       end
 
-      def erb(file, options)
+      def erb(file, options = {})
         unless @cache[file]
           @cache[file] = Tilt.new(template(file))
         end