hammer_cli_foreman 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6d49542beab521eda5d1780bf6effc51714df49
-  data.tar.gz: c8e9298892d68c30f192251b2beea23fe7ce53d6
+  metadata.gz: 97a1846e244c06dbf22be733fb72c36c84d02176
+  data.tar.gz: 6bf9b662b14a0316bcc6bc896244776c8d61a3a7
 SHA512:
-  metadata.gz: f5335b895f5de74ccf6ad621cfea4e6e405ed8185e5f01c1c1755230332157018880b46f5d1f5ec022ba3474e4fccbf2469312b7f0c44a6db2025613412a7dcb
-  data.tar.gz: 01ba227af3fb1b4d11e242b373e0b6df484eeace5b37360b2a76ad487489c0178cba9fa385b8fe78f8b89d009c3921abddd51791f06969018ef16ac47da2b8cc
+  metadata.gz: c970a3dd2cb46bd075b3117e17a0a4cb048e37b1e48a8335ccbd8a2cd20731a1289668deed841a7414f416941debd688e9859e3e9d2b67a6ed0ef21a965f054f
+  data.tar.gz: 1a2930c88886e9888de710a80b520d41ec26152c7f294fc37b206548a05c0382594614705e1962da1ebcc18d1baa16bd448708569140568255c85f3e56fc4024

data/README.md

@@ -4,6 +4,7 @@ Foreman commands for Hammer CLI
 This [Hammer CLI](https://github.com/theforeman/hammer-cli) plugin contains
 set of commands for [Foreman](http://theforeman.org/).
 
+Check out the [release notes](doc/release_notes.md#release-notes) to see what's new in the latest version.
 
 Documentation
 -------------
@@ -14,8 +15,8 @@ Documentation
 How to run
 ----------
 
-The work is still in progress and there are no builds ready yet. You can install the plugin from source.
-See [Hammer CLI readme](https://github.com/theforeman/hammer-cli/blob/master/README.md#how-to-run) for details.
+We build rpms, debs and gems. Alternatively you can install hammer from a git checkout.
+See our [Hammer CLI installation and configuration instuctions](https://github.com/theforeman/hammer-cli/blob/master/doc/installation.md#installation).
 
 
 Having issues?
@@ -25,7 +26,14 @@ If one of hammer commands doesn't work as you would expect, you can run `hammer
 full debug output from the loggers. It should give you an idea what went wrong.
 
 If you have questions, don't hesitate to contact us on `foreman-users@googlegroups.com` or
-`FreeNode#foreman` irc channel.
+the `Freenode#theforeman` IRC channel.
+
+
+Developer Docs
+--------------
+If you're planning to contribute,
+look at [the development documentation](doc/developer_docs.md#hammer-development-docs).
+
 
 How to test
 ------------

data/doc/developer_docs.md

@@ -0,0 +1,13 @@
+Hammer-CLI-Foreman Development Docs
+===================================
+
+There's a lot of useful information in
+[development documentation of Hammer Core](https://github.com/theforeman/hammer-cli/blob/master/doc/developer_docs.md#hammer-development-docs).
+Studying it first can help you to understand the basic principles.
+
+Foreman plugin extends the Hammer Core in following areas:
+ - [Building options](option_builder.md#option-builder)
+ - [Automatic name resolution](name_id_resolution.md#name---id-resolution)
+
+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/name_id_resolution.md

@@ -0,0 +1,50 @@
+Name to ID resolution
+=====================
+
+How it works
+------------
+
+The Foreman's API uses unique numeric IDs to reference resources. While they are very easy to deal with in scripts, human users appreciate more readable identifiers. Most of the Foreman's resources are also searchable by name. `HammerCLIForeman`'s commands use ID resolution to make a developer's life easier by handling the translation of names to numeric IDs.
+
+The ID resolution process consists of two parts:
+- building correct parameters (option builders are described [here](https://github.com/theforeman/hammer-cli-foreman/blob/master/doc/option_builder.md#option-builders))
+- the translation process itself ([IdResolver](https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman/id_resolver.rb) takes care of that)
+
+ID resolution step by step
+--------------------------
+
+`IdResolver` implements the method `<resource_name>_id(cli_options)` for each of the resources. Under the hood, the method:
+- returns `cli_options['option_id']` if it's not nil
+- looks at `index` method's parameters, finds all required `*_id` params there and makes sure they're present (if not it tries to resolve them recursively)
+- extends the original options with a `search` field that searches for the name
+- calls the `index` method and returns the result
+
+It can end up with an exception when:
+- the options necessary for search (typically name) are not present
+- one of the dependent resources couldn't be found
+- the resource was not found
+- more resources were found
+
+APIdoc requirements
+-------------------
+
+The builtin name to id resolution in `hammer-cli-foreman` works if the following conditions are met:
+- the API parameters that need to be resolved must respect `<resource_name>_id` format
+- the resource's API controller needs to have the action `index`
+- the `index` action has to support searching by name
+- the `index` action's docs mention all required `*_id` parameters
+- all the above conditions have been fulfilled for any resource referenced from the previous `index` action
+
+Command requirements
+--------------------
+
+Option builders should take care of all the requirements for you, but just for the sake of completeness:
+- the command's action needs to have parameter `id`
+- the command needs to have defined options `--id`, `--name` and possibly options for other identifiers of the primary resource (resource specified in the command)
+- the command needs to define options `--<resource_name>-id`, `--<resource_name>` (but with the reader method `option<resource_name>_name`!) and possibly others for remaining identifiers of all the dependent resources
+
+Behaviour tuning
+----------------
+
+Most of the resources are searchable by name. However there are exceptions that either don't have a name or offer more searchable fields. In such cases you have to update [the definition of searchable fields](https://github.com/theforeman/hammer-cli-foreman/blob/master/lib/hammer_cli_foreman/id_resolver.rb#L31).
+

data/doc/option_builder.md

@@ -0,0 +1,48 @@
+Option Builders
+===============
+
+Commands in the Foreman plugin have by default option builders for:
+- parameters of the related ApiPie action
+- parameters necessary for identication of the resources appearing in the action
+
+The latter creates options for identifying resources based on the action's parameters
+and definition of the resource's searchable fields (_any field that is unique either globally
+or in a scope and is accessible in scoped search at the same time_).
+The searchables definition is kept in [a single mapping object](../lib/hammer_cli_foreman/id_resolver.rb).
+
+__The builder creates:__
+
+1. An identifier option for each of the resource's searchable fields if the action takes parameter `:id`.
+   E.g. `--id`, `--name`, `--label`.
+1. Prefixed identifier options for each parameter ending with `_id` that appears in the action.
+   E.g. `--organization` (first searchable field
+   is considered default and the field name is omitted), `--organization-id`, `--organization-label`.
+1. Prefixed identifier options as above for each __required__ parameter ending with `_id` that appears in index actions
+   of the resources found in the previous step. These options are required for searching resources that appear in the action.
+1. Expansion continues repeating the step 3 recursively.
+
+
+However, this default behavior is not always applicable. Therefore the builder
+enables customizing the set of expanded resources.
+
+See examples in the code below.
+
+```ruby
+build_options do |o|
+  o.expand(:all)  # will do all expansions (default)
+  o.expand(:none) # will not expand anything
+
+  o.expand(:all).including(:locations) # will create additional identifier
+                                       # options for locations
+  o.expand.including(:locations)       # equivalent to the above
+
+  o.expand(:all).except(:organizations) # create identifier options for all resources
+                                        # except from organizations
+
+  o.expand.only(:architectures, :domains) # expand searchables for specific
+                                          # set of resources
+
+  # it is also possible to combine the methods
+  o.expand(:all).including(:locations).except(:organizations)
+end
+```

data/doc/release_notes.md

@@ -0,0 +1,64 @@
+Release notes
+=============
+
+### 0.1.2
+* Docs for name->id resolution
+* Update with installation details and IRC channel
+* Lazy loaded subcommands ([#6761](http://projects.theforeman.org/issues/6761))
+* I18n - fix some broken subcommand description extractions
+* I18n - fix strings to be properly extracted without interpolation
+* I18n - add en_GB locale
+* I18n - extracting new, pulling from tx
+* Initial update of translations, fixed Makefile
+* Fixed pagination ([#6766](http://projects.theforeman.org/issues/6766))
+* Restrict ci_reporter gem to less than 2.0.0 to fix CI ([#6779](http://projects.theforeman.org/issues/6779))
+* Add proxy refresh-features command ([#3387](http://projects.theforeman.org/issues/3387))
+* Fixed simplecov dependences
+* Params from searchables are not wrapped ([#6343](http://projects.theforeman.org/issues/6343))
+* rest-client > 1.7 does not support ruby 1.8 ([#6534](http://projects.theforeman.org/issues/6534))
+* Tests updated to use apidoc export for v1.6 ([#2922](http://projects.theforeman.org/issues/2922))
+* Commands for managing roles, filters, permissions and usergroups ([#2922](http://projects.theforeman.org/issues/2922), [#4004](http://projects.theforeman.org/issues/4004))
+* Obey refresh_cache default of false ([#6478](http://projects.theforeman.org/issues/6478))
+* Creating a more generic hook for search_options ([#6203](http://projects.theforeman.org/issues/6203))
+* Permit only --hostgroup when creating host ([#6335](http://projects.theforeman.org/issues/6335))
+* Better option descriptions ([#6093](http://projects.theforeman.org/issues/6093))
+* Mapping resource names in options ([#6092](http://projects.theforeman.org/issues/6092))
+* Add --server cli option ([#6219](http://projects.theforeman.org/issues/6219))
+* Fix for wrong parameters in proxy import ([#6090](http://projects.theforeman.org/issues/6090))
+* Resolving ids in foreman base command ([#6090](http://projects.theforeman.org/issues/6090))
+* Documentation for fine grained control over name expansion ([#5747](http://projects.theforeman.org/issues/5747))
+* Fine grained control over name expansion ([#5747](http://projects.theforeman.org/issues/5747))
+* Scoped options were not cleaning original options ([#5873](http://projects.theforeman.org/issues/5873))
+* List actions don't resolve ids for optional parameters ([#5873](http://projects.theforeman.org/issues/5873))
+* Help for associating commands is too generic ([#3512](http://projects.theforeman.org/issues/3512))
+* Add pkg:generate_source task to generate gem ([#5793](http://projects.theforeman.org/issues/5793))
+
+### 0.1.1
+* Support for os default templates ([#3970](http://projects.theforeman.org/issues/3970))
+* Searching all resources by name ([#4311](http://projects.theforeman.org/issues/4311))
+* Listing associated resources ([#3102](http://projects.theforeman.org/issues/3102))
+* Fix setting infinite timeouts ([#5209](http://projects.theforeman.org/issues/5209))
+* Support for API localization ([#4478](http://projects.theforeman.org/issues/4478))
+* Removed `log_api_calls` setting
+
+### 0.1.0
+* Fix for Hammer failing silently when no cache is generated ([#4849](http://projects.theforeman.org/issues/4849))
+* Request localized api responses ([#4476](http://projects.theforeman.org/issues/4476))
+* Setting request timeout ([#3598](http://projects.theforeman.org/issues/3598))
+* Added provision_method to host creation
+* Unified format of hammer commands ([#4697](http://projects.theforeman.org/issues/4697))
+* Fix for server formatter failing on not symbol keys ([#4674](http://projects.theforeman.org/issues/4674))
+* Support for dynamic bindings ([#3897](http://projects.theforeman.org/issues/3897))
+* Adds host option to pass root password ([#4587](http://projects.theforeman.org/issues/4587))
+* Adds conditional output field to show network interfaces ([#4589](http://projects.theforeman.org/issues/4589))
+* i18n support ([#4473](http://projects.theforeman.org/issues/4473))
+* Default value for proxy import_puppetclasses --dryrun ([#4130](http://projects.theforeman.org/issues/4130))
+* Fixes DNS proxy id field in subnet list ([#4558](http://projects.theforeman.org/issues/4558))
+* Fixes assigning puppet classes to hostgroups ([#4585](http://projects.theforeman.org/issues/4585))
+* Adds more fields for hostgroup list ([#4588](http://projects.theforeman.org/issues/4588))
+* Fixes createion and update of templates ([#4352](http://projects.theforeman.org/issues/4352))
+* Fixes failing proxy import_classes ([#4517](http://projects.theforeman.org/issues/4517))
+* Fixes displaying errors related to operating system commands ([#4467](http://projects.theforeman.org/issues/4467), [#4466](http://projects.theforeman.org/issues/4466), [#3360](http://projects.theforeman.org/issues/3360))
+* Credentials moved to Foreman
+* Unmanaged host can be now created empty ([#4358](http://projects.theforeman.org/issues/4358))
+* Fixes 500 error messages being ignored ([#4355](http://projects.theforeman.org/issues/4355))

data/lib/hammer_cli_foreman.rb

@@ -12,10 +12,13 @@ module HammerCLIForeman
 
   require 'hammer_cli_foreman/version'
   require 'hammer_cli_foreman/output'
+  require 'hammer_cli_foreman/output/fields'
   require 'hammer_cli_foreman/credentials'
   require 'hammer_cli_foreman/exception_handler'
-  require 'hammer_cli_foreman/searchables_option_builder'
+  require 'hammer_cli_foreman/option_builders'
+  require 'hammer_cli_foreman/param_filters'
   require 'hammer_cli_foreman/id_resolver'
+  require 'hammer_cli_foreman/dependency_resolver'
 
   begin
     require 'hammer_cli_foreman/commands'
@@ -24,28 +27,102 @@ module HammerCLIForeman
     require 'hammer_cli_foreman/parameter'
     require 'hammer_cli_foreman/common_parameter'
 
-    require 'hammer_cli_foreman/architecture'
-    require 'hammer_cli_foreman/auth'
-    require 'hammer_cli_foreman/compute_resource'
-    require 'hammer_cli_foreman/domain'
-    require 'hammer_cli_foreman/environment'
-    require 'hammer_cli_foreman/fact'
-    require 'hammer_cli_foreman/host'
-    require 'hammer_cli_foreman/hostgroup'
-    require 'hammer_cli_foreman/location'
-    require 'hammer_cli_foreman/media'
-    require 'hammer_cli_foreman/model'
-    require 'hammer_cli_foreman/operating_system'
-    require 'hammer_cli_foreman/organization'
-    require 'hammer_cli_foreman/output/fields'
-    require 'hammer_cli_foreman/partition_table'
-    require 'hammer_cli_foreman/report'
-    require 'hammer_cli_foreman/puppet_class'
-    require 'hammer_cli_foreman/smart_proxy'
-    require 'hammer_cli_foreman/smart_class_parameter'
-    require 'hammer_cli_foreman/subnet'
-    require 'hammer_cli_foreman/template'
-    require 'hammer_cli_foreman/user'
+    HammerCLI::MainCommand.lazy_subcommand('auth', _("Foreman connection login/logout."),
+      'HammerCLIForeman::Auth', 'hammer_cli_foreman/auth'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('architecture', _("Manipulate architectures."),
+      'HammerCLIForeman::Architecture', 'hammer_cli_foreman/architecture'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('compute-resource', _("Manipulate compute resources."),
+      'HammerCLIForeman::ComputeResource', 'hammer_cli_foreman/compute_resource'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('domain', _("Manipulate domains."),
+      'HammerCLIForeman::Domain', 'hammer_cli_foreman/domain'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('environment', _("Manipulate environments."),
+      'HammerCLIForeman::Environment', 'hammer_cli_foreman/environment'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('fact', _("Search facts."),
+      'HammerCLIForeman::Fact', 'hammer_cli_foreman/fact'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('filter', _("Manage permission filters."),
+      'HammerCLIForeman::Filter', 'hammer_cli_foreman/filter'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('host', _("Manipulate hosts."),
+      'HammerCLIForeman::Host', 'hammer_cli_foreman/host'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('hostgroup', _("Manipulate hostgroups."),
+      'HammerCLIForeman::Hostgroup', 'hammer_cli_foreman/hostgroup'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('location', _("Manipulate locations."),
+      'HammerCLIForeman::Location', 'hammer_cli_foreman/location'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('medium', _("Manipulate installation media."),
+      'HammerCLIForeman::Medium', 'hammer_cli_foreman/media'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('model', _("Manipulate hardware models."),
+      'HammerCLIForeman::Model', 'hammer_cli_foreman/model'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('os', _("Manipulate operating system."),
+      'HammerCLIForeman::OperatingSystem', 'hammer_cli_foreman/operating_system'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('organization', _("Manipulate organizations."),
+      'HammerCLIForeman::Organization', 'hammer_cli_foreman/organization'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('partition-table', _("Manipulate partition tables."),
+      'HammerCLIForeman::PartitionTable', 'hammer_cli_foreman/partition_table'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('puppet-class', _("Search puppet modules."),
+      'HammerCLIForeman::PuppetClass', 'hammer_cli_foreman/puppet_class'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('report', _("Browse and read reports."),
+      'HammerCLIForeman::Report', 'hammer_cli_foreman/report'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('role', _("Manage user roles."),
+      'HammerCLIForeman::Role', 'hammer_cli_foreman/role'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('sc-param', _("Manipulate smart class parameters."),
+      'HammerCLIForeman::SmartClassParameter', 'hammer_cli_foreman/smart_class_parameter'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('proxy', _("Manipulate smart proxies."),
+      'HammerCLIForeman::SmartProxy', 'hammer_cli_foreman/smart_proxy'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('subnet', _("Manipulate subnets."),
+      'HammerCLIForeman::Subnet', 'hammer_cli_foreman/subnet'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('template', _("Manipulate config templates."),
+      'HammerCLIForeman::Template', 'hammer_cli_foreman/template'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('user', _("Manipulate users."),
+      'HammerCLIForeman::User', 'hammer_cli_foreman/user'
+    )
+
+    HammerCLI::MainCommand.lazy_subcommand('user-group', _("Manage user groups."),
+      'HammerCLIForeman::Usergroup', 'hammer_cli_foreman/usergroup'
+    )
+
 
   rescue => e
     handler = HammerCLIForeman::ExceptionHandler.new(:context => {}, :adapter => :base)

data/lib/hammer_cli_foreman/architecture.rb

@@ -57,5 +57,4 @@ module HammerCLIForeman
 
 end
 
-HammerCLI::MainCommand.subcommand 'architecture', _("Manipulate architectures."), HammerCLIForeman::Architecture
 

data/lib/hammer_cli_foreman/associating_commands.rb

@@ -21,6 +21,7 @@ module HammerCLIForeman
         base_command.const_set(name, cmd_cls)
 
         cmd_cls.resource(base_command.resource.name)
+        cmd_cls.desc(command.desc)
         #TODO: update messages to inherit from parents
         cmd_cls.success_message(command.success_message)
         cmd_cls.failure_message(command.failure_message)
@@ -37,10 +38,12 @@ module HammerCLIForeman
 
       class AddHostgroupCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :hostgroups
+        desc _("Associate a hostgroup")
       end
 
       class RemoveHostgroupCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :hostgroups
+        desc _("Disassociate a hostgroup")
       end
     end
 
@@ -49,10 +52,12 @@ module HammerCLIForeman
 
       class AddEnvironmentCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :environments
+        desc _("Associate an environment")
       end
 
       class RemoveEnvironmentCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :environments
+        desc _("Disassociate an environment")
       end
     end
 
@@ -61,10 +66,12 @@ module HammerCLIForeman
 
       class AddDomainCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :domains
+        desc _("Associate a domain")
       end
 
       class RemoveDomainCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :domains
+        desc _("Disassociate a domain")
       end
     end
 
@@ -73,10 +80,12 @@ module HammerCLIForeman
 
       class AddMediumCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :media
+        desc _("Associate a medium")
       end
 
       class RemoveMediumCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :media
+        desc _("Disassociate a medium")
       end
     end
 
@@ -85,10 +94,12 @@ module HammerCLIForeman
 
       class AddSubnetCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :subnets
+        desc _("Associate a subnet")
       end
 
       class RemoveSubnetCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :subnets
+        desc _("Disassociate a subnet")
       end
     end
 
@@ -97,10 +108,12 @@ module HammerCLIForeman
 
       class AddComputeResourceCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :compute_resources
+        desc _("Associate a compute resource")
       end
 
       class RemoveComputeResourceCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :compute_resources
+        desc _("Disassociate a compute resource")
       end
     end
 
@@ -109,6 +122,7 @@ module HammerCLIForeman
 
       class AddSmartProxyCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :smart_proxies
+        desc _("Associate a smart proxy")
 
         def associated_resource_name
           "smart-proxy"
@@ -117,6 +131,7 @@ module HammerCLIForeman
 
       class RemoveSmartProxyCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :smart_proxies
+        desc _("Disassociate a smart proxy")
 
         def associated_resource_name
           "smart-proxy"
@@ -129,6 +144,7 @@ module HammerCLIForeman
 
       class AddUserCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :users
+        desc _("Associate an user")
 
         success_message "The user has been associated"
         failure_message "Could not associate the user"
@@ -136,21 +152,48 @@ module HammerCLIForeman
 
       class RemoveUserCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :users
+        desc _("Disassociate an user")
 
         success_message "The user has been disassociated"
         failure_message "Could not disassociate the user"
       end
     end
 
+    module Usergroup
+      extend CommandExtension
+
+      class AddUsergroupCommand < HammerCLIForeman::AddAssociatedCommand
+        associated_resource :usergroups
+        desc _("Associate an user group")
+
+        command_name 'add-user-group'
+
+        success_message "The user group has been associated"
+        failure_message "Could not associate the user group"
+      end
+
+      class RemoveUsergroupCommand < HammerCLIForeman::RemoveAssociatedCommand
+        associated_resource :usergroups
+        desc _("Disassociate an user group")
+
+        command_name 'remove-user-group'
+
+        success_message "The user group has been disassociated"
+        failure_message "Could not disassociate the user group"
+      end
+    end
+
     module ConfigTemplate
       extend CommandExtension
 
       class AddConfigTemplateCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :config_templates
+        desc _("Associate a configuration template")
       end
 
       class RemoveConfigTemplateCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :config_templates
+        desc _("Disassociate a configuration template")
       end
     end
 
@@ -159,10 +202,12 @@ module HammerCLIForeman
 
       class AddOrganizationCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :organizations
+        desc _("Associate an organization")
       end
 
       class RemoveOrganizationCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :organizations
+        desc _("Disassociate an organization")
       end
     end
 
@@ -171,6 +216,7 @@ module HammerCLIForeman
 
       class AddOSCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :operatingsystems
+        desc _("Associate an operating system")
 
         success_message _("Operating system has been associated")
         failure_message _("Could not associate the operating system")
@@ -179,6 +225,7 @@ module HammerCLIForeman
 
       class RemoveOSCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :operatingsystems
+        desc _("Disassociate an operating system")
 
         success_message _("Operating system has been disassociated")
         failure_message _("Could not disassociate the operating system")
@@ -190,6 +237,7 @@ module HammerCLIForeman
 
       class AddArchitectureCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :architectures
+        desc _("Associate an architecture")
 
         success_message _("Architecture has been associated")
         failure_message _("Could not associate the architecture")
@@ -198,6 +246,7 @@ module HammerCLIForeman
 
       class RemoveArchitectureCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :architectures
+        desc _("Disassociate an architecture")
 
         success_message _("Architecture has been disassociated")
         failure_message _("Could not disassociate the architecture")
@@ -209,6 +258,7 @@ module HammerCLIForeman
 
       class AddPartitionTableCommand < HammerCLIForeman::AddAssociatedCommand
         associated_resource :ptables
+        desc _("Associate a partition table")
 
         success_message _("Partition table has been associated")
         failure_message _("Could not associate the partition table")
@@ -217,12 +267,33 @@ module HammerCLIForeman
 
       class RemovePartitionTableCommand < HammerCLIForeman::RemoveAssociatedCommand
         associated_resource :ptables
+        desc _("Disassociate a partition table")
 
         success_message _("Partition table has been disassociated")
         failure_message _("Could not disassociate the partition table")
       end
     end
 
+    module Role
+      extend CommandExtension
+
+      class AddRoleCommand < HammerCLIForeman::AddAssociatedCommand
+        associated_resource :roles
+        desc _("Assign a user role")
+
+        success_message _("User role has been assigned")
+        failure_message _("Could not assign the user role")
+      end
+
+
+      class RemoveRoleCommand < HammerCLIForeman::RemoveAssociatedCommand
+        associated_resource :roles
+        desc _("Remove a user role")
+
+        success_message _("User role has been removed")
+        failure_message _("Could not remove the user role")
+      end
+    end
 
   end
 end