fix: checking the state of a database with a binary field.

src/Testing/TableTestState.php

@@ -18,6 +18,17 @@ class TableTestState extends Assert
     protected ?string $connectionName;
     protected Collection $state;
     protected string $uniqueKey;
+    protected ?array $binaryColumns = null;
+
+    protected const array BINARY_COLUMNS = [
+        'bytea',
+        'blob',
+        'tinyblob',
+        'mediumblob',
+        'longblob',
+        'binary',
+        'varbinary',
+    ];
 
     public function __construct(
         string $tableName,
@@ -91,7 +102,11 @@ protected function prepareChanges(array $changes): array
 
         return array_map(function ($item) use ($jsonFields) {
             foreach ($jsonFields as $jsonField) {
-                if (Arr::has($item, $jsonField)) {
+                $shouldDecode = Arr::has($item, $jsonField)
+                    && is_string($item[$jsonField])
+                    && json_validate($item[$jsonField]);
+
+                if ($shouldDecode) {
                     $item[$jsonField] = json_decode($item[$jsonField], true);
                 }
             }
@@ -111,10 +126,64 @@ protected function getFixturePath(string $fixtureName): string
 
     protected function getDataSet(string $table, string $orderField = 'id'): Collection
     {
-        return DB::connection($this->connectionName)
+        $dataSet = DB::connection($this->connectionName)
             ->table($table)
             ->orderBy($orderField)
             ->get()
             ->map(fn ($record) => (array) $record);
+
+        $this->prepareBinaryFields($dataSet);
+
+        return $dataSet;
+    }
+
+    protected function prepareBinaryFields(Collection $dataSet): void
+    {
+        $this->binaryColumns ??= $this->getBinaryColumns();
+
+        $dataSet->transform(function (array $record) {
+            array_walk($record, function (mixed &$value, string $field) {
+                if (!is_null($value) && in_array($field, $this->binaryColumns)) {
+                    $value = is_resource($value) ? bin2hex(stream_get_contents($value)) : bin2hex($value);
+                }
+            });
+
+            return $record;
+        });
+    }
+
+    protected function getBinaryColumns(): array
+    {
+        $connection = DB::connection($this->connectionName);
+
+        $tableSchema = $this->getTableSchema($connection->getDriverName(), $connection->getDatabaseName());
+
+        return (empty($tableSchema))
+            ? []
+            : $connection
+                ->table('information_schema.columns')
+                ->select('column_name')
+                ->where('table_name', $this->tableName)
+                ->whereIn('table_schema', $tableSchema)
+                ->whereIn('data_type', self::BINARY_COLUMNS)
+                ->get()
+                ->pluck('column_name')
+                ->toArray();
+    }
+
+    protected function getTableSchema(string $driverName, string $databaseName): array
+    {
+        $tableSchema = match ($driverName) {
+            'pgsql' => config("database.connections.{$this->connectionName}.schema")
+                ?? config("database.connections.{$this->connectionName}.search_path", 'public'),
+            'mysql' => $databaseName,
+            default => '',
+        };
+
+        $tableSchema = array_map('trim', explode(',', $tableSchema));
+
+        $tableSchema = array_filter($tableSchema, fn ($schema) => !empty($schema));
+
+        return Arr::wrap($tableSchema);
     }
 }

tests/BaseRequestTest.php

@@ -16,7 +16,7 @@ public function testGetOrderableFields()
     {
         $result = $this->callEncapsulatedMethod(new BaseRequest(), 'getOrderableFields', TestModel::class);
 
-        $expectedResult = 'id,name,json_field,castable_field,*,created_at,updated_at';
+        $expectedResult = 'id,name,json_field,castable_field,cast_binary_field,binary_field,*,created_at,updated_at';
 
         $this->assertEquals($expectedResult, $result);
     }
@@ -30,7 +30,7 @@ public function testGetOrderableFieldsWithAdditionalFields()
 
         $result = $this->callEncapsulatedMethod(new BaseRequest(), 'getOrderableFields', ...$args);
 
-        $expectedResult = 'id,name,json_field,castable_field,*,created_at,updated_at,additional_field_1,additional_field_2';
+        $expectedResult = 'id,name,json_field,castable_field,cast_binary_field,binary_field,*,created_at,updated_at,additional_field_1,additional_field_2';
 
         $this->assertEquals($expectedResult, $result);
     }

tests/ModelTestStateTest.php

@@ -36,7 +36,7 @@ public function testInitialization()
         $jsonFields = $this->getProtectedProperty($reflectionClass, 'jsonFields', $modelTestState);
         $state = $this->getProtectedProperty($reflectionClass, 'state', $modelTestState);
 
-        $this->assertEquals(['json_field', 'castable_field'], $jsonFields);
+        $this->assertEquals(['json_field', 'castable_field', 'cast_binary_field'], $jsonFields);
         $this->assertEquals($originRecords, $state);
     }
 

tests/TableTestStateTest.php

@@ -4,7 +4,9 @@
 
 use PHPUnit\Framework\Attributes\DataProvider;
 use ReflectionClass;
+use RonasIT\Support\Testing\ModelTestState;
 use RonasIT\Support\Testing\TableTestState;
+use RonasIT\Support\Tests\Support\Mock\Models\TestModel;
 use RonasIT\Support\Tests\Support\Traits\TableTestStateMockTrait;
 
 class TableTestStateTest extends TestCase
@@ -102,4 +104,101 @@ public function testAssertChangesWithCustomPrimaryKey()
 
         $modelTestState->assertChangesEqualsFixture('assertion_fixture_primary_key_set');
     }
+
+    public function testAssertChangesCastedBinaryStringMysqlDriver()
+    {
+        $initialDatasetMock = collect([[
+            'id' => 1,
+            'cast_binary_field' => null,
+        ]]);
+
+        $changedDatasetMock = collect([[
+            'id' => 1,
+            'cast_binary_field' => md5('some_string', true),
+        ]]);
+
+        $this->mockGettingDatasetForChanges(
+            responseMock: $changedDatasetMock,
+            initialState: $initialDatasetMock,
+            tableName: 'test_models',
+            binaryColumn: 'cast_binary_field',
+            dbDriver: 'mysql',
+        );
+
+        $modelTestState = new ModelTestState(TestModel::class);
+        $modelTestState->assertChangesEqualsFixture('null_to_binary_string_changes');
+    }
+
+    public function testAssertChangesCastedBinaryToNull()
+    {
+        $initialDatasetMock = collect([[
+            'id' => 1,
+            'cast_binary_field' => md5('some_string', true),
+        ]]);
+
+        $changedDatasetMock = collect([[
+            'id' => 1,
+            'cast_binary_field' => null,
+        ]]);
+
+        $this->mockGettingDatasetForChanges(
+            responseMock: $changedDatasetMock,
+            initialState: $initialDatasetMock,
+            tableName: 'test_models',
+            binaryColumn: 'cast_binary_field',
+        );
+
+        $modelTestState = new ModelTestState(TestModel::class);
+        $modelTestState->assertChangesEqualsFixture('binary_string_to_null_changes');
+    }
+
+    public function testAssertChangesWithPgsqlBinaryFieldAsResource()
+    {
+        $initialDatasetMock = collect([[
+            'id' => 1,
+            'binary_field' => null,
+        ]]);
+
+        $resource = $this->getTestResource();
+
+        $changedDatasetMock = collect([[
+            'id' => 1,
+            'binary_field' => $resource,
+        ]]);
+
+        $this->mockGettingDatasetForChanges(
+            responseMock: $changedDatasetMock,
+            initialState: $initialDatasetMock,
+            tableName: 'test_models',
+            binaryColumn: 'binary_field',
+        );
+
+        $modelTestState = new ModelTestState(TestModel::class);
+
+        $modelTestState->assertChangesEqualsFixture('null_to_binary_resource_changes');
+
+        fclose($resource);
+    }
+
+    public function testAssertChangesWithUnsupportedMysqlDriver()
+    {
+        $initialDatasetMock = collect([[
+            'id' => 1,
+            'name' => 'name',
+        ]]);
+
+        $changedDatasetMock = collect([[
+            'id' => 1,
+            'name' => 'name_changed',
+        ]]);
+
+        $this->mockGettingDatasetForChangesUnsupportedDriver(
+            responseMock: $changedDatasetMock,
+            initialState: $initialDatasetMock,
+            tableName: 'test_models',
+        );
+
+        $modelTestState = new ModelTestState(TestModel::class);
+        $modelTestState->assertChangesEqualsFixture('unsupported_db_driver');
+    }
 }

tests/fixtures/FixturesTraitTest/get_fixture/exists_fixture.json

@@ -1,3 +1,3 @@
 [
     "Test"
-]
+]

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

@@ -0,0 +1,10 @@
+{
+    "updated": [
+        {
+            "id": 1,
+            "cast_binary_field": null
+        }
+    ],
+    "created": [],
+    "deleted": []
+}

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

@@ -0,0 +1,10 @@
+{
+    "updated": [
+        {
+            "id": 1,
+            "binary_field": "31ee76261d87fed8cb9d4c465c48158c"
+        }
+    ],
+    "created": [],
+    "deleted": []
+}

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

@@ -0,0 +1,10 @@
+{
+    "updated": [
+        {
+            "id": 1,
+            "cast_binary_field": "31ee76261d87fed8cb9d4c465c48158c"
+        }
+    ],
+    "created": [],
+    "deleted": []
+}

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

@@ -0,0 +1,10 @@
+{
+    "updated": [],
+    "created": [],
+    "deleted": [
+        {
+            "id": 1,
+            "name": "name"
+        }
+    ]
+}

tests/support/Mock/Casts/BinaryCast.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace RonasIT\Support\Tests\Support\Mock\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+
+class BinaryCast implements CastsAttributes
+{
+    public function get($model, $key, $value, $attributes)
+    {
+        return is_null($value) ? $value : bin2hex($value);
+    }
+
+    public function set($model, $key, $value, $attributes)
+    {
+        return is_null($value) ? $value : md5($value, true);
+    }
+}

tests/support/Mock/Models/TestModel.php

@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
+use RonasIT\Support\Tests\Support\Mock\Casts\BinaryCast;
 use RonasIT\Support\Tests\Support\Mock\Casts\JSONCustomCast;
 use RonasIT\Support\Traits\ModelTrait;
 
@@ -17,11 +18,14 @@ class TestModel extends Model
         'name',
         'json_field',
         'castable_field',
+        'cast_binary_field',
+        'binary_field',
     ];
 
     protected $casts = [
         'json_field' => 'array',
         'castable_field' => JSONCustomCast::class,
+        'cast_binary_field' => BinaryCast::class,
     ];
 
     public function relation(): HasMany