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-6665] toolchain.xml file should support environment variables #251

Conversation

MartinKanters
Copy link
Contributor

@MartinKanters MartinKanters commented May 31, 2019

Submitted by: Mike Mol and Martin Kanters

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.

if ( value != null )
{
// we're going to parse this back in as XML so we need to escape XML markup
value = value.toString().replace( "&", "&amp;" ).replace( "<", "&lt;" ).replace( ">", "&gt;" );
Copy link
Contributor

Choose a reason for hiding this comment

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

@rscholte
Do we have any library for doing this xml escape ?

Copy link
Contributor

Choose a reason for hiding this comment

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

This line of code is pretty straight forward, at least not worth introducing a new library. Maybe one of the existing libraries has one.
Actually, looking at it I wonder the performance penalty here since we loop over the whole file 3 times. But that kind of optimization deserves a new issue.

Copy link
Contributor

Choose a reason for hiding this comment

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

@rfscholte
Sure. In fact I think it is not worth to add a library for this.
If I understand correctly this code is meant to run only really few times, so there is no need for aggressive optimizations

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This logic is taken from the DefaultSettingsBuilder, if it already exists in one of the libraries I can change both places.

Submitted by: Mike Mol and Martin Kanters

Used constructor injection to inject the toolchainsWriter, instead of always making a new one. Constructor injection is used, in order to be able to unit test against a real instance of the toolchainsWriter. Made it a @nAmed @singleton instead of @component to be consistent with the DefaultToolchainsReader.
Submitted by: Mike Mol and Martin Kanters

Added ourselves to the contributors list
Submitted by: Mike Mol and Martin Kanters

Added field injection again, instead of constructor injection, to be consistent with the codebase and because it will probably not work with the way maven generates a injection descriptor on compile time.
@rfscholte rfscholte merged commit aed5130 into apache:master Jun 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants