[TT-1842] [TT-1608] Parrot Server

.github/workflows/framework-golden-tests.yml

@@ -81,9 +81,9 @@ jobs:
               - 'framework/**'
               - '.github/workflows/framework-golden-tests.yml'
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.22.8
+          go-version: 1.23
       - name: Cache Go modules
         uses: actions/cache@v3
         with:

.github/workflows/framework.yml

@@ -36,9 +36,9 @@ jobs:
             src:
               - 'framework/**'
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.22.8
+          go-version: 1.23
       - name: Cache Go modules
         uses: actions/cache@v4
         with:

.github/workflows/lint.yaml

@@ -76,6 +76,8 @@ jobs:
             path: ./tools/asciitable/
           - name: workflowresultparser
             path: ./tools/workflowresultparser/
+          - name: parrot
+            path: ./parrot/
     steps:
       - name: Check out Code
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1

.github/workflows/parrotserver-release.yml

@@ -0,0 +1,33 @@
+name: Parrotserver Release
+
+on:
+  push:
+    tags:
+      - parrotserver/v*
+
+jobs:
+  release:
+    name: Build and Release
+    runs-on: ubuntu-latest
+    environment: integration
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@e3dd6a429d7300a6a4c196c26e071d42e0343502 # v4.0.2
+        with:
+          aws-region: ${{ secrets.QA_AWS_REGION }}
+          role-to-assume: ${{ secrets.QA_AWS_ROLE_TO_ASSUME }}
+          role-duration-seconds: 600
+      - name: Login to Amazon ECR
+        uses: aws-actions/amazon-ecr-login@062b18b96a7aff071d4dc91bc00c4c1a7945b076 # v2.0.1
+        with:
+          mask-password: 'true'
+        env:
+          AWS_REGION: ${{ secrets.QA_AWS_REGION }}
+      - name: Build and release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          IMAGE_PREFIX: ${{ secrets.QA_AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.QA_AWS_REGION }}.amazonaws.com/parrotserver
+          IMAGE_TAG: ${{ github.ref_name}}
+        run: goreleaser release --clean -f ./parrotserver/.goreleaser.yml

.github/workflows/rc-breaking-changes.yaml

@@ -16,10 +16,10 @@ jobs:
         with:
           fetch-depth: 0
           fetch-tags: true
-      - name: Set up Go 1.23.3
+      - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.23.3'
+          go-version: 1.23
       - name: Install gorelease tool
         run: |
           go install golang.org/x/exp/cmd/gorelease@latest

.github/workflows/release-go-module.yml

@@ -40,7 +40,7 @@
           echo "VERSION=$VERSION" >> "$GITHUB_ENV"
       - name: Find Last Tag for Package and Generate Release Notes
         id: generate_release_notes
         run: |
           # Find the latest tag for the same package that is not the current tag
           LAST_TAG=$(git describe --abbrev=0 --always --match "$PACKAGE_NAME/v*" --tags $(git rev-list --tags --skip=1 --max-count=1))
           echo "Last tag: ${LAST_TAG}"
@@ -69,14 +69,14 @@
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.23.3'
+          go-version: 1.23
       - name: Install gorelease tool
         run: |
           go install golang.org/x/exp/cmd/gorelease@latest
       - name: Run gorelease to check for breaking changes
         working-directory: ${{ env.PACKAGE_NAME }}
         id: check_breaking_changes
         run: |
           set +e  # Disable exit on error to capture output even if the command fails
           echo "Last tag version: ${{ env.LAST_TAG_VERSION }}"
           echo "Current tag version: ${VERSION}"
@@ -90,7 +90,7 @@
         if: always()
         working-directory: ${{ env.PACKAGE_NAME }}
         id: read_additional_notes
         run: |
           # Check if the .changeset directory exists and the file for the current version is present
           if [ -f ".changeset/${{ env.VERSION }}.md" ]; then
             # Read the content of the file
@@ -127,7 +127,7 @@
             echo "CMD_ENTRYPOINT_EXISTS=false" >> "$GITHUB_ENV"
           fi
       - name: Set binary name based on PACKAGE_NAME
         run: |
           if [ "${{ env.PACKAGE_NAME }}" == "framework" ]; then
             echo "BINARY_NAME=ctf" >> $GITHUB_ENV
           else

.github/workflows/test.yaml

@@ -26,6 +26,8 @@ jobs:
             path: ./tools/flakeguard/            
           - name: workflowresultparser
             path: ./tools/workflowresultparser/
+          - name: parrot
+            path: ./parrot/
     runs-on: ubuntu-latest
     name: ${{ matrix.project.name }} unit tests
     steps:

.gitignore

@@ -77,4 +77,7 @@ __debug*
 .tool-versions
 
 import_keys_test.go
-tag.py
+tag.py
+
+parrot/*.json
+parrot/*.log

parrot/.dockerignore

@@ -0,0 +1,13 @@
+Dockerfile
+*.md
+*.log
+.gitignore
+.golangci-lint.yml
+.goreleaser.yml
+.pre-commit-config.yaml
+*_test.go
+LICENSE
+.vscode/
+dist/
+.github/
+save.json

parrot/.goreleaser.yaml

@@ -0,0 +1,58 @@
+# yaml-language-server: $schema=https://goreleaser.com/static/schema-pro.json
+version: 1
+project_name: parrotserver
+
+monorepo:
+  tag_prefix: parrotserver/
+  dir: parrotserver
+
+env:
+  - IMG_PRE={{ if index .Env "IMAGE_PREFIX"  }}{{ .Env.IMAGE_PREFIX }}{{ else }}local{{ end }}
+  - TAG={{ if index .Env "IMAGE_TAG" }}{{ .Env.IMAGE_TAG }}{{ else }}latest{{ end }}
+
+# Build settings for binaries
+builds:
+  - id: parrotserver
+    goos:
+      - linux
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+    ldflags:
+      - '-s -w'
+
+archives:
+  - format: binary
+
+dockers:
+  - id: linux-amd64-parrotserver
+    goos: linux
+    goarch: amd64
+    image_templates:
+      - '{{ .Env.IMG_PRE }}/parrotserver:{{ .Tag }}'
+      - '{{ .Env.IMG_PRE }}/parrotserver:latest'
+    build_flag_templates:
+      - --platform=linux/amd64
+      - --pull
+      - --label=org.opencontainers.image.created={{.Date}}
+      - --label=org.opencontainers.image.title={{.ProjectName}}
+      - --label=org.opencontainers.image.revision={{.FullCommit}}
+      - --label=org.opencontainers.image.version={{.Version}}
+  - id: linux-arm64-parrotserver
+    goos: linux
+    goarch: arm64
+    image_templates:
+      - '{{ .Env.IMG_PRE }}/parrotserver:{{ .Tag }}-arm64'
+      - '{{ .Env.IMG_PRE }}/parrotserver:latest-arm64'
+    build_flag_templates:
+      - --platform=linux/arm64
+      - --pull
+      - --label=org.opencontainers.image.created={{.Date}}
+      - --label=org.opencontainers.image.title={{.ProjectName}}
+      - --label=org.opencontainers.image.revision={{.FullCommit}}
+      - --label=org.opencontainers.image.version={{.Version}}
+
+before:
+  hooks:
+    - cd parrotserver && go mod tidy

parrot/Dockerfile

@@ -0,0 +1,3 @@
+FROM scratch
+COPY parrotserver /parrotserver
+ENTRYPOINT [ "parrotserver" ]

parrot/Makefile

@@ -0,0 +1,29 @@
+# Default test log level (can be overridden)
+PARROT_TEST_LOG_LEVEL ?= ""
+
+# Pass TEST_LOG_LEVEL as a flag to go test
+TEST_ARGS ?= -testLogLevel=$(PARROT_TEST_LOG_LEVEL)
+
+.PHONY: lint
+lint:
+	golangci-lint --color=always run ./... --fix -v
+
+.PHONY: test
+test:
+	go install github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest
+	set -euo pipefail
+	go test $(TEST_ARGS) -json -cover -coverprofile cover.out -v ./... 2>&1 | tee /tmp/gotest.log | gotestfmt
+
+.PHONY: test_race
+test_race:
+	go install github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest
+	set -euo pipefail
+	go test $(TEST_ARGS) -json -cover -count=1 -race -coverprofile cover.out -v ./... 2>&1 | tee /tmp/gotest.log | gotestfmt
+
+.PHONY: test_unit
+test_unit:
+	go test $(TEST_ARGS) -coverprofile cover.out ./...
+
+.PHONY: bench
+bench:
+	go test $(TEST_ARGS) -bench=. -run=^$$ ./...

parrot/README.md

@@ -0,0 +1,19 @@
+# Parrot Server
+
+A simple, high-performing mockserver that can dynamically build new routes with customized responses, parroting back whatever you tell it to.
+
+## Run
+
+```sh
+go run ./cmd
+go run ./cmd -h # See all config options 
+```
+
+## Test
+
+```sh
+make test
+make test PARROT_TEST_LOG_LEVEL=trace # Set log level for tests
+make test_race # Test with -race flag enabled
+make bench # Benchmark
+```

parrot/cmd/main.go

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"context"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+	"github.com/smartcontractkit/chainlink-testing-framework/parrot"
+	"github.com/spf13/cobra"
+)
+
+func main() {
+	var (
+		port      int
+		debug     bool
+		trace     bool
+		silent    bool
+		json      bool
+		recorders []string
+	)
+
+	rootCmd := &cobra.Command{
+		Use:   "parrot",
+		Short: "A server that can register and parrot back dynamic requests",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			options := []parrot.ServerOption{parrot.WithPort(port)}
+			logLevel := zerolog.InfoLevel
+			if debug {
+				logLevel = zerolog.DebugLevel
+			}
+			if trace {
+				logLevel = zerolog.TraceLevel
+			}
+			if silent {
+				logLevel = zerolog.Disabled
+			}
+			options = append(options, parrot.WithLogLevel(logLevel))
+			if json {
+				options = append(options, parrot.WithJSONLogs())
+			}
+
+			ctx, cancel := context.WithCancel(context.Background())
+			defer cancel()
+
+			p, err := parrot.Wake(options...)
+			if err != nil {
+				return err
+			}
+
+			for _, r := range recorders {
+				err = p.Record(r)
+				if err != nil {
+					return err
+				}
+			}
+
+			c := make(chan os.Signal, 1)
+			signal.Notify(c, os.Interrupt, syscall.SIGTERM)
+			<-c
+			err = p.Shutdown(ctx)
+			if err != nil {
+				log.Error().Err(err).Msg("error shutting down server")
+			}
+			return nil
+		},
+	}
+
+	rootCmd.Flags().IntVarP(&port, "port", "p", 0, "Port to run the parrot on")
+	rootCmd.Flags().BoolVarP(&debug, "debug", "d", false, "Enable debug output")
+	rootCmd.Flags().BoolVarP(&trace, "trace", "t", false, "Enable trace and debug output")
+	rootCmd.Flags().BoolVarP(&silent, "silent", "s", false, "Disable all output")
+	rootCmd.Flags().BoolVarP(&json, "json", "j", false, "Output logs in JSON format")
+	rootCmd.Flags().StringSliceVarP(&recorders, "recorders", "r", nil, "Existing recorders to use")
+
+	if err := rootCmd.Execute(); err != nil {
+		log.Error().Err(err).Msg("error executing command")
+		os.Exit(1)
+	}
+}

parrot/errors.go

@@ -0,0 +1,43 @@
+package parrot
+
+import (
+	"errors"
+	"fmt"
+)
+
+var (
+	ErrNilRoute        = errors.New("route is nil")
+	ErrNoMethod        = errors.New("no method specified")
+	ErrInvalidPath     = errors.New("invalid path")
+	ErrNoResponse      = errors.New("route must have a handler or some response")
+	ErrOnlyOneResponse = errors.New("route can only have one response type")
+	ErrResponseMarshal = errors.New("unable to marshal response body to JSON")
+	ErrRouteNotFound   = errors.New("route not found")
+
+	ErrNoRecorderURL      = errors.New("no recorder URL specified")
+	ErrInvalidRecorderURL = errors.New("invalid recorder URL")
+	ErrRecorderNotFound   = errors.New("recorder not found")
+
+	ErrParrotAsleep = errors.New("parrot is asleep")
+)
+
+// Custom error type to help add more detail to base errors
+type dynamicError struct {
+	Base  error  // Base error for comparison
+	Extra string // Dynamic context (e.g., method name)
+}
+
+func (e *dynamicError) Error() string {
+	return fmt.Sprintf("%s: %s", e.Base.Error(), e.Extra)
+}
+
+func (e *dynamicError) Unwrap() error {
+	return e.Base
+}
+
+func newDynamicError(base error, detail string) error {
+	return &dynamicError{
+		Base:  base,
+		Extra: detail,
+	}
+}