Add support for sorting by SchemaTarget (#5617)

This commit adds support for sorting executions by schema target.

Fixes #5615

Author: Corneil du Plessis

spring-cloud-dataflow-aggregate-task/src/main/java/org/springframework/cloud/dataflow/aggregate/task/impl/AggregateDataFlowTaskExecutionQueryDao.java

@@ -180,6 +180,7 @@ public class AggregateDataFlowTaskExecutionQueryDao implements DataflowTaskExecu
 		validSortColumns.add("LAST_UPDATED");
 		validSortColumns.add("EXTERNAL_EXECUTION_ID");
 		validSortColumns.add("PARENT_EXECUTION_ID");
+		validSortColumns.add("SCHEMA_TARGET");
 	}
 
 	private final NamedParameterJdbcTemplate jdbcTemplate;

spring-cloud-dataflow-server-core/src/main/java/org/springframework/cloud/dataflow/server/controller/TaskExecutionController.java

@@ -127,7 +127,7 @@ public class TaskExecutionController {
 
 	private static final List<String> allowedSorts = Arrays.asList("TASK_EXECUTION_ID", "START_TIME", "END_TIME",
 			"TASK_NAME", "EXIT_CODE", "EXIT_MESSAGE", "ERROR_MESSAGE", "LAST_UPDATED", "EXTERNAL_EXECUTION_ID",
-			"PARENT_EXECUTION_ID");
+			"PARENT_EXECUTION_ID", "SCHEMA_TARGET");
 
 	/**
 	 * Creates a {@code TaskExecutionController} that retrieves Task Execution information

spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/controller/TaskExecutionControllerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 the original author or authors.
+ * Copyright 2016-2023 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.
@@ -107,6 +107,7 @@
  * @author David Turanski
  * @author Gunnar Hillert
  * @author Chris Bono
+ * @author Corneil du Plessis
  */
 @SpringBootTest(
 		classes = { JobDependencies.class, TaskExecutionAutoConfiguration.class, DataflowAsyncAutoConfiguration.class,
@@ -637,6 +638,13 @@ void sorting() throws Exception {
 				.andDo(print())
 				.andExpect(status().isOk());
 
+		mockMvc.perform(get("/tasks/executions").param("sort", "SCHEMA_TARGET").accept(MediaType.APPLICATION_JSON))
+			.andDo(print())
+			.andExpect(status().isOk());
+		mockMvc.perform(get("/tasks/executions").param("sort", "schema_target").accept(MediaType.APPLICATION_JSON))
+			.andDo(print())
+			.andExpect(status().isOk());
+
 		mockMvc.perform(get("/tasks/executions").param("sort", "WRONG_FIELD").accept(MediaType.APPLICATION_JSON))
 				.andDo(print())
 				.andExpect(status().is5xxServerError())

spring-cloud-dataflow-server-core/src/test/java/org/springframework/cloud/dataflow/server/repository/TaskExecutionExplorerTests.java

@@ -16,12 +16,14 @@
 
 package org.springframework.cloud.dataflow.server.repository;
 
+import java.net.URI;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 import javax.sql.DataSource;
 
@@ -33,21 +35,30 @@
 import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
 import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase.Replace;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.cloud.dataflow.aggregate.task.TaskDefinitionReader;
-import org.springframework.cloud.dataflow.schema.AggregateTaskExecution;
 import org.springframework.cloud.dataflow.aggregate.task.AggregateExecutionSupport;
 import org.springframework.cloud.dataflow.aggregate.task.AggregateTaskExplorer;
+import org.springframework.cloud.dataflow.aggregate.task.TaskDefinitionReader;
+import org.springframework.cloud.dataflow.core.AppRegistration;
+import org.springframework.cloud.dataflow.core.ApplicationType;
+import org.springframework.cloud.dataflow.core.TaskDefinition;
+import org.springframework.cloud.dataflow.registry.service.AppRegistryService;
+import org.springframework.cloud.dataflow.schema.AggregateTaskExecution;
+import org.springframework.cloud.dataflow.schema.AppBootSchemaVersion;
 import org.springframework.cloud.dataflow.schema.SchemaVersionTarget;
 import org.springframework.cloud.dataflow.schema.service.SchemaService;
 import org.springframework.cloud.dataflow.server.configuration.TaskServiceDependencies;
 import org.springframework.cloud.dataflow.server.repository.support.SchemaUtilities;
 import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Sort;
 import org.springframework.jdbc.core.JdbcTemplate;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.annotation.DirtiesContext.ClassMode;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.when;
 
 /**
  * @author Glenn Renfro
@@ -77,28 +88,38 @@ public class TaskExecutionExplorerTests {
 	@Autowired
 	private TaskDefinitionReader taskDefinitionReader;
 
+	@Autowired
+	private AppRegistryService appRegistryService;
+
+	@Autowired
+	private TaskDefinitionRepository definitionRepository;
+
 	@BeforeEach
 	public void setup() throws Exception {
 		template = new JdbcTemplate(dataSource);
 		for (SchemaVersionTarget target : schemaService.getTargets().getSchemas()) {
 			String prefix = target.getTaskPrefix();
 			template.execute(SchemaUtilities.getQuery("DELETE FROM %PREFIX%EXECUTION", prefix));
 		}
+		TaskDefinition taskDefinition = new TaskDefinition("baz", "baz");
+		definitionRepository.save(taskDefinition);
 	}
 
 	@Test
 	public void testInitializer() {
 		for (SchemaVersionTarget target : schemaService.getTargets().getSchemas()) {
 			String prefix = target.getTaskPrefix();
-			int actual = template.queryForObject(SchemaUtilities.getQuery("SELECT COUNT(*) from %PREFIX%EXECUTION", prefix), Integer.class);
+			int actual = template.queryForObject(
+					SchemaUtilities.getQuery("SELECT COUNT(*) from %PREFIX%EXECUTION", prefix), Integer.class);
 			assertThat(actual).isEqualTo(0);
-			actual = template.queryForObject(SchemaUtilities.getQuery("SELECT COUNT(*) from %PREFIX%EXECUTION_PARAMS", prefix), Integer.class);
+			actual = template.queryForObject(
+					SchemaUtilities.getQuery("SELECT COUNT(*) from %PREFIX%EXECUTION_PARAMS", prefix), Integer.class);
 			assertThat(actual).isEqualTo(0);
 		}
 	}
 
 	@Test
-	public void testExplorerFindAll(){
+	public void testExplorerFindAll() {
 		final int ENTRY_COUNT = 4;
 		insertTestExecutionDataIntoRepo(template, 3L, "foo");
 		insertTestExecutionDataIntoRepo(template, 2L, "foo");
@@ -135,6 +156,20 @@ public void testExplorerFindByName() throws Exception {
 		assertThat(taskExecution.getTaskName()).isEqualTo("fee");
 	}
 
+	@Test
+	public void testExplorerSort() throws Exception {
+		when(appRegistryService.find(eq("baz"), any(ApplicationType.class))).thenReturn(new AppRegistration("baz", ApplicationType.task, "1.0.0", new URI("file://src/test/resources/register-all.txt"),null, AppBootSchemaVersion.BOOT3));
+		insertTestExecutionDataIntoRepo(template, 3L, "foo");
+		insertTestExecutionDataIntoRepo(template, 2L, "bar");
+		insertTestExecutionDataIntoRepo(template, 1L, "baz");
+		insertTestExecutionDataIntoRepo(template, 0L, "fee");
+
+		List<AggregateTaskExecution> resultList = explorer.findAll(PageRequest.of(0, 10, Sort.by("SCHEMA_TARGET"))).getContent();
+		assertThat(resultList.size()).isEqualTo(4);
+		List<Long> ids = resultList.stream().map(AggregateTaskExecution::getExecutionId).collect(Collectors.toList());
+		assertThat(ids).containsExactly(0L, 2L, 3L, 1L);
+	}
+
 	private void insertTestExecutionDataIntoRepo(JdbcTemplate template, long id, String taskName) {
 		SchemaVersionTarget schemaVersionTarget = aggregateExecutionSupport.findSchemaVersionTarget(taskName, taskDefinitionReader);
 		final String INSERT_STATEMENT = SchemaUtilities.getQuery("INSERT INTO %PREFIX%EXECUTION (task_execution_id, "