hammer_cli_foreman_puppet 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f92851cfcdf0a8b5ec003d8cbbc5ef6b4d36affce07208844df5608a5f5459b1
-  data.tar.gz: 565bfa4263e76e6826ed8a30d42e6cdbb611bff5261cd87b07c432273811adfa
+  metadata.gz: 70ea47a81549cde7da9bbdce56937da3c20d4936cc7ebc526cf0d671890e2e80
+  data.tar.gz: 042c018b0757d76f33b5284247a4f84edfceb1d102f48aabd0497399ddc2abb8
 SHA512:
-  metadata.gz: e69a1c28719c4076502b00baddcd54f618c70b3ca8984ff6586134a0cb7d7ef8fac2e0cd4de3ccc1453338bf6c9b4e2e60a7c3256273ce798291a050856ea014
-  data.tar.gz: c5fa4ef46e9139c3369617a4766bdb71bddb77b94a9279de999e39275337e5766872c8158ce2235027143b881f76d1b9b8d896f89bf388f4e2430b18d0d82b68
+  metadata.gz: 1f4fd40cca5fba2861777cea022d2aed231594e654f73091f0f9861b5f0c15cfa31258dacbf5334988430eb37fed18bc837e10ad52b3ba070016d144d5cbd3cc
+  data.tar.gz: 833af50bdc2165b5b9f93e9dbc056a57379cec64c21251c0ffb707497699df4c76ec9b125fe80b596e2ca91dad4630b4c89654198149d7801ca05ce379a5b3b3

data/README.md

@@ -1,20 +1,32 @@
-[WIP] hammer_cli_foreman_puppet
-=========================================
+# Hammer CLI Foreman Puppet
 
-This [Hammer CLI](https://github.com/theforeman/hammer-cli) plugin contains
-set of commands for puppet.
-Configuration
--------------
+This Hammer CLI plugin contains a set of commands for [foreman_puppet](https://github.com/theforeman/foreman_puppet), a plugin that adds Puppet functionality to Foreman.
 
-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)
+## Compatibility
 
-If you install `hammer_cli_foreman_puppet` from source you'll have to copy the config file manually
-from `config/foreman_puppet.yml`.
+This is the list of which version of Foreman Puppet and Foreman are needed for which version of this plugin.
 
-License
--------
+|foreman        |foreman_puppet|hammer-cli-puppet |   Notes                                                 |
+|---------------|--------------|----------------- |---------------------------                              |
+| >= 3.0        | ~> 1.0       |  >= 0.0.3        |  Required                                               |
+| <= 2.5        | ~> 0.1       |     -            |  Not supported (functionality is in [hammer-cli-foreman](https://github.com/theforeman/hammer-cli-foreman)) |
 
-This project is licensed under the GPLv3+.
+## Installation
+
+    $ gem install hammer_cli_foreman_puppet
+
+    $ mkdir -p ~/.hammer/cli.modules.d/
+
+    $ cat <<EOQ > ~/.hammer/cli.modules.d/foreman_puppet.yml
+    :foreman_puppet:
+      :enable_module: true
+    EOQ
+
+## Problems
+
+Please feel free to open a [new Github issue](https://github.com/theforeman/hammer-cli-foreman-puppet/issues/new) if you encounter any bugs/issues using this plugin.
+
+## More info
+
+See our [Hammer CLI installation and configuration instuctions](
+https://github.com/theforeman/hammer-cli/blob/master/doc/installation.md#installation).

data/lib/hammer_cli_foreman_puppet/combination.rb

@@ -1,13 +1,36 @@
 
 require 'hammer_cli_foreman/combination'
+require 'hammer_cli_foreman_puppet/command_extensions/combination'
 
 module HammerCLIForemanPuppet
+  class Combination < HammerCLIForemanPuppet::Command
+    class ListCommand < HammerCLIForemanPuppet::ListCommand
+      output do
+        field nil, _("Puppet Environment"), Fields::SingleReference, :key => :environment
+      end
+    end
+
+    class InfoCommand < HammerCLIForemanPuppet::InfoCommand
+      include EnvironmentNameMapping
+      output ListCommand.output_definition do
+        field :environment_id, _('Puppet Environment ID')
+        field :environment_name, _('Puppet Environment name')
+      end
+    end
+  end
+
+  HammerCLIForeman::Combination::ListCombination.extend_with(
+    HammerCLIForemanPuppet::CommandExtensions::ListCombination.new
+  )
   HammerCLIForeman::Combination::InfoCombination.extend_with(
+    HammerCLIForemanPuppet::CommandExtensions::InfoCombination.new,
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
   )
+  HammerCLIForeman::Combination::UpdateCombination.include(HammerCLIForemanPuppet::EnvironmentNameMapping)
   HammerCLIForeman::Combination::UpdateCombination.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
   )
+  HammerCLIForeman::Combination::CreateCombination.include(HammerCLIForemanPuppet::EnvironmentNameMapping)
   HammerCLIForeman::Combination::CreateCombination.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
   )

data/lib/hammer_cli_foreman_puppet/command_extensions/combination.rb

@@ -0,0 +1,15 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class ListCombination < HammerCLI::CommandExtensions
+      output do |definition|
+        definition.insert(:after, :hostgroup, HammerCLIForemanPuppet::Combination::ListCommand.output_definition.fields)
+      end
+    end
+
+    class InfoCombination < HammerCLI::CommandExtensions
+        output do |definition|
+          definition.insert(:after, :hostgroup_name, HammerCLIForemanPuppet::Combination::InfoCommand.output_definition.fields)
+        end
+      end
+  end
+end

data/lib/hammer_cli_foreman_puppet/command_extensions/host.rb

@@ -17,8 +17,22 @@ module HammerCLIForemanPuppet
         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')
+      option_family(
+        format: HammerCLI::Options::Normalizers::List.new,
+        aliased_resource: 'config_group',
+        description: 'Names/Ids of associated config groups'
+      ) do
+        parent '--config-group-ids', 'CONFIG_GROUP_IDS', _('IDs of associated config groups'),
+               attribute_name: :option_config_group_ids
+        child '--config-groups', 'CONFIG_GROUP_NAMES', '',
+              attribute_name: :option_config_group_names
+      end
+      option_family associate: 'puppet_proxy' do
+        child '--puppet-proxy', 'PUPPET_PROXY_NAME', _('Name of Puppet proxy')
+      end
+      option_family associate: 'puppet_ca_proxy' do
+        child '--puppet-ca-proxy', 'PUPPET_CA_PROXY_NAME', _('Name of Puppet CA proxy')
+      end
 
       request_params do |params, command_object|
         if command_object.option_puppet_proxy
@@ -36,6 +50,17 @@ module HammerCLIForemanPuppet
       def self.proxy_id(resolver, name)
         resolver.smart_proxy_id('option_name' => name)
       end
+
+      def self.delete_deprecated_options(command_class)
+        %w[--puppetclass-ids --environment-id --config-group-ids].each do |switch|
+          family = command_class.option_families.find do |f|
+            f.head.switches.include?(switch)
+          end
+          command_class.declared_options.delete_if do |o|
+            family.all.include?(o)
+          end
+        end
+      end
     end
   end
 end

data/lib/hammer_cli_foreman_puppet/command_extensions/hostgroup.rb

@@ -23,6 +23,16 @@ module HammerCLIForemanPuppet
         child '--puppet-classes', 'PUPPET_CLASS_NAMES', '',
               attribute_name: :option_puppetclass_names
       end
+      option_family(
+        format: HammerCLI::Options::Normalizers::List.new,
+        aliased_resource: 'config_group',
+        description: 'Names/Ids of associated config groups'
+      ) do
+        parent '--config-group-ids', 'CONFIG_GROUP_IDS', _('IDs of associated config groups'),
+               attribute_name: :option_config_group_ids
+        child '--config-groups', 'CONFIG_GROUP_NAMES', '',
+              attribute_name: :option_config_group_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')
 
@@ -42,6 +52,17 @@ module HammerCLIForemanPuppet
       def self.proxy_id(resolver, name)
         resolver.smart_proxy_id('option_name' => name)
       end
+
+      def self.delete_deprecated_options(command_class)
+        %w[--puppetclass-ids --environment-id --config-group-ids].each do |switch|
+          family = command_class.option_families.find do |f|
+            f.head.switches.include?(switch)
+          end
+          command_class.declared_options.delete_if do |o|
+            family.all.include?(o)
+          end
+        end
+      end
     end
   end
 end

data/lib/hammer_cli_foreman_puppet/host.rb

@@ -55,11 +55,16 @@ module HammerCLIForemanPuppet
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
   )
   HammerCLIForeman::Host::CreateCommand.include(HammerCLIForemanPuppet::EnvironmentNameMapping)
+  # Delete deprecated options explicitly until they are deleted from API
+  HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.delete_deprecated_options(HammerCLIForeman::Host::CreateCommand)
   HammerCLIForeman::Host::CreateCommand.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new,
     HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.new
   )
+
   HammerCLIForeman::Host::UpdateCommand.include(HammerCLIForemanPuppet::EnvironmentNameMapping)
+  # Delete deprecated options explicitly until they are deleted from API
+  HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.delete_deprecated_options(HammerCLIForeman::Host::UpdateCommand)
   HammerCLIForeman::Host::UpdateCommand.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new,
     HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.new

data/lib/hammer_cli_foreman_puppet/hostgroup.rb

@@ -1,5 +1,4 @@
 require 'hammer_cli_foreman/hostgroup'
-require 'hammer_cli_foreman_puppet/references'
 require 'hammer_cli_foreman_puppet/command_extensions/hostgroup.rb'
 
 module HammerCLIForemanPuppet
@@ -42,7 +41,7 @@ module HammerCLIForemanPuppet
         field nil, _("Puppet Environment"), Fields::SingleReference, :key => :environment
         field nil, _("Puppet CA Proxy"), Fields::SingleReference, :key => :puppet_ca_proxy
         field nil, _("Puppet Master Proxy"), Fields::SingleReference, :key => :puppet_proxy
-        HammerCLIForemanPuppet::References.puppetclasses(self)
+        HammerCLIForemanPuppet::PuppetReferences.puppetclasses(self)
       end
     end
   end
@@ -56,11 +55,16 @@ module HammerCLIForemanPuppet
                                           HammerCLIForemanPuppet::Hostgroup::PuppetSCParamsCommand
 
   HammerCLIForeman::Hostgroup::CreateCommand.include(HammerCLIForemanPuppet::EnvironmentNameMapping)
+  # Delete deprecated options explicitly until they are deleted from API
+  HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.delete_deprecated_options(HammerCLIForeman::Hostgroup::CreateCommand)
   HammerCLIForeman::Hostgroup::CreateCommand.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new,
     HammerCLIForemanPuppet::CommandExtensions::HostgroupPuppetProxy.new
   )
+
   HammerCLIForeman::Hostgroup::UpdateCommand.include(HammerCLIForemanPuppet::EnvironmentNameMapping)
+  # Delete deprecated options explicitly until they are deleted from API
+  HammerCLIForemanPuppet::CommandExtensions::HostPuppetProxy.delete_deprecated_options(HammerCLIForeman::Hostgroup::UpdateCommand)
   HammerCLIForeman::Hostgroup::UpdateCommand.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new,
     HammerCLIForemanPuppet::CommandExtensions::HostgroupPuppetProxy.new

data/lib/hammer_cli_foreman_puppet/location.rb

@@ -1,19 +1,11 @@
 require 'hammer_cli_foreman/location'
-require 'hammer_cli_foreman_puppet/references'
 require 'hammer_cli_foreman_puppet/command_extensions/location'
 
 module HammerCLIForemanPuppet
-  module LocationAddAssociatedCommand
-    def self.included(base)
-      HammerCLIForemanPuppet::AssociatingCommands::PuppetEnvironment.extend_command(base)
-      base.create_subcommand
-    end
-  end
-
   class Location < HammerCLIForemanPuppet::Command
     class InfoCommand < HammerCLIForemanPuppet::InfoCommand
       output do
-        HammerCLIForemanPuppet::References.environments(self)
+        HammerCLIForemanPuppet::PuppetReferences.environments(self)
       end
     end
   end
@@ -27,9 +19,4 @@ module HammerCLIForemanPuppet
   HammerCLIForeman::Location::InfoCommand.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::LocationInfo.new
   )
-
-  HammerCLIForeman::Location.class_eval do
-    extend HammerCLIForemanPuppet::AssociatingCommands::ExtendCommands
-    include HammerCLIForemanPuppet::LocationAddAssociatedCommand
-  end
 end

data/lib/hammer_cli_foreman_puppet/organization.rb

@@ -1,19 +1,11 @@
 require 'hammer_cli_foreman/organization'
-require 'hammer_cli_foreman_puppet/references'
 require 'hammer_cli_foreman_puppet/command_extensions/organization'
 
 module HammerCLIForemanPuppet
-  module OrganizationAddAssociatedCommand
-    def self.included(base)
-      HammerCLIForemanPuppet::AssociatingCommands::PuppetEnvironment.extend_command(base)
-      base.create_subcommand
-    end
-  end
-
   class Organization < HammerCLIForemanPuppet::Command
     class InfoCommand < HammerCLIForemanPuppet::InfoCommand
       output do
-        HammerCLIForemanPuppet::References.environments(self)
+        HammerCLIForemanPuppet::PuppetReferences.environments(self)
       end
     end
   end
@@ -27,9 +19,4 @@ module HammerCLIForemanPuppet
   HammerCLIForeman::Organization::InfoCommand.extend_with(
     HammerCLIForemanPuppet::CommandExtensions::OrganizationInfo.new
   )
-
-  HammerCLIForeman::Organization.class_eval do
-    extend HammerCLIForemanPuppet::AssociatingCommands::ExtendCommands
-    include HammerCLIForemanPuppet::OrganizationAddAssociatedCommand
-  end
 end

data/lib/hammer_cli_foreman_puppet/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForemanPuppet
   def self.version
-    @version ||= Gem::Version.new '0.0.3'
+    @version ||= Gem::Version.new '0.0.6'
   end
 end

data/lib/hammer_cli_foreman_puppet.rb

@@ -1,5 +1,6 @@
 module HammerCLIForemanPuppet
   require 'hammer_cli'
+  require 'hammer_cli/logger'
   require 'hammer_cli_foreman'
 
   require 'hammer_cli_foreman_puppet/version'
@@ -8,7 +9,6 @@ module HammerCLIForemanPuppet
   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