foreman_templates 6.0.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0c518e8c2822c6112f13654488a324eb9c2918a
-  data.tar.gz: b32fab2dde41371d5367c8d95db70fd2eb85d0ab
+  metadata.gz: b21b717ee579458b7a0f5b4ba6ccd17df7f2c100
+  data.tar.gz: dbb379a9262aff5e3cd244ae7146d5fe0b2ae2d5
 SHA512:
-  metadata.gz: b647c76ec12f0262f6dc95703487fee408ab094bb918b77f0df6141080cb90b3373cb7d4c27620488b75aa66c0d39450c033ed9ae9145e2cf023656189c3ee18
-  data.tar.gz: '0981be0b744c1a1573fdf0c8c7cec0f82357679cb3873d7ff7264a5af6cc1348e8b8d38da4b9ea5e073b82366e2a79ca284f8b0a4e4037a9951b816c5d692902'
+  metadata.gz: 10bde89659cba8d0f0d7374888a6b7bdc2ecf5e002f6c14e8db2f411ddd55e8a378faaea1dde53c2749cc051bbda77a9c12eb1db1b74bfa612f7321f7e0d59ce
+  data.tar.gz: e140926347dbf5299c2a5eb58de6708d61bf84c03c432d55c4d898ca38a243a68b28894a9d13c14e19291617a68f53b238a4078a26a2583a423a5e3511124e2c

data/README.md

@@ -2,7 +2,8 @@
 
 This plugin will sync the contents of the Foreman Community Templates
 [repository](https://github.com/theforeman/community-templates/) (or a git repo
-of your choice) to your local Foreman instance
+of your choice) to your local Foreman instance. It can also be used to sync
+local directory, therefore any other version control systems can be used.
 
 ## Installation
 
@@ -11,7 +12,7 @@ Foreman documentation for how to install Foreman plugins.
 
 The gem name is "foreman_templates".
 
-RPM users can install the "ruby193-rubygem-foreman_templates" or "rubygem-foreman_templates" packages.
+RPM users can install the "tfm-rubygem-foreman_templates" or "rubygem-foreman_templates" packages.
 
 ## Latest code
 
@@ -26,124 +27,12 @@ These can be overriden for each import by passing options directly to a Rake tas
 
 ## Usage
 
-### Import via Rake task
-
-The plugin provides a Rake task to import the templates. To use it, simply do
-
-    foreman-rake templates:sync
-
-This will create a set of templates named "Community ...." (or update them if they
-already exist). Audit history is preserved, but no comment is currently added for
-any changes made.
-
-The importer will attempt to figure out the OS and Release the template refers to. If
-this is a new template being created, and we can find a matching OS in Foreman, the
-template will be automatically associated with the OS
-
-#### Rake options
-
-* verbose   => Print extra information during the run [false]
-* 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 [/]
-* filter    => Import names matching this regex (case-insensitive; snippets are not filtered)
-* associate => Associate to OS, "always", when "new" or "never"  [new]
-* lock      => Lock imported templates [false]
-
-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
-
-    foreman-rake templates:sync
-
-Import all templates from a custom repo, with a different prefix
-
-    foreman-rake templates:sync repo="http://github.com/GregSutcliffe/community-templates" prefix="Greg"
-
-Import templates matching the name "Fedora"
-
-    foreman-rake templates:sync filter='fedora'
-
-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
-
-#### Rake options
-
-* prefix    => The string all templates to be purged should begin with [Community ]
-* negate    => Negate the search [false]
-* verbose   => Print extra information during the run [false]
-
-#### Examples
-
-Just purge all the templates the begin with 'Community '
-
-    foreman-rake templates:purge
-
-Purge all templates that begin with 'Oops '
-
-    foreman-rake templates:purge prefix='Oops '
-
-Purge all templates that do not begin with 'Community '
-
-    foreman-rake templates:purge negate=true
-
-### Import and Export via API
-
-There is an API (`/template/import/`) to initiate import from external
-repository. The API uses Foreman's authorization and authentication
-mechanisms. There is also an export action available.
-
-Unfortunately, there is no CLI support yet. For examples about how to
-use the API, [visit our documentation](https://theforeman.org/plugins/foreman_templates/5.0/index.html#5.API).
+For more detailed description, please see [the plugin manual](https://www.theforeman.org/plugins/foreman_templates/), select the approriate version
 
 ## Integration with other Foreman Plugins
 
-`templates` will start processing a template by looking for a metadata entry of
-`model`. If this is found, `templates` will call `import!` on this model.
-
-That means it's possible for a plugin to define it's own handling of text and
-metadata, relevant to the plugins own interests. The `import!` method will be
-sent 3 arguments - the `name` of the template, the `text` of the template, and
-a complete copy of the `metadata`.
-
-As a trivial example for a random plugin, suppose `foreman_nosuchplugin` has
-this code:
-
-```
-module ForemanNosuchplugin
-  class SomeTemplate
-    def self.import!(name, text, metadata)
-      File.open("/tmp/#{name}",'w') {|f| f.write text }
-    end
-  end
-end
-```
-
-Assuming a template had "model: SomeTemplate" in it's metadata, this would then
-get written to a file in `/tmp`.
-
-`templates` will expect the `import!` method to return a Hash, containing:
-
-* `:status` (boolean),
-* `:diff` (text, may be nil), or
-  * `:old` and `:new` (in which case this plugin will calculate the diff)
-* :result` (text, may be nil).
+This plugin now fully relies on core importing capabilities. That means models inheriting from Template class are supported. To customize import behavior,
+you can override `import_custom_data` in your inheritting class. See example at [remote execution plugin](https://github.com/theforeman/foreman_remote_execution/blob/v1.5.3/app/models/job_template.rb#L201-L217)
 
 ## Copyright
 

data/app/services/foreman_templates/action.rb

@@ -33,7 +33,9 @@ module ForemanTemplates
     end
 
     def verify_path!(path)
-      raise "Using file-based synchronization, but couldn't find #{path}" unless Dir.exist?(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)
     end
 
     private

data/app/services/foreman_templates/template_exporter.rb

@@ -128,7 +128,12 @@ module ForemanTemplates
     private
 
     def find_templates
-      @taxonomies.values.all?(&:empty?) ? Template.all : find_taxed_templates
+      @taxonomies.values.all?(&:empty?) ? find_all_templates : find_taxed_templates
+    end
+
+    # We have to go through subclasses because Template does not include Taxonomix
+    def find_all_templates
+      Template.subclasses.flat_map(&:all)
     end
 
     def find_taxed_templates

data/app/services/foreman_templates/template_importer.rb

@@ -47,8 +47,8 @@ module ForemanTemplates
     end
 
     def parse_files!
-      Dir["#{@dir}#{@dirname}/**/*.erb"].each do |template_file|
-        logger.debug 'Parsing: ' + template_file.gsub(/#{@dir}#{@dirname}/, '')
+      Dir["#{@dir}/#{@dirname}/**/*.erb"].each do |template_file|
+        logger.debug 'Parsing: ' + template_file.gsub(%r{#{@dir}\/#{@dirname}}, '')
         parse_result = ParseResult.new(template_file)
 
         text = File.read(template_file)
@@ -81,8 +81,8 @@ module ForemanTemplates
       { :force => @force,
         :associate => @associate,
         :lock => @lock,
-        :organization_params => @organizations,
-        :location_params => @locations }
+        :organization_params => @taxonomies[:organizations],
+        :location_params => @taxonomies[:locations] }
     end
 
     def template_model(metadata, parse_result)

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '6.0.1'.freeze
+  VERSION = '6.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_templates
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-17 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -77,7 +77,7 @@ files:
 - lib/foreman_templates/engine.rb
 - lib/foreman_templates/version.rb
 - lib/tasks/foreman_templates_tasks.rake
-homepage: http://github.com/theforeman/foreman_templates
+homepage: https://github.com/theforeman/foreman_templates
 licenses:
 - GPL-3
 metadata: {}