🧪 Add tests for sSerialDataBitsToStr and enable testing#11
🧪 Add tests for sSerialDataBitsToStr and enable testing#11zknpr wants to merge 1 commit intosecurity-fixes-and-community-prsfrom
Conversation
Added a new test file `tests/test_serial.c` to test the `sSerialDataBitsToStr` function in `src/serial.c`. Updated `CMakeLists.txt` to enable testing and register the new test. Made `libmodbus` dependency optional in `CMakeLists.txt` so that tests can be built and run even if `libmodbus` is not present on the system. Verified that `test_serial` passes all cases. 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 infrastructure and build flexibility. It introduces dedicated unit tests 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 successfully adds unit tests for the sSerialDataBitsToStr function and configures the build system to support them. The changes in CMakeLists.txt to make libmodbus optional and enable CTest are well-implemented. I've suggested an improvement to the new test file to make the testing infrastructure more robust and scalable for the future. Overall, this is a great addition to improve code quality and test coverage.
| #include <stdio.h> | ||
| #include <string.h> | ||
| #include <assert.h> | ||
| #include "serial.h" | ||
|
|
||
| void test_sSerialDataBitsToStr() { | ||
| // Test known values | ||
| assert(strcmp(sSerialDataBitsToStr(SERIAL_DATABIT_5), "5") == 0); | ||
| assert(strcmp(sSerialDataBitsToStr(SERIAL_DATABIT_6), "6") == 0); | ||
| assert(strcmp(sSerialDataBitsToStr(SERIAL_DATABIT_7), "7") == 0); | ||
| assert(strcmp(sSerialDataBitsToStr(SERIAL_DATABIT_8), "8") == 0); | ||
|
|
||
| // Test unknown value | ||
| assert(strcmp(sSerialDataBitsToStr(SERIAL_DATABIT_UNKNOWN), "Unknown") == 0); | ||
|
|
||
| // Test arbitrary unknown value | ||
| assert(strcmp(sSerialDataBitsToStr((eSerialDataBits)123), "Unknown") == 0); | ||
|
|
||
| printf("test_sSerialDataBitsToStr passed\n"); | ||
| } | ||
|
|
||
| int main() { | ||
| test_sSerialDataBitsToStr(); | ||
| printf("All tests passed!\n"); | ||
| return 0; | ||
| } |
There was a problem hiding this comment.
While using assert is a quick way to add tests, it has a couple of drawbacks:
- It aborts on the first failure, preventing other tests from running.
- It can be disabled with the
NDEBUGmacro, which could lead to tests silently passing in release builds.
To make the new test suite more robust and scalable for future tests, I suggest a simple test runner structure that reports all failures and isn't affected by build configurations. This will provide better feedback when tests fail and ensure they always run.
#include <stdio.h>
#include <string.h>
#include "serial.h"
// Keep track of test results
static int tests_run = 0;
static int tests_failed = 0;
// A simple assertion helper for string comparison
#define ASSERT_STR_EQ(actual, expected) \
do { \
tests_run++; \
const char* _actual = (actual); \
const char* _expected = (expected); \
if (strcmp(_actual, _expected) != 0) { \
printf("FAIL: %s:%d: expected \"%s\", but got \"%s\"\n", __FILE__, __LINE__, _expected, _actual); \
tests_failed++; \
} \
} while (0)
void test_sSerialDataBitsToStr() {
// Test known values
ASSERT_STR_EQ(sSerialDataBitsToStr(SERIAL_DATABIT_5), "5");
ASSERT_STR_EQ(sSerialDataBitsToStr(SERIAL_DATABIT_6), "6");
ASSERT_STR_EQ(sSerialDataBitsToStr(SERIAL_DATABIT_7), "7");
ASSERT_STR_EQ(sSerialDataBitsToStr(SERIAL_DATABIT_8), "8");
// Test unknown value
ASSERT_STR_EQ(sSerialDataBitsToStr(SERIAL_DATABIT_UNKNOWN), "Unknown");
// Test arbitrary unknown value
ASSERT_STR_EQ(sSerialDataBitsToStr((eSerialDataBits)123), "Unknown");
}
int main() {
test_sSerialDataBitsToStr();
if (tests_failed > 0) {
printf("\n%d of %d tests failed.\n", tests_failed, tests_run);
return 1;
}
printf("\nAll %d tests passed!\n", tests_run);
return 0;
}|
Tests merged into v1.5.3 as combined test suite. Thank you Jules! |
You're welcome! Happy to help improve the test coverage. |
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>
This PR adds unit tests for
sSerialDataBitsToStrfunction insrc/serial.c.It also updates
CMakeLists.txtto:test_serialexecutable and test.libmodbusoptional, allowingmbpollexecutable build to be skipped if the library is missing, while still allowing tests (which don't depend on it) to run.Coverage:
SERIAL_DATABIT_5-> "5"SERIAL_DATABIT_6-> "6"SERIAL_DATABIT_7-> "7"SERIAL_DATABIT_8-> "8"SERIAL_DATABIT_UNKNOWN-> "Unknown"Result:
sSerialDataBitsToStris now fully tested.ctestcan be used to run the tests.PR created automatically by Jules for task 5224006931548150945 started by @zknpr