Skip to content

Document Test Suites#94

Open
Lightning11wins wants to merge 8 commits into
masterfrom
doc-testing
Open

Document Test Suites#94
Lightning11wins wants to merge 8 commits into
masterfrom
doc-testing

Conversation

@Lightning11wins

Copy link
Copy Markdown
Contributor

Add Testing.md to centrallix-sysdoc to document the various test suites and testing methods in Centrallix, including where to find them, how to run them, and how to add additional tests.

Information may be missing or inaccurate, especially regarding the Selenium test suite that I still have never run on my own.

@Lightning11wins Lightning11wins self-assigned this Apr 7, 2026
@Lightning11wins Lightning11wins added testing Includes testing, either new tests or updates to existing tests. ai-review Request AI review for PRs. labels Apr 7, 2026
@Lightning11wins Lightning11wins marked this pull request as draft April 7, 2026 17:23
@Lightning11wins Lightning11wins added the documentation Changes, improvements, or fixes to documentation files. label Apr 7, 2026
@greptile-apps

greptile-apps Bot commented Apr 7, 2026

Copy link
Copy Markdown

Greptile Summary

This PR adds Testing.md to centrallix-sysdoc, providing a comprehensive reference for all four test suites (test-obj, centrallix-lib, CXJS, and Selenium UI), including how to find, run, and extend each suite. It also fixes the C function signature in centrallix/tests/README (**char namechar** name).

  • Testing.md: Documents test locations, run commands, TONLY filtering, output status codes, code coverage, and test case formats for all suites — including a cross-reference to each project's own README.
  • centrallix/tests/README: One-line correction to the native C test function prototype to match actual usage in test source files.

Confidence Score: 5/5

Pure documentation addition with one one-line prose fix to an existing README — no runtime code is touched.

Both files are documentation only. The README fix is a straightforward correction to a C function signature that now matches the actual source files. The new Testing.md is accurate and internally consistent with the existing READMEs it references.

No files require special attention.

Important Files Changed

Filename Overview
centrallix-sysdoc/Testing.md New documentation file covering all four test suites (test-obj, centrallix-lib, CXJS, Selenium). Content is accurate and well-structured; minor typo ("copywrite" → "copyright") and a first-person troubleshooting note in the coverage section.
centrallix/tests/README Single-line fix correcting the C function signature from **char name to char** name, matching the actual usage in the test source files.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Developer runs tests] --> B{Which suite?}
    B --> C[test-obj\nmake test in centrallix/]
    B --> D[centrallix-lib\nmake test in centrallix-lib/]
    B --> E[CXJS\nmake test-js in centrallix/]
    B --> F[Selenium UI\npython3 tests/xxx_test.py]
    C --> C1[Standard: .to + .cmp files\nin centrallix/tests/]
    C --> C2[Native C: test_cat_NN.c\nlong long test char** name]
    D --> D1[C source: test_cat_NN.c\nin centrallix-lib/tests/]
    D --> D2[make valtest\nruns under Valgrind]
    D --> D3[--enable-coverage\ngcov/lcov support]
    E --> E1[node:test API\nrequires node 20+]
    F --> F1[Python + Selenium + ChromeDriver\nconfig.toml with server URL]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[Developer runs tests] --> B{Which suite?}
    B --> C[test-obj\nmake test in centrallix/]
    B --> D[centrallix-lib\nmake test in centrallix-lib/]
    B --> E[CXJS\nmake test-js in centrallix/]
    B --> F[Selenium UI\npython3 tests/xxx_test.py]
    C --> C1[Standard: .to + .cmp files\nin centrallix/tests/]
    C --> C2[Native C: test_cat_NN.c\nlong long test char** name]
    D --> D1[C source: test_cat_NN.c\nin centrallix-lib/tests/]
    D --> D2[make valtest\nruns under Valgrind]
    D --> D3[--enable-coverage\ngcov/lcov support]
    E --> E1[node:test API\nrequires node 20+]
    F --> F1[Python + Selenium + ChromeDriver\nconfig.toml with server URL]
Loading

Reviews (4): Last reviewed commit: "Merge branch 'master' into doc-testing" | Re-trigger Greptile

Comment thread centrallix-sysdoc/Testing.md Outdated
@Lightning11wins

Copy link
Copy Markdown
Contributor Author

@greptileai I've resolved your comments, can you rereview? Remember, I'd like to make MINIMAL changes to that README file in centrallix/tests even though I now have changes there because it's outside the tight scope of this small documentation project.

@Lightning11wins

Copy link
Copy Markdown
Contributor Author

Oops, forgot about the blocking issues in our questions thread. My bad.

@Lightning11wins Lightning11wins added size: medium Might be hard to review, usually less than ~5000 lines. blocked No more work can be done until other work is completed. labels Apr 27, 2026
@Lightning11wins Lightning11wins removed the blocked No more work can be done until other work is completed. label Jun 5, 2026
@Lightning11wins

Copy link
Copy Markdown
Contributor Author

The blockers have been resolved, proceeding to review.

@Lightning11wins Lightning11wins marked this pull request as ready for review June 5, 2026 23:06
@Lightning11wins

Copy link
Copy Markdown
Contributor Author

This PR is ready for human review.

@Lightning11wins

Lightning11wins commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

I think I'm going to document the test suite added in #128 here, even though it's not on master yet, since it'll probably be on master by the time this is reviewed, or at least soon afterword.

Edit: Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-review Request AI review for PRs. documentation Changes, improvements, or fixes to documentation files. size: medium Might be hard to review, usually less than ~5000 lines. testing Includes testing, either new tests or updates to existing tests.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant