Coverage Report

Coverage Report - org.apache.maven.shared.invoker.MavenCommandLineBuilder

Classes in this File

Line Coverage

Branch Coverage

Complexity

MavenCommandLineBuilder

80%

207/257

78%

102/130

4,346

 package org.apache.maven.shared.invoker;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 import java.io.File;
 import java.io.IOException;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
 
 import org.codehaus.plexus.util.Os;
 import org.codehaus.plexus.util.StringUtils;
 import org.codehaus.plexus.util.cli.CommandLineUtils;
 import org.codehaus.plexus.util.cli.Commandline;
 
 /**
  * @version $Id: MavenCommandLineBuilder.java 1401842 2012-10-24 19:49:47Z rfscholte $
  */
 public class MavenCommandLineBuilder
 {
 
     private static final InvokerLogger DEFAULT_LOGGER = new SystemOutLogger();
 
     private InvokerLogger logger = DEFAULT_LOGGER;
 
     private File workingDirectory;
 
     private File localRepositoryDirectory;
 
     private File mavenHome;
 
     private File mavenExecutable;
 
     private Properties systemEnvVars;
 
     public Commandline build( InvocationRequest request )
         throws CommandLineConfigurationException
     {
         try
         {
             checkRequiredState();
         }
         catch ( IOException e )
         {
             throw new CommandLineConfigurationException( e.getMessage(), e );
         }
         File mvn = null;
         try
         {
             mvn = findMavenExecutable();
         }
         catch ( IOException e )
         {
             throw new CommandLineConfigurationException( e.getMessage(), e );
         }
         Commandline cli = new Commandline();
 
         cli.setExecutable( mvn.getAbsolutePath() );
 
         // handling for OS-level envars
         setShellEnvironment( request, cli );
 
         // interactive, offline, update-snapshots,
         // debug/show-errors, checksum policy
         setFlags( request, cli );
 
         // failure behavior and [eventually] forced-reactor
         // includes/excludes, etc.
         setReactorBehavior( request, cli );
 
         // working directory and local repository location
         setEnvironmentPaths( request, cli );
 
         // pom-file and basedir handling
         setPomLocation( request, cli );
 
         setSettingsLocation( request, cli );
 
         setToolchainsLocation( request, cli );
         
         setProperties( request, cli );
 
         setProfiles( request, cli );
 
         setGoals( request, cli );
 
         setThreads( request, cli );
         
         return cli;
     }
 
     protected void checkRequiredState()
         throws IOException
     {
         if ( logger == null )
         {
             throw new IllegalStateException( "A logger instance is required." );
         }
 
         if ( ( mavenHome == null ) && ( System.getProperty( "maven.home" ) == null ) )
         // can be restored with 1.5
         // && ( System.getenv( "M2_HOME" ) != null ) )
         {
             if ( !getSystemEnvVars().containsKey( "M2_HOME" ) )
             {
                 throw new IllegalStateException( "Maven application directory was not "
                     + "specified, and ${maven.home} is not provided in the system "
                     + "properties. Please specify at least on of these." );
             }
         }
     }
 
     protected void setSettingsLocation( InvocationRequest request, Commandline cli )
     {
         File userSettingsFile = request.getUserSettingsFile();
 
         if ( userSettingsFile != null )
         {
             try
             {
                 File canSet = userSettingsFile.getCanonicalFile();
                 userSettingsFile = canSet;
             }
             catch ( IOException e )
             {
                 logger.debug( "Failed to canonicalize user settings path: " + userSettingsFile.getAbsolutePath()
                     + ". Using as-is.", e );
             }
 
             cli.createArg().setValue( "-s" );
             cli.createArg().setValue( userSettingsFile.getPath() );
         }
         
         File globalSettingsFile = request.getGlobalSettingsFile();
 
         if ( globalSettingsFile != null )
         {
             try
             {
                 File canSet = globalSettingsFile.getCanonicalFile();
                 globalSettingsFile = canSet;
             }
             catch ( IOException e )
             {
                 logger.debug( "Failed to canonicalize global settings path: " + globalSettingsFile.getAbsolutePath()
                     + ". Using as-is.", e );
             }
 
             cli.createArg().setValue( "-gs" );
             cli.createArg().setValue( globalSettingsFile.getPath() );
         }
 
     }
     
     protected void setToolchainsLocation( InvocationRequest request, Commandline cli )
     {
         File toolchainsFile = request.getToolchainsFile();
 
         if ( toolchainsFile != null )
         {
             try
             {
                 File canSet = toolchainsFile.getCanonicalFile();
                 toolchainsFile = canSet;
             }
             catch ( IOException e )
             {
                 logger.debug( "Failed to canonicalize toolchains path: " + toolchainsFile.getAbsolutePath()
                     + ". Using as-is.", e );
             }
 
             cli.createArg().setValue( "-t" );
             cli.createArg().setValue( toolchainsFile.getPath() );
         }
     }
 
     protected void setShellEnvironment( InvocationRequest request, Commandline cli )
         throws CommandLineConfigurationException
     {
         if ( request.isShellEnvironmentInherited() )
         {
             try
             {
                 cli.addSystemEnvironment();
                 cli.addEnvironment( "MAVEN_TERMINATE_CMD", "on" );
             }
             catch ( IOException e )
             {
                 throw new CommandLineConfigurationException( "Error reading shell environment variables. Reason: "
                     + e.getMessage(), e );
             }
             catch ( Exception e )
             {
                 if ( e instanceof RuntimeException )
                 {
                     throw (RuntimeException) e;
                 }
                 else
                 {
                     IllegalStateException error =
                         new IllegalStateException( "Unknown error retrieving shell environment variables. Reason: "
                             + e.getMessage() );
                     error.initCause( e );
 
                     throw error;
                 }
             }
         }
 
         if ( request.getJavaHome() != null )
         {
             cli.addEnvironment( "JAVA_HOME", request.getJavaHome().getAbsolutePath() );
         }
 
         if ( request.getMavenOpts() != null )
         {
             cli.addEnvironment( "MAVEN_OPTS", request.getMavenOpts() );
         }
 
         for ( Map.Entry<String, String> entry : request.getShellEnvironments().entrySet() )
         {
             cli.addEnvironment( entry.getKey(), entry.getValue() );
         }
     }
 
     protected void setProfiles( InvocationRequest request, Commandline cli )
     {
         List<String> profiles = request.getProfiles();
 
         if ( ( profiles != null ) && !profiles.isEmpty() )
         {
             cli.createArg().setValue( "-P" );
             cli.createArg().setValue( StringUtils.join( profiles.iterator(), "," ) );
         }
 
     }
 
     protected void setGoals( InvocationRequest request, Commandline cli )
     {
         List<String> goals = request.getGoals();
 
         if ( ( goals != null ) && !goals.isEmpty() )
         {
             cli.createArg().setLine( StringUtils.join( goals.iterator(), " " ) );
         }
     }
 
     protected void setProperties( InvocationRequest request, Commandline cli )
     {
         Properties properties = request.getProperties();
 
         if ( properties != null )
         {
             for ( Iterator it = properties.entrySet().iterator(); it.hasNext(); )
             {
                 Map.Entry entry = (Map.Entry) it.next();
 
                 String key = (String) entry.getKey();
                 String value = (String) entry.getValue();
 
                 cli.createArg().setValue( "-D" );
                 cli.createArg().setValue( key + '=' + value );
             }
         }
     }
 
     protected void setPomLocation( InvocationRequest request, Commandline cli )
     {
         boolean pomSpecified = false;
 
         File pom = request.getPomFile();
         String pomFilename = request.getPomFileName();
         File baseDirectory = request.getBaseDirectory();
 
         if ( pom != null )
         {
             pomSpecified = true;
         }
         else if ( baseDirectory != null )
         {
             if ( baseDirectory.isDirectory() )
             {
                 if ( pomFilename != null )
                 {
                     pom = new File( baseDirectory, pomFilename );
 
                     pomSpecified = true;
                 }
                 else
                 {
                     pom = new File( baseDirectory, "pom.xml" );
                 }
             }
             else
             {
                 logger.warn( "Base directory is a file. Using base directory as POM location." );
 
                 pom = baseDirectory;
 
                 pomSpecified = true;
             }
         }
 
         if ( pomSpecified )
         {
             try
             {
                 File canPom = pom.getCanonicalFile();
                 pom = canPom;
             }
             catch ( IOException e )
             {
                 logger.debug( "Failed to canonicalize the POM path: " + pom + ". Using as-is.", e );
             }
 
             if ( !"pom.xml".equals( pom.getName() ) )
             {
                 logger.debug( "Specified POM file is not named \'pom.xml\'. "
                     + "Using the \'-f\' command-line option to accommodate non-standard filename..." );
 
                 cli.createArg().setValue( "-f" );
                 cli.createArg().setValue( pom.getName() );
             }
         }
     }
 
     protected void setEnvironmentPaths( InvocationRequest request, Commandline cli )
     {
         File workingDirectory = request.getBaseDirectory();
 
         if ( workingDirectory == null )
         {
             File pomFile = request.getPomFile();
             if ( pomFile != null )
             {
                 workingDirectory = pomFile.getParentFile();
             }
         }
 
         if ( workingDirectory == null )
         {
             workingDirectory = this.workingDirectory;
         }
 
         if ( workingDirectory == null )
         {
             workingDirectory = new File( System.getProperty( "user.dir" ) );
         }
         else if ( workingDirectory.isFile() )
         {
             logger.warn( "Specified base directory (" + workingDirectory + ") is a file."
                 + " Using its parent directory..." );
 
             workingDirectory = workingDirectory.getParentFile();
         }
 
         try
         {
             cli.setWorkingDirectory( workingDirectory.getCanonicalPath() );
         }
         catch ( IOException e )
         {
             logger.debug( "Failed to canonicalize base directory: " + workingDirectory + ". Using as-is.", e );
 
             cli.setWorkingDirectory( workingDirectory.getAbsolutePath() );
         }
 
         File localRepositoryDirectory = request.getLocalRepositoryDirectory( this.localRepositoryDirectory );
 
         if ( localRepositoryDirectory != null )
         {
             try
             {
                 File canLRD = localRepositoryDirectory.getCanonicalFile();
                 localRepositoryDirectory = canLRD;
             }
             catch ( IOException e )
             {
                 logger.debug( "Failed to canonicalize local repository directory: " + localRepositoryDirectory
                     + ". Using as-is.", e );
             }
 
             if ( !localRepositoryDirectory.isDirectory() )
             {
                 throw new IllegalArgumentException( "Local repository location: \'" + localRepositoryDirectory
                     + "\' is NOT a directory." );
             }
 
             cli.createArg().setValue( "-D" );
             cli.createArg().setValue( "maven.repo.local=" + localRepositoryDirectory.getPath() );
         }
     }
 
     protected void setReactorBehavior( InvocationRequest request, Commandline cli )
     {
         // NOTE: The default is "fail-fast"
         String failureBehavior = request.getFailureBehavior();
 
         if ( StringUtils.isNotEmpty( failureBehavior ) )
         {
             if ( InvocationRequest.REACTOR_FAIL_AT_END.equals( failureBehavior ) )
             {
                 cli.createArg().setValue( "-fae" );
             }
             else if ( InvocationRequest.REACTOR_FAIL_NEVER.equals( failureBehavior ) )
             {
                 cli.createArg().setValue( "-fn" );
             }
         }
 
         if ( request.isActivatedReactor() )
         {
             cli.createArg().setValue( "-r" );
             String[] includes = request.getActivatedReactorIncludes();
             String[] excludes = request.getActivatedReactorExcludes();
             if ( includes != null )
             {
                 cli.createArg().setValue( "-D" );
                 cli.createArg().setValue( "maven.reactor.includes=" + StringUtils.join( includes, "," ) );
             }
             if ( excludes != null )
             {
                 cli.createArg().setValue( "-D" );
                 cli.createArg().setValue( "maven.reactor.excludes=" + StringUtils.join( excludes, "," ) );
             }
         }
 
         if( StringUtils.isNotEmpty( request.getResumeFrom() ) )
         {
             cli.createArg().setValue( "-rf" );
             cli.createArg().setValue( request.getResumeFrom() );
         }
 
         List<String> projectList = request.getProjects();
         if ( projectList != null )
         {
             cli.createArg().setValue( "-pl" );
             cli.createArg().setValue( StringUtils.join( projectList.iterator(), "," ) );
 
             if ( request.isAlsoMake() )
             {
                 cli.createArg().setValue( "-am" );
             }
 
             if ( request.isAlsoMakeDependents() )
             {
                 cli.createArg().setValue( "-amd" );
             }
         }
     }
 
     protected void setFlags( InvocationRequest request, Commandline cli )
     {
         if ( !request.isInteractive() )
         {
             cli.createArg().setValue( "-B" );
         }
 
         if ( request.isOffline() )
         {
             cli.createArg().setValue( "-o" );
         }
 
         if ( request.isUpdateSnapshots() )
         {
             cli.createArg().setValue( "-U" );
         }
 
         if ( !request.isRecursive() )
         {
             cli.createArg().setValue( "-N" );
         }
 
         if ( request.isDebug() )
         {
             cli.createArg().setValue( "-X" );
         }
         // this is superceded by -X, if it exists.
         else if ( request.isShowErrors() )
         {
             cli.createArg().setValue( "-e" );
         }
 
         String checksumPolicy = request.getGlobalChecksumPolicy();
         if ( InvocationRequest.CHECKSUM_POLICY_FAIL.equals( checksumPolicy ) )
         {
             cli.createArg().setValue( "-C" );
         }
         else if ( InvocationRequest.CHECKSUM_POLICY_WARN.equals( checksumPolicy ) )
         {
             cli.createArg().setValue( "-c" );
         }
         if ( request.isNonPluginUpdates() )
         {
             cli.createArg().setValue( "-npu" );
         }
         
         if ( request.isShowVersion() )
         {
             cli.createArg().setValue( "-V" );
         }
         }
 
     protected void setThreads( InvocationRequest request, Commandline cli )
     {
         String threads = request.getThreads();
         if ( StringUtils.isNotEmpty( threads ) )
         {
             cli.createArg().setValue( "-T" );
             cli.createArg().setValue( threads );
         }
         
     }
 
     protected File findMavenExecutable()
         throws CommandLineConfigurationException, IOException
     {
         if ( mavenHome == null )
         {
             String mavenHomeProperty = System.getProperty( "maven.home" );
             if ( mavenHomeProperty != null )
             {
                 mavenHome = new File( mavenHomeProperty );
                 if ( !mavenHome.isDirectory() )
                 {
                     File binDir = mavenHome.getParentFile();
                     if ( "bin".equals( binDir.getName() ) )
                     {
                         // ah, they specified the mvn
                         // executable instead...
                         mavenHome = binDir.getParentFile();
                     }
                     else
                     {
                         throw new IllegalStateException( "${maven.home} is not specified as a directory: \'"
                             + mavenHomeProperty + "\'." );
                     }
                 }
             }
 
             if ( ( mavenHome == null ) && ( getSystemEnvVars().getProperty( "M2_HOME" ) != null ) )
             {
                 mavenHome = new File( getSystemEnvVars().getProperty( "M2_HOME" ) );
             }
         }
 
         logger.debug( "Using ${maven.home} of: \'" + mavenHome + "\'." );
 
         if ( mavenExecutable == null || !mavenExecutable.isAbsolute() )
         {
             String executable;
             if( mavenExecutable != null )
             {
                 executable = mavenExecutable.getPath();
             }
             else if ( Os.isFamily( "windows" ) )
             {
                 executable = "mvn.bat";
             }
             else
             {
                 executable = "mvn";
             }
             
             mavenExecutable = new File( mavenHome, "/bin/" + executable );
             
             try
             {
                 File canonicalMvn = mavenExecutable.getCanonicalFile();
                 mavenExecutable = canonicalMvn;
             }
             catch ( IOException e )
             {
                 logger.debug( "Failed to canonicalize maven executable: " + mavenExecutable + ". Using as-is.", e );
             }
 
             if ( !mavenExecutable.isFile() )
             {
                 throw new CommandLineConfigurationException( "Maven executable not found at: " + mavenExecutable );
             }
         }
 
         return mavenExecutable;
     }
 
     /**
      * Wraps a path with quotes to handle paths with spaces. If no spaces are found, the original string is returned.
      * 
      * @param path string to wrap if containing spaces
      * @return quote wrapped string
      * @deprecated Quoting of command line arguments should be left to the Commandline from plexus-utils.
      */
     public String wrapStringWithQuotes( String path )
     {
         if ( path.indexOf( " " ) > -1 )
         {
             return "\"" + path + "\"";
         }
         else
         {
             return path;
         }
     }
 
     private Properties getSystemEnvVars()
         throws IOException
     {
         if ( this.systemEnvVars == null )
         {
             // with 1.5 replace with System.getenv()
             this.systemEnvVars = CommandLineUtils.getSystemEnvVars();
         }
         return this.systemEnvVars;
     }
 
     public File getLocalRepositoryDirectory()
     {
         return localRepositoryDirectory;
     }
 
     public void setLocalRepositoryDirectory( File localRepositoryDirectory )
     {
         this.localRepositoryDirectory = localRepositoryDirectory;
     }
 
     public InvokerLogger getLogger()
     {
         return logger;
     }
 
     public void setLogger( InvokerLogger logger )
     {
         this.logger = logger;
     }
 
     public File getMavenHome()
     {
         return mavenHome;
     }
 
     public void setMavenHome( File mavenHome )
     {
         this.mavenHome = mavenHome;
     }
 
     public File getWorkingDirectory()
     {
         return workingDirectory;
     }
 
     public void setWorkingDirectory( File workingDirectory )
     {
         this.workingDirectory = workingDirectory;
     }
 
     /**
      * {@code mavenExecutable} can either be relative to ${maven.home}/bin/ or absolute 
      * 
      * @param mavenExecutable the executable
      */
     public void setMavenExecutable( File mavenExecutable )
     {
         this.mavenExecutable = mavenExecutable;
     }
 
     public File getMavenExecutable()
     {
         return mavenExecutable;
     }
 
 }

1		package org.apache.maven.shared.invoker;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import java.io.File;
23		import java.io.IOException;
24		import java.util.Iterator;
25		import java.util.List;
26		import java.util.Map;
27		import java.util.Properties;
28
29		import org.codehaus.plexus.util.Os;
30		import org.codehaus.plexus.util.StringUtils;
31		import org.codehaus.plexus.util.cli.CommandLineUtils;
32		import org.codehaus.plexus.util.cli.Commandline;
33
34		/**
35		* @version $Id: MavenCommandLineBuilder.java 1401842 2012-10-24 19:49:47Z rfscholte $
36		*/
37	56	public class MavenCommandLineBuilder
38		{
39
40	1	private static final InvokerLogger DEFAULT_LOGGER = new SystemOutLogger();
41
42	56	private InvokerLogger logger = DEFAULT_LOGGER;
43
44		private File workingDirectory;
45
46		private File localRepositoryDirectory;
47
48		private File mavenHome;
49
50		private File mavenExecutable;
51
52		private Properties systemEnvVars;
53
54		public Commandline build( InvocationRequest request )
55		throws CommandLineConfigurationException
56		{
57		try
58		{
59	9	checkRequiredState();
60		}
61	0	catch ( IOException e )
62		{
63	0	throw new CommandLineConfigurationException( e.getMessage(), e );
64	9	}
65	9	File mvn = null;
66		try
67		{
68	9	mvn = findMavenExecutable();
69		}
70	0	catch ( IOException e )
71		{
72	0	throw new CommandLineConfigurationException( e.getMessage(), e );
73	9	}
74	9	Commandline cli = new Commandline();
75
76	9	cli.setExecutable( mvn.getAbsolutePath() );
77
78		// handling for OS-level envars
79	9	setShellEnvironment( request, cli );
80
81		// interactive, offline, update-snapshots,
82		// debug/show-errors, checksum policy
83	9	setFlags( request, cli );
84
85		// failure behavior and [eventually] forced-reactor
86		// includes/excludes, etc.
87	9	setReactorBehavior( request, cli );
88
89		// working directory and local repository location
90	9	setEnvironmentPaths( request, cli );
91
92		// pom-file and basedir handling
93	9	setPomLocation( request, cli );
94
95	9	setSettingsLocation( request, cli );
96
97	9	setToolchainsLocation( request, cli );
98
99	9	setProperties( request, cli );
100
101	9	setProfiles( request, cli );
102
103	9	setGoals( request, cli );
104
105	9	setThreads( request, cli );
106
107	9	return cli;
108		}
109
110		protected void checkRequiredState()
111		throws IOException
112		{
113	11	if ( logger == null )
114		{
115	1	throw new IllegalStateException( "A logger instance is required." );
116		}
117
118	10	if ( ( mavenHome == null ) && ( System.getProperty( "maven.home" ) == null ) )
119		// can be restored with 1.5
120		// && ( System.getenv( "M2_HOME" ) != null ) )
121		{
122	0	if ( !getSystemEnvVars().containsKey( "M2_HOME" ) )
123		{
124	0	throw new IllegalStateException( "Maven application directory was not "
125		+ "specified, and ${maven.home} is not provided in the system "
126		+ "properties. Please specify at least on of these." );
127		}
128		}
129	10	}
130
131		protected void setSettingsLocation( InvocationRequest request, Commandline cli )
132		{
133	11	File userSettingsFile = request.getUserSettingsFile();
134
135	11	if ( userSettingsFile != null )
136		{
137		try
138		{
139	2	File canSet = userSettingsFile.getCanonicalFile();
140	2	userSettingsFile = canSet;
141		}
142	0	catch ( IOException e )
143		{
144	0	logger.debug( "Failed to canonicalize user settings path: " + userSettingsFile.getAbsolutePath()
145		+ ". Using as-is.", e );
146	2	}
147
148	2	cli.createArg().setValue( "-s" );
149	2	cli.createArg().setValue( userSettingsFile.getPath() );
150		}
151
152	11	File globalSettingsFile = request.getGlobalSettingsFile();
153
154	11	if ( globalSettingsFile != null )
155		{
156		try
157		{
158	1	File canSet = globalSettingsFile.getCanonicalFile();
159	1	globalSettingsFile = canSet;
160		}
161	0	catch ( IOException e )
162		{
163	0	logger.debug( "Failed to canonicalize global settings path: " + globalSettingsFile.getAbsolutePath()
164		+ ". Using as-is.", e );
165	1	}
166
167	1	cli.createArg().setValue( "-gs" );
168	1	cli.createArg().setValue( globalSettingsFile.getPath() );
169		}
170
171	11	}
172
173		protected void setToolchainsLocation( InvocationRequest request, Commandline cli )
174		{
175	10	File toolchainsFile = request.getToolchainsFile();
176
177	10	if ( toolchainsFile != null )
178		{
179		try
180		{
181	1	File canSet = toolchainsFile.getCanonicalFile();
182	1	toolchainsFile = canSet;
183		}
184	0	catch ( IOException e )
185		{
186	0	logger.debug( "Failed to canonicalize toolchains path: " + toolchainsFile.getAbsolutePath()
187		+ ". Using as-is.", e );
188	1	}
189
190	1	cli.createArg().setValue( "-t" );
191	1	cli.createArg().setValue( toolchainsFile.getPath() );
192		}
193	10	}
194
195		protected void setShellEnvironment( InvocationRequest request, Commandline cli )
196		throws CommandLineConfigurationException
197		{
198	9	if ( request.isShellEnvironmentInherited() )
199		{
200		try
201		{
202	9	cli.addSystemEnvironment();
203	9	cli.addEnvironment( "MAVEN_TERMINATE_CMD", "on" );
204		}
205	0	catch ( IOException e )
206		{
207	0	throw new CommandLineConfigurationException( "Error reading shell environment variables. Reason: "
208		+ e.getMessage(), e );
209		}
210	0	catch ( Exception e )
211		{
212	0	if ( e instanceof RuntimeException )
213		{
214	0	throw (RuntimeException) e;
215		}
216		else
217		{
218	0	IllegalStateException error =
219		new IllegalStateException( "Unknown error retrieving shell environment variables. Reason: "
220		+ e.getMessage() );
221	0	error.initCause( e );
222
223	0	throw error;
224		}
225	9	}
226		}
227
228	9	if ( request.getJavaHome() != null )
229		{
230	0	cli.addEnvironment( "JAVA_HOME", request.getJavaHome().getAbsolutePath() );
231		}
232
233	9	if ( request.getMavenOpts() != null )
234		{
235	0	cli.addEnvironment( "MAVEN_OPTS", request.getMavenOpts() );
236		}
237
238	9	for ( Map.Entry<String, String> entry : request.getShellEnvironments().entrySet() )
239		{
240	0	cli.addEnvironment( entry.getKey(), entry.getValue() );
241		}
242	9	}
243
244		protected void setProfiles( InvocationRequest request, Commandline cli )
245		{
246	9	List<String> profiles = request.getProfiles();
247
248	9	if ( ( profiles != null ) && !profiles.isEmpty() )
249		{
250	1	cli.createArg().setValue( "-P" );
251	1	cli.createArg().setValue( StringUtils.join( profiles.iterator(), "," ) );
252		}
253
254	9	}
255
256		protected void setGoals( InvocationRequest request, Commandline cli )
257		{
258	11	List<String> goals = request.getGoals();
259
260	11	if ( ( goals != null ) && !goals.isEmpty() )
261		{
262	10	cli.createArg().setLine( StringUtils.join( goals.iterator(), " " ) );
263		}
264	11	}
265
266		protected void setProperties( InvocationRequest request, Commandline cli )
267		{
268	12	Properties properties = request.getProperties();
269
270	12	if ( properties != null )
271		{
272	5	for ( Iterator it = properties.entrySet().iterator(); it.hasNext(); )
273		{
274	6	Map.Entry entry = (Map.Entry) it.next();
275
276	6	String key = (String) entry.getKey();
277	6	String value = (String) entry.getValue();
278
279	6	cli.createArg().setValue( "-D" );
280	6	cli.createArg().setValue( key + '=' + value );
281	6	}
282		}
283	12	}
284
285		protected void setPomLocation( InvocationRequest request, Commandline cli )
286		{
287	15	boolean pomSpecified = false;
288
289	15	File pom = request.getPomFile();
290	15	String pomFilename = request.getPomFileName();
291	15	File baseDirectory = request.getBaseDirectory();
292
293	15	if ( pom != null )
294		{
295	2	pomSpecified = true;
296		}
297	13	else if ( baseDirectory != null )
298		{
299	12	if ( baseDirectory.isDirectory() )
300		{
301	10	if ( pomFilename != null )
302		{
303	2	pom = new File( baseDirectory, pomFilename );
304
305	2	pomSpecified = true;
306		}
307		else
308		{
309	8	pom = new File( baseDirectory, "pom.xml" );
310		}
311		}
312		else
313		{
314	2	logger.warn( "Base directory is a file. Using base directory as POM location." );
315
316	2	pom = baseDirectory;
317
318	2	pomSpecified = true;
319		}
320		}
321
322	15	if ( pomSpecified )
323		{
324		try
325		{
326	6	File canPom = pom.getCanonicalFile();
327	6	pom = canPom;
328		}
329	0	catch ( IOException e )
330		{
331	0	logger.debug( "Failed to canonicalize the POM path: " + pom + ". Using as-is.", e );
332	6	}
333
334	6	if ( !"pom.xml".equals( pom.getName() ) )
335		{
336	4	logger.debug( "Specified POM file is not named \'pom.xml\'. "
337		+ "Using the \'-f\' command-line option to accommodate non-standard filename..." );
338
339	4	cli.createArg().setValue( "-f" );
340	4	cli.createArg().setValue( pom.getName() );
341		}
342		}
343	15	}
344
345		protected void setEnvironmentPaths( InvocationRequest request, Commandline cli )
346		{
347	23	File workingDirectory = request.getBaseDirectory();
348
349	23	if ( workingDirectory == null )
350		{
351	9	File pomFile = request.getPomFile();
352	9	if ( pomFile != null )
353		{
354	2	workingDirectory = pomFile.getParentFile();
355		}
356		}
357
358	23	if ( workingDirectory == null )
359		{
360	7	workingDirectory = this.workingDirectory;
361		}
362
363	23	if ( workingDirectory == null )
364		{
365	6	workingDirectory = new File( System.getProperty( "user.dir" ) );
366		}
367	17	else if ( workingDirectory.isFile() )
368		{
369	2	logger.warn( "Specified base directory (" + workingDirectory + ") is a file."
370		+ " Using its parent directory..." );
371
372	2	workingDirectory = workingDirectory.getParentFile();
373		}
374
375		try
376		{
377	23	cli.setWorkingDirectory( workingDirectory.getCanonicalPath() );
378		}
379	0	catch ( IOException e )
380		{
381	0	logger.debug( "Failed to canonicalize base directory: " + workingDirectory + ". Using as-is.", e );
382
383	0	cli.setWorkingDirectory( workingDirectory.getAbsolutePath() );
384	23	}
385
386	23	File localRepositoryDirectory = request.getLocalRepositoryDirectory( this.localRepositoryDirectory );
387
388	23	if ( localRepositoryDirectory != null )
389		{
390		try
391		{
392	6	File canLRD = localRepositoryDirectory.getCanonicalFile();
393	6	localRepositoryDirectory = canLRD;
394		}
395	0	catch ( IOException e )
396		{
397	0	logger.debug( "Failed to canonicalize local repository directory: " + localRepositoryDirectory
398		+ ". Using as-is.", e );
399	6	}
400
401	6	if ( !localRepositoryDirectory.isDirectory() )
402		{
403	2	throw new IllegalArgumentException( "Local repository location: \'" + localRepositoryDirectory
404		+ "\' is NOT a directory." );
405		}
406
407	4	cli.createArg().setValue( "-D" );
408	4	cli.createArg().setValue( "maven.repo.local=" + localRepositoryDirectory.getPath() );
409		}
410	21	}
411
412		protected void setReactorBehavior( InvocationRequest request, Commandline cli )
413		{
414		// NOTE: The default is "fail-fast"
415	20	String failureBehavior = request.getFailureBehavior();
416
417	20	if ( StringUtils.isNotEmpty( failureBehavior ) )
418		{
419	20	if ( InvocationRequest.REACTOR_FAIL_AT_END.equals( failureBehavior ) )
420		{
421	1	cli.createArg().setValue( "-fae" );
422		}
423	19	else if ( InvocationRequest.REACTOR_FAIL_NEVER.equals( failureBehavior ) )
424		{
425	1	cli.createArg().setValue( "-fn" );
426		}
427		}
428
429	20	if ( request.isActivatedReactor() )
430		{
431	2	cli.createArg().setValue( "-r" );
432	2	String[] includes = request.getActivatedReactorIncludes();
433	2	String[] excludes = request.getActivatedReactorExcludes();
434	2	if ( includes != null )
435		{
436	1	cli.createArg().setValue( "-D" );
437	1	cli.createArg().setValue( "maven.reactor.includes=" + StringUtils.join( includes, "," ) );
438		}
439	2	if ( excludes != null )
440		{
441	1	cli.createArg().setValue( "-D" );
442	1	cli.createArg().setValue( "maven.reactor.excludes=" + StringUtils.join( excludes, "," ) );
443		}
444		}
445
446	20	if( StringUtils.isNotEmpty( request.getResumeFrom() ) )
447		{
448	1	cli.createArg().setValue( "-rf" );
449	1	cli.createArg().setValue( request.getResumeFrom() );
450		}
451
452	20	List<String> projectList = request.getProjects();
453	20	if ( projectList != null )
454		{
455	3	cli.createArg().setValue( "-pl" );
456	3	cli.createArg().setValue( StringUtils.join( projectList.iterator(), "," ) );
457
458	3	if ( request.isAlsoMake() )
459		{
460	2	cli.createArg().setValue( "-am" );
461		}
462
463	3	if ( request.isAlsoMakeDependents() )
464		{
465	2	cli.createArg().setValue( "-amd" );
466		}
467		}
468	20	}
469
470		protected void setFlags( InvocationRequest request, Commandline cli )
471		{
472	17	if ( !request.isInteractive() )
473		{
474	17	cli.createArg().setValue( "-B" );
475		}
476
477	17	if ( request.isOffline() )
478		{
479	2	cli.createArg().setValue( "-o" );
480		}
481
482	17	if ( request.isUpdateSnapshots() )
483		{
484	1	cli.createArg().setValue( "-U" );
485		}
486
487	17	if ( !request.isRecursive() )
488		{
489	0	cli.createArg().setValue( "-N" );
490		}
491
492	17	if ( request.isDebug() )
493		{
494	8	cli.createArg().setValue( "-X" );
495		}
496		// this is superceded by -X, if it exists.
497	9	else if ( request.isShowErrors() )
498		{
499	1	cli.createArg().setValue( "-e" );
500		}
501
502	17	String checksumPolicy = request.getGlobalChecksumPolicy();
503	17	if ( InvocationRequest.CHECKSUM_POLICY_FAIL.equals( checksumPolicy ) )
504		{
505	1	cli.createArg().setValue( "-C" );
506		}
507	16	else if ( InvocationRequest.CHECKSUM_POLICY_WARN.equals( checksumPolicy ) )
508		{
509	1	cli.createArg().setValue( "-c" );
510		}
511	17	if ( request.isNonPluginUpdates() )
512		{
513	0	cli.createArg().setValue( "-npu" );
514		}
515
516	17	if ( request.isShowVersion() )
517		{
518	0	cli.createArg().setValue( "-V" );
519		}
520	17	}
521
522		protected void setThreads( InvocationRequest request, Commandline cli )
523		{
524	10	String threads = request.getThreads();
525	10	if ( StringUtils.isNotEmpty( threads ) )
526		{
527	1	cli.createArg().setValue( "-T" );
528	1	cli.createArg().setValue( threads );
529		}
530
531	10	}
532
533		protected File findMavenExecutable()
534		throws CommandLineConfigurationException, IOException
535		{
536	11	if ( mavenHome == null )
537		{
538	4	String mavenHomeProperty = System.getProperty( "maven.home" );
539	4	if ( mavenHomeProperty != null )
540		{
541	4	mavenHome = new File( mavenHomeProperty );
542	4	if ( !mavenHome.isDirectory() )
543		{
544	0	File binDir = mavenHome.getParentFile();
545	0	if ( "bin".equals( binDir.getName() ) )
546		{
547		// ah, they specified the mvn
548		// executable instead...
549	0	mavenHome = binDir.getParentFile();
550		}
551		else
552		{
553	0	throw new IllegalStateException( "${maven.home} is not specified as a directory: \'"
554		+ mavenHomeProperty + "\'." );
555		}
556		}
557		}
558
559	4	if ( ( mavenHome == null ) && ( getSystemEnvVars().getProperty( "M2_HOME" ) != null ) )
560		{
561	0	mavenHome = new File( getSystemEnvVars().getProperty( "M2_HOME" ) );
562		}
563		}
564
565	11	logger.debug( "Using ${maven.home} of: \'" + mavenHome + "\'." );
566
567	11	if ( mavenExecutable == null \|\| !mavenExecutable.isAbsolute() )
568		{
569		String executable;
570	11	if( mavenExecutable != null )
571		{
572	1	executable = mavenExecutable.getPath();
573		}
574	10	else if ( Os.isFamily( "windows" ) )
575		{
576	10	executable = "mvn.bat";
577		}
578		else
579		{
580	0	executable = "mvn";
581		}
582
583	11	mavenExecutable = new File( mavenHome, "/bin/" + executable );
584
585		try
586		{
587	11	File canonicalMvn = mavenExecutable.getCanonicalFile();
588	11	mavenExecutable = canonicalMvn;
589		}
590	0	catch ( IOException e )
591		{
592	0	logger.debug( "Failed to canonicalize maven executable: " + mavenExecutable + ". Using as-is.", e );
593	11	}
594
595	11	if ( !mavenExecutable.isFile() )
596		{
597	0	throw new CommandLineConfigurationException( "Maven executable not found at: " + mavenExecutable );
598		}
599		}
600
601	11	return mavenExecutable;
602		}
603
604		/**
605		* Wraps a path with quotes to handle paths with spaces. If no spaces are found, the original string is returned.
606		*
607		* @param path string to wrap if containing spaces
608		* @return quote wrapped string
609		* @deprecated Quoting of command line arguments should be left to the Commandline from plexus-utils.
610		*/
611		public String wrapStringWithQuotes( String path )
612		{
613	4	if ( path.indexOf( " " ) > -1 )
614		{
615	2	return "\"" + path + "\"";
616		}
617		else
618		{
619	2	return path;
620		}
621		}
622
623		private Properties getSystemEnvVars()
624		throws IOException
625		{
626	0	if ( this.systemEnvVars == null )
627		{
628		// with 1.5 replace with System.getenv()
629	0	this.systemEnvVars = CommandLineUtils.getSystemEnvVars();
630		}
631	0	return this.systemEnvVars;
632		}
633
634		public File getLocalRepositoryDirectory()
635		{
636	0	return localRepositoryDirectory;
637		}
638
639		public void setLocalRepositoryDirectory( File localRepositoryDirectory )
640		{
641	3	this.localRepositoryDirectory = localRepositoryDirectory;
642	3	}
643
644		public InvokerLogger getLogger()
645		{
646	0	return logger;
647		}
648
649		public void setLogger( InvokerLogger logger )
650		{
651	7	this.logger = logger;
652	7	}
653
654		public File getMavenHome()
655		{
656	0	return mavenHome;
657		}
658
659		public void setMavenHome( File mavenHome )
660		{
661	7	this.mavenHome = mavenHome;
662	7	}
663
664		public File getWorkingDirectory()
665		{
666	0	return workingDirectory;
667		}
668
669		public void setWorkingDirectory( File workingDirectory )
670		{
671	2	this.workingDirectory = workingDirectory;
672	2	}
673
674		/**
675		* {@code mavenExecutable} can either be relative to ${maven.home}/bin/ or absolute
676		*
677		* @param mavenExecutable the executable
678		*/
679		public void setMavenExecutable( File mavenExecutable )
680		{
681	1	this.mavenExecutable = mavenExecutable;
682	1	}
683
684		public File getMavenExecutable()
685		{
686	0	return mavenExecutable;
687		}
688
689		}