foreman_puppet 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 063aa962a333e59fdec2a1fb2d301eef47ae7006aebee443c48b0ec0d2311016
-  data.tar.gz: de47e4d6cc3f191b551e43e1fc5fd134e386129a2d85bdf61439103fa87dbc72
+  metadata.gz: 49e644faeeffa930e09b12d75395777a23aa7bec00b9dbdf16eeed14b3d2e9bc
+  data.tar.gz: 9da4592a03b0fc3431a8f3c12c8bd046782544b5df29419949471b5919388c66
 SHA512:
-  metadata.gz: 0b3a81c10ef66fab6dfa6e4ba9726e19080c5d8308a89eeb21232a3d35a0c8cd9ffc3b2722fbbc297a76a94c3c6470d82782a301bbf4589b37a0419461068ea6
-  data.tar.gz: d349b0fffba53ff1fb31c2e161a985785d47022325e3b5443c5885aba017a85fa7cae4d4234e65dee3b4be5980897ec789da9bdac21b2872abfa8afbbb7ca6df
+  metadata.gz: 2e40390e1c1b70276056a455672397f0425c48fa71dda42cdf814f3718b3869f6b59ab3fa0250acbb5699754a9bdc7ef64640aef07e0cf1388e9b5b4ebc4fe27
+  data.tar.gz: c6a7e53a32381af7bef757d359e14e5828b3a3536e31f9291fda67af175ca637e971d605c302e479f49bf2e09c9ce8cdcf22494bcd28afe2244f19bbe429f053

data/README.md

@@ -1,19 +1,74 @@
 # ForemanPuppet
 
-Adds Puppet External node classification funcionality for [Foreman](theforeman.org).
+[![Gem Version](https://img.shields.io/gem/v/foreman_puppet.svg)](https://rubygems.org/gems/foreman_puppet)
+[![GPL License](https://img.shields.io/github/license/theforeman/foreman_puppet.svg)](https://github.com/theforeman/foreman_puppet/blob/master/LICENSE)
+
+This plugin adds Puppet External node classification functionality to [Foreman](https://theforeman.org).
+
+* Website: [theforeman.org](http://theforeman.org)
+* Support: [Foreman support](http://theforeman.org/support.html)
+
+## Features
+
+* Puppet dashboards
+* Puppet
+  * Environments
+  * Classes
+  * Config groups
+  * Smart Class parameters
+* Host / Hostgroup
+  * Classes assignment
+  * Environment assignment
+  * Puppet proxy assignment
+* Puppet ENC (external node classifier)
+* Smartproxy Puppet status/tab
+* Template hostgroup / environment
+
+Some features will remain in core:
+
+* PuppetCA
+* Report/Fact parsing
+
+## Compatibility
+
+Foreman 3.0 will be the first release where the Puppet functionality is mostly extracted.
+Therefore, this plugin is only required for 3.0 and onwards.
+You can install it on Foreman 2.5 to prepare for the Foreman update.
+
+|Foreman version|Plugin version|Notes                                     |
+|---------------|--------------|------------------------------------------|
+| >= 3.0        | ~> 1.0       | Required                                 |
+| >= 2.5        | ~> 0.1       | Optional; replaces Core features         |
+| < 2.5         | -            | Not supported (functionality is in Core) |
 
 ## Installation
 
-See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
+See [How_to_Install_a_Plugin](https://theforeman.org/plugins/#2.Installation)
 for how to install Foreman plugins
 
+You can manually install this plugin using:
+
+```sh
+# On RedHat/CentOS
+yum install tfm-rubygem-foreman_puppet
+
+# On Debian
+apt install ruby-foreman-puppet
+```
+
 ## Usage
 
-*Usage here*
+The usage is identical to the prior core functionality:
+
+* Import *environments* and *classes* from a Smartproxy
+* Optionally define *Smart Class* parameters
+* Assign *environment* and *classes* to *Hosts / Hostgroups*
+* Use the *Puppet ENC* on your Puppetserver(s) to query Foreman
 
-## TODO
+## Problems
 
-*Todo list here*
+Please feel free to open a [new Github issue](https://github.com/theforeman/foreman_puppet/issues/new)
+if you encounter any bugs/issues using this plugin.
 
 ## Contributing
 
@@ -21,7 +76,7 @@ Fork and send a Pull Request. Thanks!
 
 ## Copyright
 
-Copyright (c) *year* *your name*
+Copyright (c) *2021* *The Foreman developers*
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -35,4 +90,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

data/app/controllers/concerns/foreman_puppet/environments_import.rb

@@ -16,7 +16,7 @@ module ForemanPuppet
       end
 
       if !@changed['new'].empty? || !@changed['obsolete'].empty? || !@changed['updated'].empty?
-        render 'common/_puppetclasses_or_envs_changed'
+        render 'foreman_puppet/common/_puppetclasses_or_envs_changed'
       else
         info_message = _('No changes to your environments detected')
 

data/app/controllers/concerns/foreman_puppet/extensions/api_base_controller.rb

@@ -0,0 +1,28 @@
+module ForemanPuppet
+  module Extensions
+    module ApiBaseController
+      extend ActiveSupport::Concern
+
+      included do
+        prepend PatchMethods
+
+        before_action :prepare_views
+      end
+
+      def prepare_views
+        prepend_view_path ForemanPuppet::Engine.root.join('app', 'prepend_views')
+      end
+
+      module PatchMethods
+        def resource_name(resource = controller_name)
+          case resource
+          when 'environment'
+            'foreman_puppet/environment'
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/foreman_puppet/extensions/api_template_combinations_controller.rb

@@ -6,7 +6,7 @@ module ForemanPuppet
       included do
         if ForemanPuppet.extracted_from_core?
           apipie_update_methods(%i[index create show update]) do
-            param :environment_id, String, desc: N_('ID of environment')
+            param :environment_id, nil, desc: N_('ID of environment')
           end
         end
 

data/app/controllers/concerns/foreman_puppet/extensions/hostgroups_controller_extensions.rb

@@ -42,7 +42,7 @@ module ForemanPuppet
         def puppetclass_parameters
           ::Taxonomy.as_taxonomy @organization, @location do
             render partial: 'foreman_puppet/puppetclasses/classes_parameters',
-                   locals: { obj: refresh_hostgroup }
+              locals: { obj: refresh_hostgroup }
           end
         end
 

data/app/controllers/concerns/foreman_puppet/extensions/hosts_controller_extensions.rb

@@ -104,7 +104,7 @@ module ForemanPuppet
         rescue StandardError => e
           Foreman::Logging.exception("Failed to generate external nodes for #{@host}", e)
           render plain: _('Unable to generate output, Check log files'),
-                 status: :precondition_failed
+            status: :precondition_failed
         end
       end
       # rubocop:enable Naming/MethodName

data/app/controllers/concerns/foreman_puppet/extensions/parameters_host.rb

@@ -34,16 +34,9 @@ module ForemanPuppet
         end
 
         def process_deprecated_environment_params!(params)
-          env_id = env_name = env = nil
-          if ForemanPuppet.extracted_from_core?
-            env_id = params.delete(:environment_id)
-            env_name = params.delete(:environment_name)
-            env = params.delete(:environment)
-          else
-            env_id = params[:environment_id]
-            env_name = params[:environment_name]
-            env = params[:environment]
-          end
+          env_id = params.delete(:environment_id)
+          env_name = params.delete(:environment_name)
+          env = params.delete(:environment)
 
           return unless env_id || env_name || env
           ::Foreman::Deprecation.api_deprecation_warning('param host[environment_*] has been deprecated in favor of host[puppet_attributes][environment_*]')

data/app/controllers/concerns/foreman_puppet/parameters/puppetclass_lookup_key.rb

@@ -7,8 +7,8 @@ module ForemanPuppet
       def puppetclass_lookup_key_params_filter
         Foreman::ParameterFilter.new(ForemanPuppet::PuppetclassLookupKey).tap do |filter|
           filter.permit environments: [], environment_ids: [], environment_names: [],
-                        environment_classes: [], environment_classes_ids: [], environment_classes_names: [],
-                        param_classes: [], param_classes_ids: [], param_classes_names: []
+            environment_classes: [], environment_classes_ids: [], environment_classes_names: [],
+            param_classes: [], param_classes_ids: [], param_classes_names: []
           filter.permit_by_context :required, nested: true
           filter.permit_by_context :id, ui: false, api: false, nested: true
 

data/app/controllers/foreman_puppet/api/v2/config_groups_controller.rb

@@ -1,9 +1,13 @@
 module ForemanPuppet
   module Api
     module V2
-      class ConfigGroupsController < BaseController
+      class ConfigGroupsController < ::ForemanPuppet::Api::V2::PuppetBaseController
         include ForemanPuppet::Parameters::ConfigGroup
 
+        resource_description do
+          api_base_url '/foreman_puppet/api'
+        end
+
         wrap_parameters ConfigGroup, include: config_group_params_filter.accessible_attributes(parameter_filter_context)
 
         before_action :find_resource, only: %i[show update destroy]
@@ -51,6 +55,10 @@ module ForemanPuppet
         def destroy
           process_response @config_group.destroy
         end
+
+        def resource_class
+          ForemanPuppet::ConfigGroup
+        end
       end
     end
   end

data/app/controllers/foreman_puppet/api/v2/environments_controller.rb

@@ -1,12 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class EnvironmentsController < BaseController
+      class EnvironmentsController < ::ForemanPuppet::Api::V2::PuppetBaseController
         include ForemanPuppet::Api::ImportPuppetclassesCommonController
         include ForemanPuppet::Parameters::Environment
 
         resource_description do
-          api_version '2'
           api_base_url '/foreman_puppet/api'
         end
 
@@ -62,6 +61,10 @@ module ForemanPuppet
           process_response @environment.destroy
         end
 
+        def resource_class
+          ForemanPuppet::Environment
+        end
+
         private
 
         def action_permission

data/app/controllers/foreman_puppet/api/v2/host_classes_controller.rb

@@ -1,7 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class HostClassesController < V2::BaseController
+      class HostClassesController < ::ForemanPuppet::Api::V2::PuppetBaseController
+        resource_description do
+          api_base_url '/foreman_puppet/api'
+        end
+
         before_action :find_host, only: %i[index create destroy]
         before_action :find_puppetclass, only: %i[create destroy]
 
@@ -29,6 +33,10 @@ module ForemanPuppet
           process_response @host_class.destroy_all
         end
 
+        def resource_class
+          ForemanPuppet::HostClass
+        end
+
         private
 
         # overwrite resource_name so it's host and and not host_class, since we want to return @host

data/app/controllers/foreman_puppet/api/v2/hostgroup_classes_controller.rb

@@ -1,7 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class HostgroupClassesController < V2::BaseController
+      class HostgroupClassesController < ::ForemanPuppet::Api::V2::PuppetBaseController
+        resource_description do
+          api_base_url '/foreman_puppet/api'
+        end
+
         before_action :find_hostgroup, only: %i[index create destroy]
 
         api :GET, '/hostgroups/:hostgroup_id/puppetclass_ids/', N_('List all Puppet class IDs for host group')
@@ -28,6 +32,10 @@ module ForemanPuppet
           process_response @hostgroup_class.destroy_all
         end
 
+        def resource_class
+          ForemanPuppet::HostgroupClass
+        end
+
         private
 
         def find_hostgroup

data/app/controllers/foreman_puppet/api/v2/override_values_controller.rb

@@ -1,11 +1,10 @@
 module ForemanPuppet
   module Api
     module V2
-      class OverrideValuesController < LookupsCommonController
+      class OverrideValuesController < ::ForemanPuppet::Api::V2::PuppetLookupsCommonController
         include Foreman::Controller::Parameters::LookupValue
 
         resource_description do
-          api_version '2'
           api_base_url '/foreman_puppet/api'
         end
 

data/app/controllers/foreman_puppet/api/v2/{base_controller.rb → puppet_base_controller.rb}

@@ -1,10 +1,9 @@
 module ForemanPuppet
   module Api
     module V2
-      class BaseController < ::Api::V2::BaseController
+      class PuppetBaseController < ::Api::V2::BaseController
         resource_description do
-          api_version '2'
-          api_base_url '/foreman_puppet/api'
+          api_version 'v2'
         end
 
         before_action :show_deprecation_for_core_routes
@@ -12,7 +11,7 @@ module ForemanPuppet
         protected
 
         def show_deprecation_for_core_routes
-          return if request.path.starts_with?('/foreman_puppet')
+          return if request.path.starts_with?('/foreman_puppet') || request.path.starts_with?('/api/smart_proxies')
           Foreman::Deprecation.api_deprecation_warning(
             format(
               '/api/v2/%{controller} API endpoints are deprecated, please use /foreman_puppet/api/v2/%{controller} instead',

data/app/controllers/foreman_puppet/api/v2/{lookups_common_controller.rb → puppet_lookups_common_controller.rb}

@@ -1,7 +1,11 @@
 module ForemanPuppet
   module Api
     module V2
-      class LookupsCommonController < ::Api::V2::BaseController
+      class PuppetLookupsCommonController < ::Api::V2::BaseController
+        resource_description do
+          api_version 'v2'
+        end
+
         before_action :find_environment, if: :environment_id?
         before_action :find_puppetclass, if: :puppetclass_id?
         before_action :find_host, if: :host_id?
@@ -45,7 +49,7 @@ module ForemanPuppet
 
         def find_smart_class_parameter
           id = params.key?('smart_class_parameter_id') ? params['smart_class_parameter_id'] : params['id']
-          @smart_class_parameter = PuppetclassLookupKey.authorized(:view_external_parameters).smart_class_parameters.find_by(id: id.to_i) if id.to_i > 0
+          @smart_class_parameter = PuppetclassLookupKey.authorized(:view_external_parameters).smart_class_parameters.find_by(id: id.to_i) if id.to_i.positive?
           @smart_class_parameter ||= begin
             puppet_cond = { 'environment_classes.puppetclass_id' => @puppetclass.id } if @puppetclass
             env_cond = { 'environment_classes.environment_id' => @environment.id } if @environment

data/app/controllers/foreman_puppet/api/v2/puppetclasses_controller.rb

@@ -1,9 +1,13 @@
 module ForemanPuppet
   module Api
     module V2
-      class PuppetclassesController < BaseController
+      class PuppetclassesController < ::ForemanPuppet::Api::V2::PuppetBaseController
         include ForemanPuppet::Parameters::Puppetclass
 
+        resource_description do
+          api_base_url '/foreman_puppet/api'
+        end
+
         before_action :find_optional_nested_object
         before_action :find_resource, only: %w[show update destroy]
 

data/app/controllers/foreman_puppet/api/v2/smart_class_parameters_controller.rb

@@ -1,11 +1,10 @@
 module ForemanPuppet
   module Api
     module V2
-      class SmartClassParametersController < ForemanPuppet::Api::V2::LookupsCommonController
+      class SmartClassParametersController < ::ForemanPuppet::Api::V2::PuppetLookupsCommonController
         include ForemanPuppet::Parameters::PuppetclassLookupKey
 
         resource_description do
-          api_version '2'
           api_base_url '/foreman_puppet/api'
         end
 

data/app/controllers/foreman_puppet/config_groups_controller.rb

@@ -42,5 +42,9 @@ module ForemanPuppet
         process_error
       end
     end
+
+    def resource_class
+      model_of_controller
+    end
   end
 end

data/app/controllers/foreman_puppet/puppet_smart_proxies_controller.rb

@@ -16,6 +16,10 @@ module ForemanPuppet
       process_ajax_error e
     end
 
+    def resource_class
+      ::SmartProxy
+    end
+
     private
 
     def find_status

data/app/controllers/foreman_puppet/puppetclass_lookup_keys_controller.rb

@@ -9,11 +9,11 @@ module ForemanPuppet
       environment_classes = EnvironmentClass.where(puppetclass_lookup_key_id: @lookup_keys.map(&:id)).select(:puppetclass_id, :puppetclass_lookup_key_id).distinct.preload(:puppetclass)
       puppetclass_ids = environment_classes.map(&:puppetclass_id).uniq
       @puppetclass_authorizer = Authorizer.new(User.current, collection: puppetclass_ids)
-      @lookup_keys_to_class = Hash[environment_classes.map { |environment_class| [environment_class.puppetclass_lookup_key_id, environment_class.puppetclass] }]
+      @lookup_keys_to_class = environment_classes.map { |environment_class| [environment_class.puppetclass_lookup_key_id, environment_class.puppetclass] }.to_h
     end
 
     def resource_class
-      ForemanPuppet::PuppetclassLookupKey
+      model_of_controller
     end
 
     private

data/app/controllers/foreman_puppet/puppetclasses_controller.rb

@@ -3,8 +3,11 @@ module ForemanPuppet
     include Foreman::Controller::AutoCompleteSearch
     include Foreman::Controller::Parameters::Host
     include Foreman::Controller::Parameters::Hostgroup
+    include ForemanPuppet::Extensions::ParametersHost
+    include ForemanPuppet::Extensions::ParametersHostgroup
     include ForemanPuppet::Parameters::Environment
     include ForemanPuppet::Parameters::Puppetclass
+    include ForemanPuppet::EnvironmentsImport
 
     before_action :find_resource, only: %i[edit update destroy override]
     before_action :setup_search_options, only: :index
@@ -69,8 +72,8 @@ module ForemanPuppet
     def parameters
       puppetclass = Puppetclass.find(params[:id])
       render partial: 'foreman_puppet/puppetclasses/class_parameters',
-             locals: { puppetclass: puppetclass,
-                       obj: find_host_or_hostgroup }
+        locals: { puppetclass: puppetclass,
+                  obj: find_host_or_hostgroup }
     end
 
     def resource_class
@@ -92,11 +95,11 @@ module ForemanPuppet
           @obj.type = 'Host::Managed'
         end
         # puppetclass_ids and config_group_ids need to be removed so they don't cause automatic insertsgroup
-        @obj.attributes = host_params('host')
+        @obj.attributes = host_params('host').tap { |params| strip_relation_ids(params) }
       elsif params['hostgroup']
         # hostgroup.id is assigned to params['host_id'] by host_edit.js#load_puppet_class_parameters
         @obj = Hostgroup.find(host_id)
-        @obj.attributes = hostgroup_params('hostgroup')
+        @obj.attributes = hostgroup_params('hostgroup').tap { |params| strip_relation_ids(params) }
       end
       @obj
     end
@@ -109,5 +112,10 @@ module ForemanPuppet
         super
       end
     end
+
+    def strip_relation_ids(params)
+      return unless params[:puppet_attributes]
+      params[:puppet_attributes].except!(:puppetclass_ids, :config_group_ids)
+    end
   end
 end