foreman_templates 3.1.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82ee874e71d9e9079295163e6047be8d000ec0da
-  data.tar.gz: dced21a45bdb893b228b1ac6656eecfaa38bee92
+  metadata.gz: 93bf3ba6264276231731d04135d565544b718db2
+  data.tar.gz: dbc56dbd3b5b992dc9537c043eea071e61085140
 SHA512:
-  metadata.gz: 4177cb40d2c6dfa46b6ce5435320b7b84d4d870846a59c82b48824a46d16466b92b16c38a7304cbf7ed48efc74fc421425bbaf99211e8751f2f737fdcb4c93f2
-  data.tar.gz: 6e06c16092fe06fd6913575e3dbf618658a4ea1c1723187ac57ce680a785b4407ce181235b4bdd15e3e322b848e28f753c196baf8f05a4d18702cd8ab86d7397
+  metadata.gz: d1887e56355692e0edc5a4961237763a7dca030bc3326ef10874ed8e51541b9809add0ac9c340dae9ec5634fb5cbd0d8e8eb339fde42b86ef91a7b93827eed97
+  data.tar.gz: d10d1091249e6ec67815f36903049c570c04fcfe109ba9520c2a173bc54667f6eaca8cd7027d1bceaa692fb959313b92b6d348a8071ce9f0b874ceb80c9528e3

data/README.md

@@ -21,7 +21,8 @@ You can get the develop branch of the plugin by specifying your Gemfile in this
 
 ## Configuration
 
-There is no UI configuration at this time.
+The plugin comes with settings providing sane defaults for import. You can change them under Administer > Settings, TemplateSync tab.
+These can be overriden for each import by passing options directly to a Rake task (see [Usage](https://github.com/theforeman/foreman_templates#usage) section for how to do that)
 
 ## Usage
 
@@ -42,7 +43,7 @@ template will be automatically associated with the OS
 #### Rake options
 
 * verbose   => Print extra information during the run [false]
-* repo      => Sync templates from a different Git repo [https://github.com/theforeman/community-templates]
+* repo      => Sync templates from a different repo [https://github.com/theforeman/community-templates]. Importing from git and file system is supported.
 * branch    => Branch in Git repo [_see note below_]
 * prefix    => The string all imported templates should begin with [Community]
 * dirname   => The directory within the git tree containing the templates [/]
@@ -53,6 +54,8 @@ The `branch` default will use *develop* if you're on Foreman-nightly; or the
 matching *1.X-stable* branch for your version of Foreman (if it exists); or
 finally it will remain on the default branch as a fallback.
 
+Passing any option to a Rake task overrides its default value from a corresponding Setting.
+
 #### Examples
 
 Just import all the templates from the default repo
@@ -71,6 +74,10 @@ Import templates from a subdirectory of a git repo:
 
     foreman-rake templates:sync repo="http://github.com/GregSutcliffe/community-templates" dirname='/subdir'
 
+Import templates from file system:
+
+    foreman-rake templates:sync repo="/path/to/my/templates"
+
 ### Purge
 
 This task deletes matching templates from the Foreman DB

data/app/models/setting/template_sync.rb

@@ -0,0 +1,54 @@
+class Setting::TemplateSync < Setting
+  def self.associate_types
+    {
+      'always' => _('Always'),
+      'new' => _('New'),
+      'never' => _('Never')
+    }
+  end
+
+  def self.metadata_export_mode_types
+    {
+      'refresh' => _('Refresh'),
+      'keep' => _('Keep'),
+      'remove' => _('Remove')
+    }
+  end
+
+
+  def self.load_defaults
+    return unless super
+
+    %w(template_sync_filter template_sync_branch).each { |s| Setting::BLANK_ATTRS << s }
+
+    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'), 'new', N_('Associate'), nil, { :collection => Proc.new { self.associate_types } }),
+        self.set('template_sync_prefix', N_('The string all imported templates should begin with'), "Community ", 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_repo', N_('Default Git repo to sync from'), '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 } })
+      ].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
+end

data/app/services/foreman_templates/action.rb

@@ -0,0 +1,56 @@
+module ForemanTemplates
+  class Action
+    delegate :logger, :to => :Rails
+
+    def self.setting_overrides
+      %i(verbose prefix dirname filter repo negate branch)
+    end
+
+    def method_missing(method, *args, &block)
+      if self.class.setting_overrides.include?(method)
+        instance_variable_get("@#{method}")
+      else
+        super
+      end
+    end
+
+    def repond_to_missing?(method, include_private = false)
+      self.class.setting_overrides.include?(method)
+    end
+
+    def initialize(args = {})
+      assign_attributes args
+    end
+
+    def get_default_branch(repo)
+      branch_names = repo.branches.map(&:name).uniq
+
+      # Always use develop on Foreman-nightly, if present, or else relevant stable branch
+      target = SETTINGS[:version].tag == 'develop' ? 'develop' : "#{SETTINGS[:version].short}-stable"
+      return target if branch_names.include?(target)
+
+      # stay on default branch as fallback
+      nil
+    end
+
+    def git_repo?
+      @repo.start_with?('http://', 'https://', 'git://')
+    end
+
+    def get_absolute_repo_path
+      File.expand_path(@repo)
+    end
+
+    def verify_path!(path)
+      raise "Using file-based synchronization, but couldn't find #{path}" unless Dir.exist?(path)
+    end
+
+    private
+
+    def assign_attributes(args = {})
+      self.class.setting_overrides.each do |attribute|
+        instance_variable_set("@#{attribute}", args[attribute.to_sym] || Setting["template_sync_#{attribute}".to_sym])
+      end
+    end
+  end
+end

data/app/services/foreman_templates/template_exporter.rb

@@ -0,0 +1,110 @@
+module ForemanTemplates
+  class TemplateExporter < Action
+    def self.setting_overrides
+      super + %i(metadata_export_mode)
+    end
+
+    def export!
+      if git_repo?
+        export_to_git
+      else
+        export_to_files
+      end
+
+      return true
+    end
+
+    def export_to_files
+      @dir = get_absolute_repo_path
+      verify_path!(@dir)
+      dump_files!
+    end
+
+    def export_to_git
+      @dir = Dir.mktmpdir
+
+      git_repo = Git.clone(@repo, @dir)
+      logger.debug "cloned #{@repo} to #{@dir}"
+      branch = @branch ? @branch : get_default_branch(git_repo)
+      # either checkout to existing or create a new one and checkout afterwards
+      if branch
+        if git_repo.is_branch?(branch)
+          git_repo.checkout(branch)
+        else
+          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
+        end
+      end
+
+      dump_files!
+      git_repo.add
+
+      status = git_repo.status
+      if status.added.any? || status.changed.any? || status.deleted.any? || status.untracked.any?
+        logger.debug "committing changes in cloned repo"
+        git_repo.commit "Templates export made by Foreman user #{User.current.try(:login) || User::ANONYMOUS_ADMIN}"
+
+        logger.debug "pushing to branch #{branch} at origin #{@repo}"
+        git_repo.push 'origin', branch
+      else
+        logger.debug 'no change detected, skipping the commit and push'
+      end
+    ensure
+      FileUtils.remove_entry_secure(@dir) if File.exist?(@dir)
+    end
+
+    def dump_files!
+      templates_to_dump.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
+    end
+
+    def get_template_filename(template)
+      template.name.downcase.tr(' ', '_') + '.erb'
+    end
+
+    def get_dump_dir(template)
+      kind = template.respond_to?(:template_kind) ? template.template_kind.try(:name) || 'snippet' : nil
+      template_class_dir = template.model_name.human.pluralize.downcase.tr(' ', '_')
+      template_class_dir += '_templates' if template_class_dir == 'partition_tables'
+      File.join(@dir, dirname.to_s, template_class_dir, kind.to_s)
+    end
+
+    def templates_to_dump
+      base = Template.all
+      if filter.present?
+        method = negate ? :reject : :select
+        base.public_send(method) { |template| template.name.match(/#{filter}/i) }
+      else
+        base
+      end
+    end
+
+    # * refresh - template.to_erb stripping existing metadata,
+    # * remove  - just template.template with stripping existing metadata,
+    # * keep    - taking the whole template.template
+    def export_method
+      case @metadata_export_mode
+        when 'refresh'
+          :to_erb
+        when 'remove'
+          :template_without_metadata
+        when 'keep'
+          :template
+        else
+          raise "Unknown metadata export mode #{@metadata_export_mode}"
+      end
+    end
+
+  end
+end

data/app/services/foreman_templates/template_importer.rb

@@ -2,20 +2,15 @@ class NoKindError < Exception; end
 class MissingKindError < Exception; end
 
 module ForemanTemplates
-  class TemplateImporter
-    delegate :logger, :to => :Rails
+  class TemplateImporter < Action
     attr_accessor :metadata, :name, :text
 
-    def initialize(args = {})
-      @verbose   = args[:verbose] || false
-      @associate = args[:associate] || 'new'
-      @prefix    = args[:prefix] || 'Community '
-      @dirname   = args[:dirname] || '/'
-      @filter    = args[:filter] || nil
-      @repo      = args[:repo] || 'https://github.com/theforeman/community-templates.git'
-      @negate    = args[:negate] || false
-      @branch    = args[:branch] || false
+    def self.setting_overrides
+      super + %i(associate)
+    end
 
+    def initialize(args = {})
+      super
       # Rake hands off strings, not booleans, and "false" is true...
       if @verbose.is_a?(String)
         @verbose = if @verbose == 'false'
@@ -27,6 +22,20 @@ module ForemanTemplates
     end
 
     def import!
+      if git_repo?
+        import_from_git
+      else
+        import_from_files
+      end
+    end
+
+    def import_from_files
+      @dir = get_absolute_repo_path
+      verify_path!(@dir)
+      return parse_files!
+    end
+
+    def import_from_git
       # Check out the community templates to a temp location
       @dir = Dir.mktmpdir
 
@@ -56,10 +65,12 @@ module ForemanTemplates
         filename = template.split('/').last
         title    = filename.split('.').first
         name     = metadata['name'] || title
-        name     = [@prefix, name].compact.join
-        next if @filter && !name.match(/#{@filter}/i)
-
-        raise MissingKindError unless metadata['kind']
+        name     = auto_prefix(name)
+        if @filter
+          matching = name.match(/#{@filter}/i)
+          matching = !matching if @negate
+          next if !matching
+        end
 
         begin
           # Expects a return of { :diff, :status, :result }
@@ -102,6 +113,10 @@ module ForemanTemplates
       result_lines
     end
 
+    def auto_prefix(name)
+      name.start_with?(@prefix) ? name : [@prefix, name].compact.join
+    end
+
     def calculate_diff(old, new)
       if old != new
         Diffy::Diff.new(old, new, :include_diff_info => true).to_s(:color)
@@ -110,17 +125,6 @@ module ForemanTemplates
       end
     end
 
-    def get_default_branch(repo)
-      branch_names = repo.branches.map(&:name).uniq
-
-      # Always use develop on Foreman-nightly, if present, or else relevant stable branch
-      target = SETTINGS[:version].tag == 'develop' ? 'develop' : "#{SETTINGS[:version].short}-stable"
-      return target if branch_names.include?(target)
-
-      # stay on default branch as fallback
-      nil
-    end
-
     def parse_metadata(text)
       # Pull out the first erb comment only - /m is for a multiline regex
       extracted = text.match(/<%\#[\t a-z0-9=:]*(.+?).-?%>/m)

data/lib/foreman_templates/engine.rb

@@ -9,9 +9,13 @@ 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', __FILE__) if (Setting.table_exists? rescue(false))
+    end
+
     initializer 'foreman_templates.register_plugin', :before => :finisher_hook do
       Foreman::Plugin.register :foreman_templates do
-        requires_foreman '>= 1.12'
+        requires_foreman '>= 1.14'
       end
     end
 

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '3.1.0'.freeze
+  VERSION = '4.0.1'.freeze
 end

data/lib/tasks/foreman_templates_tasks.rake

@@ -1,7 +1,10 @@
 # Tasks
 namespace :templates do
-  desc 'Synchronize templates from a git repo'
-  task :sync => :environment do
+  desc 'Import templates according to settings'
+  task :import => :environment do
+    if Rake.application.top_level_tasks.include?('templates:sync')
+      ActiveSupport::Deprecation.warn('templates:sync task has been renamed to templates:import and will be removed in a future version')
+    end
     # Available options:
     #* verbose   => Print extra information during the run [false]
     #* repo      => Sync templates from a different Git repo [https://github.com/theforeman/community-templates]
@@ -24,6 +27,24 @@ namespace :templates do
     puts results.join("\n")
   end
 
+  task :sync => :import
+
+  desc 'Export templates according to settings'
+  task :export => :environment do
+    ForemanTemplates::TemplateExporter.new({
+      verbose:   ENV['verbose'],
+      repo: ENV['repo'],
+      branch: ENV['branch'],
+      prefix: ENV['prefix'],
+      dirname: ENV['dirname'],
+      filter: ENV['filter'],
+      # associate: ENV['associate'],
+      metadata_export_mode: ENV['metadata_export_mode'],
+    }).export!
+
+    puts 'Export finished'
+  end
+
   desc 'Purge unwanted templates from foreman'
   task :purge => :environment do
     ForemanTemplates::TemplateImporter.new({

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_templates
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -52,6 +52,9 @@ files:
 - app/models/concerns/foreman_templates/provisioning_template_import.rb
 - app/models/concerns/foreman_templates/ptable_import.rb
 - app/models/concerns/foreman_templates/template_import.rb
+- app/models/setting/template_sync.rb
+- app/services/foreman_templates/action.rb
+- app/services/foreman_templates/template_exporter.rb
 - app/services/foreman_templates/template_importer.rb
 - lib/foreman_templates.rb
 - lib/foreman_templates/engine.rb