Skip to content

refactor: use testcontainers for integration test #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
findingrish merged 8 commits into from
May 21, 2021
Merged

refactor: use testcontainers for integration test #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2eae565
chore: use testcontainers for integration test
JBAhire Apr 21, 2021
76c3790
chore: apply spotless
JBAhire Apr 21, 2021
886b4c2
Fix build failure
May 20, 2021
08e9bad
Merge remote-tracking branch 'origin/main' into move-to-testcontainers
May 20, 2021
3449619
.
May 20, 2021
584cd6d
.
May 20, 2021
a0479e6
.
May 20, 2021
da55f10
.
May 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 3 additions & 41 deletions entity-service/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
import com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
import com.bmuschko.gradle.docker.tasks.container.DockerStartContainer
import com.bmuschko.gradle.docker.tasks.container.DockerStopContainer
import com.bmuschko.gradle.docker.tasks.image.DockerPullImage
import com.bmuschko.gradle.docker.tasks.network.DockerCreateNetwork
import com.bmuschko.gradle.docker.tasks.network.DockerRemoveNetwork

plugins {
java
application
Expand All @@ -15,42 +8,8 @@ plugins {
id("org.hypertrace.jacoco-report-plugin")
}

tasks.register<DockerCreateNetwork>("createIntegrationTestNetwork") {
networkName.set("entity-svc-int-test")
}

tasks.register<DockerRemoveNetwork>("removeIntegrationTestNetwork") {
networkId.set("entity-svc-int-test")
}

tasks.register<DockerPullImage>("pullMongoImage") {
image.set("mongo:4.4.0")
}

tasks.register<DockerCreateContainer>("createMongoContainer") {
dependsOn("createIntegrationTestNetwork")
dependsOn("pullMongoImage")
targetImageId(tasks.getByName<DockerPullImage>("pullMongoImage").image)
containerName.set("mongo-local")
hostConfig.network.set(tasks.getByName<DockerCreateNetwork>("createIntegrationTestNetwork").networkId)
hostConfig.portBindings.set(listOf("27017:27017"))
hostConfig.autoRemove.set(true)
}

tasks.register<DockerStartContainer>("startMongoContainer") {
dependsOn("createMongoContainer")
targetContainerId(tasks.getByName<DockerCreateContainer>("createMongoContainer").containerId)
}

tasks.register<DockerStopContainer>("stopMongoContainer") {
targetContainerId(tasks.getByName<DockerCreateContainer>("createMongoContainer").containerId)
finalizedBy("removeIntegrationTestNetwork")
}

tasks.integrationTest {
useJUnitPlatform()
dependsOn("startMongoContainer")
finalizedBy("stopMongoContainer")
}

dependencies {
Expand Down Expand Up @@ -78,10 +37,13 @@ dependencies {
// Config
implementation("com.typesafe:config:1.4.1")

// integration test
integrationTestImplementation(project(":entity-service-client"))
integrationTestImplementation("org.hypertrace.core.grpcutils:grpc-context-utils:0.4.0")
integrationTestImplementation("org.junit.jupiter:junit-jupiter:5.7.1")
integrationTestImplementation("org.hypertrace.core.serviceframework:integrationtest-service-framework:0.1.23")
integrationTestImplementation("org.testcontainers:testcontainers:1.15.2")
integrationTestImplementation("com.github.stefanbirkner:system-lambda:1.2.0")
}

application {
Expand Down
62 changes: 44 additions & 18 deletions ...onTest/java/org/hypertrace/entity/service/service/EntityDataServiceRelationshipsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package org.hypertrace.entity.service.service;

import io.grpc.Channel;
import io.grpc.ClientInterceptors;
import static com.github.stefanbirkner.systemlambda.SystemLambda.withEnvironmentVariable;

import com.typesafe.config.ConfigFactory;
import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
import java.util.ArrayList;
import java.util.Collections;
Expand All @@ -24,41 +26,65 @@
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.output.Slf4jLogConsumer;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.DockerImageName;

/** Test case for testing relationships CRUD with {@link EntityDataServiceClient} */
public class EntityDataServiceRelationshipsTest {

private static final Logger LOG =
LoggerFactory.getLogger(EntityDataServiceRelationshipsTest.class);
private static final Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(LOG);

private static EntityDataServiceClient entityDataServiceClient;
private static final String TENANT_ID =
"__testTenant__" + EntityDataServiceTest.class.getSimpleName();
private static final int CONTAINER_STARTUP_ATTEMPTS = 5;

private static GenericContainer<?> mongo;
private static ManagedChannel channel;

@BeforeAll
public static void setUp() {
IntegrationTestServerUtil.startServices(new String[] {"entity-service"});
EntityServiceClientConfig esConfig = EntityServiceTestConfig.getClientConfig();
Channel channel =
ClientInterceptors.intercept(
ManagedChannelBuilder.forAddress(esConfig.getHost(), esConfig.getPort())
.usePlaintext()
.build());
public static void setUp() throws Exception {

mongo =
new GenericContainer<>(DockerImageName.parse("hypertrace/mongodb:main"))
.withExposedPorts(27017)
.withStartupAttempts(CONTAINER_STARTUP_ATTEMPTS)
.waitingFor(Wait.forListeningPort())
.withLogConsumer(logConsumer);
mongo.start();

withEnvironmentVariable("MONGO_HOST", mongo.getHost())
.and("MONGO_PORT", mongo.getMappedPort(27017).toString())
.execute(
() -> {
ConfigFactory.invalidateCaches();
IntegrationTestServerUtil.startServices(new String[] {"entity-service"});
});
EntityServiceClientConfig entityServiceTestConfig = EntityServiceTestConfig.getClientConfig();
channel =
ManagedChannelBuilder.forAddress(
entityServiceTestConfig.getHost(), entityServiceTestConfig.getPort())
.usePlaintext()
.build();

entityDataServiceClient = new EntityDataServiceClient(channel);
setupEntityTypes();
}

@AfterAll
public static void teardown() {
channel.shutdown();
IntegrationTestServerUtil.shutdownServices();
mongo.stop();
}

private static void setupEntityTypes() {
Channel channel =
ClientInterceptors.intercept(
ManagedChannelBuilder.forAddress(
EntityServiceTestConfig.getClientConfig().getHost(),
EntityServiceTestConfig.getClientConfig().getPort())
.usePlaintext()
.build());

EntityTypeServiceClient entityTypeServiceClient = new EntityTypeServiceClient(channel);
entityTypeServiceClient.upsertEntityType(
TENANT_ID,
Expand Down
36 changes: 32 additions & 4 deletions ...src/integrationTest/java/org/hypertrace/entity/service/service/EntityDataServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.hypertrace.entity.service.service;

import static com.github.stefanbirkner.systemlambda.SystemLambda.withEnvironmentVariable;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
Expand All @@ -9,6 +10,7 @@
import static org.junit.jupiter.api.Assertions.assertTrue;

import com.google.common.collect.ImmutableMap;
import com.typesafe.config.ConfigFactory;
import io.grpc.Channel;
import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
Expand Down Expand Up @@ -60,24 +62,49 @@
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.output.Slf4jLogConsumer;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.DockerImageName;

/** Test case for {@link EntityDataServiceClient} */
public class EntityDataServiceTest {
private static final Logger LOG = LoggerFactory.getLogger(EntityDataServiceTest.class);
private static final Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(LOG);

private static final String TENANT_ID =
"__testTenant__" + EntityDataServiceTest.class.getSimpleName();
private static final String TEST_ENTITY_TYPE_V2 = "TEST_ENTITY";
private static EntityDataServiceClient entityDataServiceClient;
private static ManagedChannel channel;
private static final int CONTAINER_STARTUP_ATTEMPTS = 5;
private static GenericContainer<?> mongo;

@BeforeAll
public static void setUp() {
IntegrationTestServerUtil.startServices(new String[] {"entity-service"});
EntityServiceClientConfig esConfig = EntityServiceTestConfig.getClientConfig();
public static void setUp() throws Exception {
mongo =
new GenericContainer<>(DockerImageName.parse("hypertrace/mongodb:main"))
.withExposedPorts(27017)
.withStartupAttempts(CONTAINER_STARTUP_ATTEMPTS)
.waitingFor(Wait.forListeningPort())
.withLogConsumer(logConsumer);
mongo.start();

withEnvironmentVariable("MONGO_HOST", mongo.getHost())
.and("MONGO_PORT", mongo.getMappedPort(27017).toString())
.execute(
() -> {
ConfigFactory.invalidateCaches();
IntegrationTestServerUtil.startServices(new String[] {"entity-service"});
});
EntityServiceClientConfig entityServiceTestConfig = EntityServiceTestConfig.getClientConfig();
channel =
ManagedChannelBuilder.forAddress(esConfig.getHost(), esConfig.getPort())
ManagedChannelBuilder.forAddress("localhost", entityServiceTestConfig.getPort())
.usePlaintext()
.build();

entityDataServiceClient = new EntityDataServiceClient(channel);
setupEntityTypes(channel, TENANT_ID);
}
Expand All @@ -86,6 +113,7 @@ public static void setUp() {
public static void teardown() {
channel.shutdown();
IntegrationTestServerUtil.shutdownServices();
mongo.stop();
}

private static void setupEntityTypes(Channel channel, String tenant) {
Expand Down
58 changes: 46 additions & 12 deletions ...rc/integrationTest/java/org/hypertrace/entity/service/service/EntityQueryServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package org.hypertrace.entity.service.service;

import static com.github.stefanbirkner.systemlambda.SystemLambda.withEnvironmentVariable;
import static org.hypertrace.entity.service.constants.EntityCollectionConstants.ENTITY_TYPES_COLLECTION;
import static org.hypertrace.entity.service.constants.EntityCollectionConstants.RAW_ENTITIES_COLLECTION;
import static org.junit.jupiter.api.Assertions.assertEquals;
Expand All @@ -11,7 +12,7 @@
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import io.grpc.Channel;
import io.grpc.ClientInterceptors;
import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
import java.time.Instant;
import java.util.ArrayList;
Expand Down Expand Up @@ -54,14 +55,24 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.output.Slf4jLogConsumer;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.DockerImageName;

/** Test for {@link org.hypertrace.entity.query.service.client.EntityQueryServiceClient} */
public class EntityQueryServiceTest {

private static final Logger LOG = LoggerFactory.getLogger(EntityQueryServiceTest.class);
private static final Slf4jLogConsumer logConsumer = new Slf4jLogConsumer(LOG);

private static EntityQueryServiceClient entityQueryServiceClient;
// needed to create entities
private static EntityDataServiceClient entityDataServiceClient;

private static Channel channel;
private static ManagedChannel channel;
private static Datastore datastore;

private static final String TENANT_ID =
Expand All @@ -74,18 +85,36 @@ public class EntityQueryServiceTest {
// attributes defined in application.conf in attribute map
private static final String API_DISCOVERY_STATE_ATTR = "API.apiDiscoveryState";
private static final String API_HTTP_METHOD_ATTR = "API.httpMethod";
private static final int CONTAINER_STARTUP_ATTEMPTS = 5;
private static GenericContainer<?> mongo;

@BeforeAll
public static void setUp() {
IntegrationTestServerUtil.startServices(new String[] {"entity-service"});
EntityServiceClientConfig esConfig = EntityServiceTestConfig.getClientConfig();
public static void setUp() throws Exception {
mongo =
new GenericContainer<>(DockerImageName.parse("hypertrace/mongodb:main"))
.withExposedPorts(27017)
.withStartupAttempts(CONTAINER_STARTUP_ATTEMPTS)
.waitingFor(Wait.forListeningPort())
.withLogConsumer(logConsumer);
mongo.start();

withEnvironmentVariable("MONGO_HOST", mongo.getHost())
.and("MONGO_PORT", mongo.getMappedPort(27017).toString())
.execute(
() -> {
ConfigFactory.invalidateCaches();
IntegrationTestServerUtil.startServices(new String[] {"entity-service"});
});

EntityServiceClientConfig entityServiceTestConfig = EntityServiceTestConfig.getClientConfig();
channel =
ClientInterceptors.intercept(
ManagedChannelBuilder.forAddress(esConfig.getHost(), esConfig.getPort())
.usePlaintext()
.build());
ManagedChannelBuilder.forAddress(
entityServiceTestConfig.getHost(), entityServiceTestConfig.getPort())
.usePlaintext()
.build();
entityQueryServiceClient = new EntityQueryServiceClient(channel);
entityDataServiceClient = new EntityDataServiceClient(channel);

datastore = getDatastore();

Map<String, Map<String, String>> attributesMap = getAttributesMap();
Expand All @@ -96,7 +125,6 @@ public static void setUp() {
public void clearCollections() {
clearCollection(ENTITY_TYPES_COLLECTION);
clearCollection(RAW_ENTITIES_COLLECTION);

setupEntityTypes(channel);
}

Expand All @@ -107,7 +135,9 @@ private static void clearCollection(String collName) {

@AfterAll
public static void teardown() {
channel.shutdown();
IntegrationTestServerUtil.shutdownServices();
mongo.stop();
}

private static void setupEntityTypes(Channel channel) {
Expand Down Expand Up @@ -433,6 +463,7 @@ public void testCreateAndGetEntities() {

@Nested
class TotalEntities {

@Test
public void testTotal() {
// creating an api entity with attributes
Expand Down Expand Up @@ -541,9 +572,12 @@ private static Datastore getDatastore() {
Config config = ConfigFactory.parseResources("configs/entity-service/application.conf");
EntityServiceConfig entityServiceConfig =
new EntityServiceConfig(config.getConfig("entity.service.config"));
Map<String, String> mongoConfig = new HashMap<>();
mongoConfig.putIfAbsent("host", mongo.getHost());
mongoConfig.putIfAbsent("port", mongo.getMappedPort(27017).toString());
Config dataStoreConfig = ConfigFactory.parseMap(mongoConfig);
String dataStoreType = entityServiceConfig.getDataStoreType();
return DatastoreProvider.getDatastore(
dataStoreType, entityServiceConfig.getDataStoreConfig(dataStoreType));
return DatastoreProvider.getDatastore(dataStoreType, dataStoreConfig);
}

private static Map<String, Map<String, String>> getAttributesMap() {
Expand Down
Loading