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

documentation/MIGRATION_GUIDE.md

@@ -40,7 +40,7 @@ To the show the code snippets for the change:
 authorizer, err := adal.NewServicePrincipalToken(oAuthToken, "<ClientId>", "<ClientSecret>", endpoint)
 client := resources.NewGroupsClient("<SubscriptionId>")
 client.Authorizer = authorizer
-```        
+```
 
 **Equivalent in new version (`sdk/**/arm**`)**
 
@@ -54,7 +54,7 @@ For detailed information on the benefits of using the new authentication classes
 
 ### Error Handling
 
-There are some minor changes in the error handling. 
+There are some minor changes in the error handling.
 
 - When there is an error in the SDK request, in the old version (`services/**/mgmt/**`), the return value will all be non-nil, and you can get the raw HTTP response from the response value. In the new version (`sdk/**/arm**`), the first return value will be empty and you need to cast the error to `HTTPResponse` interface to get the raw HTTP response. When the request is successful and there is no error returned, you will need to get the raw HTTP response in `RawResponse` property of the first return value.
 
@@ -180,7 +180,7 @@ In new version (`sdk/**/arm**`), we use `(armcore.ConnectionOptions).PerCallPoli
 
 Similar to the customized policy, there are changes regarding how the custom HTTP client is configured as well. You can now use the `(armcore.ConnectionOptions).HTTPClient` option in `github.com/Azure/azure-sdk-for-go/sdk/armcore` module to use your own implementation of HTTP client and plug in what they need into the configuration.
 
-**In old version (`services/**/mgmt/**`)** 
+**In old version (`services/**/mgmt/**`)**
 ```go
 httpClient := NewYourOwnHTTPClient{}
 client := resources.NewGroupsClient("<SubscriptionId>")

eng/config.json

@@ -10,7 +10,7 @@
         },
         {
             "Name": "internal",
-            "CoverageGoal": 0.83
+            "CoverageGoal": 0.90
         }
     ]
 }

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

@@ -66,6 +66,7 @@ steps:
         GO111MODULE: 'on'
         AZURE_RECORD_MODE: 'playback'
         PROXY_CERT: $(Build.SourcesDirectory)/eng/common/testproxy/dotnet-devcert.crt
+        ${{ insert }}: ${{ parameters.EnvVars }}
 
     - pwsh: ../eng/scripts/create_coverage.ps1 ${{parameters.ServiceDirectory}}
       displayName: 'Generate Coverage XML'

sdk/internal/recording/recording.go

@@ -439,7 +439,7 @@ var modeMap = map[RecordMode]recorder.Mode{
 	Playback: recorder.ModeReplaying,
 }
 
-var recordMode, _ = os.LookupEnv("AZURE_RECORD_MODE")
+var recordMode = os.Getenv("AZURE_RECORD_MODE")
 
 const (
 	modeRecording      = "record"
@@ -451,7 +451,7 @@ const (
 	UpstreamUriHeader  = "x-recording-upstream-base-uri"
 )
 
-var recordingId string
+var recordingIds = map[string]string{}
 
 var tr = &http.Transport{
 	TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
@@ -466,10 +466,6 @@ type RecordingOptions struct {
 	Scheme   string
 }
 
-func resetRecordingId() {
-	recordingId = ""
-}
-
 func defaultOptions() *RecordingOptions {
 	return &RecordingOptions{
 		UseHTTPS: true,
@@ -486,20 +482,22 @@ func (r RecordingOptions) HostScheme() string {
 }
 
 func getTestId(pathToRecordings string, t *testing.T) string {
+	if strings.HasSuffix(pathToRecordings, "/") {
+		pathToRecordings = strings.TrimRight(pathToRecordings, "/")
+	}
 	return pathToRecordings + "/recordings/" + t.Name() + ".json"
 }
 
 func StartRecording(t *testing.T, pathToRecordings string, options *RecordingOptions) error {
 	if options == nil {
 		options = defaultOptions()
 	}
-	if recordMode == "" {
-		t.Log("AZURE_RECORD_MODE was not set, options are \"record\" or \"playback\". \nDefaulting to playback")
-		recordMode = "playback"
+	if !(recordMode == modeRecording || recordMode == modePlayback) {
+		return fmt.Errorf("AZURE_RECORD_MODE was not understood, options are \"record\" or \"playback\". Received: %v", recordMode)
 	}
 	testId := getTestId(pathToRecordings, t)
 
-	url := fmt.Sprintf("%v/%v/start", options.HostScheme(), recordMode)
+	url := fmt.Sprintf("%s/%s/start", options.HostScheme(), recordMode)
 
 	req, err := http.NewRequest("POST", url, nil)
 	if err != nil {
@@ -512,13 +510,19 @@ func StartRecording(t *testing.T, pathToRecordings string, options *RecordingOpt
 	if err != nil {
 		return err
 	}
-	recordingId = resp.Header.Get(IdHeader)
+	recId := resp.Header.Get(IdHeader)
+	if recId == "" {
+		b, err := ioutil.ReadAll(resp.Body)
+		if err != nil {
+			return err
+		}
+		return fmt.Errorf("Recording ID was not returned by the response. Response body: %s", b)
+	}
+	recordingIds[t.Name()] = recId
 	return nil
 }
 
 func StopRecording(t *testing.T, options *RecordingOptions) error {
-	defer resetRecordingId()
-
 	if options == nil {
 		options = defaultOptions()
 	}
@@ -528,10 +532,12 @@ func StopRecording(t *testing.T, options *RecordingOptions) error {
 	if err != nil {
 		return err
 	}
-	if recordingId == "" {
+	var recId string
+	var ok bool
+	if recId, ok = recordingIds[t.Name()]; !ok {
 		return errors.New("Recording ID was never set. Did you call StartRecording?")
 	}
-	req.Header.Set("x-recording-id", recordingId)
+	req.Header.Set("x-recording-id", recId)
 	_, err = client.Do(req)
 	if err != nil {
 		t.Errorf(err.Error())
@@ -591,58 +597,51 @@ func LiveOnly(t *testing.T) {
 
 // Function for sleeping during a test for `duration` seconds. This method will only execute when
 // AZURE_RECORD_MODE = "record", if a test is running in playback this will be a noop.
-func Sleep(duration int) {
+func Sleep(duration time.Duration) {
 	if GetRecordMode() == modeRecording {
-		time.Sleep(time.Duration(duration) * time.Second)
+		time.Sleep(duration)
 	}
 }
 
-func GetRecordingId() string {
-	return recordingId
+func GetRecordingId(t *testing.T) string {
+	return recordingIds[t.Name()]
 }
 
 func GetRecordMode() string {
 	return recordMode
 }
 
-func InPlayback() bool {
-	return GetRecordMode() == modePlayback
-}
-
-func InRecord() bool {
-	return GetRecordMode() == modeRecording
-}
-
-func getRootCas() (*x509.CertPool, error) {
+func getRootCas(t *testing.T) (*x509.CertPool, error) {
 	localFile, ok := os.LookupEnv("PROXY_CERT")
 
 	rootCAs, err := x509.SystemCertPool()
-	if err != nil {
+	if err != nil && strings.Contains(err.Error(), "system root pool is not available on Windows") {
 		rootCAs = x509.NewCertPool()
+	} else if err != nil {
+		return rootCAs, err
 	}
 
 	if !ok {
-		fmt.Println("Could not find path to proxy certificate, set the environment variable 'PROXY_CERT' to the location of your certificate")
+		t.Log("Could not find path to proxy certificate, set the environment variable 'PROXY_CERT' to the location of your certificate")
 		return rootCAs, nil
 	}
 
 	cert, err := ioutil.ReadFile(localFile)
 	if err != nil {
-		fmt.Println("error opening cert file")
 		return nil, err
 	}
 
 	if ok := rootCAs.AppendCertsFromPEM(cert); !ok {
-		fmt.Println("No certs appended, using system certs only")
+		t.Log("No certs appended, using system certs only")
 	}
 
 	return rootCAs, nil
 }
 
-func GetHTTPClient() (*http.Client, error) {
+func GetHTTPClient(t *testing.T) (*http.Client, error) {
 	transport := http.DefaultTransport.(*http.Transport).Clone()
 
-	rootCAs, err := getRootCas()
+	rootCAs, err := getRootCas(t)
 	if err != nil {
 		return nil, err
 	}