nosu
/
taskana
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

TSK-1986 remove cycle between TaskanaEngineConfiguration und TaskanaEngine (#2078)

This commit is contained in:
Alex 2023-02-06 16:20:23 +01:00 committed by Mustapha Zorgati
parent 72cc0882c7
commit 53f9dce1db
23 changed files with 112 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
history/taskana-simplehistory-provider/src/test/java/acceptance/AbstractAccTest.java
View File

@ -100,11 +100,11 @@ public abstract class AbstractAccTest {
taskanaEngineConfiguration = new TaskanaEngineConfiguration(dataSource, false, schemaNameTmp);
taskanaEngine =
taskanaEngineConfiguration.buildTaskanaEngine(ConnectionManagementMode.AUTOCOMMIT);
TaskanaEngine.buildTaskanaEngine(
taskanaEngineConfiguration, ConnectionManagementMode.AUTOCOMMIT);
taskanaHistoryEngine = TaskanaHistoryEngineImpl.createTaskanaEngine(taskanaEngine);
historyService = new SimpleHistoryServiceImpl();
historyService.initialize(
taskanaEngineConfiguration.buildTaskanaEngine(ConnectionManagementMode.AUTOCOMMIT));
historyService.initialize(taskanaEngine);
SampleDataGenerator sampleDataGenerator =
new SampleDataGenerator(dataSource, taskanaEngineConfiguration.getSchemaName());

2
history/taskana-simplehistory-provider/src/test/java/configuration/TaskanaEngineConfigurationTest.java
View File

@ -19,7 +19,7 @@ class TaskanaEngineConfigurationTest extends AbstractAccTest {
TaskanaEngineConfiguration taskEngineConfiguration =
new TaskanaEngineConfiguration(ds, false, false, DataSourceGenerator.getSchemaName());
TaskanaEngine te = taskEngineConfiguration.buildTaskanaEngine();
TaskanaEngine te = TaskanaEngine.buildTaskanaEngine(taskEngineConfiguration);
assertThat(te).isNotNull();
}

17
history/taskana-simplehistory-provider/src/test/java/pro/taskana/simplehistory/impl/SimpleHistoryServiceImplTest.java
View File

@ -2,13 +2,11 @@ package pro.taskana.simplehistory.impl;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import acceptance.AbstractAccTest;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import org.apache.ibatis.session.SqlSession;
@ -54,21 +52,6 @@ class SimpleHistoryServiceImplTest {
@Mock private SqlSession sqlSessionMock;
@Test
void testInitializeSimpleHistoryService() throws SQLException {
when(sqlSessionManagerMock.getMapper(TaskHistoryEventMapper.class))
.thenReturn(taskHistoryEventMapperMock);
when(sqlSessionManagerMock.getMapper(WorkbasketHistoryEventMapper.class))
.thenReturn(workbasketHistoryEventMapperMock);
when(taskanaHistoryEngineMock.getSqlSession()).thenReturn(sqlSessionManagerMock);
doReturn(taskanaHistoryEngineMock).when(cutSpy).getTaskanaEngine(taskanaEngine);
doReturn(taskanaEngine).when(taskanaEngineConfiguration).buildTaskanaEngine();
cutSpy.initialize(taskanaEngineConfiguration.buildTaskanaEngine());
verify(sqlSessionManagerMock, times(4)).getMapper(any());
verify(taskanaHistoryEngineMock, times(4)).getSqlSession();
}
@Test
void should_VerifyMethodInvocations_When_CreateTaskHistoryEvent() throws Exception {
TaskHistoryEvent expectedWb =

4
history/taskana-simplehistory-rest-spring/src/main/java/pro/taskana/simplehistory/rest/TaskHistoryEventController.java
View File

@ -17,6 +17,7 @@ import org.springframework.web.bind.annotation.RestController;
import pro.taskana.TaskanaEngineConfiguration;
import pro.taskana.common.api.BaseQuery.SortDirection;
import pro.taskana.common.api.TaskanaEngine;
import pro.taskana.common.api.exceptions.InvalidArgumentException;
import pro.taskana.common.rest.QueryPagingParameter;
import pro.taskana.common.rest.QuerySortBy;
@ -47,7 +48,8 @@ public class TaskHistoryEventController {
throws SQLException {
this.simpleHistoryService = simpleHistoryServiceImpl;
this.simpleHistoryService.initialize(taskanaEngineConfiguration.buildTaskanaEngine());
this.simpleHistoryService.initialize(
TaskanaEngine.buildTaskanaEngine(taskanaEngineConfiguration));
this.assembler = assembler;
}

2
lib/taskana-cdi/src/main/java/pro/taskana/common/internal/TaskanaProducers.java
View File

@ -63,7 +63,7 @@ public class TaskanaProducers {
@ApplicationScoped
@Produces
public TaskanaEngine generateTaskEngine() throws SQLException {
return taskanaEngineConfiguration.buildTaskanaEngine();
return TaskanaEngine.buildTaskanaEngine(taskanaEngineConfiguration);
}
@ApplicationScoped

2
lib/taskana-core-test/src/test/java/acceptance/ArchitectureTest.java
View File

@ -213,6 +213,8 @@ class ArchitectureTest {
classes()
.that()
.resideInAPackage("..api..")
.and()
.areNotAssignableFrom(TaskanaEngine.class)
.should()
.onlyDependOnClassesThat(
resideOutsideOfPackage("..pro.taskana..internal..")

18
lib/taskana-core/src/main/java/pro/taskana/TaskanaEngineConfiguration.java
View File

@ -25,11 +25,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import pro.taskana.common.api.CustomHoliday;
import pro.taskana.common.api.TaskanaEngine;
import pro.taskana.common.api.TaskanaEngine.ConnectionManagementMode;
import pro.taskana.common.api.TaskanaRole;
import pro.taskana.common.api.exceptions.SystemException;
import pro.taskana.common.internal.TaskanaEngineImpl;
import pro.taskana.common.internal.configuration.DB;
import pro.taskana.common.internal.configuration.TaskanaProperty;
import pro.taskana.common.internal.util.FileLoaderUtil;
@ -241,21 +238,6 @@ public class TaskanaEngineConfiguration {
return createDatasource(driverClass, jdbcUrl, username, password);
}
/**
* This method creates the TaskanaEngine without an sqlSessionFactory.
*
* @return the TaskanaEngine
* @throws SQLException if a database access error occurs
*/
public TaskanaEngine buildTaskanaEngine() throws SQLException {
return TaskanaEngineImpl.createTaskanaEngine(this);
}
public TaskanaEngine buildTaskanaEngine(ConnectionManagementMode connectionManagementMode)
throws SQLException {
return TaskanaEngineImpl.createTaskanaEngine(this, connectionManagementMode);
}
/**
* This method creates a PooledDataSource, if the needed properties are provided.
*

28
lib/taskana-core/src/main/java/pro/taskana/common/api/TaskanaEngine.java
View File

@ -7,6 +7,7 @@ import pro.taskana.TaskanaEngineConfiguration;
import pro.taskana.classification.api.ClassificationService;
import pro.taskana.common.api.exceptions.NotAuthorizedException;
import pro.taskana.common.api.security.CurrentUserContext;
import pro.taskana.common.internal.TaskanaEngineImpl;
import pro.taskana.monitor.api.MonitorService;
import pro.taskana.task.api.TaskService;
import pro.taskana.task.api.models.Task;
@ -83,6 +84,33 @@ public interface TaskanaEngine {
*/
TaskanaEngineConfiguration getConfiguration();
/**
* This method creates the {@linkplain TaskanaEngine} with {@linkplain
* ConnectionManagementMode#PARTICIPATE }.
*
* @see TaskanaEngine#buildTaskanaEngine(TaskanaEngineConfiguration, ConnectionManagementMode)
*/
@SuppressWarnings("checkstyle:JavadocMethod")
static TaskanaEngine buildTaskanaEngine(TaskanaEngineConfiguration configuration)
throws SQLException {
return buildTaskanaEngine(configuration, ConnectionManagementMode.PARTICIPATE);
}
/**
* Builds an {@linkplain TaskanaEngine} based on {@linkplain TaskanaEngineConfiguration} and
* SqlConnectionMode.
*
* @param configuration complete taskanaEngineConfig to build the engine
* @param connectionManagementMode connectionMode for the SqlSession
* @return a {@linkplain TaskanaEngineImpl}
* @throws SQLException when the db schema could not be initialized
*/
static TaskanaEngine buildTaskanaEngine(
TaskanaEngineConfiguration configuration, ConnectionManagementMode connectionManagementMode)
throws SQLException {
return TaskanaEngineImpl.createTaskanaEngine(configuration, connectionManagementMode);
}
/**
* Returns the {@linkplain WorkingDaysToDaysConverter} of the TaskanaEngine. The {@linkplain
* WorkingDaysToDaysConverter} is used to compute holidays.

5
lib/taskana-core/src/main/java/pro/taskana/common/internal/TaskanaEngineImpl.java
View File

@ -136,11 +136,6 @@ public class TaskanaEngineImpl implements TaskanaEngine {
afterRequestChangesManager = new AfterRequestChangesManager(this);
}
public static TaskanaEngine createTaskanaEngine(
TaskanaEngineConfiguration taskanaEngineConfiguration) throws SQLException {
return createTaskanaEngine(taskanaEngineConfiguration, ConnectionManagementMode.PARTICIPATE);
}
public static TaskanaEngine createTaskanaEngine(
TaskanaEngineConfiguration taskanaEngineConfiguration,
ConnectionManagementMode connectionManagementMode)

3
lib/taskana-core/src/test/java/acceptance/AbstractAccTest.java
View File

@ -60,7 +60,8 @@ public abstract class AbstractAccTest {
sampleDataGenerator.dropDb();
}
taskanaEngine =
taskanaEngineConfiguration.buildTaskanaEngine(ConnectionManagementMode.AUTOCOMMIT);
TaskanaEngine.buildTaskanaEngine(
taskanaEngineConfiguration, ConnectionManagementMode.AUTOCOMMIT);
converter = taskanaEngine.getWorkingDaysToDaysConverter();
taskService = (TaskServiceImpl) taskanaEngine.getTaskService();

2
lib/taskana-core/src/test/java/acceptance/config/TaskanaEngineConfigTest.java
View File

@ -19,7 +19,7 @@ class TaskanaEngineConfigTest {
TaskanaEngineConfiguration taskEngineConfiguration =
new TaskanaEngineConfiguration(ds, false, DataSourceGenerator.getSchemaName());
TaskanaEngine te = taskEngineConfiguration.buildTaskanaEngine();
TaskanaEngine te = TaskanaEngine.buildTaskanaEngine(taskEngineConfiguration);
assertThat(te).isNotNull();
}

7
lib/taskana-core/src/test/java/acceptance/config/TaskanaSecurityConfigAccTest.java
View File

@ -13,6 +13,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import pro.taskana.TaskanaEngineConfiguration;
import pro.taskana.common.api.TaskanaEngine;
import pro.taskana.common.api.exceptions.SystemException;
import pro.taskana.common.internal.configuration.DB;
import pro.taskana.common.internal.configuration.DbSchemaCreator;
@ -75,12 +76,12 @@ class TaskanaSecurityConfigAccTest {
}
private void createTaskanaEngine(boolean securityEnabled) throws SQLException {
new TaskanaEngineConfiguration(
TaskanaEngine.buildTaskanaEngine(
new TaskanaEngineConfiguration(
DataSourceGenerator.getDataSource(),
false,
securityEnabled,
DataSourceGenerator.getSchemaName())
.buildTaskanaEngine();
DataSourceGenerator.getSchemaName()));
}
private Boolean retrieveSecurityFlag() throws Exception {

3
lib/taskana-core/src/test/java/acceptance/jobs/JobRunnerAccTest.java
View File

@ -42,7 +42,8 @@ class JobRunnerAccTest extends AbstractAccTest {
() -> {
try {
TaskanaEngine taskanaEngine =
taskanaEngineConfiguration.buildTaskanaEngine(ConnectionManagementMode.AUTOCOMMIT);
TaskanaEngine.buildTaskanaEngine(
taskanaEngineConfiguration, ConnectionManagementMode.AUTOCOMMIT);
DataSource dataSource = DataSourceGenerator.getDataSource();
// We have to slow down the transaction.
// This is necessary to guarantee the execution of

2
lib/taskana-core/src/test/java/acceptance/report/AbstractReportAccTest.java
View File

@ -19,7 +19,7 @@ public abstract class AbstractReportAccTest {
String schemaName = DataSourceGenerator.getSchemaName();
taskanaEngineConfiguration = new TaskanaEngineConfiguration(dataSource, false, schemaName);
taskanaEngineConfiguration.setGermanPublicHolidaysEnabled(false);
taskanaEngine = taskanaEngineConfiguration.buildTaskanaEngine();
taskanaEngine = TaskanaEngine.buildTaskanaEngine(taskanaEngineConfiguration);
taskanaEngine.setConnectionManagementMode(TaskanaEngine.ConnectionManagementMode.AUTOCOMMIT);
SampleDataGenerator sampleDataGenerator = new SampleDataGenerator(dataSource, schemaName);
sampleDataGenerator.clearDb();

11
lib/taskana-spring-example/src/main/java/pro/taskana/example/TaskanaConfig.java
View File

@ -13,9 +13,10 @@ import org.springframework.context.annotation.PropertySource;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import pro.taskana.SpringTaskanaEngineConfiguration;
import pro.taskana.TaskanaEngineConfiguration;
import pro.taskana.classification.api.ClassificationService;
import pro.taskana.common.api.TaskanaEngine;
import pro.taskana.common.internal.SpringTaskanaEngine;
import pro.taskana.task.api.TaskService;
import pro.taskana.user.api.UserService;
import pro.taskana.workbasket.api.WorkbasketService;
@ -49,14 +50,14 @@ public class TaskanaConfig {
}
@Bean
public SpringTaskanaEngineConfiguration taskanaEngineConfiguration(DataSource dataSource) {
return new SpringTaskanaEngineConfiguration(dataSource, true, false, schemaName);
public TaskanaEngineConfiguration taskanaEngineConfiguration(DataSource dataSource) {
return new TaskanaEngineConfiguration(dataSource, true, false, schemaName);
}
@Bean
public TaskanaEngine taskanaEngine(SpringTaskanaEngineConfiguration taskanaEngineConfiguration)
public TaskanaEngine taskanaEngine(TaskanaEngineConfiguration taskanaEngineConfiguration)
throws SQLException {
return taskanaEngineConfiguration.buildTaskanaEngine();
return SpringTaskanaEngine.buildTaskanaEngine(taskanaEngineConfiguration);
}
@Bean

51
lib/taskana-spring/src/main/java/pro/taskana/SpringTaskanaEngineConfiguration.java
View File

@ -1,51 +0,0 @@
package pro.taskana;
import java.sql.SQLException;
import javax.sql.DataSource;
import pro.taskana.common.api.TaskanaEngine;
import pro.taskana.common.api.TaskanaEngine.ConnectionManagementMode;
import pro.taskana.common.internal.SpringTaskanaEngineImpl;
/** This class configures the TaskanaEngineConfiguration for spring. */
public class SpringTaskanaEngineConfiguration extends TaskanaEngineConfiguration {
public SpringTaskanaEngineConfiguration(
DataSource dataSource,
boolean useManagedTransactions,
boolean securityEnabled,
String schemaName) {
super(dataSource, useManagedTransactions, securityEnabled, schemaName);
}
public SpringTaskanaEngineConfiguration(
DataSource dataSource,
boolean useManagedTransactions,
boolean securityEnabled,
String propertiesFileName,
String propertiesSeparator,
String schemaName) {
super(
dataSource,
useManagedTransactions,
securityEnabled,
propertiesFileName,
propertiesSeparator,
schemaName);
}
/**
* This method creates the Spring-based TaskanaEngine without an sqlSessionFactory.
*
* @return the TaskanaEngine
*/
@Override
public TaskanaEngine buildTaskanaEngine() throws SQLException {
this.useManagedTransactions = true;
return new SpringTaskanaEngineImpl(this, ConnectionManagementMode.PARTICIPATE);
}
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
}

38
lib/taskana-spring/src/main/java/pro/taskana/common/internal/SpringTaskanaEngine.java Normal file
View File

@ -0,0 +1,38 @@
package pro.taskana.common.internal;
import java.sql.SQLException;
import pro.taskana.TaskanaEngineConfiguration;
import pro.taskana.common.api.TaskanaEngine;
public interface SpringTaskanaEngine extends TaskanaEngine {
/**
* This method creates the {@linkplain SpringTaskanaEngine} with {@linkplain
* ConnectionManagementMode#PARTICIPATE }.
*
* @see SpringTaskanaEngine#buildTaskanaEngine(TaskanaEngineConfiguration,
* ConnectionManagementMode)
*/
@SuppressWarnings("checkstyle:JavadocMethod")
static SpringTaskanaEngine buildTaskanaEngine(TaskanaEngineConfiguration configuration)
throws SQLException {
return SpringTaskanaEngine.buildTaskanaEngine(
configuration, ConnectionManagementMode.PARTICIPATE);
}
/**
* Builds an {@linkplain SpringTaskanaEngine} based on {@linkplain TaskanaEngineConfiguration} and
* SqlConnectionMode.
*
* @param configuration complete taskanaEngineConfig to build the engine
* @param connectionManagementMode connectionMode for the SqlSession
* @return a {@linkplain SpringTaskanaEngineImpl}
* @throws SQLException when the db schema could not be initialized
*/
static SpringTaskanaEngine buildTaskanaEngine(
TaskanaEngineConfiguration configuration, ConnectionManagementMode connectionManagementMode)
throws SQLException {
return SpringTaskanaEngineImpl.createTaskanaEngine(configuration, connectionManagementMode);
}
}

18
lib/taskana-spring/src/main/java/pro/taskana/common/internal/SpringTaskanaEngineImpl.java
View File

@ -1,23 +1,25 @@
package pro.taskana.common.internal;
import java.sql.SQLException;
import javax.annotation.PostConstruct;
import org.mybatis.spring.transaction.SpringManagedTransactionFactory;
import pro.taskana.SpringTaskanaEngineConfiguration;
import pro.taskana.TaskanaEngineConfiguration;
/** This class configures the TaskanaEngine for spring. */
public class SpringTaskanaEngineImpl extends TaskanaEngineImpl {
public class SpringTaskanaEngineImpl extends TaskanaEngineImpl implements SpringTaskanaEngine {
public SpringTaskanaEngineImpl(
SpringTaskanaEngineConfiguration taskanaEngineConfiguration, ConnectionManagementMode mode)
TaskanaEngineConfiguration taskanaEngineConfiguration, ConnectionManagementMode mode)
throws SQLException {
super(taskanaEngineConfiguration, mode);
}
@PostConstruct
public void init() {
this.transactionFactory = new SpringManagedTransactionFactory();
this.sessionManager = createSqlSessionManager();
}
public static SpringTaskanaEngine createTaskanaEngine(
TaskanaEngineConfiguration taskanaEngineConfiguration,
ConnectionManagementMode connectionManagementMode)
throws SQLException {
return new SpringTaskanaEngineImpl(taskanaEngineConfiguration, connectionManagementMode);
}
}

3
lib/taskana-test-api/src/main/java/pro/taskana/testapi/extensions/TaskanaInitializationExtension.java
View File

@ -78,7 +78,8 @@ public class TaskanaInitializationExtension implements TestInstancePostProcessor
(spi, serviceProviders) ->
staticMock.when(() -> SpiLoader.load(spi)).thenReturn(serviceProviders));
taskanaEngine =
taskanaEngineConfiguration.buildTaskanaEngine(ConnectionManagementMode.AUTOCOMMIT);
TaskanaEngine.buildTaskanaEngine(
taskanaEngineConfiguration, ConnectionManagementMode.AUTOCOMMIT);
}
store.put(STORE_TASKANA_ENTITY_MAP, generateTaskanaEntityMap(taskanaEngine));

2
rest/taskana-rest-spring-example-boot/src/main/java/pro/taskana/example/boot/ExampleRestConfiguration.java
View File

@ -45,7 +45,7 @@ public class ExampleRestConfiguration {
@DependsOn("generateSampleData")
public TaskanaEngine getTaskanaEngine(TaskanaEngineConfiguration taskanaEngineConfiguration)
throws SQLException {
return taskanaEngineConfiguration.buildTaskanaEngine();
return TaskanaEngine.buildTaskanaEngine(taskanaEngineConfiguration);
}
// only required to let the adapter example connect to the same database

6
rest/taskana-rest-spring/src/main/java/pro/taskana/common/rest/RestConfiguration.java
View File

@ -12,12 +12,12 @@ import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.SpringHandlerInstantiator;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import pro.taskana.SpringTaskanaEngineConfiguration;
import pro.taskana.TaskanaEngineConfiguration;
import pro.taskana.classification.api.ClassificationService;
import pro.taskana.common.api.ConfigurationService;
import pro.taskana.common.api.TaskanaEngine;
import pro.taskana.common.api.security.CurrentUserContext;
import pro.taskana.common.internal.SpringTaskanaEngine;
import pro.taskana.monitor.api.MonitorService;
import pro.taskana.task.api.TaskService;
import pro.taskana.user.api.UserService;
@ -74,13 +74,13 @@ public class RestConfiguration {
@ConditionalOnMissingBean(TaskanaEngine.class)
public TaskanaEngine getTaskanaEngine(TaskanaEngineConfiguration taskanaEngineConfiguration)
throws SQLException {
return taskanaEngineConfiguration.buildTaskanaEngine();
return SpringTaskanaEngine.buildTaskanaEngine(taskanaEngineConfiguration);
}
@Bean
@ConditionalOnMissingBean(TaskanaEngineConfiguration.class)
public TaskanaEngineConfiguration taskanaEngineConfiguration(DataSource dataSource) {
return new SpringTaskanaEngineConfiguration(dataSource, true, true, schemaName);
return new TaskanaEngineConfiguration(dataSource, true, true, schemaName);
}
// Needed for injection into jackson deserializer.

3
routing/taskana-routing-rest/src/test/java/pro/taskana/routing/dmn/service/DmnConverterServiceAccTest.java
View File

@ -53,7 +53,8 @@ class DmnConverterServiceAccTest {
sampleDataGenerator.dropDb();
}
taskanaEngine =
taskanaEngineConfiguration.buildTaskanaEngine(ConnectionManagementMode.AUTOCOMMIT);
TaskanaEngine.buildTaskanaEngine(
taskanaEngineConfiguration, ConnectionManagementMode.AUTOCOMMIT);
sampleDataGenerator.clearDb();
sampleDataGenerator.generateTestData();

3
routing/taskana-spi-routing-dmn-router/src/test/java/pro/taskana/AbstractAccTest.java
View File

@ -40,7 +40,8 @@ public abstract class AbstractAccTest {
sampleDataGenerator.clearDb();
sampleDataGenerator.generateTestData();
taskanaEngine =
taskanaEngineConfiguration.buildTaskanaEngine(ConnectionManagementMode.AUTOCOMMIT);
TaskanaEngine.buildTaskanaEngine(
taskanaEngineConfiguration, ConnectionManagementMode.AUTOCOMMIT);
converter = taskanaEngine.getWorkingDaysToDaysConverter();
}