foreman_templates 7.0.7 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9583ee6b0f88f013c5a26f23dd90a22cf7bdcdeebbb8052c3fdffaf11960fb3d
-  data.tar.gz: 5b54607bfe06ca7cdd359d371afbb497e343310ae48d29c2f359bb4d43a6a38d
+  metadata.gz: b0dbc6a618a7c30af0547757f78e6548ae69c5b61112d14ae51dcdad8195d3ae
+  data.tar.gz: 8660614fbc2a7ba17f5f778bf9e6f65a2f3ce5fe3a01bbb83212762d6c07afa3
 SHA512:
-  metadata.gz: d6826d8bdd2c9bbc47d09cfe8a9cfeddb169a6aa65933fd670144921091267d20814b5cf4cf37e93629a81fa2b1b81120ce796dd53194d4740b02b7e10c04720
-  data.tar.gz: 2e019ce44797e7c28648f8b8913d224441a514fad0e75c977502c1c79c4bab09dbcb4b538a584c28fc8049c60df5ff3c270dfe2de2df97564c5a5af3125ebce5
+  metadata.gz: d1f7dabefd106226e7a11fa7bcf0d7314945c7955b50476c466d7cd21fdb5d562f2b4eff1977cb418d0f0e2a86c10889a4c2df81aedd8919b948558ad080aef1
+  data.tar.gz: 0bdb20444ed985d3862de5785d14a542cd294fe2365d137f9c4030be725db6642aee70f4e0c60df091bcb37599a2c956bf828e85f431994d4169c37d9a325729

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

@@ -3,6 +3,10 @@ module Api
     class TemplateController < ::Api::V2::BaseController
       include ::Foreman::Controller::Parameters::TemplateParams
 
+      resource_description do
+        resource_id 'templates'
+      end
+
       def_param_group :foreman_template_sync_params do
         param :branch, String, :required => false, :desc => N_("Branch in Git repo.")
         param :repo, String, :required => false, :desc => N_("Override the default repo from settings.")
@@ -15,7 +19,7 @@ module Api
       param :prefix, String, :required => false, :desc => N_("The string all imported templates should begin with.")
       param :associate, Setting::TemplateSync.associate_types.keys, :required => false, :desc => N_("Associate to OS's, Locations & Organizations. Options are: always, new or never.")
       param :force, :bool, :required => false, :desc => N_("Update templates that are locked")
-      param :lock, :bool, :required => false, :desc => N_("Lock imported templates")
+      param :lock, Setting::TemplateSync.lock_types.keys + ["true", "false", "0", "1"], :required => false, :desc => N_("Lock imported templates")
       param :verbose, :bool, :required => false, :desc => N_("Show template diff in response")
       param_group :foreman_template_sync_params
       param_group :taxonomies, ::Api::V2::BaseController
@@ -29,6 +33,7 @@ module Api
 
       api :POST, "/templates/export", N_("Initiate Export")
       param :metadata_export_mode, Setting::TemplateSync.metadata_export_mode_types.keys, :required => false, :desc => N_("Specify how to handle metadata")
+      param :commit_msg, String, :desc => N_("Custom commit message for templates export")
       param_group :foreman_template_sync_params
       param_group :taxonomies, ::Api::V2::BaseController
       def export

data/app/controllers/concerns/foreman/controller/parameters/template_params.rb

@@ -15,7 +15,7 @@ module Foreman
           end
 
           def extra_export_params
-            [:metadata_export_mode]
+            %i(metadata_export_mode commit_msg)
           end
 
           def template_params_filter(extra_params = [])
@@ -34,7 +34,27 @@ module Foreman
         end
 
         def template_import_params
-          add_taxonomy_params(base_import_params(:none))
+          transform_lock_param add_taxonomy_params(base_import_params(:none))
+        end
+
+        def transform_lock_param(params)
+          lock = params[:lock]
+          return params if lock.nil?
+
+          if lock == "true" || lock.is_a?(TrueClass) || lock.to_s == "1"
+            log_deprecated_param(lock)
+            params[:lock] = "lock"
+          end
+
+          if lock == "false" || lock.is_a?(FalseClass) || lock.to_s == "0"
+            log_deprecated_param(lock)
+            params[:lock] = "unlock"
+          end
+          params
+        end
+
+        def log_deprecated_param(value)
+          Logging.logger('app').warn "Using '#{value}' as a value for lock when syncing templates is deprecated and will be removed in the future."
         end
 
         def template_export_params

data/app/models/setting/template_sync.rb

@@ -11,7 +11,7 @@ class Setting
     end
 
     def self.export_stripped_names
-      %w(metadata_export_mode)
+      %w(metadata_export_mode commit_msg)
     end
 
     def self.import_setting_names(except = [])
@@ -38,6 +38,15 @@ class Setting
       }
     end
 
+    def self.lock_types
+      {
+        'lock' => _('Lock'),
+        'keep_lock_new' => _('Keep, lock new'),
+        'keep' => _('Keep, do not lock new'),
+        'unlock' => _('Unlock')
+      }
+    end
+
     def self.metadata_export_mode_types
       {
         'refresh' => _('Refresh'),
@@ -75,7 +84,8 @@ class Setting
           self.set('template_sync_branch', N_('Default branch in Git repo'), '', N_('Branch')),
           self.set('template_sync_metadata_export_mode', N_('Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata'), 'refresh', N_('Metadata export mode'), nil, { :collection => Proc.new { self.metadata_export_mode_types } }),
           self.set('template_sync_force', N_('Should importing overwrite locked templates?'), false, N_('Force import')),
-          self.set('template_sync_lock', N_('Should importing lock templates?'), false, N_('Lock templates')),
+          self.set('template_sync_lock', N_('How to handle lock for imported templates?'), 'keep', N_('Lock templates'), nil, { :collection => Proc.new { self.lock_types } }),
+          self.set('template_sync_commit_msg', N_('Custom commit message for templates export'), 'Templates export made by a Foreman user', N_('Commit message'))
         ].compact.each { |s| self.create! s.update(:category => "Setting::TemplateSync") }
       end
 

data/app/services/foreman_templates/template_exporter.rb

@@ -1,7 +1,7 @@
 module ForemanTemplates
   class TemplateExporter < Action
     def self.setting_overrides
-      super + %i(metadata_export_mode)
+      super + %i(metadata_export_mode commit_msg)
     end
 
     def initialize(args = {})
@@ -42,7 +42,7 @@ module ForemanTemplates
         new_repo = true
       end
       if new_repo || status.added.any? || status.changed.any? || status.deleted.any? || status.untracked.any?
-        git_repo.commit "Templates export made by Foreman user #{foreman_git_user}"
+        git_repo.commit commit_msg
         git_repo.push 'origin', branch
       else
         @warning = 'No change detected, skipping the commit and push'

data/app/services/foreman_templates/template_importer.rb

@@ -10,7 +10,6 @@ module ForemanTemplates
       super args
       @verbose = parse_bool(@verbose)
       @force = parse_bool(@force)
-      @lock = parse_bool(@lock)
       @result_lines = []
     end
 
@@ -79,11 +78,28 @@ module ForemanTemplates
     end
 
     def import_options
-      { :force => @force,
+      lock_predicate = lambda do |template|
+        case @lock
+        when 'lock'
+          return true
+        when 'unlock'
+          return false
+        when 'keep'
+          return template.new_record? ? false : template.locked
+        when 'keep_lock_new'
+          return template.new_record? ? true : template.locked
+        else
+          raise ::Foreman::Exception.new("Unknown lock option type, expected one of #{::Setting::TemplateSync.lock_types.keys}, got #{@lock}")
+        end
+      end
+
+      {
+        :force => @force,
         :associate => @associate,
-        :lock => @lock,
+        :lock => lock_predicate,
         :organization_params => @taxonomies[:organizations],
-        :location_params => @taxonomies[:locations] }
+        :location_params => @taxonomies[:locations]
+      }
     end
 
     def template_model(metadata, parse_result)

data/app/views/template_syncs/index.html.erb

@@ -1,9 +1,5 @@
-<% content_for(:javascripts) do %>
-  <%= webpacked_plugins_js_for :foreman_templates %>
-<% end %>
-<% content_for(:stylesheets) do %>
-  <%= webpacked_plugins_css_for :foreman_templates %>
-<% end %>
+<%= webpacked_plugins_js_for :foreman_templates %>
+<%= webpacked_plugins_css_for :foreman_templates %>
 
 <div id="foreman-templates"/>
 

data/db/migrate/20180627134929_change_lock_setting.rb

@@ -0,0 +1,5 @@
+class ChangeLockSetting < ActiveRecord::Migration[5.1]
+  def up
+    Setting.find_by(:name => 'template_sync_lock')&.destroy
+  end
+end

data/lib/foreman_templates/engine.rb

@@ -20,6 +20,12 @@ module ForemanTemplates
       end
     end
 
+    initializer "foreman_templates.load_app_instance_data" do |app|
+      ForemanTemplates::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
     initializer 'foreman_templates.register_plugin', :before => :finisher_hook do
       Foreman::Plugin.register :foreman_templates do
         requires_foreman '>= 1.24'

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '7.0.7'.freeze
+  VERSION = '8.0.0'.freeze
 end

data/package.json

@@ -20,33 +20,24 @@
     "url": "https://projects.theforeman.org"
   },
   "homepage": "https://github.com/theforeman/foreman_templates",
-  "dependencies": {
-    "@theforeman/vendor": "^1.7.0"
+  "peerDependencies": {
+    "@theforeman/vendor": ">= 3.3.2"
   },
   "devDependencies": {
-    "@theforeman/vendor-dev": "^1.7.0",
-    "babel-cli": "^6.10.1",
-    "babel-core": "^6.26.3",
-    "babel-eslint": "^8.2.1",
-    "babel-loader": "^7.1.1",
-    "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",
+    "@babel/core": "^7.7.0",
+    "@theforeman/env": "^3.3.2",
+    "@theforeman/builder": "^4.0.2",
+    "@theforeman/vendor-dev": "^3.3.2",
+    "babel-eslint": "^10.0.0",
+    "babel-jest": "^24.9.0",
     "enzyme": "^3.7.0",
     "enzyme-adapter-react-16": "^1.7.0",
     "enzyme-to-json": "^3.3.5",
-    "eslint": "^4.18.1",
-    "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-patternfly-react": "^0.2.1",
-    "eslint-plugin-react": "^7.4.0",
+    "eslint": "^6.8.0",
+    "eslint-plugin-patternfly-react": "^0.3.0",
     "identity-obj-proxy": "^3.0.0",
-    "jest": "^23.6.0",
-    "prettier": "^1.16.4",
+    "jest": "^24.9.0",
+    "prettier": "^1.19.1",
     "react-redux-test-utils": "^0.1.1"
   },
   "jest": {
@@ -56,6 +47,9 @@
       "node_modules",
       "webpack"
     ],
+    "transform": {
+      "^.+\\.js$": "babel-jest"
+    },
     "setupFiles": [
       "raf/polyfill",
       "./webpack/testSetup.js"

data/webpack/__mocks__/foremanReact/components/common/forms/ForemanForm.js

@@ -0,0 +1,2 @@
+const ForemanForm = () => jest.fn();
+export default ForemanForm;

data/webpack/components/NewTemplateSync/__fixtures__/templateSyncSettings.fixtures.js

@@ -1,5 +1,7 @@
 import Immutable from 'seamless-immutable';
 
+import { transformInitialValues } from '../components/NewTemplateSyncForm/NewTemplateSyncFormSelectors';
+
 export const associateSetting = Immutable({
   id: 45,
   value: 'new',
@@ -65,10 +67,8 @@ export const registeredExportSettings = {
 };
 
 export const initialValues = {
-  initial: importSettings.concat(exportSettings).reduce((memo, item) => {
-    memo[item.name] = item.value;
-    return memo;
-  }, {}),
+  import: transformInitialValues(importSettings),
+  export: transformInitialValues(exportSettings),
 };
 
 export const stateFactory = obj => ({

data/webpack/components/NewTemplateSync/__tests__/__snapshots__/NewTemplateSync.test.js.snap

@@ -12,7 +12,7 @@ exports[`NewTemplateSync should render when loaded 1`] = `
     header="Import or Export Templates"
     searchable={false}
   >
-    <Connect(ReduxForm)
+    <Connect(NewTemplateSyncForm)
       history={Object {}}
       userPermissions={
         Object {
@@ -38,7 +38,7 @@ exports[`NewTemplateSync should render when loading 1`] = `
     header="Import or Export Templates"
     searchable={false}
   >
-    <Connect(ReduxForm)
+    <Connect(NewTemplateSyncForm)
       history={Object {}}
       userPermissions={
         Object {

data/webpack/components/NewTemplateSync/components/NewTemplateSyncForm/NewTemplateSyncForm.js

@@ -1,58 +1,53 @@
 import React from 'react';
-import { change } from 'redux-form';
 import PropTypes from 'prop-types';
 
-import Form from 'foremanReact/components/common/forms/Form';
-
+import ForemanForm from 'foremanReact/components/common/forms/ForemanForm';
+import * as Yup from 'yup';
 import SyncSettingsFields from '../SyncSettingFields';
 import SyncTypeRadios from '../SyncTypeRadios';
-import { NEW_TEMPLATE_SYNC_FORM_NAME } from './NewTemplateSyncFormConstants';
 
-const addTaxParams = key => (params, currentTax) => {
-  if (currentTax.id) {
-    params[key] = [currentTax.id];
+const redirectToResult = history => () =>
+  history.push({ pathname: '/template_syncs/result' });
+
+const repoFormat = formatAry => value => {
+  if (value === undefined) {
+    return true;
   }
-  return params;
+
+  const valid = formatAry
+    .map(item => value.startsWith(item))
+    .reduce((memo, item) => item || memo, false);
+
+  return value && valid;
 };
 
-const addOrgParams = addTaxParams('organization_ids');
-const addLocParams = addTaxParams('location_ids');
-
-const submit = syncType => (formValues, dispatch, props) => {
-  const {
-    submitForm,
-    importUrl,
-    exportUrl,
-    history,
-    currentFields,
-    currentLocation,
-    currentOrganization,
-  } = props;
-  const url = syncType === 'import' ? importUrl : exportUrl;
-  const currentFieldNames = Object.keys(currentFields);
-  const postValues = Object.keys(formValues).reduce((memo, key) => {
-    if (currentFieldNames.includes(key)) {
-      memo[key] = formValues[key];
-    }
-    return memo;
-  }, {});
-
-  return submitForm({
-    url,
-    values: addOrgParams(
-      addLocParams(postValues, currentLocation),
-      currentOrganization
-    ),
-    message: `Templates were ${syncType}ed.`,
-    item: 'TemplateSync',
-  }).then(args => {
-    history.replace({ pathname: '/template_syncs/result' });
+const syncFormSchema = (syncType, settingsObj, validationData) => {
+  const schema = (settingsObj[syncType].asMutable() || []).reduce(
+    (memo, setting) => {
+      if (setting.name === 'repo') {
+        return {
+          ...memo,
+          repo: Yup.string()
+            .test(
+              'repo-format',
+              `Invalid repo format, must start with one of: ${validationData.repo.join(
+                ', '
+              )}`,
+              repoFormat(validationData.repo)
+            )
+            .required("can't be blank"),
+        };
+      }
+      return memo;
+    },
+    {}
+  );
+
+  return Yup.object().shape({
+    [syncType]: Yup.object().shape(schema),
   });
 };
 
-const redirectToResult = history => () =>
-  history.push({ pathname: '/template_syncs/result' });
-
 class NewTemplateSyncForm extends React.Component {
   allowedSyncType = (userPermissions, radioAttrs) =>
     this.props.userPermissions[radioAttrs.permission];
@@ -92,50 +87,54 @@ class NewTemplateSyncForm extends React.Component {
 
   render() {
     const {
-      submitting,
       error,
-      handleSubmit,
+      submitForm,
       importSettings,
       exportSettings,
-      dispatch,
       history,
       validationData,
-      valid,
+      importUrl,
+      exportUrl,
+      initialValues,
     } = this.props;
 
-    const resetToDefault = ((dispatchFn, changeFn, nameOfForm) => (
-      fieldName,
-      value
-    ) => {
-      dispatchFn(changeFn(nameOfForm, fieldName, value));
-    })(dispatch, change, NEW_TEMPLATE_SYNC_FORM_NAME);
+    const resetToDefault = (fieldName, fieldValue) => resetFn =>
+      resetFn(fieldName, fieldValue);
 
     return (
-      <Form
-        onSubmit={handleSubmit(submit(this.state.syncType))}
-        disabled={submitting || (!valid && !error)}
-        submitting={submitting}
-        error={error}
+      <ForemanForm
+        onSubmit={(values, actions) => {
+          const url = this.state.syncType === 'import' ? importUrl : exportUrl;
+          return submitForm({
+            url,
+            values: values[this.state.syncType],
+            message: `Templates were ${this.state.syncType}ed.`,
+            item: 'TemplateSync',
+          }).then(args => {
+            history.replace({ pathname: '/template_syncs/result' });
+          });
+        }}
+        initialValues={initialValues}
+        validationSchema={syncFormSchema(
+          this.state.syncType,
+          { import: importSettings, export: exportSettings },
+          validationData
+        )}
         onCancel={redirectToResult(history)}
-        errorTitle={
-          error && error.severity === 'danger' ? __('Error! ') : __('Warning! ')
-        }
+        error={error}
       >
         <SyncTypeRadios
           name="syncType"
           controlLabel="Action type"
           radios={this.initRadioButtons(this.state.syncType)}
-          disabled={submitting}
         />
         <SyncSettingsFields
           importSettings={importSettings}
           exportSettings={exportSettings}
           syncType={this.state.syncType}
           resetField={resetToDefault}
-          disabled={submitting}
-          validationData={validationData}
         />
-      </Form>
+      </ForemanForm>
     );
   }
 }
@@ -144,13 +143,13 @@ NewTemplateSyncForm.propTypes = {
   importSettings: PropTypes.array,
   exportSettings: PropTypes.array,
   userPermissions: PropTypes.object.isRequired,
-  submitting: PropTypes.bool,
   error: PropTypes.object,
-  handleSubmit: PropTypes.func.isRequired,
-  dispatch: PropTypes.func,
   history: PropTypes.object,
   validationData: PropTypes.object,
-  valid: PropTypes.bool.isRequired,
+  initialValues: PropTypes.object.isRequired,
+  exportUrl: PropTypes.string.isRequired,
+  importUrl: PropTypes.string.isRequired,
+  submitForm: PropTypes.func.isRequired,
 };
 
 NewTemplateSyncForm.defaultProps = {
@@ -158,8 +157,6 @@ NewTemplateSyncForm.defaultProps = {
   exportSettings: [],
   validationData: {},
   error: undefined,
-  dispatch: () => {},
-  submitting: false,
   history: {},
 };