Merge pull request #200 from commercetools/product-sync-note

Validate draft SKUs and cache ids per batch

Author: heshamMassoud

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/commercetools/commercetools-sync-java.svg?branch=master)](https://travis-ci.org/commercetools/commercetools-sync-java)
 [![codecov](https://codecov.io/gh/commercetools/commercetools-sync-java/branch/master/graph/badge.svg)](https://codecov.io/gh/commercetools/commercetools-sync-java)
 [![Download](https://api.bintray.com/packages/commercetools/maven/commercetools-sync-java/images/download.svg) ](https://bintray.com/commercetools/maven/commercetools-sync-java/_latestVersion)
-[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M8/)
+[![Javadoc](http://javadoc-badge.appspot.com/com.commercetools/commercetools-sync-java.svg?label=Javadoc)](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M9/)
 [![Known Vulnerabilities](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646/badge.svg)](https://snyk.io/test/github/commercetools/commercetools-sync-java/4b2e26113d591bda158217c5dc1cf80a88665646)
 
 Java API which exposes utilities for building update actions and automatic syncing of CTP data from external sources 
@@ -21,7 +21,7 @@ Java API which exposes utilities for building update actions and automatic synci
     - [Ivy](#ivy)
 - [Roadmap](#roadmap)
 - [Release Notes](/docs/RELEASE_NOTES.md)
-- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M8/)
+- [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M9/)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 ## Usage
@@ -56,20 +56,20 @@ most popular ones:
 <dependency>
   <groupId>com.commercetools</groupId>
   <artifactId>commercetools-sync-java</artifactId>
-  <version>v1.0.0-M8</version>
+  <version>v1.0.0-M9</version>
 </dependency>
 ````
 #### Gradle
 ````groovy
-implementation 'com.commercetools:commercetools-sync-java:v1.0.0-M8'
+implementation 'com.commercetools:commercetools-sync-java:v1.0.0-M9'
 ````
 #### SBT 
 ````
-libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "v1.0.0-M8"
+libraryDependencies += "com.commercetools" % "commercetools-sync-java" % "v1.0.0-M9"
 ````
 #### Ivy 
 ````xml
-<dependency org="com.commercetools" name="commercetools-sync-java" rev="v1.0.0-M8"/>
+<dependency org="com.commercetools" name="commercetools-sync-java" rev="v1.0.0-M9"/>
 ````
 
 

docs/RELEASE_NOTES.md

@@ -33,6 +33,7 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 
+- [v1.0.0-M9 -  Jan 22, 2018](#v100-m9----jan-22-2018)
 - [v1.0.0-M8 -  Dec 29, 2017](#v100-m8----dec-29-2017)
 - [v1.0.0-M7 -  Dec 15, 2017](#v100-m7----dec-15-2017)
 - [v1.0.0-M6 -  Dec 5, 2017](#v100-m6----dec-5-2017)
@@ -46,19 +47,31 @@
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 <!--
-### v1.0.0-M9 -  Jan 15, 2018
+### v1.0.0-M10 -  Feb 07, 2018
+[Commits](https://github.com/commercetools/commercetools-sync-java/compare/v1.0.0-M9...v1.0.0-M10) |
+[Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M10/) | 
+[Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/v1.0.0-M10)
+-->
+
+### v1.0.0-M9 -  Jan 22, 2018
 [Commits](https://github.com/commercetools/commercetools-sync-java/compare/v1.0.0-M8...v1.0.0-M9) |
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M9/) | 
 [Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/v1.0.0-M9)
 
+**New Features** (1)
+- **Commons** - Added `getSyncOptions` to the `ProductSync`, `CategorySync` and `InventorySync`. [#230](https://github.com/commercetools/commercetools-sync-java/issues/230)
+
+**Changes** (1)
+- **Product Sync** - Added validation for product drafts' SKUs as a required field on the input product drafts since SKUs will be used for product matching in the future. [#230](https://github.com/commercetools/commercetools-sync-java/issues/230)
+
+**Enhancements** (1)
+- **Product Sync** - Changed the product sync to cache product ids per batch as opposed to caching the entire products ids before syncing products. [#230](https://github.com/commercetools/commercetools-sync-java/issues/230) 
 
 **Bug Fixes** (1)
 - **Commons** - Fixed library version in User-Agent headers of JVM SDK clients using the library. Now it is not fetched
  from the JAR manifest but injected by gradle-scripts/set-release-version.gradle. [#227](https://github.com/commercetools/commercetools-sync-java/issues/227)
 
 
--->
-
 ### v1.0.0-M8 -  Dec 29, 2017
 [Commits](https://github.com/commercetools/commercetools-sync-java/compare/v1.0.0-M7...v1.0.0-M8) |
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M8/) | 

docs/usage/PRODUCT_SYNC.md

@@ -24,6 +24,9 @@ Utility which provides API for building CTP product update actions and product s
 1. The sync expects a list of non-null `ProductDraft` objects that have their `key` fields set to match the
 products from the source to the target. Also the target project is expected to have the `key` fields set,
 otherwise they won't be matched.
+
+**NOTE: PLEASE MAKE SURE THE `SKU` FIELDS OF ALL PRODUCTS ARE SET AS THE SYNC LIBRARY WILL BE MIGRATED TO MATCH PRODUCTS BY `SKU` INSTEAD OF `KEY` IN THE FUTURE.**
+
 2. Every product may have several references including `product type`, `categories`, `taxCategory`, etc.. Variants
 of the product also have prices, where each prices also has some references including a reference to the `Type` of its 
 custom fields and a reference to a `channel`. All these referenced resources are matched by their `key` Therefore, in 

src/integration-test/java/com/commercetools/sync/integration/ctpprojectsource/products/ProductSyncIT.java

@@ -315,7 +315,7 @@ public void sync_withProductTypeReference_ShouldUpdateProducts() {
             sourceProductType.toReference())
             .slug(LocalizedString.ofEnglish("newSlug3"))
             .key("productKey3")
-            .masterVariant(ProductVariantDraftBuilder.of().key("v3").build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("v3").sku("s3").build())
             .taxCategory(null)
             .state(null)
             .categories(Collections.emptySet())
@@ -336,6 +336,7 @@ public void sync_withProductTypeReference_ShouldUpdateProducts() {
 
         final ProductVariantDraft masterVariant = ProductVariantDraftBuilder.of()
                                                                             .key("v1")
+                                                                            .sku("s1")
                                                                             .attributes(attributeDrafts).build();
 
         // Create existing product with productKey1 in source project that has references to products with keys

src/integration-test/java/com/commercetools/sync/integration/externalsource/products/ProductSyncIT.java

@@ -345,7 +345,7 @@ public void sync_withMultipleBatchSyncing_ShouldSync() {
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey4")
             .slug(LocalizedString.of(Locale.ENGLISH, "slug4"))
-            .masterVariant(ProductVariantDraftBuilder.of().key("v4").build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("v4").sku("sku4").build())
             .build();
 
         final List<ProductDraft> batch2 = new ArrayList<>();
@@ -359,7 +359,7 @@ public void sync_withMultipleBatchSyncing_ShouldSync() {
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey3")
             .slug(LocalizedString.of(Locale.ENGLISH, "newSlug"))
-            .masterVariant(ProductVariantDraftBuilder.of().key("v3").build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("v3").sku("sku3").build())
             .build();
 
         final List<ProductDraft> batch3 = new ArrayList<>();
@@ -393,7 +393,7 @@ public void sync_withSingleBatchSyncing_ShouldSync() {
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey3")
             .slug(LocalizedString.of(Locale.ENGLISH, "slug3"))
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("mv3").sku("sku3").build())
             .build();
 
         final ProductDraft key4Draft = createProductDraftBuilder(PRODUCT_KEY_2_RESOURCE_PATH,
@@ -404,7 +404,7 @@ public void sync_withSingleBatchSyncing_ShouldSync() {
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey4")
             .slug(LocalizedString.of(Locale.ENGLISH, "slug4"))
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("mv4").sku("sku4").build())
             .build();
 
         final ProductDraft key5Draft = createProductDraftBuilder(PRODUCT_KEY_2_RESOURCE_PATH,
@@ -415,7 +415,7 @@ public void sync_withSingleBatchSyncing_ShouldSync() {
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey5")
             .slug(LocalizedString.of(Locale.ENGLISH, "slug5"))
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("mv5").sku("sku5").build())
             .build();
 
         final ProductDraft key6Draft = createProductDraftBuilder(PRODUCT_KEY_2_RESOURCE_PATH,
@@ -426,7 +426,7 @@ public void sync_withSingleBatchSyncing_ShouldSync() {
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey6")
             .slug(LocalizedString.of(Locale.ENGLISH, "slug6"))
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("mv6").sku("sku6").build())
             .build();
 
         final List<ProductDraft> batch = new ArrayList<>();
@@ -460,7 +460,7 @@ public void sync_withSameSlugInSingleBatch_ShouldNotSyncIt() {
             .categories(new ArrayList<>())
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey3")
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("k3").sku("s3").build())
             .build();
 
         final ProductDraft key4Draft = createProductDraftBuilder(PRODUCT_KEY_2_RESOURCE_PATH,
@@ -470,7 +470,7 @@ public void sync_withSameSlugInSingleBatch_ShouldNotSyncIt() {
             .categories(new ArrayList<>())
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey4")
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("k4").sku("s4").build())
             .build();
 
         final ProductDraft key5Draft = createProductDraftBuilder(PRODUCT_KEY_2_RESOURCE_PATH,
@@ -480,7 +480,7 @@ public void sync_withSameSlugInSingleBatch_ShouldNotSyncIt() {
             .categories(new ArrayList<>())
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey5")
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("k5").sku("s5").build())
             .build();
 
         final ProductDraft key6Draft = createProductDraftBuilder(PRODUCT_KEY_2_RESOURCE_PATH,
@@ -490,7 +490,7 @@ public void sync_withSameSlugInSingleBatch_ShouldNotSyncIt() {
             .categories(new ArrayList<>())
             .categoryOrderHints(CategoryOrderHints.of(new HashMap<>()))
             .key("productKey6")
-            .masterVariant(ProductVariantDraftBuilder.of().build())
+            .masterVariant(ProductVariantDraftBuilder.of().key("k6").sku("s6").build())
             .build();
 
         final List<ProductDraft> batch = new ArrayList<>();
@@ -558,9 +558,9 @@ public void sync_withADraftsWithBlankKeysInBatch_ShouldNotSyncItAndTriggerErrorC
         assertThat(errorCallBackExceptions).hasSize(2);
         assertThat(errorCallBackMessages).hasSize(2);
         assertThat(errorCallBackMessages.get(0))
-            .isEqualToIgnoringCase(format("ProductDraft with name: %s doesn't have a key.", key3Draft.getName()));
+            .containsIgnoringCase(format("ProductDraft with name: %s doesn't have a key.", key3Draft.getName()));
         assertThat(errorCallBackMessages.get(1))
-            .isEqualToIgnoringCase(format("ProductDraft with name: %s doesn't have a key.", key4Draft.getName()));
+            .containsIgnoringCase(format("ProductDraft with name: %s doesn't have a key.", key4Draft.getName()));
         assertThat(warningCallBackMessages).isEmpty();
     }