hammer_cli_foreman 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c465b8794294776b0e5c79cad51f615097d8731
-  data.tar.gz: f5fb6f3c7d7bc2a30d3aefdcff70b7f53697225d
+  metadata.gz: 6b196146a134afe8482c703b560288d0e8cb2206
+  data.tar.gz: 15eab89eccbcd3cd909194ddba493797dce136eb
 SHA512:
-  metadata.gz: 65664eb6db87d9aad63d1b02474e5511bd45824e07f65f648e27bbc5d6092c4c7a53a56f5775cb2f19587a477e73e7771119304e74f1d588eb9d6c7ba09aa9a2
-  data.tar.gz: 386f80dc7f518c543c863228bdc0b73cdaa1ad1b128cbf4b72aa2413ce69d9f91e5a1c9fc1149f935d772042cdd29702d9ed9ad2bf9b3822fbd853638b6fdea6
+  metadata.gz: beb620540ca30ef2cf3b17c9ca29b6e1ae781a3dd7bc1d173de3e9d6854cc4426872cf494fc5f65437b8aa81a59a67569b51081637005785b0549c93f072988c
+  data.tar.gz: 2225626548fe1c23627620b3a7d82806d32637ecec5fee683ab3726a8be613074027f243866c6cdc708a1e764013006da648dcab105e7a051318d985edf494a4

data/config/foreman.yml

@@ -0,0 +1,16 @@
+:foreman:
+  # Enable/disable foreman commands
+  :enable_module: true
+
+  # Your foreman server address
+  :host: 'https://localhost/'
+
+  # Credentials. You'll be asked for them interactively if you leave them blank here
+  :username: 'admin'
+  #:password: 'example'
+
+  # Check API documentation cache status on each request
+  #:refresh_cache: false
+
+  # API request timeout. Set to -1 for no timeout
+  #:request_timeout: 120 #seconds

data/doc/host_create.md

@@ -10,43 +10,72 @@ Usage:
     hammer host create [OPTIONS]
 
 Options:
-    --name NAME
-    --ip IP                       Not required if using a subnet with dhcp proxy.
-    --mac MAC                     Not required if it's a virtual machine.
-    --puppet-class-ids PUPPET_CLASS_IDS Comma separated list of values.
-    --medium-id MEDIUM_ID
-    --subnet-id SUBNET_ID
-    --sp-subnet-id SP_SUBNET_ID
-    --model-id MODEL_ID
-    --hostgroup-id HOSTGROUP_ID
-    --owner-id OWNER_ID
-    --puppet-ca-proxy-id PUPPET_CA_PROXY_ID
-    --security-groups SECURITY_GROUPS
-    --environment-id ENVIRONMENT_ID
-    --architecture-id ARCHITECTURE_ID
-    --domain-id DOMAIN_ID
-    --puppet-proxy-id PUPPET_PROXY_ID
-    --operatingsystem-id OPERATINGSYSTEM_ID
-    --partition-table-id PARTITION_TABLE_ID
-    --compute-resource-id COMPUTE_RESOURCE
-    --partition-table-id PARTITION_TABLE
-    --build BUILD                 One of true/false, yes/no, 1/0.
-                                  Default: "true"
-    --managed MANAGED             One of true/false, yes/no, 1/0.
-                                  Default: "true"
-    --enabled ENABLED             One of true/false, yes/no, 1/0.
-                                  Default: "true"
-    --parameters PARAMS           Host parameters.
-                                  Comma-separated list of key=value.
-    --compute-attributes COMPUTE_ATTRS Compute resource attributes.
-                                  Comma-separated list of key=value.
-    --volume VOLUME               Volume parameters
-                                  Comma-separated list of key=value.
-                                  Can be specified multiple times.
-    --interface INTERFACE         Interface parameters.
-                                  Comma-separated list of key=value.
-                                  Can be specified multiple times.
-    -h, --help                    print help
+ --architecture ARCHITECTURE_NAME          Architecture name
+ --architecture-id ARCHITECTURE_ID
+ --ask-root-password ASK_ROOT_PW           One of true/false, yes/no, 1/0.
+ --build BUILD                             One of true/false, yes/no, 1/0.
+                                           Default: "true"
+ --comment COMMENT                         Additional information about this host
+ --compute-attributes COMPUTE_ATTRS        Compute resource attributes.
+                                           Comma-separated list of key=value.
+ --compute-profile COMPUTE_PROFILE_NAME    Name to search by
+ --compute-profile-id COMPUTE_PROFILE_ID
+ --compute-resource COMPUTE_RESOURCE_NAME  Compute resource name
+ --compute-resource-id COMPUTE_RESOURCE_ID
+ --domain DOMAIN_NAME                      Domain name
+ --domain-id DOMAIN_ID                     Numerical ID or domain name
+ --enabled ENABLED                         One of true/false, yes/no, 1/0.
+                                           Default: "true"
+ --environment ENVIRONMENT_NAME            Environment name
+ --environment-id ENVIRONMENT_ID
+ --hostgroup HOSTGROUP_NAME                Hostgroup name
+ --hostgroup-id HOSTGROUP_ID
+ --hostgroup-title HOSTGROUP_TITLE         Hostgroup title
+ --image IMAGE_NAME                        Name to search by
+ --image-id IMAGE_ID
+ --interface INTERFACE                     Interface parameters.
+                                           Comma-separated list of key=value.
+                                           Can be specified multiple times.
+ --ip IP                                   not required if using a subnet with DHCP proxy
+ --location LOCATION_NAME                  Location name
+ --location-id LOCATION_ID
+ --mac MAC                                 required for managed host that is bare metal, not required if it’s a virtual machine
+ --managed MANAGED                         One of true/false, yes/no, 1/0.
+                                           Default: "true"
+ --medium MEDIUM_NAME                      Medium name
+ --medium-id MEDIUM_ID
+ --model MODEL_NAME                        Model name
+ --model-id MODEL_ID
+ --name NAME
+ --operatingsystem OPERATINGSYSTEM_TITLE   Operating system title
+ --operatingsystem-id OPERATINGSYSTEM_ID
+ --organization ORGANIZATION_NAME          Organization name
+ --organization-id ORGANIZATION_ID
+ --owner OWNER_LOGIN                       Login of the owner
+ --owner-id OWNER_ID                       ID of the owner
+ --owner-type OWNER_TYPE                   Host’s owner type
+ --parameters PARAMS                       Host parameters.
+                                           Comma-separated list of key=value.
+ --partition-table PARTITION_TABLE_NAME    Partition table name
+ --partition-table-id PARTITION_TABLE_ID
+ --progress-report-id PROGRESS_REPORT_ID   UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks
+ --provision-method METHOD                 One of 'build', 'image'
+ --puppet-ca-proxy PUPPET_CA_PROXY_NAME
+ --puppet-ca-proxy-id PUPPET_CA_PROXY_ID
+ --puppet-class-ids PUPPET_CLASS_IDS       Comma separated list of values.
+ --puppet-classes PUPPET_CLASS_NAMES       Comma separated list of values.
+ --puppet-proxy PUPPET_PROXY_NAME
+ --puppet-proxy-id PUPPET_PROXY_ID
+ --realm REALM_NAME                        Name to search by
+ --realm-id REALM_ID                       Numerical ID or realm name
+ --root-pass ROOT_PASS                     required if host is managed and value is not inherited from host group or default password in settings
+ --root-password ROOT_PW
+ --subnet SUBNET_NAME                      Subnet name
+ --subnet-id SUBNET_ID
+ --volume VOLUME                           Volume parameters
+                                           Comma-separated list of key=value.
+                                           Can be specified multiple times.
+ -h, --help                                print help
 ```
 
 Example
@@ -56,36 +85,55 @@ An example command for creating a host with 2 volumes (5GB raw + 10 GB qcow2) us
 a default network interface on a libvirt provider can look like this:
 ```bash
 hammer host create
-  --hostgroup-id=4                           # most of the settings is done in the hostgroup
-  --compute-resource-id=1                    # set the libvirt provider
+  --hostgroup=my_hostgroup                   # most of the settings is done in the hostgroup
+  --compute-resource=libvirt                 # set the libvirt provider
   --compute-attributes="cpus=2"              # specify the provider specific options, see the list below
-  --interface="type=network,network=default" # add a network interface, can be passed multiple times
+  --interface="primary=true,compute_type=network,compute_network=default" # add a network interface, can be passed multiple times
   --volume="capacity=5G"                     # add a volume, can be passed multiple times
   --volume="capacity=10G,format_type=qcow2"  # add another volume with different size and type
   --name="test-host"
-  --ip="1.2.3.4"
 ```
 
 See the list of all possible option keys below.
 
 
-Provider specific options
+Common interface settings
 =========================
 
-## Bare Metal
+Please note that managed hosts need to have one primary interface. Always set `primary=true` for one of your interfaces.
+
 Available keys for `--interface`:
 ```
-type       # one of Nic::Managed, Nic::BMC
 mac
+ip
+type       # One of interface, bmc, bond
 name
-domain_id
 subnet_id
-ip
+domain_id
+identifier
+managed    # true/false
+primary    # true/false, each managed hosts needs to have one primary interface.
+provision  # true/false
+virtual    # true/false
+
+# for virtual interfaces:
+tag         # VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.
+attached_to # Identifier of the interface to which this interface belongs, e.g. eth1.
+
+# for bonds:
+mode             # One of balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb
+attached_devices # Identifiers of slave interfaces, e.g. [eth1,eth2].
+bond_options
+
+# for BMCs:
 provider   # always IPMI
-username   # BMC only
-password   # BMC only
+username
+password
 ```
 
+Provider specific options
+=========================
+
 ## EC2
 Available keys for `--compute-attributes`:
 ```
@@ -115,9 +163,9 @@ start         # boolean, whether to start the machine or not
 
 Available keys for `--interface`:
 ```
-type              # one of [:bridge, :network]
-network / :bridge # name of interface according to type
-model             # one of [virtio, rtl8139, ne2k_pci, pcnet, e1000]
+compute_type                      # one of [:bridge, :network]
+compute_network / compute_bridge  # name of interface according to type
+compute_model                     # one of [virtio, rtl8139, ne2k_pci, pcnet, e1000]
 ```
 
 Available keys for `--volume`:
@@ -149,8 +197,8 @@ start      # boolean, whether to start the machine or not
 
 Available keys for `--interface`:
 ```
-name         # eg. eth0
-network      # select one of available networks for a cluster
+compute_name         # eg. eth0
+compute_network      # select one of available networks for a cluster
 ```
 
 Available keys for `--volume`:
@@ -178,7 +226,7 @@ path
 
 Available keys for `--interface`:
 ```
-network
+compute_network
 ```
 
 Available keys for `--volume`:

data/doc/release_notes.md

@@ -1,6 +1,26 @@
 Release notes
 =============
 
+### 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))
+* Improve handling of id search errors ([#9971](http://projects.theforeman.org/issues/9971))
+* Commands for managing host's interfaces ([#3849](http://projects.theforeman.org/issues/3849))
+* Support for smart variables and override values ([#2928](http://projects.theforeman.org/issues/2928))
+* Can't convert nil into Array in compute resouce info ([#7699](http://projects.theforeman.org/issues/7699))
+* Use correct domain for system locales, only load one domain ([#9648](http://projects.theforeman.org/issues/9648))
+* Allow disablement of record_to_common_format ([#8227](http://projects.theforeman.org/issues/8227))
+* Puppet-classes in host and hostgroup returns without an error ([#7473](http://projects.theforeman.org/issues/7473))
+* Does not resolve a nested host group to id when updating a host ([#9318](http://projects.theforeman.org/issues/9318))
+* User info doesn't display timezone and locale ([#9114](http://projects.theforeman.org/issues/9114))
+* Update to gettext 3.x ([#8980](http://projects.theforeman.org/issues/8980))
+* Commands for settings ([#2918](http://projects.theforeman.org/issues/2918))
+* Adds dns name association to domain cli ([#3630](http://projects.theforeman.org/issues/3630))
+* List of host facts is shown correctly ([#7187](http://projects.theforeman.org/issues/7187))
+* Add config directory to gemspec ([#8829](http://projects.theforeman.org/issues/8829))
+* List commands should not be interactive for csv output ([#3898](http://projects.theforeman.org/issues/3898))
+
+
 ### 0.1.4 (2014-12-11)
 * sending puppet class ids ([#8651](http://projects.theforeman.org/issues/8651))
 * setting --puppet-class-ids on host create/update throws api exception ([#8642](http://projects.theforeman.org/issues/8642))

data/lib/hammer_cli_foreman.rb

@@ -107,10 +107,18 @@ module HammerCLIForeman
       'HammerCLIForeman::SmartClassParameter', 'hammer_cli_foreman/smart_class_parameter'
     )
 
+    HammerCLI::MainCommand.lazy_subcommand('smart-variable', _("Manipulate smart variables."),
+      'HammerCLIForeman::SmartVariable', 'hammer_cli_foreman/smart_variable'
+    )
+
     HammerCLI::MainCommand.lazy_subcommand('proxy', _("Manipulate smart proxies."),
       'HammerCLIForeman::SmartProxy', 'hammer_cli_foreman/smart_proxy'
     )
 
+    HammerCLI::MainCommand.lazy_subcommand('settings', _("Change server settings."),
+      'HammerCLIForeman::Settings', 'hammer_cli_foreman/settings'
+    )
+
     HammerCLI::MainCommand.lazy_subcommand('subnet', _("Manipulate subnets."),
       'HammerCLIForeman::Subnet', 'hammer_cli_foreman/subnet'
     )

data/lib/hammer_cli_foreman/commands.rb

@@ -148,7 +148,10 @@ module HammerCLIForeman
       begin
         resolver.send("#{resource.singular_name}_id", opts)
       rescue HammerCLIForeman::MissingSeachOptions => e
-        raise e unless (options[:required] == false)
+        if (options[:required] == true || resource_search_requested(resource, opts))
+          logger.info "Error occured while searching for #{resource.singular_name}"
+          raise e
+        end
       end
     end
 
@@ -157,7 +160,10 @@ module HammerCLIForeman
       begin
         resolver.send("#{resource.singular_name}_ids", opts)
       rescue HammerCLIForeman::MissingSeachOptions => e
-        raise e unless (options[:required] == false)
+        if (options[:required] == true || resource_search_requested(resource, opts, true))
+          logger.info "Error occured while searching for #{resource.name}"
+          raise e
+        end
       end
     end
 
@@ -176,7 +182,7 @@ module HammerCLIForeman
     end
 
     def send_request
-      HammerCLIForeman.record_to_common_format(super)
+      transform_format(super)
     rescue HammerCLIForeman::MissingSeachOptions => e
 
       switches = self.class.find_options(:referenced_resource => e.resource.singular_name).map(&:long_switch)
@@ -198,6 +204,10 @@ module HammerCLIForeman
       )
     end
 
+    def transform_format(data)
+      HammerCLIForeman.record_to_common_format(data)
+    end
+
     def customized_options
       params = options
       # resolve all '<resource_name>_id' parameters if they are defined as options
@@ -235,6 +245,18 @@ module HammerCLIForeman
       params_pruned['id'] = params[id_option_name] if params[id_option_name]
       params_pruned
     end
+
+    private
+
+    def resource_search_requested(resource, options, plural=false)
+      # check if any searchable for given resource is set
+      filed_options = Hash[options.select { |opt, value| !value.nil? }].keys
+      searchable_options = searchables.for(resource).map do |o|
+        HammerCLI.option_accessor_name(plural ? o.plural_name : o.name)
+      end
+      !(filed_options & searchable_options).empty?
+    end
+
   end
 
 
@@ -245,16 +267,19 @@ module HammerCLIForeman
     DEFAULT_PER_PAGE = 20
 
     def adapter
-      :table
+      @context[:adapter] || :table
     end
 
     def send_request
-      data = super
-      set = HammerCLIForeman.collection_to_common_format(data)
+      set = super
       set.map! { |r| extend_data(r) }
       set
     end
 
+    def transform_format(data)
+      HammerCLIForeman.collection_to_common_format(data)
+    end
+
     def extend_data(record)
       record
     end
@@ -284,7 +309,7 @@ module HammerCLIForeman
       while list_next do
         d = retrieve_and_print
 
-        if (d.size >= self.option_per_page.to_i) && interactive?
+        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
@@ -347,8 +372,7 @@ module HammerCLIForeman
     end
 
     def send_request
-      data = super
-      record = HammerCLIForeman.record_to_common_format(data)
+      record = super
       extend_data(record)
     end
 

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -5,12 +5,21 @@ module HammerCLIForeman
   class ComputeResource < HammerCLIForeman::Command
     resource :compute_resources
 
+    module ProviderNameLegacy
+      def extend_data(data)
+        # api used to return provider_friendly_name as a provider
+        data['provider_friendly_name'] ||= data['provider']
+        data
+      end
+    end
+
     class ListCommand < HammerCLIForeman::ListCommand
+      include ProviderNameLegacy
 
       output do
         field :id, _("Id")
         field :name, _("Name")
-        field :provider, _("Provider")
+        field :provider_friendly_name, _("Provider")
       end
 
       build_options
@@ -18,6 +27,8 @@ module HammerCLIForeman
 
 
     class InfoCommand < HammerCLIForeman::InfoCommand
+      include ProviderNameLegacy
+
       PROVIDER_SPECIFIC_FIELDS = {
         'ovirt' => [
           Fields::Field.new(:label => _('UUID'), :path => ["compute_resource", "uuid"])
@@ -49,7 +60,7 @@ module HammerCLIForeman
 
       def print_data(data)
         provider = data["provider"].downcase
-        output_definition.fields.concat PROVIDER_SPECIFIC_FIELDS[provider]
+        output_definition.fields.concat(PROVIDER_SPECIFIC_FIELDS[provider] || [])
         super(data)
       end
 

data/lib/hammer_cli_foreman/domain.rb

@@ -1,5 +1,26 @@
 module HammerCLIForeman
 
+  module DomainUpdateCreateCommons
+
+    def self.included(base)
+      base.option "--dns-id", "DNS_ID",  _("ID of DNS proxy to use within this domain")
+      base.option "--dns", "DNS_NAME", _("Name of DNS proxy to use within this domain")
+    end
+
+    def request_params
+      params = super
+      params['domain']["dns_id"] = option_dns_id || dns_id(option_dns)
+      params
+    end
+
+    private
+
+    def dns_id(name)
+      resolver.smart_proxy_id('option_name' => name) if name
+    end
+
+  end
+
   class Domain < HammerCLIForeman::Command
 
     resource :domains
@@ -31,16 +52,18 @@ module HammerCLIForeman
 
 
     class CreateCommand < HammerCLIForeman::CreateCommand
+      include DomainUpdateCreateCommons
 
       success_message _("Domain [%{name}] created")
       failure_message _("Could not create the domain")
 
       option "--description", "DESC", _("Full name describing the domain"), :attribute_name => :option_fullname
-      build_options :without => [:domain_parameters_attributes, :fullname]
+      build_options :without => [:domain_parameters_attributes, :fullname, :dns_id]
     end
 
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
+      include DomainUpdateCreateCommons
 
       success_message _("Domain [%{name}] updated")
       failure_message _("Could not update the domain")