foreman_remote_execution 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d91fb9bffefb6a6d9414902cf0b666dcbee5763ce910931461126c81962b9c70
-  data.tar.gz: d735b4f6382e1f9daf255f3f0033cc8f3e7b00ad720a3c51b1e40b8aea5fb659
+  metadata.gz: '088390c13c651a79849a384d7745fad23975bacbedf7913be50d6bed8d66db60'
+  data.tar.gz: 6138f9a4c9cdc374e21254c739ec3c45b5dd95ebd87bd04e40dce2b346874380
 SHA512:
-  metadata.gz: fa5ae15780a665b6a940ac25c86ba77f52b0ba51cc71ae6ebb4b2c55928876e3e5ecd4b4889ac3e451603939b3daaef14b52b994fdb639b0b24d45987da111fa
-  data.tar.gz: d8b669044ad9c7b37e95a56ba739ea7f02c23af08f70c89c6cad65ba0f6be2fbda84b61e53ca6e37c61ab10e536074b7417fe61e8181bce6b2dfd98c3ec6e45e
+  metadata.gz: c866a3ae708c68f9e2176817d74b27c185558cba82e5d3e0c9777fe6e32a538742fac1ff60c472ed8deda93890db3b81e7b0c38af3102dbe0b56590342559a0c
+  data.tar.gz: c4a1f91be44fb15b78ce1b4ff262b885bb3b325caa7a0ac6078203f3c3011e1ff93e97082869806e14a4428e95b0476cc451d267188bc41ab0b2c4e2eaba1bd3

data/.babelrc

@@ -3,7 +3,14 @@
   "plugins": [
     "transform-class-properties",
     "transform-object-rest-spread",
-    "transform-object-assign",
-    "lodash"
-  ]
+    "transform-object-assign"
+  ],
+  "env": {
+    "test": {
+      "presets": ["@theforeman/vendor-dev/babel.preset.js"]
+    },
+    "storybook": {
+      "presets": ["@theforeman/vendor-dev/babel.preset.js"]
+    }
+  }
 }

data/.eslintrc

@@ -1,6 +1,6 @@
 {
   "root": true,
-  "extends": "airbnb-base",
+  "extends": ["airbnb-base", "./node_modules/@theforeman/vendor-dev/eslint.extends.js"],
   "plugins": [
     "react"
   ],
@@ -11,16 +11,6 @@
     "jasmine": true,
     "jest": true
   },
-  "globals": {
-    "document": false,
-    "escape": false,
-    "navigator": false,
-    "unescape": false,
-    "window": false,
-    "$": true,
-    "_": true,
-    "__": true
-  },
   "parser": "babel-eslint",
   "rules": {
     "react/jsx-uses-vars": "error",
@@ -35,13 +25,6 @@
     "no-underscore-dangle": "off",
     "no-use-before-define": "off",
     "import/prefer-default-export": "off",
-    "import/no-extraneous-dependencies": [
-      "error",
-      {
-        // Allow importing devDependencies like @storybook
-        "devDependencies": true
-      }
-    ],
     // Import rules off for now due to HoundCI issue
     "import/no-unresolved": "off",
     "import/extensions": "off"

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

@@ -25,6 +25,7 @@ module Api
         param :job_invocation, Hash, :required => true, :action_aware => true do
           param :job_template_id, String, :required => false, :desc => N_('The job template to use, parameter is required unless feature was specified')
           param :targeting_type, String, :required => true, :desc => N_('Invocation type, one of %s') % Targeting::TYPES
+          param :randomized_ordering, :bool, :desc => N_('Execute the jobs on hosts in randomized order')
           param :inputs, Hash, :required => false, :desc => N_('Inputs to use')
           param :ssh, Hash, :desc => N_('SSH provider specific options') do
             param :effective_user, String,

data/app/lib/actions/remote_execution/run_hosts_job.rb

@@ -69,7 +69,7 @@ module Actions
       end
 
       def hosts
-        job_invocation.targeting.hosts.order(:name, :id)
+        job_invocation.targeting.hosts.order("#{TargetingHost.table_name}.id")
       end
 
       def set_up_concurrency_control(invocation)

data/app/models/job_invocation.rb

@@ -23,7 +23,7 @@ class JobInvocation < ApplicationRecord
   validates_associated :targeting, :all_template_invocations
 
   scoped_search :on => :job_category, :complete_value => true
-  scoped_search :on => :description # FIXME No auto complete because of https://github.com/wvanbergen/scoped_search/issues/138
+  scoped_search :on => :description, :complete_value => true
 
   has_many :template_invocations_hosts, :through => :template_invocations, :source => :host
   scoped_search :relation => :template_invocations_hosts, :on => :name, :rename => 'host', :complete_value => true

data/app/models/job_invocation_composer.rb

@@ -108,7 +108,7 @@ class JobInvocationComposer
 
     def targeting_params
       raise ::Foreman::Exception, _('Cannot specify both bookmark_id and search_query') if api_params[:bookmark_id] && api_params[:search_query]
-      api_params.slice(:targeting_type, :bookmark_id, :search_query).merge(:user_id => User.current.id)
+      api_params.slice(:targeting_type, :bookmark_id, :search_query, :randomized_ordering).merge(:user_id => User.current.id)
     end
 
     def triggering_params
@@ -205,7 +205,7 @@ class JobInvocationComposer
         search_query = @host_ids.empty? ? 'name ^ ()' : Targeting.build_query_from_hosts(@host_ids)
         base.merge(:search_query => search_query, :targeting_type => job_invocation.targeting.targeting_type)
       else
-        base.merge job_invocation.targeting.attributes.slice('search_query', 'bookmark_id', 'targeting_type')
+        base.merge job_invocation.targeting.attributes.slice('search_query', 'bookmark_id', 'targeting_type', 'randomized_ordering')
       end
     end
 
@@ -512,7 +512,8 @@ class JobInvocationComposer
     Targeting.new(
       :bookmark_id => bookmark_id,
       :targeting_type => params[:targeting][:targeting_type],
-      :search_query => query
+      :search_query => query,
+      :randomized_ordering => params[:targeting][:randomized_ordering]
     ) { |t| t.user_id = params[:targeting][:user_id] }
   end
 

data/app/models/targeting.rb

@@ -5,11 +5,15 @@ class Targeting < ApplicationRecord
   TYPES = { STATIC_TYPE => N_('Static Query'), DYNAMIC_TYPE => N_('Dynamic Query') }.freeze
   RESOLVE_PERMISSION = :view_hosts
 
+  ORDERED = 'ordered_execution'.freeze
+  RANDOMIZED = 'randomized_execution'.freeze
+  ORDERINGS = { ORDERED => N_('Alphabetical'), RANDOMIZED => N_('Randomized') }.freeze
+
   belongs_to :user
   belongs_to :bookmark
 
   has_many :targeting_hosts, :dependent => :destroy
-  has_many :hosts, :through => :targeting_hosts
+  has_many :hosts, -> { order TargetingHost.table_name + '.id' }, :through => :targeting_hosts
   has_one :job_invocation, :dependent => :delete
   has_many :template_invocations, :through => :job_invocation
 
@@ -40,7 +44,8 @@ class Targeting < ApplicationRecord
     self.validate!
     # avoid validation of hosts objects - they will be loaded for no reason.
     #   pluck(:id) returns duplicate results for HostCollections
-    host_ids = User.as(user.login) { Host.authorized(RESOLVE_PERMISSION, Host).search_for(search_query).pluck(:id).uniq }
+    host_ids = User.as(user.login) { Host.authorized(RESOLVE_PERMISSION, Host).search_for(search_query).order(:name, :id).pluck(:id).uniq }
+    host_ids.shuffle!(random: Random.new) if randomized_ordering
     # this can be optimized even more, by introducing bulk insert
     self.targeting_hosts.build(host_ids.map { |id| { :host_id => id } })
     self.save(:validate => false)

data/app/views/api/v2/job_invocations/main.json.rabl

@@ -16,7 +16,8 @@ node do |invocation|
 end
 
 child :targeting do
-  attributes :bookmark_id, :search_query, :targeting_type, :user_id, :status, :status_label
+  attributes :bookmark_id, :search_query, :targeting_type, :user_id, :status, :status_label,
+             :randomized_ordering
 
   child :hosts do
     extends 'api/v2/hosts/base'

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

@@ -16,6 +16,10 @@
     <strong><%= _(Targeting::TYPES[job_invocation.targeting.targeting_type]).downcase %></strong>
     <pre><%= job_invocation.targeting.search_query %></pre>
     </p>
+    <p>
+      <% key = job_invocation.targeting.randomized_ordering ? Targeting::RANDOMIZED : Targeting::ORDERED %>
+      <%= _('Execution order') %>: <strong><%= Targeting::ORDERINGS[key].downcase %></strong>
+    </p>
   </div>
   <div class='card-pf-footer'>
     <p>

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

@@ -104,13 +104,21 @@
     </div>
 
     <div class="form-group advanced hidden">
+      <%= add_label({ :label => _('Execution ordering'), :label_help => _("Execution ordering determines whether the jobs should be executed on hosts in alphabetical order or in randomized order.<br><ul><li><b>Ordered</b> - executes the jobs on hosts in alphabetical order</li><li><b>Randomized</b> - randomizes the order in which jobs are executed on hosts</li></ul>") }, f, :randomized_ordering) %>
+
+      <div class="col-md-4">
+        <%= radio_button_f targeting_fields, :randomized_ordering, :value => false, :text => _(Targeting::ORDERINGS[Targeting::ORDERED]), :checked => !@composer.targeting.randomized_ordering %>
+        <%= radio_button_f targeting_fields, :randomized_ordering, :value => true, :text => _(Targeting::ORDERINGS[Targeting::RANDOMIZED]) %>
+      </div>
+    </div>
+
+    <div class="form-group">
       <%= add_label({ :label => _('Type of query'), :label_help => _("Type has impact on when is the query evaluated to hosts.<br><ul><li><b>Static</b> - evaluates just after you submit this form</li><li><b>Dynamic</b> - evaluates just before the execution is started, so if it's planed in future, targeted hosts set may change before it</li></ul>") }, f, :targetting_type) %>
 
       <div class="col-md-4">
         <%= radio_button_f targeting_fields, :targeting_type, :value => Targeting::STATIC_TYPE, :text => _(Targeting::TYPES[Targeting::STATIC_TYPE]) %>
         <%= radio_button_f targeting_fields, :targeting_type, :value => Targeting::DYNAMIC_TYPE, :text => _(Targeting::TYPES[Targeting::DYNAMIC_TYPE]) %>
       </div>
-
     </div>
   <% end %>
 

data/db/migrate/20180913101042_add_randomized_ordering_to_targeting.rb

@@ -0,0 +1,5 @@
+class AddRandomizedOrderingToTargeting < ActiveRecord::Migration[5.2]
+  def change
+    add_column :targetings, :randomized_ordering, :bool, :default => false
+  end
+end

data/db/seeds.d/100-assign_features_with_templates.rb

@@ -0,0 +1,21 @@
+User.as_anonymous_admin do
+  RemoteExecutionFeature.without_auditing do
+    if Rails.env.test? || Foreman.in_rake?
+      # If this file tries to import a template with a REX feature in a SeedsTest,
+      # it will fail - the REX feature isn't registered on SeedsTest because
+      # DatabaseCleaner truncates the db before every test.
+      # During db:seed, we also want to know the feature is registered before
+      # seeding the template
+      # kudos to dLobatog
+      ForemanRemoteExecution.register_rex_feature
+    end
+    JobTemplate.without_auditing do
+      module_template = JobTemplate.find_by(name: 'Puppet Run Once - SSH Default')
+      if module_template && !Rails.env.test? && Setting[:remote_execution_sync_templates]
+        module_template.sync_feature('puppet_run_host')
+        module_template.organizations << Organization.unscoped.all if module_template.organizations.empty?
+        module_template.locations << Location.unscoped.all if module_template.locations.empty?
+      end
+    end
+  end
+end

data/extra/cockpit/cockpit.conf.example

@@ -0,0 +1,13 @@
+[WebService]
+LoginTitle = Foreman Cockpit
+UrlRoot = /webcon/
+Origins = http://localhost:3000
+
+[Bearer]
+Action = remote-login-ssh
+
+[SSH-Login]
+command = /usr/sbin/foreman-cockpit-session
+
+[OAuth]
+Url = /cockpit/redirect

data/extra/cockpit/foreman-cockpit.service

@@ -0,0 +1,9 @@
+[Service]
+Environment=XDG_CONFIG_DIRS=/etc/foreman/
+Environment=FOREMAN_COCKPIT_SETTINGS=/etc/foreman/cockpit/foreman-cockpit-session.yml
+ExecStart=/usr/libexec/cockpit-ws --no-tls --address 127.0.0.1 --port 9999
+User=foreman
+Group=foreman
+
+[Install]
+WantedBy=multi-user.target

data/lib/foreman_remote_execution/engine.rb

@@ -180,6 +180,8 @@ module ForemanRemoteExecution
       ForemanTasks::Task.send(:include, ForemanRemoteExecution::ForemanTasksTaskExtensions)
       ForemanTasks::Cleaner.send(:include, ForemanRemoteExecution::ForemanTasksCleanerExtensions)
       RemoteExecutionProvider.register(:SSH, SSHExecutionProvider)
+
+      ForemanRemoteExecution.register_rex_feature
     end
 
     initializer 'foreman_remote_execution.register_gettext', after: :load_config_initializers do |_app|
@@ -188,4 +190,13 @@ module ForemanRemoteExecution
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
   end
+
+  def self.register_rex_feature
+    RemoteExecutionFeature.register(
+      :puppet_run_host,
+      N_('Run Puppet Once'),
+      :description => N_('Perform a single Puppet run'),
+      :host_action_button => true
+    )
+  end
 end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.8.2'.freeze
+  VERSION = '1.8.3'.freeze
 end

data/package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "license": "GPL-3.0",
   "scripts": {
-    "lint": "./node_modules/.bin/eslint -c .eslintrc webpack/ script/ || exit 0",
+    "lint": "./node_modules/.bin/eslint -c .eslintrc webpack/ script/",
     "test": "node node_modules/.bin/jest webpack",
     "test:watch": "node node_modules/.bin/jest webpack --watchAll",
     "test:current": "node node_modules/.bin/jest webpack --watch"
@@ -31,13 +31,14 @@
     "url": "http://projects.theforeman.org/projects/foreman_remote_execution/issues"
   },
   "devDependencies": {
+    "@theforeman/vendor-dev": "^0.1.1",
     "babel-eslint": "^8.2.1",
-    "babel-preset-env": "^1.6.0",
-    "babel-preset-react": "^6.24.1",
     "babel-plugin-lodash": "^3.3.2",
-    "babel-plugin-transform-object-assign": "^6.22.0",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "babel-plugin-transform-object-assign": "^6.22.0",
     "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "babel-preset-env": "^1.6.0",
+    "babel-preset-react": "^6.24.1",
     "enzyme": "^3.2.0",
     "enzyme-adapter-react-16": "^1.1.0",
     "enzyme-to-json": "^3.1.2",
@@ -50,13 +51,6 @@
     "jest": "^21.2.1"
   },
   "dependencies": {
-    "babel-polyfill": "^6.26.0",
-    "prop-types": "^15.6.0",
-    "react": "^16.2.0",
-    "react-dom": "^16.2.0",
-    "react-redux": "^5.0.6",
-    "redux": "^3.7.2",
-    "seamless-immutable": "^7.1.3",
-    "urijs": "^1.19.0"
+    "@theforeman/vendor": "^0.1.1"
   }
 }

data/test/factories/foreman_remote_execution_factories.rb

@@ -28,6 +28,10 @@ FactoryBot.define do
     search_query { 'name = foo' }
     targeting_type { 'static_query' }
     user
+
+    trait :with_randomized_ordering do
+      randomized_ordering { true }
+    end
   end
 
   factory :job_invocation do |f|

data/test/unit/job_invocation_test.rb

@@ -1,7 +1,7 @@
 require 'test_plugin_helper'
 
 class JobInvocationTest < ActiveSupport::TestCase
-  let(:job_invocation) { FactoryBot.build(:job_invocation) }
+  let(:job_invocation) { FactoryBot.build(:job_invocation, :description => 'A text with "quotes"') }
   let(:template) { FactoryBot.create(:job_template, :with_input) }
 
   context 'search for job invocations' do
@@ -13,6 +13,11 @@ class JobInvocationTest < ActiveSupport::TestCase
       found_jobs = JobInvocation.search_for(%{job_category = "#{job_invocation.job_category}"}).paginate(:page => 1).with_task.order('job_invocations.id DESC')
       found_jobs.must_equal [job_invocation]
     end
+
+    it 'is able to auto complete description' do
+      expected = 'description =  "A text with \"quotes\""'
+      JobInvocation.complete_for('description = ').must_equal [expected]
+    end
   end
 
   context 'able to be created' do

data/test/unit/targeting_test.rb

@@ -117,4 +117,23 @@ class TargetingTest < ActiveSupport::TestCase
       end
     end
   end
+
+  context 'randomized ordering' do
+    let(:targeting) { FactoryBot.build(:targeting, :with_randomized_ordering) }
+    let(:hosts) { (0..4).map { FactoryBot.create(:host) } }
+
+    it 'loads the hosts in random order' do
+      rng = Random.new(4) # Chosen by a fair dice roll
+      Random.stubs(:new).returns(rng)
+      hosts
+      targeting.search_query = 'name ~ host*'
+      targeting.user = users(:admin)
+      targeting.resolve_hosts!
+      randomized_host_ids = targeting.hosts.map(&:id)
+      host_ids = hosts.map(&:id)
+
+      assert_not_equal host_ids, randomized_host_ids
+      assert_equal host_ids, randomized_host_ids.sort
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2019-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -325,12 +325,16 @@ files:
 - db/migrate/20180202123215_add_feature_id_to_job_invocation.rb
 - db/migrate/20180226095631_change_task_id_to_uuid.rb
 - db/migrate/20180411160809_add_sudo_password_to_job_invocation.rb
+- db/migrate/20180913101042_add_randomized_ordering_to_targeting.rb
 - db/migrate/20190111153330_remove_remote_execution_without_proxy_setting.rb
+- db/seeds.d/100-assign_features_with_templates.rb
 - db/seeds.d/50-notification_blueprints.rb
 - db/seeds.d/60-ssh_proxy_feature.rb
 - db/seeds.d/70-job_templates.rb
 - db/seeds.d/90-bookmarks.rb
+- extra/cockpit/cockpit.conf.example
 - extra/cockpit/foreman-cockpit-session
+- extra/cockpit/foreman-cockpit.service
 - extra/cockpit/settings.yml.example
 - foreman_remote_execution.gemspec
 - lib/foreman_remote_execution.rb
@@ -424,7 +428,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config