Merge pull request #901 from puppetlabs/CONT-351-Syntax_update

david22swan · web-flow · commit 9d18e68d2a57 · 2023-03-03T09:09:49.000Z
(CONT-351) Syntax update
diff --git a/.puppet-lint.rc b/.puppet-lint.rc
@@ -1,6 +1 @@
 --relative
---no-parameter_types-check
---no-legacy_facts-check
---no-top_scope_facts-check
---no-parameter_documentation-check
---no-topscope_variable-check
diff --git a/.sync.yml b/.sync.yml
@@ -35,10 +35,3 @@ spec/spec_helper.rb:
   unmanaged: false
 .travis.yml:
   delete: true
-Rakefile:
-  extra_disabled_lint_checks:
-    - parameter_types
-    - legacy_facts
-    - top_scope_facts
-    - parameter_documentation
-    - topscope_variable
diff --git a/Rakefile b/Rakefile
@@ -42,11 +42,6 @@ def changelog_future_release
 end
 
 PuppetLint.configuration.send('disable_relative')
-PuppetLint.configuration.send('disable_parameter_types')
-PuppetLint.configuration.send('disable_legacy_facts')
-PuppetLint.configuration.send('disable_top_scope_facts')
-PuppetLint.configuration.send('disable_parameter_documentation')
-PuppetLint.configuration.send('disable_topscope_variable')
 
 
 if Bundler.rubygems.find_name('github_changelog_generator').any?
diff --git a/manifests/compose.pp b/manifests/compose.pp
@@ -61,7 +61,7 @@
     if $raw_url != undef {
       $docker_compose_url = $raw_url
     } else {
-      $docker_compose_url = "${base_url}/${version}/docker-compose-${::kernel}-${facts['os']['hardware']}${file_extension}"
+      $docker_compose_url = "${base_url}/${version}/docker-compose-${facts['kernel']}-${facts['os']['hardware']}${file_extension}"
     }
 
     if $proxy != undef {
diff --git a/manifests/exec.pp b/manifests/exec.pp
@@ -29,9 +29,9 @@
   $docker_command = $docker::params::docker_command
 
   if $facts['os']['family'] == 'windows' {
-    $exec_environment = "PATH=${::docker_program_files_path}/Docker/"
+    $exec_environment = "PATH=${facts['docker_program_files_path']}/Docker/"
     $exec_timeout     = 3000
-    $exec_path        = ["${::docker_program_files_path}/Docker/",]
+    $exec_path        = ["${facts['docker_program_files_path']}/Docker/",]
     $exec_provider    = 'powershell'
   } else {
     $exec_environment = 'HOME=/root'
diff --git a/manifests/image.pp b/manifests/image.pp
@@ -41,11 +41,11 @@
 
   if $facts['os']['family'] == 'windows' {
     $update_docker_image_template = 'docker/windows/update_docker_image.ps1.erb'
-    $update_docker_image_path     = "${::docker_user_temp_path}/update_docker_image.ps1"
-    $exec_environment             = "PATH=${::docker_program_files_path}/Docker/"
+    $update_docker_image_path     = "${facts['docker_user_temp_path']}/update_docker_image.ps1"
+    $exec_environment             = "PATH=${facts['docker_program_files_path']}/Docker/"
     $exec_timeout                 = 3000
     $update_docker_image_owner    = undef
-    $exec_path                    = ["${::docker_program_files_path}/Docker/",]
+    $exec_path                    = ["${facts['docker_program_files_path']}/Docker/",]
     $exec_provider                = 'powershell'
   } else {
     $update_docker_image_template = 'docker/update_docker_image.sh.erb'
diff --git a/manifests/images.pp b/manifests/images.pp
@@ -3,7 +3,7 @@
 # @param images
 #
 class docker::images (
-  $images
+  Hash $images
 ) {
   create_resources(docker::image, $images)
 }
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -347,6 +347,7 @@
 # @param service_hasstatus
 # @param service_hasrestart
 # @param acknowledge_unsupported_os
+# @param have_systemd_v230
 #
 class docker (
   Optional[String]                        $version                           = $docker::params::version,
diff --git a/manifests/install.pp b/manifests/install.pp
@@ -19,12 +19,12 @@
 # @param dependent_packages
 #
 class docker::install (
-  $version                        = $docker::version,
-  $nuget_package_provider_version = $docker::nuget_package_provider_version,
-  $docker_msft_provider_version   = $docker::docker_msft_provider_version,
-  $docker_ee_package_name         = $docker::docker_ee_package_name,
-  $docker_download_url            = $docker::package_location,
-  $dependent_packages             = $docker::dependent_packages,
+  Optional[String] $version                        = $docker::version,
+  Optional[String] $nuget_package_provider_version = $docker::nuget_package_provider_version,
+  Optional[String] $docker_msft_provider_version   = $docker::docker_msft_provider_version,
+  Optional[String] $docker_ee_package_name         = $docker::docker_ee_package_name,
+  Optional[String] $docker_download_url            = $docker::package_location,
+  Array            $dependent_packages             = $docker::dependent_packages,
 ) {
   $docker_start_command = $docker::docker_start_command
 
diff --git a/manifests/machine.pp b/manifests/machine.pp
@@ -45,7 +45,7 @@
 
   if $ensure == 'present' {
     $docker_machine_url = $url ? {
-      undef   => "https://github.com/docker/machine/releases/download/v${version}/docker-machine-${::kernel}-x86_64${file_extension}",
+      undef   => "https://github.com/docker/machine/releases/download/v${version}/docker-machine-${facts['kernel']}-x86_64${file_extension}",
       default => $url,
     }
 
diff --git a/manifests/params.pp b/manifests/params.pp
@@ -90,13 +90,13 @@
   $docker_command                    = 'docker'
 
   if ($facts['os']['family'] == 'windows') {
-    $compose_install_path   = "${::docker_program_files_path}/Docker"
+    $compose_install_path   = "${facts['docker_program_files_path']}/Docker"
     $compose_version        = '1.29.2'
     $docker_ee_package_name = 'Docker'
-    $machine_install_path   = "${::docker_program_files_path}/Docker"
-    $tls_cacert             = "${::docker_program_data_path}/docker/certs.d/ca.pem"
-    $tls_cert               = "${::docker_program_data_path}/docker/certs.d/server-cert.pem"
-    $tls_key                = "${::docker_program_data_path}/docker/certs.d/server-key.pem"
+    $machine_install_path   = "${facts['docker_program_files_path']}/Docker"
+    $tls_cacert             = "${facts['docker_program_data_path']}/docker/certs.d/ca.pem"
+    $tls_cert               = "${facts['docker_program_data_path']}/docker/certs.d/server-cert.pem"
+    $tls_key                = "${facts['docker_program_data_path']}/docker/certs.d/server-key.pem"
   } else {
     $compose_install_path   = '/usr/local/bin'
     $compose_version        = '1.29.2'
@@ -243,7 +243,7 @@
       $msft_provider_version               = $docker_msft_provider_version
       $msft_package_version                = $version
       $service_config_template             = 'docker/windows/config/daemon.json.erb'
-      $service_config                      = "${::docker_program_data_path}/docker/config/daemon.json"
+      $service_config                      = "${facts['docker_program_data_path']}/docker/config/daemon.json"
       $docker_group                        = 'docker'
       $package_ce_source_location          = undef
       $package_ce_key_source               = undef
diff --git a/manifests/plugin.pp b/manifests/plugin.pp
@@ -6,9 +6,6 @@
 #  Note that the default behaviour of docker plugin
 #  requires a plugin be disabled before it can be removed
 #
-# @param plugin_name
-#  The name of the docker plugin
-#
 # @param enabled
 #  A setting to enable or disable an installed plugin.
 #
@@ -35,8 +32,6 @@
 #
 # @param ensure
 #
-# @param grant_all_permissions
-#
 define docker::plugin (
   Enum[present,absent] $ensure                = 'present',
   String               $plugin_name           = $title,
diff --git a/manifests/plugins.pp b/manifests/plugins.pp
@@ -3,7 +3,7 @@
 # @param plugins
 #
 class docker::plugins (
-  $plugins
+  Hash $plugins
 ) {
   create_resources(docker::plugin, $plugins)
 }
diff --git a/manifests/registry.pp b/manifests/registry.pp
@@ -51,9 +51,9 @@
   $docker_command = $docker::params::docker_command
 
   if $facts['os']['family'] == 'windows' {
-    $exec_environment = ["PATH=${::docker_program_files_path}/Docker/",]
+    $exec_environment = ["PATH=${facts['docker_program_files_path']}/Docker/",]
     $exec_timeout     = 3000
-    $exec_path        = ["${::docker_program_files_path}/Docker/",]
+    $exec_path        = ["${facts['docker_program_files_path']}/Docker/",]
     $exec_provider    = 'powershell'
     $password_env     = '$env:password'
     $exec_user        = undef
@@ -124,7 +124,7 @@
     } else {
       # server may be an URI, which can contain /
       $server_strip  = regsubst($server, '[/:]', '_', 'G')
-      $passfile      = "${::docker_user_temp_path}/registry-auth-puppet_receipt_${server_strip}_${local_user}"
+      $passfile      = "${facts['docker_user_temp_path']}/registry-auth-puppet_receipt_${server_strip}_${local_user}"
       $_auth_command = "if (-not (${auth_cmd})) { Remove-Item -Path ${passfile} -Force -Recurse -EA SilentlyContinue; exit 1 } else { exit 0 }" # lint:ignore:140chars
 
       if $ensure == 'absent' {
diff --git a/manifests/registry_auth.pp b/manifests/registry_auth.pp
@@ -3,7 +3,7 @@
 # @param registries
 #
 class docker::registry_auth (
-  $registries
+  Hash $registries
 ) {
   create_resources(docker::registry, $registries)
 }
diff --git a/manifests/repos.pp b/manifests/repos.pp
@@ -9,10 +9,10 @@
 # @param architecture
 #
 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'],
+  Optional[String]  $location         = $docker::package_location,
+  Optional[String]  $key_source       = $docker::package_key_source,
+  Optional[Boolean] $key_check_source = $docker::package_key_check_source,
+  String            $architecture     = $facts['os']['architecture'],
 ) {
   ensure_packages($docker::prerequired_packages)
 
diff --git a/manifests/run.pp b/manifests/run.pp
@@ -355,11 +355,11 @@
   }
 
   if $facts['os']['family'] == 'windows' {
-    $exec_environment        = "PATH=${::docker_program_files_path}/Docker/;${::docker_systemroot}/System32/"
+    $exec_environment        = "PATH=${facts['docker_program_files_path']}/Docker/;${facts['docker_systemroot']}/System32/"
     $exec_timeout            = 3000
-    $exec_path               = ["${::docker_program_files_path}/Docker/"]
+    $exec_path               = ["${facts['docker_program_files_path']}/Docker/"]
     $exec_provider           = 'powershell'
-    $cidfile                 = "${::docker_user_temp_path}/${service_prefix}${sanitised_title}.cid"
+    $cidfile                 = "${facts['docker_user_temp_path']}/${service_prefix}${sanitised_title}.cid"
     $restart_check           = "${docker_command} inspect ${sanitised_title} -f '{{ if eq \\\"unhealthy\\\" .State.Health.Status }} {{ .Name }}{{ end }}' | findstr ${sanitised_title}" # lint:ignore:140chars
     $container_running_check = "\$state = ${docker_command} inspect ${sanitised_title} -f \"{{ .State.Running }}\"; if (\$state -ieq \"true\") { Exit 0 } else { Exit 1 }" # lint:ignore:140chars
   } else {
@@ -505,7 +505,7 @@
           fail('Restart parameter is required for Windows')
         }
 
-        $hasstatus = $::docker::params::service_hasstatus
+        $hasstatus = $docker::params::service_hasstatus
       }
     }
 
diff --git a/manifests/run_instance.pp b/manifests/run_instance.pp
@@ -3,7 +3,7 @@
 # @param instance
 #
 class docker::run_instance (
-  $instance
+  Hash $instance
 ) {
   create_resources(docker::run, $instance)
 }
diff --git a/manifests/service.pp b/manifests/service.pp
diff --git a/manifests/services.pp b/manifests/services.pp
diff --git a/manifests/swarm.pp b/manifests/swarm.pp
diff --git a/manifests/swarms.pp b/manifests/swarms.pp
diff --git a/manifests/system_user.pp b/manifests/system_user.pp
diff --git a/manifests/volumes.pp b/manifests/volumes.pp

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@`
`61`	`61`	`if $raw_url != undef {`
`62`	`62`	`$docker_compose_url = $raw_url`
`63`	`63`	`} else {`
`64`		`- $docker_compose_url = "${base_url}/${version}/docker-compose-${::kernel}-${facts['os']['hardware']}${file_extension}"`
	`64`	`+ $docker_compose_url = "${base_url}/${version}/docker-compose-${facts['kernel']}-${facts['os']['hardware']}${file_extension}"`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`if $proxy != undef {`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`# @param images`
`4`	`4`	`#`
`5`	`5`	`class docker::images (`
`6`		`- $images`
	`6`	`+ Hash $images`
`7`	`7`	`) {`
`8`	`8`	`create_resources(docker::image, $images)`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -347,6 +347,7 @@`
`347`	`347`	`# @param service_hasstatus`
`348`	`348`	`# @param service_hasrestart`
`349`	`349`	`# @param acknowledge_unsupported_os`
	`350`	`+# @param have_systemd_v230`
`350`	`351`	`#`
`351`	`352`	`class docker (`
`352`	`353`	`Optional[String] $version = $docker::params::version,`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@`
`45`	`45`
`46`	`46`	`if $ensure == 'present' {`
`47`	`47`	`$docker_machine_url = $url ? {`
`48`		`- undef => "https://github.com/docker/machine/releases/download/v${version}/docker-machine-${::kernel}-x86_64${file_extension}",`
	`48`	`+ undef => "https://github.com/docker/machine/releases/download/v${version}/docker-machine-${facts['kernel']}-x86_64${file_extension}",`
`49`	`49`	`default => $url,`
`50`	`50`	`}`
`51`	`51`