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

[MSHADE-307] defaults for transformers and filters #12

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

Conversation

rmannibucau
Copy link
Contributor

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 [MSHADE-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MSHADE-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).

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.

@eolivelli
Copy link

What about adding some description about new default in this page ?
https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html

@eolivelli
Copy link

@rfscholte please take a look

Copy link

@eolivelli eolivelli left a comment

Choose a reason for hiding this comment

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

@eolivelli
Copy link

@rmannibucau
Copy link
Contributor Author

Another path separator issue :(, fixed hopefully

@eolivelli
Copy link

private List<ResourceTransformer> getDefaultResourceTransformers()
{
final List<ResourceTransformer> transformers = new LinkedList<>();
if ( missTransformer( ServicesResourceTransformer.class ) )
Copy link
Contributor

Choose a reason for hiding this comment

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

getDefaultResourceTransformers() is only called when transformers is null, so no need for missTransformer()-call

getMatchingJars( artifacts , new ArtifactId( "*:*" ) ),
Collections.<String>emptySet(),
new HashSet<>( Arrays.asList( "META-INF/*.SF", "META-INF/*.DSA", "META-INF/*.RSA" ) ) ) );
}

filters.addAll( simpleFilters );
Copy link
Contributor

Choose a reason for hiding this comment

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

I would expect a NPE here with the default filters.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not sure i'm following, this is not this.filters but the list created in the method

@@ -822,6 +831,16 @@ private File resolveArtifactSources( Artifact artifact )
simpleFilters.add( new SimpleFilter( jars, filter.getIncludes(), filter.getExcludes() ) );
}
}
else if ( this.filters == null )
{
getLog().debug( "Adding META-INF/*.SF, META-INF/*.DSA and META-INF/*.RSA exclusions" );
Copy link
Contributor

Choose a reason for hiding this comment

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

Please create a method getDefaultFilters()

@@ -60,6 +64,50 @@
public class ShadeMojoTest
extends PlexusTestCase
{
public void testDefaultConfiguration() throws Exception
Copy link
Contributor

Choose a reason for hiding this comment

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

Very creative with reflection, but I wonder if we are testing the right things. If it is too hard to verify it with a unittest, why not switch to an integration test?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thought about it but I found it saner as a compromise cause this is really more a whitebox test to check we mutate the user config as expected than an IT which would be more complicated with fewer guarantee on what we do at that level IMHO (here we really want to check the default config is setup and not smoke test it, at least was the intention)

@rmannibucau
Copy link
Contributor Author

Updated the PR, I think the test is more relevant for this particular case than an IT since we don't care how it runs but we care about what it runs, let me know if it is still an issue.

Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

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

Is this still under consideration/development or should we close it?

@rmannibucau
Copy link
Contributor Author

rmannibucau commented Apr 11, 2020

Can depend on the SPI PR, could be replaced by a SPI module IMHO.

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