Skip to content

Commit 89ee4ed

Browse files
slawekjaranowskislawekjaranowski
committed
[MSHARED-1019] Allow pass raw cli option to Maven process
1 parent 71a1344 commit 89ee4ed

File tree

5 files changed

+79
-10
lines changed

5 files changed

+79
-10
lines changed

‎src/main/java/org/apache/maven/shared/invoker/DefaultInvocationRequest.java

+21
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,15 @@
2121

2222
import java.io.File;
2323
import java.io.InputStream;
24+
import java.util.ArrayList;
2425
import java.util.Collections;
2526
import java.util.HashMap;
2627
import java.util.List;
2728
import java.util.Map;
2829
import java.util.Properties;
2930

31+
import org.apache.maven.shared.utils.StringUtils;
32+
3033
/**
3134
* Specifies the parameters used to control a Maven invocation.
3235
*
@@ -113,6 +116,8 @@ public class DefaultInvocationRequest
113116

114117
private boolean noTransferProgress;
115118

119+
private List<String> args = new ArrayList<>();
120+
116121
/**
117122
* <p>getBaseDirectory.</p>
118123
*
@@ -499,6 +504,22 @@ public String getPomFileName()
499504
return pomFilename;
500505
}
501506

507+
508+
@Override
509+
public InvocationRequest addArg( String arg )
510+
{
511+
if ( StringUtils.isNotBlank( arg ) )
512+
{
513+
args.add( arg );
514+
}
515+
return this;
516+
}
517+
518+
public List<String> getArgs()
519+
{
520+
return args;
521+
}
522+
502523
/** {@inheritDoc} */
503524
public InvocationRequest setPomFileName( String pomFilename )
504525
{

‎src/main/java/org/apache/maven/shared/invoker/InvocationRequest.java

+18
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,14 @@ public interface InvocationRequest
190190
*/
191191
String getPomFileName();
192192

193+
/**
194+
* List of raw line arguments which will be passed to cli.
195+
*
196+
* @return a list of cli arguments
197+
* @since 3.2.0
198+
*/
199+
List<String> getArgs();
200+
193201
/**
194202
* Gets the path to the base directory of the POM for the Maven invocation. If {@link #getPomFile()} does not return
195203
* <code>null</code>, this setting only affects the working directory for the Maven invocation.
@@ -526,6 +534,16 @@ enum CheckSumPolicy
526534
*/
527535
InvocationRequest setPomFileName( String pomFilename );
528536

537+
/**
538+
* Add a raw argument to Maven cli command at the end of other arguments.
539+
* Can be called multiple time in order to add many arguments.
540+
*
541+
* @param arg a raw Maven arg line
542+
* @return This invocation request.
543+
* @since 3.2.0
544+
*/
545+
InvocationRequest addArg( String arg );
546+
529547
/**
530548
* Sets the path to the base directory of the POM for the Maven invocation. If {@link #getPomFile()} does not return
531549
* <code>null</code>, this setting only affects the working directory for the Maven invocation.

‎src/main/java/org/apache/maven/shared/invoker/MavenCommandLineBuilder.java

+10
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ public Commandline build( InvocationRequest request )
104104

105105
setThreads( request, cli );
106106

107+
setArgs( request, cli );
108+
107109
return cli;
108110
}
109111

@@ -552,6 +554,14 @@ protected void setThreads( InvocationRequest request, Commandline cli )
552554

553555
}
554556

557+
private void setArgs( InvocationRequest request, Commandline cli )
558+
{
559+
for ( String arg : request.getArgs() )
560+
{
561+
cli.createArg().setValue( arg );
562+
}
563+
}
564+
555565
private void setupMavenHome( InvocationRequest request )
556566
{
557567
if ( request.getMavenHome() != null )

‎src/site/apt/index.apt.vm

+2
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ ${project.name}
102102

103103
* Toolchains location ( since Maven3 with -t )
104104

105+
* Additional raw cli options at the start or the end of command line
106+
105107
[]
106108

107109
[]

‎src/test/java/org/apache/maven/shared/invoker/MavenCommandLineBuilderTest.java

+28-10
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040

4141
import static org.hamcrest.CoreMatchers.is;
4242
import static org.hamcrest.CoreMatchers.notNullValue;
43+
import static org.junit.Assert.assertArrayEquals;
4344
import static org.junit.Assert.assertEquals;
4445
import static org.junit.Assert.assertFalse;
4546
import static org.junit.Assert.assertTrue;
@@ -63,7 +64,7 @@ public void setUp() throws IOException
6364
Properties p = new Properties( sysProps );
6465

6566
System.setProperties( p );
66-
67+
6768
lrd = temporaryFolder.newFile();
6869

6970
}
@@ -74,7 +75,7 @@ public void tearDown()
7475
System.setProperties( sysProps );
7576
}
7677

77-
78+
7879
@Test
7980
public void testShouldFailToSetLocalRepoLocationGloballyWhenItIsAFile()
8081
{
@@ -176,7 +177,7 @@ public void testRequestProvidedWorkingDirectoryShouldOverrideGlobal()
176177
InvocationRequest req = newRequest();
177178
req.setBaseDirectory( wd );
178179

179-
mclb.setupBaseDirectory( req);
180+
mclb.setupBaseDirectory( req );
180181

181182
assertEquals( mclb.getBaseDirectory(), wd.getCanonicalFile() );
182183
}
@@ -337,23 +338,23 @@ public void testShouldSetQuietFlagFromRequest()
337338

338339
mclb.setFlags( newRequest().setQuiet( true ), cli );
339340

340-
assertArgumentsPresent( cli, Collections.singleton( "-q" ));
341+
assertArgumentsPresent( cli, Collections.singleton( "-q" ) );
341342
}
342343

343344
@Test
344345
public void testShouldSetNonRecursiveFlagsFromRequest()
345346
{
346347
mclb.setFlags( newRequest().setRecursive( false ), cli );
347348

348-
assertArgumentsPresent( cli, Collections.singleton( "-N" ));
349+
assertArgumentsPresent( cli, Collections.singleton( "-N" ) );
349350
}
350351

351352
@Test
352353
public void testShouldSetShowVersionFlagsFromRequest()
353354
{
354355
mclb.setFlags( newRequest().setShowVersion( true ), cli );
355356

356-
assertArgumentsPresent( cli, Collections.singleton( "-V" ));
357+
assertArgumentsPresent( cli, Collections.singleton( "-V" ) );
357358
}
358359

359360
@Test
@@ -389,7 +390,7 @@ public void testProjectsAndAlsoMake()
389390
{
390391

391392
mclb.setReactorBehavior( newRequest().setProjects( Collections.singletonList( "proj1" ) ).setAlsoMake( true ),
392-
cli );
393+
cli );
393394

394395
assertArgumentsPresentInOrder( cli, "-pl", "proj1", "-am" );
395396
}
@@ -471,6 +472,23 @@ public void testShouldSetFailNeverFlagFromRequest()
471472
assertArgumentsPresent( cli, Collections.singleton( "-fn" ) );
472473
}
473474

475+
476+
@Test
477+
public void testShouldAddArg() throws CommandLineConfigurationException
478+
{
479+
InvocationRequest request = newRequest()
480+
.addArg( "arg1" )
481+
.addArg( "arg2" )
482+
.setQuiet( true )
483+
.setBuilder( "bId" );
484+
485+
Commandline commandline = mclb.build( request );
486+
487+
String[] arguments = commandline.getArguments();
488+
489+
assertArrayEquals( Arrays.asList( "-b", "bId", "-q", "arg1", "arg2" ).toArray(), arguments );
490+
}
491+
474492
@Test
475493
public void testShouldUseDefaultOfFailFastWhenSpecifiedInRequest()
476494
{
@@ -489,14 +507,14 @@ public void testShouldUseDefaultOfFailFastWhenSpecifiedInRequest()
489507
public void testShouldSetNoTransferProgressFlagFromRequest()
490508
{
491509
mclb.setFlags( newRequest().setNoTransferProgress( true ), cli );
492-
assertArgumentsPresent( cli, Collections.singleton( "-ntp" ));
510+
assertArgumentsPresent( cli, Collections.singleton( "-ntp" ) );
493511
}
494512

495513
@Test
496514
public void testShouldSpecifyFileOptionUsingNonStandardPomFileLocation()
497515
throws Exception
498516
{
499-
File projectDir = temporaryFolder.newFolder( "invoker-tests", "file-option-nonstd-pom-file-location" );
517+
File projectDir = temporaryFolder.newFolder( "invoker-tests", "file-option-nonstd-pom-file-location" );
500518

501519
File pomFile = createDummyFile( projectDir, "non-standard-pom.xml" ).getCanonicalFile();
502520

@@ -946,7 +964,7 @@ private File createDummyFile( File directory, String filename )
946964
throws IOException
947965
{
948966
File dummyFile = new File( directory, filename );
949-
967+
950968
try ( FileWriter writer = new FileWriter( dummyFile ) )
951969
{
952970
writer.write( "This is a dummy file." );

0 commit comments

Comments
 (0)