foreman_puppet 0.0.1

data/db/migrate_foreman/20090722141107_create_environments.rb

@@ -0,0 +1,17 @@
+class CreateEnvironments < ActiveRecord::Migration[5.0]
+  def up
+    create_table :environments do |t|
+      t.string :name, null: false, limit: 255
+      t.timestamps null: true
+    end
+    create_table :environments_puppetclasses do |t|
+      t.references :puppetclass, foreign_key: true
+      t.references :environment, foreign_key: true
+    end
+  end
+
+  def down
+    drop_table :environments
+    drop_table :environments_puppetclasses
+  end
+end

data/db/migrate_foreman/20120905095532_create_environment_classes.rb

@@ -0,0 +1,15 @@
+class CreateEnvironmentClasses < ActiveRecord::Migration[5.0]
+  class EnvironmentClass < ApplicationRecord; end
+
+  def up
+    rename_table :environments_puppetclasses, :environment_classes
+    add_column :environment_classes, :puppetclass_lookup_key_id, :integer
+    add_foreign_key :environment_classes, :lookup_keys, column: :puppetclass_lookup_key_id, name: 'environment_classes_lookup_key_id_fk'
+  end
+
+  def down
+    remove_foreign_key :environment_classes, :lookup_key
+    drop_column :environment_classes, :puppetclass_lookup_key_id, :integer
+    rename_table :environment_classes, :environments_puppetclasses
+  end
+end

data/db/migrate_foreman/20140407161817_create_config_groups.rb

@@ -0,0 +1,9 @@
+class CreateConfigGroups < ActiveRecord::Migration[4.2]
+  def change
+    create_table :config_groups do |t|
+      t.string :name, limit: 255
+
+      t.timestamps null: true
+    end
+  end
+end

data/db/migrate_foreman/20140407162007_create_config_group_classes.rb

@@ -0,0 +1,10 @@
+class CreateConfigGroupClasses < ActiveRecord::Migration[4.2]
+  def change
+    create_table :config_group_classes do |t|
+      t.integer :puppetclass_id
+      t.integer :config_group_id
+
+      t.timestamps null: true
+    end
+  end
+end

data/db/migrate_foreman/20140407162059_create_host_config_groups.rb

@@ -0,0 +1,11 @@
+class CreateHostConfigGroups < ActiveRecord::Migration[4.2]
+  def change
+    create_table :host_config_groups do |t|
+      t.integer :config_group_id
+      t.integer :host_id
+      t.string  :host_type, limit: 255
+
+      t.timestamps null: true
+    end
+  end
+end

data/db/migrate_foreman/20161205142618_delete_orphaned_smart_class_parameters.rb

@@ -0,0 +1,10 @@
+class DeleteOrphanedSmartClassParameters < ActiveRecord::Migration[4.2]
+  def up
+    condition = 'NOT EXISTS (SELECT 1 FROM environment_classes WHERE environment_classes.puppetclass_lookup_key_id = lookup_keys.id)'
+    LookupValue.joins(:lookup_key).where(condition).where("lookup_keys.type = 'PuppetclassLookupKey'").delete_all
+    PuppetclassLookupKey.where(condition).delete_all
+  end
+
+  def down
+  end
+end

data/db/migrate_foreman/20170109115157_fix_lookup_key_auditable_type.rb

@@ -0,0 +1,15 @@
+class FixLookupKeyAuditableType < ActiveRecord::Migration[4.2]
+  def up
+    Audit.reorder(nil).joins('JOIN lookup_keys ON lookup_keys.id = audits.auditable_id')
+         .where(auditable_type: 'LookupKey', lookup_keys: { type: 'VariableLookupKey' })
+         .update_all(auditable_type: 'VariableLookupKey')
+
+    Audit.reorder(nil).joins('JOIN lookup_keys ON lookup_keys.id = audits.auditable_id')
+         .where(auditable_type: 'LookupKey', lookup_keys: { type: 'PuppetclassLookupKey' })
+         .update_all(auditable_type: 'PuppetclassLookupKey')
+  end
+
+  def down
+    Audit.where(auditable_type: %w[PuppetclassLookupKey VariableLookupKey]).update_all(auditable_type: 'LookupKey')
+  end
+end

data/db/migrate_foreman/20180816134832_cast_lookup_key_values.rb

@@ -0,0 +1,35 @@
+class CastLookupKeyValues < ActiveRecord::Migration[5.1]
+  def up
+    # Different LookupKey types handle casting a bit differently
+    PuppetclassLookupKey.unscoped.preload(:lookup_values).where(override: true).where.not(key_type: 'string').find_each do |key|
+      cast_key_and_values(key)
+    end
+  end
+
+  private
+
+  def cast_key_and_values(key)
+    fix_value(key, :default_value)
+    key.lookup_values.each do |lv|
+      fix_value(lv, :value)
+    end
+  end
+
+  def safemode_box
+    @safemode_box ||= Safemode::Box.new
+  end
+
+  def fix_value(obj, attribute)
+    return if obj.omit && !obj.try(:merge_default)
+    value = obj.send(attribute)
+    return unless value.is_a? String
+    return if value.contains_erb?
+    fixed = safemode_box.eval(value)
+    obj.update_column(attribute, fixed)
+  rescue StandardError => e
+    say "Failed to cast #{attribute} for #{obj.inspect}:"
+    say "Value: #{value}", subitem: true
+    say "Error: #{e.message}", subitem: true
+    say 'Perhaps it is invalid? Casting skipped, manual action may be needed.', subitem: true
+  end
+end

data/db/migrate_foreman/20181023112532_add_environment_puppetclass_id.rb

@@ -0,0 +1,7 @@
+# Added in theforeman/foreman#bb07c3b1cf
+class AddEnvironmentPuppetclassId < ActiveRecord::Migration[5.2]
+  def change
+    add_index :environment_classes, %i[environment_id puppetclass_id]
+    remove_index :environment_classes, :environment_id
+  end
+end

data/db/migrate_foreman/20181224174419_add_index_to_environment_class_by_lookup_key_and_puppetclass.rb

@@ -0,0 +1,6 @@
+# Added in theforeman/foreman#6d9e2b7c61
+class AddIndexToEnvironmentClassByLookupKeyAndPuppetclass < ActiveRecord::Migration[5.2]
+  def change
+    add_index :environment_classes, %i[puppetclass_lookup_key_id puppetclass_id], name: 'index_env_classes_on_lookup_key_and_class'
+  end
+end

data/db/seeds.d/111_puppet_proxy_feature.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+proxy_features = %w[Puppet]
+
+proxy_features.each do |f_name|
+  f = Feature.where(name: f_name).first_or_create
+  raise "Unable to create proxy feature: #{format_errors f}" if f.nil? || f.errors.any?
+end

data/lib/foreman_puppet.rb

@@ -0,0 +1,10 @@
+module ForemanPuppet
+  FOREMAN_EXTRACTION_VERSION = '2.5'.freeze
+
+  def self.extracted_from_core?
+    ENV['PUPPET_EXTRACTED'] == '1' ||
+      Gem::Dependency.new('', ">= #{FOREMAN_EXTRACTION_VERSION}").match?('', SETTINGS[:version])
+  end
+end
+
+require 'foreman_puppet/engine'

data/lib/foreman_puppet/engine.rb

@@ -0,0 +1,82 @@
+module ForemanPuppet
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_puppet'
+    isolate_namespace ForemanPuppet
+
+    config.paths['db/migrate'] << 'db/migrate_foreman' if Gem::Dependency.new('', ">= #{ForemanPuppet::FOREMAN_EXTRACTION_VERSION}").match?('', SETTINGS[:version])
+    config.paths['config/routes.rb'].unshift('config/api_routes.rb')
+
+    initializer 'foreman_puppet.register_plugin', before: :finisher_hook do |_app|
+      require 'foreman_puppet/register'
+      Apipie.configuration.checksum_path += ['/foreman_puppet/api/']
+    end
+
+    initializer 'foreman_puppet.migrate_by_default' do |app|
+      unless Object.const_defined?(:APP_RAKEFILE)
+        paths['db/migrate'].existent.each do |path|
+          app.config.paths['db/migrate'] << path
+        end
+      end
+    end
+
+    initializer 'foreman_ansible.configure_assets', group: :assets do
+      SETTINGS[:foreman_puppet] = { assets: { precompile: ['foreman_puppet.scss'] } }
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      # Parameters should go ASAP as they need to be applied before they are included in core controller
+      Foreman::Controller::Parameters::Host.include ForemanPuppet::Extensions::ParametersHost
+      Foreman::Controller::Parameters::Hostgroup.include ForemanPuppet::Extensions::ParametersHostgroup
+      Foreman::Controller::Parameters::TemplateCombination.include ForemanPuppet::Extensions::ParametersTemplateCombination
+
+      # Facets extenstion is applied too early - before the Hostgroup is complete
+      # We redefine thing, so we need to wait until complete definition of Hostgroup
+      # thus separate patching instead of using facet patching
+      Hostgroup.include ForemanPuppet::Extensions::Hostgroup
+
+      # include_in_clone that is used in core Facets::ManagedHostExtensions doesn't support nested objects
+      # we need to run our include_in_clone after, so the puppet without nested objects doesnt override the one including them
+      Host::Managed.include ForemanPuppet::Extensions::Host
+
+      LookupValue.include ForemanPuppet::PuppetLookupValueExtensions
+      Operatingsystem.include ForemanPuppet::Extensions::Operatingsystem
+      Nic::Managed.include ForemanPuppet::Extensions::NicManaged
+      Report.include ForemanPuppet::Extensions::Report
+      Taxonomy.include ForemanPuppet::Extensions::Taxonomy
+      User.include ForemanPuppet::Extensions::User
+      TemplateCombination.include ForemanPuppet::Extensions::TemplateCombination
+      ProvisioningTemplate.include ForemanPuppet::Extensions::ProvisioningTemplate
+
+      ::Api::V2::HostsController.include ForemanPuppet::Extensions::ApiV2HostsController
+      ::Api::V2::HostgroupsController.include ForemanPuppet::Extensions::ApiHostgroupsController
+      ::Api::V2::TemplateCombinationsController.include ForemanPuppet::Extensions::ApiTemplateCombinationsController
+      OperatingsystemsController.prepend ForemanPuppet::Extensions::OperatingsystemsController
+      HostsController.include ForemanPuppet::Extensions::HostsControllerExtensions
+      HostgroupsController.include ForemanPuppet::Extensions::HostgroupsControllerExtensions
+
+      SmartProxiesHelper::TABBED_FEATURES << 'Puppet'
+
+      unless ForemanPuppet.extracted_from_core?
+        ::HostInfo.local_entries.delete('HostInfoProviders::PuppetInfo'.safe_constantize)
+        ::HostInfo.local_entries.delete('HostInfoProviders::ConfigGroupsInfo'.safe_constantize)
+        ::ProxyStatus.status_registry.delete('ProxyStatus::Puppet'.safe_constantize)
+        Foreman.input_types_registry.input_types.delete('puppet_parameter')
+      end
+      Foreman.input_types_registry.register(ForemanPuppet::InputType::PuppetParameterInput)
+      ::ProxyStatus.status_registry.add(ForemanPuppet::ProxyStatus::Puppet)
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanPuppet::Engine.load_seed
+      end
+    end
+
+    initializer 'foreman_puppet.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
+      locale_domain = 'foreman_puppet'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+end

data/lib/foreman_puppet/register.rb

@@ -0,0 +1,218 @@
+Foreman::Plugin.register :foreman_puppet do
+  requires_foreman '>= 2.0.0'
+  # Add Global JS file for extending foreman-core components and routes
+  register_global_js_file 'fills'
+
+  apipie_documented_controllers(["#{ForemanPuppet::Engine.root}/app/controllers/foreman_puppet/api/v2/*.rb"])
+
+  unless ForemanPuppet.extracted_from_core?
+    # Remove core permissions
+    cfgs = %i[view_config_groups create_config_groups edit_config_groups destroy_config_groups]
+    plks = %i[view_external_parameters create_external_parameters edit_external_parameters
+              destroy_external_parameters]
+    pcls = %i[view_puppetclasses create_puppetclasses edit_puppetclasses destroy_puppetclasses import_puppetclasses]
+    (cfgs | plks | pcls).each do |perm_name|
+      p = Foreman::AccessControl.permission(perm_name)
+      Foreman::AccessControl.remove_permission(p)
+    end
+
+    delete_menu_item(:top_menu, :puppetclasses)
+    delete_menu_item(:top_menu, :config_groups)
+    delete_menu_item(:top_menu, :puppetclass_lookup_keys)
+    delete_menu_item(:top_menu, :environments)
+  end
+
+  # TODO: maybe this would not be necessary if we rething the form
+  %i[create_hostgroups edit_hostgroups].each do |perm|
+    p = Foreman::AccessControl.permission(perm)
+    if ForemanPuppet.extracted_from_core?
+      p.actions << 'hostgroups/environment_selected'
+      p.actions << 'hostgroups/puppetclass_parameters'
+    end
+    p.actions << 'foreman_puppet/puppetclasses/parameters'
+  end
+  p = Foreman::AccessControl.permission(:edit_hostgroups)
+  %w[index create destroy].each do |action|
+    p.actions << "foreman_puppet/api/v2/hostgroup_classes/#{action}"
+  end
+  %i[create_hosts edit_hosts].each do |perm|
+    p = Foreman::AccessControl.permission(perm)
+    if ForemanPuppet.extracted_from_core?
+      p.actions << 'hosts/hostgroup_or_environment_selected'
+      p.actions << 'hosts/puppetclass_parameters'
+      if perm == :edit_hosts
+        p.actions << 'hosts/select_multiple_environment'
+        p.actions << 'hosts/update_multiple_environment'
+        p.actions << 'hosts/select_multiple_puppet_proxy'
+        p.actions << 'hosts/update_multiple_puppet_proxy'
+      end
+    end
+    p.actions << 'foreman_puppet/puppetclasses/parameters'
+  end
+
+  p = Foreman::AccessControl.permission(:view_hosts)
+  p.actions << 'hosts/externalNodes'
+
+  p = Foreman::AccessControl.permission(:view_smart_proxies)
+  p.actions << 'foreman_puppet/puppet_smart_proxies/dashboard'
+  p.actions << 'foreman_puppet/puppet_smart_proxies/environments'
+
+  # Add permissions
+  security_block :puppet_config_groups do
+    permission :view_config_groups, { 'foreman_puppet/config_groups': %i[index auto_complete_search welcome],
+                                      'foreman_puppet/api/v2/config_groups': %i[index show],
+                                      'foreman_puppet/react': [:index] },
+      resource_type: 'ForemanPuppet::ConfigGroup'
+    permission :create_config_groups, { 'foreman_puppet/config_groups': %i[new create],
+                                        'foreman_puppet/api/v2/config_groups': [:create] },
+      resource_type: 'ForemanPuppet::ConfigGroup'
+    permission :edit_config_groups, { 'foreman_puppet/config_groups': %i[edit update],
+                                      'foreman_puppet/api/v2/config_groups': [:update] },
+      resource_type: 'ForemanPuppet::ConfigGroup'
+    permission :destroy_config_groups, { 'foreman_puppet/config_groups': [:destroy],
+                                         'foreman_puppet/api/v2/config_groups': [:destroy] },
+      resource_type: 'ForemanPuppet::ConfigGroup'
+  end
+
+  security_block :puppet_lookup_keys do
+    permission :view_external_parameters, { 'foreman_puppet/puppetclass_lookup_keys': %i[index show auto_complete_search welcome],
+                                            lookup_values: [:index],
+                                            'foreman_puppet/api/v2/smart_class_parameters': %i[index show],
+                                            'foreman_puppet/api/v2/override_values': %i[index show] },
+      resource_type: 'ForemanPuppet::PuppetclassLookupKey'
+    permission :create_external_parameters, { 'foreman_puppet/puppetclass_lookup_keys': %i[new create],
+                                              lookup_values: [:create],
+                                              'foreman_puppet/api/v2/smart_class_parameters': [:create],
+                                              'foreman_puppet/api/v2/override_values': [:create] },
+      resource_type: 'ForemanPuppet::PuppetclassLookupKey'
+    permission :edit_external_parameters, { 'foreman_puppet/puppetclass_lookup_keys': %i[edit update],
+                                            lookup_values: %i[create update destroy],
+                                            'foreman_puppet/api/v2/smart_class_parameters': [:update],
+                                            'foreman_puppet/api/v2/override_values': %i[create update destroy] },
+      resource_type: 'ForemanPuppet::PuppetclassLookupKey'
+    permission :destroy_external_parameters, { 'foreman_puppet/puppetclass_lookup_keys': [:destroy],
+                                               lookup_values: [:destroy],
+                                               'foreman_puppet/api/v2/smart_class_parameters': [:destroy],
+                                               'foreman_puppet/api/v2/override_values': %i[create update destroy] },
+      resource_type: 'ForemanPuppet::PuppetclassLookupKey'
+  end
+
+  security_block :puppet_environments do
+    permission :view_environments, { 'foreman_puppet/environments': %i[index show auto_complete_search welcome],
+                                     'foreman_puppet/api/v2/environments': %i[index show] },
+      resource_type: 'ForemanPuppet::Environment'
+    permission :create_environments, { 'foreman_puppet/environments': %i[new create],
+                                       'foreman_puppet/api/v2/environments': %i[create] },
+      resource_type: 'ForemanPuppet::Environment'
+    permission :edit_environments, { 'foreman_puppet/environments': %i[edit update],
+                                     'foreman_puppet/api/v2/environments': %i[update] },
+      resource_type: 'ForemanPuppet::Environment'
+    permission :destroy_environments, { 'foreman_puppet/environments': %i[destroy],
+                                        'foreman_puppet/api/v2/environments': %i[destroy] },
+      resource_type: 'ForemanPuppet::Environment'
+    permission :import_environments, { 'foreman_puppet/environments': %i[import_environments obsolete_and_new],
+                                       'foreman_puppet/api/v2/environments': %i[import_puppetclasses] },
+      resource_type: 'ForemanPuppet::Environment'
+  end
+
+  security_block :puppetclasses do
+    permission :view_puppetclasses,   { 'foreman_puppet/puppetclasses' => %i[index show auto_complete_search],
+                                        'foreman_puppet/api/v2/puppetclasses' => %i[index show],
+                                        'foreman_puppet/api/v2/smart_class_parameters' => %i[index show] },
+      resource_type: 'ForemanPuppet::Puppetclass'
+    permission :create_puppetclasses, { 'foreman_puppet/puppetclasses' => %i[new create],
+                                        'foreman_puppet/api/v2/puppetclasses' => [:create] },
+      resource_type: 'ForemanPuppet::Puppetclass'
+    permission :edit_puppetclasses,   { 'foreman_puppet/puppetclasses' => %i[edit update override],
+                                        'foreman_puppet/api/v2/puppetclasses' => [:update],
+                                        'foreman_puppet/api/v2/smart_class_parameters' => %i[create update destroy] },
+      resource_type: 'ForemanPuppet::Puppetclass'
+    permission :destroy_puppetclasses, { 'foreman_puppet/puppetclasses' => [:destroy],
+                                         'foreman_puppet/api/v2/puppetclasses' => [:destroy] },
+      resource_type: 'ForemanPuppet::Puppetclass'
+    permission :import_puppetclasses, { 'foreman_puppet/puppetclasses' => %i[import_environments obsolete_and_new],
+                                        'foreman_puppet/api/v2/environments' => [:import_puppetclasses] },
+      resource_type: 'ForemanPuppet::Puppetclass'
+    permission :edit_classes, { 'foreman_puppet/api/v2/host_classes': %i[index create destroy] },
+      resource_type: 'ForemanPuppet::HostClass'
+  end
+
+  add_all_permissions_to_default_roles
+  Foreman::Plugin::RbacSupport::AUTO_EXTENDED_ROLES |= ['Site manager']
+  add_permissions_to_default_roles(
+    'Site manager' => %w[view_puppetclasses import_puppetclasses view_environments import_environments
+                         view_external_parameters create_external_parameters edit_external_parameters destroy_external_parameters]
+  )
+
+  # add puppet ENC divider
+  divider :top_menu, parent: :configure_menu, caption: N_('Puppet ENC')
+
+  # add menu entries
+  add_menu_item :top_menu, :environments, caption: N_('Environments'),
+                                          engine: ForemanPuppet::Engine,
+                                          parent: :configure_menu
+  add_menu_item :top_menu, :puppetclasses, caption: N_('Classes'),
+                                           engine: ForemanPuppet::Engine,
+                                           parent: :configure_menu
+  add_menu_item :top_menu, :config_groups, caption: N_('Config Groups'),
+                                           engine: ForemanPuppet::Engine,
+                                           parent: :configure_menu
+  add_menu_item :top_menu, :puppetclass_lookup_keys, caption: N_('Smart Class Parameters'),
+                                                     engine: ForemanPuppet::Engine,
+                                                     parent: :configure_menu
+
+  register_info_provider(ForemanPuppet::HostInfoProviders::ConfigGroupsInfo)
+  register_info_provider(ForemanPuppet::HostInfoProviders::PuppetInfo)
+
+  # register host and hostgroup facet
+  register_facet ForemanPuppet::HostPuppetFacet, :puppet do
+    configure_host do
+      # extend_model ForemanPuppet::Extensions::Host
+      api_view list: 'foreman_puppet/api/v2/host_puppet_facets/base',
+               single: 'foreman_puppet/api/v2/host_puppet_facets/host_single'
+      template_compatibility_properties :environment, :environment_id, :environment_name
+      set_dependent_action :destroy
+    end
+    configure_hostgroup(ForemanPuppet::HostgroupPuppetFacet) do
+      api_view list: 'foreman_puppet/api/v2/hostgroup_puppet_facets/base',
+               single: 'foreman_puppet/api/v2/hostgroup_puppet_facets/hostgroup_single'
+      template_compatibility_properties :environment, :environment_id, :environment_name
+      set_dependent_action :destroy
+    end
+  end
+
+  add_controller_action_scope('Api::V2::HostsController', :index) do |base_scope|
+    base_scope.preload(puppet: :environment)
+  end
+
+  unless ForemanPuppet.extracted_from_core?
+    Rails.application.config.after_initialize do
+      list = Pagelets::Manager.instance.instance_variable_get(:@pagelets)['hosts/_form'][:main_tabs]
+      core_pagelet = list.detect { |pagelet| pagelet.opts[:id] == :puppet_klasses }
+      list.delete(core_pagelet)
+    end
+  end
+
+  extend_template_helpers(ForemanPuppet::TemplateRendererScope)
+
+  # extend host(group) form with puppet ENC Tab
+  %i[host hostgroup].each do |resource_type|
+    host_onlyif = ->(host, context) { context.send(:accessible_resource, host, :smart_proxy, :name, association: :puppet_proxy).present? }
+    extend_page("#{resource_type}s/_form") do |context|
+      context.add_pagelet :main_tabs,
+        id: :puppet_enc_tab,
+        name: N_('Puppet ENC'),
+        partial: 'hosts/form_puppet_enc_tab',
+        resource_type: resource_type,
+        priority: 100,
+        onlyif: (host_onlyif if resource_type == :host)
+
+      if ForemanPuppet.extracted_from_core?
+        context.add_pagelet :main_tab_fields,
+          partial: 'hosts/foreman_puppet/form_main_tab_fields',
+          resource_type: resource_type,
+          priority: 100
+      end
+    end
+  end
+end