Setup up flutter tests, minimal starter tests

.github/workflows/fluttertest.yml

@@ -0,0 +1,63 @@
+name: Flutter test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - ".github/workflows/fluttercheck.yml"
+      - "**.dart"
+
+jobs:
+  test:
+    name: Run flutter test
+    runs-on: macos-26
+    strategy:
+      matrix:
+        os: [android, ios]
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #6.0.2
+        with:
+          show-progress: false
+
+      # TODO: remove when https://go-review.googlesource.com/c/go/+/692935 lands in mainline go
+      - name: Patch Go
+        uses: DefinedNet/patch-go@c8e4a17c75eb242d34c212419d7d3d25e8d58949
+        with:
+          patch-ref: "296be05a97eb526dc0e438b7387670d4cae4a935"
+
+      - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 #v5.2.0
+        with:
+          distribution: "zulu"
+          java-version: "17"
+          cache: "gradle"
+
+      - name: Install flutter
+        uses: subosito/flutter-action@fd55f4c5af5b953cc57a2be44cb082c8f6635e8e #v2.21.0
+        with:
+          flutter-version: "3.38.9"
+          cache: true
+
+      - name: install dependencies
+        env:
+          TOKEN: ${{ secrets.MACHINE_USER_PAT }}
+        run: |
+          go install golang.org/x/mobile/cmd/gomobile@latest
+          gomobile init
+          flutter pub get
+          touch env.sh
+
+      - name: generate artifacts
+        run: ./gen-artifacts.sh ${{ matrix.os }}
+
+      - name: Run tests
+        run: flutter test --coverage
+
+      - name: Upload coverage artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-${{ matrix.os }}
+          path: coverage/lcov.info
+        if: always()

.gitignore

@@ -35,6 +35,11 @@ android/app/.cxx
 # Web related
 lib/generated_plugin_registrant.dart
 
+# Test coverage
+coverage/
+test/.test_coverage.dart
+*.coverage
+
 # Exceptions to above rules.
 !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
 /nebula/local.settings

README.md

@@ -16,7 +16,7 @@ Ensure your path is set up correctly to execute flutter
 
 Run `flutter doctor` and fix everything it complains before proceeding
 
-*NOTE* on iOS, always open `Runner.xcworkspace` and NOT the `Runner.xccodeproj`
+_NOTE_ on iOS, always open `Runner.xcworkspace` and NOT the `Runner.xccodeproj`
 
 ### Before first compile
 
@@ -30,17 +30,50 @@ Run `flutter doctor` and fix everything it complains before proceeding
 
 If you are having issues with iOS pods, try blowing it all away! `cd ios && rm -rf Pods/ Podfile.lock && pod install --repo-update`
 
+## Testing
+
+Run all tests:
+
+```sh
+flutter test
+```
+
+Run specific test file:
+
+```sh
+flutter test test/screens/settings_screen_test.dart
+```
+
+Generate coverage report:
+
+```sh
+flutter test --coverage
+```
+
+Run golden tests (update with `--update-goldens` flag):
+
+```sh
+flutter test test/screens/*_golden_test.dart
+```
+
+## Linting
+
+```sh
+flutter analyze
+```
+
 # Formatting
 
-`dart format` can be used to format the code in `lib` and `test`.  We use a line-length of 120 characters.
+`dart format` can be used to format the code in `lib` and `test`. We use a line-length of 120 characters.
 
 Use:
+
 ```sh
 dart format lib/ test/ -l 120
 ```
 
-In Android Studio, set the line length using Preferences -> Editor -> Code Style -> Dart -> Line length, set it to 120.  Enable auto-format with Preferences -> Languages & Frameworks -> Flutter -> Format code on save.
+In Android Studio, set the line length using Preferences -> Editor -> Code Style -> Dart -> Line length, set it to 120. Enable auto-format with Preferences -> Languages & Frameworks -> Flutter -> Format code on save.
 
 `./swift-format.sh` can be used to format Swift code in the repo.
 
-Once `swift-format` supports ignoring directories (<https://github.com/swiftlang/swift-format/issues/870>), we can move to a method of running it more like what <https://calebhearth.com/swift-format-github-action> describes.
+Once `swift-format` supports ignoring directories (<https://github.com/swiftlang/swift-format/issues/870>), we can move to a method of running it more like what <https://calebhearth.com/swift-format-github-action> describes.

ios/.gitignore

@@ -22,6 +22,7 @@ Flutter/app.flx
 Flutter/app.zip
 Flutter/flutter_assets/
 Flutter/flutter_export_environment.sh
+Flutter/ephemeral
 ServiceDefinitions.json
 Runner/GeneratedPluginRegistrant.*