Merge pull request #221 from relab/meling/release/v0.9.0-devel

Gorums release v0.9.0-devel

Author: meling

.github/workflows/go-test.yml

@@ -9,13 +9,13 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: ["1.22"]
+        go-version: ["1.24.1"]
         platform: [ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.platform }}
 
     steps:
     - name: Cache Go Modules
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: |
           ~/.cache/go-build          # ubuntu-latest
@@ -26,17 +26,17 @@ jobs:
           ${{ runner.os }}-go-
 
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Go
-      uses: actions/setup-go@v3
+      uses: actions/setup-go@v5
       with:
         go-version: ${{ matrix.go-version }}
 
     - name: Install Protoc
       uses: arduino/setup-protoc@v3.0.0
       with:
-        version: "29.2"
+        version: "29.3"
         include-pre-releases: true
         repo-token: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/golangci-lint.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Cache Go Modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             ~/.cache/go-build          # ubuntu-latest
@@ -25,17 +25,17 @@ jobs:
             ${{ runner.os }}-go-
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
-          go-version: "1.22"
+          go-version: "1.24.1"
 
       - name: Setup Protoc
         uses: arduino/setup-protoc@v3.0.0
         with:
-          version: "29.2"
+          version: "29.3"
           include-pre-releases: true
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 

.gitignore

@@ -8,17 +8,6 @@ _obj
 _test
 
 # Architecture specific extensions/prefixes
-*.[568vq]
-[568vq].out
-
-*.cgo1.go
-*.cgo2.c
-_cgo_defun.c
-_cgo_gotypes.go
-_cgo_export.*
-
-_testmain.go
-
 *.exe
 *.test
 *.prof
@@ -36,10 +25,10 @@ Session.vim
 
 # binary files
 cmd/benchmark/benchmark
-
-ideas.txt
-
 cmd/protoc-gen-gorums/gengorums/template_static.go.bak
+ideas.txt
+all-to-all.md
 
 # jetbrains IDE files
 .idea/
+go.work.sum

.vscode/cspell.json

@@ -0,0 +1,20 @@
+{
+    // flagWords - list of words to be always considered incorrect.
+    // This is useful for common spelling errors too short to be considered.
+    // For example "hte" should be "the"
+    "flagWords": [
+        "hte",
+        "teh"
+    ],
+    "dictionaries": [
+        "gorums"
+    ],
+    "dictionaryDefinitions": [
+        {
+            "name": "gorums",
+            "path": "./gorums.txt",
+            // Some extensions use `addWords` for adding words to your personal dictionary.
+            "addWords": true
+        }
+    ]
+}

.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+    "recommendations": [
+        "xaver.clang-format",
+        "streetsidesoftware.code-spell-checker",
+        "golang.go",
+        "davidanson.vscode-markdownlint",
+        "zxh404.vscode-proto3",
+        "github.vscode-pull-request-github",
+        "redhat.vscode-yaml"
+    ]
+}

.vscode/gorums.txt

@@ -5,6 +5,7 @@ calltype
 calltypes
 checkf
 clevel
+compiletests
 cpuprofile
 descriptorpb
 devel
@@ -13,17 +14,21 @@ donech
 emptypb
 Erevik
 errcheck
+errgroup
 extendee
 Frausing's
 fset
 gengorums
+genproto
 GOBIN
 godoc
 golangci
+goleak
 GOPATH
 gopls
 gorelease
 goroutines
+gorums
 Gorums
 gorumsexample
 grpc
@@ -45,6 +50,7 @@ memprofile
 multicast
 naddr
 obj's
+oneway
 Paxos
 Pedersen
 pkgs
@@ -63,15 +69,19 @@ qspec
 quorumcall
 Reconf
 relab
+reservednames
 rlevel
 RPC's
 RPCs
 semver
 shlex
 srvs
+stressdev
+stressgen
 struct
 syncrq
 testprotos
+testrace
 timestamppb
 tmpl
 Tormod

.vscode/settings.json

@@ -1,14 +1,6 @@
 {
-    "protoc": {
-        "compile_on_save": false,
-        "options": [
-            "--proto_path=${workspaceRoot}",
-            "--proto_path=${workspaceRoot}/cmd/protoc-gen-gorums/dev",
-            "--proto_path=${workspaceRoot}/third_party"
-        ]
-    },
+    "breadcrumbs.enabled": true,
     "cSpell.enabled": true,
-    "cSpell.showStatus": true,
     "cSpell.languageSettings": [
         {
             // use with Markdown files
@@ -19,15 +11,71 @@
             ]
         }
     ],
-    "cSpell.customWorkspaceDictionaries": [
-        {
-            "addWords": true,
-            "name": "gorums",
-            "path": "${workspaceRoot}/.vscode/gorums.txt"
-        }
+    "cSpell.ignorePaths": [
+        "vscode-extension",
+        ".git/{info,lfs,logs,refs,objects}/**",
+        ".git/{index,*refs,*HEAD}",
+        ".vscode",
+        ".vscode-insiders",
+        "go.mod",
+        "go.sum",
+        "go.work.sum",
+        "**/**/*.pb.go"
     ],
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.inlineSuggest.enabled": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll": "explicit"
+    },
+    "files.exclude": {
+        "**/.git": true,
+        "**/.DS_Store": true,
+    },
+    "files.insertFinalNewline": true,
+    "files.trimFinalNewlines": true,
+    "files.trimTrailingWhitespace": true,
+    "git.inputValidation": true,
+    "git.inputValidationSubjectLength": 72,
+    "git.inputValidationLength": 72,
     "go.lintTool": "golangci-lint",
     "go.lintFlags": [
-        "--fast",
-    ]
+        "--fast"
+    ],
+    "go.useLanguageServer": true,
+    "gopls": {
+        "formatting.gofumpt": true,
+        "build.directoryFilters": [
+            "-doc",
+            "-x",
+        ],
+        // Add parameter placeholders when completing a function.
+        "usePlaceholders": true,
+        "staticcheck": false
+    },
+    "protoc": {
+        "compile_on_save": false,
+        "options": [
+            "--proto_path=${workspaceRoot}",
+            "--proto_path=${workspaceRoot}/cmd/protoc-gen-gorums/dev",
+            "--proto_path=${workspaceRoot}/third_party"
+        ]
+    },
+    "clang-format.executable": "/usr/bin/clang-format",
+    "clang-format.style": "{ IndentWidth: 4, BasedOnStyle: google, AlignConsecutiveAssignments: true, ColumnLimit: 120 }",
+    "[proto3]": {
+        "editor.defaultFormatter": "zxh404.vscode-proto3"
+    },
+    "markdownlint.config": {
+        "MD024": false,
+        "default": true,
+        "no-hard-tabs": {
+            "code_blocks": false
+        }
+    },
+    "yaml.format.enable": true,
+    "[yaml]": {
+        "editor.tabSize": 4,
+        "editor.formatOnSave": true,
+    }
 }

Makefile

@@ -8,13 +8,14 @@ static_files			:= $(shell find $(dev_path) -name "*.go" -not -name "zorums*" -no
 proto_path 				:= $(dev_path):third_party:.
 
 plugin_deps				:= gorums.pb.go internal/correctable/opts.pb.go $(static_file)
+runtime_deps			:= ordering/ordering.pb.go ordering/ordering_grpc.pb.go
 benchmark_deps			:= benchmark/benchmark.pb.go benchmark/benchmark_gorums.pb.go
 
 .PHONY: all dev tools bootstrapgorums installgorums benchmark test compiletests
 
 all: dev benchmark compiletests
 
-dev: installgorums ordering/ordering.pb.go ordering/ordering_grpc.pb.go
+dev: installgorums $(runtime_deps)
 	@rm -f $(dev_path)/zorums*.pb.go
 	@protoc -I=$(proto_path) \
 		--go_out=:. \
@@ -41,8 +42,7 @@ $(static_file): $(static_files)
 	@protoc -I=$(proto_path) --gorums_out=paths=source_relative:. $^
 
 tools:
-	@go mod download
-	@cat tools.go | grep _ | awk -F'"' '{print $$2}' | xargs -I % go install %
+	@go install tool
 
 installgorums: bootstrapgorums $(gen_files) $(plugin_deps) Makefile
 	@go install $(PLUGIN_PATH)

benchmark/benchmark.go

@@ -44,7 +44,7 @@ func runQCBenchmark(opts Options, cfg *Configuration, f qcFunc) (*Result, error)
 	s := &Stats{}
 	var g errgroup.Group
 
-	for n := 0; n < opts.Concurrent; n++ {
+	for range opts.Concurrent {
 		g.Go(func() error {
 			warmupEnd := time.Now().Add(opts.Warmup)
 			for !time.Now().After(warmupEnd) {
@@ -70,7 +70,7 @@ func runQCBenchmark(opts Options, cfg *Configuration, f qcFunc) (*Result, error)
 	}
 
 	s.Start()
-	for n := 0; n < opts.Concurrent; n++ {
+	for range opts.Concurrent {
 		g.Go(func() error {
 			endTime := time.Now().Add(opts.Duration)
 			for !time.Now().After(endTime) {
@@ -130,7 +130,7 @@ func runAsyncQCBenchmark(opts Options, cfg *Configuration, f asyncQCFunc) (*Resu
 		return nil
 	}
 
-	for n := 0; n < opts.Concurrent; n++ {
+	for range opts.Concurrent {
 		g.Go(warmupFunc)
 	}
 	err := g.Wait()
@@ -166,7 +166,7 @@ func runAsyncQCBenchmark(opts Options, cfg *Configuration, f asyncQCFunc) (*Resu
 	}
 
 	s.Start()
-	for n := 0; n < opts.Concurrent; n++ {
+	for range opts.Concurrent {
 		g.Go(benchmarkFunc)
 	}
 	err = g.Wait()
@@ -203,7 +203,7 @@ func runServerBenchmark(opts Options, cfg *Configuration, f serverFunc) (*Result
 	}
 
 	warmupEnd := time.Now().Add(opts.Warmup)
-	for n := 0; n < opts.Concurrent; n++ {
+	for range opts.Concurrent {
 		go benchmarkFunc(warmupEnd)
 	}
 	err := g.Wait()
@@ -218,7 +218,7 @@ func runServerBenchmark(opts Options, cfg *Configuration, f serverFunc) (*Result
 
 	runtime.ReadMemStats(&start)
 	endTime := time.Now().Add(opts.Duration)
-	for n := 0; n < opts.Concurrent; n++ {
+	for range opts.Concurrent {
 		benchmarkFunc(endTime)
 	}
 	err = g.Wait()