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

fix(gnovm): correct filetest directive behavior #3697

Merged
merged 5 commits into from
Feb 6, 2025

Conversation

ltzmaxwell
Copy link
Contributor

@ltzmaxwell ltzmaxwell commented Feb 6, 2025

The test result is misleading. Without an output directive set, the current logic does not provide a prompt even when actual output occurs.

package main

func main() {
	println("ok")
}

// Error:
// panic xxx

before fix:

=== RUN TestFiles
=== PAUSE TestFiles
=== CONT TestFiles
=== RUN TestFiles/a111.gno
--- PASS: TestFiles (0.14s)
--- PASS: TestFiles/a111.gno (0.01s)
PASS
ok command-line-arguments 1.619s

after fix:

=== RUN TestFiles
=== PAUSE TestFiles
=== CONT TestFiles
=== RUN TestFiles/a111.gno
files_test.go:92: unexpected output:
ok

--- FAIL: TestFiles (0.13s)
--- FAIL: TestFiles/a111.gno (0.01s)
FAIL
FAIL command-line-arguments 1.479s
FAIL

@ltzmaxwell ltzmaxwell requested a review from thehowl February 6, 2025 14:55
@github-actions github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Feb 6, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Feb 6, 2025

🛠 PR Checks Summary

All Automated Checks passed. ✅

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)

☑️ 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: ltzmaxwell/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this 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

Copy link

codecov bot commented Feb 6, 2025

Codecov Report

Attention: Patch coverage is 40.00000% with 3 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
gnovm/pkg/test/filetest.go 40.00% 2 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

Copy link
Member

@thehowl thehowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we had instead at the beginning of runFiletest, something like:

	if dirs.First(DirectiveOutput) == nil && dirs.First(DirectiveError) == nil {
		return "", errors.New("all filetests require at least an Output or Error directive")
	}

@ltzmaxwell ltzmaxwell force-pushed the fix/maxwell/filetest_directive branch from 3dc3aa8 to b7c3380 Compare February 6, 2025 15:47
gnovm/pkg/test/filetest.go Outdated Show resolved Hide resolved
@thehowl thehowl merged commit ce6a4aa into gnolang:master Feb 6, 2025
64 of 65 checks passed
@ltzmaxwell
Copy link
Contributor Author

ltzmaxwell commented Feb 9, 2025

What if we had instead at the beginning of runFiletest, something like:

	if dirs.First(DirectiveOutput) == nil && dirs.First(DirectiveError) == nil {
		return "", errors.New("all filetests require at least an Output or Error directive")
	}

Sometimes it's not necessary to set a directive, all we need is that it's not panicking, e.g.

package main 

var a int 
var b string
...

The key issue is that a proper directive must be provided whenever an Error or Output occurs. This ensures that the system can handle these events appropriately and take the necessary actions.

Thank for the review. @thehowl

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
Projects
Development

Successfully merging this pull request may close these issues.

3 participants