hammer_cli_foreman 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8dbe72d7f0cdd60461bcb2ceedbdb241791e9ba
-  data.tar.gz: 7a93863b4b5dfa7e2318e8842df64ee23de005a1
+  metadata.gz: 9d37a2ec65a64506f68335f48ce44b78b113f26e
+  data.tar.gz: 7d4a6b52ec543e70fff320237fffaebdbe5adad7
 SHA512:
-  metadata.gz: 645d647eec03ddee3afd4c4f61677fd1ecfa98b9981cf72d150ac8cb9d68f0adc7b5b1e88c30ad4da52d7fe3463a889a4ad6622b51716cb6ad315f3d3e61b1d3
-  data.tar.gz: f2c39dccfb3949685b4a77703274aa7bcf683953a25ee271fcff63d9152f285ed833dcc00ec4cc3c61064ac92d21145d45ac9d7eb667e38945370b0eb8430533
+  metadata.gz: 79eaebf4bd95a1c7516fd08af892da46e752ae55c5f6f6815722f382b7c0bf0099bd84d8d0f17968c35283c2eb73ae3ef0befb11855c1c74ebfdfa3c53ae6fe3
+  data.tar.gz: 7dd25990c3bc04af071837f7b6bdaa3cfa00d6830310e09d123e03e82fe0143affe25814720f5a42db560df4147ceeeaffb4d4c21dc88be3fcd2fa8309f5971b

data/LICENSE

@@ -0,0 +1,5 @@
+This program and entire repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

data/README.md

@@ -37,21 +37,7 @@ look at [the development documentation](doc/developer_docs.md#hammer-development
 
 How to test
 ------------
-
-```bash
-   $ bundle install
-   $ bundle exec "rake test"
-```
-
-Generated coverage reports are stored in ./coverage directory.
-
-There is support for testing against API documentation (and sample data) generated from different versions of Foreman.
-The required version of Foreman can be set in env variable `TEST_API_VERSION`. Make sure the requested data are
-in `test/unit/data/<version>/`.
-
-```bash
-  $ TEST_API_VERSION=1.10 bundle exec rake test
-```
+Please read our [testing documentation](doc/testing.md#testing-hammer-commands) for more information about how to write and run tests.
 
 
 License

data/doc/configuration.md

@@ -11,3 +11,41 @@ from `config/foreman.yml`.
 
 See our [sample config file](https://github.com/theforeman/hammer-cli-foreman/blob/master/config/foreman.yml)
 that lists all available configuration options with descriptions.
+
+## Authentication
+### Basic auth
+Basic authentication with username and password is currently the only supported method.
+
+You can save your credentials into hammer config file in your home directory:
+`~/.hammer/cli.modules.d/foreman.yml`
+```yaml
+:foreman:
+  :username: 'admin'
+  :password: 'example'
+```
+
+Credentials can be passed directly on the command line too:
+```bash
+hammer -u admin -p example ...
+```
+
+If there are no credentials in neither config files nor command line, hammer asks for them interactively:
+```
+>> hammer host list
+[Foreman] Username: admin
+[Foreman] Password for admin:
+...
+```
+
+**Sessions**
+
+Hammer supports session authentication to reduce the need of entering credentials for each command.
+It's disabled by default. To turn it on, put following into your config file:
+```yaml
+:foreman:
+  :use_sessions: true
+```
+Unfortunately retry on session expiry is yet to be implemented. Therefore you'll observe first command to fail
+after the session expires.
+
+The default session timeout is 1 hour. This can be changed in the Foreman: `Settings > Authentication > Idle timeout`

data/doc/developer_docs.md

@@ -6,9 +6,10 @@ There's a lot of useful information in
 Studying it first can help you to understand the basic principles.
 
 Foreman plugin extends the Hammer Core in following areas:
- - [Using HammerCLIForeman::Command](using_hammer_cli_foreman_command.md)
- - [Building options](option_builder.md#option-builder)
- - [Automatic name resolution](name_id_resolution.md#name---id-resolution)
+ - [Using HammerCLIForeman::Command](using_hammer_cli_foreman_command.md#using-hammercliforeman)
+ - [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)
 
 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/release_notes.md

@@ -1,5 +1,23 @@
 Release notes
 =============
+
+### 0.10.0 (2017-03-28)
+* Adding --hidden-value option to parameters (#290) ([#18878](http://projects.theforeman.org/issues/18878))
+* Add command to clone user role ([#18318](http://projects.theforeman.org/issues/18318))
+* Default organization/location work with authenticators ([#17936](http://projects.theforeman.org/issues/17936))
+* Display hostgroup title on host actions ([#18739](http://projects.theforeman.org/issues/18739))
+* Respect original request_params ([#18790](http://projects.theforeman.org/issues/18790))
+* Rename config template to provisioning template ([#18654](http://projects.theforeman.org/issues/18654))
+* User create/update accepts organization/location name ([#17923](http://projects.theforeman.org/issues/17923))
+* Skip generating option --root-pass for host create ([#18337](http://projects.theforeman.org/issues/18337))
+* Session authenticator keeps asking for user ([#18170](http://projects.theforeman.org/issues/18170))
+* Host create uses name options ([#18339](http://projects.theforeman.org/issues/18339))
+* Only include .mo files below locale/ ([#18439](http://projects.theforeman.org/issues/18439))
+* Add config group commands ([#7520](http://projects.theforeman.org/issues/7520))
+* Poweroff hosts when using --force option ([#18319](http://projects.theforeman.org/issues/18319))
+* Resolve subnet and domain for host create/update (#273) ([#17247](http://projects.theforeman.org/issues/17247))
+* Prevent from setting taxonomies for non-overriding filters ([#17730](http://projects.theforeman.org/issues/17730))
+
 ### 0.9.0 (2016-12-15)
 * Auth overrides only unauthorized exception ([PR #271](https://github.com/theforeman/hammer-cli-foreman/pull/271)) ([#17650](http://projects.theforeman.org/issues/17650))
 * Session auth in hammer ([PR #269](https://github.com/theforeman/hammer-cli-foreman/pull/269)) ([#8016](http://projects.theforeman.org/issues/8016))

data/doc/testing.md

@@ -0,0 +1,133 @@
+# Testing hammer commands
+
+Commands from `hammer-cli-foreman` are tested by two types of tests:
+- *unit tests* - They're placed in `test/unit` and test only basic functionality of the commands like accepted options and field labels printed to stdout. Unit tests for commands are no longer extended.
+- *functional tests* - They're placed in `test/functional` and aim to test commands in broader context. Functional tests require mocking the api calls and should also test output based on data returned from the api. This is preferable way of testing the commands.
+
+
+## Running the tests
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+Generated coverage reports are stored in ./coverage directory.
+
+There is support for testing against API documentation generated from different versions of Foreman.
+The required version of Foreman can be set in env variable `TEST_API_VERSION`. Make sure the requested data are in `test/unit/data/<version>/`.
+```bash
+$ TEST_API_VERSION=1.13 bundle exec rake test
+```
+
+## Testing API expectations
+
+`hammer-cli-foreman` comes with a set of helpers and extensions to [Mocha](https://github.com/freerange/mocha) library for easier testing and better error detection.
+
+The extensions are included in `test/test_helper.rb` by default. It's also possible to include it elswhere when needed:
+```ruby
+require 'hammer_cli_foreman/testing/api_expectations'
+include HammerCLIForeman::Testing::APIExpectations
+```
+
+### Available helper functions
+
+**`api_expects`**`(resource=nil, action=nil, note=nil, &block)`
+* `resource` Symbol with plural name of the resource.
+* `action` Symbol with action name.
+* `note` String with description of the expected call to make its identification easier when the expectation fails.
+* `&block` Optional block for testing parameters.
+
+ `api_expects` is often used together with `with_params` that set expectation on parameters that need to be included in the call:
+```ruby
+describe 'hostgroup create' do
+  it 'passes architecture id' do
+    api_expects(:hostgroups, :create, 'Create hostgroup with architecture_id').with_params('hostgroup' => {
+      'name' => 'hg1',
+      'architecture_id' => 1
+    })
+
+    run_cmd(%w(hostgroup create --name hg1 --architecture-id 1))
+  end
+end
+```
+
+The expectation failure is reported with description of the call and expected parameters to make searching for mistakes easier:
+```
+unexpected invocation: #<AnyInstance:ApipieBindings::API>.call_action(<Action hostgroups:create>, {'hostgroup' => {'name' => 'hg1', 'architecture_id' => 2}}, {}, {:fake_response => nil})
+unsatisfied expectations:
+- expected exactly once, not yet invoked: Create hostgroup with architecture_id
+  #<AnyInstance:ApipieBindings::API>.call_action(:hostgroups, :create, *any_argument)
+  expected params to include: {
+    "hostgroup": {
+      "name": "hg1",
+      "architecture_id": 1
+    }
+  }
+```
+
+Alternatively parameters can be tested in a block:
+```ruby
+describe 'hostgroup create' do
+  it 'passes architecture id' do
+    api_expects(:hostgroups, :create, 'Create hostgroup with architecture_id') do |p|
+      p['hostgroup']['architecture_id'] == 1 && p['hostgroup']['name'] == 'hg1'
+    end
+
+    run_cmd(%w(hostgroup create --name hg1 --architecture-id 1))
+  end
+end
+```
+
+This approach gives more freedom in what is tested and how but can't report what parameters were expected in case of failure.
+
+**`api_expects_no_call`**
+
+Makes sure no API call is performed.
+
+Example:
+```ruby
+describe 'hostgroup create' do
+  it "doesn't perform any api request when name is missing" do
+    api_expects_no_call
+    run_cmd(%w(hostgroup create))
+  end
+end
+```
+
+**`api_expects_search`**`(resource=nil, search_options={}, note=nil)`
+* `resource` Symbol with plural name of the resource.
+* `search_options` Either hash with options to search by (eg. `:name => 'x86_64'`) or a string with the search query.
+* `note` String with description of the expected call to make its identification easier when the expectation fails.
+
+Helper that sets expectation on searching for a resource when hammer translates from name of the resource to its id. It's often used together with `returns` that mocks result of the search query.
+
+Example:
+```ruby
+describe 'hostgroup create' do
+  let(:arch) {{'id' => 1, 'name' => 'arch1'}}
+
+  it 'resolves architecture name' do
+    api_expects_search(:architectures, { :name => 'arch1' }).returns(index_response([arch]))
+    run_cmd(%w(hostgroup create --name hg1 --architecture arch1))
+  end
+end
+```
+
+**`api_connection`**`(options={}, version = '1.15')`
+* `options` Hash with options for the api connection.
+* `version` Version of the Foreman apidoc. Available exported versions are located in subdirectories of `test/data/`.
+
+The function returns instance of `FakeApiConnection` that makes `#authenticator` public and allows setting expectations on it. Useful for injection of api instances into tested objects.
+
+**`APIExpectationsDecorator`**
+
+Decorator class that adds helpers for setting expectations on the wrapped api instance.
+Provides methods `expects_call`, `expects_no_call` and `expects_search` that behave similarly to the helpers described above.
+
+Example usage:
+```ruby
+connection = api_connection
+api = APIExpectationsDecorator.new(connection.api)
+api.expects_search(:users, 'login=admin')
+```

data/lib/hammer_cli_foreman.rb

@@ -18,8 +18,6 @@ module HammerCLIForeman
   require 'hammer_cli_foreman/param_filters'
   require 'hammer_cli_foreman/id_resolver'
   require 'hammer_cli_foreman/dependency_resolver'
-  require 'hammer_cli_foreman/defaults'
-
 
   begin
     require 'hammer_cli_foreman/commands'
@@ -27,6 +25,7 @@ module HammerCLIForeman
     require 'hammer_cli_foreman/references'
     require 'hammer_cli_foreman/parameter'
     require 'hammer_cli_foreman/common_parameter'
+    require 'hammer_cli_foreman/defaults'
 
     HammerCLI::MainCommand.lazy_subcommand('auth', _("Foreman connection login/logout."),
       'HammerCLIForeman::Auth', 'hammer_cli_foreman/auth'
@@ -140,6 +139,9 @@ module HammerCLIForeman
       'HammerCLIForeman::Usergroup', 'hammer_cli_foreman/usergroup'
     )
 
+    HammerCLI::MainCommand.lazy_subcommand('config-group', _("Manipulate config groups."),
+      'HammerCLIForeman::ConfigGroup', 'hammer_cli_foreman/config_group'
+    )
 
   rescue => e
     handler = HammerCLIForeman::ExceptionHandler.new(:context => {}, :adapter => :base)

data/lib/hammer_cli_foreman/api/connection.rb

@@ -1,5 +1,6 @@
 require 'hammer_cli_foreman/api/session_authenticator_wrapper'
 require 'hammer_cli_foreman/api/interactive_basic_auth'
+require 'hammer_cli_foreman/api/void_auth'
 
 module HammerCLIForeman
   module Api
@@ -30,14 +31,27 @@ module HammerCLIForeman
       protected
 
       def create_authenticator(uri, settings)
-        return @authenticator unless @authenticator.nil?
+        return @authenticator if @authenticator
 
-        @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)
-        @authenticator
+        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)
+          @authenticator
+        end
+      end
+
+      def ssl_cert_authentication?(settings)
+        (settings.get(:_params, :ssl_client_cert) || settings.get(:ssl, :ssl_client_cert)) &&
+        (settings.get(:_params, :ssl_client_key) || settings.get(:ssl, :ssl_client_key))
+      end
+
+      def use_basic_auth?(settings)
+        settings.get(:_params, :ssl_with_basic_auth) || settings.get(:ssl, :ssl_with_basic_auth)
       end
 
       def build_default_params(settings, logger, locale)

data/lib/hammer_cli_foreman/api/interactive_basic_auth.rb

@@ -24,7 +24,7 @@ module HammerCLIForeman
       end
 
       def user
-        get_user
+        @user
       end
 
       private

data/lib/hammer_cli_foreman/api/session_authenticator_wrapper.rb

@@ -32,7 +32,8 @@ module HammerCLIForeman
       def authenticate(request, args)
         load_session
 
-        destroy_session if (@authenticator.user != @user)
+        user = @authenticator.user
+        destroy_session if (user && user != @user)
 
         if @permissions_ok && @session_id
           jar = HTTP::CookieJar.new
@@ -62,6 +63,10 @@ module HammerCLIForeman
         @authenticator.response(r)
       end
 
+      def user
+        @authenticator.user if @authenticator.respond_to?(:user)
+      end
+
       protected
 
       def session_storage

data/lib/hammer_cli_foreman/api/void_auth.rb

@@ -0,0 +1,8 @@
+require 'highline/import'
+
+module HammerCLIForeman
+  module Api
+    class VoidAuth < ApipieBindings::Authenticators::Base
+    end
+  end
+end

data/lib/hammer_cli_foreman/auth.rb

@@ -31,7 +31,7 @@ module HammerCLIForeman
       def execute
         HammerCLIForeman.foreman_api_connection.logout
         context[:api_connection].drop_all
-        print_message(_("Credentials deleted."))
+        print_message(_("Logged out."))
         HammerCLI::EX_OK
       end
     end

data/lib/hammer_cli_foreman/common_parameter.rb

@@ -26,6 +26,7 @@ module HammerCLIForeman
 
       option "--name", "NAME", _("parameter name"), :required => true
       option "--value", "VALUE", _("parameter value"), :required => true
+      option "--hidden-value", "HIDDEN_VALUE", _("should the value be hidden"), :format => HammerCLI::Options::Normalizers::Bool.new
 
       def action
         @action ||= parameter_exist? ? :update : :create

data/lib/hammer_cli_foreman/config_group.rb

@@ -0,0 +1,45 @@
+module HammerCLIForeman
+  class ConfigGroup < HammerCLIForeman::Command
+    resource :config_groups
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _("ID")
+        field :name, _("Name")
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ListCommand.output_definition do
+        HammerCLIForeman::References.puppetclasses(self)
+      end
+
+      build_options
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _("Config group created")
+      failure_message _("Could not create the config group")
+
+      build_options
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _("Config group updated")
+      failure_message _("Could not update the config group")
+
+      build_options
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _("Config group has been deleted")
+      failure_message _("Could not delete the config group")
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman/defaults.rb

@@ -1,7 +1,8 @@
 require 'hammer_cli'
 module HammerCLIForeman
   class Defaults < HammerCLI::BaseDefaultsProvider
-    def initialize
+    def initialize(api_connection = HammerCLIForeman.foreman_api_connection)
+      @api_connection = api_connection
       @provider_name = 'foreman'
       @supported_defaults = [:organization_id, :location_id]
       @description = _('Use the default organization and/or location from the server')
@@ -21,9 +22,11 @@ module HammerCLIForeman
 
     private
     def get_user
-      HammerCLIForeman.foreman_resource(:users).action(:index).call(:search =>"login="+HammerCLIForeman.credentials.username)
+      login = @api_connection.authenticator.user
+      users = @api_connection.resource(:users).action(:index).call(:search => "login=#{login}")
+      users
     end
   end
-  HammerCLI.defaults.register_provider(Defaults.new())
 
+  HammerCLI.defaults.register_provider(Defaults.new)
 end