foreman_templates 7.0.5 → 9.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 773f26f24c7e56569b70ae180164487a804c89a6
-  data.tar.gz: 13138a1fd87a675c222333e57e7c2ea78a1489c0
+SHA256:
+  metadata.gz: 46560d67a9e22719b19e71c43a0298d960ef8859a37fa0fdba12d0a2ea91fa21
+  data.tar.gz: b57fa4cf54bff7ca216d6e3a2abbbe77215e078ee7feb896053603f3d56a07fe
 SHA512:
-  metadata.gz: eecbb9e4993ab19b071dfa052290e45b9ee14d50e62b99984de31ea8f28a3a9c48b19bbc06ce17ccab1fdccd325e8016dbc2e1ea7d1a5c13c9520fbd096498d0
-  data.tar.gz: c2091508b18ecb0396564782b809e0e9e69c1489389a0cee5397c7c9a39dab1c2e46954486efd75de2f41b41a01090d8b0db03984b60dc392edf923c9d41b9fc
+  metadata.gz: 6422b8cd5feb8b24e541dfa819aa8f063f65385fdfe4ad884e48474d1e76ad7d327c13e60336803e48de9034a299b6a01bc727966384e75e73c9162fc29cf069
+  data.tar.gz: ddb404bc9683c683403c4a401ccacb2118dadc197b998272f70192525738fa68746f290264ead24c42a2c4ca97d49db115aafe6f8e3cac2c416eacc6ca420230

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,11 +33,13 @@ 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
         @result = ForemanTemplates::TemplateExporter.new(template_export_params).export!
-        render :json => { :message => @result.to_h }, :status => @result.exported ? 200 : 500
+        @result[:templates] = @result[:templates].map(&:to_h)
+        render :json => { :message => @result }, :status => @result[:error] ? 500 : 200
       end
     end
   end

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

@@ -18,7 +18,7 @@ class UiTemplateSyncsController < ApplicationController
   end
 
   def export
-    @result = ForemanTemplates::TemplateExporter.new(ui_template_export_params).export!
+    @result = OpenStruct.new ForemanTemplates::TemplateExporter.new(ui_template_export_params).export!
 
     if @result.error
       render_errors [@result.error]

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/export_result.rb

@@ -1,42 +1,33 @@
 module ForemanTemplates
   class ExportResult
-    attr_accessor :exported, :error, :warning
-    attr_reader :templates, :git_user, :branch, :repo
+    attr_reader :template, :name, :template_file, :exported, :additional_info
 
-    def initialize(repo, branch, git_user)
-      @repo = repo
-      @branch = branch
-      @git_user = git_user
-      @error = nil
-      @warning = nil
-      @templates = []
-      @exported = false
-    end
-
-    def add_exported_templates(templates)
-      @templates.concat templates
+    def initialize(template, exported = true)
+      @template = template
+      @exported = exported
+      @name = template.name
+      @template_file = template.template_file
     end
 
     def to_h
-      { :error => @error,
-        :warning => @warning,
-        :repo => @repo,
-        :branch => @branch,
-        :git_user => @git_user,
-        :templates => dumped_files_result }
+      {
+        :id => template.id,
+        :name => @name,
+        :exported => @exported,
+        :type => template.class.name.underscore,
+        :additional_info => @additional_info
+      }
     end
 
-    private
-
-    def dumped_files_result
-      @templates.map { |template| to_template_h template }
+    def matching_filter
+      generic_info "Skipping, 'name' filtered out based on 'filter' and 'negate' settings"
     end
 
-    def to_template_h(template)
-      { :id => template.id,
-        :name => template.name,
-        :exported => @exported,
-        :type => template.class.name.underscore }
+    def generic_info(additional_msg)
+      @exported = false
+      @additional_info = additional_msg
+      Logging.logger('app').debug "Not exporting #{@template.name}: #{additional_msg}"
+      self
     end
   end
 end

data/app/services/foreman_templates/parse_result.rb

@@ -14,6 +14,7 @@ module ForemanTemplates
         :changed => changed?,
         :imported => @imported,
         :additional_errors => @additional_errors,
+        :additional_info => @additional_info,
         :exception => @exception ? @exception.message : nil,
         :validation_errors => errors.to_h,
         :file => @template_file,

data/app/services/foreman_templates/template_exporter.rb

@@ -1,30 +1,32 @@
 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 = {})
+      super args
+      @result_lines = []
     end
 
     def export!
-      @export_result = ExportResult.new(@repo, @branch, foreman_git_user)
       if git_repo?
         export_to_git
       else
         export_to_files
       end
-
-      return @export_result
+      export_result
     end
 
     def export_to_files
       @dir = get_absolute_repo_path
       verify_path!(@dir)
       dump_files!
-      @export_result.exported = true
     end
 
     def export_to_git
       @dir = Dir.mktmpdir
-      return @export_result if branch_missing?
+      return if branch_missing?
 
       git_repo = Git.clone(@repo, @dir)
       logger.debug "cloned '#{@repo}' to '#{@dir}'"
@@ -33,30 +35,33 @@ module ForemanTemplates
       dump_files!
       git_repo.add
 
-      status = git_repo.status
-      if status.added.any? || status.changed.any? || status.deleted.any? || status.untracked.any?
-        git_repo.commit "Templates export made by Foreman user #{foreman_git_user}"
+      new_repo = false
+      begin
+        status = git_repo.status
+      rescue Git::GitExecuteError # no HEAD for repo without commits, git diff-index HEAD fails
+        new_repo = true
+      end
+      if new_repo || status.added.any? || status.changed.any? || status.deleted.any? || status.untracked.any?
+        git_repo.commit commit_msg
         git_repo.push 'origin', branch
-        @export_result.exported = true
       else
-        @export_result.warning = 'No change detected, skipping the commit and push'
+        @warning = 'No change detected, skipping the commit and push'
       end
     rescue StandardError => e
-      @export_result.error = e.message
+      @error = e.message
     ensure
       FileUtils.remove_entry_secure(@dir) if File.exist?(@dir)
-      @export_result
     end
 
     def setup_git_branch(git_repo)
       logger.debug "checking out branch '#{@branch}'"
-      if git_repo.is_branch?(@branch)
+      if git_repo.is_branch?(@branch) # local branch
         git_repo.checkout(@branch)
-      else
+      elsif git_repo.is_remote_branch?(@branch) # if we work with remote branch, checkout and sync
         git_repo.branch(@branch).checkout
-        if git_repo.is_remote_branch?(@branch) # if we work with remote branch we need to sync it first
-          git_repo.reset_hard("origin/#{@branch}")
-        end
+        git_repo.reset_hard("origin/#{@branch}")
+      else # neither local nor remote
+        git_repo.checkout(@branch, :new_branch => true)
       end
     end
 
@@ -65,22 +70,18 @@ module ForemanTemplates
     end
 
     def dump_files!
-      templates = templates_to_dump
-      begin
-        templates.map do |template|
-          current_dir = get_dump_dir(template)
-          FileUtils.mkdir_p current_dir
-          filename = File.join(current_dir, template.template_file)
-          File.open(filename, 'w+') do |file|
-            logger.debug "Writing to file #{filename}"
-            bytes = file.write template.public_send(export_method)
-            logger.debug "finished writing #{bytes}"
-          end
+      templates_to_dump.map do |template|
+        current_dir = get_dump_dir(template)
+        FileUtils.mkdir_p current_dir
+        filename = File.join(current_dir, template.template_file)
+        File.open(filename, 'w+') do |file|
+          logger.debug "Writing to file #{filename}"
+          bytes = file.write template.public_send(export_method)
+          logger.debug "finished writing #{bytes}"
         end
-      rescue StandardError => e
-        raise PathAccessException, e.message
       end
-      @export_result.add_exported_templates templates
+    rescue StandardError => e
+      raise PathAccessException, e.message
     end
 
     def get_dump_dir(template)
@@ -91,18 +92,23 @@ module ForemanTemplates
     end
 
     def templates_to_dump
-      base = find_templates
-      if filter.present?
-        method = negate ? :reject : :select
-        base.public_send(method) { |template| template.name.match(/#{filter}/i) }
-      else
-        base
+      find_templates.each do |template|
+        if filter.present?
+          exportable = template.name =~ /#{filter}/i ? !negate : negate
+          result = ExportResult.new(template, exportable)
+          next @result_lines << result.matching_filter unless exportable
+
+          @result_lines << result
+        else
+          @result_lines << ExportResult.new(template)
+        end
       end
+      @result_lines.select(&:exported).map(&:template)
     end
 
     def branch_missing?
       if @branch.blank?
-        @export_result.error = "Please specify a branch when exporting into a git repo"
+        @error = "Please specify a branch when exporting into a git repo"
         return true
       end
       false
@@ -124,6 +130,13 @@ module ForemanTemplates
       end
     end
 
+    def export_result
+      {
+        :templates => @result_lines, :repo => @repo, :branch => @branch,
+        :git_user => foreman_git_user, :error => @error, :warning => @warning
+      }
+    end
+
     private
 
     def find_templates

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

data/app/views/ui_template_syncs/template_export_result.rabl

@@ -1,7 +1,7 @@
-object @template
+object @template_result
 
-attributes :name, :template_file
+attributes :name, :template_file, :additional_info
 
-node(false) do |template|
-  partial "ui_template_syncs/template_attrs", :object => template
+node(false) do |result|
+  partial "ui_template_syncs/template_attrs", :object => result.template
 end

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'