In progress

kalverra · kalverra · commit 23df5c7c6618 · 2025-01-10T10:19:58.000-05:00
diff --git a/.github/workflows/framework-golden-tests.yml b/.github/workflows/framework-golden-tests.yml
@@ -65,9 +65,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:
diff --git a/.github/workflows/framework.yml b/.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:
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -56,6 +56,8 @@ jobs:
             path: ./tools/asciitable/
           - name: workflowresultparser
             path: ./tools/workflowresultparser/
+          - name: parrotserver
+            path: ./parrotserver/
     steps:
       - name: Check out Code
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
diff --git a/.github/workflows/parrotserver-release.yml b/.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
diff --git a/.github/workflows/rc-breaking-changes.yaml b/.github/workflows/rc-breaking-changes.yaml
@@ -16,10 +16,10 @@ jobs:
         with:
           fetch-depth: 0
           fetch-tags: true
-      - name: Set up Go 1.22.6
+      - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.22.6'
+          go-version: 1.23
       - name: Install gorelease tool
         run: |
           go install golang.org/x/exp/cmd/gorelease@latest
diff --git a/.github/workflows/release-go-module.yml b/.github/workflows/release-go-module.yml
@@ -69,7 +69,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.22.6'
+          go-version: 1.23
       - name: Install gorelease tool
         run: |
           go install golang.org/x/exp/cmd/gorelease@latest
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -26,6 +26,8 @@ jobs:
             path: ./tools/flakeguard/            
           - name: workflowresultparser
             path: ./tools/workflowresultparser/
+          - name: parrotserver
+            path: ./parrotserver/
     runs-on: ubuntu-latest
     name: ${{ matrix.project.name }} unit tests
     steps:
diff --git a/.gitignore b/.gitignore
@@ -77,4 +77,6 @@ __debug*
 .tool-versions
 
 import_keys_test.go
-tag.py
+tag.py
+
+parrotserver/*.json
diff --git a/parrotserver/.dockerignore b/parrotserver/.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
diff --git a/parrotserver/.goreleaser.yaml b/parrotserver/.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
diff --git a/parrotserver/Dockerfile b/parrotserver/Dockerfile
@@ -0,0 +1,3 @@
+FROM scratch
+COPY parrotserver /parrotserver
+ENTRYPOINT [ "parrotserver" ]
diff --git a/parrotserver/Makefile b/parrotserver/Makefile
@@ -0,0 +1,11 @@
+.PHONY: lint
+lint:
+	golangci-lint --color=always run ./... --fix -v
+
+.PHONY: test_unit
+test_unit:
+	go test ./...
+
+.PHONY: bench
+bench:
+	go test -bench=. -run=^$$ ./...
diff --git a/parrotserver/README.md b/parrotserver/README.md
@@ -0,0 +1,84 @@
+# Parrot Server
+
+A simple, high-performing mockserver that can dynamically build new routes with customized responses, parroting back whatever you tell it to.
+
+## Use
+
+Call the `/register` endpoint to define a route.
+
+### Curl
+
+```sh
+curl -X POST http://localhost:8080/register -d '{
+  "method": "GET",
+  "path": "/hello",
+  "response": "{\"message\": \"Hello, world!\"}",
+  "status_code": 200,
+  "content_type": "application/json"
+}' -H "Content-Type: application/json"
+```
+
+### Go and [Resty](https://github.com/go-resty/resty)
+
+```go
+client := resty.New()
+
+route := map[string]any{
+    "method":      "GET",
+    "path":        "/hello",
+    "response":    "{\"message\":\"Hello, world!\"}",
+    "status_code": 200,
+    "content_type": "application/json",
+}
+
+resp, _ := client.R().
+    SetHeader("Content-Type", "application/json").
+    SetBody(route).
+    Post("http://localhost:8080/register")
+```
+
+You can now call your endpoint and receive the JSON response back.
+
+```sh
+curl -X GET http://localhost:8080/hello -H "Content-Type: application/json"
+# {"message":"Hello, world!"}
+```
+
+## Configure
+
+Config is through environment variables.
+
+| **Environment Variable** | **Description**                                                | **Default Value** |
+| ------------------------ | -------------------------------------------------------------- | ----------------- |
+| `LOG_LEVEL`              | Controls the logging level (`debug`, `info`, `warn`, `error`). | `debug`           |
+| `SAVE_FILE`              | Path to the file where routes are saved and loaded.            | `save.json`       |
+
+## Run
+
+```sh
+go run .
+```
+
+## Test
+
+```sh
+go test -cover -race ./...
+```
+
+## Benchmark
+
+```sh
+LOG_LEVEL=disabled go test -bench=. -benchmem -run=^$
+```
+
+Benchmark run on an Apple M3 Max.
+
+```sh
+goos: darwin
+goarch: arm64
+pkg: github.com/smartcontractkit/chainlink-testing-framework/parrotserver
+BenchmarkRegisterRoute-14    	  604978	      1967 ns/op	    6263 B/op	      29 allocs/op
+BenchmarkRouteResponse-14    	16561670	        70.62 ns/op	      80 B/op	       1 allocs/op
+BenchmarkSaveRoutes-14       	    1245	    956784 ns/op	  636042 B/op	    2014 allocs/op
+BenchmarkLoadRoutes-14       	    1020	   1185990 ns/op	  348919 B/op	    9020 allocs/op
+```
diff --git a/parrotserver/cmd/main.go b/parrotserver/cmd/main.go
@@ -0,0 +1,63 @@
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+	"time"
+
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+	"github.com/smartcontractkit/parrotserver"
+)
+
+var config *parrotserver.Config
+
+func init() {
+	zerolog.TimeFieldFormat = time.RFC3339Nano
+	log.Logger = log.Output(zerolog.ConsoleWriter{
+		Out:        os.Stderr,
+		TimeFormat: "15:04:05.00", // hh:mm:ss.ss format
+	})
+	config = readConfig()
+	level := zerolog.DebugLevel
+	if config.LogLevel != "" {
+		l, err := zerolog.ParseLevel(config.LogLevel)
+		if err != nil {
+			fmt.Printf("Invalid log level '%s'\n", config.LogLevel)
+			os.Exit(1)
+		}
+		level = l
+	}
+	log.Logger = log.Logger.Level(level).With().Timestamp().Logger()
+}
+
+func start() int {
+	defer func() {
+		if err := save(); err != nil {
+			log.Error().Err(err).Msg("Failed to save configuration")
+		}
+	}()
+
+	http.HandleFunc("/register", registerRouteHandler)
+	http.HandleFunc("/", dynamicHandler)
+
+	server := &http.Server{
+		Addr:         ":8080",
+		Handler:      nil,
+		ReadTimeout:  5 * time.Second,
+		WriteTimeout: 10 * time.Second,
+		IdleTimeout:  15 * time.Second,
+	}
+
+	log.Info().Int("port", 8080).Interface("config", config).Msg("Parrot server started")
+	if err := server.ListenAndServe(); err != nil {
+		log.Error().Err(err).Msg("Server stopped")
+		return 1
+	}
+	return 0
+}
+
+func main() {
+	os.Exit(start())
+}
diff --git a/parrotserver/go.mod b/parrotserver/go.mod
@@ -0,0 +1,17 @@
+module github.com/smartcontractkit/parrotserver
+
+go 1.23.4
+
+require (
+	github.com/rs/zerolog v1.33.0
+	github.com/stretchr/testify v1.9.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/sys v0.12.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
diff --git a/parrotserver/go.sum b/parrotserver/go.sum
@@ -0,0 +1,25 @@
+github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
+github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
+github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8=
+github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o=
+golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/parrotserver/server.go b/parrotserver/server.go
diff --git a/parrotserver/server_test.go b/parrotserver/server_test.go
