foreman_templates 7.0.7 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9583ee6b0f88f013c5a26f23dd90a22cf7bdcdeebbb8052c3fdffaf11960fb3d
-  data.tar.gz: 5b54607bfe06ca7cdd359d371afbb497e343310ae48d29c2f359bb4d43a6a38d
+  metadata.gz: 3b520577905d85f390af67f22635c98defb339c3177cfc9b7ecfb8039b3999c2
+  data.tar.gz: ae67963f134f9b53fe2f4520c028cd8426474e3aa10dc01733a292bbf1bb8284
 SHA512:
-  metadata.gz: d6826d8bdd2c9bbc47d09cfe8a9cfeddb169a6aa65933fd670144921091267d20814b5cf4cf37e93629a81fa2b1b81120ce796dd53194d4740b02b7e10c04720
-  data.tar.gz: 2e019ce44797e7c28648f8b8913d224441a514fad0e75c977502c1c79c4bab09dbcb4b538a584c28fc8049c60df5ff3c270dfe2de2df97564c5a5af3125ebce5
+  metadata.gz: 763f1cd44a8a5a91bad924c0c6eb50950b7cd552b762bc767c188eeae9f78d66ecb9f4f15d81012092683a2fff263c19bf2230e622167ec235557fac64244ea7
+  data.tar.gz: e48d8b9ac3b46195afec1d2913a4ad4a6558dc2a7ea2d325e8f6566b7697ca8780e450ced74b7604d709940660dbdd54a438c6590b4c08fd66b7fa3bdd189f88

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/controllers/ui_template_syncs_controller.rb

@@ -43,6 +43,6 @@ 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
 end

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'
@@ -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

@@ -10,7 +10,6 @@ module ForemanTemplates
       super args
       @verbose = parse_bool(@verbose)
       @force = parse_bool(@force)
-      @lock = parse_bool(@lock)
       @result_lines = []
     end
 
@@ -71,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
@@ -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

@@ -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/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'
@@ -43,11 +49,11 @@ 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
 

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '7.0.7'.freeze
+  VERSION = '9.1.0'.freeze
 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/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/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/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 => ({