foreman_templates 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a8db347037219c9d8b4c09906b703e7c9370a1c5fd9775ce7d2261f82f690f
-  data.tar.gz: 5bea2c74fb7d677dca8d203607ef51ade2de42e26b8e458c739e80240c3cd7bf
+  metadata.gz: bda8e472a4ae76b0f1480738e9059423a249c4156842deebc385baa2f3c2a5ca
+  data.tar.gz: bb04b38ce6791e62f90fcea5a177d38ca62402e6c3037e7f3ed85c416f91696c
 SHA512:
-  metadata.gz: 40eab594f513b94c2deec58e35c4f03030379598db6a482bc201838b227bcfafd6f85e5c16eefab830da3d4950109b09d67a9a9032971a7059a1fcb87f3b0fee
-  data.tar.gz: 4ca1502b153c698da0461087a1e8976ac1429def1d5532012639abf5724a6c010682161b0c1d8606f6d21eebd9df997dc0e1288abc4f3638f60edbd37124666b
+  metadata.gz: 3c35d3ca52df290a50a3e1788ea654a0588067ab02278a5b77829bfaec46d8c855ae36f554a608eaf8e9c5797b650d5be1a95ed4e7f8486c905e601068180fc5
+  data.tar.gz: b58a200b8374f22481e1397949cc4126315234b6238ce08895acedb628c826515ce9ab514b85942b8388350f0e8939b0d088ccc6641fc4b3b84a1fc65ef16961

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

@@ -17,9 +17,9 @@ module Api
 
       api :POST, "/templates/import/", N_("Initiate Import")
       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 :associate, ForemanTemplates.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, Setting::TemplateSync.lock_types.keys + ["true", "false", "0", "1"], :required => false, :desc => N_("Lock imported templates")
+      param :lock, ForemanTemplates.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
@@ -32,7 +32,7 @@ module Api
       end
 
       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 :metadata_export_mode, ForemanTemplates.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

data/app/controllers/ui_template_syncs_controller.rb

@@ -8,8 +8,8 @@ class UiTemplateSyncsController < ApplicationController
   end
 
   def sync_settings
-    import_settings = Setting.where :name => Setting::TemplateSync.import_setting_names(['verbose'])
-    export_settings = Setting.where :name => Setting::TemplateSync.export_setting_names(['verbose'])
+    import_settings = setting_definitions(ForemanTemplates::IMPORT_SETTING_NAMES)
+    export_settings = setting_definitions(ForemanTemplates::EXPORT_SETTING_NAMES)
     @results = OpenStruct.new(:import => import_settings, :export => export_settings)
   end
 
@@ -43,6 +43,12 @@ class UiTemplateSyncsController < ApplicationController
   end
 
   def render_errors(messages, severity = 'danger')
-    render :json => { :error => { :errors => { :base => messages }, :severity => severity } }, :status => :unprocessable_entity
+    render :json => { :error => { :errors => { :base => messages }, full_messages: messages, :severity => severity } }, :status => :unprocessable_entity
+  end
+
+  private
+
+  def setting_definitions(short_names)
+    short_names.map { |name| Foreman.settings.find("template_sync_#{name}") }
   end
 end

data/app/services/foreman_templates/template_exporter.rb

@@ -94,7 +94,7 @@ module ForemanTemplates
     def templates_to_dump
       find_templates.each do |template|
         if filter.present?
-          exportable = template.name =~ /#{filter}/i ? !negate : negate
+          exportable = /#{filter}/i.match?(template.name) ? !negate : negate
           result = ExportResult.new(template, exportable)
           next @result_lines << result.matching_filter unless exportable
 

data/app/services/foreman_templates/template_importer.rb

@@ -70,7 +70,7 @@ module ForemanTemplates
           @result_lines << parse_result.check_for_errors
         rescue NameError => e
           @result_lines << parse_result.name_error(e, metadata['model'])
-        rescue => e
+        rescue StandardError => e
           @result_lines << parse_result.add_exception(e)
         end
       end

data/app/views/template_sync_settings/show.json.rabl

@@ -1,11 +1,11 @@
 object @setting
 
 node do |setting|
-  { :name => setting.short_name }
+  { :name => setting.name.delete_prefix('template_sync_') }
 end
 
 attributes :id, :value, :description, :settings_type, :default, :full_name
 
 node do |setting|
-  { :selection => setting.selection }
+  { :selection => (setting.select_values || {}).map { |key, label| { value: key, label: label } } }
 end

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

@@ -5,20 +5,17 @@
   <%= webpacked_plugins_css_for :foreman_templates %>
 <% end %>
 
-<div id="foreman-templates"/>
-
-<%= mount_react_component('ForemanTemplates',
-                          '#foreman-templates',
-                          { :apiUrls => {
-                              :exportUrl => export_ui_template_syncs_path,
-                              :syncSettingsUrl => sync_settings_ui_template_syncs_path,
-                              :importUrl => import_ui_template_syncs_path
-                              },
-                            :validationData => { :repo => ForemanTemplates::Action.repo_start_with },
-                            :editPaths => edit_paths,
-                            :fileRepoStartWith => ForemanTemplates::Action.file_repo_start_with,
-                            :userPermissions => {
-                              :import => authorized_for(:controller => :ui_template_syncs, :action => :import),
-                              :export => authorized_for(:controller => :ui_template_syncs, :action => :export)
-                            }
-                          }.to_json )%>
+<%= react_component('ForemanTemplates',
+                      { :apiUrls => {
+                          :exportUrl => export_ui_template_syncs_path,
+                          :syncSettingsUrl => sync_settings_ui_template_syncs_path,
+                          :importUrl => import_ui_template_syncs_path
+                          },
+                        :validationData => { :repo => ForemanTemplates::Action.repo_start_with },
+                        :editPaths => edit_paths,
+                        :fileRepoStartWith => ForemanTemplates::Action.file_repo_start_with,
+                        :userPermissions => {
+                          :import => authorized_for(:controller => :ui_template_syncs, :action => :import),
+                          :export => authorized_for(:controller => :ui_template_syncs, :action => :export)
+                        }
+                      })%>

data/app/views/ui_template_syncs/template_attrs.json.rabl

@@ -11,7 +11,7 @@ node(:class_name) do |template|
 end
 
 node(:humanized_class_name) do |template|
-  template.class.name.underscore.split('_').map { |part| part.capitalize }.join(' ')
+  template.class.name.underscore.split('_').map(&:capitalize).join(' ')
 end
 
 node(:can_edit) do |template|

data/db/migrate/20211122154929_templates_settings_category_to_dsl.rb

@@ -0,0 +1,5 @@
+class TemplatesSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
+  def up
+    Setting.where(category: 'Setting::TemplateSync').update_all(category: 'Setting')
+  end
+end

data/lib/foreman_templates/engine.rb

@@ -10,10 +10,6 @@ module ForemanTemplates
   class Engine < ::Rails::Engine
     engine_name 'foreman_templates'
 
-    initializer 'foreman_templates.load_default_settings', :before => :load_config_initializers do
-      require_dependency File.expand_path('../../app/models/setting/template_sync.rb', __dir__) if (Setting.table_exists? rescue(false))
-    end
-
     initializer "foreman_templates.add_rabl_view_path" do
       Rabl.configure do |config|
         config.view_paths << ForemanTemplates::Engine.root.join('app', 'views')
@@ -28,10 +24,78 @@ module ForemanTemplates
 
     initializer 'foreman_templates.register_plugin', :before => :finisher_hook do
       Foreman::Plugin.register :foreman_templates do
-        requires_foreman '>= 1.24'
+        requires_foreman '>= 3.2'
 
         apipie_documented_controllers ["#{ForemanTemplates::Engine.root}/app/controllers/api/v2/*.rb"]
 
+        settings do
+          category(:template_sync, N_('Template Sync')) do
+            setting('template_sync_verbose',
+              type: :boolean,
+              description: N_('Choose verbosity for Rake task importing templates'),
+              default: false,
+              full_name: N_('Verbosity'))
+            setting('template_sync_associate',
+              type: :string,
+              description: N_('Associate templates to OS, organization and location'),
+              default: 'new',
+              full_name: N_('Associate'),
+              collection: -> { ForemanTemplates.associate_types })
+            setting('template_sync_prefix',
+              type: :string,
+              description: N_('The string that will be added as prefix to imported templates'),
+              default: "",
+              full_name: N_('Prefix'))
+            setting('template_sync_dirname',
+              type: :string,
+              description: N_('The directory within the Git repo containing the templates'),
+              default: '/',
+              full_name: N_('Dirname'))
+            setting('template_sync_filter',
+              type: :string,
+              description: N_('Import/export names matching this regex (case-insensitive; snippets are not filtered)'),
+              default: '',
+              full_name: N_('Filter'))
+            setting('template_sync_repo',
+              type: :string,
+              description: N_('Target path to import/export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.'),
+              default: 'https://github.com/theforeman/community-templates.git',
+              full_name: N_('Repo'))
+            setting('template_sync_negate',
+              type: :boolean,
+              description: N_('Negate the filter for import/export'),
+              default: false,
+              full_name: N_('Negate'))
+            setting('template_sync_branch',
+              type: :string,
+              description: N_('Default branch in Git repo'),
+              default: '',
+              full_name: N_('Branch'))
+            setting('template_sync_metadata_export_mode',
+              type: :string,
+              description: N_('Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata'),
+              default: 'refresh',
+              full_name: N_('Metadata export mode'),
+              collection: -> { ForemanTemplates.metadata_export_mode_types })
+            setting('template_sync_force',
+              type: :boolean,
+              description: N_('Should importing overwrite locked templates?'),
+              default: false,
+              full_name: N_('Force import'))
+            setting('template_sync_lock',
+              type: :string,
+              description: N_('How to handle lock for imported templates?'),
+              default: 'keep',
+              full_name: N_('Lock templates'),
+              collection: -> { ForemanTemplates.lock_types })
+            setting('template_sync_commit_msg',
+              type: :string,
+              description: N_('Custom commit message for templates export'),
+              default: 'Templates export made by a Foreman user',
+              full_name: N_('Commit message'))
+          end
+        end
+
         security_block :templates do
           permission :import_templates, {
             :"api/v2/template" => [:import],
@@ -49,15 +113,17 @@ module ForemanTemplates
         add_all_permissions_to_default_roles
 
         menu :top_menu, :template_sync,
-             :url_hash => { :controller => :template_syncs, :action => :index },
-             :caption => N_('Sync Templates'),
-             :parent => :hosts_menu,
-             :before => :ptables,
-             :turbolinks => false
+          :url_hash => { :controller => :template_syncs, :action => :index },
+          :caption => N_('Sync Templates'),
+          :parent => :hosts_menu,
+          :before => :ptables,
+          :turbolinks => false
       end
     end
 
     config.to_prepare do
+      Setting::NOT_STRIPPED << 'template_sync_prefix'
+
       Template.include ForemanTemplates::TemplateExtensions
     end
   end

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '9.0.0'.freeze
+  VERSION = '9.2.0'.freeze
 end

data/lib/foreman_templates.rb

@@ -1,4 +1,19 @@
 require 'foreman_templates/engine'
 
 module ForemanTemplates
+  BASE_SETTING_NAMES = %w(repo branch dirname filter negate).freeze
+  IMPORT_SETTING_NAMES = (BASE_SETTING_NAMES | %w(prefix associate force lock)).freeze
+  EXPORT_SETTING_NAMES = (BASE_SETTING_NAMES | %w(metadata_export_mode commit_msg)).freeze
+
+  def self.associate_types
+    { 'always' => _('Always'), 'new' => _('New'), 'never' => _('Never') }
+  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'), 'keep' => _('Keep'), 'remove' => _('Remove') }
+  end
 end

data/lib/tasks/foreman_templates_tasks.rake

@@ -20,14 +20,14 @@ namespace :templates do
     verbose = ENV['verbose']
 
     results = ForemanTemplates::TemplateImporter.new({
-      verbose:   verbose,
-      repo:      ENV['repo'],
-      branch:    ENV['branch'],
-      prefix:    ENV['prefix'],
-      dirname:   ENV['dirname'],
-      filter:    ENV['filter'],
+      verbose: verbose,
+      repo: ENV['repo'],
+      branch: ENV['branch'],
+      prefix: ENV['prefix'],
+      dirname: ENV['dirname'],
+      filter: ENV['filter'],
       associate: ENV['associate'],
-      lock:      ENV['lock'],
+      lock: ENV['lock'],
     }).import!
     pp(results[:results].map { |result| result.to_h(verbose) })
   end
@@ -58,8 +58,8 @@ namespace :templates do
       # * negate  => negate query [false]
       # * prefix  => The string all templates to purge should ( or not ) begin with [Community ]
       # * verbose => Print extra information during the run [false]
-      negate:  ENV['negate'],
-      prefix:  ENV['prefix'],
+      negate: ENV['negate'],
+      prefix: ENV['prefix'],
       verbose: ENV['verbose'],
     }).purge!
   end
@@ -89,6 +89,7 @@ namespace :foreman_templates do
     begin
       require 'rubocop/rake_task'
       RuboCop::RakeTask.new(:rubocop_foreman_templates) do |task|
+        task.options = ['--config', ForemanTemplates::Engine.root.join('.rubocop.yml').to_s]
         task.patterns = ["#{ForemanTemplates::Engine.root}/app/**/*.rb",
                          "#{ForemanTemplates::Engine.root}/lib/**/*.rb",
                          "#{ForemanTemplates::Engine.root}/test/**/*.rb"]

data/webpack/ForemanTemplates.js

@@ -4,26 +4,30 @@ import PropTypes from 'prop-types';
 
 import Routes from './Routes';
 
-const ForemanTemplates = ({ data }) => (
+const ForemanTemplates = ({
+  apiUrls,
+  validationData,
+  fileRepoStartWith,
+  userPermissions,
+  editPaths,
+}) => (
   <Router>
     <Routes
-      apiUrls={data.apiUrls}
-      validationData={data.validationData}
-      editPaths={data.editPaths}
-      fileRepoStartWith={data.fileRepoStartWith}
-      userPermissions={data.userPermissions}
+      apiUrls={apiUrls}
+      validationData={validationData}
+      editPaths={editPaths}
+      fileRepoStartWith={fileRepoStartWith}
+      userPermissions={userPermissions}
     />
   </Router>
 );
 
 ForemanTemplates.propTypes = {
-  data: PropTypes.shape({
-    apiUrls: PropTypes.object,
-    validationData: PropTypes.object,
-    editPaths: PropTypes.object,
-    userPermissions: PropTypes.object,
-    fileRepoStartWith: PropTypes.array,
-  }).isRequired,
+  apiUrls: PropTypes.object.isRequired,
+  validationData: PropTypes.object.isRequired,
+  editPaths: PropTypes.object.isRequired,
+  userPermissions: PropTypes.object.isRequired,
+  fileRepoStartWith: PropTypes.array.isRequired,
 };
 
 export default ForemanTemplates;

data/webpack/__mocks__/foremanReact/Root/Context/ForemanContext.js

@@ -0,0 +1,2 @@
+export const useForemanOrganization = () => {};
+export const useForemanLocation = () => {};

data/webpack/__mocks__/foremanReact/components/Pagination/index.js

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

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

@@ -1,159 +1,116 @@
-import React from 'react';
+import React, { useState } from 'react';
 import PropTypes from 'prop-types';
 import { compose } from 'redux';
 
 import ForemanForm from 'foremanReact/components/common/forms/ForemanForm';
-import * as Yup from 'yup';
+import {
+  useForemanLocation,
+  useForemanOrganization,
+} from 'foremanReact/Root/Context/ForemanContext';
+
 import SyncSettingsFields from '../SyncSettingFields';
 import SyncTypeRadios from '../SyncTypeRadios';
-
-const redirectToResult = history => () =>
-  history.push({ pathname: '/template_syncs/result' });
-
-const repoFormat = formatAry => value => {
-  if (value === undefined) {
-    return true;
-  }
-
-  const valid = formatAry
-    .map(item => value.startsWith(item))
-    .reduce((memo, item) => item || memo, false);
-
-  return value && valid;
-};
-
-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;
-    },
-    {}
+import { redirectToResult, syncFormSchema } from './NewTemplateSyncFormHelpers';
+
+const NewTemplateSyncForm = ({
+  error,
+  submitForm,
+  importSettings,
+  exportSettings,
+  history,
+  validationData,
+  importUrl,
+  exportUrl,
+  initialValues,
+  userPermissions,
+}) => {
+  const allowedSyncType = (currentUserPermissions, radioAttrs) =>
+    currentUserPermissions[radioAttrs.permission];
+
+  const radioButtons = [
+    { label: 'Import', value: 'import', permission: 'import' },
+    { label: 'Export', value: 'export', permission: 'export' },
+  ];
+
+  const [syncType, setSyncType] = useState(
+    radioButtons.find(radioAttrs =>
+      allowedSyncType(userPermissions, radioAttrs)
+    ).value
   );
 
-  return Yup.object().shape({
-    [syncType]: Yup.object().shape(schema),
-  });
-};
-
-class NewTemplateSyncForm extends React.Component {
-  allowedSyncType = (userPermissions, radioAttrs) =>
-    this.props.userPermissions[radioAttrs.permission];
-
-  constructor(props) {
-    super(props);
-
-    this.radioButtons = [
-      { label: 'Import', value: 'import', permission: 'import' },
-      { label: 'Export', value: 'export', permission: 'export' },
-    ];
-
-    this.state = {
-      syncType: this.radioButtons.find(radioAttrs =>
-        this.allowedSyncType(props.userPermissions, radioAttrs)
-      ).value,
-    };
-  }
-
-  updateSyncType = event => {
-    this.setState({ syncType: event.target.value });
+  const updateSyncType = event => {
+    setSyncType(event.target.value);
   };
 
-  permitRadioButtons = buttons =>
+  const permitRadioButtons = buttons =>
     buttons.filter(buttonAttrs =>
-      this.allowedSyncType(this.props.userPermissions, buttonAttrs)
+      allowedSyncType(userPermissions, buttonAttrs)
     );
 
-  initRadioButtons = syncType =>
-    this.permitRadioButtons(this.radioButtons).map(buttonAttrs => ({
+  const initRadioButtons = templateSyncType =>
+    permitRadioButtons(radioButtons).map(buttonAttrs => ({
       get checked() {
-        return this.value === syncType;
+        return buttonAttrs.value === templateSyncType;
       },
-      onChange: this.updateSyncType,
+      onChange: updateSyncType,
       ...buttonAttrs,
     }));
 
-  render() {
-    const {
-      error,
-      submitForm,
-      importSettings,
-      exportSettings,
-      history,
-      validationData,
-      importUrl,
-      exportUrl,
-      initialValues,
-      currentLocation,
-      currentOrganization,
-    } = this.props;
-
-    const addTaxParams = (key, currentTax) => params => {
-      if (currentTax.id) {
-        params[key] = [currentTax.id];
-      }
-      return params;
-    };
-
-    const addOrgParams = addTaxParams('organization_ids', currentOrganization);
-    const addLocParams = addTaxParams('location_ids', currentLocation);
-
-    const resetToDefault = (fieldName, fieldValue) => resetFn =>
-      resetFn(fieldName, fieldValue);
-
-    return (
-      <ForemanForm
-        onSubmit={(values, actions) => {
-          const url = this.state.syncType === 'import' ? importUrl : exportUrl;
-          return submitForm({
-            url,
-            values: compose(
-              addLocParams,
-              addOrgParams
-            )(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)}
-        error={error}
-      >
-        <SyncTypeRadios
-          name="syncType"
-          controlLabel="Action type"
-          radios={this.initRadioButtons(this.state.syncType)}
-        />
-        <SyncSettingsFields
-          importSettings={importSettings}
-          exportSettings={exportSettings}
-          syncType={this.state.syncType}
-          resetField={resetToDefault}
-        />
-      </ForemanForm>
-    );
-  }
-}
+  const addTaxParams = (key, currentTax) => params => {
+    if (currentTax && currentTax.id) {
+      return { ...params, [key]: [currentTax.id] };
+    }
+    return params;
+  };
+
+  const addOrgParams = addTaxParams(
+    'organization_ids',
+    useForemanOrganization()
+  );
+  const addLocParams = addTaxParams('location_ids', useForemanLocation());
+
+  const resetToDefault = (fieldName, fieldValue) => resetFn =>
+    resetFn(fieldName, fieldValue);
+
+  const handleSubmit = (values, actions) => {
+    const url = syncType === 'import' ? importUrl : exportUrl;
+    return submitForm({
+      url,
+      values: compose(addLocParams, addOrgParams)(values[syncType]),
+      message: `Templates were ${syncType}ed.`,
+      item: 'TemplateSync',
+      actions,
+      successCallback: () =>
+        history.replace({ pathname: '/template_syncs/result' }),
+    });
+  };
+
+  return (
+    <ForemanForm
+      onSubmit={handleSubmit}
+      initialValues={initialValues}
+      validationSchema={syncFormSchema(
+        syncType,
+        { import: importSettings, export: exportSettings },
+        validationData
+      )}
+      onCancel={redirectToResult(history)}
+      error={error}
+    >
+      <SyncTypeRadios
+        name="syncType"
+        controlLabel="Action type"
+        radios={initRadioButtons(syncType)}
+      />
+      <SyncSettingsFields
+        importSettings={importSettings}
+        exportSettings={exportSettings}
+        syncType={syncType}
+        resetField={resetToDefault}
+      />
+    </ForemanForm>
+  );
+};
 
 NewTemplateSyncForm.propTypes = {
   importSettings: PropTypes.array,
@@ -166,8 +123,6 @@ NewTemplateSyncForm.propTypes = {
   exportUrl: PropTypes.string.isRequired,
   importUrl: PropTypes.string.isRequired,
   submitForm: PropTypes.func.isRequired,
-  currentLocation: PropTypes.object.isRequired,
-  currentOrganization: PropTypes.object.isRequired,
 };
 
 NewTemplateSyncForm.defaultProps = {

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

@@ -0,0 +1,43 @@
+import * as Yup from 'yup';
+
+export const redirectToResult = history => () =>
+  history.push({ pathname: '/template_syncs/result' });
+
+const repoFormat = formatAry => value => {
+  if (value === undefined) {
+    return true;
+  }
+
+  const valid = formatAry
+    .map(item => value.startsWith(item))
+    .reduce((memo, item) => item || memo, false);
+
+  return value && valid;
+};
+
+export 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),
+  });
+};

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

@@ -2,8 +2,6 @@ import { connect } from 'react-redux';
 
 import * as FormActions from 'foremanReact/redux/actions/common/forms';
 
-import { selectLayout } from 'foremanReact/components/Layout/LayoutSelectors';
-
 import NewTemplateSyncForm from './NewTemplateSyncForm';
 
 import {
@@ -24,8 +22,6 @@ const mapStateToProps = (state, ownProps) => {
     initialValues: { ...initialFormValues },
     importSettings,
     exportSettings,
-    currentOrganization: selectLayout(state).currentOrganization,
-    currentLocation: selectLayout(state).currentLocation,
   };
 };
 

data/webpack/components/TemplateSyncResult/TemplateSyncResultHelpers.js

@@ -1,6 +1,6 @@
 // move to some sort of pagination helper in core
 export const templatesPage = (templates, pagination) => {
-  const offset = (pagination.page - 1) * pagination.perPage;
+  const offset = (pagination.page - 1) * pagination.per_page;
 
-  return templates.slice(offset, offset + pagination.perPage);
+  return templates.slice(offset, offset + pagination.per_page);
 };

data/webpack/components/TemplateSyncResult/TemplateSyncResultReducer.js

@@ -12,7 +12,7 @@ export const initialState = Immutable({
 
   pagination: {
     page: 1,
-    perPage: 20,
+    per_page: 20,
   },
 });
 

data/webpack/components/TemplateSyncResult/__tests__/__snapshots__/TemplateSyncResultReducer.test.js.snap

@@ -4,7 +4,7 @@ exports[`TemplateSyncResultReducer should return initial state 1`] = `
 Object {
   "pagination": Object {
     "page": 1,
-    "perPage": 20,
+    "per_page": 20,
   },
   "resultAction": "",
   "templates": Array [],
@@ -27,7 +27,7 @@ Object {
   "branch": "master",
   "pagination": Object {
     "page": 1,
-    "perPage": 20,
+    "per_page": 20,
   },
   "repo": "https://github.com/theforeman/community-templates.git",
   "resultAction": "import",

data/webpack/components/TemplateSyncResult/components/SyncResultList.js

@@ -2,13 +2,19 @@ import React from 'react';
 import { ListView } from 'patternfly-react';
 import PropTypes from 'prop-types';
 
-import Pagination from 'foremanReact/components/Pagination/PaginationWrapper';
+import Pagination from 'foremanReact/components/Pagination';
 
 import SyncedTemplate from './SyncedTemplate';
 import { templatesPage } from '../TemplateSyncResultHelpers';
 import ListViewHeader from './ListViewHeader';
 
-const SyncResultList = ({ pagination, pageChange, templates, editPaths }) => (
+const SyncResultList = ({
+  pagination,
+  pagination: { page, per_page: perPage },
+  pageChange,
+  templates,
+  editPaths,
+}) => (
   <ListView>
     <ListViewHeader />
     {templatesPage(templates, pagination).map((template, idx) => (
@@ -19,11 +25,10 @@ const SyncResultList = ({ pagination, pageChange, templates, editPaths }) => (
       />
     ))}
     <Pagination
-      viewType="list"
       itemCount={templates.length}
-      pagination={pagination}
       onChange={pageChange}
-      dropdownButtonId="template-sync-result-dropdown"
+      page={page}
+      perPage={perPage}
     />
   </ListView>
 );
@@ -31,7 +36,7 @@ const SyncResultList = ({ pagination, pageChange, templates, editPaths }) => (
 SyncResultList.propTypes = {
   pagination: PropTypes.shape({
     page: PropTypes.number,
-    perPage: PropTypes.number,
+    per_page: PropTypes.number,
   }).isRequired,
   pageChange: PropTypes.func.isRequired,
   templates: PropTypes.array.isRequired,

data/webpack/components/TemplateSyncResult/components/__tests__/SyncResultList.test.js

@@ -18,7 +18,7 @@ const fixtures = {
     editPaths,
     pagination: {
       page: 1,
-      perPage: 20,
+      per_page: 20,
     },
   },
 };

data/webpack/components/TemplateSyncResult/components/__tests__/__snapshots__/SyncResultList.test.js.snap

@@ -88,17 +88,11 @@ exports[`SyncResultList should render 1`] = `
       }
     }
   />
-  <PaginationWrapper
-    dropdownButtonId="template-sync-result-dropdown"
+  <Pagination
     itemCount={5}
     onChange={[Function]}
-    pagination={
-      Object {
-        "page": 1,
-        "perPage": 20,
-      }
-    }
-    viewType="list"
+    page={1}
+    perPage={20}
   />
 </ListView>
 `;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_templates
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -69,7 +69,6 @@ files:
 - app/controllers/ui_template_syncs_controller.rb
 - app/helpers/foreman_templates_helper.rb
 - app/models/concerns/foreman_templates/template_extensions.rb
-- app/models/setting/template_sync.rb
 - app/services/foreman_templates/action.rb
 - app/services/foreman_templates/cleaner.rb
 - app/services/foreman_templates/export_result.rb
@@ -89,6 +88,7 @@ files:
 - app/views/ui_template_syncs/template_import_results.json.rabl
 - config/routes.rb
 - db/migrate/20180627134929_change_lock_setting.rb
+- db/migrate/20211122154929_templates_settings_category_to_dsl.rb
 - lib/foreman_templates.rb
 - lib/foreman_templates/engine.rb
 - lib/foreman_templates/version.rb
@@ -96,9 +96,10 @@ files:
 - package.json
 - webpack/ForemanTemplates.js
 - webpack/Routes.js
+- webpack/__mocks__/foremanReact/Root/Context/ForemanContext.js
 - webpack/__mocks__/foremanReact/common/helpers.js
 - webpack/__mocks__/foremanReact/components/Layout/LayoutSelectors.js
-- webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js
+- webpack/__mocks__/foremanReact/components/Pagination/index.js
 - webpack/__mocks__/foremanReact/components/common/forms/CommonForm.js
 - webpack/__mocks__/foremanReact/components/common/forms/ForemanForm.js
 - webpack/__mocks__/foremanReact/components/common/forms/TextField.js
@@ -120,6 +121,7 @@ files:
 - webpack/components/NewTemplateSync/__tests__/__snapshots__/NewTemplateSyncSelectors.test.js.snap
 - webpack/components/NewTemplateSync/components/ButtonTooltip.js
 - webpack/components/NewTemplateSync/components/NewTemplateSyncForm/NewTemplateSyncForm.js
+- webpack/components/NewTemplateSync/components/NewTemplateSyncForm/NewTemplateSyncFormHelpers.js
 - webpack/components/NewTemplateSync/components/NewTemplateSyncForm/NewTemplateSyncFormSelectors.js
 - webpack/components/NewTemplateSync/components/NewTemplateSyncForm/__tests__/NewTemplateSyncFormSelectors.test.js
 - webpack/components/NewTemplateSync/components/NewTemplateSyncForm/__tests__/__snapshots__/NewTemplateSyncFormSelectors.test.js.snap
@@ -198,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Template-syncing engine for Foreman

data/app/models/setting/template_sync.rb

@@ -1,115 +0,0 @@
-class Setting
-  class TemplateSync < ::Setting
-    self.include_root_in_json = false
-
-    def self.common_stripped_names
-      %w(verbose repo branch dirname filter negate)
-    end
-
-    def self.import_stripped_names
-      %w(prefix associate force lock)
-    end
-
-    def self.export_stripped_names
-      %w(metadata_export_mode commit_msg)
-    end
-
-    def self.import_setting_names(except = [])
-      map_prefix omit_settings(common_stripped_names + import_stripped_names, except)
-    end
-
-    def self.export_setting_names(except = [])
-      map_prefix omit_settings(common_stripped_names + export_stripped_names, except)
-    end
-
-    def self.map_prefix(stripped_names)
-      stripped_names.map { |item| "template_sync_#{item}" }
-    end
-
-    def self.omit_settings(setting_names, except_array)
-      setting_names.reject { |name| except_array.include? name }
-    end
-
-    def self.associate_types
-      {
-        'always' => _('Always'),
-        'new' => _('New'),
-        'never' => _('Never')
-      }
-    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'),
-        'keep' => _('Keep'),
-        'remove' => _('Remove')
-      }
-    end
-
-    def short_name
-      name.split('template_sync_').last
-    end
-
-    def selection
-      selection_method = name.split('template_sync_').last.concat('_types')
-      return transformed_selection(selection_method) if self.class.respond_to?(selection_method)
-
-      []
-    end
-
-    def self.load_defaults
-      return unless super
-
-      %w(template_sync_filter template_sync_branch template_sync_prefix).each { |s| Setting::BLANK_ATTRS << s }
-      Setting::NOT_STRIPPED << 'template_sync_prefix'
-
-      self.transaction do
-        [
-          self.set('template_sync_verbose', N_('Choose verbosity for Rake task importing templates'), false, N_('Verbosity')),
-          self.set('template_sync_associate', N_('Associate templates to OS, organization and location'), 'new', N_('Associate'), nil, { :collection => Proc.new { self.associate_types } }),
-          self.set('template_sync_prefix', N_('The string that will be added as prefix to imported templates'), "", N_('Prefix')),
-          self.set('template_sync_dirname', N_('The directory within the Git repo containing the templates'), '/', N_('Dirname')),
-          self.set('template_sync_filter', N_('Import/export names matching this regex (case-insensitive; snippets are not filtered)'), '', N_('Filter')),
-          self.set('template_sync_repo', N_('Target path to import/export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.'), 'https://github.com/theforeman/community-templates.git', N_('Repo')),
-          self.set('template_sync_negate', N_('Negate the filter for import/export'), false, N_('Negate')),
-          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_('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
-
-      true
-    end
-
-    def validate_template_sync_associate(record)
-      values = record.class.associate_types.keys
-      if record.value && !values.include?(record.value)
-        record.errors[:base] << (_("template_sync_associate must be one of %s") % values.join(', '))
-      end
-    end
-
-    def validate_template_sync_metadata_export_mode(record)
-      values = record.class.metadata_export_mode_types.keys
-      if record.value && !values.include?(record.value)
-        record.errors[:base] << (_("template_sync_metadata_export_mode must be one of %s") % values.join(', '))
-      end
-    end
-
-    private
-
-    def transformed_selection(selection_method)
-      self.class.public_send(selection_method).map { |key, translated| { :value => key, :label => translated } }
-    end
-  end
-end

data/webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js

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