Fixes #34684 - install pulp-cli

manifests/cli.pp

@@ -0,0 +1,63 @@
+# = Pulpcore command line interface
+#
+# This class installs the Pulpcore command line interface (CLI).
+#
+# === Parameters:
+#
+# $pulpcore_url::       URL on which Pulpcore runs
+#
+# $username::           Username for authentication
+#
+# $password::           Password for authentication
+#
+# $cert::               Client certificate for authentication
+#
+# $key::                Client key for authentication
+#
+# === Advanced parameters:
+#
+# $api_root::           Absolute API base path on server (not including 'api/v3/')
+#
+# $verify_ssl::         Verify SSL connection
+#
+# $dry_run::            Trace commands without performing any unsafe HTTP calls
+#
+# $version::            pulp-cli package version, it's passed to ensure parameter of package resource
+#                       can be set to specific version number, 'latest', 'present' etc.
+#
+class pulpcore::cli (
+  Optional[Stdlib::HTTPUrl] $pulpcore_url = $pulpcore::cli::params::pulpcore_url,
+  String $version = $pulpcore::cli::params::version,
+  Optional[String] $username = $pulpcore::cli::params::username,
+  Optional[String] $password = $pulpcore::cli::params::password,
+  Optional[String] $cert = $pulpcore::cli::params::cert,
+  Optional[String] $key = $pulpcore::cli::params::key,
+  Optional[String] $api_root = $pulpcore::cli::params::api_root,
+  Boolean $verify_ssl = $pulpcore::cli::params::verify_ssl,
+  Boolean $dry_run = $pulpcore::cli::params::dry_run,
+) inherits pulpcore::cli::params {
+  package { 'pulp-cli':
+    ensure => $version,
+  }
+  -> file { '/etc/pulp/cli.toml':
+    ensure  => file,
+    owner   => 'root',
+    group   => 'root',
+    mode    => '0644',
+    content => epp(
+      'pulpcore/cli-config.toml.epp',
+      {
+        base_url   => $pulpcore_url,
+        username   => $username,
+        password   => $password,
+        cert       => $cert,
+        key        => $key,
+        api_root   => $api_root,
+        verify_ssl => $verify_ssl,
+        dry_run    => $dry_run,
+      }
+    ),
+  }
+
+  Anchor <| title == 'pulpcore::repo' |> ~> Package <| tag == 'pulpcore::cli' |>
+}

manifests/cli/params.pp

@@ -0,0 +1,12 @@
+# Parameters for Pulpcore CLI class
+class pulpcore::cli::params {
+  $pulpcore_url = undef
+  $version = 'installed'
+  $username = undef
+  $password = undef
+  $cert = undef
+  $key = undef
+  $api_root = undef
+  $verify_ssl = true
+  $dry_run = true
+}

spec/acceptance/cli_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper_acceptance'
+
+describe 'installation of cli only' do
+  it_behaves_like 'an idempotent resource' do
+    let(:manifest) do
+      <<-PUPPET
+      include pulpcore::cli
+      PUPPET
+    end
+  end
+
+  describe command("pulp config validate --location /etc/pulp/cli.toml") do
+    its(:exit_status) { is_expected.to eq 0 }
+    its(:stdout) { is_expected.to match(/valid pulp-cli config/) }
+  end
+end
+
+describe 'installation of server with cli' do
+  it_behaves_like 'an idempotent resource' do
+    let(:manifest) do
+      <<-PUPPET
+      include pulpcore
+      class { 'pulpcore::cli':
+        pulpcore_url => "https://#{host_inventory['fqdn']}/",
+        cert         => "/etc/pulpcore-certs/client-cert.pem",
+        key          => "/etc/pulpcore-certs/client-key.pem",
+      }
+      PUPPET
+    end
+  end
+
+  include_examples 'the default pulpcore application'
+
+  describe command("pulp config validate --location /etc/pulp/cli.toml") do
+    its(:exit_status) { is_expected.to eq 0 }
+    its(:stdout) { is_expected.to match(/valid pulp-cli config/) }
+  end
+
+  describe command("REQUESTS_CA_BUNDLE=/etc/pulpcore-certs/ca-cert.pem pulp status") do
+    its(:exit_status) { is_expected.to eq 0 }
+    its(:stdout) { is_expected.to match(/versions/) }
+    # currently this contains a warning:
+    # SubjectAltNameWarning: Certificate for centos8-64.example.com has no `subjectAltName`, falling back to check for a `commonName` for now. This feature is being removed by major browsers and deprecated by RFC 2818.
+    # its(:stderr) { is_expected.to eq '' }
+  end
+end

spec/classes/cli_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'pulpcore::cli' do
+  on_supported_os.each do |os, os_facts|
+    context "on #{os}" do
+      let(:facts) { os_facts }
+      let(:pre_condition) { 'include pulpcore::cli' }
+
+      it { is_expected.to compile.with_all_deps }
+      it { is_expected.to contain_package('pulp-cli') }
+    end
+  end
+end

templates/cli-config.toml.epp

@@ -0,0 +1,29 @@
+<%- |
+  Optional[Stdlib::HTTPUrl] $base_url,
+  Optional[String]          $username,
+  Optional[String]          $password,
+  Optional[String]          $cert,
+  Optional[String]          $key,
+  Optional[String]          $api_root,
+  Boolean                   $verify_ssl,
+  Boolean                   $dry_run,
+| -%>
+[cli]
+base_url = "<%= $base_url %>"
+verify_ssl = <%= $verify_ssl %>
+dry_run = <%= $dry_run %>
+<% if $username { -%>
+username = "<%= $username %>"
+<% } -%>
+<% if $password { -%>
+password = "<%= $password %>"
+<% } -%>
+<% if $cert { -%>
+cert = "<%= $cert %>"
+<% } -%>
+<% if $key { -%>
+key = "<%= $key %>"
+<% } -%>
+<% if $api_root { -%>
+api_root = "<%= $api_root %>"
+<% } -%>