-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathforge-testing.html
More file actions
1374 lines (1222 loc) · 69.6 KB
/
forge-testing.html
File metadata and controls
1374 lines (1222 loc) · 69.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" class="scroll-smooth">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Forge Kernel - ForgeTesting</title>
<script src="https://cdn.tailwindcss.com"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>
<script
src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
<link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/themes/prism-tomorrow.min.css" rel="stylesheet">
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css" rel="stylesheet">
<link rel="stylesheet" href="assets/css/docs.css">
</head>
<body class="bg-gray-50 text-gray-900">
<!-- Navigation -->
<nav class="bg-white shadow-sm border-b">
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8">
<div class="flex justify-between h-16">
<div class="flex items-center">
<div class="flex-shrink-0">
<h1 class="text-xl font-bold text-gray-900">
Forge Kernel
</h1>
</div>
<div class="hidden sm:ml-6 sm:flex sm:space-x-8">
<a href="index.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600">
Home
</a>
<a href="getting-started.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600">
Getting Started
</a>
<a href="core-concepts.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600">
Core Concepts
</a>
<a href="modules.html"
class="text-blue-600 inline-flex items-center px-1 pt-1 text-sm font-medium border-b-2 border-blue-600">
Capabilities
</a>
<a href="api-reference.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600">
API Reference
</a>
<a href="tutorial.html"
class="text-gray-900 inline-flex items-center px-1 pt-1 text-sm font-medium hover:text-blue-600">
Tutorials
</a>
</div>
</div>
<div class="flex items-center sm:hidden">
<button id="mobile-menu-button" class="text-gray-700 hover:text-blue-600 p-2">
<i class="fas fa-bars text-xl"></i>
</button>
</div>
</div>
</div>
<div id="mobile-menu" class="sm:hidden hidden bg-white border-t border-gray-200">
<div class="px-2 pt-2 pb-3 space-y-1">
<a href="index.html" class="block px-3 py-2 text-gray-900 hover:text-blue-600">Home</a>
<a href="getting-started.html" class="block px-3 py-2 text-gray-900 hover:text-blue-600">Getting Started</a>
<a href="core-concepts.html" class="block px-3 py-2 text-gray-900 hover:text-blue-600">Core Concepts</a>
<a href="modules.html" class="block px-3 py-2 text-blue-600 font-medium">Capabilities</a>
<a href="api-reference.html" class="block px-3 py-2 text-gray-900 hover:text-blue-600">API Reference</a>
<a href="tutorial.html" class="block px-3 py-2 text-gray-900 hover:text-blue-600">Tutorials</a>
</div>
</div>
</nav>
<!-- Main Content -->
<div class="max-w-7xl mx-auto px-4 sm:px-6 lg:px-8 py-8">
<div class="flex flex-col lg:flex-row gap-8">
<!-- Sidebar Navigation -->
<div id="sidebar-nav" class="lg:w-1/4">
<div class="bg-white rounded-lg shadow-sm p-6 sticky top-8">
<h3 class="text-lg font-semibold text-gray-900 mb-4">ForgeTesting</h3>
<nav class="space-y-2">
<a href="#overview" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Overview</a>
<a href="#architecture" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Architecture & Design</a>
<a href="#installation" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Installation</a>
<a href="#test-scoping" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Test Scoping</a>
<a href="#test-grouping" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Test Grouping</a>
<a href="#writing-tests" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Writing Tests</a>
<a href="#attributes" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Attributes System</a>
<a href="#assertions" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Assertions</a>
<a href="#http-testing" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">HTTP Testing</a>
<a href="#database-testing" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Database Testing</a>
<a href="#performance-testing" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Performance Testing</a>
<a href="#cache-testing" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Cache Testing</a>
<a href="#test-lifecycle" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Test Lifecycle</a>
<a href="#data-providers" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Data Providers</a>
<a href="#test-dependencies" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Test Dependencies</a>
<a href="#skipping-incomplete" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Skipping & Incomplete</a>
<a href="#cli-commands" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">CLI Commands</a>
<a href="#test-caching" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Test Caching</a>
<a href="#test-results" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Test Results</a>
<a href="#examples" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Usage Examples</a>
<a href="#best-practices" class="nav-link block px-3 py-2 text-sm text-gray-700 rounded-md hover:text-blue-600">Best Practices</a>
</nav>
</div>
</div>
<!-- Main Content -->
<div class="lg:w-3/4">
<div class="bg-white rounded-lg shadow-sm p-8">
<h1 class="text-4xl font-bold text-gray-900 mb-6">ForgeTesting</h1>
<p class="text-xl text-gray-600 mb-8">
Complete testing framework for Forge Kernel. Tiny footprint, powerful features. Test your app, engine, and modules with comprehensive assertions, HTTP testing, database testing, and performance benchmarking.
</p>
<!-- Overview -->
<section id="overview" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Overview</h2>
<p class="text-gray-600 mb-6">
ForgeTesting provides a complete testing framework for Forge Kernel applications. Built with a tiny footprint (CLI-only), it offers powerful features for testing your application, engine, and modules. No web dependencies, minimal overhead, maximum productivity.
</p>
<div class="bg-blue-50 border border-blue-200 rounded-lg p-6 mb-6">
<h3 class="font-semibold text-lg mb-4">Key Features</h3>
<div class="grid md:grid-cols-2 gap-4">
<div class="space-y-2">
<div class="flex items-center"><span>Tiny footprint (CLI-only, no web overhead)</span></div>
<div class="flex items-center"><span>Test scoping (app, engine, module)</span></div>
<div class="flex items-center"><span>Test grouping and filtering</span></div>
<div class="flex items-center"><span>Attribute-based test definition</span></div>
</div>
<div class="space-y-2">
<div class="flex items-center"><span>Comprehensive assertions library</span></div>
<div class="flex items-center"><span>HTTP, database, cache, performance testing</span></div>
<div class="flex items-center"><span>Test caching for performance</span></div>
<div class="flex items-center"><span>Benchmark support with detailed metrics</span></div>
</div>
</div>
</div>
<h3 class="text-lg font-semibold mb-3">What ForgeTesting Provides</h3>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li><strong>Tiny Footprint:</strong> CLI-only module, no web dependencies, minimal overhead</li>
<li><strong>Flexible Scoping:</strong> Test app, engine, modules separately or together</li>
<li><strong>Powerful Grouping:</strong> Filter tests by groups for focused testing</li>
<li><strong>Comprehensive Assertions:</strong> 30+ assertion methods for all testing needs</li>
<li><strong>HTTP Testing:</strong> Built-in HTTP client with CSRF support</li>
<li><strong>Database Testing:</strong> Database assertions and migration support</li>
<li><strong>Performance Testing:</strong> Benchmark methods and execution time tracking</li>
<li><strong>Test Caching:</strong> Directory hash-based caching for faster test discovery</li>
</ul>
<div class="bg-green-50 border-l-4 border-green-400 p-4 mb-6">
<p class="text-sm text-green-700">
<strong>Tiny Footprint:</strong> ForgeTesting is a CLI-only module (isCli: true), meaning it only loads in CLI context. No web dependencies, no overhead for production applications. Perfect for development and CI/CD pipelines.
</p>
</div>
</section>
<!-- Architecture & Design -->
<section id="architecture" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Architecture & Design Philosophy</h2>
<p class="text-gray-600 mb-6">
ForgeTesting is built with performance, simplicity, and developer experience in mind. Its tiny footprint and powerful features make it ideal for both small projects and enterprise applications.
</p>
<h3 class="text-lg font-semibold mb-3">Tiny Footprint Design</h3>
<p class="text-gray-600 mb-4">
ForgeTesting is designed as a CLI-only module:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li><strong>CLI-Only:</strong> Module marked with <code class="bg-gray-100 px-2 py-1 rounded">isCli: true</code> — only loads in CLI context</li>
<li><strong>No Web Dependencies:</strong> Zero overhead for production web applications</li>
<li><strong>Minimal Dependencies:</strong> Uses only core Forge Kernel features</li>
<li><strong>Fast Execution:</strong> Optimized for speed with test caching</li>
</ul>
<h3 class="text-lg font-semibold mb-3">Attribute-Based Test Definition</h3>
<p class="text-gray-600 mb-4">
Tests are defined using PHP 8 attributes, not method naming conventions:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li>No requirement for method names to start with "test"</li>
<li>Use <code class="bg-gray-100 px-2 py-1 rounded">#[Test]</code> attribute to mark test methods</li>
<li>Optional test descriptions in the attribute</li>
<li>More flexible and explicit than naming conventions</li>
</ul>
<h3 class="text-lg font-semibold mb-3">Test Scoping Philosophy</h3>
<p class="text-gray-600 mb-4">
Tests are organized by scope for better organization:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li><strong>App Tests:</strong> Application-specific tests in <code class="bg-gray-100 px-2 py-1 rounded">app/tests/</code></li>
<li><strong>Engine Tests:</strong> Core engine tests in <code class="bg-gray-100 px-2 py-1 rounded">engine/tests/</code></li>
<li><strong>Module Tests:</strong> Module-specific tests in <code class="bg-gray-100 px-2 py-1 rounded">modules/{ModuleName}/src/tests/</code></li>
<li>Run tests by scope for focused testing</li>
</ul>
<h3 class="text-lg font-semibold mb-3">Test Caching System</h3>
<p class="text-gray-600 mb-4">
Directory hash-based caching for performance:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li>Cache file: <code class="bg-gray-100 px-2 py-1 rounded">storage/framework/cache/test_cache.php</code></li>
<li>Cache TTL: 3600 seconds (1 hour)</li>
<li>Automatic invalidation when test files change</li>
<li>Faster test discovery on subsequent runs</li>
</ul>
<div class="bg-blue-50 border-l-4 border-blue-400 p-4 mb-6">
<p class="text-sm text-blue-700">
<strong>Performance:</strong> Test caching means test discovery only happens when files change. This makes ForgeTesting very fast even with large test suites.
</p>
</div>
</section>
<!-- Installation -->
<section id="installation" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Installation</h2>
<p class="text-gray-600 mb-6">
Install ForgeTesting using ForgePackageManager. The module is CLI-only and has no web dependencies.
</p>
<h3 class="text-lg font-semibold mb-3">Using ForgePackageManager</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-bash"># Install with wizard (interactive)
php forge.php package:install-module
# Install directly (skip wizard)
php forge.php package:install-module --module=ForgeTesting
# Install specific version
php forge.php package:install-module --module=ForgeTesting@0.1.4</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">CLI-Only Module</h3>
<p class="text-gray-600 mb-4">
ForgeTesting is marked as CLI-only:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Module(
name: "ForgeTesting",
version: "0.1.4",
description: "A Test Suite Module By Forge",
order: 9999,
isCli: true, // Only loads in CLI context
)]</code></pre>
</div>
<p class="text-gray-600 mb-4">
This means:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li>Module only loads when running CLI commands</li>
<li>Zero overhead for web requests</li>
<li>No web dependencies or middleware</li>
<li>Perfect for development and CI/CD</li>
</ul>
</section>
<!-- Test Scoping -->
<section id="test-scoping" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Test Scoping</h2>
<p class="text-gray-600 mb-6">
ForgeTesting supports three test scopes: app, engine, and module. Run tests by scope for focused testing.
</p>
<h3 class="text-lg font-semibold mb-3">App Tests</h3>
<p class="text-gray-600 mb-4">
Application-specific tests located in <code class="bg-gray-100 px-2 py-1 rounded">app/tests/</code>:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-bash"># Run all app tests
php forge.php test
# Explicitly run app tests
php forge.php test --type=app</code></pre>
</div>
<p class="text-gray-600 mb-4">
Example: <code class="bg-gray-100 px-2 py-1 rounded">app/tests/HomeTest.php</code>
</p>
<h3 class="text-lg font-semibold mb-3">Engine Tests</h3>
<p class="text-gray-600 mb-4">
Core engine tests located in <code class="bg-gray-100 px-2 py-1 rounded">engine/tests/</code>:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-bash"># Run all engine tests
php forge.php test --type=engine</code></pre>
</div>
<p class="text-gray-600 mb-4">
Examples: <code class="bg-gray-100 px-2 py-1 rounded">engine/tests/ValidatorTest.php</code>, <code class="bg-gray-100 px-2 py-1 rounded">engine/tests/Engine/ContainerEngineTest.php</code>
</p>
<h3 class="text-lg font-semibold mb-3">Module Tests</h3>
<p class="text-gray-600 mb-4">
Module-specific tests located in <code class="bg-gray-100 px-2 py-1 rounded">modules/{ModuleName}/src/tests/</code>:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-bash"># Run all module tests
php forge.php test --type=module
# Run tests for specific module
php forge.php test --type=module --module=ForgeAuth</code></pre>
</div>
<p class="text-gray-600 mb-4">
Example: <code class="bg-gray-100 px-2 py-1 rounded">modules/ForgeAuth/src/tests/AuthenticationTest.php</code>
</p>
<div class="bg-blue-50 border-l-4 border-blue-400 p-4 mb-6">
<p class="text-sm text-blue-700">
<strong>Scoping Benefits:</strong> Test scoping allows you to run focused test suites. Test your application logic separately from engine tests, or test specific modules in isolation.
</p>
</div>
</section>
<!-- Test Grouping -->
<section id="test-grouping" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Test Grouping</h2>
<p class="text-gray-600 mb-6">
Group tests using the <code class="bg-gray-100 px-2 py-1 rounded">#[Group]</code> attribute and filter by group when running tests.
</p>
<h3 class="text-lg font-semibold mb-3">Class-Level Grouping</h3>
<p class="text-gray-600 mb-4">
Apply groups to entire test classes:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Group("http")]
final class HomeTest extends TestCase
{
// All tests in this class belong to "http" group
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Method-Level Grouping</h3>
<p class="text-gray-600 mb-4">
Apply groups to individual test methods:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Group("auth")]
final class AuthenticationTest extends TestCase
{
#[Test]
#[Group("Database")]
public function user_exists(): void
{
// This test belongs to both "auth" and "Database" groups
}
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Filtering by Group</h3>
<p class="text-gray-600 mb-4">
Run only tests in a specific group:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-bash"># Run only Database group tests
php forge.php test --group=Database
# Run only http group tests
php forge.php test --group=http
# Run only validator group tests
php forge.php test --group=validator</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Common Group Names</h3>
<p class="text-gray-600 mb-4">
Examples from the codebase:
</p>
<ul class="list-disc list-inside space-y-2 text-gray-600 mb-4">
<li><code class="bg-gray-100 px-2 py-1 rounded">http</code> — HTTP/route tests</li>
<li><code class="bg-gray-100 px-2 py-1 rounded">auth</code> — Authentication tests</li>
<li><code class="bg-gray-100 px-2 py-1 rounded">Database</code> — Database tests</li>
<li><code class="bg-gray-100 px-2 py-1 rounded">validator</code> — Validation tests</li>
<li><code class="bg-gray-100 px-2 py-1 rounded">container</code> — Container/Dependency Injection tests</li>
<li><code class="bg-gray-100 px-2 py-1 rounded">helpers</code> — Helper function tests</li>
</ul>
</section>
<!-- Writing Tests -->
<section id="writing-tests" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Writing Tests</h2>
<p class="text-gray-600 mb-6">
All tests extend <code class="bg-gray-100 px-2 py-1 rounded">TestCase</code> and use the <code class="bg-gray-100 px-2 py-1 rounded">#[Test]</code> attribute to mark test methods.
</p>
<h3 class="text-lg font-semibold mb-3">Basic Test Structure</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">use App\Modules\ForgeTesting\Attributes\Test;
use App\Modules\ForgeTesting\TestCase;
final class HomeTest extends TestCase
{
#[Test("Home / route is working")]
public function home_route_is_ok(): void
{
$response = $this->get("/");
$this->assertHttpStatus(200, $response);
}
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Test Method Naming</h3>
<p class="text-gray-600 mb-4">
Test methods can have any name — they're identified by the <code class="bg-gray-100 px-2 py-1 rounded">#[Test]</code> attribute:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">// ✅ Valid — has #[Test] attribute
#[Test]
public function my_custom_test_name(): void { }
// ✅ Valid — descriptive name
#[Test("User can login")]
public function user_can_login(): void { }
// ❌ Not a test — no #[Test] attribute
public function helper_method(): void { }</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Test Descriptions</h3>
<p class="text-gray-600 mb-4">
Provide optional descriptions in the <code class="bg-gray-100 px-2 py-1 rounded">#[Test]</code> attribute:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test("Home / route is working")]
public function home_route_is_ok(): void { }
// Description appears in test results
// Test: Home / route is working
// Class: App\Tests\HomeTest
// Method: home_route_is_ok</code></pre>
</div>
</section>
<!-- Attributes System -->
<section id="attributes" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Attributes System</h2>
<p class="text-gray-600 mb-6">
ForgeTesting uses PHP 8 attributes to define test behavior. All attributes are optional except <code class="bg-gray-100 px-2 py-1 rounded">#[Test]</code> for marking test methods.
</p>
<h3 class="text-lg font-semibold mb-3">#[Test] - Mark Test Methods</h3>
<p class="text-gray-600 mb-4">
Required attribute to mark a method as a test:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test]
public function my_test(): void { }
#[Test("Optional test description")]
public function my_test_with_description(): void { }</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">#[Group] - Group Tests</h3>
<p class="text-gray-600 mb-4">
Group tests for filtering (class or method level):
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Group("http")]
final class HomeTest extends TestCase { }
#[Group("Database")]
public function user_exists(): void { }</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">#[Skip] - Skip Tests</h3>
<p class="text-gray-600 mb-4">
Skip tests with a reason:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test]
#[Skip("Waiting on implementation")]
public function login_works(): void { }</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">#[Incomplete] - Mark Incomplete Tests</h3>
<p class="text-gray-600 mb-4">
Mark tests as incomplete with a reason:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test]
#[Incomplete("Needs to check save performance in the model")]
public function create_user(): void { }</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">#[DataProvider] - Provide Test Data</h3>
<p class="text-gray-600 mb-4">
Provide multiple test data sets:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[DataProvider("userProvider")]
#[Test]
public function multiple_users(array $users): void
{
$this->assertArrayHasKey("email", $users);
}
public function userProvider(): array
{
return [
[["email" => "user1@example.com"]],
[["email" => "user2@example.com"]],
];
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">#[Depends] - Test Dependencies</h3>
<p class="text-gray-600 mb-4">
Run tests in order based on dependencies:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test]
public function create_user(): void { }
#[Test]
#[Depends("create_user")]
public function update_user(): void
{
// create_user() runs first
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">#[BeforeEach] - Setup Methods</h3>
<p class="text-gray-600 mb-4">
Run before each test method:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[BeforeEach]
public function setup(): void
{
// Runs before each test
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">#[AfterEach] - Teardown Methods</h3>
<p class="text-gray-600 mb-4">
Run after each test method:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[AfterEach]
public function tearDown(): void
{
// Runs after each test
}</code></pre>
</div>
</section>
<!-- Assertions -->
<section id="assertions" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Assertions</h2>
<p class="text-gray-600 mb-6">
ForgeTesting provides a comprehensive assertions library with 30+ assertion methods covering all testing needs.
</p>
<h3 class="text-lg font-semibold mb-3">Basic Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertTrue($value);
$this->assertFalse($value);
$this->assertEquals($expected, $actual);
$this->assertNotEquals($expected, $actual);
$this->assertSame($expected, $actual); // ===
$this->assertNotSame($expected, $actual); // !==</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Null and Empty Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertNull($value);
$this->assertNotNull($value);
$this->assertEmpty($value);
$this->assertNotEmpty($value);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Type Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertInstanceOf(ExpectedClass::class, $object);
$this->assertNotInstanceOf(ExpectedClass::class, $object);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Array Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertArrayHasKey("key", $array);
$this->assertArrayNotHasKey("key", $array);
$this->assertCount(5, $array);
$this->assertContains($needle, $haystack);
$this->assertNotContains($needle, $haystack);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">String Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertStringContainsString("needle", $haystack);
$this->assertStringNotContainsString("needle", $haystack);
$this->assertMatchesRegularExpression("/pattern/", $string);
$this->assertDoesNotMatchRegularExpression("/pattern/", $string);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Comparison Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertGreaterThan(10, $value);
$this->assertLessThan(10, $value);
$this->assertGreaterThanOrEqual(10, $value);
$this->assertLessThanOrEqual(10, $value);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">File Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertFileExists($filename);
$this->assertFileDoesNotExist($filename);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">JSON Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertJsonStringEqualsJsonString($expectedJson, $actualJson);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">HTTP Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertHttpStatus(200, $response);
$this->assertHttpStatus(404, $response);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Exception Assertions</h3>
<p class="text-gray-600 mb-4">
Expect exceptions to be thrown:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">// Expect any exception
$this->shouldFail(function () {
throw new \Exception("Error");
});
// Expect specific exception type
$this->shouldFail(
function () {
throw new ValidationException("Error");
},
ValidationException::class
);</code></pre>
</div>
</section>
<!-- HTTP Testing -->
<section id="http-testing" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">HTTP Testing</h2>
<p class="text-gray-600 mb-6">
ForgeTesting provides built-in HTTP testing capabilities with CSRF token support.
</p>
<h3 class="text-lg font-semibold mb-3">HTTP Methods</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">// GET request
$response = $this->get("/");
// POST request
$response = $this->post("/", ["key" => "value"]);
// PATCH request
$response = $this->patch("/1", ["key" => "value"]);
// With headers
$response = $this->get("/", [], ["X-Custom-Header" => "value"]);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">CSRF Token Handling</h3>
<p class="text-gray-600 mb-4">
ForgeTesting automatically handles CSRF tokens:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">// Add CSRF token to POST data
$response = $this->post("/", $this->withCsrf([
"email" => "test@example.com",
"password" => "password123",
]));
// Add CSRF token to headers
$response = $this->patch(
"/1",
["identifier" => "newuser"],
$this->csrfHeaders()
);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Complete Example</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test("Home / route is working")]
public function home_route_is_ok(): void
{
$response = $this->get("/");
$this->assertHttpStatus(200, $response);
}
#[Test("POST / with invalid data redirects back")]
public function register_route_returns_redirect_on_validation_error(): void
{
$response = $this->post(
"/",
$this->withCsrf([
"email" => "invalid-email",
"password" => "123",
]),
);
$this->assertHttpStatus(302, $response);
}</code></pre>
</div>
</section>
<!-- Database Testing -->
<section id="database-testing" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Database Testing</h2>
<p class="text-gray-600 mb-6">
ForgeTesting provides database assertions and migration support for testing database operations.
</p>
<h3 class="text-lg font-semibold mb-3">Database Assertions</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">// Assert record exists
$this->assertDatabaseHas("users", [
"identifier" => "example",
"email" => "test@example.com",
]);
// Assert record does not exist
$this->assertDatabaseMissing("users", [
"email" => "deleted@example.com",
]);
// Assert exact count
$this->assertDatabaseCount("users", 5, [
"status" => "active",
]);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Database Refresh</h3>
<p class="text-gray-600 mb-4">
Refresh database before tests:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[BeforeEach]
public function setup(): void
{
$this->refreshDatabase(); // Runs migrations
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Seeding</h3>
<p class="text-gray-600 mb-4">
Seed database with test data:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->seed(UserSeeder::class);</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Complete Example</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test("Check a record exists in the Database by identifier")]
#[Group("Database")]
public function user_exists(): void
{
$this->assertDatabaseHas("users", [
"identifier" => $this->exampleUser["identifier"],
]);
}</code></pre>
</div>
</section>
<!-- Performance Testing -->
<section id="performance-testing" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Performance Testing</h2>
<p class="text-gray-600 mb-6">
ForgeTesting provides performance benchmarking and execution time tracking.
</p>
<h3 class="text-lg font-semibold mb-3">Benchmarking</h3>
<p class="text-gray-600 mb-4">
Measure performance with the <code class="bg-gray-100 px-2 py-1 rounded">benchmark()</code> method:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test("Benchmark user lookup")]
#[Group("Database")]
public function benchmark_user_lookup(): array
{
$results = $this->benchmark(function () {
$this->assertDatabaseHas("users", [
"email" => $this->exampleUser["email"],
]);
}, 1); // 1 iteration
return $results; // Returns: ['avg', 'min', 'max', 'total']
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
Benchmark results are displayed in test output:
</p>
<div class="bg-gray-100 border border-gray-300 rounded-lg p-4 mb-6">
<pre class="text-sm">Benchmark Results:
App\Modules\ForgeAuth\Tests\AuthenticationTest::benchmark_user_lookup:
| Avg Time/Iter | Min Time/Iter | Max Time/Iter | Total Time |
+---------------+---------------+---------------+------------+
| 0.388 ms | 0.388 ms | 0.388 ms | 0.388 ms |</pre>
</div>
<h3 class="text-lg font-semibold mb-3">Execution Time Limits</h3>
<p class="text-gray-600 mb-4">
Assert maximum execution time:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->assertMaxExecutionTime(0.5, function () {
// Code that should complete in 0.5 seconds
$this->doSomething();
});</code></pre>
</div>
</section>
<!-- Cache Testing -->
<section id="cache-testing" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Cache Testing</h2>
<p class="text-gray-600 mb-6">
ForgeTesting provides utilities for testing cache behavior.
</p>
<h3 class="text-lg font-semibold mb-3">Flush Cache</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->flushCache(); // Clears framework cache</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Clear Logs</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">$this->clearLogs(); // Clears log files</code></pre>
</div>
</section>
<!-- Test Lifecycle -->
<section id="test-lifecycle" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Test Lifecycle</h2>
<p class="text-gray-600 mb-6">
ForgeTesting provides lifecycle hooks for test setup and teardown.
</p>
<h3 class="text-lg font-semibold mb-3">Setup Method</h3>
<p class="text-gray-600 mb-4">
The <code class="bg-gray-100 px-2 py-1 rounded">setup()</code> method runs before each test:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[BeforeEach]
public function setup(): void
{
if (self::$kernel === null) {
$bootstrap = Bootstrap::getInstance();
self::$kernel = $bootstrap->getKernel();
}
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Teardown Method</h3>
<p class="text-gray-600 mb-4">
The <code class="bg-gray-100 px-2 py-1 rounded">tearDown()</code> method runs after each test:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[AfterEach]
public function tearDown(): void
{
// Cleanup after each test
}</code></pre>
</div>
<h3 class="text-lg font-semibold mb-3">Kernel Initialization</h3>
<p class="text-gray-600 mb-4">
The kernel is initialized once and shared across all tests for performance:
</p>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">protected static ?Kernel $kernel = null;
#[BeforeEach]
public function setup(): void
{
if (self::$kernel === null) {
$bootstrap = Bootstrap::getInstance();
self::$kernel = $bootstrap->getKernel();
}
}</code></pre>
</div>
</section>
<!-- Data Providers -->
<section id="data-providers" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Data Providers</h2>
<p class="text-gray-600 mb-6">
Use data providers to run the same test with multiple data sets.
</p>
<h3 class="text-lg font-semibold mb-3">Using Data Providers</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[DataProvider("userProvider")]
#[Test]
#[Group("Database")]
public function multiple_users(array $users): void
{
$this->assertArrayHasKey("email", $users);
}
public function userProvider(): array
{
$users = $this->queryBuilder
->reset()
->setTable("users")
->select("*")
->limit(10)
->get(null);
$dataProvider = [];
foreach ($users as $user) {
$dataProvider[] = [["email" => $user["email"]]];
}
return $dataProvider;
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
The test runs once for each data set returned by the provider method.
</p>
</section>
<!-- Test Dependencies -->
<section id="test-dependencies" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Test Dependencies</h2>
<p class="text-gray-600 mb-6">
Use <code class="bg-gray-100 px-2 py-1 rounded">#[Depends]</code> to ensure tests run in order.
</p>
<h3 class="text-lg font-semibold mb-3">Defining Dependencies</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test]
public function create_user(): void
{
// Create user
}
#[Test]
#[Depends("create_user")]
public function update_user(): void
{
// create_user() runs first
// Then update_user() runs
}</code></pre>
</div>
</section>
<!-- Skipping & Incomplete -->
<section id="skipping-incomplete" class="section-anchor mb-12">
<h2 class="text-2xl font-bold text-gray-900 mb-4">Skipping and Incomplete Tests</h2>
<p class="text-gray-600 mb-6">
Mark tests as skipped or incomplete with reasons. These appear in test results.
</p>
<h3 class="text-lg font-semibold mb-3">Skipping Tests</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test("User login functionality")]
#[Skip("Waiting on implementation")]
public function login_works(): void
{
$this->assertTrue(true);
}
#[Test]
#[Group("smtp")]
#[Skip("Waiting on SMTP implementation")]
public function password_reset_email(): void
{
// Test implementation
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
Skipped tests appear in test results:
</p>
<div class="bg-gray-100 border border-gray-300 rounded-lg p-4 mb-6">
<pre class="text-sm">Skipped Tests:
App\Modules\ForgeAuth\Tests\AuthenticationTest::login_works (0 ms)
Reason: Waiting on implementation</pre>
</div>
<h3 class="text-lg font-semibold mb-3">Incomplete Tests</h3>
<div class="code-block p-6 text-white rounded-lg mb-6">
<pre><code class="language-php">#[Test("Insert a new record in the Database")]
#[Group("Database")]
#[Incomplete("Needs to check save performance in the model")]
public function create_user(): void
{
$user = new User();
$user->identifier = $this->exampleUser["identifier"];
$user->save();
$this->assertNotNull($user->id);
}</code></pre>
</div>
<p class="text-gray-600 mb-4">
Incomplete tests appear in test results:
</p>
<div class="bg-gray-100 border border-gray-300 rounded-lg p-4 mb-6">