Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(gnovm): Result Caching for filetest #3955

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

notJoon
Copy link
Member

@notJoon notJoon commented Mar 17, 2025

Description

Cache the test results for filetest. For *_test.gno files, caching has not yet been implemented since previous test execution results can sometimes affect other tests.

  1. Test Result Caching:
    • Cached results are reused when test file content remains unchanged
    • Cache is stored in the ~/.gno-test-cache directory
  2. Cache Invalidation:
    • Automatically invalidated cache when test file content changes
    • Cache usage can be completely disabled with the -no-cache flag 1

Usage

Run the test command as you would for a regular test execution when not using the no-cache option.

gno test <test_path> -v

When running the same test more than once without any modifications, it will be marked as CACHED as shown below. (Using the p/demo/avl package as an example.)

$ gno test examples/gno.land/p/demo/avl/node_test.gno -v

...
=== RUN   TestTreeReverseIterateByOffset
--- PASS: TestTreeReverseIterateByOffset (0.00s)
=== RUN   file/z_0_filetest.gno
=== CACHED file/z_0_filetest.gno (0.01s)
false 2
=== RUN   file/z_1_filetest.gno
=== CACHED file/z_1_filetest.gno (0.01s)
false 3
=== RUN   file/z_2_filetest.gno
=== CACHED file/z_2_filetest.gno (0.01s)
false 3
ok      examples/gno.land/p/demo/avl    1.18s

To disable caching, add the -no-cache flag as shown below:

gno test <test_path> -v -no-cache
$ gno test examples/gno.land/p/demo/avl/node_test.gno -v -no-cache

...
--- PASS: TestTreeIterateByOffset (0.00s)
=== RUN   TestTreeReverseIterateByOffset
--- PASS: TestTreeReverseIterateByOffset (0.00s)
=== RUN   file/z_0_filetest.gno
false 2
--- PASS: file/z_0_filetest.gno (0.01s)
=== RUN   file/z_1_filetest.gno
false 3
--- PASS: file/z_1_filetest.gno (0.02s)
=== RUN   file/z_2_filetest.gno
false 3
--- PASS: file/z_2_filetest.gno (0.02s)
ok      examples/gno.land/p/demo/avl    1.39s

Footnotes

  1. While Go doesn't have a no-cache flag, the idiomatic approach is to use -count 1.

@github-actions github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Mar 17, 2025
@Gno2D2 Gno2D2 requested a review from a team March 17, 2025 07:25
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Mar 17, 2025

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: notJoon/gno-core)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

Sorry, something went wrong.

Copy link

codecov bot commented Mar 17, 2025

Codecov Report

Attention: Patch coverage is 51.44928% with 67 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
gnovm/pkg/test/cache.go 51.37% 38 Missing and 15 partials ⚠️
gnovm/pkg/test/test.go 33.33% 11 Missing and 3 partials ⚠️

📢 Thoughts on this report? Let us know!

@notJoon notJoon marked this pull request as ready for review March 18, 2025 03:52
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Mar 18, 2025
@jefft0
Copy link
Contributor

jefft0 commented Mar 20, 2025

@notJoon , please add tests to fix the failed codecov CI check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 🤖 gnovm Issues or PRs gnovm related review/triage-pending PRs opened by external contributors that are waiting for the 1st review
Projects
Status: No status
Status: Triage
Development

Successfully merging this pull request may close these issues.

None yet

3 participants