SCT-7 Add TaskExplorer implementation
* Supports SimpleTaskExplorer that accepts a TaskExecutionDao. * Updated Dao's to support the explorer query requirements * Added tests. This resolves spring-cloud/spring-cloud-task#7
This commit is contained in:
committed by
Michael Minella
parent
5c3795e7c7
commit
b62cb184c0
@@ -34,7 +34,7 @@ public class NoOpTaskExplorerTests {
|
||||
|
||||
@Test
|
||||
public void testGetTaskExecution() throws Exception {
|
||||
assertNull(taskExplorer.getTaskExecution(3l));
|
||||
assertNull(taskExplorer.getTaskExecution("abc"));
|
||||
}
|
||||
|
||||
@Test
|
||||
|
||||
@@ -0,0 +1,247 @@
|
||||
/*
|
||||
* Copyright 2015 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.
|
||||
* 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.
|
||||
*/
|
||||
|
||||
package org.springframework.cloud.task.repository.support;
|
||||
|
||||
import static junit.framework.Assert.assertNotNull;
|
||||
import static junit.framework.Assert.assertTrue;
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNull;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collection;
|
||||
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.UUID;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.junit.After;
|
||||
import org.junit.Before;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.ExpectedException;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.junit.runners.Parameterized;
|
||||
import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
|
||||
import org.springframework.cloud.task.annotation.EnableTask;
|
||||
import org.springframework.cloud.task.repository.TaskExecution;
|
||||
import org.springframework.cloud.task.repository.TaskExplorer;
|
||||
import org.springframework.cloud.task.repository.dao.JdbcTaskExecutionDao;
|
||||
import org.springframework.cloud.task.repository.dao.MapTaskExecutionDao;
|
||||
import org.springframework.cloud.task.repository.dao.TaskExecutionDao;
|
||||
import org.springframework.cloud.task.util.TestVerifierUtils;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
|
||||
/**
|
||||
* @author Glenn Renfro
|
||||
*/
|
||||
@RunWith(Parameterized.class)
|
||||
public class SimpleTaskExplorerTests {
|
||||
|
||||
private AnnotationConfigApplicationContext context;
|
||||
|
||||
private DataSource dataSource;
|
||||
|
||||
private TaskExecutionDao dao;
|
||||
|
||||
private TaskExplorer taskExplorer;
|
||||
|
||||
private DaoType testType;
|
||||
|
||||
@Parameterized.Parameters
|
||||
public static Collection<Object> data() {
|
||||
return Arrays.asList(new Object[] {
|
||||
DaoType.jdbc , DaoType.map });
|
||||
}
|
||||
|
||||
public SimpleTaskExplorerTests(DaoType testType) {
|
||||
this.testType = testType;
|
||||
}
|
||||
@Rule
|
||||
public ExpectedException expected = ExpectedException.none();
|
||||
|
||||
@Before
|
||||
public void testDefaultContext() throws Exception {
|
||||
|
||||
if(testType == DaoType.jdbc){
|
||||
initializeJdbcExplorerTest();
|
||||
}else{
|
||||
initializeMapExplorerTest();
|
||||
}
|
||||
taskExplorer = new SimpleTaskExplorer(dao);
|
||||
}
|
||||
|
||||
@After
|
||||
public void close() {
|
||||
if (this.context != null) {
|
||||
this.context.close();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTaskExecution() {
|
||||
final int TEST_COUNT = 5;
|
||||
Map<String, TaskExecution> expectedResults = new HashMap<>();
|
||||
for (int i = 0; i < TEST_COUNT; i++) {
|
||||
TaskExecution expectedTaskExecution = createAndSaveTaskExecution();
|
||||
expectedResults.put(expectedTaskExecution.getExecutionId(),
|
||||
expectedTaskExecution);
|
||||
}
|
||||
for (String taskExecutionId : expectedResults.keySet()) {
|
||||
TaskExecution actualTaskExecution =
|
||||
taskExplorer.getTaskExecution(taskExecutionId);
|
||||
assertNotNull(String.format(
|
||||
"expected a taskExecution but got null for test type %s", testType),
|
||||
actualTaskExecution);
|
||||
TestVerifierUtils.verifyTaskExecution(expectedResults.get(taskExecutionId),
|
||||
actualTaskExecution);
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTaskCountByTaskName() {
|
||||
final int TEST_COUNT = 5;
|
||||
Map<String, TaskExecution> expectedResults = new HashMap<>();
|
||||
for (int i = 0; i < TEST_COUNT; i++) {
|
||||
TaskExecution expectedTaskExecution = createAndSaveTaskExecution();
|
||||
expectedResults.put(expectedTaskExecution.getExecutionId(),
|
||||
expectedTaskExecution);
|
||||
}
|
||||
for (Map.Entry<String, TaskExecution> entry : expectedResults.entrySet()) {
|
||||
String taskName = entry.getValue().getTaskName();
|
||||
assertEquals(String.format(
|
||||
"task count for task name did not match expected result for testType %s",
|
||||
testType),
|
||||
1, taskExplorer.getTaskExecutionCount(taskName));
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void findRunningTasks() {
|
||||
final int TEST_COUNT = 2;
|
||||
final int COMPLETE_COUNT = 5;
|
||||
final String TASK_NAME = "FOOBAR";
|
||||
|
||||
Map<String, TaskExecution> expectedResults = new HashMap<>();
|
||||
//Store completed jobs
|
||||
for (int i = 0; i < COMPLETE_COUNT; i++) {
|
||||
createAndSaveTaskExecution();
|
||||
}
|
||||
|
||||
for (int i = 0; i < TEST_COUNT; i++) {
|
||||
TaskExecution expectedTaskExecution = new TaskExecution();
|
||||
expectedTaskExecution.setStartTime(new Date());
|
||||
expectedTaskExecution.setExecutionId(UUID.randomUUID().toString());
|
||||
expectedTaskExecution.setTaskName(TASK_NAME);
|
||||
dao.saveTaskExecution(expectedTaskExecution);
|
||||
expectedResults.put(expectedTaskExecution.getExecutionId(), expectedTaskExecution);
|
||||
}
|
||||
Set<TaskExecution> actualResults = taskExplorer.findRunningTaskExecutions(TASK_NAME);
|
||||
assertEquals(String.format(
|
||||
"Running task count for task name did not match expected result for testType %s",
|
||||
testType), TEST_COUNT, actualResults.size());
|
||||
|
||||
for (TaskExecution result : actualResults) {
|
||||
assertTrue(String.format(
|
||||
"result returned from repo %s not expected for testType %s",
|
||||
result.getExecutionId(), testType),
|
||||
expectedResults.containsKey(result.getExecutionId()));
|
||||
assertNull(String.format("result had non null for endTime for the testType %s",
|
||||
testType), result.getEndTime());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void findTasksByName() {
|
||||
final int TEST_COUNT = 5;
|
||||
final int COMPLETE_COUNT = 7;
|
||||
final int RESULT_SET_SIZE = 3;
|
||||
final String TASK_NAME = "FOOBAR";
|
||||
|
||||
Map<String, TaskExecution> expectedResults = new HashMap<>();
|
||||
//Store completed jobs
|
||||
for (int i = 0; i < COMPLETE_COUNT; i++) {
|
||||
createAndSaveTaskExecution();
|
||||
}
|
||||
|
||||
for (int i = 0; i < TEST_COUNT; i++) {
|
||||
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoParam();
|
||||
expectedTaskExecution.setTaskName(TASK_NAME);
|
||||
dao.saveTaskExecution(expectedTaskExecution);
|
||||
expectedResults.put(expectedTaskExecution.getExecutionId(), expectedTaskExecution);
|
||||
}
|
||||
List<TaskExecution> resultSet = taskExplorer.getTaskExecutionsByName(TASK_NAME, 1, RESULT_SET_SIZE);
|
||||
assertEquals(String.format(
|
||||
"Running task count for task name did not match expected result for testType %s",
|
||||
testType), RESULT_SET_SIZE, resultSet.size());
|
||||
|
||||
for (TaskExecution result : resultSet) {
|
||||
assertTrue(String.format("result returned from %s repo %s not expected",
|
||||
testType, result.getExecutionId()),
|
||||
expectedResults.containsKey(result.getExecutionId()));
|
||||
assertEquals(
|
||||
String.format("taskName for taskExecution is incorrect for testType %s",
|
||||
testType), TASK_NAME, result.getTaskName());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getTaskNames() {
|
||||
final int TEST_COUNT = 5;
|
||||
Set<String> expectedResults = new HashSet<>();
|
||||
for (int i = 0; i < TEST_COUNT; i++) {
|
||||
TaskExecution expectedTaskExecution = createAndSaveTaskExecution();
|
||||
expectedResults.add(expectedTaskExecution.getTaskName());
|
||||
}
|
||||
List<String> actualTaskNames = taskExplorer.getTaskNames();
|
||||
for (String taskName : actualTaskNames) {
|
||||
assertTrue(String.format("taskName was not in expected results for testType %s",
|
||||
testType), expectedResults.contains(taskName));
|
||||
}
|
||||
}
|
||||
|
||||
private TaskExecution createAndSaveTaskExecution() {
|
||||
TaskExecution taskExecution = TestVerifierUtils.createSampleTaskExecution();
|
||||
dao.saveTaskExecution(taskExecution);
|
||||
return taskExecution;
|
||||
}
|
||||
|
||||
@EnableTask
|
||||
protected static class TestConfiguration {
|
||||
}
|
||||
|
||||
private void initializeJdbcExplorerTest(){
|
||||
this.context = new AnnotationConfigApplicationContext();
|
||||
this.context.register(TestConfiguration.class,
|
||||
EmbeddedDataSourceConfiguration.class,
|
||||
PropertyPlaceholderAutoConfiguration.class);
|
||||
this.context.refresh();
|
||||
dataSource = this.context.getBean(DataSource.class);
|
||||
dao = new JdbcTaskExecutionDao(dataSource);
|
||||
}
|
||||
|
||||
private void initializeMapExplorerTest(){
|
||||
dao = new MapTaskExecutionDao();
|
||||
}
|
||||
|
||||
private enum DaoType{jdbc, map}
|
||||
}
|
||||
@@ -67,10 +67,9 @@ public class TaskDatabaseInitializerTests {
|
||||
.queryForList("select * from TASK_EXECUTION").size());
|
||||
}
|
||||
|
||||
// @Test
|
||||
@Test
|
||||
public void testNoDatabase() throws Exception {
|
||||
SimpleTaskRepository repository = new SimpleTaskRepository(new MapTaskExecutionDao());
|
||||
this.context.refresh();
|
||||
assertThat(repository.getTaskExecutionDao(), instanceOf(MapTaskExecutionDao.class));
|
||||
MapTaskExecutionDao dao = (MapTaskExecutionDao) repository.getTaskExecutionDao();
|
||||
assertEquals(0, dao.getTaskExecutions().size());
|
||||
|
||||
@@ -28,6 +28,7 @@ import static org.mockito.Mockito.when;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Date;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Random;
|
||||
import java.util.Set;
|
||||
import java.util.UUID;
|
||||
@@ -45,6 +46,8 @@ import org.springframework.cloud.task.repository.TaskExecution;
|
||||
*/
|
||||
public class TestVerifierUtils {
|
||||
|
||||
public static final int PARAM_SIZE = 5;
|
||||
|
||||
/**
|
||||
* Creates a mock {@link Appender} to be added to the root logger.
|
||||
*
|
||||
@@ -94,6 +97,29 @@ public class TestVerifierUtils {
|
||||
exitMessage, new ArrayList<String>());
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a fully populated TaskExecution for testing.
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public static TaskExecution createSampleTaskExecution() {
|
||||
Random randomGenerator = new Random();
|
||||
int exitCode = randomGenerator.nextInt();
|
||||
Date startTime = new Date();
|
||||
Date endTime = new Date();
|
||||
String executionId = UUID.randomUUID().toString();
|
||||
String taskName = UUID.randomUUID().toString();
|
||||
String exitMessage = UUID.randomUUID().toString();
|
||||
String statusCode = UUID.randomUUID().toString().substring(0, 9);
|
||||
List<String> params = new ArrayList<>(PARAM_SIZE);
|
||||
for (int i = 0 ; i < PARAM_SIZE ; i++){
|
||||
params.add(UUID.randomUUID().toString());
|
||||
}
|
||||
return new TaskExecution(executionId, exitCode, taskName,
|
||||
startTime, endTime, statusCode,
|
||||
exitMessage, params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies that all the fields in between the expected and actual are the same;
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user