GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-08-19 19:03:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
taskwarrior/taskchampion/integration-tests
History
Dustin J. Mitchell 7f68441916
Change "client key" to "client id" (#3130) 
In #3118 @ryneeverett mentioned that "key" suggests that this is a
secret, when in truth it's just a user identifier. So "ID" is a better
word for it than "key".
2023-07-11 22:13:53 -04:00
..
src Add support for _not_ creating a DB if one does not exist 2022-12-18 13:01:32 -05:00
tests Change "client key" to "client id" (#3130) 2023-07-11 22:13:53 -04:00
.gitignore rename rust/ to taskchampion/ 2022-07-29 21:41:41 -04:00
build.rs Use ffizz_header to generate taskchampion.h 2023-06-19 13:36:17 -04:00
Cargo.toml Put Rust deps at the root of the workspace 2023-06-21 12:01:06 -04:00
README.md rename rust/ to taskchampion/ 2022-07-29 21:41:41 -04:00

README.md

Integration Tests for Taskchampion

"Regular" Tests

Some of the tests in tests/ are just regular integration tests. Nothing exciting to see.

Bindings Tests

The bindings tests are a bit more interesting, since they are written in C. They are composed of a collection of "suites", each in one C file in integration-tests/src/bindings_tests/. Each suite contains a number of tests (using Unity) and an exported function named after the suite that returns an exit status (1 = failure).

The build script (integration-tests/build.rs) builds these files into a library that is linked with the integration_tests library crate. This crate contains a bindings_tests module with a pub function for each suite.

Finally, the integration-tests/tests/bindings.rs test file calls each of those functions in a separate test case.

Adding Tests

To add a test, select a suite and add a new test-case function. Add a RUN_TEST invocation for your new function to the .._tests function at the bottom. Keep the RUN_TESTs in the same order as the functions they call.

Adding Suites

To add a suite,

  1. Add a new C file in integration-tests/src/bindings_tests/, based off of one of the others.
  2. Add a the suite name to suites in integration-tests/build.rs.