Merge pull request #291 from RonasIT/strict-change-detection-in-TableTestState

fix: strict change detection in TableTestState

Author: DenTray

src/Testing/TableTestState.php

@@ -64,7 +64,12 @@ protected function getChanges(): array
                 $deletedRecords[] = $originItem;
             } else {
                 $updatedItem = $updatedData->get($updatedItemIndex);
-                $changes = array_diff_assoc($updatedItem, $originItem);
+
+                $changes = array_filter(
+                    array: $updatedItem,
+                    callback: fn ($value, $key) => !array_key_exists($key, $originItem) || $value !== $originItem[$key],
+                    mode: ARRAY_FILTER_USE_BOTH,
+                );
 
                 if (!empty($changes)) {
                     $updatedRecords[] = array_merge([$this->uniqueKey => $originItem[$this->uniqueKey]], $changes);

tests/TableTestStateTest.php

@@ -102,4 +102,20 @@ public function testAssertChangesWithCustomPrimaryKey()
 
         $modelTestState->assertChangesEqualsFixture('assertion_fixture_primary_key_set');
     }
+
+    public function testAssertChangesDetectsFalsyToNullTransitions()
+    {
+        $initialDatasetMock = collect($this->getJsonFixture('falsy_to_null_transitions/initial_dataset'));
+        $changedDatasetMock = collect($this->getJsonFixture('falsy_to_null_transitions/changed_dataset'));
+
+        $this->mockGettingDatasetForChanges($changedDatasetMock, $initialDatasetMock, 'test_models', 'name');
+
+        $modelTestState = new TableTestState(
+            tableName: 'test_models',
+            jsonFields: ['json_field', 'castable_field'],
+            uniqueKey: 'name',
+        );
+
+        $modelTestState->assertChangesEqualsFixture('assertion_fixture_falsy_to_null_transitions');
+    }
 }

tests/fixtures/TableTestStateTest/db_changes/test_models/assertion_fixture_falsy_to_null_transitions.json

@@ -0,0 +1,18 @@
+{
+    "updated": [
+        {
+            "name": "name1",
+            "some_flag": false,
+            "some_numeric_value": 0,
+            "some_string_value": ""
+        },
+        {
+            "name": "name2",
+            "some_flag": true,
+            "some_numeric_value": 0,
+            "some_string_value": "value"
+        }
+    ],
+    "created": [],
+    "deleted": []
+}

tests/fixtures/TableTestStateTest/falsy_to_null_transitions/changed_dataset.json

@@ -0,0 +1,32 @@
+[
+  {
+    "name": "name1",
+    "some_flag": false,
+    "some_numeric_value": 0.0,
+    "some_string_value": "",
+    "json_field": "{\"field1\": \"updated_value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "castable_field": "{\"field1\": \"value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "created_at": "2018-10-10 10:10:10",
+    "updated_at": "2018-10-10 10:10:10"
+  },
+  {
+    "name": "name2",
+    "some_flag": true,
+    "some_numeric_value": 0,
+    "some_string_value": "value",
+    "json_field": "{\"field1\": \"added_value\"}",
+    "castable_field": "{\"one\": \"first value\", \"two\": \"second value\"}",
+    "created_at": "2018-10-10 10:10:10",
+    "updated_at": "2018-10-10 10:10:10"
+  },
+  {
+    "name": "name3",
+    "some_flag": null,
+    "some_numeric_value": null,
+    "some_string_value": null,
+    "castable_field": "{}",
+    "json_field": "{}",
+    "created_at": "2018-10-10 10:10:10",
+    "updated_at": "2018-10-10 10:10:10"
+  }
+]

tests/fixtures/TableTestStateTest/falsy_to_null_transitions/initial_dataset.json

@@ -0,0 +1,32 @@
+[
+  {
+    "name": "name1",
+    "some_flag": null,
+    "some_numeric_value": null,
+    "some_string_value": null,
+    "json_field": "{\"field1\": \"updated_value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "castable_field": "{\"field1\": \"value\", \"field2\": [2, 3], \"field3\":  {\"one\": 1, \"two\": 2}}",
+    "created_at": "2018-10-10 10:10:10",
+    "updated_at": "2018-10-10 10:10:10"
+  },
+  {
+    "name": "name2",
+    "some_flag": null,
+    "some_numeric_value": null,
+    "some_string_value": null,
+    "json_field": "{\"field1\": \"added_value\"}",
+    "castable_field": "{\"one\": \"first value\", \"two\": \"second value\"}",
+    "created_at": "2018-10-10 10:10:10",
+    "updated_at": "2018-10-10 10:10:10"
+  },
+  {
+    "name": "name3",
+    "some_flag": null,
+    "some_numeric_value": null,
+    "some_string_value": null,
+    "castable_field": "{}",
+    "json_field": "{}",
+    "created_at": "2018-10-10 10:10:10",
+    "updated_at": "2018-10-10 10:10:10"
+  }
+]