@@ -7,81 +7,82 @@ This guide explains the various integration test scripts and their purposes.
77### Local Development
88
99** ` composer test:integration ` **
10+
1011- Main command for running integration tests locally
1112- Builds and optimizes image with Docker Slim
1213- Runs full test suite
1314- Use this for day-to-day development
1415
1516** ` composer test:integration:cached ` **
17+
1618- Runs tests using existing local image
1719- Skips building/optimization
1820- Fastest option if image already exists
1921
2022### Docker Image Management
2123
2224** ` composer docker:build ` **
25+
2326- Builds optimized test image locally
2427- Uses Docker Slim for size reduction
2528
2629** ` composer docker:pull ` **
30+
2731- Pulls the latest CI-built image from GitHub Container Registry
2832- Tags it for local use
2933- Useful for testing with the exact CI image
3034
31- ** ` composer docker:push ` ** * (Deprecated)*
32- - Shows instructions for the new CI workflow
33- - Images are now built/pushed automatically by GitHub Actions
34-
3535## Utility Scripts
3636
3737### Cleanup
3838
3939** ` composer test:integration:clean ` **
40+
4041- Stops and removes test containers
4142- Cleans up networks
4243
4344** ` composer test:integration:clean:force ` **
45+
4446- More aggressive cleanup
4547- Removes all containers with test labels
4648- Prunes networks
4749
4850### Debugging
4951
5052** ` composer test:integration:debug ` **
53+
5154- Runs integration tests with debugging enabled
5255- Useful for troubleshooting test failures
5356
5457** ` composer test:integration:shell ` **
58+
5559- Opens a shell in the test container
5660- Useful for manual testing/debugging
5761
5862### Service Management
5963
6064** ` composer test:integration:start ` **
65+
6166- Starts only OpenFGA and OTEL collector
6267- Doesn't run tests
6368- Useful for manual testing
6469
6570** ` composer test:integration:stop ` **
71+
6672- Stops all test services
6773
6874### Test Execution
6975
7076** ` composer test:integration:run ` **
77+
7178- Runs only the Pest test command
7279- Assumes services are already running
7380- Used internally by other scripts
7481
75- ## CI/CD Scripts
76-
77- ** ` composer test:integration:ci ` ** * (Deprecated)*
78- - Previously used for CI environments
79- - Now replaced by GitHub Actions workflows
80- - Shows deprecation message
81-
8282## Workflow Summary
8383
8484### For Local Development
85+
8586``` bash
8687# Standard test run (builds and optimizes)
8788composer test:integration
@@ -95,11 +96,13 @@ composer test:integration:cached
9596```
9697
9798### For CI/CD
99+
98100- Automated via GitHub Actions
99101- Images built on schedule or when Dockerfile changes
100102- Tests always use pre-built optimized images
101103
102104### For Debugging
105+
103106``` bash
104107# Interactive shell
105108composer test:integration:shell
@@ -108,4 +111,4 @@ composer test:integration:shell
108111composer test:integration:start
109112# ... do manual testing ...
110113composer test:integration:stop
111- ```
114+ ```
0 commit comments