hammer_cli_foreman 2.0.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da4ae85f2fd4296a67d175ba01b7515ba8ab4404fbce35963f16c45418b95815
-  data.tar.gz: 58c1e86329b37f245575274cfe85b143b3a19f21e26e66dbe328fc24832e0753
+  metadata.gz: 76e95389bb3b76b95c4c58d9faf7e7ff7e1b5c8bf2bcaed44aee693ef2fe9d02
+  data.tar.gz: 94cef7601ae22edec554dbfbccf4ffde70b45db465e3746f510437513d3b477e
 SHA512:
-  metadata.gz: 1ef7dd1f7f9215fb8707f6d63979b33be442ebe2a0744c9aa44cbfafb0ee2f462185369581738b09d2fd31766f1cd2fbd09ea0269b39ba52e6d348122fb8408f
-  data.tar.gz: 358bc7b858062a4e8a5f78ca38632d14ab96f0eb4aebd1e602cc45ccd67f6743d3c7fbb5500719cafb51f6fbea096070004958a533dad5981202ac419eb419bc
+  metadata.gz: 441c7dc0803a50667feafe17fc0fa5674e79ef10859fd2e06c4929ef7fe18dded59e354986e15f57c950a9e3be5bd8ec2701da1e090f36cc353fc06d150b25b4
+  data.tar.gz: bc7f373ce2e39987744a9a05c5cede008de26f0198e6ec3026a4be1b051452de701e0ae5245527768d2851dfbbd24d3f9417d1fd3939ddb7d4da7a63e2002e62

data/doc/developer_docs.md

@@ -10,6 +10,7 @@ Foreman plugin extends the Hammer Core in following areas:
  - [Building options](option_builder.md#option-builders)
  - [Automatic name resolution](name_id_resolution.md#name-to-id-resolution)
  - [Testing commands](testing.md#testing-hammer-commands)
+ - [Writing a plugin](plugin.md#writing-a-plugin)
 
 It's recommended that you set `:refresh_cache: true` in the plugin settings if
 engaging in API development to enable aggressive apidoc cache checking.

data/doc/plugin.md

@@ -0,0 +1,22 @@
+# Writing a plugin
+
+### Basic
+
+If you want to create a plugin for hammer-cli-foreman, you might want to create
+a simple draft at first.
+
+To do so, just run the following:
+```
+# You will need to checkout this repository first if you don't have it already
+$ git checkout https://github.com/theforeman/hammer-cli-foreman.git
+$ cd hammer-cli-foreman
+$ rake plugin:draft
+# fill prompts
+```
+This will create a directory called `hammer-cli-foreman-prompted-name` with
+basic structure where you can put your code afterwards. Please, don't forget to
+take a look at `TODO`s as there might be places you want to change or adjust to
+your needs first.
+
+For more information, please see: https://github.com/theforeman/hammer-cli/blob/master/doc/developer_docs.md
+as well as https://github.com/theforeman/hammer-cli-foreman/blob/master/doc/developer_docs.md

data/doc/release_notes.md

@@ -1,5 +1,38 @@
 Release notes
 =============
+### 2.1.2 (2020-07-14)
+* Change config templates to provisioning templates ([PR #531](https://github.com/theforeman/hammer-cli-foreman/pull/531)), [#29971](http://projects.theforeman.org/issues/29971)
+* Return 'set current context for request' to help ([PR #530](https://github.com/theforeman/hammer-cli-foreman/pull/530)), [#30182](http://projects.theforeman.org/issues/30182)
+* Display request uuid for audit ([PR #528](https://github.com/theforeman/hammer-cli-foreman/pull/528)) ([PR #529](https://github.com/theforeman/hammer-cli-foreman/pull/529)), [#30130](http://projects.theforeman.org/issues/30130)
+
+### 2.1.1 (2020-05-29)
+* Revert "skip one test on ruby 2.7" ([PR #520](https://github.com/theforeman/hammer-cli-foreman/pull/520)), [#28601](http://projects.theforeman.org/issues/28601)
+* Eliminate auth_type from sessions file ([PR #521](https://github.com/theforeman/hammer-cli-foreman/pull/521)), [#29876](http://projects.theforeman.org/issues/29876)
+* Add disable option for user ([PR #497](https://github.com/theforeman/hammer-cli-foreman/pull/497)), [#28973](http://projects.theforeman.org/issues/28973)
+* Added manage command to user mail notifications ([PR #513](https://github.com/theforeman/hammer-cli-foreman/pull/513)), [#7665](http://projects.theforeman.org/issues/7665)
+
+### 2.1.0 (2020-05-14)
+* Bump hammer_cli to 2.1.0 ([PR #519](https://github.com/theforeman/hammer-cli-foreman/pull/519))
+* Ask for oauth code only when needed ([PR #517](https://github.com/theforeman/hammer-cli-foreman/pull/517)), [#29635](http://projects.theforeman.org/issues/29635)
+* Possibility to create ipv6 subnet, [#28760](http://projects.theforeman.org/issues/28760)
+* Add the ability to manage bookmarks ([PR #510](https://github.com/theforeman/hammer-cli-foreman/pull/510)), [#12845](http://projects.theforeman.org/issues/12845)
+* Add aliases for info/list/delete commands ([PR #512](https://github.com/theforeman/hammer-cli-foreman/pull/512)), [#29413](http://projects.theforeman.org/issues/29413)
+* Help contains squeezed options ([PR #489](https://github.com/theforeman/hammer-cli-foreman/pull/489)), [#28440](http://projects.theforeman.org/issues/28440)
+* Add cr to hostgroup info, [#29140](http://projects.theforeman.org/issues/29140)
+* Add rake task with plugin template
+* Added virtual machine command for compute resource ([PR #469](https://github.com/theforeman/hammer-cli-foreman/pull/469)), [#20451](http://projects.theforeman.org/issues/20451)
+* Add display options to host creation on ovirt ([PR #507](https://github.com/theforeman/hammer-cli-foreman/pull/507)), [#29254](http://projects.theforeman.org/issues/29254)
+* Add mail notification command ([PR #509](https://github.com/theforeman/hammer-cli-foreman/pull/509)), [#29326](http://projects.theforeman.org/issues/29326)
+* Use right param for os default template ([PR #508](https://github.com/theforeman/hammer-cli-foreman/pull/508)), [#29274](http://projects.theforeman.org/issues/29274)
+* Update api docs to 2.1
+* Correct hot add options ([PR #505](https://github.com/theforeman/hammer-cli-foreman/pull/505)), [#29253](http://projects.theforeman.org/issues/29253)
+* Feature #28836 - allow multiple disassociating of provisioning templates ([PR #502](https://github.com/theforeman/hammer-cli-foreman/pull/502)), [#28836](http://projects.theforeman.org/issues/28836)
+* Fixed updating host owner when ownertype is usergroup ([PR #501](https://github.com/theforeman/hammer-cli-foreman/pull/501)), [#11279](http://projects.theforeman.org/issues/11279)
+* Remove duplicate api requests on addassociatedcommand ([PR #503](https://github.com/theforeman/hammer-cli-foreman/pull/503)), [#29096](http://projects.theforeman.org/issues/29096)
+* Fix help for ovirt boolean values, [#29026](http://projects.theforeman.org/issues/29026)
+* Deprecate --root-pass in host group, [#22573](http://projects.theforeman.org/issues/22573)
+* Bump to 2.1.0-develop
+
 ### 2.0.0 (2020-02-12)
 * Change the description of the scoped loc and org ([PR #494](https://github.com/theforeman/hammer-cli-foreman/pull/494)), [#28869](http://projects.theforeman.org/issues/28869)
 * Fixes tests

data/lib/hammer_cli_foreman.rb

@@ -11,6 +11,7 @@ module HammerCLIForeman
   require 'hammer_cli_foreman/i18n'
 
   require 'hammer_cli_foreman/version'
+  require 'hammer_cli_foreman/task_helper'
   require 'hammer_cli_foreman/output'
   require 'hammer_cli_foreman/output/fields'
   require 'hammer_cli_foreman/exception_handler'
@@ -153,7 +154,7 @@ module HammerCLIForeman
       'HammerCLIForeman::Subnet', 'hammer_cli_foreman/subnet'
     )
 
-    HammerCLI::MainCommand.lazy_subcommand('template', _("Manipulate config templates"),
+    HammerCLI::MainCommand.lazy_subcommand('template', _("Manipulate provisioning templates"),
       'HammerCLIForeman::Template', 'hammer_cli_foreman/template'
     )
 
@@ -180,6 +181,13 @@ module HammerCLIForeman
     HammerCLI::MainCommand.lazy_subcommand('trend', _("Manage trends"),
                                            'HammerCLIForeman::Trend', 'hammer_cli_foreman/trend'
     )
+
+    HammerCLI::MainCommand.lazy_subcommand('mail-notification', _("Manage mail notifications"),
+                                           'HammerCLIForeman::MailNotification', 'hammer_cli_foreman/mail_notification'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('bookmark', _("Manage bookmarks"),
+                                            'HammerCLIForeman::Bookmark', 'hammer_cli_foreman/bookmark')
   rescue => e
     handler = HammerCLIForeman::ExceptionHandler.new(:context => {}, :adapter => :base)
     handler.handle_exception(e)

data/lib/hammer_cli_foreman/api/connection.rb

@@ -42,26 +42,9 @@ module HammerCLIForeman
 
       protected
 
-      # If the settings in foreman.yml has use_sessions as false, use :basic_auth
-      # Else if the settings in foreman.yml has use_sessions as true
-      # and if there exists a session_file with valid contents, we use the auth_type from sessions_file
-      # Thus if the session expires (indicated by nil session_id), we use the
-      # same auth_type for re-authentication as was used by the previous session.
-      # Else we use the passed auth_type.
       def default_auth_type(settings)
         return AUTH_TYPES[:basic_auth] unless HammerCLIForeman::Sessions.enabled?
-
-        url = settings.get(:_params, :host) || settings.get(:foreman, :host)
-        username = settings.get(:_params, :username) || settings.get(:foreman, :username)
-        session = HammerCLIForeman::Sessions.get(url)
-        if !session.valid? && session.user_name == username && !session.auth_type.nil?
-          session.auth_type
-        else
-          # If the caller has not sepcified an 'auth_type'
-          # and the 'default_auth_type' in settings is also undefined
-          # use :basic_auth for authentication.
-          HammerCLI::Settings.get(:foreman, :default_auth_type) || AUTH_TYPES[:basic_auth]
-        end
+        HammerCLI::Settings.get(:foreman, :default_auth_type) || AUTH_TYPES[:basic_auth]
       end
 
       def create_authenticator(uri, settings, auth_type)

data/lib/hammer_cli_foreman/api/oauth/authentication_code_grant.rb

@@ -5,19 +5,22 @@ module HammerCLIForeman
   module Api
     module Oauth
       class AuthenticationCodeGrant < ApipieBindings::Authenticators::TokenAuth
-        attr_accessor :oidc_token_endpoint, :oidc_authorization_endpoint, :oidc_client_id, :token, :oidc_redirect_uri
+        attr_accessor :oidc_token_endpoint, :oidc_authorization_endpoint,
+                      :oidc_client_id, :token, :oidc_redirect_uri
 
         def initialize(oidc_token_endpoint, oidc_authorization_endpoint, oidc_client_id, oidc_redirect_uri)
           @oidc_token_endpoint = oidc_token_endpoint
           @oidc_authorization_endpoint = oidc_authorization_endpoint
           @oidc_client_id = oidc_client_id
           @oidc_redirect_uri = oidc_redirect_uri
-          super set_token(oidc_token_endpoint, oidc_authorization_endpoint, oidc_client_id, oidc_redirect_uri)
+          super(nil)
         end
 
         def authenticate(request, token)
           if HammerCLI.interactive?
             set_token_interactively
+          else
+            set_token(oidc_token_endpoint, oidc_authorization_endpoint, oidc_client_id, oidc_redirect_uri)
           end
           super
         end
@@ -35,7 +38,7 @@ module HammerCLIForeman
           if @oidc_client_id.to_s.empty? || @oidc_authorization_endpoint.to_s.empty? || @oidc_redirect_uri.to_s.empty? || @oidc_token_endpoint.to_s.empty?
             @token = nil
           else
-            get_code
+            @code ||= get_code
             @token = HammerCLIForeman::OpenidConnect.new(
               @oidc_token_endpoint, @oidc_client_id).get_token_via_2fa(@code, @oidc_redirect_uri)
           end
@@ -68,7 +71,7 @@ module HammerCLIForeman
                         "&redirect_uri=#{@oidc_redirect_uri}"\
                         '&scope=openid'
           HammerCLI.interactive_output.say("Enter URL in browser: #{@token_url}")
-          @code ||= ask_user(_("Code:%s") % " ")
+          ask_user(_("Code:%s") % " ")
         end
 
         def get_oidc_authorization_endpoint

data/lib/hammer_cli_foreman/api/session_authenticator_wrapper.rb

@@ -69,7 +69,6 @@ module HammerCLIForeman
         if (r.cookies['_session_id'] && r.code != 401)
           session.id = r.cookies['_session_id']
           session.user_name = @authenticator.user
-          session.auth_type = @auth_type
           session.store
         end
         @authenticator.response(r)

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -245,6 +245,7 @@ module HammerCLIForeman
         def request_params
           params = super
 
+          template_ids = params['operatingsystem']['provisioning_template_ids']
           if options['option_provisioning_template_search']
             templates = HammerCLIForeman.collection_to_common_format(
               associated_resource.call(
@@ -255,10 +256,10 @@ module HammerCLIForeman
 
             templates.each do |template|
               template_id = template['id']
-              params['operatingsystem']['provisioning_template_ids'] << template_id.to_s
+              template_ids << template_id.to_s
             end
           end
-          params['operatingsystem']['provisioning_template_ids'] = params['operatingsystem']['provisioning_template_ids'].uniq
+          params['operatingsystem']['provisioning_template_ids'] = template_ids.uniq
           params
         end
 
@@ -269,10 +270,37 @@ module HammerCLIForeman
 
       class RemoveProvisioningTemplateCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :provisioning_templates
-        desc _("Disassociate a provisioning template")
+        desc _("Disassociate provisioning templates")
 
-        success_message _("The provisioning template has been disassociated.")
-        failure_message _("Could not disassociate the provisioning template")
+        option "--provisioning-template-ids", "PROVISIONING_TEMPLATE_IDS", _("List of provisioning template ids"),
+               format: HammerCLI::Options::Normalizers::List.new
+        option "--provisioning-templates", "PROVISIONING_TEMPLATE_NAMES", _("List of provisioning template names"),
+               format: HammerCLI::Options::Normalizers::List.new, attribute_name: :option_provisioning_template_names
+        option "--provisioning-template-search", "PROVISIONING_TEMPLATE_SEARCH", _("Provisioning template name regex to search, all matching templates will be disassociated")
+
+        def request_params
+          params = super
+
+          template_ids = params['operatingsystem']['provisioning_template_ids']
+          if options['option_provisioning_template_search']
+            templates = HammerCLIForeman.collection_to_common_format(
+              associated_resource.call(
+                :index,
+                :search => "name ~ \"#{options['option_provisioning_template_search']}\"")
+            )
+            raise ResolverError.new(_("%s not found.") % associated_resource.singular_name, associated_resource) if templates.empty?
+
+            templates.each do |template|
+              template_id = template['id']
+              template_ids.delete(template_id.to_s)
+            end
+          end
+          params['operatingsystem']['provisioning_template_ids'] = template_ids.uniq
+          params
+        end
+
+        success_message _("The provisioning templates were disassociated.")
+        failure_message _("Could not disassociate the provisioning templates")
       end
     end
 

data/lib/hammer_cli_foreman/audit.rb

@@ -28,6 +28,7 @@ module HammerCLIForeman
         field :action, _("Action")
         field :auditable_type, _("Audit type")
         field nil, _("Audit record"), Fields::SingleReference, :key => :auditable
+        field :request_uuid, _("Request UUID"), Fields::Field, sets: ['ALL']
       end
 
       build_options
@@ -63,6 +64,12 @@ module HammerCLIForeman
         end
       end
 
+      extend_output_definition do |definition|
+        definition.insert(:replace, :request_uuid) do
+          field :request_uuid, _("Request UUID"), Fields::Field, sets: ['ALL', 'DEFAULT']
+        end
+      end
+
       build_options
     end
 

data/lib/hammer_cli_foreman/auth.rb

@@ -46,16 +46,16 @@ module HammerCLIForeman
           if option_two_factor?
             Oauth.execute_with_params(
               AUTH_TYPES[:oauth_authentication_code_grant],
-              option_oidc_token_endpoint,
-              option_oidc_authorization_endpoint,
-              option_oidc_client_id,
-              option_oidc_redirect_uri
+              option_oidc_token_endpoint || HammerCLI::Settings.get(:foreman, :oidc_token_endpoint),
+              option_oidc_authorization_endpoint || HammerCLI::Settings.get(:foreman, :oidc_authorization_endpoint),
+              option_oidc_client_id || HammerCLI::Settings.get(:foreman, :oidc_client_id),
+              option_oidc_redirect_uri || HammerCLI::Settings.get(:foreman, :oidc_redirect_uri)
             )
           else
             Oauth.execute_with_params(
               AUTH_TYPES[:oauth_password_grant],
-              option_oidc_token_endpoint,
-              option_oidc_client_id,
+              option_oidc_token_endpoint || HammerCLI::Settings.get(:foreman, :oidc_token_endpoint),
+              option_oidc_client_id || HammerCLI::Settings.get(:foreman, :oidc_client_id),
               option_username || HammerCLI::Settings.get('_params', 'username'),
               option_password || HammerCLI::Settings.get('_params', 'password')
             )

data/lib/hammer_cli_foreman/bookmark.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module HammerCLIForeman
+  class Bookmark < HammerCLIForeman::Command
+    resource :bookmarks
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+        field :controller, _('Controller')
+        field :query, _('Search Query')
+        field :public, _('Public')
+        field :owner_id, _('Owner Id')
+        field :owner_type, _('Owner Type')
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ListCommand.output_definition
+      
+      build_options
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _('Bookmark %<name>s created.')
+      failure_message _('Failed to create %<name>s bookmark')
+
+      build_options
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _('Bookmark %<name>s updated successfully.')
+      failure_message _('Failed to update %<name>s bookmark')
+
+      build_options
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Bookmark deleted successfully.')
+      failure_message _('Failed to delete bookmark')
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman/command_extensions.rb

@@ -5,3 +5,5 @@ require 'hammer_cli_foreman/command_extensions/option_sources'
 require 'hammer_cli_foreman/command_extensions/hosts'
 require 'hammer_cli_foreman/command_extensions/ping'
 require 'hammer_cli_foreman/command_extensions/status'
+require 'hammer_cli_foreman/command_extensions/user'
+require 'hammer_cli_foreman/command_extensions/subnet'

data/lib/hammer_cli_foreman/command_extensions/puppet_environment.rb

@@ -2,13 +2,19 @@ module HammerCLIForeman
   module CommandExtensions
     class PuppetEnvironment < HammerCLI::CommandExtensions
       # Remove when support of --environment options is ended.
-      option '--environment', 'ENVIRONMENT_NAME', _('Environment name'),
-             attribute_name: :option_environment_name,
-             deprecated: { '--environment' => _('Use --puppet-environment instead') }
-      option '--environment-id', 'ENVIRONMENT_ID', _(''),
-             format: HammerCLI::Options::Normalizers::Number.new,
-             attribute_name: :option_environment_id,
-             deprecated: { '--environment-id' => _('Use --puppet-environment-id instead') }
+      option_family(
+        aliased_resource: 'environment',
+        description: _('Puppet environment'),
+        deprecation: _("Use %s instead") % '--puppet-environment[-id]',
+        deprecated: { '--environment' => _("Use %s instead") % '--puppet-environment[-id]',
+                      '--environment-id' => _("Use %s instead") % '--puppet-environment[-id]'}
+      ) do
+        parent '--environment-id', 'ENVIRONMENT_ID', _(''),
+               format: HammerCLI::Options::Normalizers::Number.new,
+               attribute_name: :option_environment_id
+        child '--environment', 'ENVIRONMENT_NAME', _('Environment name'),
+              attribute_name: :option_environment_name
+      end
 
       option_sources do |sources, command|
         sources.find_by_name('IdResolution').insert_relative(

data/lib/hammer_cli_foreman/command_extensions/puppet_environments.rb

@@ -2,13 +2,19 @@ module HammerCLIForeman
   module CommandExtensions
     class PuppetEnvironments < HammerCLI::CommandExtensions
       # Remove when support of --environments options is ended.
-      option '--environments', 'ENVIRONMENT_NAMES', _(''),
-             attribute_name: :option_environment_names,
-             deprecated: { '--environments' => _('Use --puppet-environments instead') }
-      option '--environment-ids', 'ENVIRONMENT_IDS', _('Environment IDs'),
-             format: HammerCLI::Options::Normalizers::List.new,
-             attribute_name: :option_environment_ids,
-             deprecated: { '--environment-ids' => _('Use --puppet-environment-ids instead') }
+      option_family(
+        aliased_resource: 'environment',
+        description: _('Puppet environments'),
+        deprecation: _("Use %s instead") % '--puppet-environment[s|-ids]',
+        deprecated: { '--environments' => _("Use %s instead") % '--puppet-environment[s|-ids]',
+                      '--environment-ids' => _("Use %s instead") % '--puppet-environment[s|-ids]' }
+      ) do
+        parent '--environment-ids', 'ENVIRONMENT_IDS', _('Environment IDs'),
+               format: HammerCLI::Options::Normalizers::List.new,
+               attribute_name: :option_environment_ids
+        child '--environments', 'ENVIRONMENT_NAMES', _(''),
+              attribute_name: :option_environment_names
+      end
 
       option_sources do |sources, command|
         sources.find_by_name('IdResolution').insert_relative(

data/lib/hammer_cli_foreman/command_extensions/subnet.rb

@@ -0,0 +1,25 @@
+module HammerCLIForeman
+  module CommandExtensions
+    class Subnet < HammerCLI::CommandExtensions
+      option "--dns", "DNS_NAME", _("DNS Proxy to use within this subnet"),
+             attribute_name: :option_dns_name,
+             referenced_resource: :smart_proxy
+      option "--dhcp", "DHCP_NAME", _("DHCP Proxy to use within this subnet"),
+             attribute_name: :option_dhcp_name,
+             referenced_resource: :smart_proxy
+      option "--tftp", "TFTP_NAME", _("TFTP Proxy to use within this subnet"),
+             attribute_name: :option_tftp_name,
+             referenced_resource: :smart_proxy
+      option "--prefix", "PREFIX", _("Network prefix in CIDR notation (e.g. 64) for this subnet")
+
+      option_sources do |sources, command|
+        sources.find_by_name('IdResolution').insert_relative(
+          :after,
+          'IdParams',
+          HammerCLIForeman::OptionSources::ReferencedResourceIdParams.new(command)
+        )
+        sources
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman/command_extensions/user.rb

@@ -0,0 +1,17 @@
+module HammerCLIForeman
+  module CommandExtensions
+    class User < HammerCLI::CommandExtensions
+      option '--default-organization', 'DEFAULT_ORGANIZATION_NAME', _('Default organization name'),
+             aliased_resource: 'default_organization', referenced_resource: 'default_organization'
+      option '--default-location', 'DEFAULT_LOCATION_NAME', _('Default location name'),
+             aliased_resource: 'default_location', referenced_resource: 'default_location'
+
+      option '--ask-password', 'ASK_PW', ' ', format: HammerCLI::Options::Normalizers::Bool.new
+
+      option_sources do |sources, command|
+        sources << HammerCLIForeman::OptionSources::UserParams.new(command)
+        sources
+      end
+    end
+  end
+end