Capture more HTTP snapshots

Author: prymitive

cmd/pint/main_test.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"bytes"
 	"context"
 	"crypto/rand"
 	"crypto/rsa"
@@ -9,18 +10,21 @@ import (
 	"encoding/pem"
 	"errors"
 	"fmt"
+	"io"
 	"math/big"
 	"net"
 	"net/http"
 	"os"
 	"path"
 	"regexp"
+	"slices"
 	"strconv"
 	"strings"
 	"sync"
 	"testing"
 	"time"
 
+	"github.com/itchyny/json2yaml"
 	"github.com/rogpeppe/go-internal/testscript"
 )
 
@@ -54,7 +58,6 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 	cmd := args[0]
 
 	switch cmd {
-	// http response name /200 200 OK
 	case "response":
 		if len(args) < 5 {
 			ts.Fatalf("! http response command requires '$NAME $PATH $CODE $BODY' args, got [%s]", strings.Join(args, " "))
@@ -64,9 +67,10 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 		code, err := strconv.Atoi(args[3])
 		ts.Check(err)
 		body := strings.Join(args[4:], " ")
-		mocks.add(name, httpMock{pattern: path, handler: func(w http.ResponseWriter, _ *http.Request) {
+		mocks.add(name, httpMock{pattern: path, handler: func(w http.ResponseWriter, r *http.Request) {
+			snapshotRequest(ts, r, name, path)
 			w.WriteHeader(code)
-			_, err := w.Write([]byte(body))
+			_, err = w.Write([]byte(body))
 			ts.Check(err)
 		}})
 	case "method":
@@ -79,7 +83,8 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 		code, err := strconv.Atoi(args[4])
 		ts.Check(err)
 		body := strings.Join(args[5:], " ")
-		mocks.add(name, httpMock{pattern: path, method: meth, handler: func(w http.ResponseWriter, _ *http.Request) {
+		mocks.add(name, httpMock{pattern: path, method: meth, handler: func(w http.ResponseWriter, r *http.Request) {
+			snapshotRequest(ts, r, name, path)
 			w.WriteHeader(code)
 			_, err := w.Write([]byte(body))
 			ts.Check(err)
@@ -99,6 +104,7 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 		mocks.add(name, httpMock{pattern: path, handler: func(w http.ResponseWriter, r *http.Request) {
 			username, password, ok := r.BasicAuth()
 			if ok && username == user && password == pass {
+				snapshotRequest(ts, r, name, path)
 				w.WriteHeader(code)
 				_, err := w.Write([]byte(body))
 				ts.Check(err)
@@ -118,7 +124,8 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 		code, err := strconv.Atoi(args[4])
 		ts.Check(err)
 		body := strings.Join(args[5:], " ")
-		mocks.add(name, httpMock{pattern: path, handler: func(w http.ResponseWriter, _ *http.Request) {
+		mocks.add(name, httpMock{pattern: path, handler: func(w http.ResponseWriter, r *http.Request) {
+			snapshotRequest(ts, r, name, path)
 			time.Sleep(delay)
 			w.WriteHeader(code)
 			_, err := w.Write([]byte(body))
@@ -132,7 +139,8 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 		name := args[1]
 		srcpath := regexp.MustCompile(args[2])
 		dstpath := args[3]
-		mocks.add(name, httpMock{pattern: srcpath, handler: func(w http.ResponseWriter, _ *http.Request) {
+		mocks.add(name, httpMock{pattern: srcpath, handler: func(w http.ResponseWriter, r *http.Request) {
+			snapshotRequest(ts, r, name, srcpath)
 			w.Header().Set("Location", dstpath)
 			w.WriteHeader(http.StatusFound)
 		}})
@@ -151,6 +159,7 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 			tlsKey = args[4]
 		}
 
+		var mtx sync.Mutex
 		mux := http.NewServeMux()
 		mux.Handle("/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			var done bool
@@ -163,8 +172,10 @@ func httpServer(ts *testscript.TestScript, _ bool, args []string) {
 						if !mock.pattern.MatchString(r.URL.Path) {
 							continue
 						}
+						mtx.Lock()
 						mock.handler(w, r)
 						done = true
+						mtx.Unlock()
 						break
 					}
 					break
@@ -331,3 +342,67 @@ func writeCert(ts *testscript.TestScript, dirname, filename string, block *pem.B
 
 	ts.Logf("Wrote PEM file to %s", filename)
 }
+
+func snapshotRequest(ts *testscript.TestScript, r *http.Request, name string, path *regexp.Regexp) {
+	payload, err := io.ReadAll(r.Body)
+	ts.Check(err)
+	r.Body.Close()
+
+	var buf strings.Builder
+	buf.WriteString(r.Method)
+	buf.WriteRune(' ')
+	buf.WriteString(path.String())
+	buf.WriteRune('\n')
+
+	hKeys := make([]string, 0, len(r.Header))
+	for k := range r.Header {
+		if k == "Content-Length" || k == "User-Agent" {
+			continue
+		}
+		hKeys = append(hKeys, k)
+	}
+	slices.Sort(hKeys)
+	for _, k := range hKeys {
+		buf.WriteString("  ")
+		buf.WriteString(k)
+		buf.WriteRune(':')
+		buf.WriteRune(' ')
+		buf.WriteString(strings.Join(r.Header.Values(k), ";"))
+		buf.WriteRune('\n')
+	}
+
+	if len(payload) > 0 {
+		payload = sanitizePayload(payload)
+		buf.WriteString("--- BODY ---\n")
+		buf.Write(payload)
+		if !bytes.HasSuffix(payload, []byte("\n")) {
+			buf.WriteRune('\n')
+		}
+		buf.WriteString("--- END ---\n")
+	}
+	buf.WriteRune('\n')
+
+	f, err := os.OpenFile(ts.MkAbs(name+".got"), os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0o644)
+	ts.Check(err)
+	_, err = f.WriteString(buf.String())
+	ts.Check(err)
+	ts.Check(f.Close())
+}
+
+func sanitizePayload(payload []byte) []byte {
+	bbDurationRe := regexp.MustCompile(`\{"value":([0-9]+),"title":"Checks duration","type":"DURATION"\}`)
+	payload = bbDurationRe.ReplaceAll(payload, []byte(`{"value":0,"title":"Checks duration","type":"DURATION"}`))
+
+	ghDurationRe := regexp.MustCompile(`\| Checks duration \| ([0-9]+[a-z]+) \|`)
+	payload = ghDurationRe.ReplaceAll(payload, []byte(`| Checks duration | 0 |`))
+
+	commitIDRe := regexp.MustCompile(`"commit_id":"([0-9a-zA-Z]{40})"`)
+	payload = commitIDRe.ReplaceAll(payload, []byte(`"commit_id":"<COMMIT ID>"`))
+
+	var output bytes.Buffer
+	if err := json2yaml.Convert(&output, bytes.NewReader(payload)); err != nil {
+		return payload
+	}
+
+	return output.Bytes()
+}

cmd/pint/tests/0031_ci_bitbucket.txt

@@ -22,10 +22,7 @@ exec git commit -am 'v2'
 env BITBUCKET_AUTH_TOKEN="12345"
 exec pint -l debug --no-color ci
 ! stdout .
-stderr 'msg="Sending a request to BitBucket" method=PUT'
-stderr 'msg="BitBucket request completed" status=200'
-stderr 'msg="Sending a request to BitBucket" method=DELETE'
-stderr 'msg="BitBucket request completed" status=200'
+cmp bitbucket.got ../bitbucket.expected
 
 -- src/v1.yml --
 - alert: rule1
@@ -56,3 +53,74 @@ repository {
     repository = "rules"
   }
 }
+
+-- bitbucket.expected --
+DELETE /rest/insights/1.0/projects/prometheus/repos/rules/commits/.*/reports/pint
+  Accept-Encoding: gzip
+  Authorization: Bearer "12345"
+  Content-Type: application/json
+
+PUT /rest/insights/1.0/projects/prometheus/repos/rules/commits/.*/reports/pint
+  Accept-Encoding: gzip
+  Authorization: Bearer "12345"
+  Content-Type: application/json
+--- BODY ---
+reporter: Prometheus rule linter
+title: pint unknown
+result: PASS
+details: |-
+  pint is a Prometheus rule linter/validator.
+  It will inspect all Prometheus recording and alerting rules for problems that could prevent these from working correctly.
+  Checks can be either offline (static checks using only rule definition) or online (validate rule against live Prometheus server).
+link: https://cloudflare.github.io/pint/
+data:
+  - value: 2
+    title: Number of rules parsed
+    type: NUMBER
+  - value: 2
+    title: Number of rules checked
+    type: NUMBER
+  - value: 2
+    title: Number of problems found
+    type: NUMBER
+  - value: 7
+    title: Number of offline checks
+    type: NUMBER
+  - value: 0
+    title: Number of online checks
+    type: NUMBER
+  - value: 0
+    title: Checks duration
+    type: DURATION
+--- END ---
+
+GET /rest/api/1.0/projects/prometheus/repos/rules/commits/.*/pull-requests
+  Accept-Encoding: gzip
+  Authorization: Bearer "12345"
+  Content-Type: application/json
+
+DELETE /rest/insights/1.0/projects/prometheus/repos/rules/commits/.*/reports/pint
+  Accept-Encoding: gzip
+  Authorization: Bearer "12345"
+  Content-Type: application/json
+
+POST /rest/insights/1.0/projects/prometheus/repos/rules/commits/.*/reports/pint
+  Accept-Encoding: gzip
+  Authorization: Bearer "12345"
+  Content-Type: application/json
+--- BODY ---
+annotations:
+  - path: rules.yml
+    message: "Problem reported on unmodified line 2, annotation moved here: alerts/comparison: always firing alert"
+    severity: LOW
+    type: CODE_SMELL
+    link: https://cloudflare.github.io/pint/checks/alerts/comparison.html
+    line: 3
+  - path: rules.yml
+    message: "alerts/for: redundant field with default value"
+    severity: LOW
+    type: CODE_SMELL
+    link: https://cloudflare.github.io/pint/checks/alerts/for.html
+    line: 3
+--- END ---
+