Merge #421 - Fix #418 - ALTER EVENT statement with DEFINER=user modifier fails to be parsed

Pull-request: #421
Fixes: #418

Signed-off-by: William Desportes <williamdes@wdes.fr>

Author: williamdes

src/Statements/AlterStatement.php

@@ -13,6 +13,7 @@
 use PhpMyAdmin\SqlParser\TokensList;
 
 use function implode;
+use function trim;
 
 /**
  * `ALTER` statement.
@@ -43,7 +44,11 @@ class AlterStatement extends Statement
         'ONLINE' => 1,
         'OFFLINE' => 1,
         'IGNORE' => 2,
-
+        // `DEFINER` is also used for `ALTER EVENT`
+        'DEFINER' => [
+            2,
+            'expr=',
+        ],
         'DATABASE' => 3,
         'EVENT' => 3,
         'FUNCTION' => 3,
@@ -139,8 +144,10 @@ public function build()
             $tmp[] = $altered::build($altered);
         }
 
-        return 'ALTER ' . OptionsArray::build($this->options)
+        return trim(
+            'ALTER ' . OptionsArray::build($this->options)
             . ' ' . Expression::build($this->table)
-            . ' ' . implode(', ', $tmp);
+            . ' ' . implode(', ', $tmp)
+        );
     }
 }

tests/Builder/AlterStatementTest.php

@@ -21,6 +21,37 @@ public function testBuilder(): void
         $this->assertEquals($query, $stmt->build());
     }
 
+    public function testBuilderWithComments(): void
+    {
+        $query = 'ALTER /* comment */ TABLE `actor` ' .
+            'ADD PRIMARY KEY (`actor_id`), -- comment at the end of the line' . "\n" .
+            'ADD KEY `idx_actor_last_name` (`last_name`) -- and that is the last comment.';
+
+        $expectedQuery = 'ALTER TABLE `actor` ' .
+            'ADD PRIMARY KEY (`actor_id`), ' .
+            'ADD KEY `idx_actor_last_name` (`last_name`)';
+
+        $parser = new Parser($query);
+        $stmt = $parser->statements[0];
+
+        $this->assertEquals($expectedQuery, $stmt->build());
+    }
+
+    public function testBuilderWithCommentsOnOptions(): void
+    {
+        $query = 'ALTER EVENT `myEvent` /* comment */ ' .
+            'ON SCHEDULE -- Comment at the end of the line' . "\n" .
+            'AT "2023-01-01 01:23:45"';
+
+        $expectedQuery = 'ALTER EVENT `myEvent` ' .
+            'ON SCHEDULE AT "2023-01-01 01:23:45"';
+
+        $parser = new Parser($query);
+        $stmt = $parser->statements[0];
+
+        $this->assertEquals($expectedQuery, $stmt->build());
+    }
+
     public function testBuilderCompressed(): void
     {
         $query = 'ALTER TABLE `user` CHANGE `message` `message` TEXT COMPRESSED';
@@ -34,7 +65,7 @@ public function testBuilderPartitions(): void
         $parser = new Parser('ALTER TABLE t1 PARTITION BY HASH(id) PARTITIONS 8');
         $stmt = $parser->statements[0];
 
-        $this->assertEquals('ALTER TABLE t1 PARTITION BY  HASH(id) PARTITIONS 8 ', $stmt->build());
+        $this->assertEquals('ALTER TABLE t1 PARTITION BY  HASH(id) PARTITIONS 8', $stmt->build());
 
         $parser = new Parser('ALTER TABLE t1 ADD PARTITION (PARTITION p3 VALUES LESS THAN (2002))');
         $stmt = $parser->statements[0];
@@ -50,16 +81,24 @@ public function testBuilderPartitions(): void
         $stmt = $parser->statements[0];
 
         $this->assertEquals(
-            'ALTER TABLE p PARTITION BY  LINEAR KEY ALGORITHM=2 (id) PARTITIONS 32 ',
+            'ALTER TABLE p PARTITION BY  LINEAR KEY ALGORITHM=2 (id) PARTITIONS 32',
             $stmt->build()
         );
 
         $parser = new Parser('ALTER TABLE t1 DROP PARTITION p0, p1;');
         $stmt = $parser->statements[0];
 
         $this->assertEquals(
-            'ALTER TABLE t1 DROP PARTITION  p0, p1 ',
+            'ALTER TABLE t1 DROP PARTITION  p0, p1',
             $stmt->build()
         );
     }
+
+    public function testBuilderEventWithDefiner(): void
+    {
+        $query = 'ALTER DEFINER=user EVENT myEvent ENABLE';
+        $parser = new Parser($query);
+        $stmt = $parser->statements[0];
+        $this->assertEquals($query, $stmt->build());
+    }
 }

tests/Parser/AlterStatementTest.php

@@ -76,6 +76,8 @@ public function alterProvider(): array
             ['parser/parseAlterEventOnScheduleEvery4'],
             ['parser/parseAlterEventOnScheduleEvery5'],
             ['parser/parseAlterEventOnScheduleEvery6'],
+            ['parser/parseAlterEventWithDefiner'],
+            ['parser/parseAlterEventWithOtherDefiners'],
         ];
     }
 }

tests/data/parser/parseAlterEventWithDefiner.in

@@ -0,0 +1 @@
+ALTER DEFINER = user EVENT my_event ENABLE;