(CLOUD_1505) validate functions

manifests/compose.pp

@@ -21,14 +21,12 @@
 #   Proxy to use for downloading Docker Compose.
 #
 class docker::compose(
-  $ensure = 'present',
-  $version = $docker::params::compose_version,
-  $install_path = $docker::params::compose_install_path,
-  $proxy = undef
+  Optional[Pattern[/^present$|^absent$/]] $ensure          = 'present',
+  Optional[String] $version                                = $docker::params::compose_version,
+  Optional[String] $install_path                           = $docker::params::compose_install_path,
+  Optional[String] $proxy                                  = undef
 ) inherits docker::params {
-  validate_string($version)
-  validate_re($ensure, '^(present|absent)$')
-  validate_absolute_path($install_path)
+
   if $proxy != undef {
       validate_re($proxy, '^(https?:\/\/)?([^:^@]+:[^:^@]+@|)([\da-z\.-]+)\.([\da-z\.]{2,6})(:[\d])?([\/\w \.-]*)*\/?$')
   }

manifests/exec.pp

@@ -3,25 +3,17 @@
 # A define which executes a command inside a container.
 #
 define docker::exec(
-  $detach = false,
-  $interactive = false,
-  $tty = false,
-  $container = undef,
-  $command = undef,
-  $unless = undef,
-  $sanitise_name = true,
+  Optional[Boolean] $detach        = false,
+  Optional[Boolean] $interactive   = false,
+  Optional[Boolean] $tty           = false,
+  Optional[String] $container      = undef,
+  Optional[String] $command        = undef,
+  Optional[String] $unless         = undef,
+  Optional[Boolean] $sanitise_name = true,
 ) {
   include docker::params
 
   $docker_command = $docker::params::docker_command
-  validate_string($docker_command)
-
-  validate_string($container)
-  validate_string($command)
-  validate_string($unless)
-  validate_bool($detach)
-  validate_bool($interactive)
-  validate_bool($tty)
 
   $docker_exec_flags = docker_exec_flags({
     detach => $detach,

manifests/image.pp

@@ -24,20 +24,17 @@
 #   If you want to load a docker image from specific docker tar
 #
 define docker::image(
-  $ensure       = 'present',
-  $image        = $title,
-  $image_tag    = undef,
-  $image_digest = undef,
-  $force        = false,
-  $docker_file  = undef,
-  $docker_dir   = undef,
-  $docker_tar   = undef,
+  Optional[Pattern[/^(present|absent|latest)$/]] $ensure = 'present',
+  Optional[Pattern[/^[\S]*$/]] $image                    = $title,
+  Optional[String] $image_tag                            = undef,
+  Optional[String] $image_digest                         = undef,
+  Optional[Boolean] $force                               = false,
+  Optional[String] $docker_file                          = undef,
+  Optional[String] $docker_dir                           = undef,
+  Optional[String] $docker_tar                           = undef,
 ) {
   include docker::params
   $docker_command = $docker::params::docker_command
-  validate_re($ensure, '^(present|absent|latest)$')
-  validate_re($image, '^[\S]*$')
-  validate_bool($force)
 
   # Wrapper used to ensure images are up to date
   ensure_resource('file', '/usr/local/bin/update_docker_image.sh',

manifests/install.pp

@@ -6,11 +6,11 @@
 #
 class docker::install {
   $docker_start_command = $docker::docker_start_command
-  validate_string($docker::version)
-  validate_re($::osfamily, '^(Debian|RedHat|Archlinux|Gentoo)$',
-              'This module only works on Debian or Red Hat based systems or on Archlinux as on Gentoo.')
-  validate_bool($docker::use_upstream_package_source)
-
+  if $::osfamily {
+    assert_type(Pattern[/^(Debian|RedHat|Archlinux|Gentoo)$/], $::osfamily) |$a, $b| {
+      fail('This module only works on Debian or Red Hat based systems or on Archlinux as on Gentoo.')
+    }
+  }
   if $docker::version and $docker::ensure != 'absent' {
     $ensure = $docker::version
   } else {

manifests/registry.pp

@@ -33,20 +33,18 @@
 #   Required to be true for idempotency
 #
 define docker::registry(
-  $server      = $title,
-  $ensure      = 'present',
-  $username    = undef,
-  $password    = undef,
-  $pass_hash   = undef,
-  $email       = undef,
-  $local_user  = 'root',
-  $version     = $docker::version,
-  $receipt     = true,
+  Optional[String] $server                             = $title,
+  Optional[Pattern[/^present$|^absent$/]] $ensure      = 'present',
+  Optional[String] $username                           = undef,
+  Optional[String] $password                           = undef,
+  Optional[String] $pass_hash                          = undef,
+  Optional[String] $email                              = undef,
+  Optional[String] $local_user                         = 'root',
+  Optional[String] $version                            = $docker::version,
+  Optional[Boolean] $receipt                           = true,
 ) {
   include docker::params
 
-  validate_re($ensure, '^(present|absent)$')
-
   $docker_command = $docker::params::docker_command
 
   if $ensure == 'present' {

manifests/run.pp

@@ -60,55 +60,55 @@
 # Default: on-failure
 #
 define docker::run(
-  $image,
-  $ensure = 'present',
-  $command = undef,
-  $memory_limit = '0b',
-  $cpuset = [],
-  $ports = [],
-  $labels = [],
-  $expose = [],
-  $volumes = [],
-  $links = [],
-  $use_name = false,
-  $running = true,
-  $volumes_from = [],
-  $net = 'bridge',
-  $username = false,
-  $hostname = false,
-  $env = [],
-  $env_file = [],
-  $dns = [],
-  $dns_search = [],
-  $lxc_conf = [],
-  $service_prefix = 'docker-',
-  $restart_service = true,
-  $restart_service_on_docker_refresh = true,
-  $manage_service = true,
-  $docker_service = false,
-  $disable_network = false,
-  $privileged = false,
-  $detach = undef,
-  $extra_parameters = undef,
-  $systemd_restart = 'on-failure',
-  $extra_systemd_parameters = {},
-  $pull_on_start = false,
-  $after = [],
-  $after_service = [],
-  $depends = [],
-  $depend_services = [],
-  $tty = false,
-  $socket_connect = [],
-  $hostentries = [],
-  $restart = undef,
-  $before_start = false,
-  $before_stop = false,
-  $remove_container_on_start = true,
-  $remove_container_on_stop = true,
-  $remove_volume_on_start = false,
-  $remove_volume_on_stop = false,
-  $stop_wait_time = 0,
-  $syslog_identifier = undef,
+  Optional[Pattern[/^[\S]*$/]] $image,
+  Optional[Pattern[/^present$|^absent$/]] $ensure      = 'present',
+  Optional[String] $command                            = undef,
+  Optional[Pattern[/^[\d]*(b|k|m|g)$/]] $memory_limit  = '0b',
+  Variant[String,Array,Undef] $cpuset                  = [],
+  Variant[String,Array,Undef] $ports                   = [],
+  Variant[String,Array,Undef] $labels                  = [],
+  Variant[String,Array,Undef] $expose                  = [],
+  Variant[String,Array,Undef] $volumes                 = [],
+  Variant[String,Array,Undef] $links                   = [],
+  Optional[Boolean] $use_name                          = false,
+  Optional[Boolean] $running                           = true,
+  Variant[String,Array,Undef] $volumes_from            = [],
+  Optional[String] $net                                = 'bridge',
+  Variant[String,Boolean] $username                    = false,
+  Variant[String,Boolean] $hostname                    = false,
+  Variant[String,Array,Undef] $env                     = [],
+  Variant[String,Array,Undef] $env_file                = [],
+  Variant[String,Array,Undef] $dns                     = [],
+  Variant[String,Array,Undef] $dns_search              = [],
+  Variant[String,Array,Undef] $lxc_conf                = [],
+  Optional[String] $service_prefix                     = 'docker-',
+  Optional[Boolean] $restart_service                   = true,
+  Optional[Boolean] $restart_service_on_docker_refresh = true,
+  Optional[Boolean] $manage_service                    = true,
+  Variant[String,Boolean] $docker_service              = false,
+  Optional[Boolean] $disable_network                   = false,
+  Optional[Boolean] $privileged                        = false,
+  Optional[Boolean] $detach                            = undef,
+  Variant[String,Tuple,Undef] $extra_parameters        = undef,
+  Optional[String] $systemd_restart                    = 'on-failure',
+  Variant[String,Hash,Undef] $extra_systemd_parameters = {},
+  Optional[Boolean] $pull_on_start                     = false,
+  Variant[String,Array,Undef] $after                   = [],
+  Variant[String,Array,Undef] $after_service           = [],
+  Variant[String,Array,Undef] $depends                 = [],
+  Variant[String,Array,Undef] $depend_services         = [],
+  Optional[Boolean] $tty                               = false,
+  Variant[String,Array,Undef] $socket_connect          = [],
+  Variant[String,Array,Undef] $hostentries             = [],
+  Optional[String] $restart                            = undef,
+  Variant[String,Boolean] $before_start                = false,
+  Variant[String,Boolean] $before_stop                 = false,
+  Optional[Boolean] $remove_container_on_start         = true,
+  Optional[Boolean] $remove_container_on_stop          = true,
+  Optional[Boolean] $remove_volume_on_start            = false,
+  Optional[Boolean] $remove_volume_on_stop             = false,
+  Optional[Integer] $stop_wait_time                    = 0,
+  Optional[String] $syslog_identifier                  = undef,
 ) {
   include docker
   if ($socket_connect != []) {
@@ -120,39 +120,9 @@
   $service_name = $docker::service_name
   $docker_group = $docker::docker_group
 
-  validate_re($image, '^[\S]*$')
-  validate_re($title, '^[\S]*$')
-  validate_re($memory_limit, '^[\d]*(b|k|m|g)$')
-  validate_re($ensure, '^(present|absent)')
   if $restart {
-    validate_re($restart, '^(no|always|unless-stopped|on-failure)|^on-failure:[\d]+$')
+    assert_type(Pattern[/^(no|always|unless-stopped|on-failure)|^on-failure:[\d]+$/], $restart)
   }
-  validate_string($docker_command)
-  validate_string($service_name)
-  validate_string($docker_group)
-
-  if $command {
-    validate_string($command)
-  }
-  if $username {
-    validate_string($username)
-  }
-  if $hostname {
-    validate_string($hostname)
-  }
-  validate_bool($running)
-  validate_bool($disable_network)
-  validate_bool($privileged)
-  validate_bool($restart_service)
-  validate_bool($restart_service_on_docker_refresh)
-  validate_bool($tty)
-  validate_bool($remove_container_on_start)
-  validate_bool($remove_container_on_stop)
-  validate_bool($remove_volume_on_start)
-  validate_bool($remove_volume_on_stop)
-  validate_bool($use_name)
-
-  validate_integer($stop_wait_time)
 
   if ($remove_volume_on_start and !$remove_container_on_start) {
     fail("In order to remove the volume on start for ${title} you need to also remove the container")
@@ -169,15 +139,13 @@
     }
   }
 
-  validate_hash($extra_systemd_parameters)
   if $systemd_restart {
-    validate_re($systemd_restart, '^(no|always|on-success|on-failure|on-abnormal|on-abort|on-watchdog)$')
+    assert_type(Pattern[/^(no|always|on-success|on-failure|on-abnormal|on-abort|on-watchdog)$/], $systemd_restart)
   }
 
   if $detach == undef {
     $valid_detach = $docker::params::detach_service_in_init
   } else {
-    validate_bool($detach)
     $valid_detach = $detach
   }
 

manifests/secrets.pp

@@ -1,21 +1,13 @@
 define docker::secrets (
 
-  $ensure = 'present',
-  $label = [],
-  $secret_name = undef,
-  $secret_path = undef,
+  Optional[Pattern[/^present$|^absent$/]] $ensure = 'present',
+  Variant[String,Array,Undef] $label              = [],
+  Optional[String] $secret_name                   = undef,
+  Optional[String] $secret_path                   = undef,
 ){
   include docker::params
 
   $docker_command = "${docker::params::docker_command} secret"
-  validate_re($ensure, '^(present|absent)$')
-  validate_string($docker_command)
-  validate_string($secret_name)
-  validate_string($secret_path)
-  validate_array($label)
-
-
-
   if $ensure == 'present'{
   $docker_secrets_flags = docker_secrets_flags ({
     ensure => $ensure,

manifests/services.pp

@@ -65,41 +65,27 @@
 #
 
 define docker::services(
-  $ensure       = 'present',
-  $create       = true,
-  $update       = false,
-  $scale        = false,
-  $detach       = true,
-  $tty          = false,
-  $env          = [],
-  $label        = [],
-  $extra_params = [],
-  $image        = undef,
-  $service_name = undef,
-  $publish      = undef,
-  $replicas     = undef,
-  $user         = undef,
-  $workdir      = undef,
-  $host_socket  = undef,
+  Optional[Pattern[/^present$|^absent$/]] $ensure        = 'present',
+  Optional[Boolean] $create                              = true,
+  Optional[Boolean] $update                              = false,
+  Optional[Boolean] $scale                               = false,
+  Optional[Boolean] $detach                              = true,
+  Optional[Boolean] $tty                                 = false,
+  Optional[Array] $env                                   = [],
+  Optional[Array] $label                                 = [],
+  Optional[Array] $extra_params                          = [],
+  Variant[String,Array,Undef] $image                     = undef,
+  Variant[String,Array,Undef] $service_name              = undef,
+  Variant[String,Array,Undef] $publish                   = undef,
+  Variant[String,Array,Undef] $replicas                  = undef,
+  Variant[String,Array,Undef] $user                      = undef,
+  Variant[String,Array,Undef] $workdir                   = undef,
+  Variant[String,Array,Undef] $host_socket               = undef,
 ){
 
   include docker::params
 
   $docker_command = "${docker::params::docker_command} service"
-  validate_re($ensure, '^(present|absent)$')
-  validate_string($docker_command)
-  validate_string($image)
-  validate_string($service_name)
-  validate_string($publish)
-  validate_string($replicas)
-  validate_string($user)
-  validate_string($workdir)
-  validate_string($host_socket)
-  validate_bool($detach)
-  validate_bool($tty)
-  validate_bool($create)
-  validate_bool($update)
-  validate_bool($scale)
 
   if $ensure == 'absent' {
     if $update {
@@ -189,4 +175,3 @@
     }
   }
 }
-