big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

HADOOP-13434. Add bash quoting to Shell class. (Owen O'Malley)

Browse Source
This commit is contained in:
Arpit Agarwal 2016-08-02 13:40:33 -07:00
parent 5e5b8793fb
commit 954465e7ba
2 changed files with 73 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/util/Shell.java
View File

@ -118,6 +118,21 @@ public static void checkWindowsCommandLineLength(String...commands)
}
}
/**
* Quote the given arg so that bash will interpret it as a single value.
* Note that this quotes it for one level of bash, if you are passing it
* into a badly written shell script, you need to fix your shell script.
* @param arg the argument to quote
* @return the quoted string
*/
static String bashQuote(String arg) {
StringBuilder buffer = new StringBuilder(arg.length() + 2);
buffer.append('\'');
buffer.append(arg.replace("'", "'\\''"));
buffer.append('\'');
return buffer.toString();
}
/** a Unix command to get the current user's name: {@value}. */
public static final String USER_NAME_COMMAND = "whoami";
@ -173,7 +188,7 @@ private static OSType getOSType() {
/** a Unix command to get the current user's groups list. */
public static String[] getGroupsCommand() {
return (WINDOWS)? new String[]{"cmd", "/c", "groups"}
: new String[]{"bash", "-c", "groups"};
: new String[]{"groups"};
}
/**
@ -184,10 +199,14 @@ public static String[] getGroupsCommand() {
*/
public static String[] getGroupsForUserCommand(final String user) {
//'groups username' command return is inconsistent across different unixes
return WINDOWS ?
new String[]
{getWinUtilsPath(), "groups", "-F", "\"" + user + "\""}
: new String[] {"bash", "-c", "id -gn " + user + "; id -Gn " + user};
if (WINDOWS) {
return new String[]
{getWinUtilsPath(), "groups", "-F", "\"" + user + "\""};
} else {
String quotedUser = bashQuote(user);
return new String[] {"bash", "-c", "id -gn " + quotedUser +
"; id -Gn " + quotedUser};
}
}
/**
@ -199,17 +218,20 @@ public static String[] getGroupsForUserCommand(final String user) {
*/
public static String[] getGroupsIDForUserCommand(final String user) {
//'groups username' command return is inconsistent across different unixes
return WINDOWS ?
new String[]
{getWinUtilsPath(), "groups", "-F", "\"" + user + "\""}
: new String[] {"bash", "-c", "id -g " + user + "; id -G " + user};
if (WINDOWS) {
return new String[]{getWinUtilsPath(), "groups", "-F", "\"" + user +
"\""};
} else {
String quotedUser = bashQuote(user);
return new String[] {"bash", "-c", "id -g " + quotedUser + "; id -G " +
quotedUser};
}
}
/** A command to get a given netgroup's user list. */
public static String[] getUsersForNetgroupCommand(final String netgroup) {
//'groups username' command return is non-consistent across different unixes
return WINDOWS ? new String [] {"cmd", "/c", "getent netgroup " + netgroup}
: new String [] {"bash", "-c", "getent netgroup " + netgroup};
return new String[] {"getent", "netgroup", netgroup};
}
/** Return a command to get permission information. */
@ -240,7 +262,8 @@ public static String[] getSetPermissionCommand(String perm, boolean recursive) {
* @return String[] containing command and arguments
*/
public static String[] getSetPermissionCommand(String perm,
boolean recursive, String file) {
boolean recursive,
String file) {
String[] baseCmd = getSetPermissionCommand(perm, recursive);
String[] cmdWithFile = Arrays.copyOf(baseCmd, baseCmd.length + 1);
cmdWithFile[cmdWithFile.length - 1] = file;
@ -290,9 +313,9 @@ public static String[] getSignalKillCommand(int code, String pid) {
if (isSetsidAvailable) {
// Use the shell-builtin as it support "--" in all Hadoop supported OSes
return new String[] { "bash", "-c", "kill -" + code + " -- -" + pid };
return new String[] {"kill", "-" + code, "--", "-" + pid};
} else {
return new String[] { "bash", "-c", "kill -" + code + " " + pid };
return new String[] {"kill", "-" + code, pid };
}
}
@ -343,7 +366,7 @@ public static String[] getRunScriptCommand(File script) {
String absolutePath = script.getAbsolutePath();
return WINDOWS ?
new String[] {"cmd", "/c", absolutePath }
: new String[] { "/bin/bash", absolutePath };
: new String[] {"/bin/bash", bashQuote(absolutePath) };
}
/** a Unix command to set permission: {@value}. */

14
hadoop-common-project/hadoop-common/src/test/java/org/apache/hadoop/util/TestShell.java
View File

@ -235,9 +235,9 @@ public void testGetCheckProcessIsAliveCommand() throws Exception {
expectedCommand =
new String[]{getWinUtilsPath(), "task", "isAlive", anyPid };
} else if (Shell.isSetsidAvailable) {
expectedCommand = new String[] { "bash", "-c", "kill -0 -- -" + anyPid };
expectedCommand = new String[] {"kill", "-0", "--", "-" + anyPid };
} else {
expectedCommand = new String[]{ "bash", "-c", "kill -0 " + anyPid };
expectedCommand = new String[] {"kill", "-0", anyPid };
}
Assert.assertArrayEquals(expectedCommand, checkProcessAliveCommand);
}
@ -255,9 +255,9 @@ public void testGetSignalKillCommand() throws Exception {
expectedCommand =
new String[]{getWinUtilsPath(), "task", "kill", anyPid };
} else if (Shell.isSetsidAvailable) {
expectedCommand = new String[] { "bash", "-c", "kill -9 -- -" + anyPid };
expectedCommand = new String[] {"kill", "-9", "--", "-" + anyPid };
} else {
expectedCommand = new String[]{ "bash", "-c", "kill -9 " + anyPid };
expectedCommand = new String[] {"kill", "-9", anyPid };
}
Assert.assertArrayEquals(expectedCommand, checkProcessAliveCommand);
}
@ -461,4 +461,10 @@ private void assertExContains(Exception ex, String expectedText)
}
}
@Test
public void testBashQuote() {
assertEquals("'foobar'", Shell.bashQuote("foobar"));
assertEquals("'foo'\\''bar'", Shell.bashQuote("foo'bar"));
assertEquals("''\\''foo'\\''bar'\\'''", Shell.bashQuote("'foo'bar'"));
}
}