From 6b45e0b05a91219416bf01f7a61fce17f4eb892d Mon Sep 17 00:00:00 2001 From: Romain Bioteau Date: Fri, 25 Nov 2022 14:55:54 +0100 Subject: [PATCH] [MINSTALL-186] Use proper repositorySystemSession When looking for existing files in the local repository, use the proper `repositorySystemSession`. Current behavior ignore the `localRepositoryPath` parameter when checking for file existence and lead to false positive. --- .gitignore | 1 + .../plugins/install/InstallFileMojo.java | 6 +- .../plugins/install/InstallFileMojoTest.java | 86 ++++++++++++++++-- .../plugin-config.xml | 35 +++++++ .../maven-install-test-1.0-SNAPSHOT.jar | Bin 0 -> 2372 bytes 5 files changed, 116 insertions(+), 12 deletions(-) create mode 100644 src/test/resources/unit/install-file-from-local-repository-test/plugin-config.xml create mode 100644 src/test/resources/unit/install-file-from-local-repository-test/target/org/apache/maven/test/maven-install-test/1.0-SNAPSHOT/maven-install-test-1.0-SNAPSHOT.jar diff --git a/.gitignore b/.gitignore index 7495d7e2..3093e958 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ target/ +!src/test/resources/unit/*/target .project .classpath .settings/ diff --git a/src/main/java/org/apache/maven/plugins/install/InstallFileMojo.java b/src/main/java/org/apache/maven/plugins/install/InstallFileMojo.java index a006dace..a9eb098c 100644 --- a/src/main/java/org/apache/maven/plugins/install/InstallFileMojo.java +++ b/src/main/java/org/apache/maven/plugins/install/InstallFileMojo.java @@ -69,7 +69,7 @@ */ @Mojo( name = "install-file", requiresProject = false, aggregator = true, threadSafe = true ) public class InstallFileMojo - extends AbstractMojo + extends AbstractMojo { private static final String LS = System.getProperty( "line.separator" ); @@ -248,8 +248,8 @@ public void execute() ).setFile( file ); installRequest.addArtifact( mainArtifact ); - File artifactLocalFile = getLocalRepositoryFile( session.getRepositorySession(), mainArtifact ); - File pomLocalFile = getPomLocalRepositoryFile( session.getRepositorySession(), mainArtifact ); + File artifactLocalFile = getLocalRepositoryFile( repositorySystemSession, mainArtifact ); + File pomLocalFile = getPomLocalRepositoryFile( repositorySystemSession, mainArtifact ); if ( file.equals( artifactLocalFile ) ) { diff --git a/src/test/java/org/apache/maven/plugins/install/InstallFileMojoTest.java b/src/test/java/org/apache/maven/plugins/install/InstallFileMojoTest.java index 7efd90c0..bcfd69d7 100644 --- a/src/test/java/org/apache/maven/plugins/install/InstallFileMojoTest.java +++ b/src/test/java/org/apache/maven/plugins/install/InstallFileMojoTest.java @@ -58,12 +58,79 @@ public class InstallFileMojoTest private final String LOCAL_REPO = "target/local-repo/"; + private final String SPECIFIC_LOCAL_REPO = "target/specific-local-repo/"; + public void setUp() throws Exception { super.setUp(); FileUtils.deleteDirectory( new File( getBasedir() + "/" + LOCAL_REPO ) ); + FileUtils.deleteDirectory( new File( getBasedir() + "/" + SPECIFIC_LOCAL_REPO ) ); + } + + public void testInstallFileFromLocalRepositoryToLocalRepositoryPath() + throws Exception + { + File localRepository = + new File( getBasedir(), "target/test-classes/unit/install-file-from-local-repository-test/target" ); + + File testPom = new File( localRepository.getParentFile(), "plugin-config.xml" ); + + InstallFileMojo mojo = (InstallFileMojo) lookupMojo( "install-file", testPom ); + + assertNotNull( mojo ); + + setVariableValueToObject( mojo, "session", createMavenSession( localRepository.getAbsolutePath() ) ); + + File specificLocalRepositoryPath = new File( getBasedir() + "/" + SPECIFIC_LOCAL_REPO ); + + setVariableValueToObject( mojo, "localRepositoryPath", specificLocalRepositoryPath ); + + assignValuesForParameter( mojo ); + + mojo.execute(); + + String localPath = getBasedir() + "/" + SPECIFIC_LOCAL_REPO + groupId + "/" + artifactId + "/" + version + "/" + + artifactId + "-" + version; + + File installedArtifact = new File( localPath + "." + "jar" ); + + assertTrue( installedArtifact.exists() ); + + assertEquals( FileUtils.getFiles( new File( SPECIFIC_LOCAL_REPO ), null, null ).toString(), 5, + FileUtils.getFiles( new File( SPECIFIC_LOCAL_REPO ), null, null ).size() ); + } + + public void testInstallFileWithLocalRepositoryPath() + throws Exception + { + File testPom = + new File( getBasedir(), "target/test-classes/unit/install-file-with-checksum/" + "plugin-config.xml" ); + + InstallFileMojo mojo = (InstallFileMojo) lookupMojo( "install-file", testPom ); + + assertNotNull( mojo ); + + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); + + File specificLocalRepositoryPath = new File( getBasedir() + "/" + SPECIFIC_LOCAL_REPO ); + + setVariableValueToObject( mojo, "localRepositoryPath", specificLocalRepositoryPath ); + + assignValuesForParameter( mojo ); + + mojo.execute(); + + String localPath = getBasedir() + "/" + SPECIFIC_LOCAL_REPO + groupId + "/" + artifactId + "/" + version + "/" + + artifactId + "-" + version; + + File installedArtifact = new File( localPath + "." + "jar" ); + + assertTrue( installedArtifact.exists() ); + + assertEquals( FileUtils.getFiles( new File( SPECIFIC_LOCAL_REPO ), null, null ).toString(), 5, + FileUtils.getFiles( new File( SPECIFIC_LOCAL_REPO ), null, null ).size() ); } public void testInstallFileTestEnvironment() @@ -73,7 +140,7 @@ public void testInstallFileTestEnvironment() InstallFileMojo mojo = (InstallFileMojo) lookupMojo( "install-file", testPom ); - setVariableValueToObject( mojo, "session", createMavenSession() ); + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); assertNotNull( mojo ); } @@ -87,7 +154,7 @@ public void testBasicInstallFile() assertNotNull( mojo ); - setVariableValueToObject( mojo, "session", createMavenSession() ); + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); assignValuesForParameter( mojo ); @@ -111,7 +178,7 @@ public void testInstallFileWithClassifier() assertNotNull( mojo ); - setVariableValueToObject( mojo, "session", createMavenSession() ); + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); assignValuesForParameter( mojo ); @@ -137,7 +204,7 @@ public void testInstallFileWithGeneratePom() assertNotNull( mojo ); - setVariableValueToObject( mojo, "session", createMavenSession() ); + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); assignValuesForParameter( mojo ); @@ -178,7 +245,7 @@ public void testInstallFileWithPomFile() assertNotNull( mojo ); - setVariableValueToObject( mojo, "session", createMavenSession() ); + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); assignValuesForParameter( mojo ); @@ -211,7 +278,7 @@ public void testInstallFileWithPomAsPackaging() assertNotNull( mojo ); - setVariableValueToObject( mojo, "session", createMavenSession() ); + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); assignValuesForParameter( mojo ); @@ -239,7 +306,7 @@ public void testInstallFile() assertNotNull( mojo ); - setVariableValueToObject( mojo, "session", createMavenSession() ); + setVariableValueToObject( mojo, "session", createMavenSession( LOCAL_REPO ) ); assignValuesForParameter( mojo ); @@ -276,13 +343,14 @@ private String dotToSlashReplacer( String parameter ) return parameter.replace( '.', '/' ); } - private MavenSession createMavenSession() throws NoLocalRepositoryManagerException + private MavenSession createMavenSession( String localRepositoryBaseDir ) + throws NoLocalRepositoryManagerException { MavenSession session = mock( MavenSession.class ); DefaultRepositorySystemSession repositorySession = new DefaultRepositorySystemSession(); repositorySession.setLocalRepositoryManager( new EnhancedLocalRepositoryManagerFactory().newInstance( - repositorySession, new LocalRepository( LOCAL_REPO ) + repositorySession, new LocalRepository( localRepositoryBaseDir ) ) ); ProjectBuildingRequest buildingRequest = new DefaultProjectBuildingRequest(); diff --git a/src/test/resources/unit/install-file-from-local-repository-test/plugin-config.xml b/src/test/resources/unit/install-file-from-local-repository-test/plugin-config.xml new file mode 100644 index 00000000..31ddebf6 --- /dev/null +++ b/src/test/resources/unit/install-file-from-local-repository-test/plugin-config.xml @@ -0,0 +1,35 @@ + + + + + + maven-install-plugin + + org.apache.maven.test + maven-install-test + 1.0-SNAPSHOT + jar + ${basedir}/target/test-classes/unit/install-file-from-local-repository-test/target/org/apache/maven/test/maven-install-test/1.0-SNAPSHOT/maven-install-test-1.0-SNAPSHOT.jar + + + + + + diff --git a/src/test/resources/unit/install-file-from-local-repository-test/target/org/apache/maven/test/maven-install-test/1.0-SNAPSHOT/maven-install-test-1.0-SNAPSHOT.jar b/src/test/resources/unit/install-file-from-local-repository-test/target/org/apache/maven/test/maven-install-test/1.0-SNAPSHOT/maven-install-test-1.0-SNAPSHOT.jar new file mode 100644 index 0000000000000000000000000000000000000000..4a0e834e29ba17727a180d6ba70fdf6f845cd84c GIT binary patch literal 2372 zcmWIWW@h1H0D;t?RueD-N^k;cU)K;vT~9wZ{Q#&k4u%w(Y*MaWyRGzVWFhvfs27e5rC<&Q(!-%be8B zm%cpuys`c<-={o|r@J$%dy~)cX)olx8sOF3X`sk`s%lacv#okznbBmo=4mRd$%{Sy zKmTLPTskxC>&H6<$8IviJj1|{jOJ$+pl9-n(&664RKX2ZkywzJoRNx0p&+Wl+{Cif zJUq(9uqiJ|EiQrU;Q+gKFPFT%AtM9BejrxBsV4-eQ7<_svADQ2@U$P3p@?nk#Kyu3 z4m&~L8;zacm<@Ir6q*JKbNn_k2{5{>xOBpg$XyqXw8}qlm&{k!Gr4&0$(?z{?`>Z` ze*F2Ztm~Y|CJvmvTxAz@7K5$?o=;kyq-?sqDD`JY!T|xE&09O4t}Rj) zRgcp-;@0vZ@LQq8BaYm*R~{0EqPMJG{IcM?c#zZicYS_aoAIO03&wT!ktcp^H>rt< zoO$W$CR5RGi}oxs`j;?en{)OOkCzo|?Niw5Uq&p-Tqpi_!xokEY<~@R-B{#a+8uZy zltcT-y1)gp0k+kw)ou$TYZ|}1I59FN_S&&rc_YZZ(Ui0K+|plu{{N*7UbvZRpjP`_MhfDWFX-Bz4f1Sy#oKirve4brL{xu@Mrd{%oUn6 zv6D;W`Y-TOn|tq5H; zo&$9^%v$%|w_$`u7YDff>e158t^<0o1Bl%y^k_j*enDzcNoHzsaGC#EZ(T1PPv1a~ zRUsdIb-d3$ej3EbUL?!iCBow)%EP;cM|Ulcj>w#5XOSKro--9YPX%>%8Grtq!~2z| zr1`H5bCc~K=Zc+|x<7ey+XUx)?!NR@h+Al~anRQy$73(2E)kplp-5G1YRWQIwdo9@ z4XvfdpS!$;ii=7VFEIpoGct)V<1V9t-UI>xhPRF&8lFHA+OU_|AjKfCq){D6!nGll z;0O~ii$PF92>~FBzW|w#ViVz1^r971a6$k`hZwN<0_lJkqqsGK3Q~kddsL0EY=~Ps zs9;5C&%>r2nqy#QU@vH4rYvb(gwqT}v5Opb=tTpl9Dx8(NC+|`g+8Wt&^3d~6@+Fx zOwG7T8JO>|moo?>8;La%YpDaX1$(&zbNZ6T>lD}mErk$4j6LroEIR;9t?&d631aM_ cgvCoB%Mc|&fHx}}$Xp&E>;ZaV5i5uX0NN