Sync eng/common directory with azure-sdk-tools for PR 1287

eng/common/pipelines/templates/steps/create-apireview.yml

@@ -0,0 +1,20 @@
+parameters:
+  ArtifactPath: $(Build.ArtifactStagingDirectory)
+  Artifacts: []
+
+steps:
+  - ${{ each artifact in parameters.Artifacts }}:
+    - task: Powershell@2
+      inputs:
+        filePath: $(Build.SourcesDirectory)/eng/common/scripts/Create-APIReview.ps1
+        arguments: >
+          -ArtifactPath ${{parameters.ArtifactPath}}
+          -APIViewUri $(azuresdk-apiview-uri)
+          -APIKey $(azuresdk-apiview-apikey)
+          -APILabel "Auto Review - $(Build.SourceVersion)"
+          -PackageName ${{artifact.name}}
+        pwsh: true
+        workingDirectory: $(Pipeline.Workspace)
+      displayName: Create API Review for ${{ artifact.name}}
+      condition: and(succeededOrFailed(), ne(variables['Skip.CreateApiReview'], 'true') , ne(variables['Build.Reason'],'PullRequest'), eq(variables['System.TeamProject'], 'internal'))
+      continueOnError: true

eng/common/scripts/Create-APIReview.ps1

@@ -0,0 +1,101 @@
+[CmdletBinding()]
+Param (
+  [Parameter(Mandatory=$True)]
+  [string] $ArtifactPath,
+  [Parameter(Mandatory=$True)]
+  [string] $APIViewUri,
+  [Parameter(Mandatory=$True)]
+  [string] $APIKey,
+  [Parameter(Mandatory=$True)]
+  [string] $APILabel,
+  [string] $PackageName = ""
+)
+
+
+# Submit API review request and return status whether current revision is approved or pending or failed to create review
+function Submit-APIReview($packagename, $filePath, $uri, $apiKey, $apiLabel)
+{
+    $multipartContent = [System.Net.Http.MultipartFormDataContent]::new()
+    $FileStream = [System.IO.FileStream]::new($filePath, [System.IO.FileMode]::Open)
+    $fileHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
+    $fileHeader.Name = "file"
+    $fileHeader.FileName = $packagename
+    $fileContent = [System.Net.Http.StreamContent]::new($FileStream)
+    $fileContent.Headers.ContentDisposition = $fileHeader
+    $fileContent.Headers.ContentType = [System.Net.Http.Headers.MediaTypeHeaderValue]::Parse("application/octet-stream")
+    $multipartContent.Add($fileContent)
+
+
+    $stringHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
+    $stringHeader.Name = "label"
+    $StringContent = [System.Net.Http.StringContent]::new($apiLabel)
+    $StringContent.Headers.ContentDisposition = $stringHeader
+    $multipartContent.Add($stringContent)
+
+    $headers = @{
+        "ApiKey" = $apiKey;
+        "content-type" = "multipart/form-data"
+    }
+
+    try
+    {
+        $Response = Invoke-WebRequest -Method 'POST' -Uri $uri -Body $multipartContent -Headers $headers
+        $StatusCode = $Response.StatusCode
+    }
+    catch
+    {
+        $StatusCode = $_.Exception.Response.StatusCode
+    }
+
+    return $StatusCode
+}
+
+
+. (Join-Path $PSScriptRoot common.ps1)
+$packages = @{}
+if ($FindArtifactForApiReviewFn -and (Test-Path "Function:$FindArtifactForApiReviewFn"))
+{
+    $packages = &$FindArtifactForApiReviewFn $ArtifactPath $PackageName
+}
+else
+{
+    Write-Host "Function 'FindArtifactForApiReviewFn' is not found"
+    exit(1)
+}
+
+$responses = @{}
+if ($packages)
+{
+    foreach($pkg in $packages.Keys)
+    {
+        Write-Host "Submitting API Review for package $($pkg)"
+        Write-Host $packages[$pkg]
+        $responses[$pkg] = Submit-APIReview -packagename $pkg -filePath $packages[$pkg] -uri $APIViewUri -apiKey $APIKey -apiLabel $APILabel
+    }
+}
+else
+{
+    Write-Host "No package is found in artifact path to submit review request"
+}
+
+$FoundFailure = $False
+foreach ($pkgName in $responses.Keys)
+{    
+    $respCode = $responses[$pkgName]
+    if ($respCode -ne '200')
+    {
+        $FoundFailure = $True
+        if ($respCode -eq '201')
+        {
+            Write-Host "API Review is pending for package $pkgName"
+        }
+        else
+        {
+            Write-Host "Failed to create API Review for package $pkgName"
+        }
+    }
+}
+if ($FoundFailure)
+{
+    Write-Host "Atleast one API review is not yet approved"
+}

eng/common/scripts/common.ps1

@@ -34,4 +34,5 @@ $GetPackageInfoFromRepoFn = "Get-${Language}-PackageInfoFromRepo"
 $GetPackageInfoFromPackageFileFn = "Get-${Language}-PackageInfoFromPackageFile"
 $PublishGithubIODocsFn = "Publish-${Language}-GithubIODocs"
 $UpdateDocCIFn = "Update-${Language}-CIConfig"
-$GetGithubIoDocIndexFn = "Get-${Language}-GithubIoDocIndex"
+$GetGithubIoDocIndexFn = "Get-${Language}-GithubIoDocIndex"
+$FindArtifactForApiReviewFn = "Find-${Language}-Artifacts-For-Apireview"