chore: remove extra space in comment#3319
Conversation
Signed-off-by: box4wangjing <box4wangjing@outlook.com>
📝 WalkthroughWalkthroughThree comment and documentation updates across test files. A scenario description in the DA-inclusion restart test is refined, and benchmark test command comments in the AWS and GCP signer test files are corrected for spacing and consistency. ChangesTest Documentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@pkg/signer/aws/signer_benchmark_test.go`:
- Around line 16-18: Update the benchmark comment in signer_benchmark_test.go to
use the correct AWS environment variables and test path: replace
EVNODE_E2E_GCP_KMS_KEY_NAME and EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE with the AWS
equivalents (e.g., EVNODE_E2E_AWS_KMS_KEY_ID and an AWS credentials/secret var)
and include EVNODE_E2E_AWS_KMS_REGION (or the region vars used elsewhere in this
file), and change the go test path from ./pkg/signer/gcp to ./pkg/signer/aws so
the documented commands match the AWS KMS benchmark in this file.
In `@pkg/signer/gcp/signer_benchmark_test.go`:
- Around line 16-18: Update the benchmark comment in
pkg/signer/gcp/signer_benchmark_test.go to reference the correct GCP env vars
and package path: replace the AWS env vars (EVNODE_E2E_AWS_KMS_KEY_ID,
EVNODE_E2E_AWS_KMS_REGION) with the GCP ones used by this benchmark
(EVNODE_E2E_GCP_KMS_KEY_NAME and EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE) and change
the test path from ./pkg/signer/aws to ./pkg/signer/gcp (the comment pertains to
BenchmarkKmsSignerSign in this GCP signer test).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 959250e6-9f35-4818-9038-aeb38827e785
📒 Files selected for processing (3)
block/internal/submitting/submitter_test.gopkg/signer/aws/signer_benchmark_test.gopkg/signer/gcp/signer_benchmark_test.go
| // export EVNODE_E2E_GCP_KMS_KEY_NAME=projects/<project-id>/locations/<region>/keyRings/<keyring-name>/cryptoKeys/<key-name>/cryptoKeyVersions/1 | ||
| // export EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE=... | ||
| // go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/gcp | ||
| // go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/gcp |
There was a problem hiding this comment.
Wrong environment variables and test path in benchmark documentation.
The comment documentation has critical errors:
-
Lines 16-17 reference GCP KMS environment variables (
EVNODE_E2E_GCP_KMS_KEY_NAME,EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE), but this is an AWS KMS benchmark test that actually usesEVNODE_E2E_AWS_KMS_KEY_ID(line 20) and AWS region variables (lines 25-29). -
Line 18 references the wrong test path
./pkg/signer/gcp, but this file ispkg/signer/aws/signer_benchmark_test.go, so the path should be./pkg/signer/aws.
Developers following these comments will set the wrong environment variables and target the wrong package.
📝 Proposed fix for the documentation
-// BenchmarkKmsSignerSign test kms round trip
-// export EVNODE_E2E_GCP_KMS_KEY_NAME=projects/<project-id>/locations/<region>/keyRings/<keyring-name>/cryptoKeys/<key-name>/cryptoKeyVersions/1
-// export EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE=...
-// go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/gcp
+// BenchmarkKmsSignerSign test kms round trip
+// export EVNODE_E2E_AWS_KMS_KEY_ID="arn:aws:kms:...."
+// export EVNODE_E2E_AWS_KMS_REGION=eu-west-1
+// go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/aws🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@pkg/signer/aws/signer_benchmark_test.go` around lines 16 - 18, Update the
benchmark comment in signer_benchmark_test.go to use the correct AWS environment
variables and test path: replace EVNODE_E2E_GCP_KMS_KEY_NAME and
EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE with the AWS equivalents (e.g.,
EVNODE_E2E_AWS_KMS_KEY_ID and an AWS credentials/secret var) and include
EVNODE_E2E_AWS_KMS_REGION (or the region vars used elsewhere in this file), and
change the go test path from ./pkg/signer/gcp to ./pkg/signer/aws so the
documented commands match the AWS KMS benchmark in this file.
| // export EVNODE_E2E_AWS_KMS_KEY_ID="arn:aws:kms:...." | ||
| // export EVNODE_E2E_AWS_KMS_REGION=eu-west-1 | ||
| // go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/aws | ||
| // go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/aws |
There was a problem hiding this comment.
Wrong environment variables and test path in benchmark documentation.
The comment documentation has critical errors:
-
Lines 16-17 reference AWS KMS environment variables (
EVNODE_E2E_AWS_KMS_KEY_ID,EVNODE_E2E_AWS_KMS_REGION), but this is a GCP KMS benchmark test that actually usesEVNODE_E2E_GCP_KMS_KEY_NAME(line 20) andEVNODE_E2E_GCP_KMS_CREDENTIALS_FILE(line 25). -
Line 18 references the wrong test path
./pkg/signer/aws, but this file ispkg/signer/gcp/signer_benchmark_test.go, so the path should be./pkg/signer/gcp.
Developers following these comments will set the wrong environment variables and target the wrong package.
📝 Proposed fix for the documentation
-// BenchmarkKmsSignerSign test kms round trip
-// export EVNODE_E2E_AWS_KMS_KEY_ID="arn:aws:kms:...."
-// export EVNODE_E2E_AWS_KMS_REGION=eu-west-1
-// go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/aws
+// BenchmarkKmsSignerSign test kms round trip
+// export EVNODE_E2E_GCP_KMS_KEY_NAME=projects/<project-id>/locations/<region>/keyRings/<keyring-name>/cryptoKeys/<key-name>/cryptoKeyVersions/1
+// export EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE=...
+// go test -v -bench=BenchmarkKmsSignerSign -benchtime=3s -count=10 -run='^$' ./pkg/signer/gcp🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@pkg/signer/gcp/signer_benchmark_test.go` around lines 16 - 18, Update the
benchmark comment in pkg/signer/gcp/signer_benchmark_test.go to reference the
correct GCP env vars and package path: replace the AWS env vars
(EVNODE_E2E_AWS_KMS_KEY_ID, EVNODE_E2E_AWS_KMS_REGION) with the GCP ones used by
this benchmark (EVNODE_E2E_GCP_KMS_KEY_NAME and
EVNODE_E2E_GCP_KMS_CREDENTIALS_FILE) and change the test path from
./pkg/signer/aws to ./pkg/signer/gcp (the comment pertains to
BenchmarkKmsSignerSign in this GCP signer test).
1 participant
Overview
remove extra space in comment
Summary by CodeRabbit