hammer_cli_katello 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 020a802118e1d02ce02183915e5d3c27d17fc9a5
-  data.tar.gz: 1c481ed3adf302f0dd8162f133c4e14d87b1ccd7
+  metadata.gz: 81a158e8e77bef73123e89992746c3b24f9689ef
+  data.tar.gz: 417e144685491e014455d2c1eacb1d8caaba7d40
 SHA512:
-  metadata.gz: 4af3a91c622735ba6df894b0bdcd1feeda752f063fdf0bc2b8902ba3de47908cf263f3918e52201f5da4378f677de02ee6608605f5e7b5b4dbcc80544023d1ed
-  data.tar.gz: 818cac4835323c945ef06b618d9b510a427c2954df30cdd2250d5bf9e7857a827d7944ad819b53d7cee45d8359869ccb602e3c4d78e3860f6682540b5626450b
+  metadata.gz: 3c53985e39d45ba73ac11d19e1cf4ea3c40f60204ac98d9f86f01cb8d69c556df92889fd89965b35b93500a7d4a93b5123b48790ea3575a8f57866765b79d7ad
+  data.tar.gz: 64a6b70c343bafd39bb7bce8db5bd1b029a9bdb13769befb5ddd0441c33b3fdd443779a3859f8b9c1b1dc0e5f0c4db28b7c1a351f5a82103cd936a1e4a878c06

data/lib/hammer_cli_katello/apipie_helper.rb

@@ -0,0 +1,15 @@
+module HammerCLIKatello
+  module ApipieHelper
+    def show(resource, options = {})
+      call(:show, resource, options)
+    end
+
+    def index(resource, options = {})
+      call(:index, resource, options)['results']
+    end
+
+    def call(action, resource, options = {})
+      HammerCLIForeman.foreman_resource(resource).call(action, options)
+    end
+  end
+end

data/lib/hammer_cli_katello/associating_commands.rb

@@ -23,8 +23,10 @@ module HammerCLIKatello
 
       class AddRepositoryCommand < HammerCLIKatello::AddAssociatedCommand
         extend AddProductOptions
-        include RepositoryScopedToProduct
+        extend RepositoryScopedToProduct
         include OrganizationOptions
+
+        validate_repo_name_requires_product_options
         command_name 'add-repository'
         associated_resource :repositories
 
@@ -39,8 +41,10 @@ module HammerCLIKatello
 
       class RemoveRepositoryCommand < HammerCLIKatello::RemoveAssociatedCommand
         extend AddProductOptions
-        include RepositoryScopedToProduct
+        extend RepositoryScopedToProduct
         include OrganizationOptions
+
+        validate_repo_name_requires_product_options
         command_name 'remove-repository'
         associated_resource :repositories
 

data/lib/hammer_cli_katello/commands.rb

@@ -43,6 +43,13 @@ module HammerCLIKatello
 
   class ListCommand < HammerCLIForeman::ListCommand
     include HammerCLIKatello::ResolverCommons
+
+    def self.build_options(builder_params = {}, &block)
+      # remove --sort-by and --sort-order in favor of the Foreman's --order
+      builder_params[:without] ||= []
+      builder_params[:without] += %i(sort_by sort_order)
+      super(builder_params, &block)
+    end
   end
 
   class InfoCommand < HammerCLIForeman::InfoCommand

data/lib/hammer_cli_katello/content_view_purge.rb

@@ -53,7 +53,7 @@ module HammerCLIKatello
     end
 
     def execute
-      if option_count < 0
+      if option_count.negative?
         output.print_error _("Invalid value for --count option: value must be 0 or greater.")
         return HammerCLI::EX_USAGE
       end

data/lib/hammer_cli_katello/content_view_version.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module HammerCLIKatello
   class ContentViewVersion < HammerCLIKatello::Command
     resource :content_view_versions
@@ -245,11 +247,12 @@ module HammerCLIKatello
       end
     end
 
-    class ExportCommand < HammerCLIKatello::SingleResourceCommand
+    class LegacyExportCommand < HammerCLIKatello::SingleResourceCommand
       include HammerCLIForemanTasks::Async
+      desc _('Export a content view (deprecated)')
 
       action :export
-      command_name "export"
+      command_name "export-legacy"
 
       success_message _("Content view is being exported in task %{id}.")
       failure_message _("Could not export the content view")
@@ -259,6 +262,239 @@ module HammerCLIKatello
       end
     end
 
+    class ExportCommand < HammerCLIForeman::Command
+      include HammerCLIKatello::LocalHelper
+      include HammerCLIKatello::ApipieHelper
+
+      PUBLISHED_REPOS_DIR = "/var/lib/pulp/published/yum/https/repos/".freeze
+
+      desc _('Export a content view version')
+
+      command_name "export"
+
+      success_message _("Content view export is available in %{directory}.")
+      failure_message _("Could not export the content view")
+
+      option "--id", "ID", _("Content View Version numeric identifier")
+      option '--export-dir', 'EXPORT_DIR', _("Directory to put content view version export into.")
+
+      validate_options do
+        option(:option_export_dir).required
+        option(:option_id).required
+      end
+
+      build_options
+
+      def execute
+        cvv = show(:content_view_versions, 'id' => options['option_id'])
+        repositories = cvv['repositories'].collect do |repo|
+          show(:repositories, 'id' => repo['id'], :full_result => true)
+        end
+
+        check_repo_download_policy(repositories)
+
+        repositories.each do |repo|
+          repo['packages'] = index(:packages, 'repository_id' => repo['id'], :full_result => true)
+          repo['errata'] = index(:errata, 'repository_id' => repo['id'], :full_result => true)
+        end
+
+        json = export_json(cvv, repositories)
+        create_tar(cvv, repositories, json)
+        return HammerCLI::EX_OK
+      end
+
+      def create_tar(cvv, repositories, json)
+        export_prefix = "export-#{cvv['id']}"
+        export_file = "#{export_prefix}.json"
+        export_repos_tar = "#{export_prefix}-repos.tar"
+        export_tar = "#{export_prefix}.tar"
+
+        Dir.mkdir("#{options['option_export_dir']}/#{export_prefix}")
+
+        Dir.chdir(PUBLISHED_REPOS_DIR) do
+          repo_tar = "#{options['option_export_dir']}/#{export_prefix}/#{export_repos_tar}"
+          repo_dirs = []
+
+          repositories.each do |repo|
+            repo_dirs.push(repo['relative_path'])
+          end
+
+          `tar cvfh #{repo_tar} #{repo_dirs.join(" ")}`
+        end
+
+        Dir.chdir("#{options['option_export_dir']}/#{export_prefix}") do
+          File.open(export_file, 'w') do |file|
+            file.write(JSON.pretty_generate(json))
+          end
+        end
+
+        Dir.chdir(options['option_export_dir']) do
+          `tar cf #{export_tar} #{export_prefix}`
+          FileUtils.rm_rf(export_prefix)
+        end
+      end
+
+      def check_repo_download_policy(repositories)
+        on_demand = repositories.select do |repo|
+          show(:repositories, 'id' => repo['library_instance_id'])['download_policy'] == 'on_demand'
+        end
+        return true if on_demand.empty?
+
+        on_demand_names = repositories.collect { |repo| repo['name'] }
+        msg = <<~MSG
+          All exported repositories must be set to an immediate download policy and re-synced.
+          The following repositories need action:
+            #{on_demand_names.join('\n')}
+        MSG
+        raise _(msg)
+      end
+
+      def export_json(content_view_version, repositories)
+        json = {
+          "name" => content_view_version['content_view']['name'],
+          "major" => content_view_version['major'],
+          "minor" => content_view_version['minor']
+        }
+
+        json["repositories"] = repositories.collect do |repo|
+          {
+            "id" => repo['id'],
+            "label" => repo['label'],
+            "content_type" => repo['content_type'],
+            "backend_identifier" => repo['backend_identifier'],
+            "relative_path" => repo['relative_path'],
+            "on_disk_path" => "#{PUBLISHED_REPOS_DIR}/#{repo['relative_path']}",
+            "rpm_filenames" => repo['packages'].collect { |package| package['filename'] },
+            "errata_ids" => repo['errata'].collect { |errata| errata['errata_id'] }
+          }
+        end
+
+        json
+      end
+    end
+
+    class ImportCommand < HammerCLIForeman::Command
+      include HammerCLIForemanTasks::Async
+      include HammerCLIKatello::LocalHelper
+      include HammerCLIKatello::ApipieHelper
+
+      attr_accessor :export_tar_dir, :export_tar_file, :export_tar_prefix
+
+      desc _('Import a content view version')
+
+      command_name "import"
+
+      success_message _("Content view imported.")
+      failure_message _("Could not import the content view.")
+
+      option "--organization-id", "ORGANIZATION_ID", _("Organization numeric identifier")
+      option(
+        '--export-tar',
+        'EXPORT_TAR',
+        _("Location of export tar on disk")
+      )
+
+      validate_options do
+        option(:option_export_tar).required
+        option(:option_organization_id).required
+      end
+
+      build_options
+
+      def execute
+        unless File.exist?(options['option_export_tar'])
+          raise _("Export tar #{options['option_export_tar']} does not exist.")
+        end
+
+        self.export_tar_file = File.basename(options['option_export_tar'])
+        self.export_tar_prefix = @export_tar_file.gsub('.tar', '')
+        self.export_tar_dir = File.dirname(options['option_export_tar'])
+        untar_export
+
+        export_json = read_json
+
+        cv = content_view(export_json['name'], options['option_organization_id'])
+        sync_repositories(export_json['repositories'], options['option_organization_id'])
+
+        publish(
+          cv['id'],
+          export_json['major'],
+          export_json['minor'],
+          repos_units(export_json['repositories'])
+        )
+        return HammerCLI::EX_OK
+      end
+
+      def untar_export
+        Dir.chdir(@export_tar_dir) do
+          `tar -xf #{@export_tar_file}`
+        end
+
+        Dir.chdir("#{@export_tar_dir}/#{@export_tar_prefix}") do
+          if File.exist?(@export_tar_file.gsub('.tar', '-repos.tar'))
+            `tar -xf #{@export_tar_file.gsub('.tar', '-repos.tar')}`
+          else
+            raise _("Export repos tar file is missing.")
+          end
+        end
+      end
+
+      def read_json
+        json_file = @export_tar_file.gsub('tar', 'json')
+        json_file = "#{@export_tar_dir}/#{@export_tar_prefix}/#{json_file}"
+        json_file = File.read(json_file)
+        JSON.parse(json_file)
+      end
+
+      def sync_repositories(repositories, organization_id)
+        repositories.each do |repo|
+          library_repos = index(
+            :repositories,
+            'organization_id' => organization_id,
+            'library' => true
+          )
+
+          library_repo = library_repos.select do |candidate_repo|
+            candidate_repo['label'] == repo['label']
+          end
+
+          library_repo = library_repo.first
+
+          if library_repo.nil?
+            msg = _("Unable to sync repositories, no library repository found for %s")
+            raise msg % repo['label']
+          end
+
+          synchronize(
+            library_repo['id'],
+            "file://#{@export_tar_dir}/#{@export_tar_prefix}/#{repo['relative_path']}"
+          )
+        end
+      end
+
+      def repos_units(repositories)
+        repositories.collect do |repo|
+          {
+            'label' => repo['label'],
+            'rpm_filenames' => repo['rpm_filenames']
+          }
+        end
+      end
+
+      def content_view(name, organization_id)
+        index(:content_views, 'name' => name, 'organization_id' => organization_id).first
+      end
+
+      def synchronize(id, source_url)
+        task_progress(call(:sync, :repositories, 'id' => id, 'source_url' => source_url))
+      end
+
+      def publish(id, major, minor, repos_units)
+        params = {'id' => id, 'major' => major, 'minor' => minor, 'repos_units' => repos_units}
+        task_progress(call(:publish, :content_views, params))
+      end
+    end
+
     autoload_subcommands
   end
 end

data/lib/hammer_cli_katello/erratum.rb

@@ -3,6 +3,10 @@ module HammerCLIKatello
     resource :errata
 
     class ListCommand < HammerCLIKatello::ListCommand
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options(:option_repository_name)
+
       output do
         field :id, _("ID")
         field :errata_id, _("Errata ID")

data/lib/hammer_cli_katello/file.rb

@@ -3,6 +3,10 @@ module HammerCLIKatello
     resource :file_units
 
     class ListCommand < HammerCLIKatello::ListCommand
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options(:option_repository_name)
+
       output do
         field :id, _("ID")
         field :name, _("Name")
@@ -12,15 +16,9 @@ module HammerCLIKatello
       validate_options do
         organization_options = [:option_organization_id, :option_organization_name,
                                 :option_organization_label]
-        product_options = [:option_product_id, :option_product_name]
-
         if any(:option_product_name, :option_content_view_name).exist?
           any(*organization_options).required
         end
-
-        if option(:option_repository_name).exist?
-          any(*product_options).required
-        end
       end
 
       build_options do |o|

data/lib/hammer_cli_katello/foreman_search_options_creators.rb

@@ -76,7 +76,7 @@ module HammerCLIKatello
       create_search_options_without_katello_api(options, api.resource(:compute_resources), mode)
     end
 
-    def create_image_search_options(options, mode = nil)
+    def create_images_search_options(options, mode = nil)
       create_search_options_without_katello_api(options, api.resource(:images), mode)
     end
   end

data/lib/hammer_cli_katello/id_resolver.rb

@@ -10,6 +10,8 @@ module HammerCLIKatello
       :file_unit =>             [s_name(_("File name to search by")),
                                  s("content_view_version_id", _("Content View Version ID")),
                                  s("repository_id", _("Repository ID"))],
+      :module_stream =>         [s_name(_("Module stream name to search by")),
+                                 s("repository_id", _("Repository ID"))],
       :gpg =>                   [s_name(_("Gpg key name to search by"))],
       :host_collection =>       [s_name(_("Host collection name to search by"))],
       :lifecycle_environment => [s_name(_("Lifecycle environment name to search by"))],

data/lib/hammer_cli_katello/local_helper.rb

@@ -0,0 +1,9 @@
+module HammerCLIKatello
+  module LocalHelper
+    def parse_subcommand
+      return super if File.exist?('/usr/share/foreman')
+      raise "This command can only be run on the same server that Foreman is running on " \
+        "and cannot be run remotely."
+    end
+  end
+end

data/lib/hammer_cli_katello/module_stream.rb

@@ -0,0 +1,69 @@
+module HammerCLIKatello
+  class ModuleStreamCommand < HammerCLIKatello::Command
+    resource :module_streams
+
+    class ListCommand < HammerCLIKatello::ListCommand
+      extend RepositoryScopedToProduct
+
+      desc "List module streams"
+
+      validate_repo_name_requires_product_options(:option_repository_name)
+
+      output do
+        field :id, _("ID")
+        field :name, _("Module Stream Name")
+        field :stream, _("Stream")
+        field :uuid, _("UUID")
+        field :version, _("Version")
+        field :arch, _("Architecture")
+        field :context, _("Context")
+      end
+
+      build_options do |o|
+        o.expand.including(:products)
+      end
+    end
+
+    class InfoCommand < HammerCLIKatello::InfoCommand
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options(:option_repository_name)
+
+      output do
+        field :id, _("ID")
+        field :name, _("Module Stream Name")
+        field :stream, _("Stream")
+        field :uuid, _("UUID")
+        field :version, _("Version")
+        field :arch, _("Architecture")
+        field :context, _("Context")
+
+        collection :repositories, _("Repositories") do
+          field :id, _("ID")
+          field :name, _("Name")
+          field :label, _("Label")
+        end
+
+        collection :artifacts, _("Artifacts") do
+          field :id, _("ID")
+          field :name, _("Name")
+        end
+
+        collection :profiles, _("Profiles") do
+          field :id, _("ID")
+          field :name, _("Name")
+          collection :rpms, _("RPMs") do
+            field :id, _("ID")
+            field :name, _("Name")
+          end
+        end
+      end
+
+      build_options do |o|
+        o.expand.including(:products, :organizations)
+      end
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_katello/ostree_branch.rb

@@ -3,6 +3,10 @@ module HammerCLIKatello
     resource :ostree_branches
 
     class ListCommand < HammerCLIKatello::ListCommand
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options(:option_repository_name)
+
       output do
         field :id, _("ID")
         field :name, _("Name")

data/lib/hammer_cli_katello/package_group.rb

@@ -3,6 +3,10 @@ module HammerCLIKatello
     resource :package_groups
 
     class ListCommand < HammerCLIKatello::ListCommand
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options(:option_repository_name)
+
       output do
         field :id, _("ID")
         field :name, _("Package Group Name")

data/lib/hammer_cli_katello/puppet_module.rb

@@ -3,6 +3,10 @@ module HammerCLIKatello
     resource :puppet_modules
 
     class ListCommand < HammerCLIKatello::ListCommand
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options(:option_repository_name)
+
       output do
         field :id, _("ID")
         field :name, _("Name")

data/lib/hammer_cli_katello/repository.rb

@@ -18,7 +18,9 @@ module HammerCLIKatello
 
     # rubocop:disable ClassLength
     class InfoCommand < HammerCLIKatello::InfoCommand
-      include RepositoryScopedToProduct
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options
 
       output do
         field :id, _("ID")
@@ -42,6 +44,8 @@ module HammerCLIKatello
               Fields::Field, :hide_blank => true
         field :docker_upstream_name, _("Upstream Repository Name"),
               Fields::Field, :hide_blank => true
+        field :docker_tags_whitelist, _("Container Image Tags Filter"),
+              Fields::List, :hide_blank => true
         field :container_repository_name, _("Container Repository Name"),
               Fields::Field, :hide_blank => true
         field :ignorable_content, _("Ignorable Content Units"), Fields::List, :hide_blank => true
@@ -81,6 +85,7 @@ module HammerCLIKatello
           field :docker_tag_total, _("Container Image Tags"), Fields::Field, :hide_blank => true
           field :ostree_branch_total, _("OSTree Branches"), Fields::Field, :hide_blank => true
           field :file_total, _("Files"), Fields::Field, :hide_blank => true
+          field :module_stream_total, _("Module Streams"), Fields::Field, :hide_blank => true
         end
       end
 
@@ -118,6 +123,7 @@ module HammerCLIKatello
           data["srpm_total"] = content_counts["srpm"]
           data["package_group_total"] = content_counts["package_group"]
           data["errata_total"] = content_counts["erratum"]
+          data["module_stream_total"] = content_counts["module_stream"]
         when "docker"
           data["docker_manifest_list_total"] = content_counts["docker_manifest_list"]
           data["docker_manifest_total"] = content_counts["docker_manifest"]
@@ -156,7 +162,9 @@ module HammerCLIKatello
 
     class SyncCommand < HammerCLIKatello::SingleResourceCommand
       include HammerCLIForemanTasks::Async
-      include RepositoryScopedToProduct
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options
 
       action :sync
       command_name "synchronize"
@@ -181,7 +189,9 @@ module HammerCLIKatello
     end
 
     class UpdateCommand < HammerCLIKatello::UpdateCommand
-      include RepositoryScopedToProduct
+      extend RepositoryScopedToProduct
+
+      validate_repo_name_requires_product_options
       include OrganizationOptions
 
       success_message _("Repository updated.")
@@ -265,9 +275,10 @@ module HammerCLIKatello
     end
 
     class DeleteCommand < HammerCLIKatello::DeleteCommand
-      include RepositoryScopedToProduct
+      extend RepositoryScopedToProduct
       include OrganizationOptions
 
+      validate_repo_name_requires_product_options
       success_message _("Repository deleted.")
       failure_message _("Could not delete the Repository")
 
@@ -278,9 +289,10 @@ module HammerCLIKatello
 
     # rubocop:disable ClassLength
     class UploadContentCommand < HammerCLIKatello::InfoCommand
-      include RepositoryScopedToProduct
+      extend RepositoryScopedToProduct
       include HammerCLIForemanTasks::Helper
 
+      validate_repo_name_requires_product_options
       resource :repositories, :upload_content
       command_name "upload-content"
       CONTENT_CHUNK_SIZE = 2_500_000 # bytes to make sure it's lower than django's default 2621440
@@ -461,9 +473,10 @@ module HammerCLIKatello
     # rubocop:enable ClassLength
 
     class RemoveContentCommand < HammerCLIKatello::SingleResourceCommand
-      include RepositoryScopedToProduct
+      extend RepositoryScopedToProduct
       include OrganizationOptions
 
+      validate_repo_name_requires_product_options
       action :remove_content
       command_name "remove-content"
       desc _("Remove content from a repository")
@@ -487,9 +500,10 @@ module HammerCLIKatello
 
     class ExportCommand < HammerCLIKatello::SingleResourceCommand
       include HammerCLIForemanTasks::Async
-      include RepositoryScopedToProduct
       include OrganizationOptions
+      extend RepositoryScopedToProduct
 
+      validate_repo_name_requires_product_options
       action :export
       command_name "export"
       desc _("Export content from a repository to the configured directory")

data/lib/hammer_cli_katello/repository_scoped_to_product.rb

@@ -1,8 +1,8 @@
 module HammerCLIKatello
   module RepositoryScopedToProduct
-    def self.included(base)
-      base.validate_options do
-        any(:option_product_name, :option_product_id).required if option(:option_name).exist?
+    def validate_repo_name_requires_product_options(name_option = :option_name)
+      validate_options do
+        any(:option_product_name, :option_product_id).required if option(name_option).exist?
       end
     end
   end

data/lib/hammer_cli_katello/search_options_creators.rb

@@ -4,6 +4,11 @@ module HammerCLIKatello
   module SearchOptionsCreators
     include HammerCLIKatello::ForemanSearchOptionsCreators
 
+    def create_module_streams_search_options(options, mode = nil)
+      create_search_options_without_katello_api(options, api.resource(:module_streams), mode)
+        .merge(create_search_options(options, api.resource(:module_streams), mode))
+    end
+
     def create_file_units_search_options(options, mode = nil)
       create_search_options_without_katello_api(options, api.resource(:file_units), mode)
         .merge(create_search_options(options, api.resource(:file_units), mode))
@@ -87,12 +92,15 @@ module HammerCLIKatello
       search_options
     end
 
-    def create_search_options_with_katello_api(options, resource, _mode = nil)
+    def create_search_options_with_katello_api(options, resource, mode = nil)
       search_options = {}
       searchables(resource).each do |s|
         value = options[HammerCLI.option_accessor_name(s.name.to_s)]
-        if value
+        values = options[HammerCLI.option_accessor_name(s.plural_name.to_s)]
+        if value && [:single, nil].include?(mode)
           search_options.update(s.name.to_s => value.to_s)
+        elsif values && [:multi, nil].include?(mode)
+          values.each { |v| search_options.update(s.name.to_s => v.to_s) }
         end
       end
       search_options