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

Finish [SuppressTempFileChecks] attribute functionality, #898 #1084

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

paulirwin
Copy link
Contributor

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a change, please open an issue to discuss the change or find an existing issue.

Finishes implementation of the [SuppressTempFileChecks] attribute functionality.

Fixes #898

Description

This attribute will cause the tear down logic to swallow any exceptions when cleaning up temporary files after the tests run. No tests actually need this attribute, but theoretically it is possible that a TestFramework user might want this.

This also fixes an issue where the previous code was treating all tests as if it had this attribute, and was not throwing if removing the temporary files failed. This change will make our tests more reliable by ensuring they fail if temp file handles are held during cleanup.

I'm also open to removing this attribute, since none of our tests need it and latest Lucene doesn't use it internally either. It could be viewed as a bad practice to just ignore these files being held too long.

@paulirwin paulirwin added the notes:bug-fix Contains a fix for a bug label Jan 2, 2025
@paulirwin paulirwin requested a review from NightOwl888 January 2, 2025 04:40
@paulirwin paulirwin requested a review from NightOwl888 January 5, 2025 00:22
@@ -938,6 +937,10 @@ public virtual void TearDown()

if (result.ResultState == ResultState.Failure || result.ResultState == ResultState.Error)
{
// LUCENENET specific - Track that at least one test in the suite failed.
// LUCENENET TODO: finish implementation of RuleChains so this is not needed (#1088)
SuiteFailureMarker = false;
Copy link
Contributor

Choose a reason for hiding this comment

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

There is nothing resetting this back to true, so the first failure will cascade to the other tests. I think we were better off with this hard coded to true because this will leave lots of temp files on the disk for passing tests.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is indeed the point. It tracks whether there have been any failures. In Lucene, suiteFailureMarker is static and is flagged as failed if any tests fail.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, thanks for the clarification. I thought this was only per test.

Copy link
Contributor

Choose a reason for hiding this comment

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

According to ChatGPT, that isn't how that works. It resets the state at the beginning of every test: https://chatgpt.com/share/677af21b-bcb8-8005-ad95-b070d0c6cdaa.

But whatever the case, I am hesitant to merge this to master when a test failure could leave all of the temporary files on disk for every successful test in the assembly that runs after it. There is a specific setting for that: tests:leavetmpdir.

Side note: In NUnit, a failure isn't always an exception and Assert.Pass() throws a SuccssException. So, the TestRuleMarkFailure logic won't work as-is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I really debated whether we should even be doing this anyways in the issue comments. Again, no Lucene tests even use this attribute. I'll let you take ownership of this one from here because I'm losing interest in the purity aspect of getting this working when there is no actual benefit to our code. You can feel free to use whatever of this PR might be useful in your other test framework changes and I'm just going to mark this as draft for now. I'd appreciate getting some of my other PRs reviewed ahead of this one, anyways.

@paulirwin paulirwin marked this pull request as draft January 5, 2025 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notes:bug-fix Contains a fix for a bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Task: Finish [SuppressTempFileChecks] attribute functionality
2 participants