hammer_cli_foreman 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b196146a134afe8482c703b560288d0e8cb2206
-  data.tar.gz: 15eab89eccbcd3cd909194ddba493797dce136eb
+  metadata.gz: 08aefb712db29b91623d22e401287fa27e3e3f0e
+  data.tar.gz: bfaf0c75a8060cd2005f5ca6168fb393c323c959
 SHA512:
-  metadata.gz: beb620540ca30ef2cf3b17c9ca29b6e1ae781a3dd7bc1d173de3e9d6854cc4426872cf494fc5f65437b8aa81a59a67569b51081637005785b0549c93f072988c
-  data.tar.gz: 2225626548fe1c23627620b3a7d82806d32637ecec5fee683ab3726a8be613074027f243866c6cdc708a1e764013006da648dcab105e7a051318d985edf494a4
+  metadata.gz: d2ee27634d9ddd7107651fab6cb96e8db3057f10f1055cc60429a5357ab9215e1d4937033a2e68b1e9657dcd29b9cd15f5eb145fed98738e1b7a4374d42ac9f8
+  data.tar.gz: 4bfa4ce631e90cbe1166afb917fe0a26aa4b6004577f5d86f3f8caee3baee18cc772fb5110ef55a56761a1344886b58504ca38052a1bc009b028ef3aae57beab

data/doc/developer_docs.md

@@ -6,6 +6,7 @@ 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)
 

data/doc/host_create.md

@@ -4,6 +4,11 @@ Host Creation
 Host creation is one of the most complex commands in the hammer's foreman plugin. The majority of its parameters
 is obvious but there are some that need further explanation as their values differ with the type of a compute resource.
 
+**Warning:**
+Output of `hammer host create -h` may vary with the Foreman server used and plugins installed.
+
+Sample help output for `hammer-cli-foreman 0.2.0` and `Foreman 1.8` follows:
+
 ```
 $ hammer host create -h
 Usage:
@@ -82,7 +87,7 @@ Example
 =======
 
 An example command for creating a host with 2 volumes (5GB raw + 10 GB qcow2) using
-a default network interface on a libvirt provider can look like this:
+a default network interface on a **libvirt** provider can look like this:
 ```bash
 hammer host create
   --hostgroup=my_hostgroup                   # most of the settings is done in the hostgroup
@@ -94,6 +99,7 @@ hammer host create
   --name="test-host"
 ```
 
+Please note that volumes, interfaces and compute attributes **differ significantly** across compute resource types.
 See the list of all possible option keys below.
 
 
@@ -235,4 +241,3 @@ datastore
 name
 size_gb    # integer number
 ```
-

data/doc/release_notes.md

@@ -1,6 +1,15 @@
 Release notes
 =============
 
+### 0.3.0 (2015-07-29)
+* Add normalizer converting id parameter values to numbers ([#11137](http://projects.theforeman.org/issues/11137))
+* Docs - updated information about host creation
+* Added some rough docs showing HammerCLIForeman::Command
+* Adding a command for building PXE default ([#3968](http://projects.theforeman.org/issues/3968))
+* Turn off pagination by default ([#10534](http://projects.theforeman.org/issues/10534))
+* Can't set array parameters on hosts ([#10547](http://projects.theforeman.org/issues/10547))
+
+
 ### 0.2.0 (2015-04-23)
 * Adding default org and loc to user info ([#10251](http://projects.theforeman.org/issues/10251))
 * Host update resets some attributes ([#10215](http://projects.theforeman.org/issues/10215))

data/doc/using_hammer_cli_foreman_command.md

@@ -0,0 +1,92 @@
+Using HammerCLIForeman
+======================
+
+hammer-cli-foreman comes with a handy framework similar to [hammer-cli's ApiPie::Command](https://github.com/theforeman/hammer-cli/blob/master/doc/creating_apipie_commands.md#creating-commands-for-restful-api-with-apipie) which allows the creation of CRUD commands based off the foreman servers api documentation.
+
+Using HammerCLIForeman's Command class instead of ```HammerCLI::Command``` or ```HammerCLI::Apipie::Command``` will allow you to use less code, piggy back on the HammerCLIForeman configuration (username/password/cache/etc..) and rely more on the foreman servers api description for inputs.
+
+
+
+Example Command Template
+------------------------
+
+**Notes**
+* Replace $VARIABLES with your code
+* You will still need to map commands
+
+
+**File**: lib/hammer_cli_foreman_$NAME.rb
+```ruby
+require 'hammer_cli_foreman'
+
+module HammerCLIForeman$NAME
+  def self.exception_handler_class
+    HammerCLIForeman::ExceptionHandler
+  end
+
+  # Using lazy-loaded subcommands
+  # https://github.com/theforeman/hammer-cli/blob/master/doc/creating_commands.md#lazy-loaded-subcommands
+  HammerCLI::MainCommand.lazy_subcommand(
+    '$NAME',
+    '$DESCRIPTION',
+    'HammerCLIForeman$NAME::Command',
+    'hammer_cli_foreman_$NAME/command')
+end
+
+```
+
+
+**File**: lib/hammer_cli_foreman_$NAME/command.rb
+```ruby
+require 'hammer_cli'
+require 'hammer_cli_foreman'
+
+module HammerCLIForeman$NAME
+
+  class Command < HammerCLIForeman::Command
+
+      resource :$API_RESOURCE
+      command_name '$COMMAND_NAME'
+
+      # Lists $NAME's
+      class ListCommand < HammerCLIForeman::ListCommand
+        output do
+          field :id, _('Id')
+          $MORE_FIELDS_YOU_WANT_TO_SHOW
+        end
+
+        build_options # Builds CLI options based on the apidoc
+      end
+
+      # Get's information on a specific $NAME
+      class InfoCommand < HammerCLIForeman::InfoCommand
+        failure_message 'Could not find the requested $NAME' # What to show on failure
+
+        output do
+          field :id, _('Id')
+          $MORE_FIELDS_YOU_WANT_TO_SHOW
+        end
+
+        build_options # Builds CLI options based on the apidoc
+      end
+
+      # Creates a new $NAME
+      class CreateCommand < HammerCLIForeman::CreateCommand
+        success_message '$NAME created' # What to show on success
+        failure_message 'Could not create a $NAME' # What to show on failure
+
+        build_options # Builds CLI options based on the apidoc
+      end
+
+      # Delete's a new $NAME
+      class DeleteCommand < HammerCLIForeman::DeleteCommand
+        success_message '$NAME deleted' # What to show on success
+        failure_message 'Could not delete the $NAME' # What to show on failure
+
+        build_options # Builds CLI options based on the apidoc
+      end
+
+      autoload_subcommands
+  end
+end
+```

data/lib/hammer_cli_foreman/commands.rb

@@ -264,6 +264,7 @@ module HammerCLIForeman
 
     action :index
 
+    RETRIEVE_ALL_PER_PAGE = 1000
     DEFAULT_PER_PAGE = 20
 
     def adapter
@@ -289,12 +290,12 @@ module HammerCLIForeman
     end
 
     def execute
-      if respond_to?(:option_page) && respond_to?(:option_per_page)
-        self.option_page = (self.option_page || 1).to_i
-        self.option_per_page ||= HammerCLI::Settings.get(:ui, :per_page) || DEFAULT_PER_PAGE
-        browse_collection
+      if should_retrieve_all?
+        print_data(retrieve_all)
       else
-        retrieve_and_print
+        self.option_page = (self.option_page || 1).to_i if respond_to?(:option_page)
+        self.option_per_page = (self.option_per_page || HammerCLI::Settings.get(:ui, :per_page) || DEFAULT_PER_PAGE).to_i if respond_to?(:option_per_page)
+        print_data(send_request)
       end
 
       return HammerCLI::EX_OK
@@ -302,27 +303,27 @@ module HammerCLIForeman
 
     protected
 
+    def retrieve_all
+      self.option_per_page = RETRIEVE_ALL_PER_PAGE
+      self.option_page = 1
 
-    def browse_collection
-      list_next = true
-
-      while list_next do
-        d = retrieve_and_print
+      d = send_request
+      all = d
 
-        if (d.size >= self.option_per_page.to_i) && interactive? && adapter != :csv
-          answer = ask(_("List next page? (%s): ") % 'Y/n').downcase
-          list_next = (answer == 'y' || answer == '')
-          self.option_page += 1
-        else
-          list_next = false
-        end
+      while (d.size == RETRIEVE_ALL_PER_PAGE) do
+        self.option_page += 1
+        d = send_request
+        all += d
       end
+      all
     end
 
-    def retrieve_and_print
-      d = send_request
-      print_data d
-      d
+    def pagination_supported?
+      respond_to?(:option_page) && respond_to?(:option_per_page)
+    end
+
+    def should_retrieve_all?
+      pagination_supported? && option_per_page.nil? && option_page.nil?
     end
 
   end

data/lib/hammer_cli_foreman/exception_handler.rb

@@ -18,8 +18,8 @@ module HammerCLIForeman
 
     def handle_unprocessable_entity(e)
       response = JSON.parse(e.response)
-      response = HammerCLIForeman.record_to_common_format(response)
-      print_error response['full_messages']
+      response = HammerCLIForeman.record_to_common_format(response) unless response.has_key?('message')
+      print_error response['message'] || response['full_messages']
       HammerCLI::EX_DATAERR
     end
 
@@ -60,7 +60,7 @@ module HammerCLIForeman
     def handle_foreman_error(e)
       begin
         response = JSON.parse(e.response)
-        response = HammerCLIForeman.record_to_common_format(response)
+        response = HammerCLIForeman.record_to_common_format(response) unless response.has_key?('message')
         message = response['message'] || e.message
       rescue JSON::ParserError => parse_e
         message = e.message

data/lib/hammer_cli_foreman/host.rb

@@ -112,7 +112,7 @@ module HammerCLIForeman
     def parameter_attributes
       return {} unless option_parameters
       option_parameters.collect do |key, value|
-        {"name"=>key, "value"=>value, "nested"=>""}
+        {"name"=>key, "value"=>value.inspect, "nested"=>""}
       end
     end
 

data/lib/hammer_cli_foreman/option_builders.rb

@@ -243,6 +243,7 @@ module HammerCLIForeman
         "#{aliased_name}_id".upcase,
         description("id", :show),
         :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_id"),
+        :format => HammerCLI::Options::Normalizers::Number.new,
         :referenced_resource => resource.singular_name
       )
       options

data/lib/hammer_cli_foreman/template.rb

@@ -142,6 +142,21 @@ module HammerCLIForeman
     end
 
 
+    class BuildPXEDefaultCommand < HammerCLIForeman::Command
+
+      action :build_pxe_default
+
+      command_name "build-pxe-default"
+      desc _("Update the default PXE menu on all configured TFTP servers")
+
+      def print_data(message)
+        puts message
+      end
+
+      build_options
+    end
+
+
     HammerCLIForeman::AssociatingCommands::OperatingSystem.extend_command(self)
 
 

data/lib/hammer_cli_foreman/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIForeman
   def self.version
-    @version ||= Gem::Version.new '0.2.0'
+    @version ||= Gem::Version.new '0.3.0'
   end
 end

data/locale/de/hammer-cli-foreman.edit.po

@@ -4,15 +4,16 @@
 #
 # Translators:
 # Ettore Atalan <atalanttore@googlemail.com>, 2014
+# Marcel Fuhrmann <marcel@mfsystems.me>, 2015
 # simon11 <simon.stieger.98@live.de>, 2014
 # simon11 <simon.stieger.98@live.de>, 2014
 msgid ""
 msgstr ""
-"Project-Id-Version: hammer-cli-foreman 0.1.4\n"
+"Project-Id-Version: hammer-cli-foreman 0.2.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2015-04-23 17:25+0200\n"
-"PO-Revision-Date: 2014-10-11 10:31+0000\n"
-"Last-Translator: Ettore Atalan <atalanttore@googlemail.com>\n"
+"POT-Creation-Date: 2015-07-29 17:24+0200\n"
+"PO-Revision-Date: 2015-03-22 03:37+0000\n"
+"Last-Translator: Marcel Fuhrmann <marcel@mfsystems.me>\n"
 "Language-Team: German (http://www.transifex.com/projects/p/foreman/language/de"
 "/)\n"
 "MIME-Version: 1.0\n"
@@ -102,8 +103,9 @@ msgid "Manipulate smart class parameters."
 msgstr "Smart Class-Parameter verändern"
 
 #: ../lib/hammer_cli_foreman.rb:110
+#, fuzzy
 msgid "Manipulate smart variables."
-msgstr ""
+msgstr "Smart Proxys verändern"
 
 #: ../lib/hammer_cli_foreman.rb:114
 msgid "Manipulate smart proxies."
@@ -465,15 +467,11 @@ msgstr ""
 msgid "Could not find %{resource}, please set one of options %{switches}."
 msgstr ""
 
-#: ../lib/hammer_cli_foreman/commands.rb:313
-msgid "List next page? (%s): "
-msgstr "Nächste Seite auflisten? (%s): "
-
-#: ../lib/hammer_cli_foreman/commands.rb:516
+#: ../lib/hammer_cli_foreman/commands.rb:517
 msgid "Associate a resource"
 msgstr "Ressource zuweisen"
 
-#: ../lib/hammer_cli_foreman/commands.rb:538
+#: ../lib/hammer_cli_foreman/commands.rb:539
 msgid "Disassociate a resource"
 msgstr "Ressource lösen"
 
@@ -570,12 +568,10 @@ msgid "Could not delete the compute resource"
 msgstr "Rechnerressource konnte nicht gelöscht werden"
 
 #: ../lib/hammer_cli_foreman/credentials.rb:26
-#, fuzzy
 msgid "[Foreman] Username: "
 msgstr "[Foreman]-Benutzername: "
 
 #: ../lib/hammer_cli_foreman/credentials.rb:33
-#, fuzzy
 msgid "[Foreman] Password for %s: "
 msgstr "[Foreman]-Passwort für %s: "
 
@@ -789,7 +785,7 @@ msgstr ""
 
 #: ../lib/hammer_cli_foreman/host.rb:17
 msgid "ID of the owner"
-msgstr ""
+msgstr "Kennung des Eigentümers"
 
 #: ../lib/hammer_cli_foreman/host.rb:42
 msgid "Host parameters."
@@ -1097,24 +1093,23 @@ msgstr "Host wird neu gestartet."
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:10
 msgid "List of puppetclass ids"
-msgstr ""
+msgstr "Liste der Puppetklassen-IDs"
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:12
 msgid "Name of puppet CA proxy"
-msgstr ""
+msgstr "Name des Puppet CA Proxy"
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:13
 msgid "Name of puppet proxy"
-msgstr ""
+msgstr "Name des Puppet Proxy"
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:14
 msgid "Name of parent hostgroup"
-msgstr ""
+msgstr "Name der übergeordneten Hostgruppe"
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:49 ../lib/hammer_cli_foreman/operating_system.rb:11
-#, fuzzy
 msgid "Title"
-msgstr "Datei"
+msgstr "Titel"
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:68
 msgid "Puppet CA Proxy Id"
@@ -1130,7 +1125,7 @@ msgstr "Rechnerprofil"
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:74
 msgid "Parent Id"
-msgstr ""
+msgstr "Übergeordnete Kennung"
 
 #: ../lib/hammer_cli_foreman/hostgroup.rb:84
 msgid "Hostgroup created"
@@ -1226,9 +1221,8 @@ msgid "Organization name"
 msgstr "Organisationsname"
 
 #: ../lib/hammer_cli_foreman/id_resolver.rb:50
-#, fuzzy
 msgid "Operating system title"
-msgstr "Betriebssystem erstellt"
+msgstr "Betriebssystemname"
 
 #: ../lib/hammer_cli_foreman/id_resolver.rb:52
 msgid "Partition table name"
@@ -1281,9 +1275,8 @@ msgid "Name to search by"
 msgstr "Zu suchender Name"
 
 #: ../lib/hammer_cli_foreman/id_resolver.rb:153
-#, fuzzy
 msgid "one of %s not found"
-msgstr "%s nicht gefunden"
+msgstr ""
 
 #: ../lib/hammer_cli_foreman/id_resolver.rb:200
 msgid "%s not found"
@@ -2010,8 +2003,9 @@ msgid "Override value created"
 msgstr "Werte übergehen"
 
 #: ../lib/hammer_cli_foreman/smart_class_parameter.rb:132 ../lib/hammer_cli_foreman/smart_variable.rb:122
+#, fuzzy
 msgid "Could not create the override_value"
-msgstr ""
+msgstr "Benutzerrolle konnte nicht erstellt werden"
 
 #: ../lib/hammer_cli_foreman/smart_class_parameter.rb:151 ../lib/hammer_cli_foreman/smart_variable.rb:134
 #, fuzzy
@@ -2215,6 +2209,10 @@ msgstr "Konfigurationsvorlage gelöscht"
 msgid "Could not delete the config template"
 msgstr "Konfigurationsvorlage konnte nicht gelöscht werden"
 
+#: ../lib/hammer_cli_foreman/template.rb:150
+msgid "Update the default PXE menu on all configured TFTP servers"
+msgstr ""
+
 #: ../lib/hammer_cli_foreman/user.rb:11
 msgid "Login"
 msgstr "Anmeldung"
@@ -2305,90 +2303,53 @@ msgstr "Benutzergruppe [%<name>s] gelöscht"
 msgid "Could not delete the user group"
 msgstr "Benutzergruppe konnte nicht gelöscht werden"
 
-#: lib/hammer_cli_foreman/smart_variables.rb:62
-#: lib/hammer_cli_foreman/smart_class_parameter.rb:63
-#~ msgid "Count"
-#~ msgstr "Zähler"
-
-#: lib/hammer_cli_foreman/hostgroup.rb:41
-#~ msgid "Label"
-#~ msgstr "Label"
-
-#: lib/hammer_cli_foreman/hostgroup.rb:45
-#~ msgid "Ancestry"
-#~ msgstr "Abstammung"
-
-#: lib/hammer_cli_foreman/host.rb:167
+#: lib/hammer_cli_foreman/host.rb:171
 #~ msgid "Disk"
 #~ msgstr "Festplatte"
 
-#: lib/hammer_cli_foreman/host.rb:185
+#: lib/hammer_cli_foreman/host.rb:189
 #~ msgid "Puppet Proxy Id"
 #~ msgstr "Puppet-Proxy-ID"
 
-#: lib/hammer_cli_foreman/host.rb:194
+#: lib/hammer_cli_foreman/host.rb:198
 #~ msgid "BMC Network Interfaces"
 #~ msgstr "BMC-Netzwerkschnittstellen"
 
-#: lib/hammer_cli_foreman/host.rb:199 lib/hammer_cli_foreman/host.rb:212
+#: lib/hammer_cli_foreman/host.rb:203 lib/hammer_cli_foreman/host.rb:216
 #~ msgid "Domain Id"
 #~ msgstr "Domain-Kennung"
 
-#: lib/hammer_cli_foreman/host.rb:200 lib/hammer_cli_foreman/host.rb:213
+#: lib/hammer_cli_foreman/host.rb:204 lib/hammer_cli_foreman/host.rb:217
 #~ msgid "Domain Name"
 #~ msgstr "Domainname"
 
-#: lib/hammer_cli_foreman/host.rb:201 lib/hammer_cli_foreman/host.rb:214
+#: lib/hammer_cli_foreman/host.rb:205 lib/hammer_cli_foreman/host.rb:218
 #~ msgid "Subnet Id"
 #~ msgstr "Subnetzkennung"
 
-#: lib/hammer_cli_foreman/host.rb:202 lib/hammer_cli_foreman/host.rb:215
+#: lib/hammer_cli_foreman/host.rb:206 lib/hammer_cli_foreman/host.rb:219
 #~ msgid "Subnet Name"
 #~ msgstr "Subnetzname"
 
-#: lib/hammer_cli_foreman/host.rb:203
+#: lib/hammer_cli_foreman/host.rb:207
 #~ msgid "BMC Username"
 #~ msgstr "BMC-Benutzername"
 
-#: lib/hammer_cli_foreman/host.rb:204
+#: lib/hammer_cli_foreman/host.rb:208
 #~ msgid "BMC Password"
 #~ msgstr "BMC-Passwort"
 
-#: lib/hammer_cli_foreman/host.rb:207
+#: lib/hammer_cli_foreman/host.rb:211
 #~ msgid "Managed Network Interfaces"
 #~ msgstr "Verwaltete Netzwerkschnittstellen"
 
-#: lib/hammer_cli_foreman/operating_system.rb:11
-#~ msgid "Full name"
-#~ msgstr "Vollständiger Name"
-
-#: lib/hammer_cli_foreman/operating_system.rb:46
-#: lib/hammer_cli_foreman/operating_system.rb:73
-#~ msgid "set associated architectures"
-#~ msgstr "Zugehörige Architekturen festlegen"
-
-#: lib/hammer_cli_foreman/operating_system.rb:48
-#: lib/hammer_cli_foreman/operating_system.rb:75
-#~ msgid "set associated templates"
-#~ msgstr "Zugehörige Vorlagen festlegen"
-
-#: lib/hammer_cli_foreman/operating_system.rb:50
-#: lib/hammer_cli_foreman/operating_system.rb:77
-#~ msgid "set associated installation media"
-#~ msgstr "Zugehörige Installationsmedien festlegen"
-
-#: lib/hammer_cli_foreman/operating_system.rb:52
-#: lib/hammer_cli_foreman/operating_system.rb:79
-#~ msgid "set associated partition tables"
-#~ msgstr "Zugehörige Partitionstabellen festlegen"
-
-#: lib/hammer_cli_foreman/credentials.rb:10
-#~ msgid "[Foreman] username: "
-#~ msgstr "[Foreman]-Benutzername: "
-
-#: lib/hammer_cli_foreman/credentials.rb:15
-#~ msgid "[Foreman] password for %s: "
-#~ msgstr "[Foreman]-Passwort für %s: "
+#: lib/hammer_cli_foreman/commands.rb:288
+#~ msgid "List next page? (%s): "
+#~ msgstr "Nächste Seite auflisten? (%s): "
+
+#: lib/hammer_cli_foreman/smart_class_parameter.rb:63
+#~ msgid "Count"
+#~ msgstr "Zähler"
 
 #: lib/hammer_cli_foreman/user.rb:47
 #~ msgid "User created"