Skip to content

Commit 9ab77db

Browse files
claudeclaude
committed
Add GitHub Actions workflows for Compose Multiplatform UI tests
This commit adds CI/CD workflows to automatically run the Compose Multiplatform UI tests on pull requests and pushes to main/master branches. New Workflows: 1. compose-ui-tests.yml (Recommended for fast feedback) - Runs Compose UI tests on JVM platform - Executes in ~3 minutes for quick feedback - Uploads test results as artifacts (7 day retention) - Publishes detailed test reports with pass/fail info - Uses Gradle caching for optimal performance - Includes concurrency control to cancel outdated runs 2. multiplatform-tests.yml (Comprehensive platform coverage) - Runs tests on all supported platforms: * JVM (ubuntu-24.04) * Android (ubuntu-24.04, Robolectric) * iOS (macos-14, simulator arm64) * WebAssembly (ubuntu-24.04) - Includes test summary job aggregating all results - Uploads platform-specific test result artifacts - Executes in ~10-15 minutes 3. README.md - Comprehensive documentation of all workflows - Guidance on choosing between fast vs comprehensive tests - Local testing commands and troubleshooting tips - Best practices for adding new tests Features: - Parallel test execution where possible - Artifact uploads for debugging test failures - JUnit XML report generation - Concurrency control to save CI resources - Gradle caching for faster builds - Clear test result visualization in PR checks The workflows automatically run tests from common/src/commonTest including: - ComposeMultiplatformUiTests.kt - ISSPositionUiTests.kt - ViewModelUiTests.kt - TestTagExampleTests.kt 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 484fba6 commit 9ab77db

File tree

3 files changed

+392
-0
lines changed

3 files changed

+392
-0
lines changed

‎.github/workflows/README.md‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
# GitHub Actions Workflows
2+
3+
This directory contains CI/CD workflows for the PeopleInSpace project.
4+
5+
## Workflows
6+
7+
### Platform-Specific Workflows
8+
9+
#### `android.yml` - Android CI
10+
- **Trigger**: Pull requests
11+
- **Jobs**:
12+
- Build: Builds Android app and runs unit tests
13+
- AndroidTest: Runs instrumentation tests on Android emulator (API 26)
14+
- **Runner**: ubuntu-24.04
15+
16+
#### `ios.yml` - iOS CI
17+
- **Trigger**: Pull requests
18+
- **Jobs**: Builds iOS app using Xcode
19+
- **Runner**: macos-14
20+
- **Concurrency**: Cancels previous runs from same PR
21+
22+
#### `web.yml` - Web CI
23+
- **Trigger**: Pull requests
24+
- **Jobs**: Builds WebAssembly app
25+
- **Runner**: ubuntu-24.04
26+
- **Note**: Has commented-out deployment to GitHub Pages
27+
28+
#### `wearos.yml` - Wear OS CI
29+
- **Trigger**: Pull requests
30+
- **Jobs**: Builds Wear OS app
31+
- **Runner**: ubuntu-24.04
32+
33+
#### `maestro.yml` - E2E Tests
34+
- **Trigger**: Pull requests
35+
- **Jobs**: Runs end-to-end tests using Maestro
36+
- **Runner**: ubuntu-24.04
37+
38+
### Multiplatform Test Workflows
39+
40+
#### `compose-ui-tests.yml` - Compose UI Tests (Recommended)
41+
- **Trigger**: Pull requests and pushes to main/master
42+
- **Purpose**: Runs Compose Multiplatform UI tests from `common/src/commonTest`
43+
- **Platform**: JVM (fastest and most reliable for CI)
44+
- **Features**:
45+
- Runs all UI tests matching `*Ui*` pattern
46+
- Uploads test results as artifacts (7 day retention)
47+
- Publishes detailed test report with pass/fail information
48+
- Uses Gradle caching for faster builds
49+
- Cancels in-progress runs on new commits
50+
51+
**Test Files Covered**:
52+
- `ComposeMultiplatformUiTests.kt` - Basic UI component tests
53+
- `ISSPositionUiTests.kt` - ISS position display tests
54+
- `ViewModelUiTests.kt` - ViewModel integration tests
55+
- `TestTagExampleTests.kt` - Test tag usage examples
56+
57+
#### `multiplatform-tests.yml` - Full Platform Coverage
58+
- **Trigger**: Pull requests and pushes to main/master
59+
- **Purpose**: Runs common module tests on all supported platforms
60+
- **Jobs**:
61+
1. **jvm-tests**: Runs tests on JVM (Linux)
62+
2. **android-tests**: Runs Android unit tests (Robolectric)
63+
3. **ios-tests**: Runs iOS simulator tests (macOS)
64+
4. **wasm-tests**: Runs WebAssembly tests
65+
5. **test-summary**: Aggregates results from all platforms
66+
67+
**Note**: This workflow is more comprehensive but takes longer to complete due to multiple platform builds.
68+
69+
## Choosing Between Workflows
70+
71+
### Use `compose-ui-tests.yml` when:
72+
- ✅ You want fast feedback on UI tests (2-3 minutes)
73+
- ✅ You're primarily testing UI logic that's platform-agnostic
74+
- ✅ You want detailed test reports in PR checks
75+
- ✅ You need quick iteration during development
76+
77+
### Use `multiplatform-tests.yml` when:
78+
- ✅ You need to verify tests pass on all platforms
79+
- ✅ You're testing platform-specific behavior
80+
- ✅ You're preparing for a release
81+
- ✅ You have time for longer CI runs (10-15 minutes)
82+
83+
## Local Testing
84+
85+
Before pushing, run tests locally to catch issues early:
86+
87+
```bash
88+
# Run UI tests on JVM (fastest)
89+
./gradlew :common:jvmTest --tests "*Ui*"
90+
91+
# Run all common tests on JVM
92+
./gradlew :common:jvmTest
93+
94+
# Run Android tests
95+
./gradlew :common:testDebugUnitTest
96+
97+
# Run iOS tests (macOS only)
98+
./gradlew :common:iosSimulatorArm64Test
99+
100+
# Run WebAssembly tests
101+
./gradlew :common:wasmJsTest
102+
103+
# Run all platform tests
104+
./gradlew :common:test
105+
```
106+
107+
## Test Results
108+
109+
Test results are uploaded as artifacts and accessible in the GitHub Actions UI:
110+
- **Retention**: 7 days for UI test results
111+
- **Format**: HTML reports and JUnit XML
112+
- **Location**: Actions tab → Workflow run → Artifacts section
113+
114+
## Troubleshooting
115+
116+
### Tests Failing on CI but Passing Locally
117+
118+
1. Check for timing issues - CI might be slower:
119+
```kotlin
120+
testDispatcher.scheduler.advanceUntilIdle()
121+
waitForIdle()
122+
```
123+
124+
2. Verify test isolation - tests should not depend on order
125+
126+
3. Check platform-specific behavior
127+
128+
### Gradle Build Issues
129+
130+
- Ensure `kotlinUpgradeYarnLock` runs for WebAssembly builds
131+
- Check Java version (requires JDK 17)
132+
- Verify Gradle wrapper is up to date
133+
134+
### iOS Test Failures
135+
136+
- iOS tests require macOS runners (more expensive)
137+
- Consider running iOS tests only on main branch or release tags
138+
139+
## Workflow Best Practices
140+
141+
1. **Fast Feedback**: `compose-ui-tests.yml` runs quickly (~3 min)
142+
2. **Comprehensive Coverage**: `multiplatform-tests.yml` verifies all platforms
143+
3. **Artifact Retention**: Test results kept for 7 days for debugging
144+
4. **Concurrency Control**: Only latest run per PR/branch executes
145+
5. **Clear Naming**: Test artifacts clearly labeled by platform
146+
147+
## Adding New Tests
148+
149+
When adding new UI tests to `common/src/commonTest`:
150+
151+
1. Follow naming convention: `*UiTests.kt`
152+
2. Tests will automatically run in CI (matched by `*Ui*` pattern)
153+
3. Use `@Test` annotation from `kotlin.test`
154+
4. Use `runComposeUiTest` for compose UI tests
155+
5. Add test tags for better test stability
156+
157+
Example:
158+
```kotlin
159+
@Test
160+
fun myNewUiTest() = runComposeUiTest {
161+
setContent { MyComposable() }
162+
onNodeWithTag("myElement").assertIsDisplayed()
163+
}
164+
```
165+
166+
## Status Checks
167+
168+
Required status checks for PRs:
169+
- Compose UI Tests (JVM) - from `compose-ui-tests.yml`
170+
- Platform builds (Android, iOS, Web, Wear OS) - from platform workflows
171+
172+
Optional/informational checks:
173+
- Full multiplatform test suite - from `multiplatform-tests.yml`
174+
175+
## Resources
176+
177+
- [GitHub Actions Documentation](https://docs.github.com/en/actions)
178+
- [Gradle Actions](https://github.com/gradle/actions)
179+
- [Compose Multiplatform Testing](https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-test.html)

‎.github/workflows/compose-ui-tests.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Compose UI Tests
2+
3+
# This workflow runs the Compose Multiplatform UI tests in commonTest
4+
# These tests can run on multiple platforms and use the multiplatform UI testing framework
5+
6+
on:
7+
pull_request:
8+
push:
9+
branches: [ main, master ]
10+
11+
# Cancel any current or previous job from the same PR
12+
concurrency:
13+
group: compose-ui-tests-${{ github.head_ref || github.ref }}
14+
cancel-in-progress: true
15+
16+
jobs:
17+
compose-ui-tests:
18+
name: Compose UI Tests (JVM)
19+
runs-on: ubuntu-24.04
20+
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v5
24+
25+
- name: Set up JDK 17
26+
uses: actions/setup-java@v5
27+
with:
28+
distribution: 'zulu'
29+
java-version: 17
30+
cache: 'gradle'
31+
32+
- name: Setup Gradle
33+
uses: gradle/actions/setup-gradle@v4
34+
with:
35+
cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/master' }}
36+
37+
- name: Grant execute permission for gradlew
38+
run: chmod +x gradlew
39+
40+
- name: Run Compose UI Tests
41+
run: ./gradlew :common:jvmTest --tests "*Ui*" --no-daemon --stacktrace
42+
43+
- name: Upload Test Results
44+
if: always()
45+
uses: actions/upload-artifact@v4
46+
with:
47+
name: compose-ui-test-results
48+
path: |
49+
common/build/reports/tests/jvmTest/
50+
common/build/test-results/jvmTest/*.xml
51+
retention-days: 7
52+
53+
- name: Publish Test Report
54+
if: always()
55+
uses: mikepenz/action-junit-report@v4
56+
with:
57+
report_paths: 'common/build/test-results/jvmTest/*.xml'
58+
check_name: 'Compose UI Test Results'
59+
detailed_summary: true
60+
include_passed: true
61+
fail_on_failure: true

‎.github/workflows/multiplatform-tests.yml‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
name: Multiplatform Tests
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [ main, master ]
7+
8+
# Cancel any current or previous job from the same PR
9+
concurrency:
10+
group: multiplatform-tests-${{ github.head_ref || github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
# JVM/Desktop tests (fastest, most reliable)
15+
jvm-tests:
16+
name: JVM Tests
17+
runs-on: ubuntu-24.04
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v5
22+
23+
- name: Set up JDK 17
24+
uses: actions/setup-java@v5
25+
with:
26+
distribution: 'zulu'
27+
java-version: 17
28+
29+
- name: Setup Gradle
30+
uses: gradle/actions/setup-gradle@v4
31+
32+
- name: Run Common JVM Tests
33+
run: ./gradlew :common:jvmTest --no-daemon --stacktrace
34+
35+
- name: Upload Test Results
36+
if: always()
37+
uses: actions/upload-artifact@v4
38+
with:
39+
name: jvm-test-results
40+
path: common/build/reports/tests/jvmTest/
41+
42+
# Android Unit Tests (Robolectric)
43+
android-tests:
44+
name: Android Tests
45+
runs-on: ubuntu-24.04
46+
47+
steps:
48+
- name: Checkout
49+
uses: actions/checkout@v5
50+
51+
- name: Set up JDK 17
52+
uses: actions/setup-java@v5
53+
with:
54+
distribution: 'zulu'
55+
java-version: 17
56+
57+
- name: Setup Gradle
58+
uses: gradle/actions/setup-gradle@v4
59+
60+
- name: Run Common Android Tests
61+
run: ./gradlew :common:testDebugUnitTest --no-daemon --stacktrace
62+
63+
- name: Upload Test Results
64+
if: always()
65+
uses: actions/upload-artifact@v4
66+
with:
67+
name: android-test-results
68+
path: common/build/reports/tests/testDebugUnitTest/
69+
70+
# iOS Tests (requires macOS)
71+
ios-tests:
72+
name: iOS Tests
73+
runs-on: macos-14
74+
75+
steps:
76+
- name: Checkout
77+
uses: actions/checkout@v5
78+
79+
- name: Set up JDK 17
80+
uses: actions/setup-java@v5
81+
with:
82+
distribution: 'zulu'
83+
java-version: 17
84+
85+
- name: Setup Gradle
86+
uses: gradle/actions/setup-gradle@v4
87+
88+
- name: Run iOS Simulator Arm64 Tests
89+
run: ./gradlew :common:iosSimulatorArm64Test --no-daemon --stacktrace
90+
91+
- name: Upload Test Results
92+
if: always()
93+
uses: actions/upload-artifact@v4
94+
with:
95+
name: ios-test-results
96+
path: common/build/reports/tests/iosSimulatorArm64Test/
97+
98+
# WebAssembly Tests
99+
wasm-tests:
100+
name: WebAssembly Tests
101+
runs-on: ubuntu-24.04
102+
103+
steps:
104+
- name: Checkout
105+
uses: actions/checkout@v5
106+
107+
- name: Set up JDK 17
108+
uses: actions/setup-java@v5
109+
with:
110+
distribution: 'zulu'
111+
java-version: 17
112+
113+
- name: Setup Gradle
114+
uses: gradle/actions/setup-gradle@v4
115+
116+
- name: kotlinUpgradeYarnLock
117+
run: ./gradlew kotlinUpgradeYarnLock
118+
119+
- name: Run WebAssembly Tests
120+
run: ./gradlew :common:wasmJsTest --no-daemon --stacktrace
121+
122+
- name: Upload Test Results
123+
if: always()
124+
uses: actions/upload-artifact@v4
125+
with:
126+
name: wasm-test-results
127+
path: common/build/reports/tests/wasmJsTest/
128+
129+
# Summary job that requires all tests to pass
130+
test-summary:
131+
name: Test Summary
132+
runs-on: ubuntu-24.04
133+
needs: [jvm-tests, android-tests, ios-tests, wasm-tests]
134+
if: always()
135+
136+
steps:
137+
- name: Check test results
138+
run: |
139+
echo "JVM Tests: ${{ needs.jvm-tests.result }}"
140+
echo "Android Tests: ${{ needs.android-tests.result }}"
141+
echo "iOS Tests: ${{ needs.ios-tests.result }}"
142+
echo "WASM Tests: ${{ needs.wasm-tests.result }}"
143+
144+
if [ "${{ needs.jvm-tests.result }}" != "success" ] || \
145+
[ "${{ needs.android-tests.result }}" != "success" ] || \
146+
[ "${{ needs.ios-tests.result }}" != "success" ] || \
147+
[ "${{ needs.wasm-tests.result }}" != "success" ]; then
148+
echo "One or more test suites failed"
149+
exit 1
150+
fi
151+
152+
echo "All tests passed successfully!"

0 commit comments

Comments
 (0)