TESTS.md

All tests are written in JUnit 5.

Equals, Hashcode and ToString

• Equals and Hashcode is tested using EqualsVerifier
• Sample code is

class UserTest {

    @Test
    void equalsContract() {
        User client = UserUtils.createUser();
        User admin = UserUtils.createUser();

        EqualsVerifier.forClass(User.class)
                .withRedefinedSuperclass()
                .withPrefabValues(User.class, client, admin)
                .withOnlyTheseFields(TestUtils.getUserEqualsFields().toArray(new String[0]))
                .verify();
    }
}

• ToString is tested using To String Verifier
• Sample code is

class UserTest {

    @Test
    void testToString() {
        ToStringVerifier.forClass(User.class)
                .withClassName(NameStyle.SIMPLE_NAME)
                .withIgnoredFields("password", "userRoles", "userHistories")
                .verify();
    }
}

Integration Tests

Default (H2 in memory)

Integration tests can be run in two (2) profiles which are integration-test and integration-test-ci

integration-test profile can be dynamically activated using the run syntax:

./gradlew clean build # Profile will be set to integration-test if none is provided

This will run liquibase migration script against H2 in memory database running in Postgres Mode

Docker based (Test Container) Postgres Database Integration Test

integration-test-ci profile can be dynamically activated using the syntax:

SPRING_PROFILES_ACTIVE=integration-test-ci ./gradlew clean build

This will run the integration test in a docker container using test containers and postgres database.

Local Amazons3

Tests are powered by S3 mock library for Java/Scala

Bean definition for Amazons3 in test context is defined as:

@Configuration
@Profile(ProfileTypeConstants.TEST)
public class TestConfig {

    /**
     * A bean to be used by AmazonS3 Service.
     *
     * @param props the aws properties
     * @return instance of AmazonS3Client
     */
    @Bean
    public AmazonS3 amazonS3(AwsProperties props) {
        var endpoint = new EndpointConfiguration(props.getServiceEndpoint(), props.getRegion());
        // Create the credentials provider
        var credentials = new AnonymousAWSCredentials();

        return AmazonS3ClientBuilder.standard()
                .withPathStyleAccessEnabled(true)
                .withEndpointConfiguration(endpoint)
                .withCredentials(new AWSStaticCredentialsProvider(credentials))
                .build();
    }
}