Display the new column type when logging altered table columns.

Author: prwater

src/Audit/AlterAuditTable.php

@@ -98,7 +98,7 @@ private function compareTable(string $tableName): void
    */
   private function compareTableColumns(TableMetadata $dataTable, TableMetadata $auditTable): void
   {
-    $diff = TableColumnsMetadata::differentColumnTypes($dataTable->getColumns(), $auditTable->getColumns());
+    $diff = TableColumnsMetadata::differentColumnTypes($auditTable->getColumns(), $dataTable->getColumns());
 
     if (!empty($diff->getColumns()))
     {

src/Metadata/TableColumnsMetadata.php

@@ -57,27 +57,27 @@ public static function combine(TableColumnsMetadata $columns1, TableColumnsMetad
 
   //--------------------------------------------------------------------------------------------------------------------
   /**
-   * Compares two lists of table columns and returns a list of  table columns the are in both lists but have different
-   * metadata
+   * Compares two lists of table columns and returns a list of table columns that are in both lists but have different
+   * metadata.
    *
-   * @param TableColumnsMetadata $columns1 The first list of table columns.
-   * @param TableColumnsMetadata $columns2 The second list of table columns.
-   * @param string[]             $ignore   The properties to be ignored.
+   * @param TableColumnsMetadata $oldColumns The old metadata of the table columns.
+   * @param TableColumnsMetadata $newColumns The new metadata of the table columns.
+   * @param string[]             $ignore     The properties to be ignored.
    *
    * @return TableColumnsMetadata
    */
-  public static function differentColumnTypes(TableColumnsMetadata $columns1,
-                                              TableColumnsMetadata $columns2,
-                                              array $ignore = []): TableColumnsMetadata
+  public static function differentColumnTypes(TableColumnsMetadata $oldColumns,
+                                              TableColumnsMetadata $newColumns,
+                                              array                $ignore = []): TableColumnsMetadata
   {
     $diff = new TableColumnsMetadata();
-    foreach ($columns1->columns as $columnName => $column1)
+    foreach ($oldColumns->columns as $columnName => $oldColumn)
     {
-      if (isset($columns2->columns[$columnName]))
+      if (isset($newColumns->columns[$columnName]))
       {
-        if (!ColumnMetadata::compare($column1, $columns2->columns[$columnName], $ignore))
+        if (!ColumnMetadata::compare($oldColumn, $newColumns->columns[$columnName], $ignore))
         {
-          $diff->appendTableColumn($column1);
+          $diff->appendTableColumn($newColumns->columns[$columnName]);
         }
       }
     }

test/MySql/AuditCommand/AlterColumn/AlterColumnTest.php

@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+namespace SetBased\Audit\Test\MySql\AuditCommand\AlterColumn;
+
+use SetBased\Audit\MySql\AuditDataLayer;
+use SetBased\Audit\Test\MySql\AuditCommand\AuditCommandTestCase;
+
+/**
+ * Tests for running audit with an altered table column.
+ */
+class AlterColumnTest extends AuditCommandTestCase
+{
+  //--------------------------------------------------------------------------------------------------------------------
+  /**
+   * @inheritdoc
+   */
+  public static function setUpBeforeClass(): void
+  {
+    self::$dir = __DIR__;
+
+    parent::setUpBeforeClass();
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+  public function test01(): void
+  {
+    $this->runAudit();
+
+    AuditDataLayer::$dl->executeMulti(file_get_contents(__DIR__.'/config/alter_column.sql'));
+
+    $output = $this->runAudit();
+    self::assertSame('Type of TABLE1.c2 has been altered to varchar(80)', trim($output));
+  }
+
+  //--------------------------------------------------------------------------------------------------------------------
+}
+
+//----------------------------------------------------------------------------------------------------------------------

test/MySql/AuditCommand/AlterColumn/config/alter_column.sql

@@ -0,0 +1 @@
+alter table `TABLE1` modify `c2` varchar(80);

test/MySql/AuditCommand/AlterColumn/config/audit.json

@@ -0,0 +1,12 @@
+{
+  "database": {
+    "credentials": "credentials.ini"
+  },
+  "tables": {
+    "TABLE1": {
+      "audit": true,
+      "skip": null,
+      "alias": "t1"
+    }
+  }
+}

test/MySql/AuditCommand/AlterColumn/config/credentials.ini

@@ -0,0 +1,6 @@
+[database]
+host = 127.0.0.1
+user = test
+password = test
+data_schema = test_data
+audit_schema = test_audit

test/MySql/AuditCommand/AlterColumn/config/setup.sql

@@ -0,0 +1,6 @@
+create table `TABLE1` (
+  c1 tinyint,
+  c2 varchar(40),
+  c4 int
+);
+