add proxy support to vsts-task-lib (#268)

Author: TingluoHuang

.gitignore

@@ -41,3 +41,7 @@ node/docs/vsotask.json
 
 # tests
 node/.taskKey
+
+# powershell compiled helper
+powershell/CompiledHelpers/bin
+powershell/CompiledHelpers/obj

node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vsts-task-lib",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "description": "VSTS Task SDK",
   "main": "./task.js",
   "typings": "./task.d.ts",

node/task.ts

@@ -1529,6 +1529,43 @@ export function findMatch(defaultRoot: string, patterns: string[] | string, find
     return finalResult;
 }
 
+//-----------------------------------------------------
+// Http Proxy Helper
+//-----------------------------------------------------
+
+export interface ProxyConfiguration {
+    proxyUrl: string;
+    proxyUsername?: string;
+    proxyPassword?: string;
+    proxyBypassHosts?: string[];
+}
+
+/**
+ * Gets http proxy configuration used by Build/Release agent
+ *
+ * @return  ProxyConfiguration
+ */
+export function getHttpProxyConfiguration(): ProxyConfiguration {
+    // min agent version that supports proxy
+    assertAgent('2.105.7');
+    let proxyUrl: string = getVariable('Agent.ProxyUrl');
+    if (proxyUrl && proxyUrl.length > 0) {
+        let proxyUsername: string = getVariable('Agent.ProxyUsername');
+        let proxyPassword: string = getVariable('Agent.ProxyPassword');
+        let proxyBypassHosts: string[] = JSON.parse(getVariable('Agent.ProxyBypassList') || '[]');
+
+        return {
+            proxyUrl: proxyUrl,
+            proxyUsername: proxyUsername,
+            proxyPassword: proxyPassword,
+            proxyBypassHosts: proxyBypassHosts
+        };
+    }
+    else {
+        return null;
+    }
+}
+
 //-----------------------------------------------------
 // Test Publisher
 //-----------------------------------------------------

powershell/CompiledHelpers/VstsTaskSdk.cs

@@ -1,12 +1,94 @@
 using System;
+using System.Collections.Generic;
+using System.Net;
 using System.Runtime.InteropServices;
+using System.Text.RegularExpressions;
 
 namespace VstsTaskSdk
 {
     public class TerminationException : Exception
     {
         public TerminationException(String message) : base(message) { }
     }
+
+    public sealed class VstsWebProxy : IWebProxy
+    {
+        private string _proxyAddress;
+        private readonly List<Regex> _regExBypassList = new List<Regex>();
+
+        public ICredentials Credentials { get; set; }
+
+        public VstsWebProxy(string proxyAddress, string proxyUsername, string proxyPassword, List<string> proxyBypassList)
+        {
+            _proxyAddress = proxyAddress?.Trim();
+
+            if (string.IsNullOrEmpty(proxyUsername) || string.IsNullOrEmpty(proxyPassword))
+            {
+                Credentials = CredentialCache.DefaultNetworkCredentials;
+            }
+            else
+            {
+                Credentials = new NetworkCredential(proxyUsername, proxyPassword);
+            }
+
+            if (proxyBypassList != null)
+            {
+                foreach (string bypass in proxyBypassList)
+                {
+                    if (string.IsNullOrWhiteSpace(bypass))
+                    {
+                        continue;
+                    }
+                    else
+                    {
+                        try
+                        {
+                            Regex bypassRegex = new Regex(bypass.Trim(), RegexOptions.IgnoreCase | RegexOptions.CultureInvariant | RegexOptions.ECMAScript);
+                            _regExBypassList.Add(bypassRegex);
+                        }
+                        catch (Exception)
+                        {
+                            // eat all exceptions
+                        }
+                    }
+                }
+            }
+        }
+
+        public Uri GetProxy(Uri destination)
+        {
+            if (IsBypassed(destination))
+            {
+                return destination;
+            }
+            else
+            {
+                return new Uri(_proxyAddress);
+            }
+        }
+
+        public bool IsBypassed(Uri uri)
+        {
+            return string.IsNullOrEmpty(_proxyAddress) || uri.IsLoopback || IsMatchInBypassList(uri);
+        }
+
+        private bool IsMatchInBypassList(Uri input)
+        {
+            string matchUriString = input.IsDefaultPort ?
+                input.Scheme + "://" + input.Host :
+                input.Scheme + "://" + input.Host + ":" + input.Port.ToString();
+
+            foreach (Regex r in _regExBypassList)
+            {
+                if (r.IsMatch(matchUriString))
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+    }
 }
 
 namespace VstsTaskSdk.FS

powershell/VstsTaskSdk/ServerOMFunctions.ps1

@@ -324,6 +324,9 @@ If not specified, defaults to the directory of the entry script for the task.
 # .PARAMETER VssCredentials
 # Credentials to use when intializing the HTTP client. If not specified, the default uses the agent job token to construct the credentials object. The identity associated with the token depends on the scope selected in the build/release definition (either the project collection build/release service identity, or the project build/release service identity).
 
+# .PARAMETER WebProxy
+# WebProxy to use when intializing the HTTP client. If not specified, the default uses the proxy configuration agent current has.
+
 .EXAMPLE
 $projectHttpClient = Get-VstsVssHttpClient -TypeName Microsoft.TeamFoundation.Core.WebApi.ProjectHttpClient
 $projectHttpClient.GetProjects().Result
@@ -338,7 +341,9 @@ function Get-VssHttpClient {
 
         [string]$Uri,
 
-        $VssCredentials)
+        $VssCredentials,
+        
+        $WebProxy = (Get-WebProxy))
 
     Trace-EnteringInvocation -InvocationInfo $MyInvocation
     $originalErrorActionPreference = $ErrorActionPreference
@@ -361,6 +366,9 @@ function Get-VssHttpClient {
         # Validate the type can be loaded.
         $null = Get-OMType -TypeName $TypeName -OMKind 'WebApi' -OMDirectory $OMDirectory -Require
 
+        # Update proxy setting for vss http client
+        [Microsoft.VisualStudio.Services.Common.VssHttpMessageHandler]::DefaultWebProxy = $WebProxy
+        
         # Try to construct the HTTP client.
         Write-Verbose "Constructing HTTP client."
         try {
@@ -421,6 +429,42 @@ function Get-VssHttpClient {
     }
 }
 
+<#
+.SYNOPSIS
+Gets a VstsTaskSdk.VstsWebProxy
+
+.DESCRIPTION
+Gets an instance of a VstsTaskSdk.VstsWebProxy that has same proxy configuration as Build/Release agent.
+
+VstsTaskSdk.VstsWebProxy implement System.Net.IWebProxy interface.
+
+.EXAMPLE
+$webProxy = Get-VstsWebProxy
+$webProxy.GetProxy(New-Object System.Uri("https://github.com/Microsoft/vsts-task-lib"))
+#>
+function Get-WebProxy {
+    [CmdletBinding()]
+    param()
+
+    Trace-EnteringInvocation -InvocationInfo $MyInvocation
+    try
+    {
+        # Min agent version that supports proxy
+        Assert-Agent -Minimum '2.105.7'
+
+        $proxyUrl = Get-TaskVariable -Name Agent.ProxyUrl
+        $proxyUserName = Get-TaskVariable -Name Agent.ProxyUserName
+        $proxyPassword = Get-TaskVariable -Name Agent.ProxyPassword
+        $proxyBypassListJson = Get-TaskVariable -Name Agent.ProxyBypassList
+        [string[]]$ProxyBypassList = ConvertFrom-Json -InputObject $ProxyBypassListJson
+        
+        return New-Object -TypeName VstsTaskSdk.VstsWebProxy -ArgumentList @($proxyUrl, $proxyUserName, $proxyPassword, $proxyBypassList)
+    }
+    finally {
+        Trace-LeavingInvocation -InvocationInfo $MyInvocation
+    }
+}
+
 ########################################
 # Private functions.
 ########################################

powershell/VstsTaskSdk/VstsTaskSdk.psm1

@@ -79,6 +79,8 @@ Export-ModuleMember -Function @(
         'Trace-EnteringInvocation'
         'Trace-LeavingInvocation'
         'Trace-Path'
+        # Proxy functions
+        'Get-WebProxy'
     )
 
 # Override Out-Default globally.

powershell/make.js

@@ -28,7 +28,7 @@ target.build = function() {
     var minimatchPackage = util.downloadArchive('https://www.nuget.org/api/v2/package/minimatch/1.1.0');
     util.cp(path.join(minimatchPackage, 'lib', 'portable-net40%2Bsl50%2Bwin%2Bwp80', 'Minimatch.dll'), path.join(buildPath, 'VstsTaskSdk'));
 
-    var compiledHelperPackage = util.downloadArchive('https://vstsagenttools.blob.core.windows.net/tools/VstsTaskSdkCompiledHelpers/VstsTaskSdk.zip');
+    var compiledHelperPackage = util.downloadArchive('https://vstsagenttools.blob.core.windows.net/tools/VstsTaskSdkCompiledHelpers/2/VstsTaskSdk.zip');
     util.cp(path.join(compiledHelperPackage, 'VstsTaskSdk.dll'), path.join(buildPath, 'VstsTaskSdk'));
 
     // stamp the version number from the package.json onto the PowerShell module definition