Skip to content

Commit

Permalink
Merge pull request #2177 from demergent-labs/readme_prop_tests
Browse files Browse the repository at this point in the history
Read me prop tests
  • Loading branch information
lastmjs authored Dec 9, 2024
2 parents 04c9a0d + 716ed65 commit dfd1a86
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 0 deletions.
28 changes: 28 additions & 0 deletions tests/property/ic_api/accept_message/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# accept_message Tests

## Current Status

We have decided that the `accept_message` function is sufficiently tested for release candidate in the following locations:

- tests/end_to_end/candid_rpc/class_syntax/inspect_message/
- tests/property/candid_rpc/class_api/canister_methods/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.

## 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.
28 changes: 28 additions & 0 deletions tests/property/ic_api/method_name/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# method_name Tests

## Current Status

We have decided that the `method_name` function is sufficiently tested for release candidate in the following locations:

- tests/end_to_end/candid_rpc/class_syntax/inspect_message/
- tests/property/candid_rpc/class_api/canister_methods/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.

## 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.
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 for release candidate 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 dfd1a86

Please sign in to comment.