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

[MENFORCER-397] allow no rules #178

Merged
merged 1 commit into from
Jul 31, 2022

Conversation

raupachz
Copy link
Contributor

Hi there,

attached is another up-for-grabs. This PR allows no rules by adding a failIfNoRules parameter. Settings failIfNoRules to false will log a warning "No rules are configured" instead of throwing an exception. Default behaviour is to throw an exception if there are no rules configured. Like people are used to.

A suitable test case has been added.

Feedback is welcome.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MENFORCER-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MENFORCER-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@raupachz
Copy link
Contributor Author

My bad. Let me check.

/**
* Set this to "true" to cause a failure if there are no rules to execute
*/
@Parameter( property = "enforcer.failIfNoRules", defaultValue = "true" )
Copy link
Member

Choose a reason for hiding this comment

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

Pleas add @since

Yes - I see that other parameters also has missing it ... we can fix for rest in separate PR

It is used for documentation: https://maven.apache.org/enforcer/maven-enforcer-plugin/enforce-mojo.html

Maybe documentation - similar to other, eg:

Flag to allow executions without rules.

Comment on lines 300 to 315
public void testFailIfNoTests()
throws MojoExecutionException {
setupBasics( false );
mojo.setFailIfNoRules( false );
mojo.execute();
}
Copy link
Member

Choose a reason for hiding this comment

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

please add some assertions, eg that log.warn was called only once with specific message and no more interactions on log

@slawekjaranowski slawekjaranowski merged commit ae93fa8 into apache:master Jul 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants