added type information to serializable classes (#109)

* added type information to serializable classes * snapshot version bump Co-authored-by: Paul Latzelsperger <[email protected]>
microsoft · Jul 20, 2021 · 5e00144 · 5e00144
1 parent 2b7b4c3
commit 5e00144
Show file tree

Hide file tree

Showing 11 changed files with 120 additions and 24 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -34,7 +34,7 @@ allprojects {
     apply(plugin = "maven-publish")
     pluginManager.withPlugin("java-library") {
         group = "com.microsoft"
-        version = "0.0.1-SNAPSHOT.1"
+        version = "0.0.1-SNAPSHOT.2"
         dependencies {
             api("org.jetbrains:annotations:${jetBrainsAnnotationsVersion}")
             api("com.fasterxml.jackson.core:jackson-core:${jacksonVersion}")

diff --git a/.../com/microsoft/dagx/transfer/provision/azure/blob/ObjectContainerProvisionedResource.java b/.../com/microsoft/dagx/transfer/provision/azure/blob/ObjectContainerProvisionedResource.java
@@ -8,15 +8,16 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
 import com.microsoft.dagx.schema.azure.AzureBlobStoreSchema;
 import com.microsoft.dagx.spi.types.domain.transfer.DataAddress;
 import com.microsoft.dagx.spi.types.domain.transfer.ProvisionedDataDestinationResource;
 import com.microsoft.dagx.spi.types.domain.transfer.ProvisionedResource;
 
-/**
- *
- */
+@JsonDeserialize(builder = ObjectContainerProvisionedResource.Builder.class)
+@JsonTypeName("dagx:objectcontainerprovisionedresource")
 public class ObjectContainerProvisionedResource extends ProvisionedDataDestinationResource {
 
     @JsonProperty

diff --git a/.../microsoft/dagx/transfer/provision/azure/blob/ObjectContainerProvisionedResourceTest.java b/.../microsoft/dagx/transfer/provision/azure/blob/ObjectContainerProvisionedResourceTest.java
@@ -59,7 +59,7 @@ void verifySerialization() {
 
     @Test
     void verifyDeserialization() {
-        final String json = "{\"id\":\"test-id\",\"transferProcessId\":\"test-process-id\",\"resourceDefinitionId\":\"test-resdef-id\",\"error\":false,\"errorMessage\":null,\"accountName\":\"test-account\",\"containerName\":\"test-container\",\"resourceName\":\"test-container\"}";
+        final String json = "{\"id\":\"test-id\",\"dagxtype\":\"dagx:objectcontainerprovisionedresource\", \"transferProcessId\":\"test-process-id\",\"resourceDefinitionId\":\"test-resdef-id\",\"error\":false,\"errorMessage\":null,\"accountName\":\"test-account\",\"containerName\":\"test-container\",\"resourceName\":\"test-container\"}";
         var typeManager = new TypeManager();
         typeManager.registerTypes(ObjectContainerProvisionedResource.class);
 

diff --git a/...java/com/microsoft/dagx/spi/types/domain/transfer/ProvisionedDataDestinationResource.java b/...java/com/microsoft/dagx/spi/types/domain/transfer/ProvisionedDataDestinationResource.java
@@ -5,9 +5,15 @@
 
 package com.microsoft.dagx.spi.types.domain.transfer;
 
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
 /**
  * A provisioned resource that serves as a data destination.
  */
+@JsonTypeName("dagx:provisioneddatadestinationresource")
+@JsonDeserialize(builder = ProvisionedDataDestinationResource.Builder.class)
 public abstract class ProvisionedDataDestinationResource extends ProvisionedResource {
 
     protected ProvisionedDataDestinationResource() {
@@ -18,6 +24,7 @@ protected ProvisionedDataDestinationResource() {
 
     public abstract String getResourceName();
 
+    @JsonPOJOBuilder(withPrefix = "")
     protected static class Builder<PR extends ProvisionedResource, B extends ProvisionedResource.Builder<PR, B>> extends ProvisionedResource.Builder<PR, B> {
 
         protected Builder(PR resource) {

diff --git a/spi/src/main/java/com/microsoft/dagx/spi/types/domain/transfer/ProvisionedResource.java b/spi/src/main/java/com/microsoft/dagx/spi/types/domain/transfer/ProvisionedResource.java
@@ -5,14 +5,20 @@
 
 package com.microsoft.dagx.spi.types.domain.transfer;
 
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+import com.microsoft.dagx.spi.types.domain.Polymorphic;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Objects;
 
 /**
  * A provisioned resource that supports a data transfer request.
  */
-public abstract class ProvisionedResource {
+@JsonTypeName("dagx:provisionedresource")
+@JsonDeserialize(builder = ProvisionedResource.Builder.class)
+public abstract class ProvisionedResource implements Polymorphic {
     protected String id;
     protected String transferProcessId;
     protected String resourceDefinitionId;
@@ -46,6 +52,7 @@ public String getErrorMessage() {
     }
 
 
+    @JsonPOJOBuilder
     @SuppressWarnings("unchecked")
     public static class Builder<PR extends ProvisionedResource, B extends Builder<PR, B>> {
         protected PR provisionedResource;

diff --git a/spi/src/main/java/com/microsoft/dagx/spi/types/domain/transfer/ResourceDefinition.java b/spi/src/main/java/com/microsoft/dagx/spi/types/domain/transfer/ResourceDefinition.java
@@ -5,12 +5,19 @@
 
 package com.microsoft.dagx.spi.types.domain.transfer;
 
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+import com.microsoft.dagx.spi.types.domain.Polymorphic;
+
 import java.util.Objects;
 
 /**
  * A resource to be provisioned to support a data transfer.
  */
-public abstract class ResourceDefinition {
+@JsonTypeName("dagx:resourcedefinition")
+@JsonDeserialize(builder = ResourceDefinition.Builder.class)
+public abstract class ResourceDefinition implements Polymorphic {
     protected String id;
     protected String transferProcessId;
 
@@ -26,6 +33,7 @@ void setTransferProcessId(String transferProcessId) {
         this.transferProcessId = transferProcessId;
     }
 
+    @JsonPOJOBuilder
     @SuppressWarnings("unchecked")
     public static class Builder<RD extends ResourceDefinition, B extends Builder<RD, B>> {
         protected final RD resourceDefinition;

diff --git a/spi/src/main/java/com/microsoft/dagx/spi/types/domain/transfer/TransferType.java b/spi/src/main/java/com/microsoft/dagx/spi/types/domain/transfer/TransferType.java
@@ -7,6 +7,7 @@
 package com.microsoft.dagx.spi.types.domain.transfer;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
 
@@ -18,10 +19,12 @@ public class TransferType {
     private String contentType = DEFAULT_CONTENT_TYPE;
     private boolean isFinite = true;
 
+    @JsonProperty("contentType")
     public String getContentType() {
         return contentType;
     }
 
+    @JsonProperty("isFinite")
     public boolean isFinite() {
         return isFinite;
     }

diff --git a/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/ProvisionedResourceTest.java b/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/ProvisionedResourceTest.java
@@ -14,9 +14,6 @@
 
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
-/**
- *
- */
 class ProvisionedResourceTest {
 
     @Test

diff --git a/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/TestProvisionedResource.java b/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/TestProvisionedResource.java
@@ -5,18 +5,24 @@
 
 package com.microsoft.dagx.spi.types.domain.transfer;
 
-/**
- *
- */
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+@JsonDeserialize(builder = TestProvisionedResource.Builder.class)
+@JsonTypeName("dagx:testprovisionedresource")
 class TestProvisionedResource extends ProvisionedResource {
 
+    @JsonPOJOBuilder(withPrefix = "")
     public static class Builder extends ProvisionedResource.Builder<TestProvisionedResource, Builder> {
-        public static Builder newInstance() {
-            return new Builder();
-        }
-
         private Builder() {
             super(new TestProvisionedResource());
         }
+
+        @JsonCreator
+        public static Builder newInstance() {
+            return new Builder();
+        }
     }
 }
diff --git a/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/TestResourceDefinition.java b/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/TestResourceDefinition.java
@@ -5,18 +5,24 @@
 
 package com.microsoft.dagx.spi.types.domain.transfer;
 
-/**
- *
- */
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+@JsonTypeName("dagx:testresourcedefinition")
+@JsonDeserialize(builder = TestResourceDefinition.Builder.class)
 class TestResourceDefinition extends ResourceDefinition {
 
+    @JsonPOJOBuilder(withPrefix = "")
     public static class Builder extends ResourceDefinition.Builder<TestResourceDefinition, Builder> {
-        public static Builder newInstance() {
-            return new Builder();
-        }
-
         private Builder() {
             super(new TestResourceDefinition());
         }
+
+        @JsonCreator
+        public static Builder newInstance() {
+            return new Builder();
+        }
     }
 }
diff --git a/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/TransferTypeTest.java b/spi/src/test/java/com/microsoft/dagx/spi/types/domain/transfer/TransferTypeTest.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ *  All rights reserved.
+ *
+ */
+
+package com.microsoft.dagx.spi.types.domain.transfer;
+
+import com.microsoft.dagx.spi.types.TypeManager;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class TransferTypeTest {
+
+    private TypeManager tm;
+
+    @BeforeEach
+    void setup() {
+        tm = new TypeManager();
+        tm.registerTypes(TransferType.class);
+    }
+
+    @Test
+    void verifySerialization() {
+        var tt = TransferType.Builder.transferType()
+                .isFinite(false)
+                .contentType("someContentType")
+                .build();
+
+        var json = tm.writeValueAsString(tt);
+
+        assertThat(json).contains("\"contentType\":\"someContentType\"");
+        assertThat(json).contains("\"isFinite\":false");
+        //noinspection unchecked
+        final Map<String, Object> map = (Map<String, Object>) tm.readValue(json, Map.class);
+        assertThat(map).hasSize(2);
+        assertThat(map).containsKey("contentType");
+        assertThat(map).containsKey("isFinite");
+        assertThat(map).doesNotContainKey("dagxtype");
+    }
+
+    @Test
+    void verifyDeserialization() {
+        var tt = TransferType.Builder.transferType()
+                .isFinite(false)
+                .contentType("someContentType")
+                .build();
+
+        var json = tm.writeValueAsString(tt);
+
+        var restored = tm.readValue(json, TransferType.class);
+        assertThat(restored).usingRecursiveComparison().isEqualTo(tt);
+        assertThat(restored.isFinite()).isFalse();
+        assertThat(restored.getContentType()).isEqualTo("someContentType");
+    }
+
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,9 +14,6 @@ @@
     import static org.junit.jupiter.api.Assertions.assertNotNull;
-    /**
-     *
-     */
     class ProvisionedResourceTest {
         @Test
@@ Expand Down @@