foreman_templates 6.0.3 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cc280125e10a060bc7debd69bffbc0d233e26fb
-  data.tar.gz: 0341d3c81c3a0e91dd120fa77e33d5d0d45b1bb8
+  metadata.gz: 63fe0a1d25d54d0f50a328051d90f5df2ace0aa4
+  data.tar.gz: 430fbe5dfccd63f678dbb50d72cac11c124c8326
 SHA512:
-  metadata.gz: 4ca8d2c2d570a1895100218dcfcc7139e1791f450fcd3619c9c50641d22ce0e59003f9122a87c747d93d108e8defb2bb6d7f934f63ff20346486dd6b6ddcc050
-  data.tar.gz: b133cc7b56cf66d9a3edb57d22cef6701b43f82c879dcd338381a69ac985768c9aee54d0dbf55f827470db8fa6e172c155d07a7d84b4fc18efe4e005ae0dd869
+  metadata.gz: c57bc9dc48fd3f5b786f05d381ba9b81c3d61a47668b001e6ddcc0565f70b3b31161b27efa2cf41fef57982c6cafb47d2fb411f41bc1b598a06f8f0c76647e32
+  data.tar.gz: 2cff0a4e2a51fff6fc662ae11c30a4b77de1ab34dc11a3f1c93131244a6d7784a8181c23ad3aec4990da7bc5d035c4e622495106cfac12e21544077d7077c18b

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

@@ -25,14 +25,30 @@ module Foreman
           end
         end
 
+        def ui_template_import_params
+          base_import_params :ui_template_sync
+        end
+
+        def ui_template_export_params
+          base_export_params :ui_template_sync
+        end
+
         def template_import_params
-          add_taxonomy_params(self.class.template_params_filter(self.class.extra_import_params)
-            .filter_params(params, parameter_filter_context, :none).with_indifferent_access)
+          add_taxonomy_params(base_import_params(:none))
         end
 
         def template_export_params
-          add_taxonomy_params(self.class.template_params_filter(self.class.extra_export_params)
-            .filter_params(params, parameter_filter_context, :none).with_indifferent_access)
+          add_taxonomy_params(base_export_params(:none))
+        end
+
+        def base_import_params(toplevel_key)
+          self.class.template_params_filter(self.class.extra_import_params)
+              .filter_params(params, parameter_filter_context, toplevel_key).with_indifferent_access
+        end
+
+        def base_export_params(toplevel_key)
+          self.class.template_params_filter(self.class.extra_export_params)
+              .filter_params(params, parameter_filter_context, toplevel_key).with_indifferent_access
         end
 
         def organization_params

data/app/controllers/template_syncs_controller.rb

@@ -0,0 +1,13 @@
+class TemplateSyncsController < ReactController
+  def index
+  end
+
+  def action_permission
+    case params[:action]
+    when 'index'
+      :view_template_syncs
+    else
+      super
+    end
+  end
+end

data/app/controllers/ui_template_syncs_controller.rb

@@ -0,0 +1,48 @@
+require 'ostruct'
+
+class UiTemplateSyncsController < ApplicationController
+  include ::Foreman::Controller::Parameters::TemplateParams
+
+  rescue_from ::ForemanTemplates::PathAccessException do |error|
+    render_errors [error.message]
+  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'])
+    @results = OpenStruct.new(:import => import_settings, :export => export_settings)
+  end
+
+  def import
+    @parse_result = OpenStruct.new ForemanTemplates::TemplateImporter.new(ui_template_import_params).import!
+  end
+
+  def export
+    @result = ForemanTemplates::TemplateExporter.new(ui_template_export_params).export!
+
+    if @result.error
+      render_errors [@result.error]
+    end
+
+    if @result.warning
+      render_errors [@result.warning], 'warning'
+    end
+  end
+
+  def action_permission
+    case params[:action]
+    when 'sync_settings'
+      :view_template_syncs
+    else
+      super
+    end
+  end
+
+  def parameter_filter_context
+    Foreman::ParameterFilter::Context.new(:api, controller_name, params[:action])
+  end
+
+  def render_errors(messages, severity = 'danger')
+    render :json => { :error => { :errors => { :base => messages }, :severity => severity } }, :status => :unprocessable_entity
+  end
+end

data/app/helpers/foreman_templates_helper.rb

@@ -0,0 +1,10 @@
+module ForemanTemplatesHelper
+  def edit_paths
+    Template.subclasses.reduce({}) do |memo, subclass|
+      memo.tap do |acc|
+        path_part = "#{subclass.name.underscore.pluralize}_path"
+        acc[subclass.name] = "#{Rails.application.routes.url_helpers.public_send(path_part)}/:id/edit"
+      end
+    end
+  end
+end

data/app/models/setting/template_sync.rb

@@ -1,5 +1,35 @@
 class Setting
   class TemplateSync < ::Setting
+    self.include_root_in_json = false
+
+    def self.common_stripped_names
+      %w(verbose repo branch dir filter negate)
+    end
+
+    def self.import_stripped_names
+      %w(prefix associate force)
+    end
+
+    def self.export_stripped_names
+      %w(metadata_export_mode)
+    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'),
@@ -16,6 +46,17 @@ class Setting
       }
     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
 
@@ -28,11 +69,11 @@ class Setting
           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 all imported templates should begin with'), "", 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 or export names matching this regex (case-insensitive; snippets are not filtered)'), nil, N_('Filter')),
+          self.set('template_sync_filter', N_('Import or export names matching this regex (case-insensitive; snippets are not filtered)'), '', N_('Filter')),
           self.set('template_sync_repo', N_('Target path to import and export. Different protocols can be used, e.g. /tmp/dir, git://example.com, https://example.com, ssh://example.com'), 'https://github.com/theforeman/community-templates.git', N_('Repo')),
           self.set('template_sync_negate', N_('Negate the prefix (for purging) / filter (for importing/exporting)'), false, N_('Negate')),
-          self.set('template_sync_branch', N_('Default branch in Git repo'), nil, 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 withou metadata'), 'refresh', N_('Metadata export mode'), nil, { :collection => Proc.new { self.metadata_export_mode_types } }),
+          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')),
         ].compact.each { |s| self.create! s.update(:category => "Setting::TemplateSync") }
@@ -54,5 +95,11 @@ class Setting
         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/app/services/foreman_templates/action.rb

@@ -2,6 +2,18 @@ module ForemanTemplates
   class Action
     delegate :logger, :to => :Rails
 
+    def self.git_repo_start_with
+      %w{http:// https:// git:// ssh:// git+ssh:// ssh+git://}
+    end
+
+    def self.file_repo_start_with
+      ['/']
+    end
+
+    def self.repo_start_with
+      git_repo_start_with + file_repo_start_with
+    end
+
     def self.setting_overrides
       %i(verbose prefix dirname filter repo negate branch)
     end
@@ -25,7 +37,7 @@ module ForemanTemplates
     end
 
     def git_repo?
-      @repo.start_with?('http://', 'https://', 'git://', 'ssh://', 'git+ssh://', 'ssh+git://')
+      @repo.start_with?(*self.class.git_repo_start_with)
     end
 
     def get_absolute_repo_path
@@ -33,9 +45,9 @@ module ForemanTemplates
     end
 
     def verify_path!(path)
-      msg = _("Using file-based synchronization, but couldn't access %s to export templates. ") % path
-      msg += _("Please check the access permissions/SELinux and make sure it is writable for the web application user account, typically 'foreman'.")
-      raise msg unless Dir.exist?(path)
+      msg = _("Using file-based synchronization, but couldn't access %s. ") % path
+      msg += _("Please check the access permissions/SELinux and make sure it is readable/writable for the web application user account, typically 'foreman'.")
+      raise PathAccessException, msg unless Dir.exist?(path)
     end
 
     private

data/app/services/foreman_templates/export_result.rb

@@ -1,6 +1,7 @@
 module ForemanTemplates
   class ExportResult
     attr_accessor :exported, :error, :warning
+    attr_reader :templates, :git_user, :branch, :repo
 
     def initialize(repo, branch, git_user)
       @repo = repo

data/app/services/foreman_templates/parse_result.rb

@@ -1,7 +1,7 @@
 module ForemanTemplates
   class ParseResult
     attr_accessor :name, :template
-    attr_reader :imported, :diff, :exception, :additional_errors
+    attr_reader :imported, :diff, :exception, :additional_errors, :template_file, :additional_info
 
     def initialize(template_file)
       @template_file = template_file.split('/').last
@@ -34,7 +34,7 @@ module ForemanTemplates
     end
 
     def matching_filter
-      generic_error "Skipping, 'name' filtered out based on 'filter' and 'negate' settings"
+      generic_info "Skipping, 'name' filtered out based on 'filter' and 'negate' settings"
     end
 
     def no_metadata_name
@@ -63,6 +63,13 @@ module ForemanTemplates
       self
     end
 
+    def generic_info(additional_msg)
+      @imported = false
+      @additional_info = additional_msg
+      Logging.logger('app').debug "Not importing #{@template_file}: #{additional_msg}"
+      self
+    end
+
     def name_error(exception, template_type)
       @imported = false
       @exception = exception
@@ -72,6 +79,7 @@ module ForemanTemplates
 
     def determine_result_diff
       return if @template.nil? || !@template.template_changed?
+
       template_was = @template.template_was
       template_is = @template.template
       @diff = calculate_diff(template_was, template_is)

data/app/services/foreman_templates/path_access_exception.rb

@@ -0,0 +1,4 @@
+module ForemanTemplates
+  class PathAccessException < ::StandardError
+  end
+end

data/app/services/foreman_templates/template_exporter.rb

@@ -27,6 +27,7 @@ module ForemanTemplates
     def export_to_git
       @dir = Dir.mktmpdir
       return @export_result if branch_missing?
+
       git_repo = Git.clone(@repo, @dir)
       logger.debug "cloned '#{@repo}' to '#{@dir}'"
 
@@ -67,15 +68,19 @@ module ForemanTemplates
 
     def dump_files!
       templates = templates_to_dump
-      templates.map do |template|
-        current_dir = get_dump_dir(template)
-        FileUtils.mkdir_p current_dir
-        filename = File.join(current_dir, get_template_filename(template))
-        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}"
+      begin
+        templates.map do |template|
+          current_dir = get_dump_dir(template)
+          FileUtils.mkdir_p current_dir
+          filename = File.join(current_dir, get_template_filename(template))
+          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
         end
+      rescue StandardError => e
+        raise PathAccessException, e.message
       end
       @export_result.add_exported_templates templates
     end

data/app/services/foreman_templates/template_importer.rb

@@ -7,7 +7,7 @@ module ForemanTemplates
     end
 
     def initialize(args = {})
-      super
+      super args
       @verbose = parse_bool(@verbose)
       @force = parse_bool(@force)
       @lock = parse_bool(@lock)
@@ -62,6 +62,7 @@ module ForemanTemplates
 
         begin
           next unless (template_type = template_model(metadata, parse_result))
+
           template = template_type.import_without_save(name, text, import_options)
           parse_result.template = template
           parse_result.determine_result_diff
@@ -128,6 +129,7 @@ module ForemanTemplates
     def name_matching_filter?(name)
       matching = name.match(/#{@filter}/i)
       return !matching if @negate
+
       matching
     end
 

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

@@ -0,0 +1,11 @@
+object @setting
+
+node do |setting|
+  { :name => setting.short_name }
+end
+
+attributes :id, :value, :description, :settings_type, :default, :full_name
+
+node do |setting|
+  { :selection => setting.selection }
+end

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

@@ -0,0 +1,20 @@
+<%= webpacked_plugins_js_for :foreman_templates %>
+<%= webpacked_plugins_css_for :foreman_templates %>
+
+<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 )%>

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

@@ -0,0 +1,9 @@
+object @result
+
+attributes :repo, :branch, :git_user, :error, :warning
+
+node(:result_action) { 'export' }
+
+child :templates => :templates do
+  extends 'ui_template_syncs/template_export_results'
+end

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

@@ -0,0 +1,9 @@
+object @parse_result
+
+attributes :repo, :branch
+
+node(:result_action) { 'import' }
+
+child :results => :templates do
+  extends 'ui_template_syncs/template_import_results'
+end

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

@@ -0,0 +1,11 @@
+object false
+
+child @results => :results do
+  child :import => :import do
+    extends "template_sync_settings/show"
+  end
+
+  child :export => :export do
+    extends "template_sync_settings/show"
+  end
+end

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

@@ -0,0 +1,19 @@
+object @template
+
+attributes :id, :snippet, :locked
+
+node(:kind) do |template|
+  template.template_kind.name if template.respond_to?(:template_kind) && template.template_kind
+end
+
+node(:class_name) do |template|
+  template.class.name
+end
+
+node(:humanized_class_name) do |template|
+  template.class.name.underscore.split('_').map { |part| part.capitalize }.join(' ')
+end
+
+node(:can_edit) do |template|
+  authorized_for(:auth_object => template, :authorizer => authorizer, :permission => "edit_#{template.class.name.underscore.pluralize}")
+end

data/app/views/ui_template_syncs/template_export_result.rabl

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

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

@@ -0,0 +1,3 @@
+collection @templates
+
+extends "ui_template_syncs/template_export_result"

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

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

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

@@ -0,0 +1,3 @@
+collection @templates
+
+extends "ui_template_syncs/template_import_result"

data/config/routes.rb

@@ -1,6 +1,18 @@
 Rails.application.routes.draw do
+  resources :template_syncs, :only => [:index]
+
+  resources :ui_template_syncs, :only => [] do
+    collection do
+      get 'sync_settings'
+      post 'import'
+      post 'export'
+    end
+  end
+
+  match '/template_syncs/*page' => 'template_syncs#index', :via => [:get]
+
   namespace :api, :defaults => { :format => 'json' } do
-    scope "(:apiv)", :module => :v2, :defaults => { :apiv => 'v2' }, :apiv => /v1|v2/, :constraints => ApiConstraints.new(:version => 2) do
+    scope "(:apiv)", :module => :v2, :defaults => { :apiv => 'v2' }, :apiv => /v2/, :constraints => ApiConstraints.new(:version => 2, :default => true) do
       resources :templates, :controller => :template, :only => [] do
         collection do
           post 'import'

data/lib/foreman_templates/engine.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'yaml'
 require 'diffy'
 require 'git'
+require 'rabl'
 
 module ForemanTemplates
   # Inherit from the Rails module of the parent app (Foreman), not the plugin.
@@ -13,21 +14,40 @@ module ForemanTemplates
       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')
+      end
+    end
+
     initializer 'foreman_templates.register_plugin', :before => :finisher_hook do
       Foreman::Plugin.register :foreman_templates do
-        requires_foreman '>= 1.18'
+        requires_foreman '>= 1.24'
 
         apipie_documented_controllers ["#{ForemanTemplates::Engine.root}/app/controllers/api/v2/*.rb"]
 
         security_block :templates do
           permission :import_templates, {
-            :"api/v2/template" => [:import]
+            :"api/v2/template" => [:import],
+            :ui_template_syncs => [:import]
           }, :resource_type => 'Template'
           permission :export_templates, {
-            :"api/v2/template" => [:export]
+            :"api/v2/template" => [:export],
+            :ui_template_syncs => [:export]
+          }, :resource_type => 'Template'
+          permission :view_template_syncs, {
+            :ui_template_syncs => [:sync_settings],
+            :template_syncs => [:index]
           }, :resource_type => 'Template'
         end
         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
       end
     end
   end

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '6.0.3'.freeze
+  VERSION = '7.0.0'.freeze
 end

data/lib/tasks/foreman_templates_tasks.rake

@@ -1,6 +1,5 @@
 require 'pp'
 # Tasks
-# rubocop:disable Metrics/BlockLength
 namespace :templates do
   desc 'Import templates according to settings'
   task :import => :environment do
@@ -72,7 +71,6 @@ namespace :templates do
     puts 'Clean up finished, you can now remove the plugin from your system'
   end
 end
-# rubocop:enable Metrics/BlockLength
 
 # Tests
 namespace :test do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_templates
 version: !ruby/object:Gem::Version
-  version: 6.0.3
+  version: 7.0.0
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -65,13 +65,27 @@ files:
 - Rakefile
 - app/controllers/api/v2/template_controller.rb
 - app/controllers/concerns/foreman/controller/parameters/template_params.rb
+- app/controllers/template_syncs_controller.rb
+- app/controllers/ui_template_syncs_controller.rb
+- app/helpers/foreman_templates_helper.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
 - app/services/foreman_templates/parse_result.rb
+- app/services/foreman_templates/path_access_exception.rb
 - app/services/foreman_templates/template_exporter.rb
 - app/services/foreman_templates/template_importer.rb
+- app/views/template_sync_settings/show.json.rabl
+- app/views/template_syncs/index.html.erb
+- app/views/ui_template_syncs/export.json.rabl
+- app/views/ui_template_syncs/import.json.rabl
+- app/views/ui_template_syncs/sync_settings.json.rabl
+- app/views/ui_template_syncs/template_attrs.json.rabl
+- app/views/ui_template_syncs/template_export_result.rabl
+- app/views/ui_template_syncs/template_export_results.json.rabl
+- app/views/ui_template_syncs/template_import_result.json.rabl
+- app/views/ui_template_syncs/template_import_results.json.rabl
 - config/routes.rb
 - lib/foreman_templates.rb
 - lib/foreman_templates/engine.rb
@@ -79,7 +93,7 @@ files:
 - lib/tasks/foreman_templates_tasks.rake
 homepage: https://github.com/theforeman/foreman_templates
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -97,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Template-syncing engine for Foreman