Problem: use prebuilt image in testground #1480
Conversation
Solution: - build image manually, don't use testground builders at all. - update doc.
yihuang
requested review from
devashishdxt and
thomas-nguy
and removed request for
a team
|
Warning Rate limit exceeded@yihuang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 7 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughRecent updates to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Cli
participant TestgroundDaemon
User->>Cli: Execute command
Cli->>Cli: Filter `<jemalloc>:` warnings
Cli->>User: Return filtered stdout
User->>TestgroundDaemon: Build image with nix
TestgroundDaemon->>User: Image built and loaded
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Signed-off-by: yihuang <[email protected]>
Signed-off-by: yihuang <[email protected]>
![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
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- testground/README.md (2 hunks)
- testground/benchmark/benchmark/cli.py (1 hunks)
- testground/benchmark/compositions/local.toml (2 hunks)
- testground/benchmark/manifest.toml (1 hunks)
Files skipped from review due to trivial changes (1)
- testground/benchmark/manifest.toml
Additional context used
Markdownlint
testground/README.md
71-71: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
34-34: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
44-44: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
50-50: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
58-58: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symbol
Additional comments not posted (5)
testground/benchmark/compositions/local.toml (1)
27-28: Ensure the artifact URL is correct and accessible for the fullnodes group.Similar to the validators group, ensure that the specified Docker image is correct and accessible.
testground/README.md (3)
3-14: Refine Build Image section for clarity and completeness.The new prerequisites and instructions for building images locally using
nixare clear. Ensure all necessary steps are included and accurately described.Tools
Markdownlint
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symbol
31-31: Ensure clarity in the instructions for running the Testground Daemon.The command provided should be clear and functional. Verify that the environment variable
TESTGROUND_HOMEis correctly set and used.
Line range hint
58-58: Ensure macOS instructions are specific and accurate.The instructions for macOS users using
colimashould be verified for accuracy and specificity. Ensure that the symbolic link and mount points are correctly configured.Verification successful
The output indicates that the symbolic link is not configured. This suggests that either the instructions in the README.md are incorrect or the symbolic link was not created properly. To proceed, we need to verify the exact instructions provided in the README.md file to ensure they are correctly guiding the user to create this symbolic link.
The instructions in the README.md file to create a symbolic link from
$HOME/.colima/docker.sockto/var/run/docker.sockare correct. However, the symbolic link was not found during the script execution. This might indicate an issue with the execution environment or user permissions.To ensure the instructions are clear and specific, we need to verify if there are any missing steps or prerequisites that need to be addressed in the README.md. This includes checking for any setup steps required for
colimaand Docker on macOS.
The extracted macOS section from the README.md file includes instructions to create the symbolic link and mount the related directories into the virtual machine. The instructions appear to be correct and specific.
Given that the symbolic link was not found during the script execution, it is possible that the issue lies in the execution environment or user permissions rather than the instructions themselves.
- Ensure you have the necessary permissions to create the symbolic link.
- Verify that
$HOME/.colima/docker.sockexists before creating the symbolic link.If these conditions are met, the instructions should work as intended.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the macOS instructions for accuracy. # Test: Check if the symbolic link and mount points are correctly configured. test -L /var/run/docker.sock && echo "Symbolic link is configured" || echo "Symbolic link is not configured"Length of output: 103
Script:
#!/bin/bash # Extract the relevant section from the README.md file to verify the instructions for macOS users using colima. sed -n '58p' testground/README.mdLength of output: 93
Script:
#!/bin/bash # Extract the entire macOS section from the README.md file to verify if there are any missing steps or prerequisites. sed -n '50,70p' testground/README.mdLength of output: 503
Tools
Markdownlint
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symboltestground/benchmark/benchmark/cli.py (1)
12-22: Review the updated filtering logic inrawmethod.The addition of logic to filter out
<jemalloc>:warning messages is a good improvement. Ensure that this change does not inadvertently filter out necessary information from other stdout messages.
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (2)
testground/README.md (2)
Line range hint
38-49: Clarify the path in 'Run Test Plan' section.The paths provided in the instructions need to be accurate to prevent confusion. Ensure that the path reflects the correct location of
local.tomland other resources.- $ TESTGROUND_HOME=$PWD/data testground plan import --from /path/to/cronos/testground/benchmark + $ TESTGROUND_HOME=$PWD/data testground plan import --from testground/benchmark/compositions - $ testground run composition -f /path/to/cronos/testground/benchmark/compositions/local.toml --wait + $ testground run composition -f testground/benchmark/compositions/local.toml --waitTools
Markdownlint
33-33: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
Line range hint
70-70: Remove unnecessary blank lines.There are multiple consecutive blank lines which should be removed to maintain consistency in document formatting.
- -Tools
Markdownlint
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symbol
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- testground/README.md (2 hunks)
- testground/benchmark/compositions/local.toml (2 hunks)
- testground/benchmark/manifest.toml (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- testground/benchmark/compositions/local.toml
- testground/benchmark/manifest.toml
Additional context used
Markdownlint
testground/README.md
70-70: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
33-33: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
43-43: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
49-49: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
57-57: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symbol
Additional comments not posted (3)
testground/README.md (3)
3-15: Updated Build Image instructions are clear and detailed.The revised section on building images provides clear instructions for both general and macOS-specific scenarios. The use of
nixfor building and the steps to load the Docker image are well-documented. This should help users in setting up their environments correctly.Tools
Markdownlint
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symbol
Line range hint
17-29: Installation instructions for Testground are clearly outlined.The steps to install Testground, including cloning the repository and building dependencies, are well explained. This ensures that even users unfamiliar with the process can follow along without issues.
Tools
Markdownlint
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symbol
Line range hint
50-63: Instructions for macOS users are helpful.The additional instructions for macOS users regarding
colimaand Docker socket setup are useful. This ensures that macOS users can configure their environments appropriately.Tools
Markdownlint
5-5: null (MD027, no-multiple-space-blockquote)
Multiple spaces after blockquote symbol
Signed-off-by: yihuang <[email protected]>
Solution:
👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻
PR Checklist:
make)make test)go fmt)golangci-lint run)go list -json -m all | nancy sleuth)Thank you for your code, it's appreciated! :)
Summary by CodeRabbit
Documentation
nix.Bug Fixes
<jemalloc>:warning messages from command output incli.py.Refactor
manifest.tomlfromdocker:nixtodocker:go.local.tomlwith artifact fields forvalidatorsandfullnodes.