Merge branch 'main' into ccipv2-chaos-suite

Author: skudasov

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

@@ -86,7 +86,7 @@ jobs:
         with:
           go-version: 1.23
       - name: Cache Go modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             ~/.cache/go-build

.github/workflows/lint.yaml

@@ -82,14 +82,13 @@ jobs:
       - name: Check out Code
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
       - name: Install Go
-        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/setup-go@d2f9642bcc24a73400568756f24b72c188ac7a9a # v2.3.31
+        uses: smartcontractkit/.github/actions/setup-golang@3835daadbcefcae06d12dc42a405a856c980d2cc
         with:
-          test_download_vendor_packages_command: cd ${{ matrix.project.path }} && go mod download
-          go_mod_path: ${{ matrix.project.path }}go.mod
-          cache_key_id: ctf-go-${{ matrix.project.name }}
-          cache_restore_only: 'false'
+          go-version-file: ${{ matrix.project.path }}go.mod
+          use-go-cache: true
+          go-cache-dep-path: ${{ matrix.project.path }}go.sum
       - name: golangci-lint ${{ needs.tools.outputs.golangci-lint-version }}
-        uses: golangci/golangci-lint-action@9d1e0624a798bb64f6c3cea93db47765312263dc # v5.1.0
+        uses: golangci/golangci-lint-action@051d91933864810ecd5e2ea2cfd98f6a5bca5347 # v6.3.2
         with:
           version: v${{ needs.tools.outputs.golangci-lint-version }}
           args: --out-format checkstyle:golangci-lint-report.xml
@@ -113,12 +112,11 @@ jobs:
       - name: Check out Code
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
       - name: Install Go
-        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/setup-go@d2f9642bcc24a73400568756f24b72c188ac7a9a # v2.3.31
+        uses: smartcontractkit/.github/actions/setup-golang@3835daadbcefcae06d12dc42a405a856c980d2cc
         with:
-          test_download_vendor_packages_command: cd lib && go mod download
-          go_mod_path: ./lib/go.mod
-          cache_key_id: ctf-go
-          cache_restore_only: 'false'
+          go-version-file: ./lib/go.mod
+          use-go-cache: true
+          go-cache-dep-path: ./lib/go.sum
       - name: Write Go List
         working-directory: lib
         run: go list -json -deps ./... > ../go.list

CODEOWNERS

@@ -1 +1 @@
-* @sebawo @smartcontractkit/test-tooling-team
+* @smartcontractkit/test-tooling-team

parrot/.goreleaser.yaml

@@ -2,6 +2,8 @@
 version: 2
 project_name: parrot
 
+dist: parrot/dist
+
 monorepo:
   tag_prefix: parrot/
   dir: parrot
@@ -20,8 +22,7 @@ builds:
     goarch:
       - amd64
       - arm64
-    ldflags:
-      - '-s -w'
+    binary: parrot
 
 archives:
   - formats: ['binary']
@@ -32,6 +33,7 @@ dockers:
     goarch: amd64
     image_templates:
       - '{{ .Env.IMG_PRE }}/parrot:{{ .Tag }}-amd64'
+      - '{{ .Env.IMG_PRE }}/parrot:latest-amd64'
     build_flag_templates:
       - --platform=linux/amd64
       - --pull
@@ -44,6 +46,7 @@ dockers:
     goarch: arm64
     image_templates:
       - '{{ .Env.IMG_PRE }}/parrot:{{ .Tag }}-arm64'
+      - '{{ .Env.IMG_PRE }}/parrot:latest-arm64'
     build_flag_templates:
       - --platform=linux/arm64
       - --pull
@@ -57,7 +60,11 @@ docker_manifests:
     image_templates:
       - '{{ .Env.IMG_PRE }}/parrot:{{ .Tag }}-amd64'
       - '{{ .Env.IMG_PRE }}/parrot:{{ .Tag }}-arm64'
+  - name_template: '{{ .Env.IMG_PRE }}/parrot:latest'
+    image_templates:
+      - '{{ .Env.IMG_PRE }}/parrot:latest-amd64'
+      - '{{ .Env.IMG_PRE }}/parrot:latest-arm64'
 
 before:
   hooks:
-    - sh -c "cd parrot && go mod tidy"
+    - sh -c "cd parrot && go mod tidy"

parrot/Dockerfile

@@ -1,3 +1,7 @@
 FROM scratch
+
 COPY parrot /parrot
-ENTRYPOINT [ "parrot", "-port", "9090", "-t" ]
+ENV PARROT_PORT 80
+ENV PARROT_TRACE true
+EXPOSE 80
+ENTRYPOINT [ "/parrot" ]

parrot/Makefile

@@ -36,4 +36,5 @@ fuzz:
 .PHONY: build
 build:
 	cd .. && goreleaser release --snapshot --clean -f ./parrot/.goreleaser.yaml
+	echo "Build done, check in parrot/dist for binaries"
 

parrot/client.go

@@ -0,0 +1,98 @@
+package parrot
+
+import (
+	"fmt"
+	"net/http"
+
+	"github.com/go-resty/resty/v2"
+)
+
+// Client interacts with a parrot server
+type Client struct {
+	restyClient *resty.Client
+}
+
+// NewClient creates a new client for a parrot server running at the given url.
+func NewClient(url string) *Client {
+	restyC := resty.New()
+	restyC.SetBaseURL(url)
+	return &Client{
+		restyClient: restyC,
+	}
+}
+
+// Health returns the health of the server
+func (c *Client) Healthy() (bool, error) {
+	resp, err := c.restyClient.R().Get(HealthRoute)
+	if err != nil {
+		return false, err
+	}
+	return resp.StatusCode() == http.StatusOK, nil
+}
+
+// Routes returns all the routes registered on the server
+func (c *Client) Routes() ([]*Route, error) {
+	routes := []*Route{}
+	resp, err := c.restyClient.R().SetResult(&routes).Get(RoutesRoute)
+	if err != nil {
+		return nil, err
+	}
+	if resp.StatusCode() != http.StatusOK {
+		return nil, fmt.Errorf("failed to get routes, got %d status code: %s", resp.StatusCode(), string(resp.Body()))
+	}
+	return routes, nil
+}
+
+// CallRoute calls a route on the server
+func (c *Client) CallRoute(method, path string) (*resty.Response, error) {
+	return c.restyClient.R().Execute(method, path)
+}
+
+// RegisterRoute registers a route on the server
+func (c *Client) RegisterRoute(route *Route) error {
+	resp, err := c.restyClient.R().SetBody(route).Post(RoutesRoute)
+	if err != nil {
+		return err
+	}
+	if resp.StatusCode() != http.StatusCreated {
+		return fmt.Errorf("failed to register route, got %d status code: %s", resp.StatusCode(), string(resp.Body()))
+	}
+	return nil
+}
+
+// DeleteRoute deletes a route on the server
+func (c *Client) DeleteRoute(route *Route) error {
+	resp, err := c.restyClient.R().SetBody(route).Delete(RoutesRoute)
+	if err != nil {
+		return err
+	}
+	if resp.StatusCode() != http.StatusNoContent {
+		return fmt.Errorf("failed to delete route, got %d status code: %s", resp.StatusCode(), string(resp.Body()))
+	}
+	return nil
+}
+
+// RegisterRecorder registers a recorder on the server
+func (c *Client) RegisterRecorder(recorder *Recorder) error {
+	resp, err := c.restyClient.R().SetBody(recorder).Post(RecorderRoute)
+	if err != nil {
+		return err
+	}
+	if resp.StatusCode() != http.StatusCreated {
+		return fmt.Errorf("failed to register recorder, got %d status code: %s", resp.StatusCode(), string(resp.Body()))
+	}
+	return nil
+}
+
+// Recorders returns all the recorders registered on the server
+func (c *Client) Recorders() ([]string, error) {
+	recorders := []string{}
+	resp, err := c.restyClient.R().SetResult(&recorders).Get(RecorderRoute)
+	if err != nil {
+		return nil, err
+	}
+	if resp.StatusCode() != http.StatusOK {
+		return nil, fmt.Errorf("failed to get recorders, got %d status code: %s", resp.StatusCode(), string(resp.Body()))
+	}
+	return recorders, nil
+}

parrot/cmd/main.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"os"
 	"os/signal"
+	"strconv"
+	"strings"
 	"syscall"
 	"time"
 
@@ -26,6 +28,31 @@ func main() {
 	rootCmd := &cobra.Command{
 		Use:   "parrot",
 		Short: "A server that can register and parrot back dynamic requests",
+		PreRun: func(cmd *cobra.Command, args []string) {
+			// Check environment variables if flags are not set
+			if !cmd.Flags().Changed("port") {
+				if envPort, err := strconv.Atoi(os.Getenv("PARROT_PORT")); err == nil {
+					port = envPort
+				}
+			}
+			if !cmd.Flags().Changed("debug") {
+				debug = os.Getenv("PARROT_DEBUG") == "true"
+			}
+			if !cmd.Flags().Changed("trace") {
+				trace = os.Getenv("PARROT_TRACE") == "true"
+			}
+			if !cmd.Flags().Changed("silent") {
+				silent = os.Getenv("PARROT_SILENT") == "true"
+			}
+			if !cmd.Flags().Changed("json") {
+				json = os.Getenv("PARROT_JSON") == "true"
+			}
+			if !cmd.Flags().Changed("recorders") {
+				if envRecorders := os.Getenv("PARROT_RECORDERS"); envRecorders != "" {
+					recorders = strings.Split(envRecorders, ",")
+				}
+			}
+		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			options := []parrot.ServerOption{parrot.WithPort(port)}
 			logLevel := zerolog.InfoLevel
@@ -47,7 +74,7 @@ func main() {
 			ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
 			defer cancel()
 
-			p, err := parrot.Wake(options...)
+			p, err := parrot.NewServer(options...)
 			if err != nil {
 				return err
 			}
@@ -63,12 +90,12 @@ func main() {
 		},
 	}
 
-	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")
+	rootCmd.Flags().IntVarP(&port, "port", "p", 0, "Port to run the parrot on (env: PARROT_PORT)")
+	rootCmd.Flags().BoolVarP(&debug, "debug", "d", false, "Enable debug output (env: PARROT_DEBUG)")
+	rootCmd.Flags().BoolVarP(&trace, "trace", "t", false, "Enable trace and debug output (env: PARROT_TRACE)")
+	rootCmd.Flags().BoolVarP(&silent, "silent", "s", false, "Disable all output (env: PARROT_SILENT)")
+	rootCmd.Flags().BoolVarP(&json, "json", "j", false, "Output logs in JSON format (env: PARROT_JSON)")
+	rootCmd.Flags().StringSliceVarP(&recorders, "recorders", "r", nil, "Existing recorders to use (env: PARROT_RECORDERS)")
 
 	if err := rootCmd.Execute(); err != nil {
 		log.Error().Err(err).Msg("error executing command")