eng/common/SetupNugetSources.ps1

   1 # This file is a temporary workaround for internal builds to be able to restore from private AzDO feeds.
   2 # This file should be removed as part of this issue: https://github.com/dotnet/arcade/issues/4080
   3 #
   4 # What the script does is iterate over all package sources in the pointed NuGet.config and add a credential entry
   5 # under <packageSourceCredentials> for each Maestro managed private feed. Two additional credential
   6 # entries are also added for the two private static internal feeds: dotnet3-internal and dotnet3-internal-transport.
   7 #
   8 # This script needs to be called in every job that will restore packages and which the base repo has
   9 # private AzDO feeds in the NuGet.config.
  10 #
  11 # See example YAML call for this script below. Note the use of the variable `$(dn-bot-dnceng-artifact-feeds-rw)`
  12 # from the AzureDevOps-Artifact-Feeds-Pats variable group.
  13 #
  14 #  - task: PowerShell@2
  15 #    displayName: Setup Private Feeds Credentials
  16 #    condition: eq(variables['Agent.OS'], 'Windows_NT')
  17 #    inputs:
  18 #      filePath: $(Build.SourcesDirectory)/eng/common/SetupNugetSources.ps1
  19 #      arguments: -ConfigFile $(Build.SourcesDirectory)/NuGet.config -Password $Env:Token
  20 #    env:
  21 #      Token: $(dn-bot-dnceng-artifact-feeds-rw)
  22
  23 [CmdletBinding()]
  24 param (
  25     [Parameter(Mandatory = $true)][string]$ConfigFile,
  26     [Parameter(Mandatory = $true)][string]$Password
  27 )
  28
  29 $ErrorActionPreference = "Stop"
  30 Set-StrictMode -Version 2.0
  31 [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
  32
  33 . $PSScriptRoot\tools.ps1
  34
  35 # Add source entry to PackageSources
  36 function AddPackageSource($sources, $SourceName, $SourceEndPoint, $creds, $Username, $Password) {
  37     $packageSource = $sources.SelectSingleNode("add[@key='$SourceName']")
  38
  39     if ($packageSource -eq $null)
  40     {
  41         $packageSource = $doc.CreateElement("add")
  42         $packageSource.SetAttribute("key", $SourceName)
  43         $packageSource.SetAttribute("value", $SourceEndPoint)
  44         $sources.AppendChild($packageSource) | Out-Null
  45     }
  46     else {
  47         Write-Host "Package source $SourceName already present."
  48     }
  49
  50     AddCredential -Creds $creds -Source $SourceName -Username $Username -Password $Password
  51 }
  52
  53 # Add a credential node for the specified source
  54 function AddCredential($creds, $source, $username, $password) {
  55     # Looks for credential configuration for the given SourceName. Create it if none is found.
  56     $sourceElement = $creds.SelectSingleNode($Source)
  57     if ($sourceElement -eq $null)
  58     {
  59         $sourceElement = $doc.CreateElement($Source)
  60         $creds.AppendChild($sourceElement) | Out-Null
  61     }
  62
  63     # Add the <Username> node to the credential if none is found.
  64     $usernameElement = $sourceElement.SelectSingleNode("add[@key='Username']")
  65     if ($usernameElement -eq $null)
  66     {
  67         $usernameElement = $doc.CreateElement("add")
  68         $usernameElement.SetAttribute("key", "Username")
  69         $sourceElement.AppendChild($usernameElement) | Out-Null
  70     }
  71     $usernameElement.SetAttribute("value", $Username)
  72
  73     # Add the <ClearTextPassword> to the credential if none is found.
  74     # Add it as a clear text because there is no support for encrypted ones in non-windows .Net SDKs.
  75     #   -> https://github.com/NuGet/Home/issues/5526
  76     $passwordElement = $sourceElement.SelectSingleNode("add[@key='ClearTextPassword']")
  77     if ($passwordElement -eq $null)
  78     {
  79         $passwordElement = $doc.CreateElement("add")
  80         $passwordElement.SetAttribute("key", "ClearTextPassword")
  81         $sourceElement.AppendChild($passwordElement) | Out-Null
  82     }
  83     $passwordElement.SetAttribute("value", $Password)
  84 }
  85
  86 function InsertMaestroPrivateFeedCredentials($Sources, $Creds, $Password) {
  87     $maestroPrivateSources = $Sources.SelectNodes("add[contains(@key,'darc-int')]")
  88
  89     Write-Host "Inserting credentials for $($maestroPrivateSources.Count) Maestro's private feeds."
  90
  91     ForEach ($PackageSource in $maestroPrivateSources) {
  92         Write-Host "`tInserting credential for Maestro's feed:" $PackageSource.Key
  93         AddCredential -Creds $creds -Source $PackageSource.Key -Username $Username -Password $Password
  94     }
  95 }
  96
  97 if (!(Test-Path $ConfigFile -PathType Leaf)) {
  98   Write-PipelineTelemetryError -Category 'Build' -Message "Eng/common/SetupNugetSources.ps1 returned a non-zero exit code. Couldn't find the NuGet config file: $ConfigFile"
  99   ExitWithExitCode 1
 100 }
 101
 102 if (!$Password) {
 103     Write-PipelineTelemetryError -Category 'Build' -Message 'Eng/common/SetupNugetSources.ps1 returned a non-zero exit code. Please supply a valid PAT'
 104     ExitWithExitCode 1
 105 }
 106
 107 # Load NuGet.config
 108 $doc = New-Object System.Xml.XmlDocument
 109 $filename = (Get-Item $ConfigFile).FullName
 110 $doc.Load($filename)
 111
 112 # Get reference to <PackageSources> or create one if none exist already
 113 $sources = $doc.DocumentElement.SelectSingleNode("packageSources")
 114 if ($sources -eq $null) {
 115     $sources = $doc.CreateElement("packageSources")
 116     $doc.DocumentElement.AppendChild($sources) | Out-Null
 117 }
 118
 119 # Looks for a <PackageSourceCredentials> node. Create it if none is found.
 120 $creds = $doc.DocumentElement.SelectSingleNode("packageSourceCredentials")
 121 if ($creds -eq $null) {
 122     $creds = $doc.CreateElement("packageSourceCredentials")
 123     $doc.DocumentElement.AppendChild($creds) | Out-Null
 124 }
 125
 126 # Insert credential nodes for Maestro's private feeds
 127 InsertMaestroPrivateFeedCredentials -Sources $sources -Creds $creds -Password $Password
 128
 129 $dotnet3Source = $sources.SelectSingleNode("add[@key='dotnet3']")
 130 if ($dotnet3Source -ne $null) {
 131     AddPackageSource -Sources $sources -SourceName "dotnet3-internal" -SourceEndPoint "https://pkgs.dev.azure.com/dnceng/_packaging/dotnet3-internal/nuget/v2" -Creds $creds -Username "dn-bot" -Password $Password
 132     AddPackageSource -Sources $sources -SourceName "dotnet3-internal-transport" -SourceEndPoint "https://pkgs.dev.azure.com/dnceng/_packaging/dotnet3-internal-transport/nuget/v2" -Creds $creds -Username "dn-bot" -Password $Password
 133 }
 134
 135 $dotnet31Source = $sources.SelectSingleNode("add[@key='dotnet3.1']")
 136 if ($dotnet31Source -ne $null) {
 137     AddPackageSource -Sources $sources -SourceName "dotnet3.1-internal" -SourceEndPoint "https://pkgs.dev.azure.com/dnceng/_packaging/dotnet3.1-internal/nuget/v2" -Creds $creds -Username "dn-bot" -Password $Password
 138     AddPackageSource -Sources $sources -SourceName "dotnet3.1-internal-transport" -SourceEndPoint "https://pkgs.dev.azure.com/dnceng/_packaging/dotnet3.1-internal-transport/nuget/v2" -Creds $creds -Username "dn-bot" -Password $Password
 139 }
 140
 141 $doc.Save($filename)