SpringCloud/spring-cloud-task
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Refactored the use of the name parameters to be arguments

Browse Source 
This PR refactors the use of the term parameters to arguments to be
consistent with how the component is utilized within Spring Cloud Data
Flow.
This commit is contained in:
Michael Minella
2016-06-08 13:04:58 -05:00
parent 7f53c7d9f7
commit 77fdfbdbc0
19 changed files with 101 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/listener/TaskLifecycleListener.java
View File

@@ -231,7 +231,7 @@ public class TaskLifecycleListener implements ApplicationListener<ApplicationEve
return new TaskExecution(taskExecution.getExecutionId(),
taskExecution.getExitCode(), taskExecution.getTaskName(), startTime,
endTime,taskExecution.getExitMessage(),
Collections.unmodifiableList(taskExecution.getParameters()));
Collections.unmodifiableList(taskExecution.getArguments()));
}
@Override

24
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/repository/TaskExecution.java
View File

@@ -55,30 +55,30 @@ public class TaskExecution {
private Date endTime;
/**
* Message returned from the task or stacktrace.parameters.
* Message returned from the task or stacktrace.
*/
private String exitMessage;
/**
* The parameters that were used for this task execution.
* The arguments that were used for this task execution.
*/
private List<String> parameters;
private List<String> arguments;
public TaskExecution() {
parameters = new ArrayList<>();
arguments = new ArrayList<>();
}
public TaskExecution(long executionId, Integer exitCode, String taskName,
Date startTime, Date endTime,
String exitMessage, List<String> parameters) {
String exitMessage, List<String> arguments) {
Assert.notNull(parameters, "parameters must not be null");
Assert.notNull(arguments, "arguments must not be null");
Assert.notNull(startTime, "startTime must not be null");
this.executionId = executionId;
this.exitCode = exitCode;
this.taskName = taskName;
this.exitMessage = exitMessage;
this.parameters = new ArrayList<>(parameters);
this.arguments = new ArrayList<>(arguments);
this.startTime = (Date)startTime.clone();
this.endTime = (endTime != null) ? (Date)endTime.clone() : null;
}
@@ -127,12 +127,12 @@ public class TaskExecution {
this.exitMessage = exitMessage;
}
public List<String> getParameters() {
return parameters;
public List<String> getArguments() {
return arguments;
}
public void setParameters(List<String> parameters) {
this.parameters = new ArrayList<> (parameters);
public void setArguments(List<String> arguments) {
this.arguments = new ArrayList<> (arguments);
}
@Override
@@ -144,7 +144,7 @@ public class TaskExecution {
", startTime=" + startTime +
", endTime=" + endTime +
", exitMessage='" + exitMessage + '\'' +
", parameters=" + parameters +
", arguments=" + arguments +
'}';
}
}

4
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/repository/TaskRepository.java
View File

@@ -47,11 +47,11 @@ public interface TaskRepository {
*
* @param taskName the name that associated with the task execution.
* @param startTime the time task began.
* @param parameters list of key/value pairs that configure the task.
* @param arguments list of key/value pairs that configure the task.
* @return the initial {@link TaskExecution}
*/
@Transactional
TaskExecution createTaskExecution(String taskName,
Date startTime,List<String> parameters);
Date startTime,List<String> arguments);
}

36
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/repository/dao/JdbcTaskExecutionDao.java
View File

@@ -71,7 +71,7 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
+ "(TASK_EXECUTION_ID, START_TIME, TASK_NAME, LAST_UPDATED)"
+ "values (?, ?, ?, ?)";
private static final String CREATE_TASK_PARAMETER = "INSERT into "
private static final String CREATE_TASK_ARGUMENT = "INSERT into "
+ "%PREFIX%EXECUTION_PARAMS(TASK_EXECUTION_ID, TASK_PARAM ) values (?, ?)";
private static final String CHECK_TASK_EXECUTION_EXISTS = "SELECT COUNT(*) FROM "
@@ -86,7 +86,7 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
+ "EXIT_MESSAGE, LAST_UPDATED "
+ "from %PREFIX%EXECUTION where TASK_EXECUTION_ID = ?";
private static final String FIND_PARAMS_FROM_ID = "SELECT TASK_EXECUTION_ID, "
private static final String FIND_ARGUMENT_FROM_ID = "SELECT TASK_EXECUTION_ID, "
+ "TASK_PARAM from %PREFIX%EXECUTION_PARAMS where TASK_EXECUTION_ID = ?";
private static final String TASK_EXECUTION_COUNT = "SELECT COUNT(*) FROM " +
@@ -126,17 +126,17 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
@Override
public TaskExecution createTaskExecution(String taskName,
Date startTime, List<String> parameters) {
Date startTime, List<String> arguments) {
long taskExecutionId = getNextExecutionId();
TaskExecution taskExecution = new TaskExecution(taskExecutionId, null, taskName,
startTime, null, null, parameters);
startTime, null, null, arguments);
Object[] queryParameters = new Object[]{ taskExecutionId, startTime, taskName, new Date()};
jdbcTemplate.update(
getQuery(SAVE_TASK_EXECUTION),
queryParameters,
new int[]{ Types.BIGINT, Types.TIMESTAMP, Types.VARCHAR, Types.TIMESTAMP });
insertTaskParameters(taskExecutionId, parameters);
insertTaskArguments(taskExecutionId, arguments);
return taskExecution;
}
@@ -175,7 +175,7 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
try {
TaskExecution taskExecution = jdbcTemplate.queryForObject(getQuery(GET_EXECUTION_BY_ID),
new TaskExecutionRowMapper(), executionId);
taskExecution.setParameters(getTaskParameters(executionId));
taskExecution.setArguments(getTaskArguments(executionId));
return taskExecution;
}
catch (EmptyResultDataAccessException e) {
@@ -321,15 +321,15 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
}
/**
* Convenience method that inserts all parameters from the provided
* task parameters.
* Convenience method that inserts all arguments from the provided
* task arguments.
*
* @param executionId The executionId to which the params are associated.
* @param taskParameters The parameters to be stored.
* @param executionId The executionId to which the arguments are associated.
* @param taskArguments The arguments to be stored.
*/
private void insertTaskParameters(long executionId, List<String> taskParameters) {
for (String param : taskParameters) {
insertParameter(executionId, param);
private void insertTaskArguments(long executionId, List<String> taskArguments) {
for (String args : taskArguments) {
insertArgument(executionId, args);
}
}
@@ -337,13 +337,13 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
* Convenience method that inserts an individual records into the
* TASK_EXECUTION_PARAMS table.
*/
private void insertParameter(long executionId, String param) {
private void insertArgument(long executionId, String param) {
int[] argTypes = new int[]{ Types.BIGINT, Types.VARCHAR };
Object[] args = new Object[]{ executionId, param };
jdbcTemplate.update(getQuery(CREATE_TASK_PARAMETER), args, argTypes);
jdbcTemplate.update(getQuery(CREATE_TASK_ARGUMENT), args, argTypes);
}
private List<String> getTaskParameters(long executionId){
private List<String> getTaskArguments(long executionId){
final List<String> params= new ArrayList<>();
RowCallbackHandler handler = new RowCallbackHandler() {
@Override
@@ -352,7 +352,7 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
}
};
jdbcTemplate.query(getQuery(FIND_PARAMS_FROM_ID), new Object[] { executionId },
jdbcTemplate.query(getQuery(FIND_ARGUMENT_FROM_ID), new Object[] { executionId },
handler);
return params;
}
@@ -374,7 +374,7 @@ public class JdbcTaskExecutionDao implements TaskExecutionDao {
rs.getTimestamp("START_TIME"),
rs.getTimestamp("END_TIME"),
rs.getString("EXIT_MESSAGE"),
getTaskParameters(id));
getTaskArguments(id));
}
private Integer getNullableExitCode(ResultSet rs) throws SQLException {

4
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/repository/dao/MapTaskExecutionDao.java
View File

@@ -53,10 +53,10 @@ public class MapTaskExecutionDao implements TaskExecutionDao {
@Override
public TaskExecution createTaskExecution(String taskName,
Date startTime, List<String> parameters) {
Date startTime, List<String> arguments) {
long taskExecutionId = getNextExecutionId();
TaskExecution taskExecution = new TaskExecution(taskExecutionId, null, taskName,
startTime, null, null, parameters);
startTime, null, null, arguments);
taskExecutions.put(taskExecutionId, taskExecution);
return taskExecution;
}

4
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/repository/dao/TaskExecutionDao.java
View File

@@ -36,11 +36,11 @@ public interface TaskExecutionDao {
*
* @param taskName the name that associated with the task execution.
* @param startTime the time task began.
* @param parameters list of key/value pairs that configure the task.
* @param arguments list of key/value pairs that configure the task.
* @return A fully qualified {@link TaskExecution} instance.
*/
TaskExecution createTaskExecution( String taskName,
Date startTime, List<String> parameters);
Date startTime, List<String> arguments);
/**
* Update and existing {@link TaskExecution}.

4
spring-cloud-task-core/src/main/java/org/springframework/cloud/task/repository/support/SimpleTaskRepository.java
View File

@@ -71,11 +71,11 @@ public class SimpleTaskRepository implements TaskRepository {
@Override
public TaskExecution createTaskExecution(String taskName,
Date startTime,List<String> parameters) {
Date startTime,List<String> arguments) {
initialize();
validateCreateInformation(startTime, taskName);
TaskExecution taskExecution =
taskExecutionDao.createTaskExecution(taskName, startTime, parameters);
taskExecutionDao.createTaskExecution(taskName, startTime, arguments);
logger.debug("Creating: " + taskExecution.toString());
return taskExecution;
}

2
spring-cloud-task-core/src/test/java/org/springframework/cloud/task/listener/TaskLifecycleListenerTests.java
View File

@@ -135,7 +135,7 @@ public class TaskLifecycleListenerTests {
assertTrue(taskExecutionsByName.iterator().hasNext());
TaskExecution taskExecution = taskExecutionsByName.iterator().next();
assertEquals(numberOfParams, taskExecution.getParameters().size());
assertEquals(numberOfParams, taskExecution.getArguments().size());
assertEquals(exitCode, taskExecution.getExitCode());
if(exception != null) {

10
spring-cloud-task-core/src/test/java/org/springframework/cloud/task/repository/dao/JdbcTaskExecutionDaoTests.java
View File

@@ -57,9 +57,9 @@ public class JdbcTaskExecutionDaoTests {
@Test
@DirtiesContext
public void saveTaskExecution() {
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoParam();
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoArg();
expectedTaskExecution = dao.createTaskExecution(expectedTaskExecution.getTaskName(), expectedTaskExecution.getStartTime(),
expectedTaskExecution.getParameters());
expectedTaskExecution.getArguments());
TestVerifierUtils.verifyTaskExecution(expectedTaskExecution,
TestDBUtils.getTaskExecutionFromDB(dataSource, expectedTaskExecution.getExecutionId()));
@@ -68,9 +68,9 @@ public class JdbcTaskExecutionDaoTests {
@Test
@DirtiesContext
public void completeTaskExecution() {
TaskExecution expectedTaskExecution = TestVerifierUtils.endSampleTaskExecutionNoParam();
TaskExecution expectedTaskExecution = TestVerifierUtils.endSampleTaskExecutionNoArg();
expectedTaskExecution = dao.createTaskExecution(expectedTaskExecution.getTaskName(),
expectedTaskExecution.getStartTime(), expectedTaskExecution.getParameters());
expectedTaskExecution.getStartTime(), expectedTaskExecution.getArguments());
dao.completeTaskExecution(expectedTaskExecution.getExecutionId(),
expectedTaskExecution.getExitCode(), expectedTaskExecution.getEndTime(),
expectedTaskExecution.getExitMessage());
@@ -83,7 +83,7 @@ public class JdbcTaskExecutionDaoTests {
public void completeTaskExecutionWithNoCreate() {
JdbcTaskExecutionDao dao = new JdbcTaskExecutionDao(dataSource);
TaskExecution expectedTaskExecution = TestVerifierUtils.endSampleTaskExecutionNoParam();
TaskExecution expectedTaskExecution = TestVerifierUtils.endSampleTaskExecutionNoArg();
dao.completeTaskExecution(expectedTaskExecution.getExecutionId(),
expectedTaskExecution.getExitCode(), expectedTaskExecution.getEndTime(),
expectedTaskExecution.getExitMessage());

8
spring-cloud-task-core/src/test/java/org/springframework/cloud/task/repository/dao/MapTaskExecutionDaoTests.java
View File

@@ -34,9 +34,9 @@ public class MapTaskExecutionDaoTests {
@Test
public void saveTaskExecution(){
MapTaskExecutionDao dao = new MapTaskExecutionDao();
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoParam();
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoArg();
expectedTaskExecution = dao.createTaskExecution(expectedTaskExecution.getTaskName(),
expectedTaskExecution.getStartTime(), expectedTaskExecution.getParameters());
expectedTaskExecution.getStartTime(), expectedTaskExecution.getArguments());
Map<Long, TaskExecution> taskExecutionMap = dao.getTaskExecutions();
assertNotNull("taskExecutionMap must not be null", taskExecutionMap);
TestVerifierUtils.verifyTaskExecution(expectedTaskExecution,
@@ -46,9 +46,9 @@ public class MapTaskExecutionDaoTests {
@Test
public void completeTaskExecution(){
MapTaskExecutionDao dao = new MapTaskExecutionDao();
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoParam();
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoArg();
expectedTaskExecution = dao.createTaskExecution(expectedTaskExecution.getTaskName(),
expectedTaskExecution.getStartTime(), expectedTaskExecution.getParameters());
expectedTaskExecution.getStartTime(), expectedTaskExecution.getArguments());
dao.completeTaskExecution(expectedTaskExecution.getExecutionId(),
expectedTaskExecution.getExitCode(), expectedTaskExecution.getEndTime(),
expectedTaskExecution.getExitMessage());

2
spring-cloud-task-core/src/test/java/org/springframework/cloud/task/repository/support/SimpleTaskExplorerTests.java
View File

@@ -308,7 +308,7 @@ public class SimpleTaskExplorerTests {
private TaskExecution createAndSaveTaskExecution(int i) {
TaskExecution taskExecution = TestVerifierUtils.createSampleTaskExecution(i);
taskExecution = this.taskRepository.createTaskExecution(taskExecution.getTaskName(),
taskExecution.getStartTime(), taskExecution.getParameters());
taskExecution.getStartTime(), taskExecution.getArguments());
return taskExecution;
}

10
spring-cloud-task-core/src/test/java/org/springframework/cloud/task/util/TaskExecutionCreator.java
View File

@@ -37,9 +37,9 @@ public class TaskExecutionCreator {
* @return the taskExecution created.
*/
public static TaskExecution createAndStoreTaskExecutionNoParams(TaskRepository taskRepository) {
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoParam();
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoArg();
expectedTaskExecution = taskRepository.createTaskExecution(expectedTaskExecution.getTaskName(),
expectedTaskExecution.getStartTime(), expectedTaskExecution.getParameters());
expectedTaskExecution.getStartTime(), expectedTaskExecution.getArguments());
return expectedTaskExecution;
}
@@ -50,13 +50,13 @@ public class TaskExecutionCreator {
* @return the taskExecution created.
*/
public static TaskExecution createAndStoreTaskExecutionWithParams(TaskRepository taskRepository) {
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoParam();
TaskExecution expectedTaskExecution = TestVerifierUtils.createSampleTaskExecutionNoArg();
List<String> params = new ArrayList<String>();
params.add(UUID.randomUUID().toString());
params.add(UUID.randomUUID().toString());
expectedTaskExecution.setParameters(params);
expectedTaskExecution.setArguments(params);
expectedTaskExecution = taskRepository.createTaskExecution(expectedTaskExecution.getTaskName(),
expectedTaskExecution.getStartTime(), expectedTaskExecution.getParameters());
expectedTaskExecution.getStartTime(), expectedTaskExecution.getArguments());
return expectedTaskExecution;
}

15
spring-cloud-task-core/src/test/java/org/springframework/cloud/task/util/TestDBUtils.java
View File

@@ -16,10 +16,6 @@
package org.springframework.cloud.task.util;
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
@@ -28,7 +24,6 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import javax.sql.DataSource;
import org.springframework.batch.item.database.Order;
@@ -44,6 +39,10 @@ import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.support.MetaDataAccessException;
import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer;
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
/**
* Provides a suite of tools that allow tests the ability to retrieve results from a
* relational database.
@@ -168,10 +167,10 @@ public class TestDBUtils {
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
List<Map<String, Object>> rows = jdbcTemplate.queryForList(sql);
List<String> params = new ArrayList<>();
List<String> arguments = new ArrayList<>();
for (Map row : rows) {
params.add((String) row.get("TASK_PARAM"));
arguments.add((String) row.get("TASK_PARAM"));
}
taskExecution.setParameters(params);
taskExecution.setArguments(arguments);
}
}

42
spring-cloud-task-core/src/test/java/org/springframework/cloud/task/util/TestVerifierUtils.java
View File

@@ -47,7 +47,7 @@ import static org.mockito.Mockito.when;
*/
public class TestVerifierUtils {
public static final int PARAM_SIZE = 5;
public static final int ARG_SIZE = 5;
/**
* Creates a mock {@link Appender} to be added to the root logger.
@@ -79,11 +79,11 @@ public class TestVerifierUtils {
}
/**
* Creates a fully populated TaskExecution (except params) for testing.
* Creates a fully populated TaskExecution (except args) for testing.
*
* @return
*/
public static TaskExecution createSampleTaskExecutionNoParam() {
public static TaskExecution createSampleTaskExecutionNoArg() {
Random randomGenerator = new Random();
Date startTime = new Date();
long executionId = randomGenerator.nextLong();
@@ -94,11 +94,11 @@ public class TestVerifierUtils {
}
/**
* Creates a fully populated TaskExecution (except params) for testing.
* Creates a fully populated TaskExecution (except args) for testing.
*
* @return
*/
public static TaskExecution endSampleTaskExecutionNoParam() {
public static TaskExecution endSampleTaskExecutionNoArg() {
Random randomGenerator = new Random();
int exitCode = randomGenerator.nextInt();
Date startTime = new Date();
@@ -120,12 +120,12 @@ public class TestVerifierUtils {
Random randomGenerator = new Random();
Date startTime = new Date();
String taskName = UUID.randomUUID().toString();
List<String> params = new ArrayList<>(PARAM_SIZE);
for (int i = 0 ; i < PARAM_SIZE ; i++){
params.add(UUID.randomUUID().toString());
List<String> args = new ArrayList<>(ARG_SIZE);
for (int i = 0; i < ARG_SIZE; i++){
args.add(UUID.randomUUID().toString());
}
return new TaskExecution(executionId, null, taskName,
startTime, null, null, params);
startTime, null, null, args);
}
/**
@@ -153,22 +153,22 @@ public class TestVerifierUtils {
assertEquals("exitMessage must be equal",
expectedTaskExecution.getExitMessage(),
actualTaskExecution.getExitMessage());
if (expectedTaskExecution.getParameters() != null) {
assertNotNull("parameters should not be null",
actualTaskExecution.getParameters());
assertEquals("parameters result set count should match expected count",
expectedTaskExecution.getParameters().size(),
actualTaskExecution.getParameters().size());
if (expectedTaskExecution.getArguments() != null) {
assertNotNull("arguments should not be null",
actualTaskExecution.getArguments());
assertEquals("arguments result set count should match expected count",
expectedTaskExecution.getArguments().size(),
actualTaskExecution.getArguments().size());
}
else {
assertNull("parameters should be null", actualTaskExecution.getParameters());
assertNull("arguments should be null", actualTaskExecution.getArguments());
}
Set<String> params = new HashSet<String>();
for (String param : expectedTaskExecution.getParameters()) {
params.add(param);
Set<String> args = new HashSet<String>();
for (String param : expectedTaskExecution.getArguments()) {
args.add(param);
}
for (String param : actualTaskExecution.getParameters()) {
assertTrue("param must exist in the repository", params.contains(param));
for (String arg : actualTaskExecution.getArguments()) {
assertTrue("arg must exist in the repository", args.contains(arg));
}
}