hammer_cli_foreman 2.0.1 → 2.1.3

data/lib/hammer_cli_foreman/mail_notification.rb

@@ -0,0 +1,31 @@
+
+module HammerCLIForeman
+
+  class MailNotification < HammerCLIForeman::Command
+    resource :mail_notifications
+
+    class ListCommand < HammerCLIForeman::ListCommand
+
+      output do
+        field :id, _("Id")
+        field :name, _("Name")
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output do
+        field :id, _("Id")
+        field :name, _("Name")
+        field :description, _("Description")
+        field :subscription_type, _("Subscription type")
+      end
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end
+

data/lib/hammer_cli_foreman/operating_system.rb

@@ -136,7 +136,7 @@ module HammerCLIForeman
         params = {
           "os_default_template" => {
             "provisioning_template_id" => option_provisioning_template_id,
-            "provisioning_kind_name" => tpl_kind_name
+            "template_kind_name" => tpl_kind_name
           }
         }.merge base_action_params
 

data/lib/hammer_cli_foreman/option_builders.rb

@@ -73,12 +73,15 @@ module HammerCLIForeman
         builders << SearchablesOptionBuilder.new(resource, @searchables)
         dependent_resources += @dependency_resolver.resource_dependencies(resource, :only_required => true, :recursive => true)
       end
-
       dependent_resources += @dependency_resolver.action_dependencies(action, :only_required => false, :recursive => false)
       dependent_resources += @dependency_resolver.action_dependencies(action, :only_required => true, :recursive => true)
 
       dependent_resources.uniq(&:name).each do |dep_resource|
-        builders << DependentSearchablesOptionBuilder.new(dep_resource, @searchables)
+        builders << DependentSearchablesOptionBuilder.new(
+          dep_resource,
+          @searchables,
+          context: { action: action }
+        )
       end
 
       IdArrayParamsFilter.new(:only_required => false).for_action(action).each do |p|
@@ -181,9 +184,10 @@ module HammerCLIForeman
 
   class DependentSearchablesOptionBuilder < SearchablesAbstractOptionBuilder
 
-    def initialize(resource, searchables)
+    def initialize(resource, searchables, options = {})
       @resource = resource
       @searchables = searchables
+      @context = options[:context] || {}
     end
 
     attr_reader :resource
@@ -200,6 +204,13 @@ module HammerCLIForeman
       searchables = @searchables.for(resource)
       resource_name = resource.singular_name
       aliased_name = aliased(resource_name, resource_name_map)
+      types = searchables.map(&:name).push('id').map(&:capitalize).join('/')
+      associated_resource = resource.singular_name.to_s.tr('_', ' ')
+      family = HammerCLI::Options::OptionFamily.new(
+        referenced_resource: resource_name,
+        aliased_resource: aliased_name,
+        description: _('Set the current %{resource} context for the request. %{types} can be used') % { types: types, resource: associated_resource }
+      )
 
       unless searchables.empty?
         first = searchables[0]
@@ -207,36 +218,34 @@ module HammerCLIForeman
 
         # First option is named by the resource
         # Eg. --organization with accessor option_organization_name
-        options << option(
+        options << family.child(
           optionamize("--#{aliased_name}"),
           "#{aliased_name}_#{first.name}".upcase,
           first.description || " ",
-          :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_#{first.name}"),
-          :referenced_resource => resource.singular_name
+          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{first.name}")
         )
-
         # Other options are named by the resource plus the searchable name
         # Eg. --organization-label with accessor option_organization_label
         remaining.each do |s|
-          options << option(
+          options << family.send(s.parent? ? :parent : :child,
             optionamize("--#{aliased_name}-#{s.name}"),
             "#{aliased_name}_#{s.name}".upcase,
             s.description || " ",
-            :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_#{s.name}"),
-            :referenced_resource => resource.singular_name,
-            :format => s.format
+            attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{s.name}"),
+            format: s.format
           )
         end
       end
 
-      options << option(
-        optionamize("--#{aliased_name}-id"),
-        "#{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
-      )
+      unless options.any? { |o| o.handles?("--#{aliased_name}-id") }
+        options << family.parent(
+          optionamize("--#{aliased_name}-id"),
+          "#{aliased_name}_id".upcase,
+          description("#{aliased_name}_id", @context[:action]),
+          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_id"),
+          format: HammerCLI::Options::Normalizers::Number.new
+        )
+      end
       options
     end
 
@@ -244,6 +253,14 @@ module HammerCLIForeman
       resource_name_map[name.to_s] || resource_name_map[name.to_sym] || name
     end
 
+    def description(param_name, action)
+      return super('id', :show) if action.nil?
+
+      param = ParamsNameFilter.new(param_name).for_action(action).first
+      return ' ' if param.nil?
+
+      param.description
+    end
   end
 
   class UpdateDependentSearchablesOptionBuilder < DependentSearchablesOptionBuilder
@@ -254,42 +271,44 @@ module HammerCLIForeman
       searchables = @searchables.for(resource)
       resource_name = resource.singular_name
       aliased_name = aliased(resource_name, resource_name_map)
-
+      family = HammerCLI::Options::OptionFamily.new(
+        prefix: 'new-',
+        aliased_resource: aliased_name,
+        referenced_resource: resource_name
+      )
       unless searchables.empty?
         first = searchables[0]
         remaining = searchables[1..-1] || []
 
         # First option is named by the resource
         # Eg. --new-organization with accessor option_new_organization_name
-        options << option(
+        options << family.child(
           optionamize("--new-#{aliased_name}"),
           "new_#{aliased_name}_#{first.name}".upcase,
-          first.description || ' ',
-          attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_#{first.name}"),
-          referenced_resource: resource.singular_name
+          _('Use to update'),
+          attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_#{first.name}")
         )
-
         # Other options are named by the resource plus the searchable name
         # Eg. --new-organization-label with accessor option_new_organization_label
         remaining.each do |s|
-          options << option(
+          options << family.send(s.parent? ? :parent : :child,
             optionamize("--new-#{aliased_name}-#{s.name}"),
             "new_#{aliased_name}_#{s.name}".upcase,
-            s.description || ' ',
-            attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_#{s.name}"),
-            referenced_resource: resource.singular_name
+            _('Use to update'),
+            attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_#{s.name}")
           )
         end
       end
 
-      options << option(
-        optionamize("--new-#{aliased_name}-id"),
-        "new_#{aliased_name}_id".upcase,
-        description('id', :show),
-        attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_id"),
-        format: HammerCLI::Options::Normalizers::Number.new,
-        referenced_resource: resource.singular_name
-      )
+      unless options.any? { |o| o.handles?("--new-#{aliased_name}-id") }
+        options << family.parent(
+          optionamize("--new-#{aliased_name}-id"),
+          "new_#{aliased_name}_id".upcase,
+          _('Use to update'),
+          attribute_name: HammerCLI.option_accessor_name("new_#{resource_name}_id"),
+          format: HammerCLI::Options::Normalizers::Number.new
+        )
+      end
       options
     end
   end
@@ -308,28 +327,31 @@ module HammerCLIForeman
       unless searchables.empty?
         first = searchables[0]
         remaining = searchables[1..-1] || []
-
+        types = searchables.map(&:plural_name).map(&:capitalize).join('/')
+        associated_resource = resource.name.to_s.tr('_', ' ')
+        family = HammerCLI::Options::OptionFamily.new(
+          format: HammerCLI::Options::Normalizers::List.new,
+          referenced_resource: resource_name,
+          aliased_resource: aliased_name,
+          description: _('%{types} of associated %{resource}') % { types: types, resource: associated_resource }
+        )
         # First option is named by the resource
         # Eg. --organizations with accessor option_organization_names
-        options << option(
+        options << family.child(
           optionamize("--#{aliased_plural_name}"),
           "#{aliased_name}_#{first.plural_name}".upcase,
-          " ",
-          :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_#{first.plural_name}"),
-          :format => HammerCLI::Options::Normalizers::List.new,
-          :referenced_resource => resource.singular_name
+          ' ',
+          attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{first.plural_name}")
         )
 
         # Other options are named by the resource plus the searchable name
         # Eg. --organization-labels with accessor option_organization_labels
         remaining.each do |s|
-          options << option(
+          options << family.send(s.parent? ? :parent : :child,
             optionamize("--#{aliased_name}-#{s.plural_name}"),
             "#{aliased_name}_#{s.plural_name}".upcase,
-            " ",
-            :attribute_name => HammerCLI.option_accessor_name("#{resource_name}_#{s.plural_name}"),
-            :format => HammerCLI::Options::Normalizers::List.new,
-            :referenced_resource => resource.singular_name
+            ' ',
+            attribute_name: HammerCLI.option_accessor_name("#{resource_name}_#{s.plural_name}")
           )
         end
       end

data/lib/hammer_cli_foreman/option_sources.rb

@@ -5,3 +5,4 @@ require 'hammer_cli_foreman/option_sources/user_params'
 require 'hammer_cli_foreman/option_sources/fields_params'
 require 'hammer_cli_foreman/option_sources/puppet_environment_params'
 require 'hammer_cli_foreman/option_sources/new_params'
+require 'hammer_cli_foreman/option_sources/referenced_resource_id_params'

data/lib/hammer_cli_foreman/option_sources/referenced_resource_id_params.rb

@@ -0,0 +1,47 @@
+module HammerCLIForeman
+  module OptionSources
+    class ReferencedResourceIdParams < HammerCLIForeman::OptionSources::IdParams
+      def param_updatable?(resource, api_param)
+        resource && @command.respond_to?(HammerCLI.option_accessor_name(api_param.name))
+      end
+
+      def get_options(defined_options, result)
+        return result if @command.action.nil?
+
+        available_id_params.each do |api_param|
+          attr_name = HammerCLI.option_accessor_name(api_param.name.gsub('_id', '_name'))
+          option = @command.class.find_options(attribute_name: attr_name).first
+          next unless option
+
+          resource = HammerCLIForeman.foreman_resource(option.referenced_resource, singular: true)
+          if result[HammerCLI.option_accessor_name(api_param.name)].nil? && param_updatable?(resource, api_param)
+            scope = { HammerCLI.option_accessor_name("#{resource.singular_name}_name") => result[attr_name] }
+            resource_id = @command.get_resource_id(
+              resource, scoped: true, required: api_param.required?,
+              all_options: result.merge(scope))
+            result[HammerCLI.option_accessor_name(api_param.name)] = resource_id if resource_id
+          end
+        end
+        result
+      rescue HammerCLIForeman::MissingSearchOptions => e
+        switches = @command.class.find_options(:referenced_resource => e.resource.singular_name).map(&:long_switch)
+
+        if switches.empty?
+          error_message = _("Could not find %{resource}. Some search options were missing, please see --help.")
+        elsif switches.length == 1
+          error_message = _("Could not find %{resource}, please set option %{switches}.")
+        else
+          error_message = _("Could not find %{resource}, please set one of options %{switches}.")
+        end
+
+        raise MissingSearchOptions.new(
+          error_message % {
+            :resource => e.resource.singular_name,
+            :switches => switches.join(", ")
+          },
+          e.resource
+        )
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman/sessions.rb

@@ -55,7 +55,7 @@ module HammerCLIForeman
   end
 
   class Session
-    attr_accessor :id, :user_name, :auth_type
+    attr_accessor :id, :user_name
 
     def initialize(session_path)
       @session_path = File.expand_path(session_path)
@@ -63,7 +63,6 @@ module HammerCLIForeman
         session_data = JSON.parse(File.read(@session_path))
         @id = session_data['id']
         @user_name = session_data['user_name']
-        @auth_type = session_data['auth_type']
       end
     rescue JSON::ParserError
       warn _('Invalid session data. Resetting the session.')
@@ -73,7 +72,6 @@ module HammerCLIForeman
       File.open(@session_path,"w") do |f|
         f.write({
           id: id,
-          auth_type: auth_type,
           user_name: user_name
         }.to_json)
       end

data/lib/hammer_cli_foreman/subnet.rb

@@ -1,25 +1,28 @@
 module HammerCLIForeman
 
-   module SubnetUpdateCreateCommons
-
-    def self.included(base)
-      base.option "--dns", "DNS_NAME", _("DNS Proxy to use within this subnet")
-      base.option "--dhcp", "DHCP_NAME", _("DHCP Proxy to use within this subnet")
-      base.option "--tftp", "TFTP_NAME", _("TFTP Proxy to use within this subnet")
-    end
-
+  module SubnetUpdateCreateCommons
     def request_params
       params = super
-      params['subnet']["dns_id"] ||= proxy_feature_id(option_dns) if option_dns
-      params['subnet']["dhcp_id"] ||= proxy_feature_id(option_dhcp) if option_dhcp
-      params['subnet']["tftp_id"] ||= proxy_feature_id(option_tftp) if option_tftp
+      if option_prefix || option_mask
+        if params['subnet']['network_type'] == 'IPv6'
+          params['subnet']['cidr'] = (option_prefix || network_prefix).to_s
+        else
+          params['subnet']['mask'] = option_mask || network_mask
+        end
+      end
       params
     end
 
     private
 
-    def proxy_feature_id(name)
-      resolver.smart_proxy_id('option_name' => name) if name
+    def network_mask
+      require 'ipaddr'
+      IPAddr.new('255.255.255.255').mask(option_prefix).to_s
+    end
+
+    def network_prefix
+      require 'ipaddr'
+      IPAddr.new(option_mask).to_i.to_s(2).count('1')
     end
   end
 
@@ -84,7 +87,13 @@ module HammerCLIForeman
       success_message _("Subnet created.")
       failure_message _("Could not create the subnet")
 
-      build_options :without => [:subnet_parameters_attributes]
+      validate_options do
+        any(:option_mask, :option_prefix).required
+      end
+
+      build_options :without => [:subnet_parameters_attributes, :cidr]
+
+      extend_with(HammerCLIForeman::CommandExtensions::Subnet.new)
     end
 
 
@@ -94,7 +103,9 @@ module HammerCLIForeman
       success_message _("Subnet updated.")
       failure_message _("Could not update the subnet")
 
-      build_options :without => [:subnet_parameters_attributes]
+      build_options :without => [:subnet_parameters_attributes, :cidr]
+
+      extend_with(HammerCLIForeman::CommandExtensions::Subnet.new)
     end
 
 

data/lib/hammer_cli_foreman/task_helper.rb

@@ -0,0 +1,180 @@
+require 'fileutils'
+
+module HammerCLIForeman
+  module TaskHelper
+    class PluginDraft
+      attr_reader :name, :path
+
+      def initialize(name, path, options = {})
+        @plain_name = name
+        @name = "hammer_cli_foreman_#{name}"
+        @path = File.expand_path(@name.tr('_', '-'), path)
+        @capitalized_bits = name.split('_').map(&:capitalize)
+        @plugin_namespace = "HammerCLIForeman#{@capitalized_bits.join}"
+        @core_location = File.expand_path('../../', File.dirname(__FILE__))
+        @options = options
+      end
+
+      def build
+        FileUtils.mkpath("#{@path}/lib/#{@name}")
+        FileUtils.mkpath("#{@path}/config")
+        FileUtils.mkpath("#{@path}/test")
+        FileUtils.mkpath("#{@path}/locale")
+      end
+
+      def fill(&block)
+        FileUtils.cd(@path) do
+          self.instance_exec(&block)
+        end
+      end
+
+      private
+
+      def cp_license
+        FileUtils.cp(File.expand_path('LICENSE', @core_location), FileUtils.pwd)
+      end
+
+      def mk_config
+        File.open("config/foreman_#{@plain_name}.yml", 'w') do |config|
+          config.write <<-EOF
+:foreman_#{@plain_name}:
+  :enable_module: true
+EOF
+        end
+      end
+
+      def mk_readme
+        File.open('README.md', 'w') do |readme|
+          readme.write <<-EOF
+# TODO
+EOF
+        end
+      end
+
+      def mk_gemfile
+        File.open('Gemfile', 'w') do |gemfile|
+          gemfile.write <<-EOF
+source "https://rubygems.org"
+
+gemspec
+EOF
+        end
+      end
+
+      def mk_gemspec
+        File.open("#{@name}.gemspec", 'w') do |gemspec|
+          gemspec.write <<-EOF
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require '#{@name}/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = '#{@name}'
+  spec.version       = #{@plugin_namespace}.version.dup
+  spec.authors       = ['#{@options[:author]}']
+  spec.email         = ['#{@options[:email]}']
+  spec.homepage      = 'https://github.com/theforeman/#{@name.tr('_', '-')}'
+  spec.license       = 'GPL-3.0'
+
+  spec.platform      = Gem::Platform::RUBY
+  spec.summary       = 'Foreman #{@capitalized_bits.join(' ')} plugin for Hammer CLI'
+
+  # TODO: Don't forget to update required files accordingly!
+  spec.files         = Dir['{lib,config}/**/*', 'LICENSE', 'README*']
+  spec.require_paths = ['lib']
+  spec.test_files    = Dir['{test}/**/*']
+
+  spec.add_dependency 'hammer_cli_foreman', '>= 2.0.0', '< 3.0.0'
+end
+EOF
+        end
+      end
+
+      def mk_version
+        File.open("lib/#{@name}/version.rb", 'w') do |version|
+          version.write <<-EOF
+module #{@plugin_namespace}
+  def self.version
+    @version ||= Gem::Version.new '0.0.1'
+  end
+end
+EOF
+        end
+      end
+
+      def mk_root
+        File.open("lib/#{@name}.rb", 'w') do |plugin|
+          plugin.write <<-EOF
+module #{@plugin_namespace}
+  require 'hammer_cli'
+  require 'hammer_cli_foreman'
+
+  require '#{@name}/version'
+  require '#{@name}/resource'
+
+  HammerCLI::MainCommand.lazy_subcommand(
+    'resource',
+    'Manage resources',
+    '#{@plugin_namespace}::ResourceCommand',
+    '#{@name}/resource'
+  )
+end
+EOF
+        end
+      end
+
+      def mk_boilerplate
+        File.open("lib/#{@name}/resource.rb", 'w') do |resource_command|
+          resource_command.write <<-EOF
+module #{@plugin_namespace}
+  class ResourceCommand < HammerCLIForeman::Command
+    resource :resources
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ResourceCommand::ListCommand.output_definition do
+        field :head_type, _('Head type')
+      end
+
+      build_options
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _('Resource created.')
+      failure_message _('Could not create the resource')
+
+      build_options
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      success_message _('Resource updated.')
+      failure_message _('Could not update the resource')
+
+      build_options without: [:sprig]
+      option '--head', 'HEAD', _('Head type'), attribute_name: :option_head
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Resource deleted.')
+      failure_message _('Could not delete the resource')
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end
+EOF
+        end
+      end
+    end
+  end
+end