Set tokens to empty values if not set. (#48)

* Set tokens to empty values if not set. Fixes #24 * Add option for defining if empty values should be replaced.
openalm · Oct 21, 2016 · 09ccc04 · 09ccc04
1 parent 9165104
commit 09ccc04
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/Utilites/Tokenizer/task.json b/Utilites/Tokenizer/task.json
@@ -17,7 +17,13 @@
   },
   "demands": [
   ],
-
+  "groups": [
+    {
+      "name": "advanced",
+      "displayName": "Advanced",
+      "isExpanded": false
+    }
+  ],  
   "inputs": [
     {
       "name": "SourcePath",
@@ -42,6 +48,15 @@
       "defaultValue": "",
       "helpMarkDown": "Json file that contains environment specific settings in the form XPath, Attribute, Value and values for user-defined variables.",
       "required": false
+    },
+    {
+      "name": "ReplaceUndefinedValuesWithEmpty",
+      "type": "boolean",
+      "label": "Replace undefined values with empty",
+      "defaultValue": false,
+      "groupName": "advanced",
+      "helpMarkDown": "If set tokens will be set to an empty value if neither environment variable was set nor the value be found in the configuration. Otherwise the token will be skipped.",
+      "required": false
     }
   ],
   "instanceNameFormat": "Tokenizer: Transform Source filename",

diff --git a/Utilites/Tokenizer/tokenize-ps3.ps1 b/Utilites/Tokenizer/tokenize-ps3.ps1
@@ -108,7 +108,12 @@ try {
                         $variableValue = $Configuration.$environmentName.CustomVariables.$matchedItem
                         Write-Verbose "Found variable '$matchedItem' in configuration with value '$variableValue"
                     } else {
-                        Write-Host "No value found for token '$match'" 
+                        Write-Host "No value found for token '$match'"
+                        if ($ReplaceUndefinedValuesWithEmpty) {
+                            Write-Host "Setting '$match' to an empty value."
+                            # Explicitely set token to empty value if neither environment variable was set nor the value be found in the configuration.
+                            $variableValue = [string]::Empty                                          
+                        }
                     }             
                 }
             }

diff --git a/Utilites/Tokenizer/tokenize.ps1 b/Utilites/Tokenizer/tokenize.ps1
@@ -6,13 +6,16 @@ param
     #DestinationFile that will have the transformed $SourcePath, if empty then $SourcePath will be used as $DestinationPath
     [String] [Parameter(Mandatory = $false)] $DestinationPath,
     #ConfigurationJsonFile contains the environment specific configuration values, XPath key value pairs that will be used for XML documents passed as $SourcePath
-    [String] [Parameter(Mandatory = $false)] $ConfigurationJsonFile
+    [String] [Parameter(Mandatory = $false)] $ConfigurationJsonFile,
+    #Replace undefined values with empty
+    [Boolean] [Parameter(Mandatory = $false)] $ReplaceUndefinedValuesWithEmpty    
 )
 
 Write-Verbose "Entering script tokenize.ps1"
 Write-Verbose "SourcePath = $SourcePath"
 Write-Verbose "DestinationPath = $DestinationPath"
 Write-Verbose "ConfigurationJsonFile = $ConfigurationJsonFile"
+Write-Verbose "ReplaceUndefinedValuesWithEmpty = $ReplaceUndefinedValuesWithEmpty"
 
 . $PSScriptRoot\Helpers.ps1
 
@@ -98,7 +101,12 @@ ForEach ($match in $matches) {
               Write-Verbose "Found variable '$matchedItem' in configuration with value '$variableValue" 
           }
           else {
-              Write-Host "No value found for token '$match'"              
+              Write-Host "No value found for token '$match'"
+              if ($ReplaceUndefinedValuesWithEmpty) {
+                  Write-Host "Setting '$match' to an empty value."
+                  # Explicitely set token to empty value if neither environment variable was set nor the value be found in the configuration.
+                  $variableValue = [string]::Empty
+              }
           }
       }
   }