Adds a detailed developer-facing testing guide for Kmesh contributors. #1468
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @AkarshSahlot, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've introduced a new developer-facing testing guide for the Kmesh project. This guide aims to provide clear, step-by-step instructions for contributors on how to run different types of tests, including Go, BPF, and shell-based integration tests. It also covers Docker-based testing workflows and offers solutions for common troubleshooting scenarios, ensuring a smoother development and contribution experience.
Highlights
- New Developer Testing Guide: I've added a new file, docs/testing.md, which serves as a comprehensive guide for Kmesh contributors on how to effectively run and manage tests within the project. This document aims to streamline the testing process for both new and experienced developers.
- Comprehensive Test Execution Instructions: The new guide provides detailed instructions for executing various types of tests, including Go unit tests, BPF unit tests, shell-based integration tests, and Docker-based test flows. It also outlines recommended approaches for different platforms, such as Linux and macOS (Apple Silicon/UTM/ARM).
- Troubleshooting and Known Issues: To assist developers with common hurdles, the guide includes a dedicated troubleshooting section. This covers solutions for issues like missing BPF object files, Go version errors (specifically with Go 1.23 format), Docker permission denied errors, and problems related to missing securec headers.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
New guide now stands,Tests run smooth, code flows free,Knowledge lights the way.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Signed-off-by: AkarshSahlot <[email protected]>
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive developer-facing testing guide. The guide is well-structured and covers various testing scenarios, including local, Docker-based, and manual testing, along with troubleshooting common issues. My review identified a couple of incorrect commands for running BPF unit tests. Correcting these will ensure developers can successfully run all test suites as described.
| | Type | Location | Command | | ||
| |--------------|-------------------------------------|---------------------------------------| | ||
| | Go Unit Test | All Go modules (e.g. pkg/, cmd/) | `go test ./...` | | ||
| | BPF UT | test/bpf_ut/ | `make -C test/bpf_ut test` | |
There was a problem hiding this comment.
The command to run BPF unit tests is incorrect. The Makefile in test/bpf_ut/ does not have a test target. The correct target to run the tests is run.
| | BPF UT | test/bpf_ut/ | `make -C test/bpf_ut test` | | |
| | BPF UT | test/bpf_ut/ | `make -C test/bpf_ut run` | |
| To verify BPF-specific tests: | ||
|
|
||
| ```bash | ||
| make -C test/bpf_ut test |
There was a problem hiding this comment.
This command for verifying BPF-specific tests is incorrect. The Makefile in test/bpf_ut/ does not have a test target. The correct command should use the run target.
| make -C test/bpf_ut test | |
| make -C test/bpf_ut run |
AkarshSahlot
force-pushed
the
docs/testing-guide
branch
from
f474f87 to
dd71ccf
Compare
| @@ -0,0 +1,194 @@ | |||
| # Kmesh Developer Testing Guide | |||
There was a problem hiding this comment.
We already have similar docs in Kmesh website. You can imporve existing ones if you'd like to :)
There was a problem hiding this comment.
ok I will work on improving the existing one
3 participants
Explains how to run:
Go unit tests
BPF UTs
Shell-based integration tests
Docker-based test flow (and permissions)
also Includes known troubleshooting steps for issues with .o files, securec.h, Go 1.23 format, and Docker access.
I also Linked from kmesh_development_guide.md
New file created: docs/testing.md
Fixes #375