Validate app names for their length

 - Before deploying/launching stream/task, validate the app names' length
 - For streams, the length is computed as `streamName-appName-v{version}
 - Rename the validation method
 - Add more logging and increase the version length limit to 5 digits

Fixes #3005

Author: ilayaperumalg

spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/service/impl/validation/DefaultTaskValidationService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018 the original author or authors.
+ * Copyright 2018-2019 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@
 import org.springframework.cloud.dataflow.server.service.ValidationStatus;
 import org.springframework.cloud.dataflow.server.service.impl.NodeStatus;
 import org.springframework.cloud.dataflow.server.service.impl.TaskServiceUtils;
+import org.springframework.cloud.task.listener.TaskException;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
@@ -35,9 +36,12 @@
  *
  * @author Glenn Renfro
  * @author Mark Pollack
+ * @author Ilayaperumal Gopinathan
  */
 public class DefaultTaskValidationService extends DefaultValidationService implements TaskValidationService {
 
+	private static final int MAX_APPNAME_LENGTH = 63;
+
 	private final TaskDefinitionRepository taskDefinitionRepository;
 
 	private final String composedTaskRunnerName;
@@ -54,6 +58,7 @@ public DefaultTaskValidationService(AppRegistryService appRegistry,
 
 	@Override
 	public ValidationStatus validateTask(String name) {
+		validateTaskName(name);
 		TaskDefinition definition = this.taskDefinitionRepository.findByTaskName(name);
 		ValidationStatus validationStatus = new ValidationStatus(
 				definition.getName(),
@@ -68,6 +73,7 @@ public ValidationStatus validateTask(String name) {
 				String childTaskPrefix = TaskNode.getTaskPrefix(name);
 				taskNode.getTaskApps().stream().forEach(task -> {
 					TaskDefinition childDefinition = this.taskDefinitionRepository.findByTaskName(childTaskPrefix + task.getName());
+					validateTaskName(childTaskPrefix + task.getName());
 					boolean status = this.validate(childDefinition.getRegisteredAppName(), ApplicationType.task);
 					validationStatus.getAppsStatuses().put(
 							String.format("%s:%s", appType.name(), childDefinition.getName()),
@@ -88,4 +94,10 @@ public ValidationStatus validateTask(String name) {
 		}
 		return validationStatus;
 	}
+
+	private void validateTaskName(String taskName) {
+		if (taskName.length() > MAX_APPNAME_LENGTH) {
+			throw new TaskException("The task name should not exceed "+ MAX_APPNAME_LENGTH+ " in length.");
+		}
+	}
 }

spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/stream/SkipperStreamDeployer.java

@@ -48,6 +48,7 @@
 import org.springframework.cloud.dataflow.registry.service.AppRegistryService;
 import org.springframework.cloud.dataflow.rest.SkipperStream;
 import org.springframework.cloud.dataflow.server.controller.NoSuchAppException;
+import org.springframework.cloud.dataflow.server.controller.support.InvalidStreamDefinitionException;
 import org.springframework.cloud.dataflow.server.repository.NoSuchStreamDefinitionException;
 import org.springframework.cloud.dataflow.server.repository.StreamDefinitionRepository;
 import org.springframework.cloud.deployer.spi.app.AppInstanceStatus;
@@ -98,6 +99,9 @@ public class SkipperStreamDeployer implements StreamDeployer {
 
 	private static Log logger = LogFactory.getLog(SkipperStreamDeployer.class);
 
+	//Assume version suffix added by skipper is 5 chars.
+	private static final int MAX_APPNAME_LENGTH = 63-5;
+
 	private final SkipperClient skipperClient;
 
 	private final StreamDefinitionRepository streamDefinitionRepository;
@@ -200,7 +204,7 @@ private boolean streamDefinitionExists(String streamName) {
 	}
 
 	public Release deployStream(StreamDeploymentRequest streamDeploymentRequest) {
-		validateAllAppsRegistered(streamDeploymentRequest);
+		validateStreamDeploymentRequest(streamDeploymentRequest);
 		Map<String, String> streamDeployerProperties = streamDeploymentRequest.getStreamDeployerProperties();
 		String packageVersion = streamDeployerProperties.get(SkipperStream.SKIPPER_PACKAGE_VERSION);
 		Assert.isTrue(StringUtils.hasText(packageVersion), "Package Version must be set");
@@ -283,21 +287,32 @@ private String determinePlatformName(final String platformName) {
 		}
 	}
 
-	private void validateAllAppsRegistered(StreamDeploymentRequest streamDeploymentRequest) {
+	private void validateStreamDeploymentRequest(StreamDeploymentRequest streamDeploymentRequest) {
 		if (streamDeploymentRequest.getAppDeploymentRequests() == null
 				|| streamDeploymentRequest.getAppDeploymentRequests().isEmpty()) {
 			// nothing to validate.
 			return;
 		}
-
+		String streamName = streamDeploymentRequest.getStreamName();
 		// throw as at this point we should have definition
 		StreamDefinition streamDefinition = this.streamDefinitionRepository
-				.findById(streamDeploymentRequest.getStreamName())
+				.findById(streamName)
 				.orElseThrow(() -> new NoSuchStreamDefinitionException(streamDeploymentRequest.getStreamName()));
 
 		for (AppDeploymentRequest adr : streamDeploymentRequest.getAppDeploymentRequests()) {
+			String registeredAppName = getRegisteredName(streamDefinition, adr.getDefinition().getName());
+			String appName =  String.format("%s-%s-v", streamName, registeredAppName);
+			if (appName.length() > 40) {
+				logger.warn("The stream name plus application name [" + appName + "] is longer than 40 characters." +
+						"  This can not exceed " + MAX_APPNAME_LENGTH + " in length.");
+			}
+			if (appName.length() > MAX_APPNAME_LENGTH) {
+				throw new InvalidStreamDefinitionException(
+						String.format("The runtime application name for the app %s in the stream %s "
+						+ "should not exceed %s in length. The runtime application name is: %s", registeredAppName, streamName, MAX_APPNAME_LENGTH, appName));
+			}
 			String version = this.appRegistryService.getResourceVersion(adr.getResource());
-			validateAppVersionIsRegistered(getRegisteredName(streamDefinition, adr.getDefinition().getName()), adr, version);
+			validateAppVersionIsRegistered(registeredAppName, adr, version);
 		}
 	}
 

spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/stream/SkipperStreamDeployerTests.java

@@ -33,6 +33,7 @@
 import org.springframework.cloud.dataflow.core.StreamDefinition;
 import org.springframework.cloud.dataflow.registry.service.AppRegistryService;
 import org.springframework.cloud.dataflow.rest.SkipperStream;
+import org.springframework.cloud.dataflow.server.controller.support.InvalidStreamDefinitionException;
 import org.springframework.cloud.dataflow.server.repository.StreamDefinitionRepository;
 import org.springframework.cloud.dataflow.server.support.MockUtils;
 import org.springframework.cloud.dataflow.server.support.SkipperPackageUtils;
@@ -375,6 +376,50 @@ public void testStateOfUndeployedStream() {
 
 	}
 
+	@Test
+	public void testStreamDeployWithLongAppName() {
+
+		AppRegistryService appRegistryService = mock(AppRegistryService.class);
+
+		when(appRegistryService.appExist(eq("time"), eq(ApplicationType.source), eq("1.2.0.RELEASE")))
+				.thenReturn(true);
+		when(appRegistryService.appExist(eq("log"), eq(ApplicationType.sink), eq("1.2.0.RELEASE")))
+				.thenReturn(true);
+
+		AppDefinition timeAppDefinition = new AppDefinition("time", new HashMap<>());
+		MavenResource timeResource = new MavenResource.Builder()
+				.artifactId("time-source-rabbit").groupId("org.springframework.cloud.stream.app")
+				.version("1.2.0.RELEASE").build();
+		when(appRegistryService.getResourceVersion(timeResource)).thenReturn(timeResource.getVersion());
+		AppDeploymentRequest timeAppDeploymentRequest = new AppDeploymentRequest(timeAppDefinition, timeResource);
+
+		List<AppDeploymentRequest> appDeploymentRequests = Arrays.asList(timeAppDeploymentRequest);
+
+		String streamName = "asdfkdunfdnereerejrerkjelkraerkldjkfdjfkdsjflkjdflkdjflsdflsdjfldlfdlsfjdlfjdlfjdslfdnmdfndfmdsfmndsdfafdsfmdnfdske";
+
+		String streamDSL = "time | log";
+
+		StreamDeploymentRequest streamDeploymentRequest = new StreamDeploymentRequest(streamName, streamDSL,
+								appDeploymentRequests,
+				new HashMap<>());
+
+		SkipperClient skipperClient = MockUtils.createSkipperClientMock();
+
+		StreamDefinitionRepository streamDefinitionRepository = mock(StreamDefinitionRepository.class);
+		SkipperStreamDeployer skipperStreamDeployer = new SkipperStreamDeployer(skipperClient,
+				streamDefinitionRepository, appRegistryService, mock(ForkJoinPool.class));
+
+		when(streamDefinitionRepository.findById(streamName)).thenReturn(Optional.of(new StreamDefinition(streamName, streamDSL)));
+		try {
+			skipperStreamDeployer.deployStream(streamDeploymentRequest);
+			fail("Expected InvalidStreamDefinitionException");
+		}
+		catch (Exception e) {
+			assertThat(e instanceof InvalidStreamDefinitionException).isTrue();
+			assertThat(e.getMessage().equals("The runtime application name for the app time in the stream "+streamName+" should not exceed 63 in length. Currently it is: "+streamName+"-time-v{version-2digits}"));
+		}
+	}
+
 	private Info createInfo(StatusCode statusCode) {
 		Info info = new Info();
 		Status status = new Status();