foreman_puppet 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 063aa962a333e59fdec2a1fb2d301eef47ae7006aebee443c48b0ec0d2311016
-  data.tar.gz: de47e4d6cc3f191b551e43e1fc5fd134e386129a2d85bdf61439103fa87dbc72
+  metadata.gz: 22506c7ebf919c047dded9e11b60b405e4a3e7c1456cd2d5125312ef156d3e7f
+  data.tar.gz: 5249dd5ee17f4627b159fb10952ce36d0b2f0bcee212df9d5cd82ba18898259c
 SHA512:
-  metadata.gz: 0b3a81c10ef66fab6dfa6e4ba9726e19080c5d8308a89eeb21232a3d35a0c8cd9ffc3b2722fbbc297a76a94c3c6470d82782a301bbf4589b37a0419461068ea6
-  data.tar.gz: d349b0fffba53ff1fb31c2e161a985785d47022325e3b5443c5885aba017a85fa7cae4d4234e65dee3b4be5980897ec789da9bdac21b2872abfa8afbbb7ca6df
+  metadata.gz: 99998691aeb424b63ceca8f140049677b3ba2c8a280c21972425b5f3efa1f4b024e75b67e386735dbb6024dfcd6d8bc4dbc3c226cef6e6d87f23c6872fd29c75
+  data.tar.gz: 5587134660de8b3a8bded2014307d5f515d7adcacfe6c32a90336289735ecf2123cc3b67f0231c6a1088bbe1ab11b56009cf0488449a61178e4be067bb330f0b

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/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

@@ -51,6 +51,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

@@ -62,6 +62,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

@@ -29,6 +29,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

@@ -28,6 +28,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/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

@@ -5,6 +5,7 @@ module ForemanPuppet
     include Foreman::Controller::Parameters::Hostgroup
     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 +70,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

data/app/helpers/foreman_puppet/environments_helper.rb

@@ -9,7 +9,7 @@ module ForemanPuppet
     end
 
     def environments_title_actions
-      title_actions import_proxy_select(hash_for_import_environments_environments_path),
+      title_actions import_proxy_select(hash_for_import_environments_environments_path.merge(engine: foreman_puppet)),
         button_group(new_link(_('Create Puppet Environment'), engine: foreman_puppet)),
         button_group(help_button)
     end

data/app/helpers/foreman_puppet/hosts_helper.rb

@@ -4,6 +4,7 @@ module ForemanPuppet
       multiple_actions_provider :puppet_host_multiple_actions
       # otherwise registered twice
       overview_buttons_provider :puppet_host_overview_buttons if ForemanPuppet.extracted_from_core?
+      overview_fields_provider :puppet_host_overview_fields if ForemanPuppet.extracted_from_core?
     end
 
     def puppet_host_multiple_actions
@@ -28,5 +29,19 @@ module ForemanPuppet
       end
       buttons
     end
+
+    def puppet_host_overview_fields(host)
+      fields = []
+      if host.environment.present?
+        fields << {
+          field: [
+            _('Puppet Environment'),
+            link_to(host.puppet.environment, hosts_path(search: "environment = #{host.puppet.environment}")),
+          ],
+          priority: 650,
+        }
+      end
+      fields
+    end
   end
 end

data/app/helpers/foreman_puppet/puppetclass_lookup_keys_helper.rb

@@ -2,8 +2,8 @@ module ForemanPuppet
   module PuppetclassLookupKeysHelper
     def puppetclass_lookup_keys_breadcrumbs
       breadcrumbs(resource_url: api_smart_class_parameters_path,
-                  name_field: 'parameter',
-                  switcher_item_url: '/puppetclass_lookup_keys/:id-:name/edit')
+        name_field: 'parameter',
+        switcher_item_url: '/puppetclass_lookup_keys/:id-:name/edit')
     end
 
     # ------ Host(group) Form Helpers -----

data/app/models/concerns/foreman_puppet/extensions/host.rb

@@ -6,18 +6,23 @@ module ForemanPuppet
       included do
         prepend PrependedMethods
 
-        env_assoc = reflect_on_association(:environment)
-        env_assoc&.instance_variable_set(:@class_name, 'ForemanPuppet::Environment')
+        unless ForemanPuppet.extracted_from_core?
+          env_assoc = reflect_on_association(:environment)
+          env_assoc&.instance_variable_set(:@class_name, 'ForemanPuppet::Environment')
+
+          host_classes_assoc = reflect_on_association(:host_classes)
+          host_classes_assoc&.instance_variable_set(:@class_name, 'ForemanPuppet::HostClass')
+        end
 
         include_in_clone puppet: %i[config_groups host_config_groups host_classes]
 
         scoped_search relation: :environment, on: :name, complete_value: true, rename: :environment
         scoped_search relation: :puppetclasses, on: :name, complete_value: true, rename: :class, only_explicit: true, operators: ['= ', '~ '],
-                      ext_method: :search_by_deprecated_class
+          ext_method: :search_by_deprecated_class
         scoped_search relation: :puppetclasses, on: :name, complete_value: true, rename: :puppetclass, only_explicit: true, operators: ['= ', '~ '],
-                      ext_method: :search_by_puppetclass
+          ext_method: :search_by_puppetclass
         scoped_search relation: :config_groups, on: :name, complete_value: true, rename: :config_group, only_explicit: true, operators: ['= ', '~ '],
-                      ext_method: :search_by_config_group
+          ext_method: :search_by_config_group
       end
 
       class_methods do
@@ -61,6 +66,12 @@ module ForemanPuppet
       end
 
       module PrependedMethods
+        # TODO: we can drop this once extracted_from_core?
+        def validate_association_taxonomy(association_name)
+          return if association_name.to_sym == :environment
+          super
+        end
+
         def provisioning_template(opts = {})
           opts[:environment_id] ||= puppet&.environment_id
           super(opts)
@@ -70,9 +81,9 @@ module ForemanPuppet
           kinds = template_kinds(provisioning)
           kinds.map do |kind|
             ProvisioningTemplate.find_template({ kind: kind.name,
-                                                 operatingsystem_id: operatingsystem_id,
-                                                 hostgroup_id: hostgroup_id,
-                                                 environment_id: puppet&.environment_id })
+              operatingsystem_id: operatingsystem_id,
+              hostgroup_id: hostgroup_id,
+              environment_id: puppet&.environment_id })
           end.compact
         end
 

data/app/models/concerns/foreman_puppet/extensions/hostgroup.rb

@@ -17,11 +17,11 @@ module ForemanPuppet
         scoped_search relation: :environment, on: :name, complete_value: true, rename: :environment, only_explicit: true
         scoped_search relation: :puppetclasses, on: :name, complete_value: true, rename: :class, only_explicit: true, operators: ['= ', '~ ']
         scoped_search relation: :config_groups, on: :name,
-                      complete_value: true,
-                      rename: :config_group,
-                      only_explicit: true,
-                      operators: ['= ', '~ '],
-                      ext_method: :search_by_config_group
+          complete_value: true,
+          rename: :config_group,
+          only_explicit: true,
+          operators: ['= ', '~ '],
+          ext_method: :search_by_config_group
       end
 
       # Temporary, can be ordinary class_methods do, when removed from core

data/app/models/concerns/foreman_puppet/extensions/provisioning_template.rb

@@ -6,11 +6,11 @@ module ForemanPuppet
       included do
         if ForemanPuppet.extracted_from_core?
           has_many :environments, through: :template_combinations
-          before_destroy EnsureNotUsedBy.new(:environments)
+          before_destroy ActiveRecord::Base::EnsureNotUsedBy.new(:environments)
 
           scoped_search relation: :environments, on: :name, rename: :environment, complete_value: true
 
-          class << base
+          class << self
             prepend PrependedClassMethods
           end
 

data/app/models/concerns/foreman_puppet/extensions/report.rb

@@ -5,6 +5,24 @@ module ForemanPuppet
 
       included do
         has_one :environment, through: :host
+
+        # for cases when class already inherit before we apply the patch
+        self.class.subclasses.each do |subclass|
+          add_environment_search_to(subclass)
+        end
+      end
+
+      class_methods do
+        def inherited(child)
+          add_environment_search_to(child)
+          super
+        end
+
+        def add_environment_search_to(klass)
+          klass.instance_eval do
+            scoped_search relation: :environment, on: :name, complete_value: true, rename: :environment
+          end
+        end
       end
     end
   end

data/app/models/concerns/foreman_puppet/extensions/template_combination.rb

@@ -5,7 +5,7 @@ module ForemanPuppet
 
       included do
         if ForemanPuppet.extracted_from_core?
-          belongs_to :environment
+          belongs_to :environment, class_name: 'ForemanPuppet::Environment'
 
           validates :environment_id, uniqueness: { scope: %i[hostgroup_id provisioning_template_id] }