foreman_puppet 0.0.1

data/README.md

@@ -0,0 +1,38 @@
+# ForemanPuppet
+
+Adds Puppet External node classification funcionality for [Foreman](theforeman.org).
+
+## Installation
+
+See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
+for how to install Foreman plugins
+
+## Usage
+
+*Usage here*
+
+## TODO
+
+*Todo list here*
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) *year* *your name*
+
+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
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+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/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+foreman_path = Dir['./foreman', '../foreman', '../../foreman']
+foreman_path.select! { |path| File.exist?(File.join(path, 'Gemfile')) }
+raise 'Foreman have not been found!' unless foreman_path.any?
+foreman_path = File.expand_path(foreman_path.first, __dir__)
+
+# for migrations to work from 'app:db:migrate'
+task 'dynflow:migrate' => 'app:dynflow:migrate'
+task 'parameters:reset_priorities' => 'app:parameters:reset_priorities'
+
+APP_RAKEFILE = File.expand_path('Rakefile', foreman_path)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+Rake::TestTask.new(test: 'app:db:test:prepare') do |t|
+  t.libs << 'test'
+  t.libs << File.join(foreman_path, 'lib')
+  t.libs << File.join(foreman_path, 'test')
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :test

data/app/assets/stylesheets/foreman_puppet.scss

@@ -0,0 +1,117 @@
+#hostclasses,
+.classes li,
+.classes li a {
+  list-style-type: none;
+  margin-right: 0.5em;
+  text-decoration: none;
+}
+
+.classes > ul {
+  margin-bottom: 0;
+  margin-left: -42px;
+}
+
+.puppetclass,
+.puppetclass li,
+.selected_puppetclass,
+.selected_puppetclass li,
+.config_group,
+.config_group li,
+.selected_config_group,
+.selected_config_group li {
+  a {
+    color: #333;
+  }
+
+  a.glyphicon-minus-sign,
+  a.glyphicon-plus-sign {
+    float: right;
+    margin-right: 10px;
+  }
+}
+
+a.config_group_name {
+  color: #428bca;
+}
+
+#params #inherited_puppetclasses_parameters {
+    .overridden .param_name {
+      font-weight: bold;
+    }
+
+    .btn-override {
+      border-top-right-radius: 4px;
+      border-bottom-right-radius: 4px;
+    }
+  }
+}
+
+.lookup_values {
+  .fields {
+    border-top: 1px dotted lightgrey;
+    padding-top: 10px;
+
+    &:nth-child(3) {
+      border-top: none;
+    }
+
+    .btn-hide {
+      display: none;
+    }
+  }
+}
+
+.lookup-keys-container {
+  h6 {
+    margin-top: 0;
+  }
+
+  .help-block {
+    margin: 0;
+  }
+
+  input[type=checkbox] {
+    margin-top: 8px;
+  }
+
+  .nav a.btn-success:focus {
+    background-color: #5cb85c;
+    border-color: #4cae4c;
+  }
+
+  .matcher .matcher-group {
+    display: block;
+  }
+
+  .matcher_value {
+    width: 60%;
+  }
+}
+
+.selected_puppetclass.unavailable a {
+  color: $color-pf-black-400;
+}
+
+#inherited_ids {
+  padding-left: 0;
+}
+
+#inherited-classes .panel-title {
+  font-size: 1.6rem;
+}
+
+#puppet_klasses ul {
+  padding-left: 40px;
+  padding-right: 20px;
+}
+
+.puppetclass_group,
+.config_group_group {
+  li {
+    a {
+      i.glyphicon {
+        font-size: 11px;
+      }
+    }
+  }
+}

data/app/controllers/concerns/foreman_puppet/api/import_puppetclasses_common_controller.rb

@@ -0,0 +1,139 @@
+module ForemanPuppet
+  module Api
+    module ImportPuppetclassesCommonController
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :find_required_puppet_proxy, only: [:import_puppetclasses]
+        before_action :find_environment_id, only: [:import_puppetclasses]
+        before_action :find_optional_environment, only: [:import_puppetclasses]
+      end
+
+      extend Apipie::DSL::Concern
+
+      api :POST, '/smart_proxies/:id/import_puppetclasses', N_('Import puppet classes from puppet proxy')
+      api :POST, '/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses', N_('Import puppet classes from puppet proxy for an environment')
+      api :POST, '/environments/:environment_id/smart_proxies/:id/import_puppetclasses', N_('Import puppet classes from puppet proxy for an environment')
+      param :id, :identifier, required: true
+      param :smart_proxy_id, String, required: false
+      param :environment_id, String, required: false
+      param :dryrun, :bool, required: false
+      param :except, String, required: false, desc: N_('Optional comma-delimited string'\
+                                                       "containing either 'new', 'updated', or 'obsolete'"\
+                                                       'that is used to limit the imported Puppet classes')
+
+      def import_puppetclasses
+        return unless changed_environments
+        # @changed is returned from the method above changed_environments
+        # Limit actions by setting @changed[kind] to empty hash {} (no action)
+        # if :except parameter is passed with comma deliminator import_puppetclasses?except=new,obsolete
+        if params[:except].present?
+          kinds = params[:except].split(',')
+          kinds.each do |kind|
+            @changed[kind] = {} if PuppetClassImporter::CHANGE_KINDS.include?(kind)
+          end
+        end
+
+        # DRYRUN - /import_puppetclasses?dryrun - do not run PuppetClassImporter
+        rabl_template = @environment ? 'show' : 'index'
+        if params.key?('dryrun') && ['false', false].exclude?(params['dryrun'])
+          render("foreman_puppet/api/v#{api_version}/import_puppetclasses/#{rabl_template}", layout: 'api/layouts/import_puppetclasses_layout')
+          return
+        end
+
+        # RUN PuppetClassImporter
+        if (errors = PuppetClassImporter.new.obsolete_and_new(@changed)).empty?
+          render("foreman_puppet/api/v#{api_version}/import_puppetclasses/#{rabl_template}", layout: 'api/layouts/import_puppetclasses_layout')
+        else
+          render json: {
+            message: _('Failed to update the environments and Puppet classes from the on-disk puppet installation: %s') % errors.join(', '),
+          }, status: :internal_server_error
+        end
+      end
+
+      private
+
+      def changed_environments
+        @changed = import_changed_proxy_environments
+        return false unless @changed
+
+        # PuppetClassImporter expects [kind][env] to be in json format
+        PuppetClassImporter::CHANGE_KINDS.each do |kind|
+          next if (envs = @changed[kind]).empty?
+          envs.keys.sort.each do |env|
+            @changed[kind][env] = @changed[kind][env].to_json
+          end
+        end
+
+        # @environments is used in import_puppletclasses/index.json.rabl
+        environment_names = (@changed['new'].keys + @changed['obsolete'].keys +
+                             @changed['updated'].keys + @changed['ignored'].keys).uniq.sort
+
+        @environments = environment_names.map do |name|
+          OpenStruct.new(name: name)
+        end
+
+        unless @environments.any?
+          render_message(_('No changes to your environments detected'))
+          return false
+        end
+
+        @environments.any?
+      end
+
+      def import_changed_proxy_environments
+        opts = { url: @smart_proxy.url }
+        opts[:env] = if @environment.present?
+                       @environment.name
+                     else
+                       @env_id
+                     end
+        @importer = PuppetClassImporter.new(opts)
+        changed = @importer.changes
+
+        # check if environemnt id passed in URL is name of NEW environment in puppetmaster that doesn't exist in db
+        if @environment || (changed['new'].key?(@env_id) && (@environment ||= OpenStruct.new(name: @env_id)))
+          # only return :keys equal to @environment in @changed hash
+          %w[new obsolete updated ignored].each do |kind|
+            changed[kind].slice!(@environment.name) unless changed[kind].empty?
+          end
+        end
+        changed
+      rescue StandardError => e
+        if /puppet feature/i.match?(e.message)
+          msg = _('No proxy found to import classes from, ensure that the smart proxy has the Puppet feature enabled.')
+        else
+          Foreman::Logging.exception('Error while importing Puppet classes', e)
+          msg = e.message
+        end
+        render_message(msg, status: :internal_server_error)
+        nil
+      end
+
+      def find_required_puppet_proxy
+        id = params.key?('smart_proxy_id') ? params['smart_proxy_id'] : params['id']
+        @smart_proxy = SmartProxy.authorized(:view_smart_proxies).find(id)
+        unless @smart_proxy && SmartProxy.with_features('Puppet').exists?(id: @smart_proxy.id)
+          not_found _('No proxy found to import classes from, ensure that the smart proxy has the Puppet feature enabled.')
+        end
+        @smart_proxy
+      end
+
+      def find_environment_id
+        @env_id = if params.key?('environment_id')
+                    params['environment_id']
+                  elsif params.key?('smart_proxy_id') && params['id'].present?
+                    params['id']
+                  end
+        @env_id
+      end
+
+      def find_optional_environment
+        @environment = Environment.authorized(:view_environments).find(@env_id) if @env_id
+      rescue ActiveRecord::RecordNotFound => e
+        Foreman::Logging.exception('Resource not found', e, level: :debug)
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# various methods which gets added to the puppetclasses and environments controllers
+
+module ForemanPuppet
+  module EnvironmentsImport
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :importer, only: :import_environments
+    end
+
+    def import_environments
+      @changed = importer.changes
+
+      if @importer.ignored_boolean_environment_names?
+        warning(_('Ignored environment names resulting in booleans found. Please quote strings like true/false and yes/no in config/ignored_environments.yml'))
+      end
+
+      if !@changed['new'].empty? || !@changed['obsolete'].empty? || !@changed['updated'].empty?
+        render 'common/_puppetclasses_or_envs_changed'
+      else
+        info_message = _('No changes to your environments detected')
+
+        list_ignored(info_message, @changed['ignored']) if @changed['ignored'].present?
+
+        info info_message
+        redirect_to controller: controller_path
+      end
+    end
+
+    def obsolete_and_new
+      if (errors = PuppetClassImporter.new.obsolete_and_new(params[:changed])).empty?
+        success _('Successfully updated environments and Puppet classes from the on-disk Puppet installation')
+      else
+        error _('Failed to update environments and Puppet classes from the on-disk Puppet installation: %s') % errors.to_sentence
+      end
+      redirect_to controller: controller_path
+    end
+
+    private
+
+    def importer
+      opts = params[:proxy].blank? ? {} : { url: SmartProxy.find(params[:proxy]).try(:url) }
+      opts[:env] = params[:env] if params[:env].present?
+      @importer = PuppetClassImporter.new(opts)
+    rescue ::Foreman::Exception => _e
+      error _("No smart proxy was found to import environments from, ensure that at least one smart proxy is registered with the 'puppet' feature")
+      redirect_to controller: controller_path
+    end
+
+    def list_ignored(info_message, ignored)
+      environments = ignored.select { |_, values| values.first == '_ignored_' }
+      ignore_info = if environments.any?
+                      _('Ignored environments: %s') % environments.keys.to_sentence
+                    else
+                      _('Ignored classes in the environments: %s') % ignored.keys.to_sentence
+                    end
+
+      info_message << "\n" << ignore_info
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module ForemanPuppet
+  module Extensions
+    module ApiHostgroupsController
+      extend ActiveSupport::Concern
+
+      included do
+        prepend PatchMethods
+
+        if ForemanPuppet.extracted_from_core?
+          method_desc = Apipie.get_method_description(self, :index)
+          method_desc.apis << Apipie::MethodDescription::Api.new(:GET, '/puppetclasses/:puppetclass_id/hostgroups', N_('List all host groups for a Puppet class'), {})
+
+          apipie_update_methods([:index]) do
+            param :puppetclass_id, String, desc: N_('ID of Puppetclass')
+          end
+
+          apipie_update_methods(%i[create update]) do
+            param :hostgroup, Hash do
+              param :environment_id, String, desc: N_('Deprecated in favor of hostgroup/puppet_attributes/environment_id')
+              param :puppetclass_ids, Array, desc: N_('Deprecated in favor of hostgroup/puppet_attributes/puppetclass_ids')
+              param :config_group_ids, Array, desc: N_('Deprecated in favor of hostgroup/puppet_attributes/config_group_ids')
+
+              param :puppet_attributes, Hash do
+                param :environment_id, String, desc: N_('ID of associated puppet Environment')
+                param :puppetclass_ids, Array, desc: N_('IDs of associated Puppetclasses')
+                param :config_group_ids, Array, desc: N_('IDs of associated ConfigGroups')
+              end
+            end
+          end
+        end
+      end
+
+      module PatchMethods
+        def allowed_nested_id
+          super | ['puppetclass_id']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module ForemanPuppet
+  module Extensions
+    module ApiTemplateCombinationsController
+      extend ActiveSupport::Concern
+
+      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')
+          end
+        end
+
+        prepend PrependedMethods
+      end
+
+      module PrependedMethods
+        def allowed_nested_id
+          super | ['environment_id']
+        end
+      end
+    end
+  end
+end