hammer_cli_foreman_puppet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8cf103215c0693d5edeedfba47ce25c89a894b042ab4da48d16839d414b49c0
+  data.tar.gz: 740d0819a7ca0142f7f962df9aef29a0bd6f6cc27e8ac8bfdf5ae8f246b027d1
+SHA512:
+  metadata.gz: 4ca662500bc6c2fea49c077daadfa82b4cceb26af0f3668adb21f6b013579e6ef07397d230a1b4928c5993c6b49bb07d350ffbfe7488e9aa5cc0b9d893c24fca
+  data.tar.gz: ecbd3bae2f043ae3e5bba7887343aee0d121bbc1523454b8ec3644ace72465203aead339ac6ab489c2f4d347ebab19aa2cb17b815e2a4d521950b300b82a33a6

data/LICENSE

@@ -0,0 +1,5 @@
+This program and entire repository 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 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/README.md

@@ -0,0 +1,20 @@
+[WIP] hammer_cli_foreman_puppet
+=========================================
+
+This [Hammer CLI](https://github.com/theforeman/hammer-cli) plugin contains
+set of commands for puppet.
+Configuration
+-------------
+
+Configuration is expected to be placed in one of hammer's configuration directories for plugins:
+- `/etc/hammer/cli.modules.d/`
+- `~/.hammer/cli.modules.d/`
+- `./.config/cli.modules.d/` (config dir in CWD)
+
+If you install `hammer_cli_foreman_puppet` from source you'll have to copy the config file manually
+from `config/foreman_puppet.yml`.
+
+License
+-------
+
+This project is licensed under the GPLv3+.

data/config/foreman_puppet.yml

@@ -0,0 +1,2 @@
+:foreman_puppet:
+  :enable_module: true

data/lib/hammer_cli_foreman_puppet.rb

@@ -0,0 +1,57 @@
+module HammerCLIForemanPuppet
+  require 'hammer_cli'
+  require 'hammer_cli_foreman'
+
+  require 'hammer_cli_foreman_puppet/version'
+  require 'hammer_cli_foreman_puppet/puppet_references'
+  require 'hammer_cli_foreman_puppet/environment_name_mapping'
+  require 'hammer_cli_foreman_puppet/commands'
+  require 'hammer_cli_foreman_puppet/command_extensions'
+  require 'hammer_cli_foreman_puppet/option_sources'
+  require 'hammer_cli_foreman_puppet/associating_commands'
+  require 'hammer_cli_foreman_puppet/id_resolver'
+
+  # Puppet commands
+  require 'hammer_cli_foreman_puppet/smart_class_parameter'
+  require 'hammer_cli_foreman_puppet/environment'
+  require 'hammer_cli_foreman_puppet/config_group'
+  require 'hammer_cli_foreman_puppet/class'
+
+  # extensions to hammer_cli_foreman commands
+  require 'hammer_cli_foreman_puppet/host'
+  require 'hammer_cli_foreman_puppet/organization'
+  require 'hammer_cli_foreman_puppet/location'
+  require 'hammer_cli_foreman_puppet/smart_proxy'
+  require 'hammer_cli_foreman_puppet/combination'
+  require 'hammer_cli_foreman_puppet/hostgroup'
+
+  HammerCLI::MainCommand.lazy_subcommand(
+    'puppet-class',
+    _('Manage Foreman Puppet classes'),
+    'HammerCLIForemanPuppet::PuppetClass',
+    'hammer_cli_foreman_puppet/class'
+  )
+  HammerCLI::MainCommand.lazy_subcommand(
+    'puppet-environment',
+    _('Manage Foreman Puppet environments'),
+    'HammerCLIForemanPuppet::PuppetEnvironment',
+    'hammer_cli_foreman_puppet/environment'
+  )
+  HammerCLI::MainCommand.lazy_subcommand(
+    'config-group',
+    _('Manage Foreman config groups'),
+    'HammerCLIForemanPuppet::ConfigGroup',
+    'hammer_cli_foreman_puppet/config_group'
+  )
+  HammerCLI::MainCommand.lazy_subcommand(
+    'sc-param',
+    _('Manage Foreman Puppet smart class parameters'),
+    'HammerCLIForemanPuppet::SmartClassParameter',
+    'hammer_cli_foreman_puppet/smart_class_parameter'
+  )
+
+  # plugins extensions
+  begin
+    require 'hammer_cli_foreman_puppet/discovery'
+  rescue LoadError
+end

data/lib/hammer_cli_foreman_puppet/associating_commands.rb

@@ -0,0 +1 @@
+require 'hammer_cli_foreman_puppet/associating_commands/associating_commands'

data/lib/hammer_cli_foreman_puppet/associating_commands/associating_commands.rb

@@ -0,0 +1,40 @@
+module HammerCLIForemanPuppet
+  module AssociatingCommands
+    module ExtendCommands
+      def create_subcommand(name = :PuppetEnvironment)
+        commands = constants.select { |c| c.to_s.include? name.to_s }.map { |p| const_get(p)}
+        commands.each do |command|
+          subcommand(command.command_name, command.desc, command, warning: command.warning)
+        end
+      end
+    end
+
+    module PuppetEnvironment
+      extend HammerCLIForeman::AssociatingCommands::CommandExtension
+
+      class AddPuppetEnvironmentCommand < HammerCLIForemanPuppet::AddAssociatedCommand
+        include EnvironmentNameMapping
+        associated_resource :environments
+        desc _('Associate a Puppet environment')
+        command_name "add-environment"
+
+        success_message _("The environment has been associated.")
+        failure_message _("Could not associate the environment")
+
+        extend_with(HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new)
+      end
+
+      class RemovePuppetEnvironmentCommand < HammerCLIForemanPuppet::RemoveAssociatedCommand
+        include EnvironmentNameMapping
+        associated_resource :environments
+        desc _('Disassociate a Puppet environment')
+        command_name "remove-environment"
+
+        success_message _("The environment has been disassociated.")
+        failure_message _("Could not disassociate the environment")
+
+        extend_with(HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new)
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/class.rb

@@ -0,0 +1,54 @@
+module HammerCLIForemanPuppet
+  class PuppetClass < HammerCLIForemanPuppet::Command
+
+    resource :puppetclasses
+
+    class ListCommand < HammerCLIForemanPuppet::ListCommand
+      output do
+        field :id, _("Id")
+        field :name, _("Name")
+      end
+
+      def send_request
+        self.class.unhash_classes(super)
+      end
+
+      def self.unhash_classes(classes)
+        clss = classes.first.inject([]) { |list, (pp_module, pp_module_classes)| list + pp_module_classes }
+
+        HammerCLI::Output::RecordCollection.new(clss, :meta => classes.meta)
+      end
+
+      build_options
+
+      extend_with(HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new)
+    end
+
+    class InfoCommand < HammerCLIForemanPuppet::InfoCommand
+      output ListCommand.output_definition do
+        collection :smart_class_parameters, _('Smart class parameters'), :numbered => false do
+          custom_field Fields::Reference, :name_key => :parameter
+        end
+        HammerCLIForeman::References.hostgroups(self)
+        HammerCLIForemanPuppet::PuppetReferences.environments(self)
+        HammerCLIForeman::References.parameters(self)
+      end
+
+      build_options
+
+      extend_with(HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new)
+    end
+
+
+    class SCParamsCommand < HammerCLIForemanPuppet::SmartClassParametersBriefList
+      build_options_for :puppetclasses
+
+      def validate_options
+        super
+        validator.any(:option_puppetclass_name, :option_puppetclass_id).required
+      end
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman_puppet/combination.rb

@@ -0,0 +1,14 @@
+
+require 'hammer_cli_foreman/combination'
+
+module HammerCLIForemanPuppet
+  HammerCLIForeman::Combination::InfoCombination.extend_with(
+    HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
+  )
+  HammerCLIForeman::Combination::UpdateCombination.extend_with(
+    HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
+  )
+  HammerCLIForeman::Combination::CreateCombination.extend_with(
+    HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
+  )
+end

data/lib/hammer_cli_foreman_puppet/command_extensions.rb

@@ -0,0 +1,2 @@
+require 'hammer_cli_foreman_puppet/command_extensions/environment'
+require 'hammer_cli_foreman_puppet/command_extensions/environments'

data/lib/hammer_cli_foreman_puppet/command_extensions/discovery.rb

@@ -0,0 +1,8 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class Provision < HammerCLI::CommandExtensions
+      option "--puppetclass-ids", "PUPPETCLASS_IDS", " ",
+        :format => HammerCLI::Options::Normalizers::List.new
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/command_extensions/environment.rb

@@ -0,0 +1,24 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class PuppetEnvironment < HammerCLI::CommandExtensions
+      # FIXME: Temp workaround for option builders in case of multiple plugins
+      # extensions of the same command
+      option_family do
+        parent '--puppet-environment-id', 'PUPPET_ENVIRONMENT_ID', _('ID of associated Puppet environment'),
+               format: HammerCLI::Options::Normalizers::Number.new,
+               attribute_name: :option_environment_id
+        child '--puppet-environment', 'PUPPET_ENVIRONMENT_NAME', _('Name of associated Puppet environment'),
+              attribute_name: :option_environment_name
+      end
+
+      option_sources do |sources, command|
+        sources.find_by_name('IdResolution').insert_relative(
+          :after,
+          'IdParams',
+          HammerCLIForemanPuppet::OptionSources::PuppetEnvironmentParams.new(command)
+        )
+        sources
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/command_extensions/environments.rb

@@ -0,0 +1,24 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class PuppetEnvironments < HammerCLI::CommandExtensions
+      # FIXME: Temp workaround for option builders in case of multiple plugins
+      # extensions of the same command
+      option_family do
+        parent '--puppet-environment-ids', 'PUPPET_ENVIRONMENT_IDS', _('IDs of associated Puppet environment'),
+               format: HammerCLI::Options::Normalizers::List.new,
+               attribute_name: :option_environment_ids
+        child '--puppet-environments', 'PUPPET_ENVIRONMENT_NAMES', _('Names of associated Puppet environment'),
+              attribute_name: :option_environment_names
+      end
+
+      option_sources do |sources, command|
+        sources.find_by_name('IdResolution').insert_relative(
+          :after,
+          'IdsParams',
+          HammerCLIForemanPuppet::OptionSources::PuppetEnvironmentParams.new(command)
+        )
+        sources
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/command_extensions/host.rb

@@ -0,0 +1,41 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class Host < HammerCLI::CommandExtensions
+      output do |definition|
+        definition.insert(:after, :location, HammerCLIForemanPuppet::Host::InfoCommand.output_definition.fields)
+      end
+    end
+
+    class HostPuppetProxy < HammerCLI::CommandExtensions
+      option_family(
+        format: HammerCLI::Options::Normalizers::List.new,
+        aliased_resource: 'puppet-class',
+        description: 'Names/Ids of associated Puppet classes'
+      ) do
+        parent '--puppet-class-ids', 'PUPPET_CLASS_IDS', _('List of Puppet class ids'),
+               attribute_name: :option_puppetclass_ids
+        child '--puppet-classes', 'PUPPET_CLASS_NAMES', '',
+              attribute_name: :option_puppetclass_names
+      end
+      option '--puppet-ca-proxy', 'PUPPET_CA_PROXY_NAME', _('Name of Puppet CA proxy')
+      option '--puppet-proxy', 'PUPPET_PROXY_NAME', _('Name of Puppet proxy')
+
+      request_params do |params, command_object|
+        if command_object.option_puppet_proxy
+          params['host']['puppet_proxy_id'] ||= HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.proxy_id(
+            command_object.resolver, command_object.option_puppet_proxy
+          )
+        end
+        if command_object.option_puppet_ca_proxy
+          params['host']['puppet_ca_proxy_id'] ||= HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.proxy_id(
+            command_object.resolver, command_object.option_puppet_ca_proxy
+          )
+        end
+      end
+
+      def self.proxy_id(resolver, name)
+        resolver.smart_proxy_id('option_name' => name)
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/command_extensions/hostgroup.rb

@@ -0,0 +1,47 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class HostgroupInfo < HammerCLI::CommandExtensions
+      output do |definition|
+        definition.insert(:after, :compute_resource, HammerCLIForemanPuppet::Hostgroup::InfoCommand.output_definition.fields)
+      end
+    end
+
+    class HostgroupList < HammerCLI::CommandExtensions
+      output do |definition|
+        definition.insert(:after, :operatingsystem, HammerCLIForemanPuppet::Hostgroup::ListCommand.output_definition.fields)
+      end
+    end
+
+    class HostgroupPuppetProxy < HammerCLI::CommandExtensions
+      option_family(
+        format: HammerCLI::Options::Normalizers::List.new,
+        aliased_resource: 'puppet-class',
+        description: 'Names/Ids of associated Puppet classes'
+      ) do
+        parent '--puppet-class-ids', 'PUPPET_CLASS_IDS', _('List of Puppet class ids'),
+               attribute_name: :option_puppetclass_ids
+        child '--puppet-classes', 'PUPPET_CLASS_NAMES', '',
+              attribute_name: :option_puppetclass_names
+      end
+      option '--puppet-ca-proxy', 'PUPPET_CA_PROXY_NAME', _('Name of Puppet CA proxy')
+      option '--puppet-proxy', 'PUPPET_PROXY_NAME', _('Name of Puppet proxy')
+
+      request_params do |params, command_object|
+        if command_object.option_puppet_proxy
+          params['hostgroup']['puppet_proxy_id'] ||= HammerCLIForemanPuppet::CommandExtensions::HostgroupPuppetProxy.proxy_id(
+            command_object.resolver, command_object.option_puppet_proxy
+          )
+        end
+        if command_object.option_puppet_ca_proxy
+          params['hostgroup']['puppet_ca_proxy_id'] ||= HammerCLIForemanPuppet::CommandExtensions::HostgroupPuppetProxy.proxy_id(
+            command_object.resolver, command_object.option_puppet_ca_proxy
+          )
+        end
+      end
+
+      def self.proxy_id(resolver, name)
+        resolver.smart_proxy_id('option_name' => name)
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/command_extensions/location.rb

@@ -0,0 +1,9 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class LocationInfo < HammerCLI::CommandExtensions
+      output do |definition|
+        definition.insert(:after, :realms, HammerCLIForemanPuppet::Location::InfoCommand.output_definition.fields)
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/command_extensions/organization.rb

@@ -0,0 +1,9 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class OrganizationInfo < HammerCLI::CommandExtensions
+      output do |definition|
+        definition.insert(:after, :realms, HammerCLIForemanPuppet::Organization::InfoCommand.output_definition.fields)
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/commands.rb

@@ -0,0 +1,76 @@
+module HammerCLIForemanPuppet
+  RESOURCE_NAME_MAPPING = {
+    :puppetclass => :puppet_class,
+    :puppetclasses => :puppet_classes,
+    :environment => :puppet_environment,
+    :environments => :puppet_environments
+  }.freeze
+
+  RESOURCE_ALIAS_NAME_MAPPING = {
+    environment: :puppet_environment,
+    environments: :puppet_environments
+  }.freeze
+
+  module ResolverCommons
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    module ClassMethods
+
+      def api_connection
+        if HammerCLI.context[:api_connection]
+          HammerCLI.context[:api_connection].get("foreman")
+        else
+          HammerCLI::Connection.get("foreman").api
+        end
+      end
+
+      def resolver
+        HammerCLIForemanPuppet::IdResolver.new(
+          api_connection,
+          HammerCLIForemanPuppet::Searchables.new
+        )
+      end
+      def resource_name_mapping
+        HammerCLIForemanPuppet::RESOURCE_NAME_MAPPING.dup
+      end
+
+      def searchables
+        @searchables ||= HammerCLIForemanPuppet::Searchables.new
+        @searchables
+      end
+    end
+  end
+
+  class Command < HammerCLIForeman::Command
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+
+  class UpdateCommand < HammerCLIForeman::UpdateCommand
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+
+  class InfoCommand < HammerCLIForeman::InfoCommand
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+
+  class CreateCommand < HammerCLIForeman::CreateCommand
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+
+  class DeleteCommand < HammerCLIForeman::DeleteCommand
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+
+  class ListCommand < HammerCLIForeman::ListCommand
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+
+  class AddAssociatedCommand < HammerCLIForeman::AddAssociatedCommand
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+
+  class RemoveAssociatedCommand < HammerCLIForeman::RemoveAssociatedCommand
+    include HammerCLIForemanPuppet::ResolverCommons
+  end
+end