hammer_cli_foreman 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f81351582f4f713c7186858fda4d98b2e450d5c1
-  data.tar.gz: 6abc6beec85cc11c4677cb4aa8031841a7a54a0b
+  metadata.gz: d452c453ff4c1d71b981aa86267a97d57ad5af89
+  data.tar.gz: 1c3a7f0a5e69bd24c75bddfc0a82ebe3c42c2143
 SHA512:
-  metadata.gz: 807d5903e8b026a982f944fa3d58577d4d5975cd42340b1b6e2784bbdf42708be9f4169c5947ace310c8fc55df3ca7bc5bfab82e065e841ccca81a1c259a8214
-  data.tar.gz: 559d0b261a6069fa02540f0db294dbd9c90f30157055e7a13a5b81f3b3116bd1db1a78710a67f806b800e341755c984182ac07c716fbb02b7c4f3526822cb805
+  metadata.gz: 0a501559d4630e4cb23e0761ec3172ef9e4152e8594abdafa04adf348a0794da761380c21f5534725385f71a8b891f59740d2b80027e45a6d70dc150328bc4b9
+  data.tar.gz: fc59ef6ba743c661725412edd411d91f30cee6f37beeaad218fe3c8a2a13f40ea232a56e1f81f45b3e8a726e9a057594a0179156317f69acea470107b3323de0

data/config/foreman.yml

@@ -14,3 +14,7 @@
 
   # API request timeout. Set to -1 for no timeout
   #:request_timeout: 120 #seconds
+
+  # Follow API redirects. One of :never, :default, :always
+  # Value :default means RestClient default behaviour - follow only in GET and HEAD requests
+  #:follow_redirects: :never

data/doc/host_create.md

@@ -169,7 +169,7 @@ start         # boolean, whether to start the machine or not
 
 Available keys for `--interface`:
 ```
-compute_type                      # one of [:bridge, :network]
+compute_type                      # one of [bridge, network]
 compute_network / compute_bridge  # name of interface according to type
 compute_model                     # one of [virtio, rtl8139, ne2k_pci, pcnet, e1000]
 ```
@@ -231,9 +231,9 @@ memory_mb            # integer number
 cluster              # cluster id from VMware
 path                 # path to folder
 guest_id             # guest OS id form VMware
-scsi_controller_type # id of the controller from VMWare
-hardware_version     # hardware version id from VMWare
-start                # 1/0
+scsi_controller_type # id of the controller from VMware
+hardware_version     # hardware version id from VMware
+start                # Must be a 1 or 0, whether to start the machine or not
 ```
 
 Available keys for `--interface`:

data/doc/release_notes.md

@@ -1,12 +1,30 @@
 Release notes
 =============
 
-### 0.6.2 (2016-03-22)
-* hammer-cli-foreman-0.6.1 misses dependency on apipie-bindings >=0.0.16 ([#14312](http://projects.theforeman.org/issues/14312))
-* Specifying provision and primary flags should not be mandatory ([#13927](http://projects.theforeman.org/issues/13927))
-
-### 0.6.1 (2016-03-15)
-* Host creation error: ApipieBindings::InvalidArgumentTypesError ([#13966](http://projects.theforeman.org/issues/13966))
+### 0.7.0 (2016-06-14)
+* Let print adapters decide whether to paginate ([#15257](http://projects.theforeman.org/issues/15257))
+* Forbid setting smart param override value and puppet default ([#13832](http://projects.theforeman.org/issues/13832))
+* Add rebuild config option for host ([PR#231](https://github.com/theforeman/hammer-cli-foreman/pull/231)) ([#12103](http://projects.theforeman.org/issues/12103))
+* Removing wrong colons from host create docs
+* i18n - remove underscore from override value error message
+* Typo in MissingSeachOptions ([#14007](http://projects.theforeman.org/issues/14007))
+* Add Catalan language ([#14947](http://projects.theforeman.org/issues/14947))
+* Hammer shows incorrect admin status when assign admin role using user group ([#14606](http://projects.theforeman.org/issues/14606))
+* Fixed response parsing for puppetclasses parameter ([#14930](http://projects.theforeman.org/issues/14930))
+* Display locked flag for templates and ptables ([#14943](http://projects.theforeman.org/issues/14943))
+* Document vmware `start` parameter
+* Fixes VMware name in docs for host create
+* Respect per_page set in config file ([#14530](http://projects.theforeman.org/issues/14530))
+* Provide success/failure message for associating commands ([#7492](http://projects.theforeman.org/issues/7492))
+* Add support for Gemfile.local.rb ([#14466](http://projects.theforeman.org/issues/14466))
+* Fixing path in docs for generated test json ([PR#226](https://github.com/theforeman/hammer-cli-foreman/pull/226))
+* Added clone command to config templates ([#13946](http://projects.theforeman.org/issues/13946))
+* Handle API request redirects with useful message ([#11147](http://projects.theforeman.org/issues/11147))
+* Newer version of apipie validates types for arrays ([#13966](http://projects.theforeman.org/issues/13966))
+* Show auth source name for all auth sources ([#7468](http://projects.theforeman.org/issues/7468))
+* Environment and Puppet proxy is not required ([#13926](http://projects.theforeman.org/issues/13926))
+* Added special method for dealing with puppetclasses ([#11880](http://projects.theforeman.org/issues/11880))
+* Make primary and provision flag optional ([#13927](http://projects.theforeman.org/issues/13927))
 
 ### 0.6.0 (2016-02-25)
 * Names of sc-params are immutable ([#13830](http://projects.theforeman.org/issues/13830))

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -39,11 +39,17 @@ module HammerCLIForeman
       class AddHostgroupCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :hostgroups
         desc _("Associate a hostgroup")
+
+        success_message _("The hostgroup has been associated")
+        failure_message _("Could not associate the hostgroup")
       end
 
       class RemoveHostgroupCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :hostgroups
         desc _("Disassociate a hostgroup")
+
+        success_message _("The hostgroup has been disassociated")
+        failure_message _("Could not disassociate the hostgroup")
       end
     end
 
@@ -53,11 +59,17 @@ module HammerCLIForeman
       class AddEnvironmentCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :environments
         desc _("Associate an environment")
+
+        success_message _("The environment has been associated")
+        failure_message _("Could not associate the environment")
       end
 
       class RemoveEnvironmentCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :environments
         desc _("Disassociate an environment")
+
+        success_message _("The environment has been disassociated")
+        failure_message _("Could not disassociate the environment")
       end
     end
 
@@ -67,11 +79,17 @@ module HammerCLIForeman
       class AddDomainCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :domains
         desc _("Associate a domain")
+
+        success_message _("The domain has been associated")
+        failure_message _("Could not associate the domain")
       end
 
       class RemoveDomainCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :domains
         desc _("Disassociate a domain")
+
+        success_message _("The domain has been disassociated")
+        failure_message _("Could not disassociate the domain")
       end
     end
 
@@ -81,11 +99,17 @@ module HammerCLIForeman
       class AddMediumCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :media
         desc _("Associate a medium")
+
+        success_message _("The medium has been associated")
+        failure_message _("Could not associate the medium")
       end
 
       class RemoveMediumCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :media
         desc _("Disassociate a medium")
+
+        success_message _("The medium has been disassociated")
+        failure_message _("Could not disassociate the medium")
       end
     end
 
@@ -95,11 +119,17 @@ module HammerCLIForeman
       class AddSubnetCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :subnets
         desc _("Associate a subnet")
+
+        success_message _("The subnet has been associated")
+        failure_message _("Could not associate the subnet")
       end
 
       class RemoveSubnetCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :subnets
         desc _("Disassociate a subnet")
+
+        success_message _("The subnet has been disassociated")
+        failure_message _("Could not disassociate the subnet")
       end
     end
 
@@ -109,11 +139,17 @@ module HammerCLIForeman
       class AddComputeResourceCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :compute_resources
         desc _("Associate a compute resource")
+
+        success_message _("The compute resource has been associated")
+        failure_message _("Could not associate the compute resource")
       end
 
       class RemoveComputeResourceCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :compute_resources
         desc _("Disassociate a compute resource")
+
+        success_message _("The compute resource has been disassociated")
+        failure_message _("Could not disassociate the compute resource")
       end
     end
 
@@ -124,6 +160,9 @@ module HammerCLIForeman
         associated_resource :smart_proxies
         desc _("Associate a smart proxy")
 
+        success_message _("The smart proxy has been associated")
+        failure_message _("Could not associate the smart proxy")
+
         def associated_resource_name
           "smart-proxy"
         end
@@ -133,6 +172,9 @@ module HammerCLIForeman
         associated_resource :smart_proxies
         desc _("Disassociate a smart proxy")
 
+        success_message _("The smart proxy has been disassociated")
+        failure_message _("Could not disassociate the smart proxy")
+
         def associated_resource_name
           "smart-proxy"
         end
@@ -189,11 +231,17 @@ module HammerCLIForeman
       class AddConfigTemplateCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :config_templates
         desc _("Associate a configuration template")
+
+        success_message _("The configuration template has been associated")
+        failure_message _("Could not associate the configuration template")
       end
 
       class RemoveConfigTemplateCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :config_templates
         desc _("Disassociate a configuration template")
+
+        success_message _("The configuration template has been disassociated")
+        failure_message _("Could not disassociate the configuration template")
       end
     end
 
@@ -203,11 +251,17 @@ module HammerCLIForeman
       class AddOrganizationCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :organizations
         desc _("Associate an organization")
+
+        success_message _("The organization has been associated")
+        failure_message _("Could not associate the organization")
       end
 
       class RemoveOrganizationCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :organizations
         desc _("Disassociate an organization")
+
+        success_message _("The organization has been disassociated")
+        failure_message _("Could not disassociate the organization")
       end
     end
 

data/lib/hammer_cli_foreman/commands.rb

@@ -25,6 +25,7 @@ module HammerCLIForeman
     config[:credentials] = credentials
     config[:logger] = Logging.logger['API']
     config[:api_version] = 2
+    config[:follow_redirects] = HammerCLI::Settings.get(:foreman, :follow_redirects) || :never
     config[:aggressive_cache_checking] = HammerCLI::Settings.get(:foreman, :refresh_cache) || false
     config[:headers] = { "Accept-Language" => HammerCLI::I18n.locale }
     config[:language] = HammerCLI::I18n.locale
@@ -151,7 +152,7 @@ module HammerCLIForeman
       end
       begin
         resolver.send("#{resource.singular_name}_id", opts)
-      rescue HammerCLIForeman::MissingSeachOptions => e
+      rescue HammerCLIForeman::MissingSearchOptions => e
         if (options[:required] == true || resource_search_requested(resource, opts))
           logger.info "Error occured while searching for #{resource.singular_name}"
           raise e
@@ -163,7 +164,7 @@ module HammerCLIForeman
       opts = resolver.scoped_options(resource.singular_name, all_options)
       begin
         resolver.send("#{resource.singular_name}_ids", opts)
-      rescue HammerCLIForeman::MissingSeachOptions => e
+      rescue HammerCLIForeman::MissingSearchOptions => e
         if (options[:required] == true || resource_search_requested(resource, opts, true))
           logger.info "Error occured while searching for #{resource.name}"
           raise e
@@ -187,7 +188,7 @@ module HammerCLIForeman
 
     def send_request
       transform_format(super)
-    rescue HammerCLIForeman::MissingSeachOptions => e
+    rescue HammerCLIForeman::MissingSearchOptions => e
 
       switches = self.class.find_options(:referenced_resource => e.resource.singular_name).map(&:long_switch)
 
@@ -199,7 +200,7 @@ module HammerCLIForeman
         error_message = _("Could not find %{resource}, please set one of options %{switches}.")
       end
 
-      raise MissingSeachOptions.new(
+      raise MissingSearchOptions.new(
         error_message % {
           :resource => e.resource.singular_name,
           :switches => switches.join(", ")
@@ -327,7 +328,9 @@ module HammerCLIForeman
     end
 
     def should_retrieve_all?
-      pagination_supported? && option_per_page.nil? && option_page.nil?
+      retrieve_all = pagination_supported? && option_per_page.nil? && option_page.nil?
+      retrieve_all &&= HammerCLI::Settings.get(:ui, :per_page).nil? if output.adapter.paginate_by_default?
+      retrieve_all
     end
 
   end
@@ -475,6 +478,11 @@ module HammerCLIForeman
       return superclass.associated_resource if superclass.respond_to? :associated_resource
     end
 
+    def self.default_message(format)
+      name = associated_resource ? associated_resource.singular_name.to_s : nil
+      format % { :resource_name => name.gsub(/_|-/, ' ') } unless name.nil?
+    end
+
     def get_associated_identifier
       get_resource_id(associated_resource, :scoped => true)
     end
@@ -521,6 +529,14 @@ module HammerCLIForeman
       description.strip.empty? ? _("Associate a resource") : description
     end
 
+    def self.failure_message(msg = nil)
+      super(msg) || default_message(_('Could not associate the %{resource_name}'))
+    end
+
+    def self.success_message(msg = nil)
+      super(msg) || default_message(_('The %{resource_name} has been associated'))
+    end
+
     def get_new_ids
       ids = get_current_ids.map(&:to_s)
       required_id = get_associated_identifier.to_s
@@ -551,7 +567,12 @@ module HammerCLIForeman
       ids
     end
 
-  end
-
+    def self.failure_message(msg = nil)
+      super(msg) || default_message(_('Could not disassociate the %{resource_name}'))
+    end
 
+    def self.success_message(msg = nil)
+      super(msg) || default_message(_('The %{resource_name} has been disassociated'))
+    end
+  end
 end

data/lib/hammer_cli_foreman/exception_handler.rb

@@ -10,6 +10,7 @@ module HammerCLIForeman
         [RestClient::InternalServerError, :handle_internal_error],
         [RestClient::Forbidden, :handle_forbidden],
         [RestClient::UnprocessableEntity, :handle_unprocessable_entity],
+        [RestClient::MovedPermanently, :handle_moved_permanently],
         [ArgumentError, :handle_argument_error],
       ]
     end
@@ -24,6 +25,18 @@ module HammerCLIForeman
     end
 
 
+    def handle_moved_permanently(e)
+      error = [_("Redirection of API call detected.")]
+      https_message = _("It seems hammer is configured to use HTTP and the server prefers HTTPS.")
+      error << https_message if strip_protocol(e.response.headers[:location]) == strip_protocol(e.response.request.url)
+      error << _("Update your server url configuration")
+      error << _("you can set 'follow_redirects' to one of :default or :always to enable redirects following")
+      print_error error.join("\n")
+      log_full_error e
+      HammerCLI::EX_CONFIG
+    end
+
+
     def handle_internal_error(e)
       handle_foreman_error(e)
       HammerCLI::EX_SOFTWARE
@@ -79,5 +92,10 @@ module HammerCLIForeman
       HammerCLI::EX_CONFIG
     end
 
+    private
+
+    def strip_protocol(url)
+      url.gsub(%r'^http(s)?://','').gsub(%r'//', '/')
+    end
   end
 end

data/lib/hammer_cli_foreman/exceptions.rb

@@ -13,7 +13,7 @@ module HammerCLIForeman
     end
   end
 
-  class MissingSeachOptions < ResolverError; end
+  class MissingSearchOptions < ResolverError; end
 
 end
 

data/lib/hammer_cli_foreman/host.rb

@@ -368,12 +368,8 @@ module HammerCLIForeman
         super
         unless validator.any(:option_hostgroup_id, :option_hostgroup_name).exist?
           if option_managed
-            validator.all(:option_environment_id, :option_architecture_id, :option_domain_id,
-                          :option_puppet_proxy_id, :option_operatingsystem_id,
-                          :option_ptable_id).required
-          else
-            # unmanaged host only requires environment
-            validator.option(:option_environment_id).required
+            validator.all(:option_architecture_id, :option_domain_id,
+                          :option_operatingsystem_id, :option_ptable_id).required
           end
         end
       end
@@ -518,6 +514,15 @@ module HammerCLIForeman
       end
     end
 
+    class RebuildConfigCommand < HammerCLIForeman::SingleResourceCommand
+      action :rebuild_config
+      command_name "rebuild-config"
+      desc _('Rebuild orchestration related configurations for host')
+      success_message _('Configuration successfully rebuilt.')
+
+      build_options
+    end
+
     autoload_subcommands
 
     subcommand 'interface', HammerCLIForeman::Interface.desc, HammerCLIForeman::Interface

data/lib/hammer_cli_foreman/id_resolver.rb

@@ -119,7 +119,7 @@ module HammerCLIForeman
     end
 
     def puppetclass_ids(options)
-      options[HammerCLI.option_accessor_name("ids")] || find_resources(:puppetclasses, options).collect{|h| h.values}.flatten.map{|h| h['id']}
+      options[HammerCLI.option_accessor_name("ids")] || find_puppetclasses(options).collect { |c| c['id'] }
     end
 
     protected
@@ -154,6 +154,14 @@ module HammerCLIForeman
       results
     end
 
+    def find_puppetclasses(options)
+      resource_name = :puppetclasses
+      resource = @api.resource(resource_name)
+      results = resolved_call(resource_name, :index, options).first.values.flatten
+      raise ResolverError.new(_("one of %s not found") % resource.name, resource) if results.count < expected_record_count(options, resource)
+      results
+    end
+
     def find_resource(resource_name, options)
       results = find_resource_raw(resource_name, options)
       resource = @api.resource(resource_name)
@@ -209,7 +217,7 @@ module HammerCLIForeman
                        else
                          create_search_options(options, resource)
                        end
-      raise MissingSeachOptions.new(_("Missing options to search %s") % resource.singular_name, resource) if search_options.empty?
+      raise MissingSearchOptions.new(_("Missing options to search %s") % resource.singular_name, resource) if search_options.empty?
       search_options
     end