From b7e893fde98debd74f6f3eb9ad3076903c62fe7a Mon Sep 17 00:00:00 2001
From: Dilyan Damyanov <dilyand@gmail.com>
Date: Wed, 16 Sep 2020 10:22:56 +0100
Subject: [PATCH] Common: fix PiiPseudonymizerEnrichment for arrays and improve
 unit tests coverage (close #334)

---
 .../enrichments/EnrichmentManagerSpec.scala   | 128 ++++++++++++++++++
 1 file changed, 128 insertions(+)

diff --git a/modules/common/src/test/scala/com.snowplowanalytics.snowplow.enrich.common/enrichments/EnrichmentManagerSpec.scala b/modules/common/src/test/scala/com.snowplowanalytics.snowplow.enrich.common/enrichments/EnrichmentManagerSpec.scala
index 6a819ebde..1db0ef363 100644
--- a/modules/common/src/test/scala/com.snowplowanalytics.snowplow.enrich.common/enrichments/EnrichmentManagerSpec.scala
+++ b/modules/common/src/test/scala/com.snowplowanalytics.snowplow.enrich.common/enrichments/EnrichmentManagerSpec.scala
@@ -449,6 +449,134 @@ class EnrichmentManagerSpec extends Specification with EitherMatchers {
       enriched.value must beLeft
     }
 
+    "fail to emit an EnrichedEvent if a context PII value that needs to be hashed is an empty object" >> {
+      val parameters = Map(
+        "e" -> "ue",
+        "tv" -> "js-0.13.1",
+        "p" -> "web",
+        "co" -> """
+          {
+            "schema": "iglu:com.snowplowanalytics.snowplow/contexts/jsonschema/1-0-0",
+            "data": [
+              {
+                "schema":"iglu:com.acme/email_sent/jsonschema/1-0-0",
+                "data": {
+                  "emailAddress": "hello@world.com",
+                  "emailAddress2": "foo@bar.org",
+                  "emailAddress3": {}
+                }
+              }
+            ]
+          }
+        """,
+        "ue_pr" -> """
+          {
+            "schema":"iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0",
+            "data":{
+              "schema":"iglu:com.acme/email_sent/jsonschema/1-0-0",
+              "data": {
+                "emailAddress": "hello@world.com",
+                "emailAddress2": "foo@bar.org"
+              }
+            }
+          }"""
+      )
+      val rawEvent = RawEvent(api, parameters, None, source, context)
+      val enrichmentReg = EnrichmentRegistry[Id](
+        piiPseudonymizer = PiiPseudonymizerEnrichment(
+          List(
+            PiiJson(
+              fieldMutator = JsonMutators("contexts"),
+              schemaCriterion = SchemaCriterion("com.acme", "email_sent", "jsonschema", 1, 0, 0),
+              jsonPath = "$.emailAddress3"
+            )
+          ),
+          false,
+          PiiStrategyPseudonymize(
+            "MD5",
+            hashFunction = DigestUtils.sha256Hex(_: Array[Byte]),
+            "pepper123"
+          )
+        ).some
+      )
+      def enriched =
+        EnrichmentManager.enrichEvent(
+          enrichmentReg,
+          client,
+          processor,
+          timestamp,
+          rawEvent
+        )
+      enriched.value must beLeft
+    }
+
+    "fail to emit an EnrichedEvent if a PII value needs to be hashed in both co and ue and is invalid in one of them" >> {
+      val parameters = Map(
+        "e" -> "ue",
+        "tv" -> "js-0.13.1",
+        "p" -> "web",
+        "co" -> """
+          {
+            "schema": "iglu:com.snowplowanalytics.snowplow/contexts/jsonschema/1-0-0",
+            "data": [
+              {
+                "schema":"iglu:com.acme/email_sent/jsonschema/1-0-0",
+                "data": {
+                  "emailAddress": "hello@world.com",
+                  "emailAddress2": "foo@bar.org",
+                  "emailAddress3": {}
+                }
+              }
+            ]
+          }
+        """,
+        "ue_pr" -> """
+          {
+            "schema":"iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0",
+            "data":{
+              "schema":"iglu:com.acme/email_sent/jsonschema/1-0-0",
+              "data": {
+                "emailAddress": "hello@world.com",
+                "emailAddress2": "foo@bar.org",
+                "emailAddress3": ""
+              }
+            }
+          }"""
+      )
+      val rawEvent = RawEvent(api, parameters, None, source, context)
+      val enrichmentReg = EnrichmentRegistry[Id](
+        piiPseudonymizer = PiiPseudonymizerEnrichment(
+          List(
+            PiiJson(
+              fieldMutator = JsonMutators("contexts"),
+              schemaCriterion = SchemaCriterion("com.acme", "email_sent", "jsonschema", 1, 0, 0),
+              jsonPath = "$.emailAddress3"
+            ),
+            PiiJson(
+              fieldMutator = JsonMutators("unstruct_event"),
+              schemaCriterion = SchemaCriterion("com.acme", "email_sent", "jsonschema", 1, 0, 0),
+              jsonPath = "$.emailAddress3"
+            )
+          ),
+          false,
+          PiiStrategyPseudonymize(
+            "MD5",
+            hashFunction = DigestUtils.sha256Hex(_: Array[Byte]),
+            "pepper123"
+          )
+        ).some
+      )
+      def enriched =
+        EnrichmentManager.enrichEvent(
+          enrichmentReg,
+          client,
+          processor,
+          timestamp,
+          rawEvent
+        )
+      enriched.value must beLeft
+    }
+
     "have a preference of 'ua' query string parameter over user agent of HTTP header" >> {
       val qs_ua = "Mozilla/5.0 (X11; Linux x86_64; rv:75.0) Gecko/20100101 Firefox/75.0"
       val parameters = Map(