packages/sql-semantics/tests/Unit/Core/Ast/SchemaReaderTest.php

1<?php
2
3declare(strict_types=1);
4
5namespace Tests\Unit\Core\Ast;
6
7use PHPUnit\Framework\Attributes\CoversClass;
8use PHPUnit\Framework\Attributes\Medium;
9use PHPUnit\Framework\Attributes\TestWith;
10use PHPUnit\Framework\TestCase;
11use SqlSemantics\Core\Binder;
12use SqlSemantics\Core\Dialect;
13use SqlSemantics\Core\SchemaBuilder;
14use SqlSemantics\Core\SemanticException;
15use SqlSemantics\Core\Type\Nullability;
16use SqlSemantics\Platform\MySql\Dialect as MySqlDialect;
17use SqlSemantics\Platform\PostgreSql\Dialect as PostgreSqlDialect;
18use SqlSemantics\Platform\Sqlite\Dialect as SqliteDialect;
19
20#[CoversClass(\SqlSemantics\Core\Ast\SchemaReader::class)]
21#[CoversClass(\SqlSemantics\Core\Binding\ExpressionBinder::class)]
22#[CoversClass(\SqlSemantics\Core\Binding\ExpressionRules::class)]
23#[CoversClass(\SqlSemantics\Core\Binding\FromBinder::class)]
24#[CoversClass(\SqlSemantics\Core\Binding\LiteralBinder::class)]
25#[CoversClass(\SqlSemantics\Core\Binding\NullFacts::class)]
26#[CoversClass(\SqlSemantics\Core\Binding\ProjectionBinder::class)]
27#[CoversClass(\SqlSemantics\Core\Binding\SelectBinder::class)]
28#[CoversClass(\SqlSemantics\Core\Binding\SyntaxGuard::class)]
29#[CoversClass(\SqlSemantics\Core\Binding\SelectModifiersBinder::class)]
30#[CoversClass(\SqlSemantics\Core\Binding\TypeResolution::class)]
31#[CoversClass(Binder::class)]
32#[CoversClass(SchemaBuilder::class)]
33#[CoversClass(\SqlSemantics\Core\Ast\DialectParser::class)]
34#[CoversClass(\SqlSemantics\Core\Ast\ColumnReader::class)]
35#[CoversClass(\SqlSemantics\Core\Ast\ConstraintReader::class)]
36#[CoversClass(\SqlSemantics\Core\Ast\Identifiers::class)]
37#[CoversClass(\SqlSemantics\Core\Ast\StatementList::class)]
38#[CoversClass(\SqlSemantics\Core\Ast\TokenGroups::class)]
39#[CoversClass(\SqlSemantics\Core\Ast\Tree::class)]
40#[CoversClass(\SqlSemantics\Core\Ast\TypeReader::class)]
41#[CoversClass(\SqlSemantics\Core\Binding\BoundRelation::class)]
42#[CoversClass(\SqlSemantics\Core\Binding\IdentitySequence::class)]
43#[CoversClass(\SqlSemantics\Core\Binding\Scope::class)]
44#[CoversClass(\SqlSemantics\Core\Binding\TableResolver::class)]
45#[CoversClass(\SqlSemantics\Core\Model\ColumnBinding::class)]
46#[CoversClass(\SqlSemantics\Core\Model\Expression::class)]
47#[CoversClass(\SqlSemantics\Core\Model\Join::class)]
48#[CoversClass(\SqlSemantics\Core\Model\Ordering::class)]
49#[CoversClass(\SqlSemantics\Core\Model\OutputColumn::class)]
50#[CoversClass(\SqlSemantics\Core\Model\BoundSelect::class)]
51#[CoversClass(\SqlSemantics\Core\Model\TableUse::class)]
52#[CoversClass(\SqlSemantics\Core\Schema::class)]
53#[CoversClass(\SqlSemantics\Core\Schema\ColumnDefinition::class)]
54#[CoversClass(\SqlSemantics\Core\Schema\TableConstraint::class)]
55#[CoversClass(\SqlSemantics\Core\Schema\TableDefinition::class)]
56#[CoversClass(SemanticException::class)]
57#[CoversClass(\SqlSemantics\Core\Type\TypeDescriptor::class)]
58#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Core\Policy\SyntaxRules::class)]
59#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\PostgreSql\QueryRules::class)]
60#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\PostgreSql\Platform::class)]
61#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\PostgreSql\TypeRules::class)]
62#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\PostgreSql\NameRules::class)]
63#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\PostgreSql\SchemaRules::class)]
64#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\Sqlite\QueryRules::class)]
65#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\Sqlite\Platform::class)]
66#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\Sqlite\TypeRules::class)]
67#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\Sqlite\NameRules::class)]
68#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\Sqlite\SchemaRules::class)]
69#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\MySql\QueryRules::class)]
70#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\MySql\Platform::class)]
71#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\MySql\TypeRules::class)]
72#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\MySql\NameRules::class)]
73#[\PHPUnit\Framework\Attributes\UsesClass(\SqlSemantics\Platform\MySql\SchemaRules::class)]
74#[Medium]
75final class SchemaReaderTest extends TestCase
76{
77    #[TestWith([PostgreSqlDialect::PostgreSql])]
78    #[TestWith([MySqlDialect::MySql])]
79    #[TestWith([SqliteDialect::Sqlite])]
80    public function testReadDeclaredKeysDefaultsAndChecks(Dialect $dialect): void
81    {
82        $schema = (new SchemaBuilder($dialect))->build('CREATE TABLE users (id INTEGER PRIMARY KEY, parent_id INTEGER, score INTEGER NOT NULL DEFAULT 1, UNIQUE(score), FOREIGN KEY (parent_id) REFERENCES users(id), CHECK (score > 0))');
83        $table = $schema->tables[0];
84        self::assertSame(['id', 'parent_id', 'score'], array_column($table->columns, 'name'));
85        self::assertSame(Nullability::NotNull, $table->columns[0]->nullability);
86        self::assertNotNull($table->columns[2]->defaultExpression);
87        self::assertSame(4, count($table->constraints));
88        self::assertSame(['parent_id'], $table->constraints[2]->columns);
89        self::assertSame(['users'], $table->constraints[2]->referencedTable);
90        self::assertSame(['id'], $table->constraints[2]->referencedColumns);
91        self::assertNotNull($table->constraints[3]->expression);
92    }
93
94    public function testTableRejectsDuplicateDeclarations(): void
95    {
96        $builder = new SchemaBuilder(PostgreSqlDialect::PostgreSql);
97        $sql = 'CREATE TABLE users (id INTEGER)';
98        $this->expectException(SemanticException::class);
99        $this->expectExceptionMessage('Duplicate table');
100        $builder->build($sql, $sql);
101    }
102
103    public function testPrimaryKeysRejectsMissingColumn(): void
104    {
105        $this->expectException(SemanticException::class);
106        $this->expectExceptionMessage('unknown column');
107        (new SchemaBuilder(PostgreSqlDialect::PostgreSql))->build('CREATE TABLE users (id INTEGER, PRIMARY KEY (missing))');
108    }
109
110    public function testColumnNodesPreservesSqliteDeclarationOrder(): void
111    {
112        $table = (new SchemaBuilder(SqliteDialect::Sqlite))->build('CREATE TABLE users (z INTEGER, a TEXT, m REAL)')->tables[0];
113        self::assertSame(['z', 'a', 'm'], array_column($table->columns, 'name'));
114    }
115
116    public function testPrimaryNotNullRespectsSqliteDescException(): void
117    {
118        $table = (new SchemaBuilder(SqliteDialect::Sqlite))->build('CREATE TABLE users (id INTEGER PRIMARY KEY DESC)')->tables[0];
119        self::assertSame(Nullability::MaybeNull, $table->columns[0]->nullability);
120    }
121
122    public function testValidateRejectsCreateAsSelect(): void
123    {
124        $this->expectException(SemanticException::class);
125        (new SchemaBuilder(SqliteDialect::Sqlite))->build('CREATE TABLE users AS SELECT 1 AS id');
126    }
127
128    public function testPrimaryKeysResolvesCaseInsensitiveSqliteConstraintColumns(): void
129    {
130        $table = (new SchemaBuilder(SqliteDialect::Sqlite))->build('CREATE TABLE users (id INTEGER, PRIMARY KEY (ID))')->tables[0];
131        self::assertSame(Nullability::NotNull, $table->columns[0]->nullability);
132    }
133}
134