foreman_remote_execution 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3de54e0a9f145a63c004e5e569305d4207167111
-  data.tar.gz: 9cea79ef9465ceb6b2164f3eb9b072c45753a0bb
+  metadata.gz: fdc605ffe45ecda6a6b4689598d5a445884f023a
+  data.tar.gz: 44a2f051b425edf500e4aca917c835484a5b7af3
 SHA512:
-  metadata.gz: e0dde3c38bf68c68c6cadeb4b5c78d1d916be96b92e0dcd313bb1fb0f2113c8003b2e652c95c3dba8138afb680bb5c40fa631131aa5ff4bb589373f209107993
-  data.tar.gz: 9057f5eaad349a39352a6ecaeeee828978695e58c8f9b20fe10e4395c1ea60066b469bd776f7470cf69dee44a463407a1abca512c584108760143cc5f35afbbc
+  metadata.gz: 8d8cda76fef2487397ca8a59433b5ef526c04b5a44ebe6604cf2c9b12b21f05d28a32d2d313cf72eb13cca83b2f05809839099847f68b0a6f750dd85168312e1
+  data.tar.gz: f142c1067294ff125544b699528d24f4036ebc2d748d817ccf6b43428a22e0f8880fca4dea57d27d04b7651a9088480c69df559c755b81453d0490fedc31a034

data/.rubocop.yml

@@ -45,3 +45,6 @@ Style/ClassAndModuleChildren:
 
 Style/EachWithObject:
   Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false

data/.rubocop_todo.yml

@@ -195,12 +195,6 @@ Style/SpaceInsideBrackets:
 Style/SpaceInsideHashLiteralBraces:
   Enabled: false
 
-# Offense count: 19
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
-  Enabled: false
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoredMethods.

data/app/assets/javascripts/template_input.js

@@ -7,3 +7,8 @@ function update_visibility_after_input_type_change(select){
   fieldset.find('div.custom_input_type_fields').hide();
   fieldset.find('div.' + select.val() + '_input_type').show();
 }
+
+function update_foreign_input_set_include(include_all_checkbox) {
+    fieldset = $(include_all_checkbox.closest('fieldset'));
+    fieldset.find('input.foreign_input_set_include').prop('disabled', include_all_checkbox.checked);
+}

data/app/assets/javascripts/template_invocation.js

@@ -1,6 +1,6 @@
 $(function() { job_invocation_form_binds() });
 
-function refresh_execution_form() {
+function refresh_execution_form(perform_description_reset) {
   var form = $('form#job_invocation_form');
   var data = form.serializeArray();
 
@@ -15,6 +15,11 @@ function refresh_execution_form() {
     password_caps_lock_hint();
     form.find('a[rel="popover-modal"]').popover({html: true});
     form.find('select').select2({allowClear: true});
+    if(perform_description_reset == true) {
+        var fieldset = $('fieldset#job_template_' + $('select.job_template_selector').val());
+        reset_description(fieldset);
+    }
+    template_change($('select.job_template_selector'));
     job_invocation_form_binds();
   });
 }
@@ -52,13 +57,15 @@ function close_preview_hosts_modal() {
 }
 
 function job_invocation_form_binds() {
-  $('input.job_template_selector').on('click', function () {
-    parent_fieldset = $(this).closest('fieldset');
-    $(parent_fieldset).find('fieldset.job_template_form').hide();
+  $('select.job_template_selector').on('click', function () {
+    provider_fieldset = $('#provider_' + $(this).data('providerType'));
+    $(provider_fieldset).find('fieldset.job_template_form').hide();
     $('#job_template_' + $(this).val()).show();
   });
 
-  $('select#job_invocation_job_name').on('change', refresh_execution_form);
+  $('select#job_invocation_job_category').on('change', function() {
+        refresh_execution_form(true);
+  });
 
   $('button#refresh_execution_form').on('click', refresh_execution_form);
 
@@ -85,8 +92,8 @@ function delayed_refresh(url, data){
 function job_invocation_refresh_data(){
   return {
     hosts_needs_refresh: $("div#hosts").data('refresh_required'),
+    host_ids_needing_name_update: fetch_ids_of_hosts('name'),
     host_ids_needing_status_update: fetch_ids_of_hosts('status'),
-    host_ids_needing_provider_update: fetch_ids_of_hosts('provider'),
     host_ids_needing_actions_update: fetch_ids_of_hosts('actions')
   }
 }
@@ -98,26 +105,27 @@ function fetch_ids_of_hosts(attribute){
 function regenerate_description(thing) {
   var fieldset = $(thing).closest('fieldset');
   var dict = load_keys(fieldset);
-  var format = fieldset.find('#description_format').val();
-  fieldset.find('#description').val(String.format(format, dict));
+  var format = fieldset.find('.description_format').val();
+  fieldset.find('.description').val(String.format(format, dict));
 }
 
 function load_keys(parent) {
   var dict = {};
-  var pattern = $(parent).find("#description_format").val();
+  var pattern = $(parent).find(".description_format").val();
   var re = new RegExp("%\\{([^\\}]+)\\}", "gm");
   var match = re.exec(pattern);
   while(match != null) {
     dict[match[1]] = $(parent).find("#" + match[1]).val();
     match = re.exec(pattern);
   }
-  dict['job_name'] = $('#job_invocation_job_name').val();
+  dict['job_category'] = $('#job_invocation_job_category').val();
+  dict['template_name'] = $('.job_template_selector:visible span.select2-chosen').html();
   return dict;
 }
 
 function description_override(source) {
-    var description_format_container = $(source).closest('fieldset').find('#description_format_container');
-    var description_format = $(description_format_container).find('#description_format');
+    var description_format_container = $(source).closest('fieldset').find('.description_format_container');
+    var description_format = $(description_format_container).find('.description_format');
     var old_value = $(source).val();
     if($(source).is(':checked')) {
 	$(description_format_container).hide();
@@ -129,6 +137,30 @@ function description_override(source) {
     regenerate_description(description_format);
 }
 
+function template_change(source) {
+    var template_forms = $('fieldset.job_template_form');
+    for(i = 0; i < template_forms.length; i++) {
+        set_description_disable(template_forms[i], true);
+    }
+    var id = $(source).val();
+    var template_fieldset = $(source).closest('form').find('fieldset#job_template_' + id);
+    set_description_disable(template_fieldset, false);
+    regenerate_description(template_fieldset.find('.description'));
+}
+
+function set_description_disable(thing, value) {
+    $(thing).find('.description').prop('disabled', value);
+    $(thing).find('.description_format').prop('disabled', value);
+    $(thing).find('.description_format_override').prop('disabled', value);
+}
+
+function reset_description(fieldset) {
+    var checkbox = $(fieldset).find('.description_format_override');
+    $(fieldset).find('.description_format').val($(checkbox).val());
+    $(checkbox).prop('checked', true);
+    $(fieldset).find('.description_format_container').hide();
+}
+
 String.format = function (pattern, dict) {
   if(pattern == undefined) {
     return "";

data/app/controllers/api/v2/foreign_input_sets_controller.rb

@@ -0,0 +1,80 @@
+module Api
+  module V2
+    class ForeignInputSetsController < ::Api::V2::BaseController
+      include ::Api::Version2
+      include ::Foreman::Renderer
+
+      before_filter :find_required_nested_object
+      before_filter :find_resource, :only => %w{show update destroy}
+
+      api :GET, '/templates/:template_id/foreign_input_sets', N_('List foreign input sets')
+      param :template_id, :identifier, :required => true
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      def index
+        @foreign_input_sets = nested_obj.foreign_input_sets.search_for(*search_options).paginate(paginate_options)
+      end
+
+      api :GET, '/templates/:template_id/foreign_input_sets/:id', N_('Show foreign input set details')
+      param :template_id, :identifier, :required => true
+      param :id, :identifier, :required => true
+      def show
+      end
+
+      def_param_group :foreign_input_set do
+        param :foreign_input_set, Hash, :required => true, :action_aware => true do
+          param :target_template_id, :identifier, :required => true, :desc => N_('Target template id')
+          param :include_all, :bool, :desc => N_('Include all inputs form the foreign template')
+          param :include, String, :desc => N_('A comma separated list of input names to be included from the foreign template.')
+          param :exclude, String, :desc => N_('A comma separated list of input names to be included from the foreign template.')
+          param :description, String, :required => false, :desc => N_('Input set description')
+        end
+      end
+
+      api :POST, '/templates/:template_id/foreign_input_sets/', N_('Create a foreign input set')
+      param :template_id, :identifier, :required => true
+      param_group :foreign_input_set, :as => :create
+      def create
+        @foreign_input_set = resource_class.new(params[:foreign_input_set].merge(:template_id => @nested_obj.id))
+        process_response @foreign_input_set.save
+      end
+
+      api :DELETE, '/templates/:template_id/foreign_input_sets/:id', N_('Delete a foreign input set')
+      param :template_id, :identifier, :required => true
+      param :id, :identifier, :required => true
+      def destroy
+        process_response @foreign_input_set.destroy
+      end
+
+      api :PUT, '/templates/:template_id/foreign_input_sets/:id', N_('Update a foreign input set')
+      param :template_id, :identifier, :required => true
+      param :id, :identifier, :required => true
+      param_group :foreign_input_set
+      def update
+        process_response @foreign_input_set.update_attributes(params[:foreign_input_set])
+      end
+
+      def resource_name(nested_resource = nil)
+        nested_resource || 'foreign_input_set'
+      end
+
+      def controller_permission
+        'templates'
+      end
+
+      def action_permission
+        case params[:action]
+        when :create, :edit, :destroy
+          'edit'
+        else
+          super
+        end
+      end
+
+      private
+
+      def resource_class
+        ForeignInputSet
+      end
+    end
+  end
+end

data/app/controllers/api/v2/job_invocations_controller.rb

@@ -12,44 +12,58 @@ module Api
 
       wrap_parameters JobInvocation, :include => (JobInvocation.attribute_names + [:ssh])
 
-      api :GET, "/job_invocations/", N_("List job invocations")
+      api :GET, '/job_invocations/', N_('List job invocations')
       param_group :search_and_pagination, ::Api::V2::BaseController
       def index
         @job_invocations = resource_scope_for_index
       end
 
-      api :GET, "/job_invocations/:id", N_("Show job invocation")
+      api :GET, '/job_invocations/:id', N_('Show job invocation')
       param :id, :identifier, :required => true
       def show
       end
 
       def_param_group :job_invocation do
         param :job_invocation, Hash, :required => true, :action_aware => true do
-          param :job_name, String, :required => true, :desc => N_("Job name")
-          param :job_template_id, String, :required => false, :desc => N_("If using a specific template, the id of that template.")
-          param :targeting_type, String, :required => true, :desc => N_("Invocation type, one of %s") % Targeting::TYPES
-          param :inputs, Hash, :required => false, :desc => N_("Inputs to use")
-          param :ssh, Hash, :desc => N_("Ssh provider specific options") do
+          param :job_category, String, :required => true, :desc => N_('Job category')
+          param :job_template_id, String, :required => false, :desc => N_('If using a specific template, the id of that template.')
+          param :targeting_type, String, :required => true, :desc => N_('Invocation type, one of %s') % Targeting::TYPES
+          param :inputs, Hash, :required => false, :desc => N_('Inputs to use')
+          param :ssh, Hash, :desc => N_('SSH provider specific options') do
             param :effective_user, String,
                   :required => false,
-                  :desc => N_("What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.")
+                  :desc => N_('What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.')
           end
+
+          param :recurrence, Hash, :desc => N_('Create a recurring job') do
+            param :cron_line, String, :required => false, :desc => N_('How often the job should occur, in the cron format')
+            param :max_iteration, :number, :required => false, :desc => N_('Repeat a maximum of N times')
+            param :end_time, DateTime, :required => false, :desc => N_('Perform no more executions after this time')
+          end
+
+          param :scheduling, Hash, :desc => N_('Schedule the job to start at a later time') do
+            param :start_at, DateTime, :required => false, :desc => N_('Schedule the job for a future time')
+            param :start_before, DateTime, :required => false, :desc => N_('Indicates that the action should be cancelled if it cannot be started before this time.')
+          end
+
           param :bookmark_id, Integer, :required => false
           param :search_query, Integer, :required => false
+          param :description_format, String, :required => false, :desc => N_('Override the description format from the template for this invocation only')
         end
       end
 
-      api :POST, "/job_invocations/", N_("Create a job invocation")
+      api :POST, '/job_invocations/', N_('Create a job invocation')
       param_group :job_invocation, :as => :create
       def create
         composer = JobInvocationComposer.from_api_params(job_invocation_params)
         composer.save!
-        ForemanTasks.async_task(::Actions::RemoteExecution::RunHostsJob, composer.job_invocation)
         @job_invocation = composer.job_invocation
+        @job_invocation.generate_description! if @job_invocation.description.blank?
+        composer.triggering.trigger(::Actions::RemoteExecution::RunHostsJob, @job_invocation)
         process_response @job_invocation
       end
 
-      api :GET, "/job_invocations/:id/hosts/:host_id", N_("Get output for a host")
+      api :GET, '/job_invocations/:id/hosts/:host_id', N_('Get output for a host')
       param :id, :identifier, :required => true
       param :host_id, :identifier, :required => true
       param :since, String, :required => false
@@ -90,13 +104,13 @@ module Api
         if job_invocation_params[:job_template_id]
           templates << JobTemplate.find(job_invocation_params[:job_template_id])
         else
-          templates = JobTemplate.where(:job_name => job_invocation_params[:job_name])
+          templates = JobTemplate.where(:job_category => job_invocation_params[:job_category])
           if templates.pluck(:provider_type).uniq.length != templates.length
-            raise Foreman::Exception, _("Duplicate remote execution providers found for specified Job, please specify a single job_template_id.")
+            raise Foreman::Exception, _('Duplicate remote execution providers found for specified Job, please specify a single job_template_id.')
           end
         end
 
-        raise Foreman::Exception, _("No templates associated with specified Job Name") if templates.empty?
+        raise Foreman::Exception, _('No templates associated with specified Job Name') if templates.empty?
       end
 
       def job_invocation_params

data/app/controllers/api/v2/job_templates_controller.rb

@@ -13,62 +13,66 @@ module Api
 
       wrap_parameters JobTemplate, :include => (JobTemplate.attribute_names + [:ssh])
 
-      api :GET, "/job_templates/", N_("List job templates")
-      api :GET, "/locations/:location_id/job_templates/", N_("List job templates per location")
-      api :GET, "/organizations/:organization_id/job_templates/", N_("List job templates per organization")
+      api :GET, '/job_templates/', N_('List job templates')
+      api :GET, '/locations/:location_id/job_templates/', N_('List job templates per location')
+      api :GET, '/organizations/:organization_id/job_templates/', N_('List job templates per organization')
       param_group :taxonomy_scope, ::Api::V2::BaseController
       param_group :search_and_pagination, ::Api::V2::BaseController
       def index
         @job_templates = resource_scope_for_index
       end
 
-      api :GET, "/job_templates/:id", N_("Show job template details")
+      api :GET, '/job_templates/:id', N_('Show job template details')
       param :id, :identifier, :required => true
       def show
       end
 
       def_param_group :job_template do
         param :job_template, Hash, :required => true, :action_aware => true do
-          param :name, String, :required => true, :desc => N_("Template name")
-          param :job_name, String, :required => true, :desc => N_("Job name")
+          param :name, String, :required => true, :desc => N_('Template name')
+          param :job_category, String, :required => true, :desc => N_('Job category')
+          param :description_format, String, :required => false, :desc => N_('This template is used to generate the description. ' +
+                                                                             'Input values can be used using the syntax %{package}. ' +
+                                                                             'You may also include the job category and template ' +
+                                                                             'name using %{job_category} and %{template_name}.')
           param :template, String, :required => true
-          param :provider_type, RemoteExecutionProvider.provider_names, :required => true, :desc => N_("Provider type")
+          param :provider_type, RemoteExecutionProvider.provider_names, :required => true, :desc => N_('Provider type')
           param :snippet, :bool, :allow_nil => true
           param :audit_comment, String, :allow_nil => true
-          param :locked, :bool, :desc => N_("Whether or not the template is locked for editing")
-          param :ssh, Hash, :desc => N_("Ssh provider specific options") do
-            param :effective_user, Hash, :desc => N_("Effective user options") do
-              param :value, String, :desc => N_("What user should be used to run the script (using sudo-like mechanisms)"), :allowed_nil => true
-              param :overridable, :bool, :desc => N_("Whether it should be allowed to override the effective user from the invocation form.")
-              param :current_user, :bool, :desc => N_("Whether the current user login should be used as the effective user")
+          param :locked, :bool, :desc => N_('Whether or not the template is locked for editing')
+          param :ssh, Hash, :desc => N_('SSH provider specific options') do
+            param :effective_user, Hash, :desc => N_('Effective user options') do
+              param :value, String, :desc => N_('What user should be used to run the script (using sudo-like mechanisms)'), :allowed_nil => true
+              param :overridable, :bool, :desc => N_('Whether it should be allowed to override the effective user from the invocation form.')
+              param :current_user, :bool, :desc => N_('Whether the current user login should be used as the effective user')
             end
           end
           param_group :taxonomies, ::Api::V2::BaseController
         end
       end
 
-      api :POST, "/job_templates/", N_("Create a job template")
+      api :POST, '/job_templates/', N_('Create a job template')
       param_group :job_template, :as => :create
       def create
         @job_template = JobTemplate.new(job_template_params)
         process_response @job_template.save
       end
 
-      api :PUT, "/job_templates/:id", N_("Update a job template")
+      api :PUT, '/job_templates/:id', N_('Update a job template')
       param :id, :identifier, :required => true
       param_group :job_template
       def update
         process_response @job_template.update_attributes(job_template_params)
       end
 
-      api :GET, "/job_templates/revision"
-      param :version, String, :desc => N_("Template version")
+      api :GET, '/job_templates/revision'
+      param :version, String, :desc => N_('Template version')
       def revision
         audit = Audit.authorized(:view_audit_logs).find(params[:version])
         render :json => audit.revision.template
       end
 
-      api :DELETE, "/job_templates/:id", N_("Delete a job template")
+      api :DELETE, '/job_templates/:id', N_('Delete a job template')
       param :id, :identifier, :required => true
       def destroy
         process_response @job_template.destroy
@@ -76,11 +80,11 @@ module Api
 
       def_param_group :job_template_clone do
         param :job_template, Hash, :required => true, :action_aware => true do
-          param :name, String, :required => true, :desc => N_("Template name")
+          param :name, String, :required => true, :desc => N_('Template name')
         end
       end
 
-      api :POST, "/job_templates/:id/clone", N_("Clone a provision template")
+      api :POST, '/job_templates/:id/clone', N_('Clone a provision template')
       param :id, :identifier, :required => true
       param_group :job_template_clone, :as => :create
       def clone

data/app/controllers/api/v2/template_inputs_controller.rb

@@ -5,17 +5,17 @@ module Api
       include ::Foreman::Renderer
 
       before_filter :find_required_nested_object
-      before_filter :find_resource, :only => %w{show update destroy clone}
+      before_filter :find_resource, :only => %w{show update destroy}
       before_filter :normalize_options, :only => %w{create update}
 
-      api :GET, "/templates/:template_id/template_inputs", N_("List template inputs")
+      api :GET, '/templates/:template_id/template_inputs', N_('List template inputs')
       param :template_id, :identifier, :required => true
       param_group :search_and_pagination, ::Api::V2::BaseController
       def index
         @template_inputs = nested_obj.template_inputs.search_for(*search_options).paginate(paginate_options)
       end
 
-      api :GET, "/templates/:template_id/template_inputs/:id", N_("Show template input details")
+      api :GET, '/templates/:template_id/template_inputs/:id', N_('Show template input details')
       param :template_id, :identifier, :required => true
       param :id, :identifier, :required => true
       def show
@@ -24,30 +24,33 @@ module Api
       def_param_group :template_input do
         param :template_input, Hash, :required => true, :action_aware => true do
           param :name, String, :required => true, :desc => N_('Input name')
+          param :description, String, :required => false, :desc => N_('Input description')
+          param :required, :bool, :allow_nil => true, :desc => N_('Input is required')
           param :input_type, TemplateInput::TYPES.keys.map(&:to_s), :required => true, :desc => N_('Input type')
           param :fact_name, String, :required => false, :desc => N_('Fact name, used when input type is fact')
           param :variable_name, String, :required => false, :desc => N_('Variable name, used when input type is variable')
+          param :puppet_parameter_class, String, :required => false, :desc => N_('Puppet class name, used when input type is puppet_parameter')
           param :puppet_parameter_name, String, :required => false, :desc => N_('Puppet parameter name, used when input type is puppet_parameter')
           param :options, Array, :required => false, :desc => N_('Selectable values for user inputs')
         end
       end
 
-      api :POST, "/templates/:template_id/template_inputs/", N_("Create a template input")
+      api :POST, '/templates/:template_id/template_inputs/', N_('Create a template input')
       param :template_id, :identifier, :required => true
       param_group :template_input, :as => :create
       def create
-        @template_input = TemplateInput.new(params[:template_input].merge(:template_id => @nested_obj.id))
+        @template_input = resource_class.new(params[:template_input].merge(:template_id => @nested_obj.id))
         process_response @template_input.save
       end
 
-      api :DELETE, "/templates/:template_id/template_inputs/:id", N_("Delete a template input")
+      api :DELETE, '/templates/:template_id/template_inputs/:id', N_('Delete a template input')
       param :template_id, :identifier, :required => true
       param :id, :identifier, :required => true
       def destroy
         process_response @template_input.destroy
       end
 
-      api :PUT, "/templates/:template_id/template_inputs/:id", N_("Update a template input")
+      api :PUT, '/templates/:template_id/template_inputs/:id', N_('Update a template input')
       param :template_id, :identifier, :required => true
       param :id, :identifier, :required => true
       param_group :template_input