Fix issue #364 - TTY option to run commands

pom.xml

@@ -9,7 +9,7 @@
 		<version>1.0.5</version>
 	</parent>
 	<artifactId>server</artifactId>
-	<version>4.8.0</version>
+	<version>4.8.1</version>
 	<packaging>pom</packaging>
 	<build>
 		<finalName>${project.groupId}.${project.artifactId}-${project.version}</finalName>
@@ -554,7 +554,7 @@
 	</repositories>
 	<properties>
 		<commons.version>2.0.11</commons.version>
-		<k8shelper.version>2.1.5</k8shelper.version>
+		<k8shelper.version>2.1.6</k8shelper.version>
 		<slf4j.version>1.7.5</slf4j.version>
 		<logback.version>1.2.0</logback.version>
 		<antlr.version>4.7.2</antlr.version>

server-core/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<build>
 		<plugins>

server-core/src/main/java/io/onedev/server/buildspec/BuildSpec.java

@@ -1001,4 +1001,48 @@ private void migrate8(VersionedYamlDoc doc, Stack<Integer> versions) {
 		}			
 	}	
 
+	@SuppressWarnings("unused")
+	private void migrate9(VersionedYamlDoc doc, Stack<Integer> versions) {
+		for (NodeTuple specTuple: doc.getValue()) {
+			String specObjectKey = ((ScalarNode)specTuple.getKeyNode()).getValue();
+			if (specObjectKey.equals("jobs")) {
+				SequenceNode jobsNode = (SequenceNode) specTuple.getValueNode();
+				for (Node jobsNodeItem: jobsNode.getValue()) {
+					MappingNode jobNode = (MappingNode) jobsNodeItem;
+					for (NodeTuple jobTuple: jobNode.getValue()) {
+						String jobTupleKey = ((ScalarNode)jobTuple.getKeyNode()).getValue();
+						if (jobTupleKey.equals("steps")) {
+							SequenceNode stepsNode = (SequenceNode) jobTuple.getValueNode();
+							for (Node stepsNodeItem: stepsNode.getValue()) {
+								MappingNode stepNode = (MappingNode) stepsNodeItem;
+								if (stepNode.getTag().getValue().equals("!CommandStep")) {
+									stepNode.getValue().add(new NodeTuple(new ScalarNode(Tag.STR, "useTTY"), 
+											new ScalarNode(Tag.BOOL, "false")));
+								}
+							}
+						}
+					}
+				}
+			} else if (specObjectKey.equals("stepTemplates")) {
+				SequenceNode stepTemplatesNode = (SequenceNode) specTuple.getValueNode();
+				for (Node stepTemplatesNodeItem: stepTemplatesNode.getValue()) {
+					MappingNode stepTemplateNode = (MappingNode) stepTemplatesNodeItem;
+					for (NodeTuple stepTemplateTuple: stepTemplateNode.getValue()) {
+						String stepTemplateTupleKey = ((ScalarNode)stepTemplateTuple.getKeyNode()).getValue();
+						if (stepTemplateTupleKey.equals("steps")) {
+							SequenceNode stepsNode = (SequenceNode) stepTemplateTuple.getValueNode();
+							for (Node stepsNodeItem: stepsNode.getValue()) {
+								MappingNode stepNode = (MappingNode) stepsNodeItem;
+								if (stepNode.getTag().getValue().equals("!CommandStep")) {
+									stepNode.getValue().add(new NodeTuple(new ScalarNode(Tag.STR, "useTTY"), 
+											new ScalarNode(Tag.BOOL, "false")));
+								}
+							}
+						}
+					}
+				}				
+			}
+		}			
+	}	
+
 }

server-core/src/main/java/io/onedev/server/buildspec/step/CommandStep.java

@@ -26,6 +26,8 @@ public class CommandStep extends Step {
 
 	private List<String> commands = new ArrayList<>();
 
+	private boolean useTTY;
+
 	@Editable(order=100, description="Specify docker image to execute commands inside")
 	@Interpolative(variableSuggester="suggestVariables")
 	@NotEmpty
@@ -50,6 +52,18 @@ public void setCommands(List<String> commands) {
 		this.commands = commands;
 	}
 
+	@Editable(order=120, name="Enable TTY Mode", description="Many commands print outputs with ANSI colors in "
+			+ "TTY mode to help identifying problems easily. However some commands running in this mode may "
+			+ "wait for user input to cause build hanging. This can normally be fixed by adding extra options "
+			+ "to the command")
+	public boolean isUseTTY() {
+		return useTTY;
+	}
+
+	public void setUseTTY(boolean useTTY) {
+		this.useTTY = useTTY;
+	}
+
 	@SuppressWarnings("unused")
 	private static List<InputSuggestion> suggestVariables(String matchWith) {
 		return BuildSpec.suggestVariables(matchWith, false, false);
@@ -62,7 +76,7 @@ private static List<InputSuggestion> suggestCommandVariables(String matchWith) {
 
 	@Override
 	public Executable getExecutable(Build build, String jobToken, ParamCombination paramCombination) {
-		return new CommandExecutable(getImage(), getCommands());
+		return new CommandExecutable(getImage(), getCommands(), isUseTTY());
 	}
 
 }

server-core/src/main/java/io/onedev/server/migration/DataMigrator.java

@@ -2581,4 +2581,24 @@ private void migrate59(File dataDir, Stack<Integer> versions) {
 		}
 	}
 
+	private void migrate60(File dataDir, Stack<Integer> versions) {
+		for (File file: dataDir.listFiles()) {
+			if (file.getName().startsWith("Settings.xml")) {
+				VersionedXmlDoc dom = VersionedXmlDoc.fromFile(file);
+				for (Element element: dom.getRootElement().elements()) {
+					if (element.elementTextTrim("key").equals("JOB_EXECUTORS")) {
+						Element valueElement = element.element("value");
+						if (valueElement != null) {
+							for (Element executorElement: valueElement.elements()) {
+								if (executorElement.getName().equals("io.onedev.server.plugin.docker.DockerExecutor"))
+									executorElement.setName("io.onedev.server.plugin.executor.docker.DockerExecutor");
+							}
+						}
+					}
+				}
+				dom.writeToFile(file, false);
+			}
+		}
+	}
+
 }

server-plugin/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<dependencies>
 		<dependency>

server-plugin/server-plugin-archetype/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<build>
 		<resources>

server-plugin/server-plugin-authenticator-ldap/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.authenticator.ldap.LdapModule</moduleClass>

server-plugin/server-plugin-buildspec-gradle/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.buildspec.gradle.GradleModule</moduleClass>

server-plugin/server-plugin-buildspec-maven/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.buildspec.maven.MavenModule</moduleClass>

server-plugin/server-plugin-buildspec-node/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.buildspec.node.NodePluginModule</moduleClass>

server-plugin/server-plugin-executor-docker/pom.xml

@@ -5,9 +5,9 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
-		<moduleClass>io.onedev.server.plugin.docker.DockerModule</moduleClass>
+		<moduleClass>io.onedev.server.plugin.executor.docker.DockerModule</moduleClass>
 	</properties>
 </project>

server-plugin/server-plugin-executor-docker/src/main/java/io/onedev/server/plugin/docker/DockerExecutor.java → server-plugin/server-plugin-executor-docker/src/main/java/io/onedev/server/plugin/executor/docker/DockerExecutor.java

@@ -1,4 +1,4 @@
-package io.onedev.server.plugin.docker;
+package io.onedev.server.plugin.executor.docker;
 
 import static io.onedev.k8shelper.KubernetesHelper.cloneRepository;
 import static io.onedev.k8shelper.KubernetesHelper.getCacheInstances;
@@ -70,7 +70,7 @@
 import io.onedev.server.git.config.GitConfig;
 import io.onedev.server.model.support.RegistryLogin;
 import io.onedev.server.model.support.administration.jobexecutor.JobExecutor;
-import io.onedev.server.plugin.docker.DockerExecutor.TestData;
+import io.onedev.server.plugin.executor.docker.DockerExecutor.TestData;
 import io.onedev.server.util.ExceptionUtils;
 import io.onedev.server.util.PKCS12CertExtractor;
 import io.onedev.server.util.ServerConfig;
@@ -593,6 +593,8 @@ public boolean execute(LeafExecutable executable, List<Integer> position) {
 											}
 										}
 
+										if (commandExecutable.isUseTTY())
+											docker.addArgs("-t");
 										docker.addArgs("-w", containerWorkspace, "--entrypoint=" + containerEntryPoint);
 
 										docker.addArgs(commandExecutable.getImage());

server-plugin/server-plugin-executor-docker/src/main/java/io/onedev/server/plugin/docker/DockerModule.java → server-plugin/server-plugin-executor-docker/src/main/java/io/onedev/server/plugin/executor/docker/DockerModule.java

@@ -1,4 +1,4 @@
-package io.onedev.server.plugin.docker;
+package io.onedev.server.plugin.executor.docker;
 
 import java.util.Collection;
 

server-plugin/server-plugin-executor-kubernetes/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.executor.kubernetes.KubernetesModule</moduleClass>

server-plugin/server-plugin-executor-kubernetes/src/main/java/io/onedev/server/plugin/executor/kubernetes/KubernetesExecutor.java

@@ -823,7 +823,7 @@ public void consume(String line) {
 				} else {
 					List<Action> actions = new ArrayList<>();
 					CommandExecutable executable = new CommandExecutable((String) executionContext, 
-							Lists.newArrayList("this does not matter"));
+							Lists.newArrayList("this does not matter"), false);
 					actions.add(new Action("test", executable, ExecuteCondition.ALWAYS));
 					entryExecutable = new CompositeExecutable(actions);
 				}
@@ -853,16 +853,19 @@ public void consume(String line) {
 					public Void visit(LeafExecutable executable, List<Integer> position) {
 						String containerName = getContainerName(position);
 						containerNames.add(containerName);
-						String image;
-						if (executable instanceof CommandExecutable)
-							image = ((CommandExecutable)executable).getImage();
-						else 
-							image = "1dev/k8s-helper-" + baselineOsInfo.getHelperImageSuffix() + ":" + helperImageVersion;
+						Map<Object, Object> stepContainerSpec;
+						if (executable instanceof CommandExecutable) {
+							stepContainerSpec = CollectionUtils.newHashMap(
+									"name", containerName, 
+									"image", ((CommandExecutable)executable).getImage());
+							if (((CommandExecutable) executable).isUseTTY())
+								stepContainerSpec.put("tty", true);
+						} else { 
+							stepContainerSpec = CollectionUtils.newHashMap(
+									"name", containerName, 
+									"image", "1dev/k8s-helper-" + baselineOsInfo.getHelperImageSuffix() + ":" + helperImageVersion);
+						}
 
-						Map<Object, Object> stepContainerSpec = CollectionUtils.newHashMap(
-								"name", containerName, 
-								"image", image);
-
 						String positionStr = stringifyPosition(position);
 						if (baselineOsInfo.isLinux()) {
 							stepContainerSpec.put("command", Lists.newArrayList("sh"));

server-plugin/server-plugin-import-github/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.imports.github.GitHubPluginModule</moduleClass>

server-plugin/server-plugin-import-youtrack/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.imports.youtrack.YouTrackPluginModule</moduleClass>

server-plugin/server-plugin-report-checkstyle/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.report.checkstyle.CheckstylePluginModule</moduleClass>

server-plugin/server-plugin-report-clover/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.report.clover.CloverPluginModule</moduleClass>

server-plugin/server-plugin-report-jest/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.report.jest.JestTestReportModule</moduleClass>

server-plugin/server-plugin-report-markdown/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<properties>
 		<moduleClass>io.onedev.server.plugin.report.markdown.MarkdownReportModule</moduleClass>

server-plugin/server-plugin-sso-openid/pom.xml

@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server-plugin</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<dependencies>
 		<dependency>

server-product/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>io.onedev</groupId>
 		<artifactId>server</artifactId>
-		<version>4.8.0</version>
+		<version>4.8.1</version>
 	</parent>
 	<dependencies>
 		<dependency>