foreman_remote_execution 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9caedc0baf4a767d6b0149fd1b349b97081460193cdccad1cb9a3208d278b67f
-  data.tar.gz: 709c83b4582ffd65cab576e84d1b502ce31a70c57f0ce9af76e3ffd9978de031
+  metadata.gz: d00f4722f74258ad947432c2d8104522d3fb53749f7bac4e7c52914862af3ecc
+  data.tar.gz: 187645d51578339523b94fb83fe781cba865477a616c2d8c0980255be1fd0377
 SHA512:
-  metadata.gz: 9ca7d43729ca2e9b8d2012c8f1e9055832ba52a7c7abe8b14c37ad92b73af1a689dd92ec6415e2f4f1532b18a10310caee45c2370579e389914237acb2496cbb
-  data.tar.gz: 687feaca288aec140529e59948290a4e99aae6261567953768340b0b36aa6a8920f9e2640fd0b7a8a02cb22f727b417302569fba4bfda736c0a2a0b6c04b41a1
+  metadata.gz: 04c6a44e96bb03d75310d7dd48acd249503f04778c62f520d1101bf4719d195c2cd4d11e9a6ae63c97e24d8cbd50884dd090ec56a54aff933ee19f3379bbeec1
+  data.tar.gz: 165ba49b54b18ed4128c7b72a53ef52fea60f6f9a619ee7bd0a22545910cf68997b763e27f3569892b20dd528e70236c44b241c1d1b6c5fcec15a5a21f76af7e

data/.eslintrc

@@ -1,32 +1,7 @@
 {
-  "root": true,
-  "extends": ["airbnb-base", "./node_modules/@theforeman/vendor-dev/eslint.extends.js"],
-  "plugins": [
-    "react"
-  ],
-  "env": {
-    "browser": true,
-    "es6": true,
-    "node": true,
-    "jasmine": true,
-    "jest": true
-  },
-  "parser": "babel-eslint",
-  "rules": {
-    "react/jsx-uses-vars": "error",
-    "react/jsx-uses-react": "error",
-    "no-unused-vars": [
-      "error",
-      {
-        "vars": "all",
-        "args": "none"
-      }
-    ],
-    "no-underscore-dangle": "off",
-    "no-use-before-define": "off",
-    "import/prefer-default-export": "off",
-    // Import rules off for now due to HoundCI issue
-    "import/no-unresolved": "off",
-    "import/extensions": "off"
-  }
+  "plugins": ["@theforeman/foreman"],
+  "extends": [
+    "plugin:@theforeman/foreman/core",
+    "plugin:@theforeman/foreman/plugins"
+  ]
 }

data/.gitignore

@@ -14,3 +14,4 @@ locale/*/*.po.time_stamp
 Gemfile.lock
 node_modules/
 package-lock.json
+coverage/

data/.hound.yml

@@ -11,9 +11,4 @@ rubocop:
 jshint:
   enabled: false
 
-eslint:
-  enabled: true
-  config_file: .eslintrc
-  ignore_file: .eslintignore
-
 fail_on_violations: true

data/.travis.yml

@@ -1,6 +1,5 @@
 language: node_js
 node_js:
-  - '6.10' # current EPEL 7
-  - '6' # previous LTS
-  - '8' # current LTS
+  - '10'
+  - '12'
 script: ./scripts/travis_run_js_tests.sh

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

@@ -29,6 +29,9 @@ module Actions
 
         raise _('Could not use any template used in the job invocation') if template_invocation.blank?
 
+        provider = template_invocation.template.provider
+        proxy_selector = provider.required_proxy_selector_for(template_invocation.template) || proxy_selector
+
         provider_type = template_invocation.template.provider_type.to_s
         proxy = determine_proxy!(proxy_selector, provider_type, host)
 
@@ -36,8 +39,6 @@ module Actions
         script = renderer.render
         raise _('Failed rendering template: %s') % renderer.error_message unless script
 
-        provider = template_invocation.template.provider
-
         additional_options = { :hostname => provider.find_ip_or_hostname(host),
                                :script => script,
                                :execution_timeout_interval => job_invocation.execution_timeout_interval,

data/app/models/concerns/foreman_remote_execution/orchestration/ssh.rb

@@ -13,6 +13,9 @@ module ForemanRemoteExecution
       proxy = ::SmartProxy.find(proxy_id)
       begin
         proxy.drop_host_from_known_hosts(target)
+      rescue RestClient::ResourceNotFound => e
+        # ignore 404 when known_hosts entry is missing or the module was not enabled
+        Foreman::Logging.exception "Proxy failed to delete SSH known_hosts for #{name}, #{ip}", e, :level => :error
       rescue => e
         Rails.logger.warn e.message
         return false

data/app/models/remote_execution_provider.rb

@@ -98,5 +98,10 @@ class RemoteExecutionProvider
     def proxy_action_class
       ForemanRemoteExecutionCore::Actions::RunScript
     end
+
+    # Return a specific proxy selector to use for running a given template
+    # Returns either nil to use the default selector or an instance of a (sub)class of ::ForemanTasks::ProxySelector
+    def required_proxy_selector_for(_template)
+    end
   end
 end

data/app/services/default_proxy_proxy_selector.rb

@@ -0,0 +1,18 @@
+class DefaultProxyProxySelector < ::RemoteExecutionProxySelector
+  def initialize
+    # TODO: Remove this once we have a reliable way of determining the internal proxy without katello
+    # Tracked as https://projects.theforeman.org/issues/29840
+    raise _('Internal proxy selector can only be used if Katello is enabled') unless defined?(::Katello)
+
+    super
+  end
+
+  def available_proxies(host, provider)
+    # TODO: Once we have a internal proxy marker/feature on the proxy, we can
+    # swap the implementation
+    internal_proxy = ::Katello.default_capsule
+    super.reduce({}) do |acc, (key, proxies)|
+      acc.merge(key => proxies.select { |proxy| proxy == internal_proxy })
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ 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]
-      template = JobTemplate.import_raw!(File.read(template), :default => true, :locked => true, :update => sync)
+      template = JobTemplate.import_raw!(File.read(template), :default => true, :lock => true, :update => sync)
       template.organizations = organizations if template.present?
       template.locations = locations if template.present?
     end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '3.2.1'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/package.json

@@ -3,25 +3,14 @@
   "version": "1.0.0",
   "license": "GPL-3.0",
   "scripts": {
-    "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"
-  },
-  "jest": {
-    "verbose": true,
-    "moduleDirectories": [
-      "node_modules",
-      "webpack"
-    ],
-    "setupFiles": [
-      "raf/polyfill",
-      "./webpack/test_setup.js"
-    ],
-    "testPathIgnorePatterns": [
-      "/node_modules/",
-      "<rootDir>/foreman/"
-    ]
+    "lint": "tfm-lint --plugin -d /webpack",
+    "test": "tfm-test --plugin",
+    "test:watch": "tfm-test --plugin --watchAll",
+    "test:current": "tfm-test --plugin --watch",
+    "publish-coverage": "tfm-publish-coverage",
+    "stories": "tfm-stories --plugin",
+    "stories:build": "tfm-build-stories --plugin",
+    "stories:deploy": "surge --project .storybook-dist"
   },
   "repository": {
     "type": "git",
@@ -32,22 +21,16 @@
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": "^4.0.2",
-    "@theforeman/vendor-dev": "^4.0.2",
+    "@theforeman/builder": "^4.2.1",
+    "@theforeman/eslint-plugin-foreman": "^4.2.1",
+    "@theforeman/stories": "^4.2.1",
+    "@theforeman/test": "^4.2.1",
+    "@theforeman/vendor-dev": "^4.2.1",
     "babel-eslint": "^10.0.0",
-    "babel-jest": "^24.9.0",
-    "enzyme": "^3.2.0",
-    "enzyme-adapter-react-16": "^1.1.0",
-    "enzyme-to-json": "^3.1.2",
-    "eslint": "^4.10.0",
-    "eslint-config-airbnb": "^16.0.0",
-    "eslint-plugin-import": "^2.8.0",
-    "eslint-plugin-jest": "^21.2.0",
-    "eslint-plugin-jsx-a11y": "^6.0.2",
-    "eslint-plugin-react": "^7.4.0",
-    "jest": "^24.9.0"
+    "eslint": "^6.8.0",
+    "prettier": "^1.19.1"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 4.0.2"
+    "@theforeman/vendor": ">= 4.2.1"
   }
 }

data/webpack/index.js

@@ -1,6 +1,5 @@
-import URI from 'urijs';
 // eslint-disable-next-line import/no-extraneous-dependencies
-import { mount, registerReducer } from 'foremanReact/common/MountingService';
+import { registerReducer } from 'foremanReact/common/MountingService';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import componentRegistry from 'foremanReact/components/componentRegistry';
 import JobInvocationContainer from './react_app/components/jobInvocations';

data/webpack/react_app/components/jobInvocations/AggregateStatus/index.js

@@ -1,4 +1,5 @@
 import React from 'react';
+import PropTypes from 'prop-types';
 
 const AggregateStatus = ({ statuses }) => (
   <div id="aggregate_statuses">
@@ -31,4 +32,13 @@ const AggregateStatus = ({ statuses }) => (
   </div>
 );
 
+AggregateStatus.propTypes = {
+  statuses: PropTypes.shape({
+    cancelled: PropTypes.number,
+    failed: PropTypes.number,
+    pending: PropTypes.number,
+    success: PropTypes.number,
+  }).isRequired,
+};
+
 export default AggregateStatus;

data/webpack/react_app/components/jobInvocations/AggregateStatus/index.test.js

@@ -1,6 +1,6 @@
 import React from 'react';
-import { shallow } from 'enzyme';
-import AggregateStatus from './index.js';
+import { shallow } from '@theforeman/test';
+import AggregateStatus from './index';
 
 jest.unmock('./index.js');
 
@@ -20,7 +20,10 @@ describe('AggregateStatus', () => {
 
     it('renders cards with props passed', () => {
       const statuses = {
-        success: 19, failed: 20, cancelled: 31, pending: 3,
+        success: 19,
+        failed: 20,
+        cancelled: 31,
+        pending: 3,
       };
       const chartNumbers = shallow(<AggregateStatus statuses={statuses} />);
       const success = chartNumbers.find('#success_count').text();

data/webpack/react_app/components/jobInvocations/index.js

@@ -4,14 +4,18 @@ import Immutable from 'seamless-immutable';
 import PropTypes from 'prop-types';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import DonutChart from 'foremanReact/components/common/charts/DonutChart';
-import AggregateStatus from './AggregateStatus/index.js';
+import AggregateStatus from './AggregateStatus';
 import * as JobInvocationActions from '../../redux/actions/jobInvocations';
 
-const colIndexOfMaxValue = columns => columns.reduce((iMax, x, i, arr) => (x[1] > arr[iMax][1] ? i : iMax), 0);
+const colIndexOfMaxValue = columns =>
+  columns.reduce((iMax, x, i, arr) => (x[1] > arr[iMax][1] ? i : iMax), 0);
 
 class JobInvocationContainer extends React.Component {
   componentDidMount() {
-    const { startJobInvocationsPolling, data: { url } } = this.props;
+    const {
+      startJobInvocationsPolling,
+      data: { url },
+    } = this.props;
 
     startJobInvocationsPolling(url);
   }
@@ -22,15 +26,20 @@ class JobInvocationContainer extends React.Component {
 
     return (
       <div id="job_invocations_chart_container">
-        <DonutChart data={Immutable.asMutable(jobInvocations)}
-                    title={{type: 'percent', secondary: (jobInvocations[iMax] || [])[0]}}/>
+        <DonutChart
+          data={Immutable.asMutable(jobInvocations)}
+          title={{
+            type: 'percent',
+            secondary: (jobInvocations[iMax] || [])[0],
+          }}
+        />
         <AggregateStatus statuses={statuses} />
       </div>
     );
   }
 }
 
-const mapStateToProps = (state) => {
+const mapStateToProps = state => {
   const {
     jobInvocations,
     statuses,
@@ -62,4 +71,7 @@ JobInvocationContainer.defaultProps = {
   jobInvocations: [['property', 3, 'color']],
   statuses: {},
 };
-export default connect(mapStateToProps, JobInvocationActions)(JobInvocationContainer);
+export default connect(
+  mapStateToProps,
+  JobInvocationActions
+)(JobInvocationContainer);

data/webpack/react_app/redux/actions/jobInvocations/index.js

@@ -8,10 +8,10 @@ import {
 } from '../../consts';
 
 const defaultJobInvocationsPollingInterval = 1000;
-const jobInvocationsInterval = process.env.JOB_INVOCATIONS_POLLING ||
-  defaultJobInvocationsPollingInterval;
+const jobInvocationsInterval =
+  process.env.JOB_INVOCATIONS_POLLING || defaultJobInvocationsPollingInterval;
 
-const getJobInvocations = url => (dispatch, getState) => {
+const getJobInvocations = url => async (dispatch, getState) => {
   function onGetJobInvocationsSuccess({ data }) {
     // If the job has finished, stop polling
     if (data.finished) {
@@ -41,7 +41,7 @@ const getJobInvocations = url => (dispatch, getState) => {
     if (jobInvocationsInterval) {
       setTimeout(
         () => dispatch(getJobInvocations(url)),
-        jobInvocationsInterval,
+        jobInvocationsInterval
       );
     }
   }
@@ -52,10 +52,14 @@ const getJobInvocations = url => (dispatch, getState) => {
 
   if (getState().foremanRemoteExecutionReducers.jobInvocations.isPolling) {
     if (isDocumentVisible) {
-      API.get(url)
-        .then(onGetJobInvocationsSuccess)
-        .catch(onGetJobInvocationsFailed)
-        .then(triggerPolling);
+      try {
+        const data = await API.get(url);
+        onGetJobInvocationsSuccess(data);
+      } catch (error) {
+        onGetJobInvocationsFailed(error);
+      } finally {
+        triggerPolling();
+      }
     } else {
       // document is not visible, keep polling without api call
       triggerPolling();

data/webpack/react_app/redux/consts.js

@@ -2,5 +2,4 @@ export const JOB_INVOCATIONS_POLLING_STARTED =
   'JOB_INVOCATIONS_POLLING_STARTED';
 export const JOB_INVOCATIONS_GET_JOB_INVOCATIONS =
   'JOB_INVOCATIONS_GET_JOB_INVOCATIONS';
-export const JOB_INVOCATIONS_JOB_FINISHED =
-  'JOB_INVOCATIONS_JOB_FINISHED';
+export const JOB_INVOCATIONS_JOB_FINISHED = 'JOB_INVOCATIONS_JOB_FINISHED';

data/webpack/react_app/redux/reducers/jobInvocations/index.fixtures.js

@@ -15,26 +15,10 @@ export const pollingStarted = Immutable({
 export const jobInvocationsPayload = Immutable({
   jobInvocations: {
     job_invocations: [
-      [
-        'Success',
-        100,
-        '#B7312D',
-      ],
-      [
-        'Failed',
-        20,
-        '#B7312D',
-      ],
-      [
-        'Pending',
-        40,
-        '#B7312D',
-      ],
-      [
-        'Cancelled',
-        0,
-        '#B7312D',
-      ],
+      ['Success', 100, '#B7312D'],
+      ['Failed', 20, '#B7312D'],
+      ['Pending', 40, '#B7312D'],
+      ['Cancelled', 0, '#B7312D'],
     ],
     statuses: {
       cancelled: 0,
@@ -48,26 +32,10 @@ export const jobInvocationsPayload = Immutable({
 export const jobInvocationsReceived = Immutable({
   isPolling: true,
   jobInvocations: [
-    [
-      'Success',
-      100,
-      '#B7312D',
-    ],
-    [
-      'Failed',
-      20,
-      '#B7312D',
-    ],
-    [
-      'Pending',
-      40,
-      '#B7312D',
-    ],
-    [
-      'Cancelled',
-      0,
-      '#B7312D',
-    ],
+    ['Success', 100, '#B7312D'],
+    ['Failed', 20, '#B7312D'],
+    ['Pending', 40, '#B7312D'],
+    ['Cancelled', 0, '#B7312D'],
   ],
   statuses: {
     cancelled: 0,

data/webpack/react_app/redux/reducers/jobInvocations/index.test.js

@@ -18,20 +18,26 @@ describe('job invocations chart reducer', () => {
     expect(reducer(undefined, {})).toEqual(initialState);
   });
   it('should start polling given POLLING_STARTED', () => {
-    expect(reducer(initialState, {
-      type: JOB_INVOCATIONS_POLLING_STARTED,
-    })).toEqual(pollingStarted);
+    expect(
+      reducer(initialState, {
+        type: JOB_INVOCATIONS_POLLING_STARTED,
+      })
+    ).toEqual(pollingStarted);
   });
   it('should stop polling given JOB_FINISHED', () => {
-    expect(reducer(pollingStarted, {
-      type: JOB_INVOCATIONS_JOB_FINISHED,
-      payload: { jobInvocations: { job_invocations: [], statuses: {} } },
-    })).toEqual(initialState);
+    expect(
+      reducer(pollingStarted, {
+        type: JOB_INVOCATIONS_JOB_FINISHED,
+        payload: { jobInvocations: { job_invocations: [], statuses: {} } },
+      })
+    ).toEqual(initialState);
   });
   it('should receive job invocations given GET_JOB_INVOCATIONS', () => {
-    expect(reducer(pollingStarted, {
-      type: JOB_INVOCATIONS_GET_JOB_INVOCATIONS,
-      payload: jobInvocationsPayload,
-    })).toEqual(jobInvocationsReceived);
+    expect(
+      reducer(pollingStarted, {
+        type: JOB_INVOCATIONS_GET_JOB_INVOCATIONS,
+        payload: jobInvocationsPayload,
+      })
+    ).toEqual(jobInvocationsReceived);
   });
 });

data/webpack/test_setup.js

@@ -1,7 +1,8 @@
 import 'core-js/shim';
 import 'regenerator-runtime/runtime';
 
-import { configure } from 'enzyme';
+import { configure } from '@theforeman/test';
+// eslint-disable-next-line import/no-extraneous-dependencies
 import Adapter from 'enzyme-adapter-react-16';
 
 configure({ adapter: new Adapter() });

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -205,6 +205,7 @@ files:
 - app/models/template_invocation_input_value.rb
 - app/overrides/execution_interface.rb
 - app/overrides/subnet_proxies.rb
+- app/services/default_proxy_proxy_selector.rb
 - app/services/remote_execution_proxy_selector.rb
 - app/services/ui_notifications/remote_execution_jobs/base_job_finish.rb
 - app/views/api/v2/foreign_input_sets/base.json.rabl
@@ -426,7 +427,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config