hammer_cli_foreman_puppet 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f92851cfcdf0a8b5ec003d8cbbc5ef6b4d36affce07208844df5608a5f5459b1
-  data.tar.gz: 565bfa4263e76e6826ed8a30d42e6cdbb611bff5261cd87b07c432273811adfa
+  metadata.gz: 2073a0e9ebeae64eec1b55d35fae3735af4b7f4bef12f0dcc24ece34a8d906d2
+  data.tar.gz: c0c147e6f74533ed1fcbb8ba2ecc87a6486b831e85234fa79a5734757092fd67
 SHA512:
-  metadata.gz: e69a1c28719c4076502b00baddcd54f618c70b3ca8984ff6586134a0cb7d7ef8fac2e0cd4de3ccc1453338bf6c9b4e2e60a7c3256273ce798291a050856ea014
-  data.tar.gz: c5fa4ef46e9139c3369617a4766bdb71bddb77b94a9279de999e39275337e5766872c8158ce2235027143b881f76d1b9b8d896f89bf388f4e2430b18d0d82b68
+  metadata.gz: 8d7ae1eed57c8d48113706af0a82fe1d6f078587e9c021d827311bf06e3ba5dbe49239b7e97f01fd72a120df317722d1a7e739b94b932757bac6b30d494a60ab
+  data.tar.gz: 707f9ab99b9665c294f4f0f034f6956374790b60166196f8db0325370f55ed988b006cdc0ee964b40b317e7495b679a30a598c49e059e53f6ba5bc463117db50

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/discovery.rb

@@ -0,0 +1,16 @@
+module HammerCLIForemanPuppet
+  module CommandExtensions
+    class Provision < 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
+    end
+  end
+end

data/lib/hammer_cli_foreman_puppet/discovery.rb

@@ -0,0 +1,10 @@
+require 'hammer_cli_foreman_discovery/discovery'
+require 'hammer_cli_foreman_puppet/command_extensions/discovery'
+require 'hammer_cli_foreman_puppet/command_extensions/environment'
+
+module HammerCLIForemanPuppet
+  HammerCLIForemanDiscovery::DiscoveredHost::ProvisionCommand.extend_with(
+    HammerCLIForemanPuppet::CommandExtensions::Provision.new,
+    HammerCLIForemanPuppet::CommandExtensions::PuppetEnvironment.new
+  )
+end

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

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.4'
   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
@@ -49,4 +49,12 @@ module HammerCLIForemanPuppet
     'HammerCLIForemanPuppet::SmartClassParameter',
     'hammer_cli_foreman_puppet/smart_class_parameter'
   )
+
+  # Plugins extensions
+  begin
+    require 'hammer_cli_foreman_puppet/discovery'
+  rescue Exception => e
+    logger = Logging.logger['HammerCLIForemanPuppet::Discovery']
+    logger.debug("Discovery plugin was not found: #{e}")
+  end
 end

data/test/functional/template_test.rb

@@ -10,10 +10,10 @@ describe 'template' do
       params = ['create', '--provisioning-template-id=10', '--hostgroup-id=1', '--puppet-environment-id=1']
       expected_result = success_result("Template combination created.\n")
       api_expects(:template_combinations, :create, 'Create template combination') do |p|
-        p['provisioning_template_id'] == 10 &&
-          p['hostgroup_id'] == 1 &&
+        p['provisioning_template_id'] == '10' &&
+          p['hostgroup_id'] == '1' &&
           p['environment_id'] == 1 &&
-          p['template_combination'] == { 'environment_id' => 1, 'hostgroup_id' => 1 }
+          p['template_combination'] == { 'environment_id' => 1, 'hostgroup_id' => '1' }
       end
 
       result = run_cmd(@cmd + params)
@@ -25,10 +25,10 @@ describe 'template' do
       expected_result = success_result("Template combination updated.\n")
       api_expects(:template_combinations, :update, 'Update template combination') do |p|
         p['id'] == '3' &&
-          p['provisioning_template_id'] == 10 &&
-          p['hostgroup_id'] == 1 &&
+          p['provisioning_template_id'] == '10' &&
+          p['hostgroup_id'] == '1' &&
           p['environment_id'] == 1 &&
-          p['template_combination'] == { 'environment_id' => 1, 'hostgroup_id' => 1 }
+          p['template_combination'] == { 'environment_id' => 1, 'hostgroup_id' => '1' }
       end
 
       result = run_cmd(@cmd + params)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli_foreman_puppet
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Amir Fefer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-05 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hammer_cli_foreman
@@ -30,7 +30,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
-description:
+description: 
 email:
 - amirfefer@gmail.com
 executables: []
@@ -42,10 +42,11 @@ files:
 - config/foreman_puppet.yml
 - lib/hammer_cli_foreman_puppet.rb
 - lib/hammer_cli_foreman_puppet/associating_commands.rb
-- lib/hammer_cli_foreman_puppet/associating_commands/associating_commands.rb
 - lib/hammer_cli_foreman_puppet/class.rb
 - lib/hammer_cli_foreman_puppet/combination.rb
 - lib/hammer_cli_foreman_puppet/command_extensions.rb
+- lib/hammer_cli_foreman_puppet/command_extensions/combination.rb
+- lib/hammer_cli_foreman_puppet/command_extensions/discovery.rb
 - lib/hammer_cli_foreman_puppet/command_extensions/environment.rb
 - lib/hammer_cli_foreman_puppet/command_extensions/environments.rb
 - lib/hammer_cli_foreman_puppet/command_extensions/host.rb
@@ -54,6 +55,7 @@ files:
 - lib/hammer_cli_foreman_puppet/command_extensions/organization.rb
 - lib/hammer_cli_foreman_puppet/commands.rb
 - lib/hammer_cli_foreman_puppet/config_group.rb
+- lib/hammer_cli_foreman_puppet/discovery.rb
 - lib/hammer_cli_foreman_puppet/environment.rb
 - lib/hammer_cli_foreman_puppet/environment_name_mapping.rb
 - lib/hammer_cli_foreman_puppet/host.rb
@@ -65,7 +67,6 @@ files:
 - lib/hammer_cli_foreman_puppet/option_sources/puppet_environment_params.rb
 - lib/hammer_cli_foreman_puppet/organization.rb
 - lib/hammer_cli_foreman_puppet/puppet_references.rb
-- lib/hammer_cli_foreman_puppet/references.rb
 - lib/hammer_cli_foreman_puppet/smart_class_parameter.rb
 - lib/hammer_cli_foreman_puppet/smart_proxy.rb
 - lib/hammer_cli_foreman_puppet/version.rb
@@ -96,7 +97,7 @@ homepage: https://github.com/theforeman/hammer-cli-foreman-puppet
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -111,32 +112,32 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.10
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.6.3
+signing_key: 
 specification_version: 4
 summary: Foreman Puppet plugin for Hammer CLI
 test_files:
-- test/functional/test_helper.rb
-- test/functional/smart_class_parameter_test.rb
+- test/data/2.1/foreman_api.json
+- test/data/3.0/foreman_api.json
+- test/data/README.md
+- test/unit/helpers/command.rb
+- test/unit/helpers/fake_searchables.rb
+- test/unit/helpers/resource_disabled.rb
+- test/unit/apipie_resource_mock.rb
+- test/unit/puppet_class_test.rb
+- test/unit/puppet_environment_test.rb
+- test/unit/smart_class_parameter_test.rb
+- test/unit/test_helper.rb
+- test/unit/test_output_adapter.rb
+- test/unit/config_group_test.rb
+- test/test_helper.rb
 - test/functional/config_group_test.rb
-- test/functional/proxy_test.rb
-- test/functional/template_test.rb
 - test/functional/host/create_test.rb
 - test/functional/host/update_test.rb
 - test/functional/hostgroup/create_test.rb
 - test/functional/hostgroup/update_test.rb
-- test/test_helper.rb
-- test/unit/puppet_environment_test.rb
-- test/unit/test_helper.rb
-- test/unit/smart_class_parameter_test.rb
-- test/unit/config_group_test.rb
-- test/unit/test_output_adapter.rb
-- test/unit/helpers/resource_disabled.rb
-- test/unit/helpers/command.rb
-- test/unit/helpers/fake_searchables.rb
-- test/unit/puppet_class_test.rb
-- test/unit/apipie_resource_mock.rb
-- test/data/README.md
-- test/data/2.1/foreman_api.json
-- test/data/3.0/foreman_api.json
+- test/functional/proxy_test.rb
+- test/functional/smart_class_parameter_test.rb
+- test/functional/test_helper.rb
+- test/functional/template_test.rb

data/lib/hammer_cli_foreman_puppet/associating_commands/associating_commands.rb

@@ -1,40 +0,0 @@
-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/references.rb

@@ -1,22 +0,0 @@
-module HammerCLIForemanPuppet
-
-  module References
-
-    def self.environments(dsl)
-      dsl.build do
-        collection :environments, _("Environments"), :numbered => false do
-          custom_field Fields::Reference
-        end
-      end
-    end
-
-    def self.puppetclasses(dsl)
-      dsl.build do
-        collection :puppetclasses, _("Puppetclasses"), :numbered => false do
-          custom_field Fields::Reference
-        end
-      end
-    end
-
-  end
-end