foreman_puppet 2.0.0.alpha.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b910e24e11c9bd100021c5b87cc45b03eab68bc68260985f90d3510496d016
-  data.tar.gz: '08fa8d3c7bdf23231daf2e14332f68be4d2a79fe33195260de1c1b276924c2de'
+  metadata.gz: c850f32331462f52510a8e895c149eb470e9982ad819de78529c38c888ab549c
+  data.tar.gz: 81460cb582b62baa3f96083c3573a99607a9b2619d2a20c31df4f41da48677c6
 SHA512:
-  metadata.gz: cb6a6d40b42d741a4f4010aa81b9bbfa7e0b330473637036522d0a8d7e2fa983cee353ee0a59c3eacd1a64314d3edb17dfa29ee95adb7d47f08938f2380e822a
-  data.tar.gz: 1e2f6b9ac9b996cbb368612dfb22d3adc03c89201d3d1931ca7920baf58090769160ded784c5094a3cfd1043ba22bf93b2926ff6de0075294630a7376179be6b
+  metadata.gz: f0b20469d894d6a1cc2e8c6f486ef5f09dd9c04742c0be684f68846fe930536a813ee404fb30af2ba0ae9031df6c2c00ea3a4af0233be5b24640b81d2a58d031
+  data.tar.gz: 16cab8e0431a72b04795046e4e66ca67a029247f4bf182a7a3f36e7ec8f2c5d45a1ae3db4ce8d96a48869a698eebec284eef6d9c0290d10270c41ab19789d0ee

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

@@ -14,12 +14,7 @@ module ForemanPuppet
       module PatchedClassMethods
         def host_params_filter
           super.tap do |filter|
-            filter.permit :environment_id, :environment_name, :environment,
-              config_groups: [], config_group_ids: [], config_group_names: [],
-              puppetclasses: [], puppetclass_ids: [], puppetclass_names: []
-
-            # TODO: bring to core - this is what facets should do, but does not
-            filter.permit(puppet_attributes: {})
+            add_host_puppet_params_filter(filter)
           end
         end
       end
@@ -27,40 +22,54 @@ module ForemanPuppet
       module PatchedMethods
         def host_params(*attrs)
           params = super(*attrs)
-
-          process_deprecated_environment_params!(params)
-          process_deprecated_attributes!(params)
+          process_deprecated_puppet_params!(params)
           params
         end
+      end
 
-        def process_deprecated_environment_params!(params)
-          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_*]')
+      class_methods do
+        def add_host_puppet_params_filter(filter)
+          filter.permit :environment_id, :environment_name, :environment,
+            config_groups: [], config_group_ids: [], config_group_names: [],
+            puppetclasses: [], puppetclass_ids: [], puppetclass_names: []
 
-          params[:puppet_attributes] ||= {}
-          params[:puppet_attributes][:environment_id] ||= env_id if env_id
-          params[:puppet_attributes][:environment_name] ||= env_name if env_name
-          params[:puppet_attributes][:environment] ||= env if env
+          # TODO: bring to core - this is what facets should do, but does not
+          filter.permit(puppet_attributes: {})
         end
+      end
+
+      def process_deprecated_puppet_params!(params, top_level_hash = controller_name.singularize)
+        process_deprecated_environment_params!(params, top_level_hash)
+        process_deprecated_attributes!(params, top_level_hash)
+      end
 
-        def process_deprecated_attributes!(params)
-          %w[puppetclass config_group].each do |relation|
-            ids = params.delete("#{relation}_ids".to_sym)
-            names = params.delete("#{relation}_names".to_sym)
-            plains = params.delete(relation.pluralize.to_sym)
+      def process_deprecated_environment_params!(params, top_level_hash = 'host')
+        env_id = params.delete(:environment_id)
+        env_name = params.delete(:environment_name)
+        env = params.delete(:environment)
 
-            next unless ids || names || plains
-            ::Foreman::Deprecation.api_deprecation_warning("param host[#{relation}_*] has been deprecated in favor of host[puppet_attributes][#{relation}_*]")
+        return unless env_id || env_name || env
+        ::Foreman::Deprecation.api_deprecation_warning("param #{top_level_hash}[environment_*] has been deprecated in favor of #{top_level_hash}[puppet_attributes][environment_*]")
 
-            params[:puppet_attributes] ||= {}
-            params[:puppet_attributes]["#{relation}_ids".to_sym] ||= ids if ids
-            params[:puppet_attributes]["#{relation}_names".to_sym] ||= names if names
-            params[:puppet_attributes][relation.pluralize.to_sym] ||= plains if plains
-          end
+        params[:puppet_attributes] ||= {}
+        params[:puppet_attributes][:environment_id] ||= env_id if env_id
+        params[:puppet_attributes][:environment_name] ||= env_name if env_name
+        params[:puppet_attributes][:environment] ||= env if env
+      end
+
+      def process_deprecated_attributes!(params, top_level_hash = 'host')
+        %w[puppetclass config_group].each do |relation|
+          ids = params.delete("#{relation}_ids".to_sym)
+          names = params.delete("#{relation}_names".to_sym)
+          plains = params.delete(relation.pluralize.to_sym)
+
+          next unless ids || names || plains
+          ::Foreman::Deprecation.api_deprecation_warning("param #{top_level_hash}[#{relation}_*] has been deprecated in favor of #{top_level_hash}[puppet_attributes][#{relation}_*]")
+
+          params[:puppet_attributes] ||= {}
+          params[:puppet_attributes]["#{relation}_ids".to_sym] ||= ids if ids
+          params[:puppet_attributes]["#{relation}_names".to_sym] ||= names if names
+          params[:puppet_attributes][relation.pluralize.to_sym] ||= plains if plains
         end
       end
     end

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

@@ -14,12 +14,7 @@ module ForemanPuppet
       module PatchedClassMethods
         def hostgroup_params_filter
           super.tap do |filter|
-            filter.permit :environment_id, :environment_name,
-              config_group_ids: [], config_group_names: [],
-              puppetclass_ids: [], puppetclass_names: []
-
-            # TODO: bring to core - this is what facets should do, but does not
-            filter.permit(puppet_attributes: {})
+            add_hostgroup_puppet_params_filter(filter)
           end
         end
       end
@@ -27,36 +22,50 @@ module ForemanPuppet
       module PatchedMethods
         def hostgroup_params(*attrs)
           params = super(*attrs)
-
-          process_deprecated_hostgroup_environment_params!(params)
-          process_deprecated_hostgroup_attributes!(params)
+          process_deprecated_hostgroup_puppet_params!(params)
           params
         end
+      end
 
-        def process_deprecated_hostgroup_environment_params!(params)
-          env_id = params.delete(:environment_id)
-          env_name = params.delete(:environment_name)
-
-          return unless env_id || env_name
-          ::Foreman::Deprecation.api_deprecation_warning('param hostgroup[environment_*] has been deprecated in favor of hostgroup[puppet_attributes][environment_*]')
+      class_methods do
+        def add_hostgroup_puppet_params_filter(filter)
+          filter.permit :environment_id, :environment_name,
+            config_group_ids: [], config_group_names: [],
+            puppetclass_ids: [], puppetclass_names: []
 
-          params[:puppet_attributes] ||= {}
-          params[:puppet_attributes][:environment_id] ||= env_id if env_id
-          params[:puppet_attributes][:environment_name] ||= env_name if env_name
+          # TODO: bring to core - this is what facets should do, but does not
+          filter.permit(puppet_attributes: {})
         end
+      end
+
+      def process_deprecated_hostgroup_puppet_params!(params, top_level_hash = 'hostgroup')
+        process_deprecated_hostgroup_environment_params!(params, top_level_hash)
+        process_deprecated_hostgroup_attributes!(params, top_level_hash)
+      end
 
-        def process_deprecated_hostgroup_attributes!(params)
-          %w[puppetclass config_group].each do |relation|
-            ids = params.delete("#{relation}_ids")
-            names = params.delete("#{relation}_names")
+      def process_deprecated_hostgroup_environment_params!(params, top_level_hash = 'hostgroup')
+        env_id = params.delete(:environment_id)
+        env_name = params.delete(:environment_name)
 
-            next unless ids || names
-            ::Foreman::Deprecation.api_deprecation_warning("param hostgroup[#{relation}_*] has been deprecated in favor of hostgroup[puppet_attributes][#{relation}_*]")
+        return unless env_id || env_name
+        ::Foreman::Deprecation.api_deprecation_warning("param #{top_level_hash}[environment_*] has been deprecated in favor of #{top_level_hash}[puppet_attributes][environment_*]")
 
-            params[:puppet_attributes] ||= {}
-            params[:puppet_attributes]["#{relation}_ids".to_sym] ||= ids if ids
-            params[:puppet_attributes]["#{relation}_names".to_sym] ||= names if names
-          end
+        params[:puppet_attributes] ||= {}
+        params[:puppet_attributes][:environment_id] ||= env_id if env_id
+        params[:puppet_attributes][:environment_name] ||= env_name if env_name
+      end
+
+      def process_deprecated_hostgroup_attributes!(params, top_level_hash = 'hostgroup')
+        %w[puppetclass config_group].each do |relation|
+          ids = params.delete("#{relation}_ids")
+          names = params.delete("#{relation}_names")
+
+          next unless ids || names
+          ::Foreman::Deprecation.api_deprecation_warning("param #{top_level_hash}[#{relation}_*] has been deprecated in favor of #{top_level_hash}[puppet_attributes][#{relation}_*]")
+
+          params[:puppet_attributes] ||= {}
+          params[:puppet_attributes]["#{relation}_ids".to_sym] ||= ids if ids
+          params[:puppet_attributes]["#{relation}_names".to_sym] ||= names if names
         end
       end
     end

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

@@ -20,7 +20,7 @@ module ForemanPuppet
 
         def create
           @hostgroup_class = HostgroupClass.create!(hostgroup_puppet_facet_id: @hostgroup.puppet.id, puppetclass_id: params[:puppetclass_id].to_i)
-          render json: { hostgroup_id: @hostgroup_class.hostgroup_id, puppetclass_id: @hostgroup_class.puppetclass_id }
+          render json: { hostgroup_id: @hostgroup.puppet.hostgroup_id, puppetclass_id: @hostgroup_class.puppetclass_id }
         end
 
         api :DELETE, '/hostgroups/:hostgroup_id/puppetclass_ids/:id/', N_('Remove a Puppet class from host group')

data/app/helpers/foreman_puppet/environments_helper.rb

@@ -10,7 +10,7 @@ module ForemanPuppet
 
     def environments_title_actions
       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(new_link(_('Create Puppet Environment'), { engine: foreman_puppet }, id: 'new_environment')),
         button_group(help_button)
     end
   end

data/app/models/foreman_puppet/host_puppet_facet.rb

@@ -48,7 +48,7 @@ module ForemanPuppet
 
     def parent_config_groups
       return [] unless host.hostgroup
-      host.hostgroup.puppet&.all_config_groups
+      host.hostgroup.puppet&.all_config_groups || []
     end
 
     def ensure_puppet_associations

data/app/models/foreman_puppet/hostgroup_puppet_facet.rb

@@ -48,6 +48,8 @@ module ForemanPuppet
       Hostgroup.sort_by_ancestry(hostgroup.ancestors.joins(:puppet).where(HostgroupPuppetFacet.arel_table[attr.to_sym].not_eq(nil))).last&.puppet.try(attr)
     end
 
+    delegate :parent_id, to: :hostgroup
+
     # and helpers
     def parent_facet_id
       parent_facet&.id

data/app/views/foreman_puppet/config_groups/index.html.erb

@@ -2,7 +2,7 @@
 <% content_for(:search_bar) { } %>
 <% title _('Config Groups') %>
 
-<% title_actions new_link(_('Create Config Group'), engine: foreman_puppet), help_button %>
+<% title_actions new_link(_('Create Config Group'), { engine: foreman_puppet }, id: 'new_config_group'), help_button %>
 
 <table class="<%= table_css_classes 'table-fixed' %>">
   <thead>

data/db/migrate/20200803113903_migrate_host_type_in_host_config_groups.foreman_puppet.rb

@@ -13,26 +13,8 @@ class MigrateHostTypeInHostConfigGroups < ActiveRecord::Migration[6.0]
   end
 
   def up
-    host_config_group_ids = FakeHostConfigGroup.for_host.pluck(:host_id).uniq
-    host_config_group_ids.each do |host_id|
-      host_facet_id = ForemanPuppet::HostPuppetFacet.where(host_id: host_id).pick(:id)
-      host_groups = FakeHostConfigGroup.for_host.where(host_id: host_id)
-      if host_facet_id
-        host_groups.update_all(host_type: 'ForemanPuppet::HostPuppetFacet', host_id: host_facet_id)
-      else
-        deleted_groups = FakeConfigGroup.where(id: host_groups.pluck(:config_group_id)).pluck(:name)
-        say "deleting groups #{deleted_groups.join(', ')} from Host (id=#{host_id}) because it has no environment"
-        host_groups.delete_all
-      end
-    end
-    hostgroup_config_group_ids = FakeHostConfigGroup.for_hostgroup.pluck(:host_id).uniq
-    hostgroup_config_group_ids.each do |hostgroup_id|
-      hostgroup_facet_id = ForemanPuppet::HostgroupPuppetFacet.where(hostgroup_id: hostgroup_id).pick(:id)
-      hostgroup_facet_id ||= ForemanPuppet::HostgroupPuppetFacet.create!(hostgroup: Hostgroup.unscoped.find(hostgroup_id)).id
-      FakeHostConfigGroup.for_hostgroup
-                         .where(host_id: hostgroup_id)
-                         .update_all(host_type: 'ForemanPuppet::HostgroupPuppetFacet', host_id: hostgroup_facet_id)
-    end
+    migrate_host_data_to_facets
+    migrate_hostgroup_data_to_facets
   end
 
   def down
@@ -51,4 +33,38 @@ class MigrateHostTypeInHostConfigGroups < ActiveRecord::Migration[6.0]
                          .update_all(host_type: 'Hostgroup', host_id: hostgroup_facet_ids[hostgroup_facet_id])
     end
   end
+
+  private
+
+  def migrate_host_data_to_facets
+    host_config_group_ids = FakeHostConfigGroup.for_host.pluck(:host_id).uniq
+    host_config_group_ids.each do |host_id|
+      host_facet_id = ForemanPuppet::HostPuppetFacet.where(host_id: host_id).pick(:id)
+      host_groups = FakeHostConfigGroup.for_host.where(host_id: host_id)
+      if host_facet_id
+        host_groups.update_all(host_type: 'ForemanPuppet::HostPuppetFacet', host_id: host_facet_id)
+      else
+        deleted_groups = FakeConfigGroup.where(id: host_groups.pluck(:config_group_id)).pluck(:name)
+        say "Deleting Config groups #{deleted_groups.join(', ')} from Host (id=#{host_id}) because the Host doesn't exist or has no environment"
+        host_groups.delete_all
+      end
+    end
+  end
+
+  def migrate_hostgroup_data_to_facets
+    hostgroup_config_group_ids = FakeHostConfigGroup.for_hostgroup.pluck(:host_id).uniq
+    hostgroup_config_group_ids.each do |hostgroup_id|
+      hostgroup = Hostgroup.unscoped.find_by(id: hostgroup_id)
+      hostgroup_groups = FakeHostConfigGroup.for_hostgroup.where(host_id: hostgroup_id)
+      if hostgroup
+        hostgroup_facet_id = ForemanPuppet::HostgroupPuppetFacet.where(hostgroup_id: hostgroup_id).pick(:id)
+        hostgroup_facet_id ||= ForemanPuppet::HostgroupPuppetFacet.create!(hostgroup: hostgroup).id
+        hostgroup_groups.update_all(host_type: 'ForemanPuppet::HostgroupPuppetFacet', host_id: hostgroup_facet_id)
+      else
+        deleted_groups = FakeConfigGroup.where(id: hostgroup_groups.pluck(:config_group_id)).pluck(:name)
+        say "Deleting Config groups #{deleted_groups.join(', ')} from Hostgroup (id=#{hostgroup_id}) because Hostgroup doesn't exist"
+        hostgroup_groups.delete_all
+      end
+    end
+  end
 end

data/db/migrate/20201125113903_migrate_puppetclasses_to_facets.foreman_puppet.rb

@@ -33,17 +33,9 @@ class MigratePuppetclassesToFacets < ActiveRecord::Migration[6.0]
       hostgroup_facet ||= ForemanPuppet::HostgroupPuppetFacet.create(hostgroup: Hostgroup.unscoped.find(hostgroup_id))
       ForemanPuppet::HostgroupClass.where(hostgroup_id: hostgroup_id).update_all(hostgroup_puppet_facet_id: hostgroup_facet.id)
     end
-
-    change_column_null(:host_classes, :host_id, true)
-    change_column_null(:hostgroup_classes, :hostgroup_id, true)
-    # remove_reference(:host_classes, :host, index: true, foreign_key: true)
-    # remove_reference(:hostgroup_classes, :hostgroup, index: true, foreign_key: true)
   end
 
   def down
-    # add_reference :host_classes, :host, foreign_key: true, index: true
-    # add_reference :hostgroup_classes, :hostgroup, foreign_key: true, index: true
-
     host_facets_ids = ForemanPuppet::HostClass.joins(:host_puppet_facet).pluck(:host_puppet_facet_id, 'host_puppet_facets.host_id')
     host_facets_ids.each do |host_facet_id, host_id|
       ForemanPuppet::HostClass.where(host_puppet_facet_id: host_facet_id).update_all(host_id: host_id)

data/db/migrate/20211111125003_drop_puppetclasses_direct_references.foreman_puppet.rb

@@ -0,0 +1,11 @@
+class DropPuppetclassesDirectReferences < ActiveRecord::Migration[6.0]
+  def up
+    remove_reference(:host_classes, :host, index: true, foreign_key: true)
+    remove_reference(:hostgroup_classes, :hostgroup, index: true, foreign_key: true)
+  end
+
+  def down
+    add_reference :host_classes, :host, foreign_key: true, index: true
+    add_reference :hostgroup_classes, :hostgroup, foreign_key: true, index: true
+  end
+end

data/db/migrate/20211112130803_cleanup_environment_from_core_tables.foreman_puppet.rb

@@ -0,0 +1,10 @@
+class CleanupEnvironmentFromCoreTables < ActiveRecord::Migration[6.0]
+  def up
+    ::Hostgroup.update_all(environment_id: nil) if column_exists?(:hostgroups, :environment_id)
+    Host::Managed.update_all(environment_id: nil) if column_exists?(:hosts, :environment_id)
+  end
+
+  def down
+    # nothing to do
+  end
+end

data/db/migrate_foreman/{20090722141107_create_environments.rb → 20090722141107_create_environments.foreman_puppet.rb}

@@ -11,7 +11,7 @@ class CreateEnvironments < ActiveRecord::Migration[4.2]
   end
 
   def down
-    drop_table :environments
     drop_table :environments_puppetclasses
+    drop_table :environments
   end
 end

data/db/migrate_foreman/{20090802062223_create_puppetclasses.rb → 20090802062223_create_puppetclasses.foreman_puppet.rb}

@@ -21,8 +21,9 @@ class CreatePuppetclasses < ActiveRecord::Migration[4.2]
   end
 
   def down
-    drop_table :puppetclasses
-    drop_table :hosts_puppetclasses
     drop_table :operatingsystems_puppetclasses
+    drop_table :hosts_puppetclasses
+    remove_foreign_key(:environments_puppetclasses, :puppetclasses)
+    drop_table :puppetclasses
   end
 end

data/db/migrate_foreman/{20120824142048_add_some_indexes.rb → 20120824142048_add_some_indexes.foreman_puppet.rb}

@@ -1,5 +1,5 @@
 class AddSomeIndexes < ActiveRecord::Migration[4.2]
-  def change
+  def up
     # puppetclasses
     add_index :puppetclasses, :name
 
@@ -11,4 +11,11 @@ class AddSomeIndexes < ActiveRecord::Migration[4.2]
     add_foreign_key 'operatingsystems_puppetclasses', 'operatingsystems', name: 'operatingsystems_puppetclasses_operatingsystem_id_fk'
     add_foreign_key 'operatingsystems_puppetclasses', 'puppetclasses', name: 'operatingsystems_puppetclasses_puppetclass_id_fk'
   end
+
+  def down
+    remove_foreign_key 'host_classes', 'hosts', name: 'host_classes_host_id_fk'
+    remove_foreign_key 'host_classes', 'puppetclasses', name: 'host_classes_puppetclass_id_fk'
+    remove_foreign_key 'operatingsystems_puppetclasses', 'operatingsystems', name: 'operatingsystems_puppetclasses_operatingsystem_id_fk'
+    remove_foreign_key 'operatingsystems_puppetclasses', 'puppetclasses', name: 'operatingsystems_puppetclasses_puppetclass_id_fk'
+  end
 end

data/db/migrate_foreman/{20120905095532_create_environment_classes.rb → 20120905095532_create_environment_classes.foreman_puppet.rb}

@@ -8,8 +8,8 @@ class CreateEnvironmentClasses < ActiveRecord::Migration[5.0]
   end
 
   def down
-    remove_foreign_key :environment_classes, :lookup_key
-    drop_column :environment_classes, :puppetclass_lookup_key_id, :integer
+    remove_foreign_key :environment_classes, :lookup_keys, column: :puppetclass_lookup_key_id
+    remove_column :environment_classes, :puppetclass_lookup_key_id, :integer
     rename_table :environment_classes, :environments_puppetclasses
   end
 end

data/lib/foreman_puppet/register.rb

@@ -3,6 +3,41 @@ Foreman::Plugin.register :foreman_puppet do
   # Add Global JS file for extending foreman-core components and routes
   register_global_js_file 'fills'
 
+  settings do
+    category(:facts, N_('Facts')) do
+      setting('default_puppet_environment',
+        type: :string,
+        description: N_('Foreman will default to this puppet environment if it cannot auto detect one'),
+        default: 'production',
+        full_name: N_('Default Puppet environment'),
+        collection: proc { ForemanPuppet::Environment.pluck(:name).map { |name| [name, name] }.to_h })
+      setting('enc_environment',
+        type: :boolean,
+        description: N_('Foreman will explicitly set the puppet environment in the ENC yaml output. '\
+                        'This will avoid conflicts between the environment in puppet.conf and the environment set in Foreman'),
+        default: true,
+        full_name: N_('ENC environment'))
+      setting('update_environment_from_facts',
+        type: :boolean,
+        description: N_("Foreman will update a host's environment from its facts"),
+        default: false,
+        full_name: N_('Update environment from facts'))
+    end
+
+    category(:cfgmgmt, N_('Config Management')) do
+      setting('puppet_interval',
+        type: :integer,
+        description: N_('Duration in minutes after servers reporting via Puppet are classed as out of sync.'),
+        default: 35,
+        full_name: N_('Puppet interval'))
+      setting('puppet_out_of_sync_disabled',
+        type: :boolean,
+        description: N_('Disable host configuration status turning to out of sync for %s after report does not arrive within configured interval') % 'Puppet',
+        default: false,
+        full_name: N_('%s out of sync disabled') % 'Puppet')
+    end
+  end
+
   apipie_documented_controllers(["#{ForemanPuppet::Engine.root}/app/controllers/foreman_puppet/api/v2/*.rb"])
 
   # TODO: maybe this would not be necessary if we rething the form

data/lib/foreman_puppet/version.rb

@@ -1,3 +1,3 @@
 module ForemanPuppet
-  VERSION = '2.0.0.alpha.2'.freeze
+  VERSION = '2.0.0'.freeze
 end