[Internal] Add methods for configuring tests to work with test proxy

eng/pipelines/templates/steps/build-test.yml

@@ -4,67 +4,95 @@ parameters:
   Scope: 'sdk/...'
   Image: ''
   GoVersion: ''
-  RunTests: false
+  AzureRecordMode: 'playback'
 
 steps:
 
-  - pwsh: ./eng/scripts/build.ps1
+  - pwsh: |
+      go get github.com/jstemmer/go-junit-report
+      go get github.com/axw/gocov/gocov
+      go get github.com/AlekSi/gocov-xml
+      go get github.com/matm/gocov-html
+      go get -u github.com/wadey/gocovmerge
+    displayName: "Install Coverage and Junit Dependencies"
+    workingDirectory: '${{parameters.GoWorkspace}}'
+
+  - pwsh: |
+      $modDirs = (./eng/scripts/get_module_dirs.ps1 -serviceDir $(SCOPE))
+      foreach ($md in $modDirs) {
+        pushd $md
+        Write-Host "##[command]Executing go build -v ./... in $md"
+        go build -v ./...
+      }
     displayName: 'Build'
     workingDirectory: '${{parameters.GoWorkspace}}'
     env:
       GO111MODULE: 'on'
 
-  - pwsh: ./eng/scripts/build.ps1 -vet -skipBuild
+  - pwsh: |
+      $modDirs = (./eng/scripts/get_module_dirs.ps1 -serviceDir $(SCOPE))
+      foreach ($md in $modDirs) {
+        pushd $md
+        Write-Host "##[command]Executing go vet ./... in $md"
+        go vet ./...
+      }
     displayName: 'Vet'
     workingDirectory: '${{parameters.GoWorkspace}}'
     env:
       GO111MODULE: 'on'
 
-  - ${{ if eq(parameters.RunTests, 'true') }}:
-    - pwsh: |
-        go get github.com/jstemmer/go-junit-report
-        go get github.com/axw/gocov/gocov
-        go get github.com/AlekSi/gocov-xml
-        go get github.com/matm/gocov-html
-        go get -u github.com/wadey/gocovmerge
-      displayName: "Install Coverage and Junit Dependencies"
-      workingDirectory: '${{parameters.GoWorkspace}}'
+  - template: configure-proxy.yml
+    parameters:
+      ServiceDirectory: ${{ parameters.ServiceDirectory }}
 
-    - pwsh: |
-        $testDirs = (./eng/scripts/get_test_dirs.ps1 -serviceDir $(SCOPE))
-        foreach ($td in $testDirs) {
-          pushd $td
-          Write-Host "##[command]Executing 'go test -run "^Test" -v -coverprofile coverage.txt .' in $td"
-          go test -run "^Test" -v -coverprofile coverage.txt . | Tee-Object -FilePath outfile.txt
-          if ($LASTEXITCODE) { exit $LASTEXITCODE }
-          cat outfile.txt | go-junit-report > report.xml
-          # if no tests were actually run (e.g. examples) delete the coverage file so it's omitted from the coverage report
-          if (Select-String -path ./report.xml -pattern '<testsuites></testsuites>' -simplematch -quiet) {
-            Write-Host "##[command]Deleting empty coverage file"
-            rm coverage.txt
-          }
+  - pwsh: |
+      $testDirs = (./eng/scripts/get_test_dirs.ps1 -serviceDir $(SCOPE))
+      foreach ($td in $testDirs) {
+        pushd $td
+        $(Build.SourcesDirectory)/eng/scripts/proxy-server.ps1 start
+        Write-Host "##[command]Executing 'go test -run "^Test" -v -coverprofile coverage.txt .' in $td"
+        go test -run "^Test" -v -coverprofile coverage.txt . | Tee-Object -FilePath outfile.txt
+        if ($LASTEXITCODE) { exit $LASTEXITCODE }
+        cat outfile.txt | go-junit-report > report.xml
+        # if no tests were actually run (e.g. examples) delete the coverage file so it's omitted from the coverage report
+        if (Select-String -path ./report.xml -pattern '<testsuites></testsuites>' -simplematch -quiet) {
+          Write-Host "##[command]Deleting empty coverage file"
+          rm coverage.txt
         }
-      displayName: 'Run Tests'
-      workingDirectory: '${{parameters.GoWorkspace}}'
-      env:
-        GO111MODULE: 'on'
-
-    - pwsh: ../eng/scripts/create_coverage.ps1 ${{parameters.ServiceDirectory}}
-      displayName: 'Generate Coverage XML'
-      workingDirectory: '${{parameters.GoWorkspace}}sdk'
+      }
+      $(Build.SourcesDirectory)/eng/scripts/proxy-server.ps1 stop
+    displayName: 'Run Tests'
+    workingDirectory: '${{parameters.GoWorkspace}}'
+    env:
+      GO111MODULE: 'on'
+      AZURE_RECORD_MODE: '${{parameters.AzureRecordMode}}'
 
-    - task: PublishTestResults@2
-      condition: succeededOrFailed()
-      inputs:
-        testRunner: JUnit
-        testResultsFiles: '${{parameters.GoWorkspace}}sdk/**/report.xml'
-        testRunTitle: 'Go ${{ parameters.GoVersion }} on ${{ parameters.Image }}'
-        failTaskOnFailedTests: true
+  - pwsh: |
+      $coverageFiles = [Collections.Generic.List[String]]@()
+      Get-ChildItem -recurse -path $(SCOPE) -filter coverage.txt | foreach-object {
+        $covFile = $_.FullName
+        Write-Host "Adding $covFile to the list of code coverage files"
+        $coverageFiles.Add($covFile)
+      }
+      gocovmerge $coverageFiles > mergedCoverage.txt
+      gocov convert ./mergedCoverage.txt > ./coverage.json
+      # gocov converts rely on standard input
+      Get-Content ./coverage.json | gocov-xml > ./coverage.xml
+      Get-Content ./coverage.json | gocov-html > ./coverage.html
+    displayName: 'Generate Coverage XML'
+    workingDirectory: '${{parameters.GoWorkspace}}sdk'
+  - task: PublishTestResults@2
+    condition: succeededOrFailed()
+    inputs:
+      testRunner: JUnit
+      testResultsFiles: '${{parameters.GoWorkspace}}sdk/**/report.xml'
+      testRunTitle: 'Go ${{ parameters.GoVersion }} on ${{ parameters.Image }}'
+      failTaskOnFailedTests: true
 
-    - task: PublishCodeCoverageResults@1
-      condition: succeededOrFailed()
-      inputs:
-        codeCoverageTool: Cobertura
-        summaryFileLocation: '${{parameters.GoWorkspace}}sdk/coverage.xml'
-        additionalCodeCoverageFiles: '${{parameters.GoWorkspace}}sdk/coverage.html'
-        failIfCoverageEmpty: true
+  - task: PublishCodeCoverageResults@1
+    condition: succeededOrFailed()
+    inputs:
+      codeCoverageTool: Cobertura
+      summaryFileLocation: '${{parameters.GoWorkspace}}sdk/coverage.xml'
+      additionalCodeCoverageFiles: '${{parameters.GoWorkspace}}sdk/coverage.html'
+      failIfCoverageEmpty: true

eng/pipelines/templates/steps/configure-proxy.yml

@@ -0,0 +1,18 @@
+parameters:
+  ServiceDirectory: ''
+
+steps:
+  - pwsh: |
+        $certUriPfx = "https://github.com/Azure/azure-sdk-tools/raw/main/tools/test-proxy/docker/dev_certificate/dotnet-devcert.pfx"
+        $certUriCrt = "https://github.com/Azure/azure-sdk-tools/raw/main/tools/test-proxy/docker/dev_certificate/dotnet-devcert.crt"
+        $certLocationPfx = "$(Build.SourcesDirectory)/dotnet-devcert.pfx"
+        $certLocationCrt = "$(Build.SourcesDirectory)/dotnet-devcert.crt"
+        Invoke-WebRequest `
+            -Uri $certUriPfx `
+            -OutFile $certLocationPfx -UseBasicParsing
+        Invoke-WebRequest `
+            -Uri $certUriCrt `
+            -OutFile $certLocationCrt -UseBasicParsing
+        dotnet dev-certs https --clean --import $certLocationPfx -p "password"
+        Write-Host "##vso[task.setvariable variable=PROXY_CERT]$certLocationCrt"
+    displayName: 'Download and Trust Certificate'

eng/scripts/proxy-server.ps1

@@ -0,0 +1,66 @@
+param(
+    [ValidateSet("start", "stop")]
+    [String]
+    $mode,
+    [String]
+    $targetFolder = "."
+)
+
+try {
+    docker --version | Out-Null
+}
+catch {
+    Write-Error "A invocation of docker --version failed. This indicates that docker is not properly installed or running."
+    Write-Error "Please check your docker invocation and try running the script again."
+}
+
+$repoRoot = (Resolve-Path $targetFolder).Path.Replace("`\", "/")
+Write-Host $repoRoot
+
+$CONTAINER_NAME = "ambitious_azsdk_test_proxy"
+$IMAGE_SOURCE = "azsdkengsys.azurecr.io/engsys/testproxy-lin:1037115"
+$Initial = ""
+
+if ($IsWindows -and $env:TF_BUILD){
+    $IMAGE_SOURCE = "azsdkengsys.azurecr.io/engsys/testproxy-win:1037115"
+    $Initial = "C:"
+}
+
+function Get-Proxy-Container(){
+    return (docker container ls -a --format "{{ json . }}" --filter "name=$CONTAINER_NAME" `
+                | ConvertFrom-Json `
+                | Select-Object -First 1)
+}
+
+if ($mode -eq "start"){
+    $proxyContainer = Get-Proxy-Container
+
+    # if we already have one, we just need to check the state
+    if($proxyContainer){
+        if ($proxyContainer.State -eq "running")
+        {
+            Write-Host "Discovered an already running instance of the test-proxy!. Exiting"
+            exit(0)
+        }
+    }
+    # else we need to create it
+    else {
+        Write-Host "Attempting creation of Docker host $CONTAINER_NAME"
+        Write-Host "docker container create -v `"${repoRoot}:${Initial}/etc/testproxy`" -p 5001:5001 -p 5000:5000 --name $CONTAINER_NAME $IMAGE_SOURCE"
+        docker container create -v "${repoRoot}:${Initial}/etc/testproxy" -p 5001:5001 -p 5000:5000 --name $CONTAINER_NAME $IMAGE_SOURCE
+    }
+
+    Write-Host "Attempting start of Docker host $CONTAINER_NAME"
+    docker container start $CONTAINER_NAME
+}
+
+if ($mode -eq "stop"){
+    $proxyContainer = Get-Proxy-Container
+
+    if($proxyContainer){
+        if($proxyContainer.State -eq "running"){
+            Write-Host "Found a running instance of $CONTAINER_NAME, shutting it down."
+            docker container stop $CONTAINER_NAME
+        }
+    }
+}

sdk/azcore/example_test.go

@@ -49,13 +49,13 @@ func ExampleRequest_SetBody() {
 }
 
 // false positive by linter
-func ExampleLogger_SetClassifications() { //nolint:govet
+func ExampleSetClassifications() { //nolint:govet
 	// only log HTTP requests and responses
 	azcore.SetClassifications(azcore.LogRequest, azcore.LogResponse)
 }
 
 // false positive by linter
-func ExampleLogger_SetListener() { //nolint:govet
+func ExampleSetListener() { //nolint:govet
 	// a simple logger that writes to stdout
 	azcore.SetListener(func(cls azcore.LogClassification, msg string) {
 		fmt.Printf("%s: %s\n", cls, msg)