Common: add tests for required property that is explicitly set to null (

close #628)
snowplow · Jun 23, 2022 · c9e3748 · c9e3748
1 parent 048f1c3
commit c9e3748
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 8 deletions.
diff --git a/...c/test/scala/com.snowplowanalytics.snowplow.enrich.common/enrichments/TransformSpec.scala b/...c/test/scala/com.snowplowanalytics.snowplow.enrich.common/enrichments/TransformSpec.scala
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2014-2022 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+package com.snowplowanalytics.snowplow.enrich.common.enrichments
+
+import cats.syntax.option._
+
+import com.snowplowanalytics.snowplow.enrich.common.adapters.RawEvent
+import com.snowplowanalytics.snowplow.enrich.common.loaders.CollectorPayload
+import com.snowplowanalytics.snowplow.enrich.common.outputs.EnrichedEvent
+import com.snowplowanalytics.snowplow.enrich.common.SpecHelpers.MapOps
+
+import org.specs2.mutable.Specification
+
+class TransformSpec extends Specification {
+  "transform should not drop properties with explicit null values" >> {
+    val ApplicationJsonWithCapitalCharset = "application/json; charset=UTF-8"
+    val raw = RawEvent(
+      CollectorPayload.Api("com.snowplowanalytics.snowplow", "tp2"),
+      Map(
+        "tv" -> "0",
+        "p" -> "web",
+        "e" -> "pv",
+        "nuid" -> "123",
+        "cx" -> "ewogICJzY2hlbWEiOiAiaWdsdTpjb20uc25vd3Bsb3dhbmFseXRpY3Muc25vd3Bsb3cvY29udGV4dHMvanNvbnNjaGVtYS8xLTAtMCIsCiAgImRhdGEiOiBbCiAgICB7CiAgICAgICJzY2hlbWEiOiAiaWdsdTpjb20uc25vd3Bsb3dhbmFseXRpY3Muc25vd3Bsb3cvY2xpZW50X3Nlc3Npb24vanNvbnNjaGVtYS8xLTAtMSIsCiAgICAgICJkYXRhIjogewogICAgICAgICJzZXNzaW9uSW5kZXgiOiAxLAogICAgICAgICJzdG9yYWdlTWVjaGFuaXNtIjogIkxPQ0FMX1NUT1JBR0UiLAogICAgICAgICJmaXJzdEV2ZW50SWQiOiAiNWMzM2ZjY2YtNmJlNS00Y2U2LWFmYjEtZTM0MDI2YTNjYTc1IiwKICAgICAgICAic2Vzc2lvbklkIjogIjIxYzJhMGRkLTg5MmQtNDJkMS1iMTU2LTNhOWQ0ZTE0N2VlZiIsCiAgICAgICAgInByZXZpb3VzU2Vzc2lvbklkIjogbnVsbCwKICAgICAgICAidXNlcklkIjogIjIwZDYzMWI4LTc4MzctNDlkZi1hNzNlLTZkYTczMTU0ZTZmZCIKICAgICAgfQogICAgfQogIF0KfQ=="
+      ).toOpt,
+      ApplicationJsonWithCapitalCharset.some,
+      CollectorPayload.Source("source", "UTF-8", None),
+      CollectorPayload.Context(None, None, None, None, Nil, None)
+    )
+
+    val enriched = new EnrichedEvent
+    Transform.transform(raw, enriched)
+
+    enriched.contexts mustEqual """{"schema":"iglu:com.snowplowanalytics.snowplow/contexts/jsonschema/1-0-0","data":[{"schema":"iglu:com.snowplowanalytics.snowplow/client_session/jsonschema/1-0-1","data":{"sessionIndex":1,"storageMechanism":"LOCAL_STORAGE","firstEventId":"5c33fccf-6be5-4ce6-afb1-e34026a3ca75","sessionId":"21c2a0dd-892d-42d1-b156-3a9d4e147eef","previousSessionId":null,"userId":"20d631b8-7837-49df-a73e-6da73154e6fd"}}]}"""
+  }
+}
diff --git a/...mon/src/test/scala/com.snowplowanalytics.snowplow.enrich.common/utils/IgluUtilsSpec.scala b/...mon/src/test/scala/com.snowplowanalytics.snowplow.enrich.common/utils/IgluUtilsSpec.scala
@@ -21,6 +21,7 @@ import com.snowplowanalytics.iglu.client.ClientError.{ResolutionError, Validatio
 import com.snowplowanalytics.snowplow.badrows._
 
 import io.circe.Json
+import io.circe.parser._
 
 import cats.data.NonEmptyList
 
@@ -92,16 +93,17 @@ class IgluUtilsSpec extends Specification with ValidatedMatchers {
       "emailAddress": "[email protected]"
     }
   }"""
+  val clientSessionData = s"""{
+     "sessionIndex": 1,
+     "storageMechanism": "LOCAL_STORAGE",
+     "firstEventId": "5c33fccf-6be5-4ce6-afb1-e34026a3ca75",
+     "sessionId": "21c2a0dd-892d-42d1-b156-3a9d4e147eef",
+     "previousSessionId": null,
+     "userId": "20d631b8-7837-49df-a73e-6da73154e6fd"
+  }"""
   val clientSession = s"""{
     "schema": "${clientSessionSchema.toSchemaUri}",
-    "data": {
-      "sessionIndex": 1,
-      "storageMechanism": "LOCAL_STORAGE",
-      "firstEventId": "5c33fccf-6be5-4ce6-afb1-e34026a3ca75",
-      "sessionId": "21c2a0dd-892d-42d1-b156-3a9d4e147eef",
-      "previousSessionId": null,
-      "userId": "20d631b8-7837-49df-a73e-6da73154e6fd"
-    }
+    "data": $clientSessionData
   }"""
   val noSchema =
     """{"schema":"iglu:com.snowplowanalytics.snowplow/foo/jsonschema/1-0-0", "data": {}}"""
@@ -515,6 +517,17 @@ class IgluUtilsSpec extends Specification with ValidatedMatchers {
           )
       }
     }
+
+    "return the extracted input context for an input that has a required property set to null if the schema explicitly allows it" >> {
+      val input = new EnrichedEvent
+      input.setContexts(buildInputContexts(List(clientSession)))
+
+      val csd = parse(clientSessionData).getOrElse("")
+
+      IgluUtils.extractAndValidateInputJsons(input, SpecHelpers.client, raw, processor).value must beRight(
+        (List(SelfDescribingData(clientSessionSchema, csd)), None)
+      )
+    }
   }
 
   def buildUnstruct(sdj: String) =