Introduce predefined @Disabled*/@Enabled* variants

[ttddyy]

Overview

I just happened to have a test only failing on MS Windows machines and thought about JUnit Jupiter.

I could write a custom extension implementing ContainerExecutionCondition and TestExecutionCondition, but having a predefined @Disabled annotation such as @DisabledIfWindows or @Disabled(condition = IsWindowsEvaluator.class) to extend disabling feature might be handy.

Related Issues

• Introduce a TemporaryFolder extension #1247

Deliverables

• system property matches a pattern
• environment variable matches a pattern
• ❌ current day of week matches one of the supplied enums
  • The team decided not to publish @EnabledOnDayOfWeek and @DisabledOnDayOfWeek.
• current OS matches one of the supplied enums
• current JRE version matches one of the supplied enums
• Check for user configuration errors. For example, if a user declares @EnabledOnOs({}), that should result in an exception instead of a disabled result.
• Introduce integration tests for each condition.
• Write JavaDoc for each annotation.
• Document in User Guide.
• Document in Release Notes.

[ttddyy]

I just realized I should write like this to skip the test on windows machines for my use case.
assumeFalse(System.getProperty("os.name").toLowerCase().contains("win"))

However, I still think annotating such condition would be easier to detect than writing assumptions in body of the test methods.

[sbrannen]

@ttddyy, that's an interesting idea, and I in fact had a similar idea (hence the new subject).

I'm not sure that we will introduce such mechanisms in core JUnit 5, but I do imagine they will end up somewhere (perhaps in an add-on module or in an example project).

p.s. this would be similar to @IfProfileValue in Spring, only much more powerful. 😉

[sbrannen]

We have recently received a recommendation for introducing an annotation like @DisabledUntil( /* date */).

So that is also something to keep in mind.

I'm currently thinking we should support the following use cases.

• system property matches a pattern
• environment variable matches a pattern
• current date/time matches some criteria

[smoyer64]

I wanted to add a use-case to this issue that was described during the "Metrics-Driven Continuous Delivery in Practice [TUT5941]" session at JavaOne.

The presenter's company (Dynatrace) has developed a custom @ignore annotation which allows tests to be ignored only if the issue (in this case in Jira) it's testing against is still open. This seems like a pretty clever TDD trick too.

[sbrannen]

Yep, that's also a clever use case.

But something like that is very specific to a particular technology. So I don't foresee that being implemented as a generic solution within JUnit itself.

[smoyer64]

No ... but the "condition =" idea above would satisfy both this use case and the @DisableUntil use case.

[sbrannen]

This issue has been resolved in latest commits pushed to master.