Add unit tests for sSerialFlowToStr#15
Add unit tests for sSerialFlowToStr#15zknpr wants to merge 1 commit intosecurity-fixes-and-community-prsfrom
Conversation
Added a new test suite 'tests/test_serial.c' to verify the behavior of 'sSerialFlowToStr' function in 'src/serial.c'. Updated CMake configuration to enable testing and include the new test. Co-authored-by: zknpr <96851588+zknpr@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Summary of ChangesHello @zknpr, 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! This pull request significantly enhances the project's testing capabilities by introducing a new unit test for the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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 by creating a comment using either
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a testing infrastructure using CTest and adds the first unit test for sSerialFlowToStr. The changes are well-structured, and the test cases provide good coverage for the target function. I have one suggestion to improve the structure of the test file for better long-term maintainability as more tests are added to the project. Overall, this is a great addition to improve code quality and robustness.
| int main(void) { | ||
| struct { | ||
| eSerialFlow flow; | ||
| const char *expected; | ||
| } test_cases[] = { | ||
| {SERIAL_FLOW_NONE, "none"}, | ||
| {SERIAL_FLOW_RTSCTS, "hardware"}, | ||
| {SERIAL_FLOW_XONXOFF, "software"}, | ||
| {SERIAL_FLOW_RS485_RTS_AFTER_SEND, "rs485 rts after send"}, | ||
| {SERIAL_FLOW_RS485_RTS_ON_SEND, "rs485 rts on send"}, | ||
| {SERIAL_FLOW_UNKNOWN, "Unknown"}, | ||
| {(eSerialFlow)99, "Unknown"} | ||
| }; | ||
|
|
||
| int num_cases = sizeof(test_cases) / sizeof(test_cases[0]); | ||
| int failed = 0; | ||
|
|
||
| for (int i = 0; i < num_cases; i++) { | ||
| const char *result = sSerialFlowToStr(test_cases[i].flow); | ||
| if (strcmp(result, test_cases[i].expected) != 0) { | ||
| fprintf(stderr, "Test failed for flow %d: expected '%s', got '%s'\n", | ||
| (int)test_cases[i].flow, test_cases[i].expected, result); | ||
| failed = 1; | ||
| } | ||
| } | ||
|
|
||
| if (failed) { | ||
| return 1; | ||
| } | ||
|
|
||
| printf("All tests passed\n"); | ||
| return 0; | ||
| } |
There was a problem hiding this comment.
This is a great first test! To improve the structure and make it easier to add more tests in the future, consider organizing tests into separate functions. This approach enhances modularity and provides clearer test reports, such as a count of failed tests. Here's a suggested refactoring that encapsulates the test logic in its own function and uses a failure counter.
static int run_sSerialFlowToStr_tests() {
struct {
eSerialFlow flow;
const char *expected;
} test_cases[] = {
{SERIAL_FLOW_NONE, "none"},
{SERIAL_FLOW_RTSCTS, "hardware"},
{SERIAL_FLOW_XONXOFF, "software"},
{SERIAL_FLOW_RS485_RTS_AFTER_SEND, "rs485 rts after send"},
{SERIAL_FLOW_RS485_RTS_ON_SEND, "rs485 rts on send"},
{SERIAL_FLOW_UNKNOWN, "Unknown"},
{(eSerialFlow)99, "Unknown"}
};
int num_cases = sizeof(test_cases) / sizeof(test_cases[0]);
int failures = 0;
for (int i = 0; i < num_cases; i++) {
const char *result = sSerialFlowToStr(test_cases[i].flow);
if (strcmp(result, test_cases[i].expected) != 0) {
fprintf(stderr, "Test failed for sSerialFlowToStr(%d): expected '%s', got '%s'\n",
(int)test_cases[i].flow, test_cases[i].expected, result);
failures++;
}
}
return failures;
}
int main(void) {
int total_failures = 0;
total_failures += run_sSerialFlowToStr_tests();
if (total_failures > 0) {
fprintf(stderr, "\n%d test(s) failed.\n", total_failures);
return 1;
}
printf("All tests passed\n");
return 0;
}|
Tests merged into v1.5.3 as combined test suite. Thank you Jules! |
You're welcome! Glad to hear the tests are merged. |
Add comprehensive test suite for serial port configuration functions: - sSerialFlowToStr: flow control type conversion - sSerialDataBitsToStr: data bits conversion - sSerialStopBitsToStr: stop bits conversion - sSerialParityToStr: parity conversion Test infrastructure: - tests/test_serial.c: All serial function tests - tests/CMakeLists.txt: CTest integration - BUILD_TESTING option in main CMakeLists.txt Based on Jules AI contributions from PRs #10, #11, #14, #15 Reviewed by: Gemini Code Assist Co-Authored-By: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
🎯 What:
Added a new unit test for
sSerialFlowToStrinsrc/serial.c.📊 Coverage:
The test covers all enum values of
eSerialFlow:SERIAL_FLOW_NONE-> "none"SERIAL_FLOW_RTSCTS-> "hardware"SERIAL_FLOW_XONXOFF-> "software"SERIAL_FLOW_RS485_RTS_AFTER_SEND-> "rs485 rts after send"SERIAL_FLOW_RS485_RTS_ON_SEND-> "rs485 rts on send"SERIAL_FLOW_UNKNOWNand invalid values -> "Unknown"✨ Result:
Improved test coverage for serial configuration string conversion. The project now has a testing infrastructure using CTest.
PR created automatically by Jules for task 15767447349940031235 started by @zknpr