From 84be574b9406bcc2eabe5d54e8d8102fc35e1734 Mon Sep 17 00:00:00 2001
From: Kenyon Ralph <quic_kralph@quicinc.com>
Date: Tue, 21 Nov 2023 10:53:15 -0800
Subject: [PATCH] keyring: rename parameters to remove redundancy

We don't need apt::keyring::keyring_thing, it should just be
apt::keyring::thing.
---
 REFERENCE.md         | 18 +++++++++---------
 manifests/keyring.pp | 24 ++++++++++++------------
 manifests/source.pp  | 10 +++++-----
 3 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/REFERENCE.md b/REFERENCE.md
index f4e31a20cf..61237dd8a0 100644
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -665,15 +665,15 @@ apt::source { 'puppet8-release':
 
 The following parameters are available in the `apt::keyring` defined type:
 
-* [`keyring_dir`](#-apt--keyring--keyring_dir)
-* [`keyring_filename`](#-apt--keyring--keyring_filename)
-* [`keyring_file`](#-apt--keyring--keyring_file)
-* [`keyring_file_mode`](#-apt--keyring--keyring_file_mode)
+* [`dir`](#-apt--keyring--dir)
+* [`filename`](#-apt--keyring--filename)
+* [`file`](#-apt--keyring--file)
+* [`mode`](#-apt--keyring--mode)
 * [`source`](#-apt--keyring--source)
 * [`content`](#-apt--keyring--content)
 * [`ensure`](#-apt--keyring--ensure)
 
-##### <a name="-apt--keyring--keyring_dir"></a>`keyring_dir`
+##### <a name="-apt--keyring--dir"></a>`dir`
 
 Data type: `Stdlib::Absolutepath`
 
@@ -681,7 +681,7 @@ Path to the directory where the keyring will be stored.
 
 Default value: `'/etc/apt/keyrings'`
 
-##### <a name="-apt--keyring--keyring_filename"></a>`keyring_filename`
+##### <a name="-apt--keyring--filename"></a>`filename`
 
 Data type: `String[1]`
 
@@ -689,15 +689,15 @@ Optional filename for the keyring. It should also contain extension along with t
 
 Default value: `$name`
 
-##### <a name="-apt--keyring--keyring_file"></a>`keyring_file`
+##### <a name="-apt--keyring--file"></a>`file`
 
 Data type: `Stdlib::Absolutepath`
 
 File path of the keyring.
 
-Default value: `"${keyring_dir}/${keyring_filename}"`
+Default value: `"${dir}/${filename}"`
 
-##### <a name="-apt--keyring--keyring_file_mode"></a>`keyring_file_mode`
+##### <a name="-apt--keyring--mode"></a>`mode`
 
 Data type: `Stdlib::Filemode`
 
diff --git a/manifests/keyring.pp b/manifests/keyring.pp
index 83af558257..407ecb1f3d 100644
--- a/manifests/keyring.pp
+++ b/manifests/keyring.pp
@@ -14,16 +14,16 @@
 #     }
 #   }
 #
-# @param keyring_dir
+# @param dir
 #   Path to the directory where the keyring will be stored.
 #
-# @param keyring_filename
+# @param filename
 #   Optional filename for the keyring. It should also contain extension along with the filename.
 #
-# @param keyring_file
+# @param file
 #   File path of the keyring.
 #
-# @param keyring_file_mode
+# @param mode
 #   File permissions of the keyring.
 #
 # @param source
@@ -36,15 +36,15 @@
 #   Ensure presence or absence of the resource.
 #
 define apt::keyring (
-  Stdlib::Absolutepath $keyring_dir = '/etc/apt/keyrings',
-  String[1] $keyring_filename = $name,
-  Stdlib::Absolutepath $keyring_file = "${keyring_dir}/${keyring_filename}",
-  Stdlib::Filemode $keyring_file_mode = '0644',
+  Stdlib::Absolutepath $dir = '/etc/apt/keyrings',
+  String[1] $filename = $name,
+  Stdlib::Absolutepath $file = "${dir}/${filename}",
+  Stdlib::Filemode $mode = '0644',
   Optional[Stdlib::Filesource] $source = undef,
   Optional[String[1]] $content = undef,
   Enum['present','absent'] $ensure = 'present',
 ) {
-  ensure_resource('file', $keyring_dir, { ensure => 'directory', mode => '0755', })
+  ensure_resource('file', $dir, { ensure => 'directory', mode => '0755', })
   if $source and $content {
     fail("Parameters 'source' and 'content' are mutually exclusive")
   } elsif ! $source and ! $content {
@@ -53,9 +53,9 @@
 
   case $ensure {
     'present': {
-      file { $keyring_file:
+      file { $file:
         ensure  => 'file',
-        mode    => $keyring_file_mode,
+        mode    => $mode,
         owner   => 'root',
         group   => 'root',
         source  => $source,
@@ -63,7 +63,7 @@
       }
     }
     'absent': {
-      file { $keyring_file:
+      file { $file:
         ensure => $ensure,
       }
     }
diff --git a/manifests/source.pp b/manifests/source.pp
index e1793cea48..0dc104f705 100644
--- a/manifests/source.pp
+++ b/manifests/source.pp
@@ -183,11 +183,11 @@
     # Modern apt keyrings
     elsif $_key =~ Hash and $_key['name'] {
       apt::keyring { $_key['name']:
-        ensure           => $_key_ensure,
-        content          => $_key['content'],
-        source           => $_key['source'],
-        keyring_filename => $_key['filename'],
-        before           => $_before,
+        ensure   => $_key_ensure,
+        content  => $_key['content'],
+        source   => $_key['source'],
+        filename => $_key['filename'],
+        before   => $_before,
       }
       # TODO replace this block with a reference to the apt::keyring's final filename/full_path
       if $_key['filename'] {