Added feature helpers (#1010)

* Add node tl feature helper

* Fix typescript err

* Update changelog

* Bump package version

* node: Format debug message

* powershell: Add Get-PipelineFeature

* powershell: Bump version to 0.19.0

* Reset InputFunctions encoding

node/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## 4.x
 
+### 4.9.0
+
+- Added internal feature helpers [#1010](https://github.com/microsoft/azure-pipelines-task-lib/pull/1010)
+
+### 4.8.0
+
+- Added `source` property for error/warning [#1009](https://github.com/microsoft/azure-pipelines-task-lib/pull/1009)
+
 ### 4.7.0
 
 Replaced mockery - [#989](https://github.com/microsoft/azure-pipelines-task-lib/pull/989)

node/mock-task.ts

@@ -62,6 +62,7 @@ module.exports.getInput = task.getInput;
 module.exports.getInputRequired = task.getInputRequired;
 module.exports.getBoolInput = task.getBoolInput;
 module.exports.getBoolFeatureFlag = task.getBoolFeatureFlag;
+module.exports.getPipelineFeature = task.getPipelineFeature;
 module.exports.getDelimitedInput = task.getDelimitedInput;
 module.exports.filePathSupplied = task.filePathSupplied;
 

node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-pipelines-task-lib",
-  "version": "4.8.2",
+  "version": "4.9.0",
   "description": "Azure Pipelines Task SDK",
   "main": "./task.js",
   "typings": "./task.d.ts",

node/task.ts

@@ -279,10 +279,11 @@ export function getBoolInput(name: string, required?: boolean): boolean {
 
 /**
  * Gets the value of an feature flag and converts to a bool.
- *
+ * @IMPORTANT This method is only for internal Microsoft development. Do not use it for external tasks.
  * @param     name     name of the feature flag to get.
  * @param     defaultValue default value of the feature flag in case it's not found in env. (optional. Default value = false)
  * @returns   boolean
+ * @deprecated Don't use this for new development. Use getPipelineFeature instead.
  */
 export function getBoolFeatureFlag(ffName: string, defaultValue: boolean = false): boolean {
     const ffValue = process.env[ffName];
@@ -297,6 +298,28 @@ export function getBoolFeatureFlag(ffName: string, defaultValue: boolean = false
     return ffValue.toLowerCase() === "true";
 }
 
+/**
+ * Gets the value of an task feature and converts to a bool.
+ * @IMPORTANT This method is only for internal Microsoft development. Do not use it for external tasks.
+ * @param     name     name of the feature to get.
+ * @returns   boolean
+ */
+export function getPipelineFeature(featureName: string): boolean {
+    const variableName = im._getVariableKey(`DistributedTask.Tasks.${featureName}`);
+    const featureValue = process.env[variableName];
+
+    if (!featureValue) {
+        debug(`Feature '${featureName}' not found. Returning false as default.`);
+        return false;
+    }
+
+    const boolValue = featureValue.toLowerCase() === "true";
+
+    debug(`Feature '${featureName}' = '${featureValue}'. Processed as '${boolValue}'.`);
+
+    return boolValue;
+}
+
 /**
  * Gets the value of an input and splits the value using a delimiter (space, comma, etc).
  * Empty values are removed.  This function is useful for splitting an input containing a simple
@@ -801,7 +824,7 @@ export function mkdirP(p: string): void {
     let testDir: string = p;
     while (true) {
         // validate the loop is not out of control
-        if (stack.length >= (process.env['TASKLIB_TEST_MKDIRP_FAILSAFE'] || 1000)) {
+        if (stack.length >= Number(process.env['TASKLIB_TEST_MKDIRP_FAILSAFE'] || 1000)) {
             // let the framework throw
             debug('loop is out of control');
             fs.mkdirSync(p);

node/test/inputtests.ts

@@ -1200,4 +1200,38 @@ describe('Input Tests', function () {
             assert.equal(ffValue, true);
         })
     });
+
+    describe('Pipeline features tests', () => {
+        it(`Should return if no feature variable present.`, () => {
+            const featureName = "TestFeature"
+            delete process.env[im._getVariableKey(`DistributedTask.Tasks.${featureName}`)];
+
+            const ffValue = tl.getPipelineFeature(featureName);
+
+            assert.deepStrictEqual(ffValue, false);
+        })
+
+        const testInputs = ([
+            ["true", true],
+            ["TRUE", true],
+            ["TruE", true],
+            ["false", false],
+            ["treu", false],
+            ["fasle", false],
+            ["On", false],
+            ["", false],
+            [undefined, false]
+        ] as [string, boolean][])
+        for (const [input, expected] of testInputs) {
+            it(`Should return '${expected}' if feature is '${input}'`, () => {
+                const featureVariable = "DISTRIBUTEDTASK_TASKS_TESTFEATURE";
+                const featureName = "TestFeature";
+                process.env[featureVariable] = input;
+
+                const result = tl.getPipelineFeature(featureName);
+
+                assert.deepStrictEqual(result, expected);
+            })
+        }
+    })
 });

powershell/Tests/L0/Get-PipelineFeature.InputsTest.ps1

@@ -0,0 +1,36 @@
+[CmdletBinding()]
+param()
+
+. $PSScriptRoot\..\lib\Initialize-Test.ps1
+
+$featureName = "TestFeature"
+$featureVariable = "DISTRIBUTEDTASK_TASKS_TESTFEATURE"
+
+Invoke-VstsTaskScript -ScriptBlock {
+    $testInputs = @(
+        @("true", $true),
+        @("TRUE", $true),
+        @("TruE", $true),
+        @("false", $false),
+        @("treu", $false),
+        @("fasle", $false),
+        @("On", $false),
+        @("", $false),
+        @($null, $false)
+    )
+    foreach ($testInput in $testInputs) {
+        $inputValue = $testInput[0]
+        $expectedValue = $testInput[1]
+
+        Set-Item -Path env:$featureVariable -Value $inputValue
+
+        $result = Get-VstsPipelineFeature -FeatureName $featureName
+
+        try {
+            Assert-AreEqual -Expected $expectedValue -Actual $result -Message "Suite failed. Input value: '$inputValue'"
+        }
+        finally {
+            ${env:$featureVariable} = ""
+        }
+    }
+}

powershell/VstsTaskSdk/InputFunctions.ps1

@@ -320,6 +320,37 @@ function Set-TaskVariable {
     Write-SetVariable -Name $Name -Value $Value -Secret:$Secret
 }
 
+<#
+.SYNOPSIS
+Gets the value of an task feature and converts to a bool.
+
+.PARAMETER $FeatureName
+Name of the feature to get.
+
+.NOTES
+This method is only for internal Microsoft development. Do not use it for external tasks.
+#>
+function Get-PipelineFeature {
+    [CmdletBinding(DefaultParameterSetName = 'Require')]
+    param(
+        [Parameter(Mandatory = $true)]
+        [string]$FeatureName
+    )
+
+    $featureValue = Get-TaskVariable -Name "DistributedTask.Tasks.$FeatureName"
+
+    if (!$featureValue) {
+        Write-Debug "Feature '$FeatureName' is not set. Defaulting to 'false'"
+        return $false
+    }
+
+    $boolValue = $featureValue.ToLowerInvariant() -eq 'true'
+
+    Write-Debug "Feature '$FeatureName' = '$featureValue'. Processed as '$boolValue'"
+
+    return $boolValue
+}
+
 ########################################
 # Private functions.
 ########################################

powershell/VstsTaskSdk/VstsTaskSdk.psm1

@@ -44,6 +44,7 @@ Export-ModuleMember -Function @(
         'Get-TaskVariable'
         'Get-TaskVariableInfo'
         'Set-TaskVariable'
+        'Get-PipelineFeature'
         # Legacy find functions.
         'Find-Files'
         # Localization functions.

powershell/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.18.2",
+  "version": "0.19.0",
   "private": true,
   "scripts": {
     "build": "node make.js build",