Merge branch 'master' into verkle-support

Author: pk910

.github/workflows/_shared-build.yaml

@@ -64,6 +64,7 @@ jobs:
     # build binaries
     - name: Build linux amd64 binary
       run: |
+        make docs
         make build
       env:
         RELEASE: ${{ inputs.release }}
@@ -103,6 +104,7 @@ jobs:
     # build binaries
     - name: Build linux arm64 binary
       run: |
+        make docs
         make build GOARCH=arm64 CC=/usr/bin/aarch64-linux-gnu-gcc
       env:
         RELEASE: ${{ inputs.release }}
@@ -136,6 +138,7 @@ jobs:
     # build binaries
     - name: Build windows binary
       run: |
+        make docs
         make build
       env:
         RELEASE: ${{ inputs.release }}
@@ -169,6 +172,7 @@ jobs:
     # build binaries
     - name: Build macos amd64 binary
       run: |
+        make docs
         make build
       env:
         RELEASE: ${{ inputs.release }}
@@ -202,6 +206,7 @@ jobs:
     # build binaries
     - name: Build macos arm64 binary
       run: |
+        make docs
         make build GOARCH=arm64
       env:
         RELEASE: ${{ inputs.release }}

.github/workflows/build-master.yml

@@ -61,6 +61,7 @@ jobs:
             echo "$line" >> ./wiki.md
           fi
           done <<< $(cat $filename)
+          echo "" >> ./wiki.md
         done
 
         cp ./wiki.md ./wiki/Home.md

Dockerfile

@@ -1,10 +1,10 @@
 # syntax=docker/dockerfile:1
-FROM golang:1.18 AS builder
+FROM golang:1.21 AS builder
 WORKDIR /src
 COPY go.sum go.mod ./
 RUN go mod download
 COPY . .
-RUN CGO_ENABLED=1 go build -o /bin/app .
+RUN make build
 
 FROM ubuntu:latest  
 RUN apt-get update && apt-get -y upgrade && apt-get install -y --no-install-recommends \
@@ -13,5 +13,5 @@ RUN apt-get update && apt-get -y upgrade && apt-get install -y --no-install-reco
   jq \
   && apt-get clean \
   && rm -rf /var/lib/apt/lists/*
-COPY --from=builder /bin/app /assertoor
+COPY --from=builder bin/assertoor /assertoor
 ENTRYPOINT ["/assertoor"]

Makefile

@@ -3,9 +3,9 @@ VERSION := $(shell git rev-parse --short HEAD)
 GOLDFLAGS += -X 'github.com/ethpandaops/assertoor/pkg/coordinator/buildinfo.BuildVersion="$(VERSION)"'
 GOLDFLAGS += -X 'github.com/ethpandaops/assertoor/pkg/coordinator/buildinfo.BuildRelease="$(RELEASE)"'
 
-.PHONY: all test clean
+.PHONY: all docs test clean
 
-all: build
+all: docs build
 
 test:
 	go test ./...
@@ -14,5 +14,8 @@ build:
 	@echo version: $(VERSION)
 	env CGO_ENABLED=1 go build -v -o bin/ -ldflags="-s -w $(GOLDFLAGS)" .
 
+docs:
+	go install github.com/swaggo/swag/cmd/swag@v1.16.3 && swag init -g web/api/handler.go -d pkg/coordinator --parseDependency -o pkg/coordinator/web/api/docs
+
 clean:
 	rm -f bin/*

cmd/root.go

@@ -13,7 +13,7 @@ import (
 var rootCmd = &cobra.Command{
 	Use:   "assertoor",
 	Short: "Runs a configured test until completion or error",
-	Run: func(cmd *cobra.Command, args []string) {
+	Run: func(cmd *cobra.Command, _ []string) {
 		config, err := coordinator.NewConfig(cfgFile)
 		if err != nil {
 			log.Fatal(err)
@@ -31,7 +31,7 @@ var rootCmd = &cobra.Command{
 			logr.SetLevel(logrus.DebugLevel)
 		}
 
-		coord := coordinator.NewCoordinator(config, logr, metricsPort, lameDuckSeconds)
+		coord := coordinator.NewCoordinator(config, logr, metricsPort)
 
 		if err := coord.Run(cmd.Context()); err != nil {
 			log.Fatal(err)
@@ -41,11 +41,10 @@ var rootCmd = &cobra.Command{
 }
 
 var (
-	cfgFile         string
-	logFormat       string
-	verbose         bool
-	metricsPort     int
-	lameDuckSeconds int
+	cfgFile     string
+	logFormat   string
+	verbose     bool
+	metricsPort int
 )
 
 // Execute adds all child commands to the root command and sets flags appropriately.
@@ -65,5 +64,4 @@ func init() {
 	rootCmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "Verbose output")
 
 	rootCmd.Flags().IntVarP(&metricsPort, "metrics-port", "", 9090, "Port to serve Prometheus metrics on")
-	rootCmd.Flags().IntVarP(&lameDuckSeconds, "lame-duck-seconds", "", 30, "Lame duck period in seconds (wait for this long after completion before terminating")
 }

cmd/tasks.go

@@ -9,14 +9,14 @@ import (
 
 	"github.com/ethpandaops/assertoor/pkg/coordinator/tasks"
 	"github.com/spf13/cobra"
-	"gopkg.in/yaml.v2"
+	"gopkg.in/yaml.v3"
 )
 
 // tasksCmd represents the tasks command
 var tasksCmd = &cobra.Command{
 	Use:   "tasks",
 	Short: "Lists all available tasks",
-	Run: func(cmd *cobra.Command, args []string) {
+	Run: func(_ *cobra.Command, _ []string) {
 		available := tasks.AvailableTasks()
 
 		yamlData, err := yaml.Marshal(&available)

go.mod

@@ -7,26 +7,31 @@ require (
 	github.com/donovanhide/eventsource v0.0.0-20210830082556-c59027999da0
 	github.com/ethereum/go-ethereum v1.13.8
 	github.com/ethpandaops/ethwallclock v0.3.0
+	github.com/gorhill/cronexpr v0.0.0-20180427100037-88b0669f7d75
 	github.com/gorilla/mux v1.8.1
 	github.com/herumi/bls-eth-go-binary v1.31.0
 	github.com/holiman/uint256 v1.2.4
+	github.com/itchyny/gojq v0.12.14
+	github.com/juliangruber/go-intersect v1.1.0
 	github.com/mashingan/smapping v0.1.19
 	github.com/prometheus/client_golang v1.17.0
 	github.com/protolambda/zrnt v0.30.0
 	github.com/protolambda/ztyp v0.2.2
 	github.com/rs/zerolog v1.29.1
 	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/cobra v1.5.0
+	github.com/swaggo/http-swagger v1.3.4
+	github.com/swaggo/swag v1.16.3
 	github.com/tdewolff/minify v2.3.6+incompatible
 	github.com/tyler-smith/go-bip39 v1.1.0
 	github.com/urfave/negroni v1.0.0
 	github.com/wealdtech/go-eth2-types/v2 v2.8.2
 	github.com/wealdtech/go-eth2-util v1.8.2
-	gopkg.in/yaml.v2 v2.4.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
+	github.com/KyleBanks/depth v1.2.1 // indirect
 	github.com/Microsoft/go-winio v0.6.1 // indirect
 	github.com/StackExchange/wmi v1.2.1 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
@@ -45,16 +50,21 @@ require (
 	github.com/go-logr/logr v1.2.4 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-ole/go-ole v1.2.5 // indirect
+	github.com/go-openapi/jsonpointer v0.19.5 // indirect
+	github.com/go-openapi/jsonreference v0.20.0 // indirect
+	github.com/go-openapi/spec v0.20.6 // indirect
+	github.com/go-openapi/swag v0.19.15 // indirect
 	github.com/goccy/go-yaml v1.9.5 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/uuid v1.3.0 // indirect
 	github.com/gorilla/websocket v1.4.2 // indirect
 	github.com/huandu/go-clone v1.6.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
-	github.com/itchyny/gojq v0.12.14 // indirect
 	github.com/itchyny/timefmt-go v0.1.5 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
 	github.com/kilic/bls12-381 v0.1.0 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.6 // indirect
+	github.com/mailru/easyjson v0.7.6 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
@@ -71,6 +81,7 @@ require (
 	github.com/shirou/gopsutil v3.21.4-0.20210419000835-c7a38de76ee5+incompatible // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/supranational/blst v0.3.11 // indirect
+	github.com/swaggo/files v0.0.0-20220610200504-28940afbdbfe // indirect
 	github.com/tdewolff/parse v2.3.4+incompatible // indirect
 	github.com/tdewolff/test v1.0.10 // indirect
 	github.com/tklauser/go-sysconf v0.3.12 // indirect
@@ -89,6 +100,7 @@ require (
 	golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/cenkalti/backoff.v1 v1.1.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 	rsc.io/tmplfunc v0.0.3 // indirect
 )