unitTesting-asu2025F

.github/workflows/build_artifacts.yml

@@ -0,0 +1,103 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+
+name: Build APKs
+run-name: ${{ github.event.inputs.custom_run_name || github.workflow }}
+
+on:
+  # run anytime a PR is merged to main or a direct push to main
+  push:
+    branches: [main]
+
+  # run on any push to a PR branch
+  pull_request:
+
+  # run on demand
+  workflow_dispatch:
+    inputs:
+      custom-run-name:
+        description: "Custom name for this Actions run"
+        required: false
+        type: string
+
+# cancel any previously-started, yet still active runs of this workflow on the same branch
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Notify User to Scroll
+        run: |
+          echo "## Scroll to the end of the page for artifacts :arrow_down:" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "---" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: "21"
+          distribution: "temurin"
+
+      # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
+      # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
+
+      - name: Change wrapper permissions
+        run: chmod +x ./gradlew
+
+      - name: Build with Gradle Wrapper
+        run: ./gradlew build
+
+      - name: Upload App Debug APK
+        uses: actions/upload-artifact@v4
+        with:
+          name: app-debug-apk # Optional: Name your artifact
+          path: app/build/outputs/apk/debug/app-debug.apk # Path to your build output (e.g., JARs, WARs)
+          retention-days: 1 # Optional: Set a custom retention period in days
+
+      - name: Upload App Release APK
+        uses: actions/upload-artifact@v4
+        with:
+          name: app-release-apk # Optional: Name your artifact
+          path: app/build/outputs/apk/release/app-release-unsigned.apk # Path to your build output (e.g., JARs, WARs)
+          retention-days: 1 # Optional: Set a custom retention period in days
+    # NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html).
+    # If your project does not have the Gradle Wrapper configured, you can use the following configuration to run Gradle with a specified version.
+    #
+    # - name: Setup Gradle
+    #   uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
+    #   with:
+    #     gradle-version: '8.9'
+    #
+    # - name: Build with Gradle 8.9
+    #   run: gradle build
+
+  dependency-submission:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: "21"
+          distribution: "temurin"
+
+      # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies.
+      # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md
+      - name: Generate and submit dependency graph
+        uses: gradle/actions/dependency-submission@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0

.github/workflows/format_and_lint.yml

@@ -0,0 +1,56 @@
+---
+# template source: https://github.com/bretfisher/super-linter-workflow/blob/main/templates/call-super-linter.yaml
+name: Lint Code Base
+run-name: ${{ github.event.inputs.custom_run_name || github.workflow }}
+
+on:
+  # run anytime a PR is merged to main or a direct push to main
+  push:
+    branches: [main]
+
+  # run on any push to a PR branch
+  pull_request:
+
+  # run on demand
+  workflow_dispatch:
+    inputs:
+      custom-run-name:
+        description: "Custom name for this Actions run"
+        required: false
+        type: string
+
+# cancel any previously-started, yet still active runs of this workflow on the same branch
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+permissions: read-all
+
+# adapted from https://mskelton.medium.com/auto-formatting-code-using-prettier-and-github-actions-ed458f58b7df
+jobs:
+  call-super-linter:
+    #  needs: format
+    name: Call Super-Linter
+
+    permissions:
+      contents: read # clone the repo to lint
+      statuses: write # read/write to repo custom statuses
+
+    ### use Reusable Workflows to call my workflow remotely
+    ### https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
+    ### you can also call workflows from inside the same repo via file path
+
+    # FIXME: customize uri to point to your own reusable linter repository
+    uses: polygeist111/super-linter-workflow/.github/workflows/reusable-super-linter.yaml@main
+    # TODO: update url to point to gb reusable linter, not thalia's
+
+    ### Optional settings examples
+
+    # with:
+    ### For a DevOps-focused repository. Prevents some code-language linters from running
+    ### defaults to false
+    # devops-only: false
+
+    ### A regex to exclude files from linting
+    ### defaults to empty
+    # filter-regex-exclude:

.github/workflows/report_kotlin_coverage.yml

@@ -0,0 +1,67 @@
+name: Measure Test Coverage
+run-name: ${{ github.event.inputs.custom_run_name || github.workflow }}
+
+on:
+  # run anytime a PR is merged to main or a direct push to main
+  push:
+    branches: [main]
+
+  # run on any push to a PR branch
+  pull_request:
+
+  # run on demand
+  workflow_dispatch:
+    inputs:
+      custom-run-name:
+        description: "Custom name for this Actions run"
+        required: false
+        type: string
+
+# cancel any previously-started, yet still active runs of this workflow on the same branch
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Define Coverage Minimums
+        run: |
+          echo "min-coverage-overall=80" >> $GITHUB_ENV
+          echo "min-coverage-changed-files=80" >> $GITHUB_ENV
+      - uses: actions/checkout@v3
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: "temurin"
+          java-version: "21"
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v3
+      - name: Generate kover coverage report
+        run: ./gradlew koverXmlReport
+      - name: Add coverage report to PR
+        id: kover
+        uses: mi-kas/kover-report@v1
+        with:
+          path: |
+            ${{ github.workspace }}/app/build/reports/kover/report.xml
+          title: Code Coverage
+          update-comment: true
+          min-coverage-overall: ${{ env.min-coverage-overall }}
+          min-coverage-changed-files: ${{ env.min-coverage-changed-files }}
+          coverage-counter-type: LINE
+      - name: Add short summary to workflow run
+        run: |
+          echo "| Type | Coverage | Passing |" >> $GITHUB_STEP_SUMMARY
+          echo "|---|---|---|" >> $GITHUB_STEP_SUMMARY
+          echo "| Overall Coverage | ${{ steps.kover.outputs.coverage-overall }}% | ${{ steps.kover.outputs.coverage-overall >= env.min-coverage-overall && ':white_check_mark:' || ':x:' }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Changed File Coverage | ${{ steps.kover.outputs.coverage-changed-files }}% | ${{ steps.kover.outputs.coverage-changed-files >= env.min-coverage-changed-files && ':white_check_mark:' || ':x:' }} |" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "(Changed File Coverage is currently bugged, disregard)" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "---" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -62,3 +62,5 @@ kotlin-ide/
 .idea/
 .aider*
 .env
+.idea/misc.xml
+.vscode/

.husky/pre-commit

@@ -0,0 +1 @@
+npm run lint-staged

.prettierignore

@@ -0,0 +1,3 @@
+build
+coverage
+node_modules

CI_README.md

@@ -0,0 +1,5 @@
+The CI pipeline behaves as follows:
+
+1. run Prettier on web-related filetypes, as well as XML
+   a. Do not use prettier-plugin-kotlin, it is not maintained and errors regularly
+2. On push, run super-linter. For all possible cases, run autofix (this covers Kotlin)

README.md

@@ -1,19 +1,29 @@
 # Project Mesh
--------------------
+
+---
+
 Grey-box.ca
 New version by wil-mesh-rmit
 
-Project Mesh runs locally on an android device. Build the project then either export the APK and send to the device, or use ADB to install. The app only works on physical devices, and not the android simulator. 
+Project Mesh runs locally on an android device. Build the project then either export the APK and send to the device, or use ADB to install. The app only works on physical devices, and not the android simulator.
+
+<div align="center">
+
+![Super-Linter](https://github.com/polygeist111/project-mesh/actions/workflows/format_and_lint.yml/badge.svg)
+![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)
+
+</div>
 
 # Deployment Instructions
-The Android app runs independently of an internet connection. The APK needs to be installed in each phone, then the phones are able to connect to each other from within the app. 
+
+The Android app runs independently of an internet connection. The APK needs to be installed in each phone, then the phones are able to connect to each other from within the app.
+
 1. Open the app
 2. When prompted, allow location and nearby devices permissions
 3. Wait for a QR code to appear on screen
 4. On each phone, use the ‘Scan QR code’ button to scan the codes of adjacent devices
 5. Messages are able to be sent to connected devices with the ‘Send’ button and ‘Message’ text box
 
-
 Credential info: N/A
 
 GitHub URL: https://github.com/grey-box/Project-Mesh

app/build.gradle.kts

@@ -4,6 +4,7 @@ plugins {
     id("kotlin-kapt")
     id("com.google.devtools.ksp") version "1.9.0-1.0.13"
     kotlin("plugin.serialization") version "1.9.0"
+    id("org.jetbrains.kotlinx.kover") version "0.9.3"
 }
 
 android {
@@ -84,7 +85,21 @@ dependencies {
     implementation(libs.androidx.activity)
     implementation(libs.androidx.navigation.compose)
     implementation(libs.androidx.lifecycle.viewmodel.android)
+
     testImplementation(libs.junit)
+
+    // ===============================
+    // Unit testing (JVM) deps added
+    // ===============================
+    testImplementation("junit:junit:4.13.2")
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.8.1")
+    testImplementation("io.mockk:mockk:1.13.12")
+    testImplementation("org.robolectric:robolectric:4.12.2")
+    testImplementation("androidx.test:core:1.6.1")
+    testImplementation("app.cash.turbine:turbine:1.1.0")
+
+
+
     androidTestImplementation(libs.androidx.junit)
     androidTestImplementation(libs.androidx.espresso.core)
     androidTestImplementation(platform(libs.androidx.compose.bom))
@@ -137,6 +152,12 @@ dependencies {
     // optional - Test helpers
     testImplementation("androidx.room:room-testing:$room_version")
 
+    // Unit test libs (local JVM tests in app/src/test)
+    testImplementation("io.mockk:mockk:1.13.12")
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.8.1")
+    testImplementation("org.robolectric:robolectric:4.12.2")
+    testImplementation("androidx.test:core:1.6.1")
+
     // optional - Paging 3 Integration
     implementation("androidx.room:room-paging:$room_version")
 
@@ -145,4 +166,4 @@ dependencies {
 
     // For JSON serialisation
     implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.3")
-}
+}