Merge pull request #338 from kenyon/mark-install-as-private

Mark `install.pp` as private

REFERENCE.md

@@ -9,7 +9,6 @@
 #### Public Classes
 
 * [`letsencrypt`](#letsencrypt): Install and configure Certbot, the LetsEncrypt client
-* [`letsencrypt::install`](#letsencrypt--install): Installs the Let's Encrypt client.
 * [`letsencrypt::plugin::dns_cloudflare`](#letsencrypt--plugin--dns_cloudflare): Installs and configures the dns-cloudflare plugin
 * [`letsencrypt::plugin::dns_rfc2136`](#letsencrypt--plugin--dns_rfc2136): Installs and configures the dns-rfc2136 plugin
 * [`letsencrypt::plugin::dns_route53`](#letsencrypt--plugin--dns_route53): Installs and configures the dns-route53 plugin
@@ -19,6 +18,7 @@
 #### Private Classes
 
 * `letsencrypt::config`: Configures the Let's Encrypt client.
+* `letsencrypt::install`: Installs the Let's Encrypt client.
 * `letsencrypt::scripts`: Deploy helper scripts scripts
 
 ### Defined types
@@ -328,42 +328,6 @@ certificate. Two environmental variables are supplied by certbot:
 
 Default value: `[]`
 
-### <a name="letsencrypt--install"></a>`letsencrypt::install`
-
-Installs the Let's Encrypt client.
-
-#### Parameters
-
-The following parameters are available in the `letsencrypt::install` class:
-
-* [`configure_epel`](#-letsencrypt--install--configure_epel)
-* [`package_ensure`](#-letsencrypt--install--package_ensure)
-* [`package_name`](#-letsencrypt--install--package_name)
-
-##### <a name="-letsencrypt--install--configure_epel"></a>`configure_epel`
-
-Data type: `Boolean`
-
-A feature flag to include the 'epel' class and depend on it for package installation.
-
-Default value: `$letsencrypt::configure_epel`
-
-##### <a name="-letsencrypt--install--package_ensure"></a>`package_ensure`
-
-Data type: `String`
-
-The value passed to `ensure` when installing the client package.
-
-Default value: `$letsencrypt::package_ensure`
-
-##### <a name="-letsencrypt--install--package_name"></a>`package_name`
-
-Data type: `String`
-
-Name of package to use when installing the client package.
-
-Default value: `$letsencrypt::package_name`
-
 ### <a name="letsencrypt--plugin--dns_cloudflare"></a>`letsencrypt::plugin::dns_cloudflare`
 
 This class installs and configures the Let's Encrypt dns-cloudflare plugin.

manifests/install.pp

@@ -4,11 +4,15 @@
 # @param package_ensure The value passed to `ensure` when installing the client package.
 # @param package_name Name of package to use when installing the client package.
 #
+# @api private
+#
 class letsencrypt::install (
-  Boolean $configure_epel                = $letsencrypt::configure_epel,
-  String $package_name                   = $letsencrypt::package_name,
-  String $package_ensure                 = $letsencrypt::package_ensure,
+  Boolean $configure_epel = $letsencrypt::configure_epel,
+  String $package_name = $letsencrypt::package_name,
+  String $package_ensure = $letsencrypt::package_ensure,
 ) {
+  assert_private()
+
   package { 'letsencrypt':
     ensure => $package_ensure,
     name   => $package_name,

spec/classes/letsencrypt_spec.rb

@@ -58,25 +58,25 @@
               end
               is_expected.to contain_class('letsencrypt::install').with(package_name: 'certbot')
               is_expected.to contain_class('letsencrypt').with(package_command: 'certbot')
-              is_expected.to contain_package('letsencrypt').with(name: 'certbot')
+              is_expected.to contain_package('letsencrypt').with(name: 'certbot').with_ensure('installed')
               is_expected.to contain_file('/etc/letsencrypt').with(ensure: 'directory')
             elsif facts[:osfamily] == 'Debian'
               is_expected.to contain_class('letsencrypt::install').with(package_name: 'certbot')
               is_expected.to contain_file('/etc/letsencrypt').with(ensure: 'directory')
             elsif facts[:operatingsystem] == 'Gentoo'
               is_expected.to contain_class('letsencrypt::install').with(package_name: 'app-crypt/certbot')
               is_expected.to contain_class('letsencrypt').with(package_command: 'certbot')
-              is_expected.to contain_package('letsencrypt').with(name: 'app-crypt/certbot')
+              is_expected.to contain_package('letsencrypt').with(name: 'app-crypt/certbot').with_ensure('installed')
               is_expected.to contain_file('/etc/letsencrypt').with(ensure: 'directory')
             elsif facts[:operatingsystem] == 'OpenBSD'
               is_expected.to contain_class('letsencrypt::install').with(package_name: 'certbot')
               is_expected.to contain_class('letsencrypt').with(package_command: 'certbot')
-              is_expected.to contain_package('letsencrypt').with(name: 'certbot')
+              is_expected.to contain_package('letsencrypt').with(name: 'certbot').with_ensure('installed')
               is_expected.to contain_file('/etc/letsencrypt').with(ensure: 'directory')
             elsif facts[:operatingsystem] == 'FreeBSD'
               is_expected.to contain_class('letsencrypt::install').with(package_name: 'py39-certbot')
               is_expected.to contain_class('letsencrypt').with(package_command: 'certbot')
-              is_expected.to contain_package('letsencrypt').with(name: 'py39-certbot')
+              is_expected.to contain_package('letsencrypt').with(name: 'py39-certbot').with_ensure('installed')
               is_expected.to contain_file('/usr/local/etc/letsencrypt').with(ensure: 'directory')
             else
               is_expected.to contain_class('letsencrypt::install')