lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Refactoring/Improving source: repository 5 (slf4j) (#1605)

Browse Source 
Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
2024-02-03 17:58:54 +02:00
committed by GitHub
parent 990d1a7545
commit f8b1910d02
12 changed files with 56 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/matcher/EventVerifier.java
View File

@@ -24,13 +24,12 @@ import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import lombok.extern.slf4j.Slf4j;
import org.awaitility.Awaitility;
import org.awaitility.core.ConditionTimeoutException;
import org.eclipse.hawkbit.repository.event.remote.RemoteIdEvent;
import org.eclipse.hawkbit.repository.event.remote.RemoteTenantAwareEvent;
import org.eclipse.hawkbit.repository.event.remote.TargetAssignDistributionSetEvent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.bus.event.RemoteApplicationEvent;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationListener;
@@ -42,8 +41,8 @@ import org.springframework.test.context.support.AbstractTestExecutionListener;
/**
* Test rule to setup and verify the event count for a method.
*/
@Slf4j
public class EventVerifier extends AbstractTestExecutionListener {
private static final Logger LOGGER = LoggerFactory.getLogger(EventVerifier.class);
private EventCaptor eventCaptor;
@@ -140,10 +139,10 @@ public class EventVerifier extends AbstractTestExecutionListener {
@Override
public void onApplicationEvent(final RemoteApplicationEvent event) {
LOGGER.debug("Received event {}", event.getClass().getSimpleName());
log.debug("Received event {}", event.getClass().getSimpleName());
if (ResetCounterMarkerEvent.class.isAssignableFrom(event.getClass())) {
LOGGER.debug("Retrieving reset counter marker event - resetting counters");
log.debug("Retrieving reset counter marker event - resetting counters");
capturedEvents.clear();
return;
}

9
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/AbstractIntegrationTest.java
View File

@@ -24,6 +24,7 @@ import java.util.List;
import java.util.NoSuchElementException;
import java.util.stream.Collectors;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.RandomStringUtils;
import org.eclipse.hawkbit.artifact.repository.ArtifactRepository;
@@ -71,8 +72,6 @@ import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.extension.ExtendWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.stream.binder.test.TestChannelBinderConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
@@ -92,6 +91,7 @@ import org.springframework.test.context.TestExecutionListeners;
import org.springframework.test.context.TestExecutionListeners.MergeMode;
import org.springframework.test.context.TestPropertySource;
@Slf4j
@ActiveProfiles({ "test" })
@ExtendWith({ JUnitTestLoggerExtension.class , SharedSqlTestDatabaseExtension.class })
@WithUser(principal = "bumlux", allSpPermissions = true, authorities = { CONTROLLER_ROLE, SYSTEM_ROLE })
@@ -110,7 +110,6 @@ import org.springframework.test.context.TestPropertySource;
mergeMode = MergeMode.MERGE_WITH_DEFAULTS)
@TestPropertySource(properties = "spring.main.allow-bean-definition-overriding=true")
public abstract class AbstractIntegrationTest {
private static final Logger LOG = LoggerFactory.getLogger(AbstractIntegrationTest.class);
protected static final Pageable PAGE = PageRequest.of(0, 500, Sort.by(Direction.ASC, "id"));
@@ -436,7 +435,7 @@ public abstract class AbstractIntegrationTest {
try {
FileUtils.cleanDirectory(new File(ARTIFACT_DIRECTORY));
} catch (final IOException | IllegalArgumentException e) {
LOG.warn("Cannot cleanup file-directory", e);
log.warn("Cannot cleanup file-directory", e);
}
}
}
@@ -452,7 +451,7 @@ public abstract class AbstractIntegrationTest {
try {
FileUtils.deleteDirectory(new File(ARTIFACT_DIRECTORY));
} catch (final IOException | IllegalArgumentException e) {
LOG.warn("Cannot delete file-directory", e);
log.warn("Cannot delete file-directory", e);
}
}
}

11
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/AbstractSqlTestDatabase.java
View File

@@ -15,8 +15,7 @@ import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.test.context.TestExecutionListener;
import org.springframework.test.context.support.AbstractTestExecutionListener;
import org.springframework.util.AntPathMatcher;
@@ -25,9 +24,9 @@ import org.springframework.util.AntPathMatcher;
* A {@link TestExecutionListener} for creating and dropping SQL schemas if
* tests are setup with an SQL schema.
*/
@Slf4j
public abstract class AbstractSqlTestDatabase extends AbstractTestExecutionListener {
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractSqlTestDatabase.class);
protected static final AntPathMatcher MATCHER = new AntPathMatcher();
protected final DatasourceContext context;
@@ -43,13 +42,13 @@ public abstract class AbstractSqlTestDatabase extends AbstractTestExecutionListe
protected abstract String getRandomSchemaUri();
protected void executeStatement(final String uri, final String statement) {
LOGGER.trace("\033[0;33mExecuting statement {} on uri {} \033[0m", statement, uri);
log.trace("\033[0;33mExecuting statement {} on uri {} \033[0m", statement, uri);
try (final Connection connection = getConnection(uri, context.getUsername(), context.getPassword());
final PreparedStatement preparedStatement = connection.prepareStatement(statement)) {
preparedStatement.execute();
} catch (final SQLException e) {
LOGGER.error("Execution of statement '{}' on uri {} failed!", statement, uri, e);
log.error("Execution of statement '{}' on uri {} failed!", statement, uri, e);
}
}
}

8
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/DatasourceContext.java
View File

@@ -9,17 +9,15 @@
*/
package org.eclipse.hawkbit.repository.test.util;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.RandomStringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Holds all database related configuration
*/
@Slf4j
public class DatasourceContext {
private static final Logger LOGGER = LoggerFactory.getLogger(DatasourceContext.class);
public static final String SPRING_DATASOURCE_URL_KEY = "spring.datasource.url";
public static final String SPRING_DATABASE_KEY = "spring.jpa.database";
public static final String SPRING_DATABASE_USERNAME_KEY = "spring.datasource.username";
@@ -82,7 +80,7 @@ public class DatasourceContext {
}
public boolean isNotProperlyConfigured() {
LOGGER.debug("Datasource environment variables: [database: {}, username: {}, password: {}, datasourceUrl: {}]",
log.debug("Datasource environment variables: [database: {}, username: {}, password: {}, datasourceUrl: {}]",
database, username, password, datasourceUrl);
return database == null || datasourceUrl == null || username == null || password == null;

8
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/DisposableSqlTestDatabaseExtension.java
View File

@@ -10,19 +10,17 @@
package org.eclipse.hawkbit.repository.test.util;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.extension.AfterAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static org.eclipse.hawkbit.repository.test.util.DatasourceContext.SPRING_DATASOURCE_URL_KEY;
/**
* Provides a convenient way to generate a test database that can be used, and disposed of after the test is executed.
*/
@Slf4j
public class DisposableSqlTestDatabaseExtension extends SharedSqlTestDatabaseExtension implements AfterAllCallback {
private static final Logger LOGGER = LoggerFactory.getLogger(SharedSqlTestDatabaseExtension.class);
private DatasourceContext datasourceContext = null;
@@ -37,7 +35,7 @@ public class DisposableSqlTestDatabaseExtension extends SharedSqlTestDatabaseExt
sharedContext.getUsername(), sharedContext.getPassword());
final AbstractSqlTestDatabase database = matchingDatabase(datasourceContext);
final String randomSchemaUri = database.createRandomSchema().getRandomSchemaUri();
LOGGER.info("\033[0;33mRandom Schema URI is {} \033[0m", randomSchemaUri);
log.info("\033[0;33mRandom Schema URI is {} \033[0m", randomSchemaUri);
System.setProperty(SPRING_DATASOURCE_URL_KEY, randomSchemaUri);
}

20
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/HashGeneratorUtils.java
View File

@@ -9,24 +9,21 @@
*/
package org.eclipse.hawkbit.repository.test.util;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.HexFormat;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Hash digest utility.
*/
@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class HashGeneratorUtils {
private static final Logger LOG = LoggerFactory.getLogger(HashGeneratorUtils.class);
private HashGeneratorUtils() {
}
/**
* Generates a MD5 cryptographic string.
*
@@ -67,9 +64,8 @@ public final class HashGeneratorUtils {
final byte[] hashedBytes = digest.digest(message);
return HexFormat.of().withLowerCase().formatHex(hashedBytes);
} catch (final NoSuchAlgorithmException e) {
LOG.error("Algorithm could not be found", e);
log.error("Algorithm could not be found", e);
}
return null;
}
}
}

12
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/JUnitTestLoggerExtension.java
View File

@@ -9,28 +9,26 @@
*/
package org.eclipse.hawkbit.repository.test.util;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.extension.BeforeTestExecutionCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.TestWatcher;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Slf4j
public class JUnitTestLoggerExtension implements BeforeTestExecutionCallback, TestWatcher {
private static final Logger LOG = LoggerFactory.getLogger(JUnitTestLoggerExtension.class);
@Override
public void testSuccessful(final ExtensionContext context) {
LOG.info("Test {} succeeded.", context.getTestMethod());
log.info("Test {} succeeded.", context.getTestMethod());
}
@Override
public void testFailed(final ExtensionContext context, final Throwable cause) {
LOG.error("Test {} failed with {}.", context.getTestMethod(), cause.getMessage());
log.error("Test {} failed with {}.", context.getTestMethod(), cause.getMessage());
}
@Override
public void beforeTestExecution(final ExtensionContext context) {
LOG.info("Starting Test {}...", context.getTestMethod());
log.info("Starting Test {}...", context.getTestMethod());
}
}

7
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/JpaTestRepositoryManagement.java
View File

@@ -11,19 +11,18 @@ package org.eclipse.hawkbit.repository.test.util;
import java.util.List;
import lombok.extern.slf4j.Slf4j;
import org.eclipse.hawkbit.cache.TenantAwareCacheManager;
import org.eclipse.hawkbit.repository.SystemManagement;
import org.eclipse.hawkbit.security.SystemSecurityContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.domain.Sort.Direction;
@Slf4j
public class JpaTestRepositoryManagement {
private static final Logger LOGGER = LoggerFactory.getLogger(JpaTestRepositoryManagement.class);
private static final Pageable PAGE = PageRequest.of(0, 400, Sort.by(Direction.ASC, "id"));
private final TenantAwareCacheManager cacheManager;
@@ -64,7 +63,7 @@ public class JpaTestRepositoryManagement {
return null;
});
} catch (final Exception e) {
LOGGER.error("Error while delete tenant", e);
log.error("Error while delete tenant", e);
}
});
}

10
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/MsSqlTestDatabase.java
View File

@@ -9,18 +9,16 @@
*/
package org.eclipse.hawkbit.repository.test.util;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.extension.Extension;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An {@link Extension} for creating and dropping MS SQL Server
* schemas if tests are set up with MS SQL Server.
*/
@Slf4j
public class MsSqlTestDatabase extends AbstractSqlTestDatabase {
private static final Logger LOGGER = LoggerFactory.getLogger(MsSqlTestDatabase.class);
public MsSqlTestDatabase(final DatasourceContext context) {
super(context);
}
@@ -28,7 +26,7 @@ public class MsSqlTestDatabase extends AbstractSqlTestDatabase {
@Override
public MsSqlTestDatabase createRandomSchema() {
final String uri = context.getDatasourceUrl();
LOGGER.info("\033[0;33mCreating mssql schema {} \033[0m", context.getRandomSchemaName());
log.info("\033[0;33mCreating mssql schema {} \033[0m", context.getRandomSchemaName());
executeStatement(uri.split(";database=")[0], "CREATE DATABASE " + context.getRandomSchemaName() + ";");
return this;
@@ -38,7 +36,7 @@ public class MsSqlTestDatabase extends AbstractSqlTestDatabase {
protected void dropRandomSchema() {
final String uri = context.getDatasourceUrl();
final String dbServerUri = uri.split(";database=")[0];
LOGGER.info("\033[0;33mDropping mssql schema {} \033[0m", context.getRandomSchemaName());
log.info("\033[0;33mDropping mssql schema {} \033[0m", context.getRandomSchemaName());
// Needed to avoid the DROP is rejected with "database still in use"
executeStatement(dbServerUri, "ALTER DATABASE " + context.getRandomSchemaName() + " SET SINGLE_USER WITH ROLLBACK IMMEDIATE;");

11
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/MySqlTestDatabase.java
View File

@@ -11,17 +11,16 @@ package org.eclipse.hawkbit.repository.test.util;
import java.util.Map;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.extension.Extension;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An {@link Extension} for creating and dropping MySql schemas if
* tests are set up with MySql.
*/
@Slf4j
public class MySqlTestDatabase extends AbstractSqlTestDatabase {
private static final Logger LOGGER = LoggerFactory.getLogger(MySqlTestDatabase.class);
protected static final String MYSQL_URI_PATTERN = "jdbc:mariadb://{host}:{port}/{db}*";
public MySqlTestDatabase(final DatasourceContext context) {
@@ -32,7 +31,7 @@ public class MySqlTestDatabase extends AbstractSqlTestDatabase {
public MySqlTestDatabase createRandomSchema() {
final String uri = context.getDatasourceUrl();
final String schemaName = getSchemaName(uri);
LOGGER.info("\033[0;33mCreating mysql schema {} if not existing \033[0m", context.getRandomSchemaName());
log.info("\033[0;33mCreating mysql schema {} if not existing \033[0m", context.getRandomSchemaName());
executeStatement(uri.split("/" + schemaName)[0],
"CREATE SCHEMA IF NOT EXISTS " + context.getRandomSchemaName() + ";");
@@ -43,7 +42,7 @@ public class MySqlTestDatabase extends AbstractSqlTestDatabase {
protected void dropRandomSchema() {
final String uri = context.getDatasourceUrl();
final String schemaName = getSchemaName(uri);
LOGGER.info("\033[0;33mDropping mysql schema {} \033[0m", context.getRandomSchemaName());
log.info("\033[0;33mDropping mysql schema {} \033[0m", context.getRandomSchemaName());
executeStatement(uri.split("/" + schemaName)[0], "DROP SCHEMA " + context.getRandomSchemaName() + ";");
}

11
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/PostgreSqlTestDatabase.java
View File

@@ -11,17 +11,16 @@ package org.eclipse.hawkbit.repository.test.util;
import java.util.Map;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.extension.Extension;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An {@link Extension} for creating and dropping MySql schemas if
* tests are set up with MySql.
*/
@Slf4j
public class PostgreSqlTestDatabase extends AbstractSqlTestDatabase {
private static final Logger LOGGER = LoggerFactory.getLogger(PostgreSqlTestDatabase.class);
private static final String POSTGRESQL_URI_PATTERN = "jdbc:postgresql://{host}:{port}/{db}*";
public PostgreSqlTestDatabase(final DatasourceContext context) {
@@ -30,7 +29,7 @@ public class PostgreSqlTestDatabase extends AbstractSqlTestDatabase {
@Override
protected PostgreSqlTestDatabase createRandomSchema() {
LOGGER.info("\033[0;33mCreating postgreSql schema {} \033[0m", context.getRandomSchemaName());
log.info("\033[0;33mCreating postgreSql schema {} \033[0m", context.getRandomSchemaName());
final String uri = getBaseUri() + "?currentSchema=" + getSchemaName();
executeStatement(uri, "CREATE SCHEMA " + context.getRandomSchemaName() + ";");
return this;
@@ -38,7 +37,7 @@ public class PostgreSqlTestDatabase extends AbstractSqlTestDatabase {
@Override
protected void dropRandomSchema() {
LOGGER.info("\033[0;33mDropping postgreSql schema {}\033[0m", context.getRandomSchemaName());
log.info("\033[0;33mDropping postgreSql schema {}\033[0m", context.getRandomSchemaName());
final String uri = getBaseUri() + "?currentSchema=" + getSchemaName();
executeStatement(uri, "DROP SCHEMA " + context.getRandomSchemaName() + " CASCADE;");
}

15
hawkbit-repository/hawkbit-repository-test/src/main/java/org/eclipse/hawkbit/repository/test/util/SharedSqlTestDatabaseExtension.java
View File

@@ -13,17 +13,16 @@ import static org.eclipse.hawkbit.repository.test.util.DatasourceContext.SPRING_
import java.util.concurrent.atomic.AtomicReference;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Represents a test database configuration for a "shared" database instance across all tests annotated with this extension
*/
@Slf4j
public class SharedSqlTestDatabaseExtension implements BeforeAllCallback {
private static final Logger LOGGER = LoggerFactory.getLogger(SharedSqlTestDatabaseExtension.class);
protected static final AtomicReference<DatasourceContext> CONTEXT = new AtomicReference<>();
@Override
@@ -31,20 +30,20 @@ public class SharedSqlTestDatabaseExtension implements BeforeAllCallback {
final DatasourceContext testDatasourceContext = new DatasourceContext();
if (testDatasourceContext.isNotProperlyConfigured()) {
LOGGER.info("\033[0;33mSchema generation skipped... No datasource environment variables found!\033[0m");
log.info("\033[0;33mSchema generation skipped... No datasource environment variables found!\033[0m");
return;
}
// update CONTEXT only if the current value is null => initialize only
if (!CONTEXT.compareAndSet(null, testDatasourceContext)) {
final String randomSchemaUri = matchingDatabase(testDatasourceContext).getRandomSchemaUri();
LOGGER.info("\033[0;33mReusing Random Schema at URI {} \033[0m", randomSchemaUri);
log.info("\033[0;33mReusing Random Schema at URI {} \033[0m", randomSchemaUri);
return;
}
final AbstractSqlTestDatabase database = matchingDatabase(testDatasourceContext);
final String randomSchemaUri = database.createRandomSchema().getRandomSchemaUri();
LOGGER.info("\033[0;33mRandom Schema URI is {} \033[0m", randomSchemaUri);
log.info("\033[0;33mRandom Schema URI is {} \033[0m", randomSchemaUri);
System.setProperty(SPRING_DATASOURCE_URL_KEY, randomSchemaUri);
registerDropSchemaOnSystemShutdownHook(database, randomSchemaUri);
@@ -52,7 +51,7 @@ public class SharedSqlTestDatabaseExtension implements BeforeAllCallback {
private void registerDropSchemaOnSystemShutdownHook(final AbstractSqlTestDatabase database, final String schemaUri) {
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
LOGGER.warn("\033[0;33mDropping schema at url {} \033[0m", schemaUri);
log.warn("\033[0;33mDropping schema at url {} \033[0m", schemaUri);
database.dropRandomSchema();
}));
}