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

[MNG-6797] - Remember if Maven model problems were encountered. #298

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

Conversation

wilx
Copy link

@wilx wilx commented Nov 2, 2019

Remember in MavenSession if Maven model problems were detected in
DefaultGraphBuilder.

The reason for this is to be able to read the problems flag in Maven Enforcer plugin rule that would stop build if any Maven model problems were encountered.

See also MNG-6797.

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 [MNG-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MNG-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 Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

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.

Remember in MavenSession if Maven model problems were detected in
DefaultGraphBuilder.
Copy link
Member

@michael-o michael-o left a comment

Choose a reason for hiding this comment

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

As fas as I understand you want to memorize state. Can you provide an IT why this is necessary/benefit?

I also fail to see how problems are detected, you only changed the signature of the method.

* This indicates whether there were any problems detected when building Maven model.
* @return true if there were problems, false otherwise
*/
public boolean isProblems() {
Copy link
Member

Choose a reason for hiding this comment

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

That really hurts because the plural implies that you have a collection of problem, and not a boolean value. Moreover, third person singular with a plural reads horribly.

Copy link
Author

Choose a reason for hiding this comment

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

As fas as I understand you want to memorize state. Can you provide an IT why this is necessary/benefit?

IME as someone who maintains Maven projects, people often introduce issues like that and they do not care to fix them unless their build breaks. Remembering in MavenSession that there were problems with the Maven model will allow me to write Maven Enforcer plugin rule that will read that and will fail the build.

I also fail to see how problems are detected, you only changed the signature of the method.

See org.apache.maven.graph.DefaultGraphBuilder#collectProjects. It prints the collected Maven model problems.

That really hurts because the plural implies that you have a collection of problem, and not a boolean value. Moreover, third person singular with a plural reads horribly.

I am open to suggestions for better name. I have only propagated the problems variable name upwards. One thing, I would like to keep the isX or getX for the getter as that would allow me, I believe, to use something like this ReflectionValueExtractor.evaluate("problems", session, false); to retrieve it in the Enforce rule easily, I hope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants