hammer_cli_katello 0.24.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef1231a1d905ff53eb70cc86e37c9fe6312ff5aca6183165e172cf03e88ac44
-  data.tar.gz: b377c06ddefb1ca00b8ed84d02f90b66dc51fb27ef4817b87d2c8a7d0cdc62af
+  metadata.gz: 3a90c77802499a72d618883d73162f061b8465d838be44c8df27e3d79d2fc316
+  data.tar.gz: d4cd08a9eb8fae1437bad8d9adaba03fb5a71cd2c770b5af6500312fb497283c
 SHA512:
-  metadata.gz: 3c85164176d1e27213fde99d8a7ca7135fe85dc0b3ee0bf7fdf552e1644b0a42c249d415eb546a40286e5b7895c12b56bae227fca7043329bd20ca584c67fc41
-  data.tar.gz: 675dfa2798671df7b13caf791f107626ada1289f36f1ca4c0fa9986cf9602cd90275293125a61cf3bf738961a4ba2ca31d91ed76a7f3e2d99db106c753384e01
+  metadata.gz: 3aa81078857f074f4c15104e67a31ca9b85ba05d95510b2805114df31955972acd4795078ae3128849568d2f1c3e1e19d274307ac97d7cc8391edc1f05cd44b9
+  data.tar.gz: ce940d980543120e2cf86a0374fb61e11c20ce37ee06c2ff381b98da2c5731c6adcb4cac0b59bd80d945233b2589d13889859097a910e838117403ee002137c5

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"),
@@ -141,6 +142,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'

data/lib/hammer_cli_katello/content_export.rb

@@ -0,0 +1,72 @@
+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 :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,172 @@
+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)
+      resource.call(:index, :id => export_history_id)["results"].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)
+      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)
+      end
+
+      base.validate_options do
+        unless option(:option_id).exist?
+          any(:option_id, :option_content_view_name, :option_content_view_id).required
+          option(:option_version).required
+          unless option(:option_content_view_id).exist?
+            any(:option_organization_id, :option_organization_name, \
+                                :option_organization_label).required
+          end
+        end
+      end
+
+      base.success_message _("Content view version is being exported in task %{id}.")
+      base.failure_message _("Could not export the content view version")
+
+      base.class_eval do
+        def request_params
+          super.tap do |opts|
+            opts["id"] = resolver.content_view_version_id(options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli_katello/content_export_incremental.rb

@@ -0,0 +1,25 @@
+module HammerCLIKatello
+  class ContentExportIncremental < HammerCLIKatello::Command
+    desc "Prepare content for an incremental export to a disconnected Katello"
+    resource :content_export_incrementals
+    command_name 'incremental'
+
+    class VersionCommand < HammerCLIKatello::SingleResourceCommand
+      desc _('Performs an incremental export of a content view version')
+      command_name "version"
+
+      include HammerCLIForemanTasks::Async
+      include ContentExportHelper
+    end
+
+    class LibraryCommand < HammerCLIKatello::SingleResourceCommand
+      desc _("Performs an incremental 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_import.rb

@@ -0,0 +1,63 @@
+module HammerCLIKatello
+  class ContentImport < HammerCLIKatello::Command
+    desc "Import content from a content archive"
+    resource :content_imports
+
+    module ContentImportCommon
+      def self.included(base)
+        base.option "--metadata-file",
+                "METADATA_FILE", _("Location of the metadata.json file. "\
+                                   "This is not required if the metadata.json file"\
+                                   " is already in the archive directory."),
+                 :attribute_name => :option_metadata_file,
+                 :required => false
+
+        base.build_options do |o|
+          o.expand(:all).including(:content_views, :organizations).except(:metadata)
+        end
+
+        base.validate_options do
+          option(:option_path).required
+
+          metadata_file = option(:option_metadata_file).value ||
+                          File.join(option(:option_path).value, "metadata.json")
+          unless File.exist?(metadata_file)
+            msg = _("Unable to find '#{metadata_file}'. "\
+                     "If the metadata.json file is at a different location "\
+                     "provide it to the --metadata-file option ")
+            raise HammerCLI::Options::Validators::ValidationError, msg
+          end
+        end
+        base.success_message _("Archive is being imported in task %{id}.")
+        base.failure_message _("Could not import the archive.")
+      end
+
+      def request_params
+        super.tap do |opts|
+          metadata_file = option_metadata_file || File.join(option_path, "metadata.json")
+          opts["metadata"] = JSON.parse(File.read(metadata_file))
+        end
+      end
+    end
+
+    class VersionCommand < HammerCLIKatello::SingleResourceCommand
+      desc _('Imports a content archive to a content view version')
+      action :version
+      command_name "version"
+
+      include HammerCLIForemanTasks::Async
+      include ContentImportCommon
+    end
+
+    class LibraryCommand < HammerCLIKatello::SingleResourceCommand
+      desc _("Imports a content archive to an organization's library lifecycle environment")
+      action :library
+      command_name "library"
+
+      include HammerCLIForemanTasks::Async
+      include ContentImportCommon
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_katello/content_view.rb

@@ -106,10 +106,12 @@ module HammerCLIKatello
       failure_message _("Could not create the content view")
 
       option ["--composite"], :flag, _("Create a composite content view")
-
+      option ["--import-only"], :flag, _("Designate this Content View for "\
+                                         "importing from upstream servers only.")
       def request_params
         super.tap do |opts|
           opts['composite'] = option_composite? || false
+          opts['import_only'] = option_import_only? || false
         end
       end
 

data/lib/hammer_cli_katello/content_view_version.rb

@@ -278,24 +278,6 @@ module HammerCLIKatello
       end
     end
 
-    class ExportHistoriesCommand < HammerCLIKatello::ListCommand
-      desc "View content view export histories"
-      command_name "export-histories"
-      action :export_histories
-
-      output do
-        field :id, _('ID')
-        field :destination_server, _('Destination Server')
-        field :path, _('Path')
-        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
-
     class ExportDefaultCommand < HammerCLIForeman::Command
       include HammerCLIKatello::LocalHelper
       include HammerCLIKatello::ApipieHelper

data/lib/hammer_cli_katello/version.rb

@@ -1,5 +1,5 @@
 module HammerCLIKatello
   def self.version
-    @version ||= Gem::Version.new('0.24.0')
+    @version ||= Gem::Version.new('0.24.1')
   end
 end