Kitchensink test (#180)

<!--- Note to EXTERNAL Contributors -->
<!-- Thanks for opening a PR! 
If it is a significant code change, please **make sure there is an open
issue** for this.
We work best with you when we have accepted the idea first before you
code. -->

<!--- For ALL Contributors 👇 -->

## What was changed
<!-- Describe what has changed in this PR -->

Framework for checking kitchensink actions across SDKs.

(more tests to be added later ...)

## Why?
<!-- Tell your future self why have you made these changes -->

To ensure actions are supported correctly and comprehensively; and
document missing implementations.

Especially for new actions this helps ensure you've implemented them
correctly.

## Checklist
<!--- add/delete as needed --->

1. Closes <!-- add issue number here -->

2. How was this tested:
<!--- Please describe how you tested your changes/how we can test them
-->

3. Any docs updates needed?
<!--- update README if applicable
      or point out where to update docs.temporal.io -->

Author: stephanos

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on: # rebuild any PRs and main branch changes
       - main
 
 jobs:
-  shellcheck:
+  lint-shell:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
@@ -22,132 +22,141 @@ jobs:
           format: gcc
           severity: error
 
-  build-lint-test-go:
+  test-omes:
     runs-on: ubuntu-latest
     steps:
-      - name: Print build information
-        run: "echo head_ref: ${{ github.head_ref }}, ref: ${{ github.ref }}"
       - name: Checkout repo
         uses: actions/checkout@v4
-      - name: Install mise
-        uses: jdx/[email protected]
+      - uses: actions/setup-go@v4
         with:
-          version: ${{ env.MISE_VERSION }}
-      - name: Install Go
-        run: ./scripts/install-go.sh
-      - name: Lint Go
-        run: |
-          ./scripts/lint-go-worker.sh
-      - name: Check Go formatting
+          go-version-file: 'go.mod'
+      - name: Run tests
         run: |
-          git diff --exit-code || (echo "Go worker has uncommitted formatting changes after linting" && exit 1)
-      - name: Build Go worker
-        run: |
-          ./scripts/build-go-worker.sh
+          go test -race ./...
 
-  build-lint-test-java:
+  lint-worker:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sdk: [go, java, python, typescript, dotnet]
+        include:
+          - sdk: go
+            install: ./scripts/install-go.sh
+            lint: ./scripts/lint-go-worker.sh
+            submodules: false
+          - sdk: java
+            install: ./scripts/install-java.sh && ./scripts/install-go.sh
+            lint: ./scripts/lint-java-worker.sh
+            submodules: false
+          - sdk: python
+            install: ./scripts/install-python.sh && ./scripts/install-go.sh
+            lint: ./scripts/lint-python-worker.sh
+            submodules: false
+          - sdk: typescript
+            install: ./scripts/install-node.sh && ./scripts/install-go.sh
+            lint: ./scripts/lint-typescript-worker.sh
+            submodules: true
+          - sdk: dotnet
+            install: ./scripts/install-dotnet.sh && ./scripts/install-go.sh
+            lint: ./scripts/lint-dotnet-worker.sh
+            submodules: true
     steps:
       - name: Print build information
         run: "echo head_ref: ${{ github.head_ref }}, ref: ${{ github.ref }}"
       - name: Checkout repo
         uses: actions/checkout@v4
-      - name: Install mise
-        uses: jdx/[email protected]
         with:
-          version: ${{ env.MISE_VERSION }}
-      - name: Install Tools
-        run: |
-          ./scripts/install-java.sh
-          ./scripts/install-go.sh
-      - name: Lint Java
-        run: |
-          ./scripts/lint-java-worker.sh
-      - name: Check Java formatting
-        run: |
-          git diff --exit-code || (echo "Java worker has uncommitted formatting changes after linting" && exit 1)
-      - name: Build Java worker
-        run: |
-          ./scripts/build-java-worker.sh
-
-  build-lint-test-python:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Print build information
-        run: "echo head_ref: ${{ github.head_ref }}, ref: ${{ github.ref }}"
-      - name: Checkout repo
-        uses: actions/checkout@v4
+          submodules: ${{ matrix.submodules }}
       - name: Install mise
         uses: jdx/[email protected]
         with:
           version: ${{ env.MISE_VERSION }}
       - name: Install Tools
+        run: ${{ matrix.install }}
+      - name: Lint ${{ matrix.sdk }}
+        run: ${{ matrix.lint }}
+      - name: Check formatting
         run: |
-          ./scripts/install-python.sh
-          ./scripts/install-go.sh
-      - name: Lint Python
-        run: |
-          ./scripts/lint-python-worker.sh
-      - name: Check Python formatting
-        run: |
-          git diff --exit-code || (echo "Python worker has uncommitted formatting changes after linting" && exit 1)
-      - name: Build Python worker
-        run: |
-          ./scripts/build-python-worker.sh
+          git diff --exit-code || (echo "${{ matrix.sdk }} worker has uncommitted formatting changes after linting" && exit 1)
 
-  build-lint-test-typescript:
+  build-worker:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sdk: [go, java, python, typescript, dotnet]
+        include:
+          - sdk: go
+            install: ./scripts/install-go.sh
+            build: ./scripts/build-go-worker.sh
+            submodules: false
+          - sdk: java
+            install: ./scripts/install-java.sh && ./scripts/install-go.sh
+            build: ./scripts/build-java-worker.sh
+            submodules: false
+          - sdk: python
+            install: ./scripts/install-python.sh && ./scripts/install-go.sh
+            build: ./scripts/build-python-worker.sh
+            submodules: false
+          - sdk: typescript
+            install: ./scripts/install-node.sh && ./scripts/install-go.sh
+            build: ./scripts/build-typescript-worker.sh
+            submodules: true
+          - sdk: dotnet
+            install: ./scripts/install-dotnet.sh && ./scripts/install-go.sh
+            build: ./scripts/build-dotnet-worker.sh
+            submodules: true
     steps:
-      - name: Print build information
-        run: "echo head_ref: ${{ github.head_ref }}, ref: ${{ github.ref }}"
       - name: Checkout repo
         uses: actions/checkout@v4
         with:
-          submodules: 'true'
+          submodules: ${{ matrix.submodules }}
       - name: Install mise
         uses: jdx/[email protected]
         with:
           version: ${{ env.MISE_VERSION }}
       - name: Install Tools
-        run: |
-          ./scripts/install-node.sh
-          ./scripts/install-go.sh
-      - name: Lint TypeScript
-        run: |
-          ./scripts/lint-typescript-worker.sh
-      - name: Check TypeScript formatting
-        run: |
-          git diff --exit-code || (echo "TypeScript worker has uncommitted formatting changes after linting" && exit 1)
-      - name: Build TypeScript worker
-        run: |
-          ./scripts/build-typescript-worker.sh
+        run: ${{ matrix.install }}
+      - name: Build ${{ matrix.sdk }} worker
+        run: ${{ matrix.build }}
 
-  build-lint-test-dotnet:
+  test-kitchensink:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        sdk: [go, java, python, typescript, dotnet]
+        include:
+          - sdk: go
+            install: ./scripts/install-go.sh
+            submodules: false
+          - sdk: java
+            install: ./scripts/install-java.sh && ./scripts/install-go.sh
+            submodules: false
+          - sdk: python
+            install: ./scripts/install-python.sh && ./scripts/install-go.sh
+            submodules: false
+          - sdk: typescript
+            install: ./scripts/install-node.sh && ./scripts/install-go.sh
+            submodules: true
+          - sdk: dotnet
+            install: ./scripts/install-dotnet.sh && ./scripts/install-go.sh
+            submodules: true
     steps:
-      - name: Print build information
-        run: "echo head_ref: ${{ github.head_ref }}, ref: ${{ github.ref }}"
       - name: Checkout repo
         uses: actions/checkout@v4
         with:
-          submodules: 'true'
+          submodules: ${{ matrix.submodules }}
       - name: Install mise
         uses: jdx/[email protected]
         with:
           version: ${{ env.MISE_VERSION }}
       - name: Install Tools
+        run: ${{ matrix.install }}
+      - name: Test Kitchensink ${{ matrix.sdk }}
         run: |
-          ./scripts/install-dotnet.sh
-          ./scripts/install-go.sh
-      - name: Lint .NET
-        run: |
-          ./scripts/lint-dotnet-worker.sh
-      - name: Check .NET formatting
-        run: |
-          git diff --exit-code || (echo ".NET worker has uncommitted formatting changes after linting" && exit 1)
-      - name: Build .NET worker
-        run: |
-          ./scripts/build-dotnet-worker.sh
+          SDK=${{ matrix.sdk }} go test -race ./loadgen -run TestKitchensink -v
 
   build-ks-gen-and-ensure-protos-up-to-date:
     runs-on: ubuntu-latest

.github/workflows/docker-images.yml

@@ -55,7 +55,7 @@ jobs:
       - uses: actions/setup-go@v4
         if: ${{ !inputs.do-push || github.event.pull_request.head.repo.fork }}
         with:
-          go-version: '^1.24'
+          go-version-file: 'go.mod'
 
       - name: Set up Docker Buildx
         if: ${{ !inputs.do-push || github.event.pull_request.head.repo.fork }}
@@ -110,7 +110,7 @@ jobs:
 
       - uses: actions/setup-go@v4
         with:
-          go-version: '^1.24'
+          go-version-file: 'go.mod'
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3

.gitignore

@@ -18,5 +18,7 @@ workers/java/build
 /last_fuzz_run.proto
 workers/dotnet/Temporalio.Omes.temp.csproj
 
-omes-temp-*/
+workers/*/omes-temp-*/
+workers/*/prepared/
+
 temporal-omes

README.md

@@ -243,6 +243,8 @@ to test a wide variety of scenarios without having to imagine all possible edge
 come up in workflows. Input may be saved for regression testing, or hand written for specific cases.
 
 Build by running `scripts/build-kitchensink.sh`.
+Test by running `go test -v ./loadgen -run TestKitchensink`.
+Prefix with env variable `SDK=<sdk>` to test a specific SDK only.
 
 ### Scenario Failure
 

cmd/build_worker_image.go

@@ -176,7 +176,7 @@ func (b *workerImageBuilder) build(ctx context.Context, allowPush bool) error {
 	for _, arg := range buildArgs {
 		args = append(args, "--build-arg", arg)
 	}
-	args = append(args, rootDir())
+	args = append(args, repoDir())
 	b.logger.Infof("Running: docker %v", strings.Join(args, " "))
 	if b.dryRun {
 		return nil

cmd/cmdoptions/scenario.go

@@ -9,21 +9,13 @@ import (
 )
 
 type ScenarioID struct {
-	scenario string
-	runID    string
+	Scenario string
+	RunID    string
 }
 
 func (r *ScenarioID) AddCLIFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&r.scenario, "scenario", "", "Scenario name to run")
-	fs.StringVar(&r.runID, "run-id", shortRand(), "Run ID for this run")
-}
-
-func (r *ScenarioID) Scenario() string {
-	return r.scenario
-}
-
-func (r *ScenarioID) RunID() string {
-	return r.runID
+	fs.StringVar(&r.Scenario, "scenario", "", "Scenario name to run")
+	fs.StringVar(&r.RunID, "run-id", shortRand(), "Run ID for this run")
 }
 
 func shortRand() string {

cmd/prepare_worker.go

@@ -19,7 +19,7 @@ func prepareWorkerCmd() *cobra.Command {
 			b.preRun()
 		},
 		Run: func(cmd *cobra.Command, args []string) {
-			baseDir := filepath.Join(rootDir(), "workers", b.SdkOptions.Language.String())
+			baseDir := workers.BaseDir(repoDir(), b.SdkOptions.Language)
 			if _, err := b.Build(cmd.Context(), baseDir); err != nil {
 				b.Logger.Fatal(err)
 			}
@@ -46,7 +46,7 @@ func (b *workerBuilder) preRun() {
 	b.Logger = b.loggingOptions.MustCreateLogger()
 }
 
-func rootDir() string {
+func repoDir() string {
 	_, currFile, _, _ := runtime.Caller(0)
 	return filepath.Dir(filepath.Dir(currFile))
 }

cmd/run_scenario.go

@@ -86,10 +86,10 @@ func (r *scenarioRunner) preRun() {
 }
 
 func (r *scenarioRunner) run(ctx context.Context) error {
-	scenario := loadgen.GetScenario(r.scenario.Scenario())
+	scenario := loadgen.GetScenario(r.scenario.Scenario)
 	if scenario == nil {
 		return fmt.Errorf("scenario not found")
-	} else if r.scenario.RunID() == "" {
+	} else if r.scenario.RunID == "" {
 		return fmt.Errorf("run ID not found")
 	} else if r.iterations > 0 && r.duration > 0 {
 		return fmt.Errorf("cannot provide both iterations and duration")
@@ -114,7 +114,6 @@ func (r *scenarioRunner) run(ctx context.Context) error {
 			value = string(data)
 		}
 		scenarioOptions[key] = value
-
 	}
 
 	metrics := r.metricsOptions.MustCreateMetrics(r.logger)
@@ -137,8 +136,8 @@ func (r *scenarioRunner) run(ctx context.Context) error {
 	defer client.Close()
 
 	scenarioInfo := loadgen.ScenarioInfo{
-		ScenarioName:   r.scenario.Scenario(),
-		RunID:          r.scenario.RunID(),
+		ScenarioName:   r.scenario.Scenario,
+		RunID:          r.scenario.RunID,
 		Logger:         r.logger,
 		MetricsHandler: metrics.NewHandler(),
 		Client:         client,
@@ -152,7 +151,7 @@ func (r *scenarioRunner) run(ctx context.Context) error {
 		},
 		ScenarioOptions: scenarioOptions,
 		Namespace:       r.clientOptions.Namespace,
-		RootPath:        rootDir(),
+		RootPath:        repoDir(),
 	}
 	err = scenario.Executor.Run(ctx, scenarioInfo)
 	if err != nil {

cmd/run_scenario_with_worker.go

@@ -7,6 +7,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/temporalio/omes/cmd/cmdoptions"
+	"github.com/temporalio/omes/workers"
 )
 
 func runScenarioWithWorkerCmd() *cobra.Command {
@@ -54,7 +55,7 @@ func (r *workerWithScenarioRunner) run(ctx context.Context) error {
 	workerErrCh := make(chan error, 1)
 	workerStartCh := make(chan struct{})
 	r.OnWorkerStarted = func() { close(workerStartCh) }
-	go func() { workerErrCh <- r.Run(ctx, rootDir()) }()
+	go func() { workerErrCh <- r.Run(ctx, workers.BaseDir(repoDir(), r.SdkOptions.Language)) }()
 	select {
 	case err := <-workerErrCh:
 		return fmt.Errorf("worker did not start: %w", err)