hammer_cli_foreman 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aca6597f50629e6d78d1c059677409a1bd28c0c5
-  data.tar.gz: 52228db5fe22493aa3c0f2f2cd00e41ff0bf7f1c
+  metadata.gz: 5bbff81f4608f3747313bf8525acb14c1734db93
+  data.tar.gz: 9fe96408c5e413b1731c4196d1cb62c80895a20d
 SHA512:
-  metadata.gz: d6cc4de6593ae729c30b614c1c8d239e8d009d55d5e3091cb89df8ad1522e9d5debaf16168da89502a4b38de1122630484a07900ce1041bbafd6251856efc33d
-  data.tar.gz: 27a2c9cac09d0dd7513f060f06c3d560f803ee16f5bed12799a366cee5dc601c3de90a0080dfcdd0d9f5b60575198c2b961c797423d601d71bd870b186da2308
+  metadata.gz: 080d7ba7ce6424c9bf4ff975e3d3bf63336cb565d96455fa4e07e317cc447eb52b8c5ede99de581c5026f259fb9e7f9943acc6dec41651137e732ae654639067
+  data.tar.gz: 94cbec39dca93447a6105586a948f2c5708b8dad4563731d5203ec303c579fa9612003d993eadc186a0e248e8976dae2b11cecc32ad83356339185ecec92fc25

data/config/foreman.yml

@@ -8,6 +8,10 @@
   # Credentials. You'll be asked for them interactively if you leave them blank here
   :username: 'admin'
   #:password: 'example'
+
+  # Enable using sessions
+  # When sessions are enabled, hammer ignores credentials stored in the config file
+  # and asks for them interactively at the begining of each session.
   :use_sessions: false
 
   # Check API documentation cache status on each request

data/doc/release_notes.md

@@ -1,19 +1,35 @@
 Release notes
 =============
 
-### 0.10.2 (2017-05-05)
+### 0.11.0 (2017-08-01)
+* Adding a list normalizer to override-value-order ([#17135](http://projects.theforeman.org/issues/17135))
+* Correctly reset taxonomies for overriding filters ([#20117](http://projects.theforeman.org/issues/20117))
+* Sessions mutually exclusive with basic auth ([#20315](http://projects.theforeman.org/issues/20315))
+* Disable auth login when sessions are off ([#19602](http://projects.theforeman.org/issues/19602))
+* Add all_parameters to host info ([#20286](http://projects.theforeman.org/issues/20286))
+* Fix Hammer-cli display groups base dn ([#20227](http://projects.theforeman.org/issues/20227))
+* Fix Hammer-cli current user password update ([#18005](http://projects.theforeman.org/issues/18005))
+* Don't send snippet flag when --type is undefined ([#20145](http://projects.theforeman.org/issues/20145))
+* Fix merging .edit.po into .po files ([#17671](http://projects.theforeman.org/issues/17671))
+* Enable taxonomy titles ([#19157](http://projects.theforeman.org/issues/19157))
 * Provide default exception handler ([#19470](http://projects.theforeman.org/issues/19470))
+* Accept hostgroup title in host create ([#19048](http://projects.theforeman.org/issues/19048))
 * Retry command on session expiry ([#19431](http://projects.theforeman.org/issues/19431))
 * More detailed instructions on SSL verification fail ([#19390](http://projects.theforeman.org/issues/19390))
-
-### 0.10.1 (2017-04-24)
+* Add additional attributes on user list command ([#4396](http://projects.theforeman.org/issues/4396))
+* Add description to hostgroup ([#19361](http://projects.theforeman.org/issues/19361))
 * Require apipie-bindings >= 0.2.0 ([#19362](http://projects.theforeman.org/issues/19362))
-* Require rest-client >= 1.8.0 ([PR #306](https://github.com/theforeman/hammer-cli-foreman/pull/306)) ([#19358](http://projects.theforeman.org/issues/19358))
-* Custom error for 401 unauthorized ([PR #305](https://github.com/theforeman/hammer-cli-foreman/pull/305)) ([#19362](http://projects.theforeman.org/issues/19362))
+* Require rest-client >= 1.8.0 ([#19358](http://projects.theforeman.org/issues/19358))
+* Rustom error for 401 unauthorized ([#19362](http://projects.theforeman.org/issues/19362))
+* Correctly resolve empty arrays ([#18742](http://projects.theforeman.org/issues/18742))
 * Use Array for empty attributes ([#19312](http://projects.theforeman.org/issues/19312))
+* Compute-resources has images subcommand ([#19156](http://projects.theforeman.org/issues/19156))
 * Prevent sending nil values in hostgroup update ([#14872](http://projects.theforeman.org/issues/14872))
 * Install server CA cert without root access ([#19083](http://projects.theforeman.org/issues/19083))
+* Add description to subnet ([#19172](http://projects.theforeman.org/issues/19172))
+* Replaces --subnet-parameters-attributes with parameter commands ([#18663](http://projects.theforeman.org/issues/18663))
 * Make session authenticator compatible with rest-client 1.8 ([#19159](http://projects.theforeman.org/issues/19159))
+* Add vlan id field to subnet ([#19134](http://projects.theforeman.org/issues/19134))
 
 ### 0.10.0 (2017-03-28)
 * Adding --hidden-value option to parameters (#290) ([#18878](http://projects.theforeman.org/issues/18878))

data/lib/hammer_cli_foreman/api/connection.rb

@@ -36,11 +36,20 @@ module HammerCLIForeman
         if ssl_cert_authentication?(settings) && !use_basic_auth?(settings)
           @authenticator = VoidAuth.new
         else
-          @authenticator = InteractiveBasicAuth.new(
-            settings.get(:_params, :username) || ENV['FOREMAN_USERNAME'] || settings.get(:foreman, :username),
-            settings.get(:_params, :password) || ENV['FOREMAN_PASSWORD'] || settings.get(:foreman, :password)
-          )
-          @authenticator = SessionAuthenticatorWrapper.new(@authenticator, uri) if settings.get(:foreman, :use_sessions)
+          if settings.get(:foreman, :use_sessions)
+            @authenticator = InteractiveBasicAuth.new(
+              settings.get(:_params, :username) || ENV['FOREMAN_USERNAME'],
+              settings.get(:_params, :password) || ENV['FOREMAN_PASSWORD']
+            )
+            @authenticator = SessionAuthenticatorWrapper.new(@authenticator, uri)
+          else
+            username = settings.get(:_params, :username) || ENV['FOREMAN_USERNAME'] || settings.get(:foreman, :username)
+            password = settings.get(:_params, :password) || ENV['FOREMAN_PASSWORD']
+            if (password.nil? && (username == settings.get(:foreman, :username)))
+              password = settings.get(:foreman, :password)
+            end
+            @authenticator = InteractiveBasicAuth.new(username, password)
+          end
           @authenticator
         end
       end

data/lib/hammer_cli_foreman/api/interactive_basic_auth.rb

@@ -12,19 +12,31 @@ module HammerCLIForeman
       end
 
       def error(ex)
-        return UnauthorizedError.new(_("Invalid username or password")) if ex.is_a?(RestClient::Unauthorized)
+        if ex.is_a?(RestClient::Unauthorized)
+          self.clear
+          return UnauthorizedError.new(_("Invalid username or password"))
+        end
       end
 
       def status
         unless @user.nil? || @password.nil?
-          _("You are logged in as '%s'") % @user
+          _("Using configured credentials for user '%s'.") % @user
         else
-          _("You are currently not logged in")
+          _("Credentials are not configured.")
         end
       end
 
-      def user
-        @user
+      def user(ask=nil)
+        @user ||= ask && get_user
+      end
+
+      def set_credentials(user, password)
+        @user = user
+        @password = password
+      end
+
+      def clear
+        set_credentials(nil, nil)
       end
 
       private

data/lib/hammer_cli_foreman/api/session_authenticator_wrapper.rb

@@ -18,23 +18,33 @@ module HammerCLIForeman
 
       def clear
         destroy_session
+        @authenticator.clear if @authenticator.respond_to?(:clear)
       end
 
       def status
         if load_session
-          _("Session exist, currently logged in as '%s'") % @user
+          _("Session exists, currently logged in as '%s'") % @user
         else
-          _("You are currently not logged in")
+          _("Using sessions, you are currently not logged in.")
         end
       end
 
+      def force_user_change
+        @user_changed = true
+      end
+
+      def user_changed?
+        !!@user_changed
+      end
+
       def authenticate(request, args)
         load_session
 
         user = @authenticator.user
-        destroy_session if (user && user != @user)
 
-        if @permissions_ok && @session_id
+        @user_changed ||= (!user.nil? && user != @user)
+
+        if !@user_changed && @permissions_ok && @session_id
           jar = HTTP::CookieJar.new
           jar.add(HTTP::Cookie.new('_session_id', @session_id, domain: uri.hostname.downcase, path: '/', for_domain: true))
           request['Cookie'] = HTTP::Cookie.cookie_value(jar.cookies)
@@ -47,8 +57,12 @@ module HammerCLIForeman
       def error(ex)
         load_session
         if ex.is_a?(RestClient::Unauthorized) && !@session_id.nil?
-          destroy_session
-          return SessionExpired.new(_("Session has expired"))
+          if @user_changed
+            return UnauthorizedError.new(_("Invalid username or password, continuing with session for '%s'") % @user)
+          else
+            destroy_session
+            return SessionExpired.new(_("Session has expired"))
+          end
         else
           return @authenticator.error(ex)
         end
@@ -62,8 +76,12 @@ module HammerCLIForeman
         @authenticator.response(r)
       end
 
-      def user
-        @authenticator.user if @authenticator.respond_to?(:user)
+      def user(ask=nil)
+        @authenticator.user(ask) if @authenticator.respond_to?(:user)
+      end
+
+      def set_credentials(*args)
+        @authenticator.set_credentials(*args) if @authenticator.respond_to?(:set_credentials)
       end
 
       protected
@@ -83,6 +101,7 @@ module HammerCLIForeman
           @session_id = session_data['session_id']
         end
       rescue JSON::ParserError
+        destroy_session
         warn _('Invalid session file format')
         nil
       end

data/lib/hammer_cli_foreman/auth.rb

@@ -10,16 +10,21 @@ module HammerCLIForeman
       option ["-p", "--password"], "PASSWORD", _("password to access the remote system")
 
       def execute
-        HammerCLIForeman.foreman_api_connection.logout
-        context[:api_connection].drop_all
-        HammerCLI::Settings.load({
-          :_params => {
-            :username => option_username,
-            :password => option_password
-          }
-        })
+        if !(HammerCLIForeman.foreman_api_connection.authenticator.is_a?(HammerCLIForeman::Api::SessionAuthenticatorWrapper))
+          print_message(_("Can't perform login. Make sure sessions are enabled in hammer configuration file."))
+          return HammerCLI::EX_USAGE
+        end
+
+        # Make sure we reflect also credentials set for the main hammer command
+        # ( hammer -u test auth login )
+        HammerCLIForeman.foreman_api_connection.authenticator.set_credentials(
+          option_username || HammerCLI::Settings.get('_params', 'username'),
+          option_password || HammerCLI::Settings.get('_params', 'password')
+        )
+        HammerCLIForeman.foreman_api_connection.authenticator.force_user_change
         HammerCLIForeman.foreman_api_connection.login
-        print_message(_("Successfully logged in."))
+
+        print_message(_("Successfully logged in as '%s'.") % HammerCLIForeman.foreman_api_connection.authenticator.user)
         HammerCLI::EX_OK
       end
     end
@@ -30,7 +35,6 @@ module HammerCLIForeman
 
       def execute
         HammerCLIForeman.foreman_api_connection.logout
-        context[:api_connection].drop_all
         print_message(_("Logged out."))
         HammerCLI::EX_OK
       end

data/lib/hammer_cli_foreman/auth_source_ldap.rb

@@ -1,70 +1,74 @@
 module HammerCLIForeman
-
   class AuthSourceLdap < HammerCLIForeman::Command
-
     resource :auth_source_ldaps
     command_name 'ldap'
-    desc _("Manage LDAP auth sources.")
-
+    desc _('Manage LDAP auth sources.')
 
     class ListCommand < HammerCLIForeman::ListCommand
-
       output do
-        field :id                , _("Id")
-        field :name              , _("Name")
-        field :tls               , _('LDAPS?')
-        field :port              , _('Port')
-        field :type              , _("Server Type")
+        field :id, _('Id')
+        field :name, _('Name')
+        field :host, _('Server')
+        field :port, _('Port')
+        field :tls, _('LDAPS?'), Fields::Boolean
       end
 
       build_options
     end
 
-
     class InfoCommand < HammerCLIForeman::InfoCommand
-
-      output ListCommand.output_definition do
-        field :account           , _('Account Username')
-        field :base_dn           , _('Base DN')
-        field :ldap_filter       , _('LDAP filter')
-        field :onthefly_register , _('Automatically Create Accounts?')
-        field :attr_login        , _('Login Name Attribute')
-        field :attr_firstname    , _('First Name Attribute')
-        field :attr_lastname     , _('Last Name Attribute')
-        field :attr_mail         , _('Email Address Attribute')
-        field :attr_photo        , _('Photo Attribute')
+      output do
+        label _('Server') do
+          field :id, _('Id')
+          field :name, _('Name')
+          field :host, _('Server')
+          field :tls, _('LDAPS'), Fields::Boolean
+          field :port, _('Port')
+          field :server_type, _('Server Type')
+        end
+        label _('Account') do
+          field :account, _('Account Username')
+          field :base_dn, _('Base DN')
+          field :groups_base, _('Groups base DN')
+          field :use_netgroups, _('Use Netgroups'), Fields::Boolean
+          field :ldap_filter, _('LDAP filter')
+          field :onthefly_register, _('Automatically Create Accounts?'), Fields::Boolean
+          field :usergroup_sync, _('Usergroup sync'), Fields::Boolean
+        end
+        label _('Attribute mappings') do
+          field :attr_login, _('Login Name Attribute')
+          field :attr_firstname, _('First Name Attribute')
+          field :attr_lastname, _('Last Name Attribute')
+          field :attr_mail, _('Email Address Attribute')
+          field :attr_photo, _('Photo Attribute')
+        end
+        HammerCLIForeman::References.taxonomies(self)
       end
 
       build_options
     end
 
-
     class CreateCommand < HammerCLIForeman::CreateCommand
-      success_message _("Auth source created")
-      failure_message _("Could not create the Auth Source")
+      success_message _('Auth source [%{name}] created')
+      failure_message _('Could not create the Auth Source')
 
       build_options
     end
 
-
     class DeleteCommand < HammerCLIForeman::DeleteCommand
-      success_message _("Auth source deleted")
-      failure_message _("Could not delete the Auth Source")
+      success_message _('Auth source [%{name}] deleted')
+      failure_message _('Could not delete the Auth Source')
 
       build_options
     end
 
-
     class UpdateCommand < HammerCLIForeman::UpdateCommand
-      success_message _("Auth source updated")
-      failure_message _("Could not update the Auth Source")
+      success_message _('Auth source [%{name}] updated')
+      failure_message _('Could not update the Auth Source')
 
       build_options
     end
 
     autoload_subcommands
   end
-
 end
-
-

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -96,6 +96,30 @@ module HammerCLIForeman
       build_options
     end
 
+    class AvailableNetworksCommand < HammerCLIForeman::ListCommand
+
+      resource :compute_resources, :available_networks
+      command_name 'networks'
+      desc _("Show available networks")
+
+      build_options
+
+      validate_options do
+        any(:option_id, :option_name).required
+      end
+
+      def request_params
+        params = super
+        params['id'] ||= get_identifier
+        params
+      end
+
+      output do
+        field :name, _("Name")
+        field :id, _("Id")
+      end
+
+    end
 
     autoload_subcommands
     subcommand 'image', HammerCLIForeman::Image.desc, HammerCLIForeman::Image

data/lib/hammer_cli_foreman/filter.rb

@@ -93,7 +93,7 @@ module HammerCLIForeman
 
       def request_params
         params = super
-        if override?
+        if !override?
           # Clear taxonomies in case the filter is switching override from true to false
           params['filter']['location_ids'] = []
           params['filter']['organization_ids'] = []
@@ -107,7 +107,11 @@ module HammerCLIForeman
       end
 
       def override?
-        option_override || filter['override?']
+        if option_override.nil?
+          filter['override?']
+        else
+          option_override
+        end
       end
 
       def filter

data/lib/hammer_cli_foreman/host.rb

@@ -52,12 +52,6 @@ module HammerCLIForeman
         host
       end
 
-      def get_parameters(host_id)
-        params = HammerCLIForeman.foreman_resource!(:parameters).call(:index, :host_id => host_id)
-        HammerCLIForeman.collection_to_common_format(params)
-      end
-
-
       output do
         field :id, _("Id")
         field :uuid, _("UUID"), Fields::Field, :hide_blank => true
@@ -115,6 +109,7 @@ module HammerCLIForeman
         end
 
         HammerCLIForeman::References.parameters(self)
+        HammerCLIForeman::References.all_parameters(self)
 
         # additional info
         label _("Additional info") do
@@ -233,7 +228,7 @@ module HammerCLIForeman
 
       def validate_options
         super
-        unless validator.any(:option_hostgroup_id, :option_hostgroup_name).exist?
+        unless validator.any(:option_hostgroup_id, :option_hostgroup_name, :option_hostgroup_title).exist?
           if option_managed
             validator.any(:option_architecture_name, :option_architecture_id).required
             validator.any(:option_domain_name, :option_domain_id).required

data/lib/hammer_cli_foreman/hostgroup.rb

@@ -72,6 +72,7 @@ module HammerCLIForeman
     class InfoCommand < HammerCLIForeman::InfoCommand
 
       output ListCommand.output_definition do
+        field :description, _("Description"), Fields::LongText, :hide_blank => true
         field nil, _("Subnet"), Fields::SingleReference, :key => :subnet
 
         field nil, _("Domain"), Fields::SingleReference, :key => :domain