Coverage Report

Coverage Report - org.apache.maven.shared.utils.cli.shell.BourneShell

Classes in this File

Line Coverage

Branch Coverage

Complexity

BourneShell

80%

33/41

50%

11/22

3.143

 package org.apache.maven.shared.utils.cli.shell;
 
 /*
  * 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.util.ArrayList;
 import java.util.List;
 import org.apache.maven.shared.utils.Os;
 import org.apache.maven.shared.utils.StringUtils;
 
 /**
  * @author Jason van Zyl
  */
 public class BourneShell
     extends Shell
 {
     private static final char[] BASH_QUOTING_TRIGGER_CHARS =
         { ' ', '$', ';', '&', '|', '<', '>', '*', '?', '(', ')', '[', ']', '{', '}', '`' };
 
     public BourneShell()
     {
         setShellCommand( "/bin/sh" );
         setArgumentQuoteDelimiter( '\'' );
         setExecutableQuoteDelimiter( '\"' );
         setSingleQuotedArgumentEscaped( true );
         setSingleQuotedExecutableEscaped( false );
         setQuotedExecutableEnabled( true );
     }
 
     /**
      * {@inheritDoc}
      */
     public String getExecutable()
     {
         if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
         {
             return super.getExecutable();
         }
 
         return unifyQuotes( super.getExecutable() );
     }
 
     public List<String> getShellArgsList()
     {
         List<String> shellArgs = new ArrayList<String>();
         List<String> existingShellArgs = super.getShellArgsList();
 
         if ( ( existingShellArgs != null ) && !existingShellArgs.isEmpty() )
         {
             shellArgs.addAll( existingShellArgs );
         }
 
         shellArgs.add( "-c" );
 
         return shellArgs;
     }
 
     public String[] getShellArgs()
     {
         String[] shellArgs = super.getShellArgs();
         if ( shellArgs == null )
         {
             shellArgs = new String[0];
         }
 
         if ( ( shellArgs.length > 0 ) && !shellArgs[shellArgs.length - 1].equals( "-c" ) )
         {
             String[] newArgs = new String[shellArgs.length + 1];
 
             System.arraycopy( shellArgs, 0, newArgs, 0, shellArgs.length );
             newArgs[shellArgs.length] = "-c";
 
             shellArgs = newArgs;
         }
 
         return shellArgs;
     }
 
     protected String getExecutionPreamble()
     {
         if ( getWorkingDirectoryAsString() == null )
         {
             return null;
         }
 
         String dir = getWorkingDirectoryAsString();
         StringBuilder sb = new StringBuilder();
         sb.append( "cd " );
 
         sb.append( unifyQuotes( dir ) );
         sb.append( " && " );
 
         return sb.toString();
     }
 
     protected char[] getQuotingTriggerChars()
     {
         return BASH_QUOTING_TRIGGER_CHARS;
     }
 
     /**
      * <p>Unify quotes in a path for the Bourne Shell.</p>
      * <p/>
      * <pre>
      * BourneShell.unifyQuotes(null)                       = null
      * BourneShell.unifyQuotes("")                         = (empty)
      * BourneShell.unifyQuotes("/test/quotedpath'abc")     = /test/quotedpath\'abc
      * BourneShell.unifyQuotes("/test/quoted path'abc")    = "/test/quoted path'abc"
      * BourneShell.unifyQuotes("/test/quotedpath\"abc")    = "/test/quotedpath\"abc"
      * BourneShell.unifyQuotes("/test/quoted path\"abc")   = "/test/quoted path\"abc"
      * BourneShell.unifyQuotes("/test/quotedpath\"'abc")   = "/test/quotedpath\"'abc"
      * BourneShell.unifyQuotes("/test/quoted path\"'abc")  = "/test/quoted path\"'abc"
      * </pre>
      *
      * @param path not null path.
      * @return the path unified correctly for the Bourne shell.
      */
     private static String unifyQuotes( String path )
     {
         if ( path == null )
         {
             return null;
         }
 
         if ( path.indexOf( ' ' ) == -1 && path.indexOf( '\'' ) != -1 && path.indexOf( '"' ) == -1 )
         {
             return StringUtils.escape( path );
         }
 
         return StringUtils.quoteAndEscape( path, '\"', BASH_QUOTING_TRIGGER_CHARS );
     }
 }

1		package org.apache.maven.shared.utils.cli.shell;
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
23		import java.util.ArrayList;
24		import java.util.List;
25		import org.apache.maven.shared.utils.Os;
26		import org.apache.maven.shared.utils.StringUtils;
27
28		/**
29		* @author Jason van Zyl
30		*/
31		public class BourneShell
32		extends Shell
33		{
34	1	private static final char[] BASH_QUOTING_TRIGGER_CHARS =
35		{ ' ', '$', ';', '&', '\|', '<', '>', '*', '?', '(', ')', '[', ']', '{', '}', '`' };
36
37		public BourneShell()
38	9	{
39	9	setShellCommand( "/bin/sh" );
40	9	setArgumentQuoteDelimiter( '\'' );
41	9	setExecutableQuoteDelimiter( '\"' );
42	9	setSingleQuotedArgumentEscaped( true );
43	9	setSingleQuotedExecutableEscaped( false );
44	9	setQuotedExecutableEnabled( true );
45	9	}
46
47		/**
48		* {@inheritDoc}
49		*/
50		public String getExecutable()
51		{
52	18	if ( Os.isFamily( Os.FAMILY_WINDOWS ) )
53		{
54	0	return super.getExecutable();
55		}
56
57	18	return unifyQuotes( super.getExecutable() );
58		}
59
60		public List<String> getShellArgsList()
61		{
62	9	List<String> shellArgs = new ArrayList<String>();
63	9	List<String> existingShellArgs = super.getShellArgsList();
64
65	9	if ( ( existingShellArgs != null ) && !existingShellArgs.isEmpty() )
66		{
67	0	shellArgs.addAll( existingShellArgs );
68		}
69
70	9	shellArgs.add( "-c" );
71
72	9	return shellArgs;
73		}
74
75		public String[] getShellArgs()
76		{
77	9	String[] shellArgs = super.getShellArgs();
78	9	if ( shellArgs == null )
79		{
80	9	shellArgs = new String[0];
81		}
82
83	9	if ( ( shellArgs.length > 0 ) && !shellArgs[shellArgs.length - 1].equals( "-c" ) )
84		{
85	0	String[] newArgs = new String[shellArgs.length + 1];
86
87	0	System.arraycopy( shellArgs, 0, newArgs, 0, shellArgs.length );
88	0	newArgs[shellArgs.length] = "-c";
89
90	0	shellArgs = newArgs;
91		}
92
93	9	return shellArgs;
94		}
95
96		protected String getExecutionPreamble()
97		{
98	9	if ( getWorkingDirectoryAsString() == null )
99		{
100	3	return null;
101		}
102
103	6	String dir = getWorkingDirectoryAsString();
104	6	StringBuilder sb = new StringBuilder();
105	6	sb.append( "cd " );
106
107	6	sb.append( unifyQuotes( dir ) );
108	6	sb.append( " && " );
109
110	6	return sb.toString();
111		}
112
113		protected char[] getQuotingTriggerChars()
114		{
115	35	return BASH_QUOTING_TRIGGER_CHARS;
116		}
117
118		/**
119		* <p>Unify quotes in a path for the Bourne Shell.</p>
120		* <p/>
121		* <pre>
122		* BourneShell.unifyQuotes(null) = null
123		* BourneShell.unifyQuotes("") = (empty)
124		* BourneShell.unifyQuotes("/test/quotedpath'abc") = /test/quotedpath\'abc
125		* BourneShell.unifyQuotes("/test/quoted path'abc") = "/test/quoted path'abc"
126		* BourneShell.unifyQuotes("/test/quotedpath\"abc") = "/test/quotedpath\"abc"
127		* BourneShell.unifyQuotes("/test/quoted path\"abc") = "/test/quoted path\"abc"
128		* BourneShell.unifyQuotes("/test/quotedpath\"'abc") = "/test/quotedpath\"'abc"
129		* BourneShell.unifyQuotes("/test/quoted path\"'abc") = "/test/quoted path\"'abc"
130		* </pre>
131		*
132		* @param path not null path.
133		* @return the path unified correctly for the Bourne shell.
134		*/
135		private static String unifyQuotes( String path )
136		{
137	24	if ( path == null )
138		{
139	0	return null;
140		}
141
142	24	if ( path.indexOf( ' ' ) == -1 && path.indexOf( '\'' ) != -1 && path.indexOf( '"' ) == -1 )
143		{
144	0	return StringUtils.escape( path );
145		}
146
147	24	return StringUtils.quoteAndEscape( path, '\"', BASH_QUOTING_TRIGGER_CHARS );
148		}
149		}