Skip to content

Commit

Permalink
Merge branch 'DEVX-257_Migrate-type-syncer' into DEVX-245_migrate-it-…
Browse files Browse the repository at this point in the history 
…for-cli-runner
  • Loading branch information
salander85 committed Oct 31, 2023
2 parents a9665ee + 45ccb69 commit d7f6577
Show file tree
Hide file tree
Showing 5 changed files with 197 additions and 97 deletions.
10 changes: 1 addition & 9 deletions src/main/java/com/commercetools/project/sync/product/ProductSyncer.java
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.commercetools.project.sync.product;

import static com.commercetools.project.sync.util.SyncUtils.IDENTIFIER_NOT_PRESENT;
import static com.commercetools.project.sync.util.SyncUtils.getCompletionExceptionCause;
import static com.commercetools.project.sync.util.SyncUtils.logErrorCallback;
import static com.commercetools.project.sync.util.SyncUtils.logWarningCallback;
import static com.commercetools.sync.products.utils.ProductTransformUtils.toProductDrafts;
Expand Down Expand Up @@ -33,7 +34,6 @@
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletionException;
import java.util.concurrent.CompletionStage;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
Expand Down Expand Up @@ -171,14 +171,6 @@ private ProductVariantDraft createProductVariantDraftWithoutDiscounted(
return ProductVariantDraftBuilder.of(productVariantDraft).prices(priceDrafts).build();
}

@Nonnull
private static Throwable getCompletionExceptionCause(@Nonnull final Throwable exception) {
if (exception instanceof CompletionException) {
return getCompletionExceptionCause(exception.getCause());
}
return exception;
}

@Nonnull
@Override
protected ByProjectKeyProductProjectionsGet getQuery() {
Expand Down
18 changes: 15 additions & 3 deletions src/main/java/com/commercetools/project/sync/type/TypeSyncer.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.commercetools.project.sync.type;

import static com.commercetools.project.sync.util.SyncUtils.getCompletionExceptionCause;
import static com.commercetools.project.sync.util.SyncUtils.logErrorCallback;
import static com.commercetools.project.sync.util.SyncUtils.logWarningCallback;

Expand Down Expand Up @@ -27,6 +28,7 @@
import java.util.concurrent.CompletionStage;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -96,11 +98,21 @@ protected Logger getLoggerInstance() {
@Nonnull
@Override
protected CompletionStage<List<TypeDraft>> transform(@Nonnull final List<Type> page) {
return CompletableFuture.completedFuture(
page.stream().map(TypeSyncer::typeToDraft).collect(Collectors.toList()));
return CompletableFuture.supplyAsync(
() -> page.stream().map(TypeSyncer::typeToDraft).collect(Collectors.toList()))
.handle(
((typeDrafts, throwable) -> {
if (throwable != null) {
if (LOGGER.isWarnEnabled()) {
LOGGER.warn(throwable.getMessage(), getCompletionExceptionCause(throwable));
}
return List.of();
}
return typeDrafts;
}));
}

@Nonnull
@Nullable
private static TypeDraft typeToDraft(@Nonnull final Type type) {
return TypeDraftBuilder.of()
.key(type.getKey())
Expand Down
9 changes: 9 additions & 0 deletions src/main/java/com/commercetools/project/sync/util/SyncUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import com.commercetools.sync.commons.exceptions.SyncException;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletionException;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
Expand Down Expand Up @@ -112,6 +113,14 @@ public static void logWarningCallback(
}
}

@Nonnull
public static Throwable getCompletionExceptionCause(@Nonnull final Throwable exception) {
if (exception instanceof CompletionException) {
return getCompletionExceptionCause(exception.getCause());
}
return exception;
}

@Nonnull
public static String buildLastSyncTimestampContainerName(
@Nonnull final String syncModuleName, @Nullable final String runnerName) {
Expand Down
239 changes: 154 additions & 85 deletions src/test/java/com/commercetools/project/sync/type/TypeSyncerTest.java
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,36 @@
package com.commercetools.project.sync.type;

import static com.commercetools.project.sync.util.TestUtils.getMockedClock;
import static com.commercetools.project.sync.util.TestUtils.readObjectFromResource;
import static java.lang.String.format;
import static java.util.stream.Collectors.toList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import com.commercetools.api.client.ByProjectKeyTypesGet;
import com.commercetools.api.client.ProjectApiRoot;
import com.commercetools.api.defaultconfig.ApiRootBuilder;
import com.commercetools.api.models.type.Type;
import com.commercetools.api.models.type.TypeDraft;
import com.commercetools.api.models.type.TypeDraftBuilder;
import com.commercetools.api.models.type.TypePagedQueryResponse;
import com.commercetools.api.models.type.TypePagedQueryResponseBuilder;
import com.commercetools.sync.types.TypeSync;
import io.vrap.rmf.base.client.ApiHttpResponse;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import uk.org.lidalia.slf4jtest.LoggingEvent;
import uk.org.lidalia.slf4jtest.TestLogger;
import uk.org.lidalia.slf4jtest.TestLoggerFactory;

// These tests aren't migrated
// TODO: Migrate tests
class TypeSyncerTest {
private final TestLogger syncerTestLogger = TestLoggerFactory.getTestLogger(TypeSyncer.class);

Expand All @@ -14,87 +39,131 @@ void setup() {
syncerTestLogger.clearAll();
}

// @Test
// void of_ShouldCreateTypeSyncerInstance() {
// // test
// final TypeSyncer typeSyncer =
// TypeSyncer.of(mock(SphereClient.class), mock(SphereClient.class), getMockedClock());
//
// // assertions
// assertThat(typeSyncer).isNotNull();
// assertThat(typeSyncer.getQuery()).isEqualTo(TypeQuery.of());
// assertThat(typeSyncer.getSync()).isInstanceOf(TypeSync.class);
// }
//
// @Test
// void transform_ShouldConvertResourcesToDrafts() {
// // preparation
// final TypeSyncer typeSyncer =
// TypeSyncer.of(mock(SphereClient.class), mock(SphereClient.class), getMockedClock());
// final List<Type> typePage =
// asList(
// readObjectFromResource("type-key-1.json", Type.class),
// readObjectFromResource("type-key-2.json", Type.class));
//
// // test
// final CompletionStage<List<TypeDraft>> draftsFromPageStage = typeSyncer.transform(typePage);
//
// // assertions
// assertThat(draftsFromPageStage)
// .isCompletedWithValue(
// typePage.stream()
// .map(
// type ->
// TypeDraftBuilder.of(
// type.getKey(), type.getName(), type.getResourceTypeIds())
// .fieldDefinitions(type.getFieldDefinitions())
// .description(type.getDescription()))
// .map(TypeDraftBuilder::build)
// .collect(toList()));
// }
//
// @Test
// void getQuery_ShouldBuildTypeQuery() {
// // preparation
// final TypeSyncer typeSyncer =
// TypeSyncer.of(mock(SphereClient.class), mock(SphereClient.class), getMockedClock());
//
// // test
// final TypeQuery query = typeSyncer.getQuery();
//
// // assertion
// assertThat(query).isEqualTo(TypeQuery.of());
// }
//
// @Test
// void syncWithError_WhenNoKeyIsProvided_ShouldCallErrorCallback() {
// // preparation
// final SphereClient sourceClient = mock(SphereClient.class);
// final SphereClient targetClient = mock(SphereClient.class);
// when(sourceClient.getConfig()).thenReturn(SphereApiConfig.of("source-project"));
// when(targetClient.getConfig()).thenReturn(SphereApiConfig.of("target-project"));
//
// final List<Type> typePage =
// Collections.singletonList(readObjectFromResource("type-without-key.json", Type.class));
//
// final PagedQueryResult<Type> pagedQueryResult = mock(PagedQueryResult.class);
// when(pagedQueryResult.getResults()).thenReturn(typePage);
// when(sourceClient.execute(any(TypeQuery.class)))
// .thenReturn(CompletableFuture.completedFuture(pagedQueryResult));
//
// // test
// final TypeSyncer typeSyncer = TypeSyncer.of(sourceClient, targetClient, mock(Clock.class));
// typeSyncer.sync(null, true).toCompletableFuture().join();
//
// // assertion
// final LoggingEvent errorLog = syncerTestLogger.getAllLoggingEvents().get(1);
// assertThat(errorLog.getMessage())
// .isEqualTo(
// "Error when trying to sync type. Existing key: <<not present>>. Update actions:
// []");
// assertThat(errorLog.getThrowable().get().getMessage())
// .isEqualTo(
// "TypeDraft with name: LocalizedString(en -> typeName) doesn't have a key. Please
// make sure all type drafts have keys.");
// }
@Test
void of_ShouldCreateTypeSyncerInstance() {
// preparation
final ProjectApiRoot sourceClient = mock(ProjectApiRoot.class);
when(sourceClient.types()).thenReturn(mock());
when(sourceClient.types().get()).thenReturn(mock());

// test
final TypeSyncer typeSyncer =
TypeSyncer.of(sourceClient, mock(ProjectApiRoot.class), getMockedClock());

// assertions
assertThat(typeSyncer).isNotNull();
assertThat(typeSyncer.getSync()).isInstanceOf(TypeSync.class);
}

@Test
void transform_ShouldConvertResourcesToDrafts() {
// preparation
final TypeSyncer typeSyncer =
TypeSyncer.of(mock(ProjectApiRoot.class), mock(ProjectApiRoot.class), getMockedClock());
final List<Type> typePage =
List.of(
readObjectFromResource("type-key-1.json", Type.class),
readObjectFromResource("type-key-2.json", Type.class));

// test
final CompletionStage<List<TypeDraft>> draftsFromPageStage = typeSyncer.transform(typePage);

// assertions
assertThat(draftsFromPageStage)
.isCompletedWithValue(
typePage.stream()
.map(
type ->
TypeDraftBuilder.of()
.key(type.getKey())
.name(type.getName())
.resourceTypeIds(type.getResourceTypeIds())
.fieldDefinitions(type.getFieldDefinitions())
.description(type.getDescription()))
.map(TypeDraftBuilder::build)
.collect(toList()));
}

@Test
void getQuery_ShouldBuildTypeQuery() {
// preparation
final ProjectApiRoot apiRoot =
ApiRootBuilder.of().withApiBaseUrl("baseURl").build("testProjectKey");
final TypeSyncer typeSyncer =
TypeSyncer.of(apiRoot, mock(ProjectApiRoot.class), getMockedClock());

// test
final ByProjectKeyTypesGet query = typeSyncer.getQuery();

// assertion
assertThat(query).isInstanceOf(ByProjectKeyTypesGet.class);
}

@Test
void transform_WhenNoKeyIsProvided_ShouldLogErrorAndContinue() {
// preparation
final ProjectApiRoot sourceClient = mock(ProjectApiRoot.class);
final List<Type> typePage =
List.of(readObjectFromResource("type-without-key.json", Type.class));

// test
final TypeSyncer typeSyncer =
TypeSyncer.of(sourceClient, mock(ProjectApiRoot.class), getMockedClock());
final CompletableFuture<List<TypeDraft>> typeDrafts =
typeSyncer.transform(typePage).toCompletableFuture();

// assertion
assertThat(typeDrafts).isCompletedWithValue(Collections.emptyList());
assertThat(syncerTestLogger.getAllLoggingEvents())
.anySatisfy(
loggingEvent -> {
assertThat(loggingEvent.getMessage()).contains("TypeDraft: key is missing");
assertThat(loggingEvent.getThrowable().isPresent()).isTrue();
assertThat(loggingEvent.getThrowable().get())
.isInstanceOf(NullPointerException.class);
});
}

@Test
void sync_whenKeyIsBlank_shouldCallErrorCallback() {
// preparation
final ProjectApiRoot sourceClient = mock(ProjectApiRoot.class);
Type type = readObjectFromResource("type-key-1.json", Type.class);
type.setKey("");

final TypePagedQueryResponse response =
TypePagedQueryResponseBuilder.of()
.results(List.of(type))
.limit(20L)
.offset(0L)
.count(1L)
.build();

final ApiHttpResponse apiHttpResponse = mock(ApiHttpResponse.class);
when(apiHttpResponse.getBody()).thenReturn(response);
final ByProjectKeyTypesGet byProjectKeyTypesGet = mock(ByProjectKeyTypesGet.class);
when(byProjectKeyTypesGet.execute())
.thenReturn(CompletableFuture.completedFuture(apiHttpResponse));
when(byProjectKeyTypesGet.withLimit(anyInt())).thenReturn(byProjectKeyTypesGet);
when(byProjectKeyTypesGet.withWithTotal(anyBoolean())).thenReturn(byProjectKeyTypesGet);
when(byProjectKeyTypesGet.withSort(anyString())).thenReturn(byProjectKeyTypesGet);
when(sourceClient.types()).thenReturn(mock());
when(sourceClient.types().get()).thenReturn(byProjectKeyTypesGet);

// test
final TypeSyncer typeSyncer =
TypeSyncer.of(sourceClient, mock(ProjectApiRoot.class), getMockedClock());
typeSyncer.sync(null, true);

// assertions
final LoggingEvent errorLog = syncerTestLogger.getAllLoggingEvents().get(1);
assertThat(errorLog.getMessage())
.isEqualTo(
"Error when trying to sync type. Existing key: <<not present>>. Update actions: []");
assertThat(errorLog.getThrowable().get().getMessage())
.isEqualTo(
format(
"TypeDraft with name: %s doesn't have a key. Please make sure all type drafts have keys.",
type.getName()));
}
}
18 changes: 18 additions & 0 deletions src/test/java/com/commercetools/project/sync/util/SyncUtilsTest.java
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.commercetools.project.sync.util;

import static com.commercetools.project.sync.util.SyncUtils.*;
import static com.commercetools.project.sync.util.TestUtils.createBadGatewayException;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
Expand All @@ -10,8 +11,10 @@
import com.commercetools.sync.commons.exceptions.SyncException;
import com.commercetools.sync.products.ProductSync;
import com.commercetools.sync.types.TypeSync;
import io.vrap.rmf.base.client.error.BadGatewayException;
import java.util.Arrays;
import java.util.Optional;
import java.util.concurrent.CompletionException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import uk.org.lidalia.slf4jtest.LoggingEvent;
Expand Down Expand Up @@ -175,4 +178,19 @@ void logWarningCallbackWithResource_ShouldLogWarningWithCorrectMessage() {
assertThat(loggingEvent.getThrowable().isPresent()).isTrue();
assertThat(loggingEvent.getThrowable().get()).isInstanceOf(SyncException.class);
}

@Test
void getCompletionExceptionCause_WithCompletionException_ShouldReturnDifferentException() {
final BadGatewayException wrappedException = createBadGatewayException();
final CompletionException completionException = new CompletionException(wrappedException);

assertThat(getCompletionExceptionCause(completionException)).isEqualTo(wrappedException);
}

@Test
void getCompletionExceptionCause_WithBadGatewayException_ShouldReturnException() {
final BadGatewayException badGatewayException = createBadGatewayException();

assertThat(getCompletionExceptionCause(badGatewayException)).isEqualTo(badGatewayException);
}
}

0 comments on commit d7f6577

Please sign in to comment.