Use apt::source keyring to fix apt-key deprecated warnings

manifests/init.pp

@@ -347,6 +347,9 @@
 # @param service_hasstatus
 # @param service_hasrestart
 # @param acknowledge_unsupported_os
+# @param keyring
+#   Absolute path to a file containing the PGP keyring used to sign this repository. Value is used to set signed-by on the source entry.
+#   See https://wiki.debian.org/DebianRepository/UseThirdParty for details.
 #
 class docker (
   Optional[String]                        $version                           = $docker::params::version,
@@ -466,6 +469,7 @@
   Optional[Boolean]                       $service_hasrestart                = $docker::params::service_hasrestart,
   Optional[Variant[String,Array]]         $registry_mirror                   = $docker::params::registry_mirror,
   Boolean                                 $acknowledge_unsupported_os        = false,
+  Stdlib::Absolutepath                    $keyring                           = '/etc/apt/keyrings/docker.gpg',
 
   # Windows specific parameters
   Optional[String]                        $docker_msft_provider_version      = $docker::params::docker_msft_provider_version,

manifests/repos.pp

@@ -8,11 +8,16 @@
 #
 # @param architecture
 #
+# @param keyring
+#   Absolute path to a file containing the PGP keyring used to sign this repository. Value is used to set signed-by on the source entry.
+#   See https://wiki.debian.org/DebianRepository/UseThirdParty for details.
+#
 class docker::repos (
   $location         = $docker::package_location,
   $key_source       = $docker::package_key_source,
   $key_check_source = $docker::package_key_check_source,
   $architecture     = $facts['os']['architecture'],
+  $keyring          = $docker::keyring,
 ) {
   ensure_packages($docker::prerequired_packages)
 
@@ -22,19 +27,42 @@
       $package_key   = $docker::package_key
       $package_repos = $docker::package_repos
 
+      if ( $facts['os']['distro']['id'] == 'Debian' and versioncmp($facts['os']['distro']['release']['major'],'10') >= 0 ) or ( $facts['os']['distro']['id'] == 'Ubuntu' and versioncmp($facts['os']['distro']['release']['major'],'22') >= 0 ) { # lint:ignore:140chars
+        # fix deprecated apt-key warnings
+        file { $keyring:
+          ensure  => file,
+          content => binary_file("${module_name}/etc/apt/keyrings/docker.gpg"),
+          mode    => '0644',
+          owner   => 'root',
+          group   => 'root',
+        }
+        $key_options = {
+          keyring => $keyring,
+        }
+        apt::key { 'docker-key-in-trusted.gpg':
+          ensure => absent,
+          id     => '9DC858229FC7DD38854AE2D88D81803C0EBFCD88',
+        }
+      }
+      else {
+        $key_options = {
+          key => {
+            id     => $package_key,
+            source => $key_source,
+          },
+        }
+      }
+
       if ($docker::use_upstream_package_source) {
         apt::source { 'docker':
           location     => $location,
           architecture => $architecture,
           release      => $release,
           repos        => $package_repos,
-          key          => {
-            id     => $package_key,
-            source => $key_source,
-          },
           include      => {
             src => false,
           },
+          *            => $key_options,
         }
 
         $url_split  = split($location, '/')

metadata.json

@@ -14,7 +14,7 @@
     },
     {
       "name": "puppetlabs/apt",
-      "version_requirement": ">= 4.4.1 < 10.0.0"
+      "version_requirement": ">= 8.1.0 < 10.0.0"
     },
     {
       "name": "puppetlabs/powershell",

spec/classes/init_spec.rb

@@ -30,6 +30,9 @@
     'docker_msft_provider_version'   => '123',
     'nuget_package_provider_version' => '41',
   },
+  'with keyring set to optional path' => {
+    'keyring' => '/root/keyrings/docker.gpg',
+  },
 }
 
 describe 'docker', type: :class do
@@ -180,6 +183,7 @@
             'tmp_dir'                           => defaults['tmp_dir'],
             'use_upstream_package_source'       => defaults['use_upstream_package_source'],
             'version'                           => defaults['version'],
+            'keyring'                           => defaults['keyring']
           }.merge(default_params).merge(local_params)
 
           let(:facts) do

spec/helper/get_defaults.rb

@@ -88,6 +88,7 @@ def get_defaults(_facts)
   tmp_dir                           = '/tmp/'
   tmp_dir_config                    = true
   version                           = :undef
+  keyring                           = '/etc/apt/keyrings/docker.gpg'
 
   if _facts[:os]['family'] == 'windows'
     compose_install_path   = "#{_facts['docker_program_files_path']}/Docker"
@@ -487,5 +488,6 @@ def get_defaults(_facts)
     'tmp_dir_config' => tmp_dir_config,
     'use_upstream_package_source' => use_upstream_package_source,
     'version' => version,
+    'keyring' => keyring,
   }
 end

spec/shared_examples/repos.rb

@@ -11,6 +11,7 @@
   key_source       = values['package_key_source']
   key_check_source = values['package_key_check_source']
   architecture     = facts[:os]['architecture']
+  keyring          = params['keyring']
 
   unless params['prerequired_packages'].empty?
     params['prerequired_packages'].each do |package|
@@ -27,21 +28,51 @@
     package_repos = values['package_repos']
 
     if params['use_upstream_package_source']
-      it {
-        is_expected.to contain_apt__source('docker').with(
-          'location'     => location,
-          'architecture' => architecture,
-          'release'      => release,
-          'repos'        => package_repos,
-          'key'          => {
-            'id'     => package_key,
-            'source' => key_source,
-          },
-          'include' => {
-            'src' => false,
-          },
-        )
-      }
+      # check if debian version is atleast 10 and ubuntu version is atleast 22
+      if (facts[:operatingsystem] == 'Debian' && facts[:operatingsystemrelease] =~ /1[0-9]/) || (facts[:operatingsystem] == 'Ubuntu' && facts[:operatingsystemrelease] =~ /2[2-9]/)
+        it {
+          is_expected.to contain_file(keyring).with(
+            'ensure'  => 'file',
+            'mode'    => '0644',
+            'owner'   => 'root',
+            'group'   => 'root',
+          )
+        }
+        it {
+          is_expected.to contain_apt__source('docker').with(
+            'location'     => location,
+            'architecture' => architecture,
+            'release'      => release,
+            'repos'        => package_repos,
+            'keyring'      => keyring,
+            'include' => {
+              'src' => false,
+            },
+          )
+        }
+        it {
+          is_expected.to contain_apt__key('docker-key-in-trusted.gpg').with(
+            'ensure' => 'absent',
+            'id'     => '9DC858229FC7DD38854AE2D88D81803C0EBFCD88',
+          )
+        }
+      else
+        it {
+          is_expected.to contain_apt__source('docker').with(
+            'location'     => location,
+            'architecture' => architecture,
+            'release'      => release,
+            'repos'        => package_repos,
+            'key'          => {
+              'id'     => package_key,
+              'source' => key_source,
+            },
+            'include' => {
+              'src' => false,
+            },
+          )
+        }
+      end
 
       url_split  = location.split('/')
       repo_host  = url_split[2]