Merge branch 'master' into DEVX-291_Sync-producttypes-with-reference-set

salander85 · salander85 · commit 5a31f5a51a35 · 2023-12-05T11:59:49.000+01:00
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -43,7 +43,7 @@ jobs:
         id: vars
         run: echo ::set-output name=tag::${GITHUB_REF#refs/*/}
       - name: Set up Java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: 11
           distribution: 'zulu'
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-java@v3
+      - uses: actions/setup-java@v4
         with:
           java-version: 11
           distribution: 'zulu'
diff --git a/build.gradle b/build.gradle
@@ -2,16 +2,16 @@ plugins {
     id 'org.ajoberstar.git-publish' version '4.2.1'
     id 'com.adarshr.test-logger' version '4.0.0'
     id 'org.ajoberstar.grgit' version '5.2.1'
-    id "com.github.ben-manes.versions" version '0.49.0'
+    id "com.github.ben-manes.versions" version '0.50.0'
     id 'ru.vyarus.mkdocs' version '3.0.0'
-    id "com.github.spotbugs" version "5.2.3"
-    id 'com.diffplug.spotless' version '6.22.0'
+    id "com.github.spotbugs" version "6.0.1"
+    id 'com.diffplug.spotless' version '6.23.3'
     id 'io.github.gradle-nexus.publish-plugin' version '1.3.0'
 }
 
 ext{
     commercetoolsJavaSdkV2Version = '17.2.0'
-    mockitoJunitJupiterVersion = '5.7.0'
+    mockitoJunitJupiterVersion = '5.8.0'
     jupiterApiVersion = '5.10.1'
     assertjVersion = '3.24.2'
     pmdVersion = '6.55.0'
@@ -47,15 +47,15 @@ dependencies {
     implementation "com.github.ben-manes.caffeine:caffeine:${caffeineVersion}"
     implementation "org.apache.commons:commons-text:${commonTextVersion}"
     api "com.commercetools.sdk:commercetools-sdk-java-api:${commercetoolsJavaSdkV2Version}"
-    api 'commons-io:commons-io:2.11.0'
+    api 'commons-io:commons-io:2.15.1'
     api 'commons-codec:commons-codec:1.16.0'
     api 'com.google.code.findbugs:annotations:3.0.1'
-    api 'com.neovisionaries:nv-i18n:1.28'
+    api 'com.neovisionaries:nv-i18n:1.29'
     testImplementation "org.mockito:mockito-junit-jupiter:${mockitoJunitJupiterVersion}"
     testImplementation "org.junit.jupiter:junit-jupiter-api:${jupiterApiVersion}"
     testImplementation "org.junit.jupiter:junit-jupiter-params:${jupiterApiVersion}"
     testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${jupiterApiVersion}"
     testRuntimeOnly "org.junit.vintage:junit-vintage-engine:${jupiterApiVersion}"
     testImplementation "org.assertj:assertj-core:${assertjVersion}"
-    testImplementation 'com.github.spotbugs:spotbugs-annotations:4.8.1'
+    testImplementation 'com.github.spotbugs:spotbugs-annotations:4.8.2'
 }
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
diff --git a/src/main/java/com/commercetools/sync/categories/utils/CategoryReferenceResolutionUtils.java b/src/main/java/com/commercetools/sync/categories/utils/CategoryReferenceResolutionUtils.java
@@ -83,15 +83,7 @@ private static CategoryDraft mapToCategoryDraft(
         getResourceIdentifierWithKey(
             category.getParent(),
             referenceIdToKeyCache,
-            (id, key) -> {
-              final CategoryResourceIdentifierBuilder builder =
-                  CategoryResourceIdentifierBuilder.of();
-              if (id == null) {
-                return builder.key(key).build();
-              } else {
-                return builder.id(id).build();
-              }
-            });
+            (id, key) -> CategoryResourceIdentifierBuilder.of().key(key).id(id).build());
     return CategoryDraftBuilder.of()
         .key(category.getKey())
         .slug(category.getSlug())
diff --git a/src/main/java/com/commercetools/sync/commons/utils/CustomTypeReferenceResolutionUtils.java b/src/main/java/com/commercetools/sync/commons/utils/CustomTypeReferenceResolutionUtils.java
@@ -70,16 +70,11 @@ public static CustomFieldsDraft mapToCustomFieldsDraft(
                                     SyncUtils.getResourceIdentifierWithKey(
                                         typeReference,
                                         referenceIdToKeyCache,
-                                        (id, key) -> {
-                                          final TypeResourceIdentifierBuilder builder =
-                                              TypeResourceIdentifierBuilder.of();
-                                          if (id == null) {
-
-                                            return builder.key(key).build();
-                                          } else {
-                                            return builder.id(id).build();
-                                          }
-                                        }))
+                                        (id, key) ->
+                                            TypeResourceIdentifierBuilder.of()
+                                                .key(key)
+                                                .id(id)
+                                                .build()))
                             .orElse(null))
                     .build())
         .orElse(null);
diff --git a/src/main/java/com/commercetools/sync/commons/utils/SyncUtils.java b/src/main/java/com/commercetools/sync/commons/utils/SyncUtils.java
@@ -70,7 +70,7 @@ ResourceIdentifierT getResourceIdentifierWithKey(
           @Nullable final String key,
           final BiFunction<String, String, ResourceIdentifierT> toResourceIdentifier) {
 
-    if (!StringUtils.isEmpty(key)) {
+    if (!StringUtils.isBlank(key)) {
       return toResourceIdentifier.apply(null, key);
     }
     return toResourceIdentifier.apply(id, null);
diff --git a/src/main/java/com/commercetools/sync/inventories/utils/InventoryReferenceResolutionUtils.java b/src/main/java/com/commercetools/sync/inventories/utils/InventoryReferenceResolutionUtils.java
@@ -11,12 +11,14 @@
 import com.commercetools.api.models.inventory.InventoryEntry;
 import com.commercetools.api.models.inventory.InventoryEntryDraft;
 import com.commercetools.api.models.inventory.InventoryEntryDraftBuilder;
+import com.commercetools.api.models.type.CustomFieldsDraft;
 import com.commercetools.api.models.type.Type;
 import com.commercetools.api.models.type.TypeReference;
 import com.commercetools.api.models.type.TypeResourceIdentifier;
 import com.commercetools.sync.commons.utils.ReferenceIdToKeyCache;
 import java.util.List;
 import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 
 /**
  * Util class which provides utilities that can be used when syncing resources from a source
@@ -81,24 +83,41 @@ private static InventoryEntryDraft mapToInventoryEntryDraft(
         getResourceIdentifierWithKey(
             inventoryEntry.getSupplyChannel(),
             referenceIdToKeyCache,
-            (id, key) -> {
-              final ChannelResourceIdentifierBuilder builder =
-                  ChannelResourceIdentifierBuilder.of();
-              if (id == null) {
-                return builder.key(key).build();
-              } else {
-                return builder.id(id).build();
-              }
-            });
-    return InventoryEntryDraftBuilder.of()
-        .sku(inventoryEntry.getSku())
-        .quantityOnStock(inventoryEntry.getQuantityOnStock())
-        .expectedDelivery(inventoryEntry.getExpectedDelivery())
-        .restockableInDays(inventoryEntry.getRestockableInDays())
-        .key(inventoryEntry.getKey())
-        .custom(mapToCustomFieldsDraft(inventoryEntry, referenceIdToKeyCache))
-        .supplyChannel(channelResourceIdentifier)
-        .build();
+            (id, key) -> ChannelResourceIdentifierBuilder.of().key(key).id(id).build());
+    final CustomFieldsDraft customFieldsDraft =
+        mapToCustomFieldsDraft(inventoryEntry, referenceIdToKeyCache);
+    return getInventoryEntryDraft(inventoryEntry, customFieldsDraft, channelResourceIdentifier);
+  }
+
+  /**
+   * Creates a new {@link InventoryEntryDraft} from given {@link InventoryEntry}, already mapped
+   * {@link CustomFieldsDraft} and channel as {@link ChannelResourceIdentifier}.
+   *
+   * @param inventoryEntry - a template inventoryEntry to build the draft from
+   * @param mappedCustomFields - a customFieldsDraft or null
+   * @param channel - a resource identifier representing the supply channel or null
+   * @return a new {@link InventoryEntryDraft} with all fields copied from the {@param
+   *     inventoryEntry} and custom fields set {@param mappedCustomFields} and supply channel with
+   *     {@param channel} resource identifier - it will return empty InventoryEntryDraft if sku or
+   *     quantityOnStock are missing.
+   */
+  private static InventoryEntryDraft getInventoryEntryDraft(
+      @Nonnull final InventoryEntry inventoryEntry,
+      @Nullable final CustomFieldsDraft mappedCustomFields,
+      @Nullable final ChannelResourceIdentifier channel) {
+    if (inventoryEntry.getSku() != null && inventoryEntry.getQuantityOnStock() != null) {
+      return InventoryEntryDraftBuilder.of()
+          .sku(inventoryEntry.getSku())
+          .quantityOnStock(inventoryEntry.getQuantityOnStock())
+          .expectedDelivery(inventoryEntry.getExpectedDelivery())
+          .restockableInDays(inventoryEntry.getRestockableInDays())
+          .key(inventoryEntry.getKey())
+          .custom(mappedCustomFields)
+          .supplyChannel(channel)
+          .build();
+    } else {
+      return InventoryEntryDraft.of();
+    }
   }
 
   private InventoryReferenceResolutionUtils() {}
diff --git a/src/main/java/com/commercetools/sync/products/ProductSync.java b/src/main/java/com/commercetools/sync/products/ProductSync.java
@@ -258,7 +258,7 @@ private CompletionStage<Void> syncOrKeepTrack(
                   final Set<String> missingReferencedProductKeys =
                       getMissingReferencedProductKeys(newDraft, keyToIdCache);
 
-                  boolean selfReferenceExists =
+                  final boolean selfReferenceExists =
                       missingReferencedProductKeys.remove(newDraft.getKey());
 
                   if (!missingReferencedProductKeys.isEmpty()) {
diff --git a/src/main/java/com/commercetools/sync/products/utils/PriceUtils.java b/src/main/java/com/commercetools/sync/products/utils/PriceUtils.java
@@ -67,15 +67,7 @@ private static ChannelResourceIdentifier createChannelResourceIdentifier(
           getResourceIdentifierWithKey(
               channelReference,
               referenceIdToKeyCache,
-              (id, key) -> {
-                final ChannelResourceIdentifierBuilder builder =
-                    ChannelResourceIdentifierBuilder.of();
-                if (id == null) {
-                  return builder.key(key).build();
-                } else {
-                  return builder.id(id).build();
-                }
-              });
+              (id, key) -> ChannelResourceIdentifierBuilder.of().key(key).id(id).build());
     } else if (channelReference != null) {
       channelResourceIdentifier =
           ChannelResourceIdentifierBuilder.of().id(channelReference.getId()).build();
diff --git a/src/main/java/com/commercetools/sync/products/utils/ProductReferenceResolutionUtils.java b/src/main/java/com/commercetools/sync/products/utils/ProductReferenceResolutionUtils.java
@@ -149,41 +149,19 @@ public static List<ProductDraft> mapToProductDrafts(
                   getResourceIdentifierWithKey(
                       product.getProductType(),
                       referenceIdToKeyCache,
-                      (id, key) -> {
-                        final ProductTypeResourceIdentifierBuilder builder =
-                            ProductTypeResourceIdentifierBuilder.of();
-                        if (id == null) {
-                          return builder.key(key).build();
-                        } else {
-                          return builder.id(id).build();
-                        }
-                      });
+                      (id, key) ->
+                          ProductTypeResourceIdentifierBuilder.of().id(id).key(key).build());
               final TaxCategoryResourceIdentifier taxCategoryResourceIdentifier =
                   getResourceIdentifierWithKey(
                       product.getTaxCategory(),
                       referenceIdToKeyCache,
-                      (id, key) -> {
-                        final TaxCategoryResourceIdentifierBuilder builder =
-                            TaxCategoryResourceIdentifierBuilder.of();
-                        if (id == null) {
-                          return builder.key(key).build();
-                        } else {
-                          return builder.id(id).build();
-                        }
-                      });
+                      (id, key) ->
+                          TaxCategoryResourceIdentifierBuilder.of().key(key).id(id).build());
               final StateResourceIdentifier stateResourceIdentifier =
                   getResourceIdentifierWithKey(
                       product.getState(),
                       referenceIdToKeyCache,
-                      (id, key) -> {
-                        final StateResourceIdentifierBuilder builder =
-                            StateResourceIdentifierBuilder.of();
-                        if (id == null) {
-                          return builder.key(key).build();
-                        } else {
-                          return builder.id(id).build();
-                        }
-                      });
+                      (id, key) -> StateResourceIdentifierBuilder.of().key(key).id(id).build());
               return productDraftBuilder
                   .masterVariant(masterVariantDraftWithKeys)
                   .variants(variantDraftsWithKeys)
diff --git a/src/main/java/com/commercetools/sync/states/utils/StateReferenceResolutionUtils.java b/src/main/java/com/commercetools/sync/states/utils/StateReferenceResolutionUtils.java
@@ -65,19 +65,37 @@ public static List<StateDraft> mapToStateDrafts(
             state -> {
               final List<StateResourceIdentifier> newTransitions =
                   replaceTransitionIdsWithKeys(state, referenceIdToKeyCache);
-              return StateDraftBuilder.of()
-                  .key(state.getKey())
-                  .type(state.getType())
-                  .name(state.getName())
-                  .description(state.getDescription())
-                  .initial(state.getInitial())
-                  .roles(state.getRoles())
-                  .transitions(newTransitions)
-                  .build();
+              return getStateDraft(state, newTransitions);
             })
         .collect(Collectors.toList());
   }
 
+  /**
+   * Creates a new {@link StateDraft} from given {@link State} and transitions as {@link
+   * java.util.List}&lt; {@link StateResourceIdentifier}&gt;
+   *
+   * @param state - template state to build the draft from
+   * @param newTransitions - transformed list of state resource identifiers
+   * @return a new {@link StateDraft} with all fields copied from the {@param state} and transitions
+   *     set {@param newTransitions} - it will return empty StateDraft if key or type are missing.
+   */
+  private static StateDraft getStateDraft(
+      State state, List<StateResourceIdentifier> newTransitions) {
+    if (state.getKey() != null && state.getType() != null) {
+      return StateDraftBuilder.of()
+          .key(state.getKey())
+          .type(state.getType())
+          .name(state.getName())
+          .description(state.getDescription())
+          .initial(state.getInitial())
+          .roles(state.getRoles())
+          .transitions(newTransitions)
+          .build();
+    } else {
+      return StateDraft.of();
+    }
+  }
+
   @SuppressWarnings("PMD.ReturnEmptyCollectionRatherThanNull")
   private static List<StateResourceIdentifier> replaceTransitionIdsWithKeys(
       @Nonnull final State state, @Nonnull final ReferenceIdToKeyCache referenceIdToKeyCache) {
diff --git a/src/test/java/com/commercetools/sync/commons/utils/SyncUtilsTest.java b/src/test/java/com/commercetools/sync/commons/utils/SyncUtilsTest.java
@@ -1,5 +1,6 @@
 package com.commercetools.sync.commons.utils;
 
+import static com.commercetools.sync.services.impl.BaseTransformServiceImpl.KEY_IS_NOT_SET_PLACE_HOLDER;
 import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -161,4 +162,40 @@ void getResourceIdentifierWithKey_WithNullReference_ShouldReturnNull() {
             (id, key) -> CategoryResourceIdentifierBuilder.of().id(id).key(key).build());
     assertThat(resourceIdentifier).isNull();
   }
+
+  @Test
+  void getResourceIdentifierWithKey_WithNotCachedReference_ShouldReturnResourceIdentifierWithId() {
+    final String categoryId = UUID.randomUUID().toString();
+
+    final CategoryReference categoryReference =
+        CategoryReferenceBuilder.of().id(categoryId).build();
+
+    final CategoryResourceIdentifier resourceIdentifier =
+        SyncUtils.getResourceIdentifierWithKey(
+            categoryReference,
+            referenceIdToKeyCache,
+            (id, key) -> CategoryResourceIdentifierBuilder.of().id(id).key(key).build());
+
+    assertThat(resourceIdentifier).isNotNull();
+    assertThat(resourceIdentifier.getId()).isEqualTo(categoryId);
+  }
+
+  @Test
+  void
+      getResourceIdentifierWithKey_WithCachedReferenceIsEmptyPlaceholder_ShouldReturnResourceIdentifierWithKeyPlaceholder() {
+    final String categoryId = UUID.randomUUID().toString();
+    referenceIdToKeyCache.add(categoryId, KEY_IS_NOT_SET_PLACE_HOLDER);
+
+    final CategoryReference categoryReference =
+        CategoryReferenceBuilder.of().id(categoryId).build();
+
+    final CategoryResourceIdentifier resourceIdentifier =
+        SyncUtils.getResourceIdentifierWithKey(
+            categoryReference,
+            referenceIdToKeyCache,
+            (id, key) -> CategoryResourceIdentifierBuilder.of().id(id).key(key).build());
+
+    assertThat(resourceIdentifier).isNotNull();
+    assertThat(resourceIdentifier.getKey()).isEqualTo(KEY_IS_NOT_SET_PLACE_HOLDER);
+  }
 }
diff --git a/src/test/java/com/commercetools/sync/inventories/utils/InventoryReferenceResolutionUtilsTest.java b/src/test/java/com/commercetools/sync/inventories/utils/InventoryReferenceResolutionUtilsTest.java
@@ -125,4 +125,33 @@ void mapToInventoryEntryDrafts_WithNullReferences_ShouldNotReturnResourceIdentif
       assertThat(referenceReplacedDraft.getSupplyChannel()).isNull();
     }
   }
+
+  @Test
+  void mapToInventoryEntryDrafts_WithMissingRequiredFields_ShouldNotFailAndReturnEmptyDraft() {
+    // preparation
+    final InventoryEntry mockInventory = mock(InventoryEntry.class);
+    when(mockInventory.getQuantityOnStock()).thenReturn(null);
+
+    // asserts
+    assertThat(
+            InventoryReferenceResolutionUtils.mapToInventoryEntryDrafts(
+                    List.of(mockInventory), referenceIdToKeyCache)
+                .get(0))
+        .isEqualTo(InventoryEntryDraft.of());
+
+    when(mockInventory.getSku()).thenReturn("Any sku");
+    assertThat(
+            InventoryReferenceResolutionUtils.mapToInventoryEntryDrafts(
+                    List.of(mockInventory), referenceIdToKeyCache)
+                .get(0))
+        .isEqualTo(InventoryEntryDraft.of());
+
+    when(mockInventory.getSku()).thenReturn(null);
+    when(mockInventory.getQuantityOnStock()).thenReturn(1L);
+    assertThat(
+            InventoryReferenceResolutionUtils.mapToInventoryEntryDrafts(
+                    List.of(mockInventory), referenceIdToKeyCache)
+                .get(0))
+        .isEqualTo(InventoryEntryDraft.of());
+  }
 }
diff --git a/src/test/java/com/commercetools/sync/products/utils/ProductTransformUtilsTest.java b/src/test/java/com/commercetools/sync/products/utils/ProductTransformUtilsTest.java
diff --git a/src/test/java/com/commercetools/sync/states/utils/StateReferenceResolutionUtilsTest.java b/src/test/java/com/commercetools/sync/states/utils/StateReferenceResolutionUtilsTest.java

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ ResourceIdentifierT getResourceIdentifierWithKey(`
`70`	`70`	`@Nullable final String key,`
`71`	`71`	`final BiFunction<String, String, ResourceIdentifierT> toResourceIdentifier) {`
`72`	`72`
`73`		`- if (!StringUtils.isEmpty(key)) {`
	`73`	`+ if (!StringUtils.isBlank(key)) {`
`74`	`74`	`return toResourceIdentifier.apply(null, key);`
`75`	`75`	`}`
`76`	`76`	`return toResourceIdentifier.apply(id, null);`