Sync eng/common directory with azure-sdk-tools repository for Tools PR Azure/azure-sdk-tools#903 (#14289)

Author: azure-sdk

eng/common/pipelines/templates/steps/verify-links.yml

@@ -14,5 +14,6 @@ steps:
       -rootUrl "file://$(Build.SourcesDirectory)/${{ parameters.Directory }}" 
       -recursive: $false 
       -ignoreLinksFile ${{ parameters.IgnoreLinksFile }}
-      -branchReplaceRegex "($env:SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI.*/blob/)master(/.*)"
+      -branchReplaceRegex "^($env:SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI.*/(?:blob|tree)/)master(/.*)$"
       -branchReplacementName $env:SYSTEM_PULLREQUEST_SOURCECOMMITID
+      -devOpsLogging: $true

eng/common/scripts/Verify-Links.ps1

@@ -14,7 +14,7 @@ param (
   # list of http status codes count as broken links. Defaults to 400, 401, 404, SocketError.HostNotFound = 11001, SocketError.NoData = 11004
   [array] $errorStatusCodes = @(400, 401, 404, 11001, 11004),
   # regex to check if the link needs to be replaced
-  [string] $branchReplaceRegex = "(https://github.com/.*/blob/)master(/.*)",
+  [string] $branchReplaceRegex = "^(https://github.com/.*/(?:blob|tree)/)master(/.*)$",
   # the substitute branch name or SHA commit
   [string] $branchReplacementName = "",
   # flag to allow checking against azure sdk link guidance.
@@ -62,6 +62,18 @@ function LogWarning
   }
 }
 
+function LogError
+{
+  if ($devOpsLogging)
+  {
+    Write-Host "##vso[task.logissue type=error]$args"
+  }
+  else
+  {
+    Write-Error "$args"
+  }
+}
+
 function ResolveUri ([System.Uri]$referralUri, [string]$link)
 {
   # If the link is mailto, skip it.
@@ -123,6 +135,9 @@ function ParseLinks([string]$baseUri, [string]$htmlContent)
 function CheckLink ([System.Uri]$linkUri)
 {
   if ($checkedLinks.ContainsKey($linkUri)) { 
+    if (!$checkedLinks[$linkUri]) {
+      LogWarning "broken link $linkUri"
+    }
     return $checkedLinks[$linkUri] 
   }
 
@@ -245,7 +260,6 @@ if ($PSVersionTable.PSVersion.Major -lt 6)
 {
   LogWarning "Some web requests will not work in versions of PS earlier then 6. You are running version $($PSVersionTable.PSVersion)."
 }
-$badLinks = @();
 $ignoreLinks = @();
 if (Test-Path $ignoreLinksFile)
 {
@@ -254,6 +268,7 @@ if (Test-Path $ignoreLinksFile)
 
 $checkedPages = @{};
 $checkedLinks = @{};
+$badLinks = @{};
 $pageUrisToCheck = new-object System.Collections.Queue
 
 foreach ($url in $urls) {
@@ -269,23 +284,38 @@ while ($pageUrisToCheck.Count -ne 0)
 
   $linkUris = GetLinks $pageUri
   Write-Host "Found $($linkUris.Count) links on page $pageUri";
-  
+  $badLinksPerPage = @();
   foreach ($linkUri in $linkUris) {
     $linkUri = ReplaceGithubLink $linkUri
-
     $isLinkValid = CheckLink $linkUri
-    if (!$isLinkValid) {
-      $script:badLinks += $linkUri
+    if (!$isLinkValid -and !$badLinksPerPage.Contains($linkUri)) {
+      $badLinksPerPage += $linkUri
     }
     if ($recursive -and $isLinkValid) {
       if ($linkUri.ToString().StartsWith($baseUrl) -and !$checkedPages.ContainsKey($linkUri)) {
         $pageUrisToCheck.Enqueue($linkUri);
       }
     }
   }
+  if ($badLinksPerPage.Count -gt 0) {
+    $badLinks[$pageUri] = $badLinksPerPage
+  }
 }
 
-Write-Host "Found $($checkedLinks.Count) links with $($badLinks.Count) broken"
-$badLinks | ForEach-Object { Write-Host "  $_" }
+if ($badLinks.Count -gt 0) {
+  Write-Host "Summary of broken links:"
+}
+foreach ($pageLink in $badLinks.Keys) {
+  Write-Host "'$pageLink' has $($badLinks[$pageLink].Count) broken link(s):"
+  foreach ($brokenLink in $badLinks[$pageLink]) {
+    Write-Host "  $brokenLink"
+  }
+}
 
+if ($badLinks.Count -gt 0) {
+  LogError "Found $($checkedLinks.Count) links with $($badLinks.Count) page(s) broken."
+} 
+else {
+  Write-Host "Found $($checkedLinks.Count) links. No broken links found."
+}
 exit $badLinks.Count