foreman_remote_execution 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: cee9f09b684c8a829284e5eef226b75d241e91a3622fbad2f1626ff75855c812
-  data.tar.gz: 160de6767048860228ab7007394d548d937d757d8f19f3cd401e1257b96950ad
+SHA1:
+  metadata.gz: 4f9842eca9c6a28b109c5e9b7056a362908a8463
+  data.tar.gz: 8cf8bfd85fd584a9e18b756c4d7cf0d9e4adcc4c
 SHA512:
-  metadata.gz: c4c7c5c3a2d9173defa65b8a9fa81de541698345a623cf870f76f70a6c83792f8ecf9a70939f103fb78b0ef5fc4e8dd763bfd541df46f965bfbe532aa1cee9e8
-  data.tar.gz: 9311306fda1292ff48856e6f3c05808c61f89154f07491071f9e71bafbf089b13f18ef128749ad0c8726005d4f8d0658bc551ecacd3960d069fdce16387b485d
+  metadata.gz: 720b43d0d18f4521e329f0a690b8482048ee07297cf78ec6057bf20c05fe7c8da79d68f77406fbf637138d298fc4c68e3f4883df36916c36d4236e2e9e8e21c8
+  data.tar.gz: 5e2bd57fd39c8ecd7b09eb1ecca377edf608e8dd50007c9995af78a2f68b7828337582ea036b6dda37bdddf5f3e6bee2496cb8d75e9eb323c2bfad2937f0efd3

data/.rubocop.yml

@@ -105,3 +105,6 @@ Metrics/PerceivedComplexity:
 
 Metrics/AbcSize:
   Max: 45
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Api
+  module V2
+    class TemplateInvocationsController < ::Api::V2::BaseController
+
+      before_action :find_job_invocation, :only => %w{template_invocations}
+
+      api :GET, '/job_invocations/:job_invocation_id/template_invocations',
+          N_('List template invocations belonging to job invocation')
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      param :job_invocation_id, :identifier, :required => true
+      def template_invocations
+        @template_invocations = resource_scope.paginate(paginate_options)
+        render :layout => 'api/v2/layouts/index_layout'
+      end
+
+      def resource_scope
+        if params[:action] == 'template_invocations'
+          resource_scope_for_template_invocations
+        else
+          super
+        end
+      end
+
+      private
+
+      def resource_scope_for_template_invocations
+        @job_invocation.template_invocations.search_for(*search_options)
+      end
+
+      def find_job_invocation
+        @job_invocation = JobInvocation.find(params[:id])
+      end
+
+      def action_permission
+        case params[:action]
+        when 'template_invocations'
+          :view
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/controllers/job_invocations_controller.rb

@@ -13,6 +13,12 @@ class JobInvocationsController < ApplicationController
         :bookmark_id => params[:bookmark_id]
       }
     }
+    # replace an empty string search with a dummy search query to match all hosts
+    # but only if search query was entered (based on presence of :search parameter)
+    if params.key?(:search)
+      query = params[:search].empty? ? "name != ''" : params[:search]
+      ui_params[:targeting].update(:search_query => query)
+    end
 
     if (template = JobTemplate.find_by(id: params[:template_id]))
       ui_params[:job_invocation] = {

data/app/models/job_invocation_composer.rb

@@ -8,7 +8,7 @@ class JobInvocationComposer
 
     def params
       { :job_category => job_invocation_base[:job_category],
-        :targeting => ui_params.fetch(:targeting, {}).merge(:user_id => User.current.id),
+        :targeting => targeting(ui_params.fetch(:targeting, {})),
         :triggering => triggering,
         :host_ids => ui_params[:host_ids],
         :remote_execution_feature_id => job_invocation_base[:remote_execution_feature_id],
@@ -82,6 +82,10 @@ class JobInvocationComposer
       return trig unless trig.key?(:end_time) && trig[:end_time].keys == keys
       trig.merge(:end_time => Time.local(*trig[:end_time].values_at(*keys)))
     end
+
+    def targeting(targeting_params)
+      targeting_params.merge(:user_id => User.current.id)
+    end
   end
 
   class ApiParams

data/app/models/remote_execution_provider.rb

@@ -1,6 +1,6 @@
 class RemoteExecutionProvider
 
-  EFFECTIVE_USER_METHODS = %w[sudo su].freeze
+  EFFECTIVE_USER_METHODS = %w[sudo dzdo su].freeze
 
   class << self
     def provider_for(type)

data/app/views/api/v2/template_invocations/base.json.rabl

@@ -0,0 +1,5 @@
+object @template_invocation
+
+attributes :id, :template_id, :job_invocation_id, :effective_user, :host_id, :run_host_job_task_id
+
+node(:host_name) { |ti| ti.host.name }

data/app/views/api/v2/template_invocations/template_invocations.json.rabl

@@ -0,0 +1,3 @@
+collection @template_invocations
+
+extends 'api/v2/template_invocations/base'

data/app/views/job_invocations/welcome.html.erb

@@ -0,0 +1,14 @@
+<div class="blank-slate-pf">
+    <div class="blank-slate-pf-icon">
+        <%= icon_text("globe", "", :kind => "fa") %>
+    </div>
+    <h1><%= _('Job Invocations') %></h1>
+    <p>
+        <%= _("Foreman can run arbitrary commands on remote hosts using different providers, such as SSH or Ansible. Communication goes through the Smart Proxy so Foreman does not have to have direct access to the target hosts and can scale to control many hosts.") %></br>
+    </p>
+    <p><%= link_to _('Learn more about this in the documentation.'),
+           documentation_url('1.ForemanRemoteExecution1.3Manual', :root_url => 'https://www.theforeman.org/plugins/foreman_remote_execution/1.3/index.html#'), :rel => 'external' %></p>
+    <div class="blank-slate-pf-main-action">
+        <%= new_link(_("Run Job"), {}, { :class => "btn-lg" }) %>
+    </div>
+</div>

data/app/views/template_invocations/show.html.erb

@@ -1,4 +1,13 @@
-<% title _('Detail of %s run') % @template_invocation.job_invocation.job_category %>
+<% items = [{ :caption => @template_invocation.job_invocation.description,
+              :url => job_invocation_path(@template_invocation.job_invocation_id) },
+            { :caption => _('Template Invocation for %s') % @template_invocation.host.name }] %>
+
+<% breadcrumbs(:resource_url => template_invocations_api_job_invocation_path(@template_invocation.job_invocation_id),
+               :name_field => 'host_name',
+               :switcher_item_url => template_invocation_path(':id'),
+               :items => items)
+%>
+
 <% stylesheet 'foreman_remote_execution/template_invocation' %>
 <% javascript 'foreman_remote_execution/template_invocation' %>
 

data/config/routes.rb

@@ -47,6 +47,7 @@ Rails.application.routes.draw do
         member do
           post 'cancel'
           post 'rerun'
+          get  'template_invocations', :to => 'template_invocations#template_invocations'
         end
       end
 

data/db/seeds.d/70-job_templates.rb

@@ -1,8 +1,12 @@
+organizations = Organization.unscoped.all
+locations = Location.unscoped.all
 User.as_anonymous_admin do
   JobTemplate.without_auditing do
     Dir[File.join("#{ForemanRemoteExecution::Engine.root}/app/views/templates/**/*.erb")].each do |template|
       sync = !Rails.env.test? && Setting[:remote_execution_sync_templates]
-      JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+      template = JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+      template.organizations = organizations if SETTINGS[:organizations_enabled] && template.present?
+      template.locations = locations if SETTINGS[:locations_enabled] && template.present?
     end
   end
 end

data/foreman_remote_execution.gemspec

@@ -4,6 +4,7 @@ require 'date'
 Gem::Specification.new do |s|
   s.name        = 'foreman_remote_execution'
   s.version     = ForemanRemoteExecution::VERSION
+  s.license     = 'GPL-3.0'
   s.date        = Date.today.to_s
   s.authors     = ['Foreman Remote Execution team']
   s.email       = ['foreman-dev@googlegroups.com']

data/lib/foreman_remote_execution/engine.rb

@@ -59,6 +59,8 @@ module ForemanRemoteExecution
                                                 'api/v2/job_invocations' => [:create, :rerun] }, :resource_type => 'JobInvocation'
           permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search], :template_invocations => [:show],
                                               'api/v2/job_invocations' => [:index, :show, :output] }, :resource_type => 'JobInvocation'
+          permission :view_template_invocations, { :template_invocations => [:show],
+                                                   'api/v2/template_invocations' => [:template_invocations] }, :resource_type => 'TemplateInvocation'
           permission :create_template_invocations, {}, :resource_type => 'TemplateInvocation'
           permission :cancel_job_invocations, { :job_invocations => [:cancel], 'api/v2/job_invocations' => [:cancel] }, :resource_type => 'JobInvocation'
           # this permissions grants user to get auto completion hints when setting up filters

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.5.2'.freeze
+  VERSION = '1.5.3'.freeze
 end