test
Run unit tests and instrumentation tests for Canvas Android apps. Use when user mentions testing, running tests, JUnit, Espresso, or checking test results. Includes commands for Student, Teacher, and Parent apps.
When & Why to Use This Skill
This Claude skill streamlines the testing lifecycle for Canvas Android applications by providing automated commands for unit, instrumentation, and Espresso tests. It enables developers to efficiently validate business logic with Mockk and verify UI stability across Student, Teacher, and Parent apps, ensuring high-quality code delivery and faster regression cycles through standardized Gradle workflows.
Use Cases
- Automated Unit Testing: Execute JUnit tests for specific Android modules or shared libraries to validate business logic in isolation using Mockk and automated Gradle tasks.
- UI & Instrumentation Verification: Run Espresso tests on emulators or physical devices to ensure seamless user interactions and UI consistency across different app variants (Student, Teacher, Parent).
- Targeted Test Execution: Use specific flags to isolate and run individual test classes or packages, significantly reducing the time required for debugging and local verification during development.
- Test Result Analysis: Generate and access detailed HTML test reports to identify failures, track code coverage, and maintain high quality standards within the Canvas Android ecosystem.
| name | test |
|---|---|
| description | Run unit tests and instrumentation tests for Canvas Android apps. Use when user mentions testing, running tests, JUnit, Espresso, or checking test results. Includes commands for Student, Teacher, and Parent apps. |
| allowed-tools | Bash, Read |
Test Canvas Android Apps
Run unit tests, instrumentation tests, and Espresso tests for Canvas Android apps.
Test Location
All test commands must be run from the repository root (canvas-android/), not the apps/ directory.
Unit Tests
Unit tests verify business logic in isolation using Mockk for mocking.
Prerequisites
- Set Build Variant to
qaDebugin Android Studio, or - Use command line with
testQaDebugUnitTestas shown below
Run Unit Tests for Apps
# Student app - all unit tests
./gradle/gradlew -p apps :student:testQaDebugUnitTest
# Teacher app - all unit tests
./gradle/gradlew -p apps :teacher:testQaDebugUnitTest
# Parent app - all unit tests
./gradle/gradlew -p apps :parent:testQaDebugUnitTest
Run Unit Tests for Shared Libraries
# Test a specific module (e.g., pandautils)
./gradle/gradlew -p apps :pandautils:testDebugUnitTest
# Test specific class or package
./gradle/gradlew -p apps :pandautils:testDebugUnitTest --tests "com.instructure.pandautils.features.discussion.router.*"
# Force re-run tests (ignore cache)
./gradle/gradlew -p apps :pandautils:testDebugUnitTest --rerun-tasks
Run Specific Unit Tests
Use the --tests flag to run specific test classes or methods:
# Run single test class
./gradle/gradlew -p apps :student:testQaDebugUnitTest --tests "com.instructure.student.features.dashboard.DashboardViewModelTest"
# Run tests matching a pattern
./gradle/gradlew -p apps :student:testQaDebugUnitTest --tests "com.instructure.student.features.dashboard.widget.*"
Test Structure
- Unit tests:
src/test/java/com/instructure/{app}/features/{feature}/ - Instrumentation tests:
src/androidTest/java/com/instructure/{app}/ui/{feature}/
Instrumentation/Espresso Tests
Instrumentation tests run on a device or emulator to test UI interactions.
Prerequisites
Before running UI tests, check for connected devices:
adb devices -l
If multiple devices are connected:
- Prefer running on an emulator if available
- Use
ANDROID_SERIALenvironment variable or-sflag to specify a device
Run All Instrumentation Tests
# Student app
./gradle/gradlew -p apps :student:connectedQaDebugAndroidTest
# Teacher app
./gradle/gradlew -p apps :teacher:connectedQaDebugAndroidTest
Run Specific Instrumentation Test
# Run single test class
./gradle/gradlew -p apps :student:connectedQaDebugAndroidTest -Pandroid.testInstrumentationRunnerArguments.class=com.instructure.student.ui.dashboard.DashboardPageTest
Target Specific Device
If multiple devices are connected:
# Use environment variable
ANDROID_SERIAL=emulator-5554 ./gradle/gradlew -p apps :student:connectedQaDebugAndroidTest
# Or use adb flag
adb -s emulator-5554 shell ...
Testing Patterns
- Write unit tests in the same style as existing tests (check
student/src/test/) - Write instrumentation tests following existing patterns (check
student/src/androidTest/) - Mock dependencies with Mockk
- Use test doubles for repositories in ViewModel tests
- Espresso tests should use page object pattern from
:espressomodule - Ensure tests are isolated and repeatable
Examples
Run all widget tests:
./gradle/gradlew -p apps :student:testQaDebugUnitTest --tests "com.instructure.student.features.dashboard.widget.*"
Run tests and view report:
./gradle/gradlew -p apps :student:testQaDebugUnitTest
open apps/student/build/reports/tests/testQaDebugUnitTest/index.html