]> review.fuel-infra Code Review - puppet-modules/puppetlabs-apt.git/commitdiff
apt(::key|_key) Remove the `key.*_` prefixes.
authorDaniele Sluijters <daenney@users.noreply.github.com>
Sat, 28 Feb 2015 16:35:25 +0000 (17:35 +0100)
committerDaniele Sluijters <daenney@users.noreply.github.com>
Sun, 1 Mar 2015 13:20:46 +0000 (14:20 +0100)
Remove a lot of the redundant `key_` prefixes on `apt::key` and the
`keyserver_` prefix on `apt_key`.

lib/puppet/type/apt_key.rb
manifests/key.pp
manifests/source.pp
spec/classes/apt_spec.rb
spec/defines/key_spec.rb
spec/defines/source_spec.rb

index 70825ac218c5bb286dc04219145eecf442803094..8aae686816577ac3b167ca7b19d9325cd1e2017a 100644 (file)
@@ -62,7 +62,7 @@ Puppet::Type.newtype(:apt_key) do
     newvalues(/\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/)
   end
 
-  newparam(:keyserver_options) do
+  newparam(:options) do
     desc 'Additional options to pass to apt-key\'s --keyserver-options.'
   end
 
index ce5fc2514cee6c27d32be04cd0cdaf3f47dac359..0f0572ed5f160c7483e3fd199c2fa9fedb087e05 100644 (file)
 #   * +present+
 #   * +absent+
 #
-# [*key_content*]
+# [*content*]
 #   _default_: +undef+
 #
 #   This parameter can be used to pass in a GPG key as a
 #   string in case it cannot be fetched from a remote location
 #   and using a file resource is for other reasons inconvenient.
 #
-# [*key_source*]
+# [*source*]
 #   _default_: +undef+
 #
 #   This parameter can be used to pass in the location of a GPG
@@ -38,7 +38,7 @@
 #   * +URL+: ftp, http or https
 #   * +path+: absolute path to a file on the target system.
 #
-# [*key_server*]
+# [*server*]
 #   _default_: +undef+
 #
 #   The keyserver from where to fetch our GPG key. It can either be a domain
 #   undef which results in apt_key's default keyserver being used,
 #   currently +keyserver.ubuntu.com+.
 #
-# [*key_options*]
+# [*options*]
 #   _default_: +undef+
 #
 #   Additional options to pass on to `apt-key adv --keyserver-options`.
 define apt::key (
-  $key         = $title,
-  $ensure      = present,
-  $key_content = undef,
-  $key_source  = undef,
-  $key_server  = undef,
-  $key_options = undef,
+  $key     = $title,
+  $ensure  = present,
+  $content = undef,
+  $source  = undef,
+  $server  = undef,
+  $options = undef,
 ) {
 
   validate_re($key, ['\A(0x)?[0-9a-fA-F]{8}\Z', '\A(0x)?[0-9a-fA-F]{16}\Z', '\A(0x)?[0-9a-fA-F]{40}\Z'])
   validate_re($ensure, ['\Aabsent|present\Z',])
 
-  if $key_content {
-    validate_string($key_content)
+  if $content {
+    validate_string($content)
   }
 
-  if $key_source {
-    validate_re($key_source, ['\Ahttps?:\/\/', '\Aftp:\/\/', '\A\/\w+'])
+  if $source {
+    validate_re($source, ['\Ahttps?:\/\/', '\Aftp:\/\/', '\A\/\w+'])
   }
 
-  if $key_server {
-    validate_re($key_server,['\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$'])
+  if $server {
+    validate_re($server,['\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$'])
   }
 
-  if $key_options {
-    validate_string($key_options)
+  if $options {
+    validate_string($options)
   }
 
   case $ensure {
@@ -86,12 +86,12 @@ define apt::key (
 
       if !defined(Anchor["apt_key ${key} present"]) {
         apt_key { $title:
-          ensure            => $ensure,
-          id                => $key,
-          source            => $key_source,
-          content           => $key_content,
-          server            => $key_server,
-          keyserver_options => $key_options,
+          ensure  => $ensure,
+          id      => $key,
+          source  => $source,
+          content => $content,
+          server  => $server,
+          options => $options,
         } ->
         anchor { "apt_key ${key} present": }
       }
@@ -104,12 +104,12 @@ define apt::key (
 
       if !defined(Anchor["apt_key ${key} absent"]){
         apt_key { $title:
-          ensure            => $ensure,
-          id                => $key,
-          source            => $key_source,
-          content           => $key_content,
-          server            => $key_server,
-          keyserver_options => $key_options,
+          ensure  => $ensure,
+          id      => $key,
+          source  => $source,
+          content => $content,
+          server  => $server,
+          options => $options,
         } ->
         anchor { "apt_key ${key} absent": }
       }
index b7d150c2233b8448710f7690315606e9bef4e461..215e4c407eaf5d26c7cec02f854e82ad808b7c65 100644 (file)
@@ -44,12 +44,12 @@ define apt::source(
   # We do not want to remove keys when the source is absent.
   if $key and ($ensure == 'present') {
     apt::key { "Add key: ${key} from Apt::Source ${title}":
-      ensure      => present,
-      key         => $key,
-      key_server  => $key_server,
-      key_content => $key_content,
-      key_source  => $key_source,
-      before      => Apt::Setting["list-${name}"],
+      ensure  => present,
+      key     => $key,
+      server  => $key_server,
+      content => $key_content,
+      source  => $key_source,
+      before  => Apt::Setting["list-${name}"],
     }
   }
 }
index 8e8a6c6613c5d1b2cf7636040697e59c342c14d3..2de19650610c6db89239c0af86bd586480a48341 100644 (file)
@@ -180,19 +180,19 @@ describe 'apt' do
     end
     let(:params) { { :keys => {
       '55BE302B' => {
-        'key_server' => 'subkeys.pgp.net',
+        'server' => 'subkeys.pgp.net',
       },
       '4BD6EC30' => {
-        'key_server' => 'pgp.mit.edu',
+        'server' => 'pgp.mit.edu',
       }
     } } }
 
     it { is_expected.to contain_apt__key('55BE302B').with({
-        :key_server => 'subkeys.pgp.net',
+        :server => 'subkeys.pgp.net',
     })}
 
     it { is_expected.to contain_apt__key('4BD6EC30').with({
-        :key_server => 'pgp.mit.edu',
+        :server => 'pgp.mit.edu',
     })}
   end
 
index c6f3752e809749b658151bf4caf7bef43d2e2e47..3d82df0e4ff4ca33bca36b83a8ddb84fb31f2b6c 100644 (file)
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'apt::key', :type => :define do
+describe 'apt::key' do
   let(:facts) { { :lsbdistid => 'Debian', :osfamily => 'Debian' } }
   GPG_KEY_ID = '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
 
@@ -12,12 +12,12 @@ describe 'apt::key', :type => :define do
     describe 'default options' do
       it 'contains the apt_key' do
         is_expected.to contain_apt_key(title).with({
-          :id                => title,
-          :ensure            => 'present',
-          :source            => nil,
-          :server            => nil,
-          :content           => nil,
-          :keyserver_options => nil,
+          :id      => title,
+          :ensure  => 'present',
+          :source  => nil,
+          :server  => nil,
+          :content => nil,
+          :options => nil,
         })
       end
       it 'contains the apt_key present anchor' do
@@ -36,12 +36,12 @@ describe 'apt::key', :type => :define do
 
       it 'contains the apt_key' do
         is_expected.to contain_apt_key(title).with({
-          :id                => GPG_KEY_ID,
-          :ensure            => 'present',
-          :source            => nil,
-          :server            => nil,
-          :content           => nil,
-          :keyserver_options => nil,
+          :id      => GPG_KEY_ID,
+          :ensure  => 'present',
+          :source  => nil,
+          :server  => nil,
+          :content => nil,
+          :options => nil,
         })
       end
       it 'contains the apt_key present anchor' do
@@ -56,12 +56,12 @@ describe 'apt::key', :type => :define do
 
       it 'contains the apt_key' do
         is_expected.to contain_apt_key(title).with({
-          :id                => title,
-          :ensure            => 'absent',
-          :source            => nil,
-          :server            => nil,
-          :content           => nil,
-          :keyserver_options => nil,
+          :id        => title,
+          :ensure    => 'absent',
+          :source    => nil,
+          :server    => nil,
+          :content   => nil,
+          :keyserver => nil,
         })
       end
       it 'contains the apt_key absent anchor' do
@@ -71,20 +71,20 @@ describe 'apt::key', :type => :define do
 
     describe 'set a bunch of things!' do
       let :params do {
-        :key_content => 'GPG key content',
-        :key_source => 'http://apt.puppetlabs.com/pubkey.gpg',
-        :key_server => 'pgp.mit.edu',
-        :key_options => 'debug',
+        :content => 'GPG key content',
+        :source  => 'http://apt.puppetlabs.com/pubkey.gpg',
+        :server  => 'pgp.mit.edu',
+        :options => 'debug',
       } end
 
       it 'contains the apt_key' do
         is_expected.to contain_apt_key(title).with({
-          :id                => title,
-          :ensure            => 'present',
-          :source            => 'http://apt.puppetlabs.com/pubkey.gpg',
-          :server            => 'pgp.mit.edu',
-          :content           => params[:key_content],
-          :keyserver_options => 'debug',
+          :id      => title,
+          :ensure  => 'present',
+          :source  => 'http://apt.puppetlabs.com/pubkey.gpg',
+          :server  => 'pgp.mit.edu',
+          :content => params[:content],
+          :options => 'debug',
         })
       end
       it 'contains the apt_key present anchor' do
@@ -94,7 +94,7 @@ describe 'apt::key', :type => :define do
 
     context "domain with dash" do
       let(:params) do{
-        :key_server => 'p-gp.m-it.edu',
+        :server => 'p-gp.m-it.edu',
       } end
       it 'contains the apt_key' do
         is_expected.to contain_apt_key(title).with({
@@ -107,7 +107,7 @@ describe 'apt::key', :type => :define do
     context "url" do
       let :params do
         {
-          :key_server => 'hkp://pgp.mit.edu',
+          :server => 'hkp://pgp.mit.edu',
         }
       end
       it 'contains the apt_key' do
@@ -120,7 +120,7 @@ describe 'apt::key', :type => :define do
     context "url with port number" do
       let :params do
         {
-          :key_server => 'hkp://pgp.mit.edu:80',
+          :server => 'hkp://pgp.mit.edu:80',
         }
       end
       it 'contains the apt_key' do
@@ -135,7 +135,7 @@ describe 'apt::key', :type => :define do
   describe 'validation' do
     context "domain begin with dash" do
       let(:params) do{
-        :key_server => '-pgp.mit.edu',
+        :server => '-pgp.mit.edu',
       } end
       it 'fails' do
         expect { subject } .to raise_error(/does not match/)
@@ -144,7 +144,7 @@ describe 'apt::key', :type => :define do
 
     context "domain begin with dot" do
       let(:params) do{
-        :key_server => '.pgp.mit.edu',
+        :server => '.pgp.mit.edu',
       } end
       it 'fails' do
         expect { subject } .to raise_error(/does not match/)
@@ -153,7 +153,7 @@ describe 'apt::key', :type => :define do
 
     context "domain end with dot" do
       let(:params) do{
-        :key_server => "pgp.mit.edu.",
+        :server => "pgp.mit.edu.",
       } end
       it 'fails' do
         expect { subject } .to raise_error(/does not match/)
@@ -162,7 +162,7 @@ describe 'apt::key', :type => :define do
     context "exceed character url" do
       let :params do
         {
-          :key_server => 'hkp://pgpiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii.mit.edu'
+          :server => 'hkp://pgpiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii.mit.edu'
         }
       end
       it 'fails' do
@@ -172,7 +172,7 @@ describe 'apt::key', :type => :define do
     context "incorrect port number url" do
       let :params do
         {
-          :key_server => 'hkp://pgp.mit.edu:8008080'
+          :server => 'hkp://pgp.mit.edu:8008080'
         }
       end
       it 'fails' do
@@ -182,7 +182,7 @@ describe 'apt::key', :type => :define do
     context "incorrect protocol for  url" do
       let :params do
         {
-          :key_server => 'abc://pgp.mit.edu:80'
+          :server => 'abc://pgp.mit.edu:80'
         }
       end
       it 'fails' do
@@ -192,7 +192,7 @@ describe 'apt::key', :type => :define do
     context "missing port number url" do
       let :params do
         {
-          :key_server => 'hkp://pgp.mit.edu:'
+          :server => 'hkp://pgp.mit.edu:'
         }
       end
       it 'fails' do
@@ -202,7 +202,7 @@ describe 'apt::key', :type => :define do
     context "url ending with a dot" do
       let :params do
         {
-          :key_server => 'hkp://pgp.mit.edu.'
+          :server => 'hkp://pgp.mit.edu.'
         }
       end
       it 'fails' do
@@ -211,7 +211,7 @@ describe 'apt::key', :type => :define do
     end
     context "url begin with a dash" do
       let(:params) do{
-        :key_server => "hkp://-pgp.mit.edu",
+        :server => "hkp://-pgp.mit.edu",
       } end
       it 'fails' do
         expect { subject }.to raise_error(/does not match/)
@@ -228,7 +228,7 @@ describe 'apt::key', :type => :define do
 
     context 'invalid source' do
       let :params do {
-        :key_source => 'afp://puppetlabs.com/key.gpg',
+        :source => 'afp://puppetlabs.com/key.gpg',
       } end
       it 'fails' do
         expect { subject }.to raise_error(/does not match/)
@@ -237,7 +237,7 @@ describe 'apt::key', :type => :define do
 
     context 'invalid content' do
       let :params do {
-        :key_content => [],
+        :content => [],
       } end
       it 'fails' do
         expect { subject }.to raise_error(/is not a string/)
@@ -246,16 +246,16 @@ describe 'apt::key', :type => :define do
 
     context 'invalid server' do
       let :params do {
-        :key_server => 'two bottles of rum',
+        :server => 'two bottles of rum',
       } end
       it 'fails' do
         expect { subject }.to raise_error(/does not match/)
       end
     end
 
-    context 'invalid keyserver_options' do
+    context 'invalid options' do
       let :params do {
-        :key_options => {},
+        :options => {},
       } end
       it 'fails' do
         expect { subject }.to raise_error(/is not a string/)
@@ -292,12 +292,12 @@ describe 'apt::key', :type => :define do
 
         it 'contains only a single apt_key' do
           is_expected.to contain_apt_key('duplicate').with({
-            :id                => title,
-            :ensure            => 'present',
-            :source            => nil,
-            :server            => nil,
-            :content           => nil,
-            :keyserver_options => nil,
+            :id      => title,
+            :ensure  => 'present',
+            :source  => nil,
+            :server  => nil,
+            :content => nil,
+            :options => nil,
           })
           is_expected.not_to contain_apt_key(title)
         end
index 5e2728b25138274c5e9515f86f40fa6d5f8a065b..f55921b615784a1f9b4db5860e9f22b167278ee1 100644 (file)
@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'apt::source', :type => :define do
+describe 'apt::source' do
   GPG_KEY_ID = '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
 
   let :pre_condition do
@@ -71,11 +71,11 @@ describe 'apt::source', :type => :define do
     }
 
     it { is_expected.to contain_apt__key("Add key: #{GPG_KEY_ID} from Apt::Source my_source").that_comes_before('Apt::Setting[list-my_source]').with({
-      'ensure' => 'present',
-        'key'  => GPG_KEY_ID,
-        'key_server' => 'pgp.mit.edu',
-        'key_content' => 'GPG key content',
-        'key_source' => 'http://apt.puppetlabs.com/pubkey.gpg',
+      'ensure'  => 'present',
+      'key'     => GPG_KEY_ID,
+      'server'  => 'pgp.mit.edu',
+      'content' => 'GPG key content',
+      'source'  => 'http://apt.puppetlabs.com/pubkey.gpg',
     })
     }
   end
@@ -122,7 +122,7 @@ describe 'apt::source', :type => :define do
     }).with_content(/# my_source\ndeb-src \[arch=x86_64 \]  wheezy main\n/)
     }
   end
+
   context 'ensure => absent' do
     let :facts do
       {