hammer_cli_katello 0.23.1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39b7d013b69ccff473c384efe07fbc1c1574033c074e685be65723f5e3d79156
-  data.tar.gz: 9ba014e8f0a515eddfbb66d507483fa8f81b8873c5e670eca78755989bc1f40d
+  metadata.gz: 6a4a20566a58ddf6462ecdc274f1d4f7e107c482ac79ab93b42db2ab11b6d45e
+  data.tar.gz: 6ad63b1d4e551613de6508c34f137f835934c34731e6dcbb18e69a20b51d421a
 SHA512:
-  metadata.gz: 32c3e1f7dc2aa8fa32ceba935d7229c7b628bdf9429f6ed1fa036e818d3cca44bfa47d5d2319e7b8b16354688302f6743168fca59aa62c4a956f9ba4206fe74c
-  data.tar.gz: d270942a73c21fa9e996f1e0457d82b8e4abc866ddeed5d201d017febfbf9272640144aeacc260387550e8e8e22b36fac80b33b2e7b3d93fad87ff98ee465886
+  metadata.gz: 179e73dd5c1186e82ff0265cb7eeb36f1a86daee9b2fe915d9cb3fe855ae62420601d2f7ca3adb153d70ffaadaa492be3086ecf129ed17b9435441d8727ac2e1
+  data.tar.gz: 8918cf5f6376226d4cecd99a70dbadd59d3a7ba2d029517a06849e3f89a9e94b0ea5a76ce46edb60847ceb64b2dcf0af0724a86530541231cf0ae22fa2d2c593

data/lib/hammer_cli_katello.rb

@@ -31,6 +31,7 @@ module HammerCLIKatello
   require 'hammer_cli_katello/local_helper'
   require 'hammer_cli_katello/apipie_helper'
   require 'hammer_cli_katello/cv_import_export_helper'
+  require 'hammer_cli_katello/content_export_helper'
 
   # commands
   HammerCLI::MainCommand.lazy_subcommand("activation-key", _("Manipulate activation keys"),
@@ -43,18 +44,8 @@ module HammerCLIKatello
                                           'hammer_cli_katello/organization'
                                          )
 
-  HammerCLI::MainCommand.lazy_subcommand("gpg",
-                                         _("Manipulate GPG Key actions on the server"),
-                                         'HammerCLIKatello::GpgKeyCommand',
-                                         'hammer_cli_katello/gpg_key',
-                                         :warning =>
-  _('The gpg sub-command is deprecated and will be removed in one of the future versions.' \
-    ' Please use the content-credentials command instead.')
-                                        )
-
   HammerCLI::MainCommand.lazy_subcommand("content-credentials",
-                                         _("Manipulate content credentials (i.e. GPG Keys)' \
-                                          'on the server"),
+                                         _("Manipulate content credentials on the server"),
                                          'HammerCLIKatello::ContentCredentialCommand',
                                          'hammer_cli_katello/content_credential'
                                         )
@@ -70,11 +61,6 @@ module HammerCLIKatello
                                          'hammer_cli_katello/product'
                                         )
 
-  HammerCLI::MainCommand.lazy_subcommand("puppet-module", _("View Puppet Module details"),
-                                         'HammerCLIKatello::PuppetModule',
-                                         'hammer_cli_katello/puppet_module'
-                                        )
-
   HammerCLI::MainCommand.lazy_subcommand("repository", _("Manipulate repositories"),
                                          'HammerCLIKatello::Repository',
                                          'hammer_cli_katello/repository'
@@ -142,6 +128,18 @@ module HammerCLIKatello
                                          'hammer_cli_katello/file'
                                         )
 
+  HammerCLI::MainCommand.lazy_subcommand("content-export",
+                                          _("Prepare content for export to a disconnected Katello"),
+                                         'HammerCLIKatello::ContentExport',
+                                         'hammer_cli_katello/content_export'
+                                        )
+
+  HammerCLI::MainCommand.lazy_subcommand("content-import",
+                                         _("Import content from an upstream archive."),
+                                         'HammerCLIKatello::ContentImport',
+                                         'hammer_cli_katello/content_import'
+                                        )
+
   HammerCLI::MainCommand.lazy_subcommand("module-stream", _("View Module Streams"),
                                          'HammerCLIKatello::ModuleStreamCommand',
                                          'hammer_cli_katello/module_stream'
@@ -152,6 +150,12 @@ module HammerCLIKatello
                                         'hammer_cli_katello/srpm'
                                         )
 
+  HammerCLI::MainCommand.lazy_subcommand("simple-content-access",
+                                         _("Simple content access commands"),
+                                         'HammerCLIKatello::SimpleContentAccess',
+                                         'hammer_cli_katello/simple_content_access'
+                                        )
+
   # subcommands to hammer_cli_foreman commands
   require 'hammer_cli_katello/host'
   require 'hammer_cli_katello/hostgroup'

data/lib/hammer_cli_katello/activation_key.rb

@@ -11,7 +11,7 @@ module HammerCLIKatello
       action :index
 
       output do
-        field :id, _("ID")
+        field :id, _("Id")
         field :name, _("Name")
         field :format_consumed, _("Host Limit")
         from :environment do
@@ -53,7 +53,7 @@ module HammerCLIKatello
 
       output do
         field :name, _("Name")
-        field :id, _("ID")
+        field :id, _("Id")
         field :description, _("Description")
         field :format_limit, _("Host Limit")
         field :auto_attach, _("Auto Attach")
@@ -67,7 +67,7 @@ module HammerCLIKatello
         end
 
         collection :host_collections, _("Host Collections") do
-          field :id, _("ID")
+          field :id, _("Id")
           field :name, _("Name")
         end
 
@@ -150,7 +150,7 @@ module HammerCLIKatello
       command_name "subscriptions"
 
       output do
-        field :id, _("ID")
+        field :id, _("Id")
         field :product_name, _("Name")
         field :format_consumed, _("Attached")
         field :quantity_attached, _("Quantity")
@@ -230,7 +230,7 @@ module HammerCLIKatello
       command_name "host-collections"
 
       output do
-        field :id, _("ID")
+        field :id, _("Id")
         field :name, _("Name")
       end
 

data/lib/hammer_cli_katello/capsule.rb

@@ -13,7 +13,7 @@ module HammerCLIKatello
         command_name 'lifecycle-environments'
 
         output do
-          field :id, _("ID")
+          field :id, _("Id")
           field :name, _("Name")
           from :organization do
             field :name, _("Organization")
@@ -28,7 +28,7 @@ module HammerCLIKatello
         command_name 'available-lifecycle-environments'
 
         output do
-          field :id, _("ID")
+          field :id, _("Id")
           field :name, _("Name")
           from :organization do
             field :name, _("Organization")
@@ -167,7 +167,6 @@ module HammerCLIKatello
                   field :packages, _('Packages')
                   field :package_groups, _('Package groups')
                   field :errata, _('Errata')
-                  field :puppet_modules, _('Puppet modules')
                 end
               end
             end

data/lib/hammer_cli_katello/command_extensions/lifecycle_environment.rb

@@ -2,13 +2,16 @@ module HammerCLIKatello
   module CommandExtensions
     class LifecycleEnvironment < HammerCLI::CommandExtensions
       # Remove when support of --environment options is ended.
-      option '--environment', 'ENVIRONMENT_NAME', _('Lifecycle environment name to search by'),
-             attribute_name: :option_environment_name,
-             deprecated: { '--environment' => _('Use --lifecycle-environment instead') }
-      option '--environment-id', 'ENVIRONMENT_ID', _(''),
-             format: HammerCLI::Options::Normalizers::Number.new,
-             attribute_name: :option_environment_id,
-             deprecated: { '--environment-id' => _('Use --lifecycle-environment-id instead') }
+      option_family(
+        deprecated: { '--environment' => _("Use %s instead") % '--lifecycle-environment',
+                      '--environment-id' => _("Use %s instead") % '--lifecycle-environment-id'}
+      ) do
+        child '--environment', 'ENVIRONMENT_NAME', _('Lifecycle environment name to search by'),
+              attribute_name: :option_environment_name
+        parent '--environment-id', 'ENVIRONMENT_ID', _(''),
+               format: HammerCLI::Options::Normalizers::Number.new,
+               attribute_name: :option_environment_id
+      end
 
       option_sources do |sources, command|
         sources.find_by_name('IdResolution').insert_relative(

data/lib/hammer_cli_katello/command_extensions/lifecycle_environments.rb

@@ -2,14 +2,17 @@ module HammerCLIKatello
   module CommandExtensions
     class LifecycleEnvironments < HammerCLI::CommandExtensions
       # Remove when support of --environments options is ended.
-      option '--environments', 'ENVIRONMENT_NAMES', _(''),
-             format: HammerCLI::Options::Normalizers::List.new,
-             attribute_name: :option_environment_names,
-             deprecated: { '--environments' => _('Use --lifecycle-environments instead') }
-      option '--environment-ids', 'ENVIRONMENT_IDS', _(''),
-             format: HammerCLI::Options::Normalizers::List.new,
-             attribute_name: :option_environment_ids,
-             deprecated: { '--environment-ids' => _('Use --lifecycle-environment-ids instead') }
+      option_family(
+        format: HammerCLI::Options::Normalizers::List.new,
+        deprecation: _("Use %s instead") % '--lifecycle-environment[s|-ids]',
+        deprecated: { '--environments' => _("Use %s instead") % '--lifecycle-environments',
+                      '--environment-ids' => _("Use %s instead") % '--lifecycle-environment-ids'}
+      ) do
+        parent '--environment-ids', 'ENVIRONMENT_IDS', _(''),
+               attribute_name: :option_environment_ids
+        child '--environments', 'ENVIRONMENT_NAMES', _(''),
+              attribute_name: :option_environment_names
+      end
 
       option_sources do |sources, command|
         sources.find_by_name('IdResolution').insert_relative(

data/lib/hammer_cli_katello/content_credential.rb

@@ -4,8 +4,9 @@ module HammerCLIKatello
 
     class ListCommand < HammerCLIKatello::ListCommand
       output do
-        field :id, _("ID")
-        field :name, _("Name")
+        field :id, _('Id')
+        field :name, _('Name')
+        field :content_type, _('Content Type')
       end
 
       build_options
@@ -13,51 +14,51 @@ module HammerCLIKatello
 
     class InfoCommand < HammerCLIKatello::InfoCommand
       output do
-        field :id, _("ID")
-        field :name, _("Name")
+        field :id, _('Id')
+        field :name, _('Name')
         from :organization do
-          field :name, _("Organization")
+          field :name, _('Organization')
         end
 
-        collection :repositories, "Repositories" do
-          field :id, _("ID")
-          field :name, _("Name")
-          field :content_type, _("Content Type")
+        collection :repositories, 'Repositories' do
+          field :id, _('Id')
+          field :name, _('Name')
+          field :content_type, _('Content Type')
           from :product do
-            field :name, _("Product")
+            field :name, _('Product')
           end
         end
 
-        field :content, _("Content"), Fields::LongText
+        field :content, _('Content'), Fields::LongText
       end
 
       build_options
     end
 
     class CreateCommand < HammerCLIKatello::CreateCommand
-      success_message _("Content credential created.")
-      failure_message _("Could not create GPG key")
+      success_message _('Content Credential created.')
+      failure_message _('Could not create Content Credential')
 
       build_options :without => [:content]
-      option "--key", "GPG_KEY_FILE", _("GPG Key file"),
+      option '--path', 'KEY_FILE', _('Key file'),
              :attribute_name => :option_content,
              :required => true,
              :format => HammerCLI::Options::Normalizers::File.new
     end
 
     class UpdateCommand < HammerCLIKatello::UpdateCommand
-      success_message _("GPG Key updated.")
-      failure_message _("Could not update GPG Key")
+      success_message _('Content Credential updated.')
+      failure_message _('Could not update Content Credential')
 
       build_options :without => [:content]
-      option "--key", "GPG_KEY_FILE", _("GPG Key file"),
+      option '--path', 'KEY_FILE', _('Key file'),
              :attribute_name => :option_content,
              :format => HammerCLI::Options::Normalizers::File.new
     end
 
     class DeleteCommand < HammerCLIKatello::DeleteCommand
-      success_message _("GPG Key deleted.")
-      failure_message _("Could not delete the GPG Key")
+      success_message _('Content Credential deleted.')
+      failure_message _('Could not delete the Content Credential')
 
       build_options
     end

data/lib/hammer_cli_katello/content_export.rb

@@ -0,0 +1,73 @@
+require 'hammer_cli_katello/content_export_complete'
+require 'hammer_cli_katello/content_export_incremental'
+
+module HammerCLIKatello
+  class ContentExport < HammerCLIKatello::Command
+    desc "Prepare content for export to a disconnected Katello"
+    resource :content_exports
+
+    class GenerateMetadataCommand < HammerCLIKatello::Command
+      desc _("Writes export metadata to disk for use by the importing Katello. This command "\
+        + "only needs to be used if the export was performed asynchronously "\
+        + "or if the metadata was lost")
+
+      command_name 'generate-metadata'
+
+      include ContentExportHelper
+
+      option "--task-id", "TASK_ID",
+             _("Generate metadata based on output of the specified export task"),
+             :attribute_name => :option_task_id,
+             :required => false
+
+      option "--id", "ID",
+             _("Generate metadata based on specified export history"),
+             :attribute_name => :option_export_id,
+             :required => false
+
+      def execute
+        export_history = if option_task_id
+                           export_task = reload_task(option_task_id)
+                           fetch_export_history_from_task(export_task)
+                         else
+                           fetch_export_history(option_export_id)
+                         end
+
+        unless export_history
+          raise _("No export history was found. Verify the value given for "\
+            + "--task-id or --id")
+        end
+
+        generate_metadata_json(export_history)
+
+        HammerCLI::EX_OK
+      end
+    end
+
+    class ListCommand < HammerCLIKatello::ListCommand
+      desc "View content view export histories"
+      output do
+        field :id, _('ID')
+        field :destination_server, _('Destination Server')
+        field :path, _('Path')
+        field :type, _('Type')
+        field :content_view_version, _('Content View Version')
+        field :content_view_version_id, _('Content View Version ID')
+        field :created_at, _('Created at')
+        field :updated_at, _('Updated at'), Fields::Field, :hide_blank => true
+      end
+
+      build_options
+    end
+
+    autoload_subcommands
+
+    subcommand HammerCLIKatello::ContentExportComplete.command_name,
+               HammerCLIKatello::ContentExportComplete.desc,
+               HammerCLIKatello::ContentExportComplete
+
+    subcommand HammerCLIKatello::ContentExportIncremental.command_name,
+               HammerCLIKatello::ContentExportIncremental.desc,
+               HammerCLIKatello::ContentExportIncremental
+  end
+end

data/lib/hammer_cli_katello/content_export_complete.rb

@@ -0,0 +1,25 @@
+module HammerCLIKatello
+  class ContentExportComplete < HammerCLIKatello::Command
+    desc "Prepare content for a full export to a disconnected Katello"
+    resource :content_exports
+    command_name 'complete'
+
+    class VersionCommand < HammerCLIKatello::SingleResourceCommand
+      desc _('Performs a full export a content view version')
+      command_name "version"
+
+      include HammerCLIForemanTasks::Async
+      include ContentExportHelper
+    end
+
+    class LibraryCommand < HammerCLIKatello::SingleResourceCommand
+      desc _("Performs a full export of the organization's library environment")
+      command_name "library"
+
+      include HammerCLIForemanTasks::Async
+      include ContentExportHelper
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_katello/content_export_helper.rb

@@ -0,0 +1,181 @@
+require 'hammer_cli_katello/repository'
+# rubocop:disable ModuleLength
+module HammerCLIKatello
+  module ContentExportHelper
+    include ApipieHelper
+
+    def execute
+      warn_unexportable_repositories
+      response = super
+      if option_async?
+        output.print_message _("Once the task completes the export metadata must be generated "\
+          + "with the command:")
+        output.print_message(" hammer content-export generate-metadata --task-id #{@task['id']}")
+        HammerCLI::EX_OK
+      elsif response != HammerCLI::EX_OK
+        response
+      else
+        export_history = fetch_export_history_from_task(reload_task(@task))
+        if export_history
+          generate_metadata_json(export_history)
+          HammerCLI::EX_OK
+        else
+          output.print_error _("Could not fetch the export history")
+          HammerCLI::EX_CANTCREAT
+        end
+      end
+    end
+
+    def send_request
+      @task = super
+    end
+
+    def reload_task(task)
+      task_id = if task.is_a? Hash
+                  task['id']
+                else
+                  task
+                end
+      show(:foreman_tasks, id: task_id)
+    end
+
+    def fetch_export_history(export_history_id)
+      index(:content_exports, :id => export_history_id).first if export_history_id
+    end
+
+    def fetch_export_history_from_task(task)
+      # checking this here implies the task object was loaded recently
+      if %w(error warning).include?(task['result'])
+        raise _("Can not fetch export history from an unfinished task")
+      end
+
+      export_history_id = task.dig('output', 'export_history_id')
+      fetch_export_history(export_history_id)
+    end
+
+    def generate_metadata_json(export_history)
+      metadata_json = export_history["metadata"].to_json
+      begin
+        metadata_path = "#{export_history['path']}/metadata.json"
+        File.write(metadata_path, metadata_json)
+        output.print_message _("Generated #{metadata_path}")
+      rescue SystemCallError
+        filename = "metadata-#{export_history['id']}.json"
+        File.write(filename, metadata_json)
+        output.print_message _("Unable to access/write to '#{export_history['path']}'. "\
+                               "Generated '#{Dir.pwd}/#{filename}' instead. "\
+                               "This file is necessary to perform an import.")
+      end
+    end
+
+    def version_command?
+      self.class.command_name.first.to_sym == :version
+    end
+
+    def fetch_repositories
+      repo_options = {
+        library: true,
+        content_type: 'yum',
+        search: 'download_policy != immediate'
+      }
+      if version_command?
+        repo_options[:content_view_version_id] = resolver.content_view_version_id(options)
+      else
+        repo_options[:organization_id] = options["option_organization_id"]
+      end
+      index(:repositories, repo_options)
+    end
+
+    def warn_unexportable_repositories
+      repos = fetch_repositories
+      unless repos.empty?
+        if version_command?
+          output.print_message _("NOTE: Unable to fully export this version because"\
+            " it contains repositories without the 'immediate' download policy."\
+            " Update the download policy and sync affected repositories."\
+            " Once synced republish the content view"\
+            " and export the generated version.")
+        else
+          output.print_message _("NOTE: Unable to fully export this organization's library because"\
+            " it contains repositories without the 'immediate' download policy."\
+            " Update the download policy and sync affected"\
+            " repositories to include them in the export.")
+        end
+        output.print_message _("Use the following command to update the "\
+          "download policy of these repositories.")
+        output.print_message "hammer repository update --id=<REPOSITORY_ID> "\
+          "--download-policy='immediate'"
+        output.print_message ""
+        print_record(::HammerCLIKatello::Repository::ListCommand.output_definition, repos)
+        exit(HammerCLI::EX_SOFTWARE) if option_fail_on_missing_content?
+      end
+    end
+
+    def self.included(base)
+      if base.command_name.first.to_sym == :version
+        setup_version(base)
+      elsif base.command_name.first.to_sym == :library
+        setup_library(base)
+      end
+    end
+
+    def self.setup_library(base)
+      base.action(:library)
+      base.success_message _("Library environment is being exported in task %{id}.")
+      base.failure_message _("Could not export the library")
+      base.option "--fail-on-missing-content", :flag,
+                    _("Fails if any of the repositories belonging"\
+                      " to this organization are unexportable.")
+
+      base.build_options do |o|
+        o.expand(:all).including(:organizations)
+      end
+    end
+
+    def self.setup_version(base)
+      base.action(:version)
+      setup_version_options(base)
+      base.success_message _("Content view version is being exported in task %{id}.")
+      base.failure_message _("Could not export the content view version")
+
+      base.extend_with(
+        HammerCLIKatello::CommandExtensions::LifecycleEnvironments.new(only: :option_sources)
+      )
+      base.include(LifecycleEnvironmentNameMapping)
+
+      base.class_eval do
+        def request_params
+          super.tap do |opts|
+            opts["id"] = resolver.content_view_version_id(options)
+          end
+        end
+      end
+    end
+
+    def self.setup_version_options(base)
+      base.option "--fail-on-missing-content", :flag,
+                    _("Fails if any of the repositories belonging"\
+                      " to this version are unexportable.")
+
+      base.option "--version", "VERSION", _("Filter versions by version number."),
+                 :attribute_name => :option_version,
+                 :required => false
+
+      base.build_options do |o|
+        o.expand(:all).including(:content_views, :organizations, :environments)
+        o.without(:environment_ids, :environment_id)
+      end
+
+      base.validate_options do
+        unless option(:option_id).exist?
+          any(:option_id, :option_content_view_name, :option_content_view_id).required
+          any(:option_version, :option_environment_id, :option_environment_name).required
+          unless option(:option_content_view_id).exist?
+            any(:option_organization_id, :option_organization_name, \
+                                :option_organization_label).required
+          end
+        end
+      end
+    end
+  end
+end