packages/sql-catalog/tests/Unit/Reporter/Html/Page/FileIndexPageTest.php
1<?php
2
3declare(strict_types=1);
4
5namespace Tests\Unit\Reporter\Html\Page;
6
7use PHPUnit\Framework\Attributes\CoversClass;
8use PHPUnit\Framework\Attributes\UsesClass;
9use PHPUnit\Framework\TestCase;
10use SqlCatalog\Core\Catalog\AnalysisProblem;
11use SqlCatalog\Core\Catalog\CallSite;
12use SqlCatalog\Core\Catalog\Catalog;
13use SqlCatalog\Core\Catalog\CatalogEntry;
14use SqlCatalog\Core\Catalog\Finding;
15use SqlCatalog\Core\Catalog\FindingRule;
16use SqlCatalog\Core\Catalog\Placeholder;
17use SqlCatalog\Core\Catalog\Resolution;
18use SqlCatalog\Core\Catalog\Severity;
19use SqlCatalog\Core\Catalog\StatementPart;
20use SqlCatalog\Core\Catalog\ValueDomain;
21use SqlCatalog\Core\Sql\StatementKind;
22use SqlCatalog\Core\Text\LiteralText;
23use SqlCatalog\Core\Text\Origin;
24use SqlCatalog\Core\Text\TextHole;
25use SqlCatalog\Core\Text\TextPattern;
26use SqlCatalog\Core\Type\TypeShape;
27use SqlCatalog\Reporter\Html\CatalogIndex;
28use SqlCatalog\Reporter\Html\CatalogStatistics;
29use SqlCatalog\Reporter\Html\HtmlText;
30use SqlCatalog\Reporter\Html\Page\FileIndexPage;
31use SqlCatalog\Reporter\Html\Palette;
32use SqlCatalog\Reporter\Html\ReportSite;
33use SqlCatalog\Reporter\Html\Scope;
34use SqlCatalog\Reporter\Html\SqlFormatter;
35use SqlCatalog\Reporter\Html\SqlHighlighter;
36use SqlCatalog\Reporter\Html\StatementList;
37use SqlCatalog\Reporter\Html\StatementRow;
38use SqlCatalog\Reporter\Html\TableName;
39
40#[CoversClass(FileIndexPage::class)]
41#[UsesClass(CallSite::class)]
42#[UsesClass(Catalog::class)]
43#[UsesClass(CatalogEntry::class)]
44#[UsesClass(CatalogIndex::class)]
45#[UsesClass(CatalogStatistics::class)]
46#[UsesClass(HtmlText::class)]
47#[UsesClass(ReportSite::class)]
48#[UsesClass(Scope::class)]
49#[UsesClass(Severity::class)]
50#[UsesClass(StatementKind::class)]
51#[UsesClass(LiteralText::class)]
52#[UsesClass(TextPattern::class)]
53#[UsesClass(AnalysisProblem::class)]
54#[UsesClass(Finding::class)]
55#[UsesClass(FindingRule::class)]
56#[UsesClass(Placeholder::class)]
57#[UsesClass(ValueDomain::class)]
58#[UsesClass(Resolution::class)]
59#[UsesClass(StatementPart::class)]
60#[UsesClass(Palette::class)]
61#[UsesClass(SqlFormatter::class)]
62#[UsesClass(SqlHighlighter::class)]
63#[UsesClass(StatementList::class)]
64#[UsesClass(StatementRow::class)]
65#[UsesClass(TableName::class)]
66#[UsesClass(Origin::class)]
67#[UsesClass(TextHole::class)]
68#[UsesClass(TypeShape::class)]
69final class FileIndexPageTest extends TestCase
70{
71 public function testRenderListsFilesUnderTheirDirectories(): void
72 {
73 $catalog = new Catalog([
74 new CatalogEntry('a1', StatementKind::Select, TextPattern::fromText('SELECT 1'), [], [], new CallSite('src/a.php', 1, 'f', 'pdo.query'), []),
75 new CatalogEntry('b1', StatementKind::Select, TextPattern::fromText('SELECT 2'), [], [], new CallSite('index.php', 1, 'f', 'pdo.query'), []),
76 ]);
77 $page = (new FileIndexPage())->render(new ReportSite($catalog, formatter: \SqlCatalog\Facade\Builtins::sqlFormatter()));
78
79 self::assertStringContainsString('<h1>Files<span class="count">2 files</span></h1>', $page);
80 self::assertStringContainsString('<h2 id="dir-root"><code>(root)</code><span class="count">1 file</span></h2>', $page);
81 self::assertStringContainsString('<h2 id="dir-src"><code>src/</code><span class="count">1 file</span></h2>', $page);
82 self::assertStringContainsString('No statement was found.', (new FileIndexPage())->render(new ReportSite(new Catalog(), formatter: \SqlCatalog\Facade\Builtins::sqlFormatter())));
83 }
84
85 public function testSectionIsASortableTableOfTheDirectorysFiles(): void
86 {
87 $catalog = new Catalog([
88 new CatalogEntry('a1', StatementKind::Select, TextPattern::fromText('SELECT 1'), [], [], new CallSite('src/a.php', 1, 'f', 'pdo.query'), []),
89 ]);
90 $section = (new FileIndexPage())->section(new ReportSite($catalog, formatter: \SqlCatalog\Facade\Builtins::sqlFormatter()), 'src', ['src/a.php']);
91
92 self::assertStringContainsString('<table class="sortable filter-target" data-dd-sortable><thead><tr><th scope="col" data-dd-sort="text">File</th>', $section);
93 self::assertStringContainsString('href="files/src-a-php.html">a.php</a>', $section);
94 }
95
96 public function testRowCountsWhatWasFoundInTheFile(): void
97 {
98 $entries = [
99 new CatalogEntry('a1', StatementKind::Select, TextPattern::fromText('SELECT 1'), ['users'], [], new CallSite('src/a.php', 1, 'f', 'pdo.query'), []),
100 new CatalogEntry('a2', StatementKind::Select, TextPattern::fromText('SELECT 2'), ['users'], [], new CallSite('src/a.php', 2, 'g', 'pdo.query'), []),
101 ];
102
103 self::assertSame(
104 '<tr><td><a class="mono" href="files/src-a-php.html">a.php</a></td><td class="num">2</td><td class="num">2</td><td class="num">1</td><td class="num"><span class="none">0</span></td></tr>',
105 (new FileIndexPage())->row(new ReportSite(new Catalog($entries), formatter: \SqlCatalog\Facade\Builtins::sqlFormatter()), 'src/a.php', $entries),
106 );
107 }
108
109 public function testAnchorsNameEveryDirectory(): void
110 {
111 $catalog = new Catalog([
112 new CatalogEntry('a1', StatementKind::Select, TextPattern::fromText('SELECT 1'), [], [], new CallSite('src/a.php', 1, 'f', 'pdo.query'), []),
113 ]);
114
115 self::assertSame([['src/', 'dir-src']], (new FileIndexPage())->anchors(new ReportSite($catalog, formatter: \SqlCatalog\Facade\Builtins::sqlFormatter())));
116 }
117
118 public function testRenderIsWrittenExactly(): void
119 {
120 $entries = [
121 new CatalogEntry('a1', StatementKind::Select, TextPattern::fromSegments([
122 new LiteralText('SELECT id FROM posts WHERE slug = '),
123 new TextHole(Origin::External, TypeShape::unknown(), '$_GET["s"]'),
124 ]), ['posts'], [new Placeholder('?', 0, null, new ValueDomain('int', [7], true, []))], new CallSite('src/a.php', 4, 'App\\R::find', 'pdo.query'), [
125 Finding::of(FindingRule::ExternalInput, 'spliced'),
126 ], false, ['App\\R::run', 'App\\R::find']),
127 new CatalogEntry('a2', StatementKind::Insert, TextPattern::fromText('INSERT INTO posts (id) VALUES (1)'), ['posts'], [], new CallSite('src/a.php', 9, 'App\\R::add', 'pdo.query'), []),
128 new CatalogEntry('a3', StatementKind::Update, TextPattern::fromText('UPDATE posts SET title = ? WHERE id = ?'), ['posts'], [], new CallSite('src/a.php', 14, 'App\\R::add', 'pdo.prepare'), [
129 Finding::of(FindingRule::PlaceholderCountMismatch, 'one bound'),
130 ]),
131 new CatalogEntry('b1', StatementKind::Delete, TextPattern::fromText('DELETE FROM users WHERE id = 1'), ['users'], [], new CallSite('src/b.php', 3, 'App\\Admin\\U::drop', 'pdo.query'), []),
132 new CatalogEntry('b2', StatementKind::Alter, TextPattern::fromText('ALTER TABLE users ADD x INT'), ['users'], [], new CallSite('src/b.php', 8, 'App\\Admin\\U::migrate', 'pdo.exec'), []),
133 new CatalogEntry('c1', StatementKind::Select, TextPattern::fromHole(new TextHole(Origin::Budget, TypeShape::unknown())), [], [], new CallSite('lib/c.php', 2, 'helper', 'mysqli.query'), [
134 Finding::of(FindingRule::AnalysisIncomplete, 'stopped'),
135 ], true, [], true),
136 new CatalogEntry('c2', StatementKind::Unknown, TextPattern::fromHole(new TextHole(Origin::Unreached, TypeShape::unknown(), '$db->query($sql)')), [], [], new CallSite('lib/c.php', 6, '{main}', 'unmatched'), [
137 Finding::of(FindingRule::CallNotAnalyzed, 'unseen'),
138 ]),
139 new CatalogEntry('d1', StatementKind::Select, TextPattern::fromText('SELECT * FROM posts p JOIN users u ON u.id = p.author'), ['posts', 'users'], [], new CallSite('src/d.php', 1, 'App\\R::find', 'pdo.query'), [
140 Finding::of(FindingRule::DynamicSql, 'dyn'),
141 ]),
142 new CatalogEntry('e1', StatementKind::Show, TextPattern::fromText('SHOW TABLES'), [], [], new CallSite('src/e.php', 1, 'App\\R::find', 'pdo.query'), []),
143 new CatalogEntry('f1', StatementKind::Select, TextPattern::fromText('SELECT 1 FROM t1'), ['t1'], [], new CallSite('src/f.php', 1, 'App\\F::a', 'pdo.query'), []),
144 new CatalogEntry('f2', StatementKind::Select, TextPattern::fromText('SELECT 2 FROM t2'), ['t2'], [], new CallSite('src/f.php', 2, 'App\\F::b', 'pdo.query'), []),
145 new CatalogEntry('f3', StatementKind::Select, TextPattern::fromText('SELECT 3 FROM t3'), ['t3'], [], new CallSite('src/f.php', 3, 'App\\G::a', 'pdo.query'), []),
146 new CatalogEntry('f4', StatementKind::Select, TextPattern::fromText('SELECT 4 FROM t4'), ['t4'], [], new CallSite('src/f.php', 4, 'App\\H::a', 'pdo.query'), []),
147 new CatalogEntry('f5', StatementKind::Select, TextPattern::fromText('SELECT 5 FROM t5'), ['t5'], [], new CallSite('src/g.php', 1, 'App\\I::a', 'pdo.query'), []),
148 new CatalogEntry('f6', StatementKind::Select, TextPattern::fromText('SELECT 6 FROM t6'), ['t6'], [], new CallSite('src/h.php', 1, 'App\\J::a', 'pdo.query'), []),
149 new CatalogEntry('f7', StatementKind::Select, TextPattern::fromText('SELECT 7 FROM t7'), ['t7'], [], new CallSite('src/i.php', 1, 'App\\K::a', 'pdo.query'), [
150 Finding::of(FindingRule::DynamicSql, 'dyn'),
151 ]),
152 new CatalogEntry('f8', StatementKind::Select, TextPattern::fromText('SELECT 8 FROM t8'), ['t8'], [], new CallSite('src/j.php', 1, 'App\\L::a', 'pdo.query'), [
153 Finding::of(FindingRule::DynamicSql, 'dyn'),
154 ]),
155 new CatalogEntry('f9', StatementKind::Select, TextPattern::fromText('SELECT 9 FROM t9'), ['t9'], [], new CallSite('src/k.php', 1, 'App\\M::a', 'pdo.query'), [
156 Finding::of(FindingRule::DynamicSql, 'dyn'),
157 ]),
158 ];
159 $catalog = new Catalog($entries, [new AnalysisProblem('src/broken.php', 'broken')]);
160 $site = new ReportSite($catalog, formatter: \SqlCatalog\Facade\Builtins::sqlFormatter());
161
162 self::assertSame(
163 '<h1>Files<span class="count">11 files</span></h1><p class="lede">Every file a statement is written in, by directory. Open a file to read its statement'
164 . 's function by function.</p><input type="search" name="filter" class="input input-block" data-filter-rows placeholder="Narrow by file name…" aria-label'
165 . '="Narrow by file name" autocomplete="off" spellcheck="false"><section class="group"><h2 id="dir-lib"><code>lib/</code><span class="count">1 file</span'
166 . '></h2><div class="table-wrap"><table class="sortable filter-target" data-dd-sortable><thead><tr><th scope="col" data-dd-sort="text">File</th><th scope'
167 . '="col" class="num" data-dd-sort="number">Statements</th><th scope="col" class="num" data-dd-sort="number">Functions</th><th scope="col" class="num" da'
168 . 'ta-dd-sort="number">Tables</th><th scope="col" class="num" data-dd-sort="number">Attention</th></tr></thead><tbody><tr><td><a class="mono" href="files'
169 . '/lib-c-php.html">c.php</a></td><td class="num">2</td><td class="num">2</td><td class="num"><span class="none">0</span></td><td class="num"><span class'
170 . '="none">0</span></td></tr></tbody></table></div></section><section class="group"><h2 id="dir-src"><code>src/</code><span class="count">10 files</span>'
171 . '</h2><div class="table-wrap"><table class="sortable filter-target" data-dd-sortable><thead><tr><th scope="col" data-dd-sort="text">File</th><th scope='
172 . '"col" class="num" data-dd-sort="number">Statements</th><th scope="col" class="num" data-dd-sort="number">Functions</th><th scope="col" class="num" dat'
173 . 'a-dd-sort="number">Tables</th><th scope="col" class="num" data-dd-sort="number">Attention</th></tr></thead><tbody><tr><td><a class="mono" href="files/'
174 . 'src-a-php.html">a.php</a></td><td class="num">3</td><td class="num">2</td><td class="num">1</td><td class="num">2</td></tr><tr><td><a class="mono" hre'
175 . 'f="files/src-b-php.html">b.php</a></td><td class="num">2</td><td class="num">2</td><td class="num">1</td><td class="num"><span class="none">0</span></'
176 . 'td></tr><tr><td><a class="mono" href="files/src-d-php.html">d.php</a></td><td class="num">1</td><td class="num">1</td><td class="num">2</td><td class='
177 . '"num">1</td></tr><tr><td><a class="mono" href="files/src-e-php.html">e.php</a></td><td class="num">1</td><td class="num">1</td><td class="num"><span c'
178 . 'lass="none">0</span></td><td class="num"><span class="none">0</span></td></tr><tr><td><a class="mono" href="files/src-f-php.html">f.php</a></td><td cl'
179 . 'ass="num">4</td><td class="num">4</td><td class="num">4</td><td class="num"><span class="none">0</span></td></tr><tr><td><a class="mono" href="files/s'
180 . 'rc-g-php.html">g.php</a></td><td class="num">1</td><td class="num">1</td><td class="num">1</td><td class="num"><span class="none">0</span></td></tr><t'
181 . 'r><td><a class="mono" href="files/src-h-php.html">h.php</a></td><td class="num">1</td><td class="num">1</td><td class="num">1</td><td class="num"><spa'
182 . 'n class="none">0</span></td></tr><tr><td><a class="mono" href="files/src-i-php.html">i.php</a></td><td class="num">1</td><td class="num">1</td><td cla'
183 . 'ss="num">1</td><td class="num">1</td></tr><tr><td><a class="mono" href="files/src-j-php.html">j.php</a></td><td class="num">1</td><td class="num">1</t'
184 . 'd><td class="num">1</td><td class="num">1</td></tr><tr><td><a class="mono" href="files/src-k-php.html">k.php</a></td><td class="num">1</td><td class="'
185 . 'num">1</td><td class="num">1</td><td class="num">1</td></tr></tbody></table></div></section>',
186 (new FileIndexPage())->render($site),
187 );
188 }
189}
190