packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (4)

110-117: Refactor the volume mount for npm-test.
The relative path ../../../../../../ is brittle and easy to break if the file structure changes. Consider simplifying to a more robust mount, for example:

 volumes:
-  - ../../../../../../:/usr/src/app
+  - ./:/usr/src/app

or using an environment variable (${PWD}:/usr/src/app).

---

122-122: Pin a more specific Node.js image tag.
Using node:20 will float to the latest patch. For reproducibility and smaller images, you could pin a digest or switch to an Alpine/slim variant, e.g.:

image: node:20-alpine

---

135-136: Normalize the restart policy.
The YAML uses a string "no". For clarity and to match most Compose examples, you can use an unquoted boolean-like value or remove it (default is no-restart):

-restart: "no"
+restart: no

---

150-153: Simplify the Python tester command sequence.
The long chained cd and pip install calls can be consolidated for readability and reuse. For example, merge requirements into one file or reduce directory jumps:

-command: ["sh", "-c", "cd packages/.../client_hoppscotch && pip install -r requirements.txt && cd ../../../../test/python && pip install -r requirements.txt && pytest"]
+command: ["sh", "-c", "pip install -r packages/.../client_hoppscotch/requirements.txt -r packages/.../test/python/requirements.txt && pytest packages/.../test/python"]

.github/workflows/pr-testing-with-test-project.yml (1)

12-12: Use consistent naming for workflow outputs.
Currently you map steps.should_run.outputs.shouldrun into should_test. Consider renaming the step’s output key to should_test for symmetry and to reduce confusion.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (1)

122-127: Upgrade tester-js to Node 20 and chain dependencies
Bumping the image to node:20 matches npm-test. The new depends_on ensures JS acceptance tests wait for package tests to complete. As a nitpick, consider using npm ci instead of npm install for reproducible, lockfile-driven installs.

Also applies to: 132-135

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

.github/workflows/pr-testing-with-test-project.yml (3)

35-46: Consider extracting bot‐title exceptions
The negated block for asyncapi-bot, asyncapi-bot-eve, and allcontributors[bot] works, but as more automation is added it may become hard to maintain. You could factor these into a small composite action or at least move the list of excluded actors/titles into a single YAML anchor for clarity.

---

51-69: Correct use of step‐level conditionals
Splitting the old commented-out job into a dedicated test job and gating only the docker compose up step on needs.changes.outputs.should_test is exactly the right pattern. It guarantees the job always appears (satisfying branch-protection) while avoiding unnecessary work when no relevant files change.

Once the flag behaviour stabilizes, consider removing or lowering the verbosity of the interim Log should_test value step to clean up your checks output.

---

70-84: Approve acceptance test job structure
The new acceptance job mirrors the integration tests pattern, uses step-level gating on the same flag, and correctly points at the Microcks Podman compose file. This ensures acceptance tests run only when needed and still satisfy branch protection.

Similarly, you can drop or silence the debug logging step once you’re confident the flag propagation is correct.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

Learnt from: derberg
PR: asyncapi/generator#1552
File: .github/workflows/pr-testing-with-test-project.yml:51-69
Timestamp: 2025-05-09T08:24:17.265Z
Learning: In GitHub Actions workflows, don't use job-level `if` conditions for jobs that might be required in branch protection rules. When a job is skipped via job-level conditions, it doesn't appear in the GitHub checks list at all, and if that job is set as required, PRs would be blocked indefinitely. Instead, use step-level conditionals within the job to skip the substantive work while still allowing the job to complete successfully.

Learnt from: derberg
PR: asyncapi/generator#1552
File: .github/workflows/pr-testing-with-test-project.yml:70-84
Timestamp: 2025-05-09T08:25:03.402Z
Learning: When suggesting workflow optimizations in GitHub Actions, be cautious with job-level conditional statements (`if` at the job level). If a job with a job-level conditional is set as a required check in branch protection settings, PRs that don't trigger the job (condition evaluates to false) can never be merged since GitHub would be waiting for a required check that never runs. Using step-level conditionals is often better as the job still completes successfully, satisfying branch protection requirements.

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (1)

171-173: Verify and correct Python test paths in tester-py
The cd packages/templates/clients/websocket/python/test/... sequence still references python/test rather than the intended test/python directory. This path issue was flagged previously; please confirm the actual layout and update accordingly.

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (2)

4-7: Explicit network definition for Microcks environment
Defining a custom microcks_default bridge network ensures all services communicate over an isolated network and avoids collisions with other Compose projects.

---

120-122: Use YAML array syntax for the importer command
Switching from a multiline string to an explicit array improves readability and avoids shell-escaping pitfalls.
+```diff

• command: >
• sh -c "microcks-cli import fixtures/asyncapi-hoppscotch-server.yml \

• --microcksURL=http://microcks:8080/api/ \
  

• --keycloakClientId=microcks-serviceaccount \
  

• --keycloakClientSecret=…"
  

• command:
• • microcks-cli
• • import
• • "fixtures/asyncapi-hoppscotch-server.yml"
• • "--microcksURL=http://microcks:8080/api/"
• • "--keycloakClientId=microcks-serviceaccount"
• • "--keycloakClientSecret=${KEYCLOAK_CLIENT_SECRET}"
    +```

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (2)

186-192: Verify and correct Python test paths in tester-py
The cd commands reference deep paths under packages/templates/clients/websocket/python/test then switch to ../../../../test/python. Ensure these directories match the actual layout (likely under packages/templates/clients/websocket/test/python).

---

135-138: ⚠️ Potential issue

Remove hard-coded Keycloak client secret
Embedding --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54 exposes a credential. Move this secret into an environment variable or Podman secret.

Example diff:

     command: >
       sh -c "microcks-cli import __fixtures__/asyncapi-hoppscotch-server.yml \
       --microcksURL=http://microcks:8080/api/ \
       --keycloakClientId=microcks-serviceaccount \
-      --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54"
+      --keycloakClientSecret=${KEYCLOAK_CLIENT_SECRET}"
     environment:
       - KEYCLOAK_CLIENT_SECRET

🧰 Tools

🪛 Gitleaks (8.21.2)

138-138: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (1)

156-172: Review test dependencies for tester-js
The tester-js service correctly depends on successful npm-test and healthy app. Consider adding a dependency on importer completing successfully, so test data is loaded before JS acceptance tests run.

Example addition:

     depends_on:
       app:
         condition: service_healthy
       npm-test:
         condition: service_completed_successfully
+      importer:
+        condition: service_completed_successfully

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (2)

134-137: Remove hard-coded Keycloak client secret
Embedding --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54 poses a security risk. Move this value to an environment variable or Podman secret and inject via environment: or a secret: reference.

🧰 Tools

🪛 Gitleaks (8.21.2)

137-137: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

---

90-103: 🛠️ Refactor suggestion

Improve async-minion startup resilience
Introducing a shell-based health check before launching the Java process is solid. To avoid potential infinite loops if Microcks never becomes ready, add a retry counter and timeout.

Apply this diff within the entrypoint block:

@@ entrypoint:
-          echo "Waiting for microcks to be available..."
+          echo "Waiting for microcks to be available..."
+          attempts=0
           until curl -sf http://microcks:8080/api/health; do
             echo "  microcks not up yet, retrying..."
+            ((attempts++))
+            if [ "$attempts" -gt 60 ]; then
+              echo "Timeout waiting for Microcks, exiting."
+              exit 1
+            fi
             sleep 5
           done

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (3)

145-146: Reduce volume mapping scope
Mounting the entire repository (../../../../../../) into the container can expose unnecessary files and slows startup. Consider mapping only ./packages or the specific test directories needed.

---

164-165: Reduce volume mapping scope in JS tester
Mounting the entire repo into /usr/src/app is broad. Consider mapping only the specific test directory to minimize context and avoid exposing unrelated files.

---

184-184: Reduce volume mapping scope in Python tester
As with other services, mounting the entire repo into the container may introduce noise. Limit the volume mount to only the Python test folder or share via named volumes.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (2)

106-107: Remove hard-coded Keycloak client secret
Embedding --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54 exposes a sensitive credential in source control. Move this value into an environment variable or Podman secret and reference it in the command.

Example diff:

 microcks-cli-importer:
   # ...
-  command: >
-    sh -c "microcks-cli import __fixtures__/asyncapi-hoppscotch-server.yml \
-    --microcksURL=http://microcks:8080/api/ \
-    --keycloakClientId=microcks-serviceaccount \
-    --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54"
+  environment:
+    KEYCLOAK_CLIENT_SECRET: ${KEYCLOAK_CLIENT_SECRET}
+  command: >
+    sh -c "microcks-cli import __fixtures__/asyncapi-hoppscotch-server.yml \
+    --microcksURL=http://microcks:8080/api/ \
+    --keycloakClientId=microcks-serviceaccount \
+    --keycloakClientSecret=$KEYCLOAK_CLIENT_SECRET"

🧰 Tools

🪛 Gitleaks (8.21.2)

107-107: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

---

142-155: Correct and simplify Python acceptance test paths
The chained cd into python/test/temp/snapshotTestResult/... and backtracking into test/python is brittle and likely mismatches the actual layout (as noted in earlier reviews). Please confirm the directory structure and simplify the command. For example:

-websocket-acceptance-tester-py:
-  command: ["sh", "-c", "cd packages/templates/clients/websocket/python/test/temp/snapshotTestResult/client_hoppscotch && pip install -r requirements.txt && cd ../../../../test/python && pip install -r requirements.txt && pytest"]
+websocket-acceptance-tester-py:
+  command: ["sh", "-c", "pip install -r packages/templates/clients/websocket/test/python/requirements.txt && pytest packages/templates/clients/websocket/test/python"]

This reduces path complexity and ensures the correct test suite is executed.

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (1)

109-119: Simplify and stabilize project root mounting for npm-test
The deeply nested relative path (../../../../../../:/usr/src/app) is brittle and can break when directory structures change. Consider using a single-level mount or variable substitution. For example:

 npm-test:
   # ...
-  volumes:
-    - ../../../../../../:/usr/src/app
+  volumes:
+    - ./:/usr/src/app  # Mount project root (adjust if necessary)

This makes the configuration easier to maintain.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (2)

206-207: Validate Python test paths.
The command navigates into python/test/temp/... then back to test/python, which may not match the actual layout. Please confirm and simplify to avoid brittle paths.

---

144-147: ⚠️ Potential issue

Remove hard-coded Keycloak secret.
Embedding --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54 exposes credentials in source control. Move this to an environment variable or a Podman secret (environment: KEYCLOAK_CLIENT_SECRET).
Suggested diff:

-      --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54
+      --keycloakClientSecret=$KEYCLOAK_CLIENT_SECRET

🧰 Tools

🪛 Gitleaks (8.21.2)

147-147: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (3)

107-116: Add timeout to readiness loop.
The async-minion entrypoint currently waits indefinitely for the Microcks API. To avoid endless hangs, introduce a retry counter or timeout.
Suggested diff:

           until curl -sf http://microcks:8080/api/health; do
             echo "  microcks not up yet, retrying..."
-            sleep 5
+            sleep 5
+            ((attempts++))
+            if [ "$attempts" -gt 60 ]; then
+              echo "Timeout waiting for Microcks, exiting."
+              exit 1
+            fi
           done

---

157-158: Scope down the volume mount.
Mounting the entire repository can slow CI and expose unrelated files. Consider mounting only the WebSocket test directory:

-      - ../../../../../../:/usr/src/app
+      - ../../../:/usr/src/app

---

224-224: Add newline at end of file.
YAML linter expects a trailing newline.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 224-224: no new line character at the end of file

(new-line-at-end-of-file)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (2)

162-162: Remove hard-coded Keycloak client secret
A static secret (ab54d329-e435-41ae-a900-ec6b3fe15c54) is committed in the entrypoint. Please move this value to an environment variable or Podman secret to avoid exposing sensitive credentials.

🧰 Tools

🪛 Gitleaks (8.21.2)

162-162: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

---

267-268: Verify and correct Python test paths in tester-py
The script navigates to packages/templates/clients/websocket/python/test/temp/snapshotTestResult/client_hoppscotch then back to test/python; these paths look brittle and may not align with the repository layout. Please confirm the actual locations of your test suites and adjust the cd commands.

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (8)

117-121: Add timeout to health-check loop in async-minion
The loop will retry indefinitely if Microcks never becomes healthy, potentially hanging CI pipelines. Introduce a max retry count or timeout to fail fast.

Example snippet:

           until curl -sf http://microcks:8080/api/health; do
             echo "  microcks not up yet, retrying..."
-            sleep 5
+            sleep 5
+            attempts=$((attempts+1))
+            if [ "$attempts" -gt 60 ]; then
+              echo "Timeout waiting for Microcks, exiting."
+              exit 1
+            fi
           done

---

140-140: Pin microcks-cli-importer image to a specific version
Using microcks-cli:latest can introduce unpredictability if the upstream image changes. It’s safer to reference a fixed tag matching the Microcks server version (e.g., quay.io/microcks/microcks-cli:1.11.2).

---

182-183: Avoid deep relative volume mapping for npm-test
The host path uses six levels of .. to reach the repo root, which is brittle and error-prone. Consider using ${PWD} or the context field in a build section to simplify this.

---

188-191: Add timeout to wait for CLI importer completion in npm-test
The loop polling /signals/cli.done has no fail-safe. Introduce a retry limit or timeout to prevent infinite waiting if the importer never signals completion.

---

218-219: Simplify host volume mount for JS tester
Similar to npm-test, the JS tester uses deep relative paths (../../../../../../). This can break if directory structure changes. Use an environment variable or an explicit context to reference the project root.

---

224-231: Introduce timeout in JS acceptance tester wait loops
Both the file-signal and health-check loops in websocket-acceptance-tester-js lack a retry cap. Add a max attempt count to each loop to ensure the container exits if dependencies never become ready.

---

253-254: Simplify host volume mount for Python tester
The Python tester also uses a multi-level relative path (../../../../../../). As above, consider using ${PWD} or a defined context to map the codebase more reliably.

---

259-266: Add retry limit for Python tester wait loops
The loops that wait for /signals/npm.done and the Microcks health endpoint have no timeout, risking infinite hang. Add a retry counter or timeout for both loops.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/templates/clients/websocket/test/README.md (1)

49-53: ⚠️ Potential issue

Remove hardcoded Keycloak client secret
Embedding the Keycloak client secret in documentation exposes sensitive credentials. Replace with a placeholder or environment variable and document how users should supply their own.

-    --keycloakClientSecret="ab54d329-e435-41ae-a900-ec6b3fe15c54"
+    --keycloakClientSecret="$MICROCKS_CLIENT_SECRET"

🧰 Tools

🪛 Gitleaks (8.21.2)

52-52: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

packages/templates/clients/websocket/test/README.md (1)

65-71: ⚠️ Potential issue

Remove hardcoded Keycloak secret in test command
The acceptance test invocation includes a hardcoded Keycloak client secret, which should be externalized to prevent credential exposure.

-    --keycloakClientSecret="ab54d329-e435-41ae-a900-ec6b3fe15c54" \
+    --keycloakClientSecret="$MICROCKS_CLIENT_SECRET" \

🧰 Tools

🪛 Gitleaks (8.21.2)

70-70: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (1)

138-138: ⚠️ Potential issue

Remove hardcoded Keycloak client secret in importer
Embedding the Keycloak secret in the importer command exposes credentials. Use an environment variable or Podman secret to inject it securely.

-      --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54 && sleep infinity
+      --keycloakClientSecret="$MICROCKS_CLIENT_SECRET" && sleep infinity

🧰 Tools

🪛 Gitleaks (8.21.2)

138-138: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

packages/templates/clients/websocket/test/README.md (1)

43-44: Fix typo in installation instruction
The note reads “Instal AsyncAPI CLI” but should be “Install AsyncAPI CLI.”

.github/workflows/pr-testing-with-test-project.yml (1)

108-108: Add newline at end of file
A missing newline at EOF triggers YAML lint errors; adding it will resolve the lint warning.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 108-108: no new line character at the end of file

(new-line-at-end-of-file)

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (1)

167-167: Trim trailing spaces
Remove the trailing spaces on this line to satisfy YAML linting.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 167-167: trailing spaces

(trailing-spaces)

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

Learnt from: derberg
PR: asyncapi/generator#1552
File: .github/workflows/pr-testing-with-test-project.yml:51-69
Timestamp: 2025-05-09T08:24:17.362Z
Learning: In GitHub Actions workflows, don't use job-level `if` conditions for jobs that might be required in branch protection rules. When a job is skipped via job-level conditions, it doesn't appear in the GitHub checks list at all, and if that job is set as required, PRs would be blocked indefinitely. Instead, use step-level conditionals within the job to skip the substantive work while still allowing the job to complete successfully.

Learnt from: derberg
PR: asyncapi/generator#1552
File: .github/workflows/pr-testing-with-test-project.yml:70-84
Timestamp: 2025-05-09T08:25:03.441Z
Learning: When suggesting workflow optimizations in GitHub Actions, be cautious with job-level conditional statements (`if` at the job level). If a job with a job-level conditional is set as a required check in branch protection settings, PRs that don't trigger the job (condition evaluates to false) can never be merged since GitHub would be waiting for a required check that never runs. Using step-level conditionals is often better as the job still completes successfully, satisfying branch protection requirements.

packages/templates/clients/websocket/test/README.md (2)

57-61: ⚠️ Potential issue

Remove hard-coded Keycloak secret
Embedding --keycloakClientSecret="ab54d329-e435-41ae-a900-ec6b3fe15c54" exposes credentials in source control. Replace with an environment variable placeholder and document how to supply it at runtime:

-    --keycloakClientSecret="ab54d329-e435-41ae-a900-ec6b3fe15c54"
+    --keycloakClientSecret="$MICROCKS_CLIENT_SECRET"

Also add a note in the Prerequisites section describing how to set MICROCKS_CLIENT_SECRET.

🧰 Tools

🪛 Gitleaks (8.21.2)

60-60: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

---

100-101: ⚠️ Potential issue

Align websocat debug URL with updated service and operation
The example still points to the old Hoppscotch server and sendTimeStampMessage. Update it to the Postman Echo client and sendEchoMessage:

-websocat ws://localhost:8081/api/ws/Hoppscotch+WebSocket+Server/1.0.0/sendTimeStampMessage
+websocat ws://localhost:8081/api/ws/Postman+Echo+WebSocket+Client/1.0.0/sendEchoMessage

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (1)

136-136: ⚠️ Potential issue

Avoid embedding credentials in the compose file
The Keycloak client secret is hard-coded under the importer service. Move this value to an environment variable or a Podman secret:

-      --keycloakClientSecret=ab54d329-e435-41ae-a900-ec6b3fe15c54
+      --keycloakClientSecret=$MICROCKS_CLIENT_SECRET

Ensure you document how to provide MICROCKS_CLIENT_SECRET securely in CI and local environments.

🧰 Tools

🪛 Gitleaks (8.21.2)

136-136: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

.github/workflows/pr-testing-with-test-project.yml (2)

66-69: Remove temporary debug logging once stabilized
The Log should_test value across jobs step is helpful for debugging, but consider removing it in a follow-up cleanup to reduce noise in workflow logs once the flag behavior is confirmed.

---

108-108: Add newline at end of file
YAML files should end with a single newline character to satisfy POSIX standards and avoid linter warnings.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 108-108: no new line character at the end of file

(new-line-at-end-of-file)

packages/templates/clients/websocket/test/microcks-setup/microcks-podman.yml (3)

85-85: Remove trailing spaces
Line 85 contains trailing whitespace. Please remove to conform with YAML linting rules.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 85-85: trailing spaces

(trailing-spaces)

---

163-163: Remove trailing spaces
Line 163 contains trailing whitespace. Please remove to conform with YAML linting rules.

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 163-163: trailing spaces

(trailing-spaces)

---

147-148: Simplify volume mapping for npm-test service
The current relative path (../../../../../../:/usr/src/app) is brittle and hard to maintain. Consider using a bind mount from the repo root or setting the working directory at startup:

-    volumes:
-      - ../../../../../../:/usr/src/app
+    volumes:
+      - ../..:/usr/src/app  # adjust path to repo root relative to microcks-setup

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

Learnt from: derberg
PR: asyncapi/generator#1552
File: .github/workflows/pr-testing-with-test-project.yml:51-69
Timestamp: 2025-05-09T08:24:17.362Z
Learning: In GitHub Actions workflows, don't use job-level `if` conditions for jobs that might be required in branch protection rules. When a job is skipped via job-level conditions, it doesn't appear in the GitHub checks list at all, and if that job is set as required, PRs would be blocked indefinitely. Instead, use step-level conditionals within the job to skip the substantive work while still allowing the job to complete successfully.

Learnt from: derberg
PR: asyncapi/generator#1552
File: .github/workflows/pr-testing-with-test-project.yml:70-84
Timestamp: 2025-05-09T08:25:03.441Z
Learning: When suggesting workflow optimizations in GitHub Actions, be cautious with job-level conditional statements (`if` at the job level). If a job with a job-level conditional is set as a required check in branch protection settings, PRs that don't trigger the job (condition evaluates to false) can never be merged since GitHub would be waiting for a required check that never runs. Using step-level conditionals is often better as the job still completes successfully, satisfying branch protection requirements.

packages/templates/clients/websocket/test/README.md (2)

57-61: Avoid hardcoding secrets in documentation.

Hardcoding --keycloakClientSecret="ab54d329-e435-41ae-a900-ec6b3fe15c54" exposes sensitive information. Replace with an environment variable placeholder and instruct users to set it:

- --keycloakClientSecret="ab54d329-e435-41ae-a900-ec6b3fe15c54"
+ --keycloakClientSecret="${MICROCKS_CLIENT_SECRET}"

Add a note to export the secret before running:

export MICROCKS_CLIENT_SECRET=your_client_secret_here

🧰 Tools

🪛 Gitleaks (8.21.2)

60-60: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

---

73-79: Parameterize Keycloak secret in the test invocation.

Similarly, avoid embedding the Keycloak secret in the microcks-cli test command. Use the environment variable placeholder:

- --keycloakClientSecret="ab54d329-e435-41ae-a900-ec6b3fe15c54" \
+ --keycloakClientSecret="${MICROCKS_CLIENT_SECRET}" \

Ensure users export MICROCKS_CLIENT_SECRET as shown earlier.

🧰 Tools

🪛 Gitleaks (8.21.2)

78-78: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

packages/templates/clients/websocket/test/README.md (3)

13-21: Refine step numbering and grammar in test instructions.

Replace repeated "1." list markers with sequential numbering for clarity. Also add the article "a" in "Run tests for a given client" and insert a comma after "This way". For example:

- 1. Go to microcks directory: `cd microcks-setup`
- 1. Setup infra based on Microcks and proper AsyncAPI documents: `podman compose -f microcks-podman.yml --profile infra up -d`
- 1. Run tests for given client, for example `podman compose -f microcks-podman.yml --profile test-js up --abort-on-container-exit` to run JS client tests. Use `test-py` profile for Python client tests.
+ 1. Go to the `microcks-setup` directory:
+    ```bash
+    cd microcks-setup
+    ```
+ 2. Set up infrastructure:
+    ```bash
+    podman compose -f microcks-podman.yml --profile infra up -d
+    ```
+ 3. Run tests for a given client:
+    ```bash
+    podman compose -f microcks-podman.yml --profile test-js up --abort-on-container-exit
+    ```

> You need to remember about `--profile infra` to run the whole setup with tests. This way, you ensure that the `asyncapi-bundler` service produces `__fixtures__/bundled.yml`, which the importer container will import into Microcks.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...rato run whole setup with tests. This way you ensure that theasyncapi-bundler` ...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[uncategorized] ~21-~21: You might be missing the article “a” here.
Context: ...import into Microcks. 1. Run tests for given client, for example `podman compose -f ...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

---

39-41: Avoid duplicating instructions under separate sections.

The steps to cd microcks-setup and set up infra are repeated here (lines 39–41) after the earlier "To run tests" section (lines 15–17). Consolidate these into a single "Start Microcks" section or reference the initial instructions to reduce duplication and maintenance overhead.

---

51-51: Fix typographical error and improve clarity.

The word "Instal" is missing an "l". Consider rephrasing for consistency:

- Instal AsyncAPI CLI and use `bundle` command.
+ Install the AsyncAPI CLI and run the `bundle` command to produce a bundled AsyncAPI spec.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro