Moved container name sanitisation code to puppet function. (puppetlab…

…s#401)

Make sanitisation code available for external modules
so it can be reused when working with scripts and container names.

README.md

@@ -26,6 +26,7 @@
    * [Defined types](#definedtypes)
    * [Types](#types)
    * [Parameters](#parameters)
+   * [Functions](#functions)
 5. [Limitations - OS compatibility, etc.](#limitations)
 6. [Development - Guide for contributing to the module](#development)
 
@@ -1503,6 +1504,12 @@ Extends the pool by the specified percentage when the threshold is passed.
 
 For further explanation please refer to the[PE documentation](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html) or [Bolt documentation](https://puppet.com/docs/bolt/latest/bolt.html) on how to execute a task.
 
+### Functions
+
+#### `docker::sanitised_name`
+
+Sanitises string or array of strings for safe usage as container name inside scripts and commands.
+
 ## Limitations
 
 This module supports:

functions/sanitised_name.pp

@@ -0,0 +1,12 @@
+# == Function: docker::sanitised_name
+#
+# Function to sanitise container name.
+#
+# === Parameters
+#
+# [*name*]
+#   Name to sanitise
+#
+function docker::sanitised_name($name){
+  regsubst($name, '[^0-9A-Za-z.\-_]', '-', 'G')
+}

manifests/run.pp

@@ -211,19 +211,19 @@
     osfamily              => $::osfamily,
   })
 
-  $sanitised_title = regsubst($title, '[^0-9A-Za-z.\-_]', '-', 'G')
+  $sanitised_title = docker::sanitised_name($title)
   if empty($depends_array) {
     $sanitised_depends_array = []
   }
   else {
-    $sanitised_depends_array = regsubst($depends_array, '[^0-9A-Za-z.\-_]', '-', 'G')
+    $sanitised_depends_array = docker::sanitised_name($depends_array)
   }
 
   if empty($after_array) {
     $sanitised_after_array = []
   }
   else {
-    $sanitised_after_array = regsubst($after_array, '[^0-9A-Za-z.\-_]', '-', 'G')
+    $sanitised_after_array = docker::sanitised_name($after_array)
   }
 
   if $::osfamily == 'windows' {