Skip to content

Commit

Permalink
add timer readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bdemann committed Nov 1, 2024
1 parent 8cff886 commit 425740a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
2 changes: 1 addition & 1 deletion tests/property/ic_api/inspect_message/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Current Status

We have decided that the `inspect_message`, `accept_message`, and `method_name` functions are sufficiently tested in the following location:
tests/property/ic_api/inspect_message/
tests/end_to_end/candid_rpc/class_syntax/inspect_message/

These existing tests provide adequate coverage for the current release candidate. They ensure that all the APIs are called correctly and function as expected.

Expand Down
26 changes: 26 additions & 0 deletions tests/property/ic_api/timers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# clear_timer, set_timer, and set_timer_interval Tests

## Current Status

We have decided that the `clear_timer`, `set_timer`, and `set_timer_interval` functions are sufficiently tested in the following location:
tests/end_to_end/candid_rpc/class_syntax/timers/

These existing tests provide adequate coverage for the current release candidate. They ensure that all the APIs are called correctly and function as expected.

## Future Work

While the current tests are sufficient for the release candidate, there is potential for future improvements:

1. Add more property-based tests to increase coverage and robustness.
2. Expand test scenarios to cover different ways and places to call these functions.
3. Implement additional edge cases and error handling tests.

## Current Approach

For the time being, we are confident that the existing tests in the end-to-end directory provide enough coverage to proceed with the release candidate. This approach allows us to:

1. Ensure core functionality is working correctly.
2. Meet current release deadlines.
3. Plan for future enhancements in subsequent releases.

As development progresses and more complex use cases arise, we may revisit this decision and expand the test suite accordingly.

0 comments on commit 425740a

Please sign in to comment.