chore: setup gold pact for contract testing [IDE-296] (#55)

Author: teodora-sandu

.circleci/config.yml

@@ -31,9 +31,6 @@ jobs:
     executor: default
     steps:
       - checkout
-      - run:
-          name: Install tools
-          command: make tools
       - run:
           name: Run unit tests
           command: make test
@@ -50,13 +47,17 @@ jobs:
   contract_test:
     executor: default
     steps:
+      - setup_remote_docker
       - checkout
       - run:
           name: Install tools
           command: make tools
       - run:
           name: Run contract tests
           command: make contract-test
+      - run:
+          name: Publish contract
+          command: make publish-contract
   build:
     executor: default
     steps:
@@ -71,6 +72,7 @@ jobs:
       - prodsec/security_scans:
           mode: auto
           iac-scan: disabled
+
 # Orchestrate our job run sequence
 workflows:
   version: 2
@@ -94,11 +96,13 @@ workflows:
       - smoke_test:
           name: Smoke tests
           context:
-            - code-client-go-smoke-tests-token
+            - code-client-go-smoke-tests-token # SMOKE_TEST_TOKEN
           requires:
             - Unit tests
       - contract_test:
           name: Contract tests
+          context:
+            - code-client-go-contract-tests # PACT_BROKER_BASE_URL, PACT_BROKER_TOKEN
           requires:
             - Unit tests
       - build:

CONTRIBUTING.md

@@ -86,9 +86,9 @@ make contract-test
 These tests use `pact` and the name of each test should start with `TestPact`. The contracts end up in [https://snyk-dev.pactflow.io/](https://snyk-dev.pactflow.io/).
 
 If writing contract tests, use the test implementations in [./internal/util/testutil](./internal/util/testutil) and
-make sure that at the top of each file is the following line `//go:build CONTRACT`.
+make sure that at the top of each file is the following line `//go:build contract`.
 
-These tests are used then in the CI/CD as a gate for the PR.
+These tests are used then in the CI/CD as a gate for the PR and for the release process in `main`.
 
 ### Smoke tests
 
@@ -192,7 +192,13 @@ Do not hold onto your changes for too long. Commit and push frequently and creat
 We use a [GitHub Action](https://github.com/marketplace/actions/conventional-release-labels) to generate labels which are then used to generate the release notes when merging the PR.
 The title of the PR is what is used to generate the labels.
 
+The following steps run in the CI/CD of a PR and gate the merge:
+![](PR pipeline.jpg)
+
 ## Merging PRs
 
 We use a [GitHub Action](https://github.com/marketplace/actions/semver-conventional-commits) to compute the version based on conventional commit messages, push a tag with the computed version, then use
-the [GitHub Release CLI](https://cli.github.com/manual/gh_release_create) to generate release notes based on labels.
+the [GitHub Release CLI](https://cli.github.com/manual/gh_release_create) to generate release notes based on labels.
+
+The following steps run in the CI/CD of the `main` branch and gate the release:
+![](main pipeline.png)

Makefile

@@ -5,14 +5,17 @@ GOARCH = $(shell go env GOARCH)
 TOOLS_BIN := $(shell pwd)/.bin
 
 OVERRIDE_GOCI_LINT_V := v1.55.2
-SHELL:=env PATH=$(TOOLS_BIN)/go:$(PATH) $(SHELL)
+SHELL:=env PATH=$(TOOLS_BIN)/go:$(TOOLS_BIN)/pact/bin:$(PATH) $(SHELL)
 
 ## tools: Install required tooling.
 .PHONY: tools
 tools: $(TOOLS_BIN)/golangci-lint $(TOOLS_BIN)/go
 $(TOOLS_BIN)/golangci-lint:
 	@curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/$(OVERRIDE_GOCI_LINT_V)/install.sh | sh -s -- -b $(TOOLS_BIN)/ $(OVERRIDE_GOCI_LINT_V)
 
+$(TOOLS_BIN)/pact-broker:
+	@cd $(TOOLS_BIN); curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | PACT_CLI_VERSION=v2.4.4 bash; cd ../
+
 $(TOOLS_BIN)/go:
 	mkdir -p ${TOOLS_BIN}/go
 	@cat tools.go | grep _ | awk -F'"' '{print $$2}' | xargs -tI % sh -c 'GOBIN=${TOOLS_BIN}/go go install %'
@@ -44,24 +47,28 @@ clean:
 	@rm -rf $(TOOLS_BIN)
 
 .PHONY: test
-test: 
+test:
 	@echo "Testing..."
-	@go test -cover ./...
+	@go test -cover . ./...
 
 .PHONY: testv
-testv: 
+testv:
 	@echo "Testing verbosely..."
-	@go test -v
+	@go test -v . ./...
+
+.PHONY: smoke-test
+smoke-test:
+	@echo "Smoke testing..."
+	@go test -tags=smoke
 
 .PHONY: contract-test
 contract-test: $(TOOLS_BIN)
 	@echo "Contract testing..."
-	@go test -tags=CONTRACT ./...
+	@go test -tags=contract ./...
 
-.PHONY: smoke-test
-smoke-test:
-	@echo "Smoke testing..."
-	@go test -tags=SMOKE
+.PHONY: publish-contract
+publish-contract: $(TOOLS_BIN)/pact-broker
+	./scripts/publish-contract.sh
 
 .PHONY: generate
 generate:
@@ -106,5 +113,8 @@ help:
 	@echo "$(LOG_PREFIX) download-apis"
 	@echo "$(LOG_PREFIX) download-workspace-api"
 	@echo "$(LOG_PREFIX) download-orchestration-api"
+	@echo "$(LOG_PREFIX) contract-test
+	@echo "$(LOG_PREFIX) smoke-test
+	@echo "$(LOG_PREFIX) publish-contract
 	@echo "$(LOG_PREFIX) GOOS                       Specify Operating System to compile for (see golang GOOS, default=$(GOOS))"
 	@echo "$(LOG_PREFIX) GOARCH                     Specify Architecture to compile for (see golang GOARCH, default=$(GOARCH))"

PR pipeline.jpg

@@ -1,4 +1,4 @@
-//go:build CONTRACT
+//go:build contract
 
 /*
  * © 2022-2024 Snyk Limited
@@ -51,7 +51,7 @@ var (
 	pact *consumer.V2HTTPMockProvider
 )
 
-func TestSnykCodeClientPact(t *testing.T) {
+func TestPact_DeepcodeClient(t *testing.T) {
 	setupPact(t)
 
 	t.Run("Create bundle", func(t *testing.T) {

internal/deepcode/client_pact_test.go

@@ -1,4 +1,4 @@
-//go:build CONTRACT
+//go:build contract
 
 /*
  * © 2022-2024 Snyk Limited
@@ -23,6 +23,7 @@ import (
 	"fmt"
 	"net/http"
 	"testing"
+	"time"
 
 	"github.com/pact-foundation/pact-go/v2/consumer"
 	"github.com/pact-foundation/pact-go/v2/matchers"
@@ -42,7 +43,7 @@ import (
 const (
 	consumerName = "code-client-go"
 	pactDir      = "./pacts"
-	pactProvider = "OrchestrationApi"
+	pactProvider = "orchestration-service"
 
 	orgUUID       = "e7ea34c9-de0f-422c-bf2c-4654c2e2da90"
 	workspaceId   = "b6ea34c9-de0f-422c-bf2c-4654c2e2da90"
@@ -256,9 +257,13 @@ func setupPact(t *testing.T) {
 	errorReporter := testutil.NewTestErrorReporter()
 	httpClient = codeClientHTTP.NewHTTPClient(
 		func() *http.Client {
-			return http.DefaultClient
+			client := http.Client{
+				Timeout:   time.Duration(60) * time.Second,
+				Transport: testutil.TestAuthRoundTripper{http.DefaultTransport},
+			}
+			return &client
 		},
-		codeClientHTTP.WithRetryCount(3),
+		codeClientHTTP.WithRetryCount(1),
 		codeClientHTTP.WithInstrumentor(instrumentor),
 		codeClientHTTP.WithErrorReporter(errorReporter),
 		codeClientHTTP.WithLogger(&logger),

internal/orchestration/2024-02-16/client_pact_test.go

@@ -164,7 +164,7 @@
       "providerState": "Scan ID",
       "request": {
         "method": "GET",
-        "path": "/orgs/e7ea34c9-de0f-422c-bf2c-4654c2e2da90/scans/c4a998ce-be47-4bca-b470-6a1f88becdda",
+        "path": "/orgs/e7ea34c9-de0f-422c-bf2c-4654c2e2da90/scans/d1216ba2-d040-443c-bf3e-9c3cf16fa809",
         "query": "version=2024-02-16%7eexperimental"
       },
       "response": {
@@ -197,6 +197,6 @@
     }
   },
   "provider": {
-    "name": "OrchestrationApi"
+    "name": "orchestration-service"
   }
 }

internal/orchestration/2024-02-16/pacts/code-client-go-orchestrationapi.json renamed to internal/orchestration/2024-02-16/pacts/code-client-go-orchestration-service.json

@@ -0,0 +1,22 @@
+package testutil
+
+import (
+	"fmt"
+	"github.com/google/uuid"
+	"net/http"
+	"os"
+)
+
+type TestAuthRoundTripper struct {
+	http.RoundTripper
+}
+
+func (tart TestAuthRoundTripper) RoundTrip(req *http.Request) (res *http.Response, e error) {
+	token := os.Getenv("SMOKE_TEST_TOKEN")
+	if token == "" {
+		req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", uuid.New().String()))
+	} else {
+		req.Header.Set("Authorization", fmt.Sprintf("token %s", token))
+	}
+	return tart.RoundTripper.RoundTrip(req)
+}