Adding UI testing of APRSdroid

.github/workflows/android.yml

@@ -0,0 +1,188 @@
+name: Android CI
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: [ '**' ]
+  workflow_dispatch:
+
+jobs:
+  compile:
+    runs-on: ubuntu-latest
+    name: "Compile all sources"
+
+    steps:
+    - name: Checkout project
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        submodules: recursive
+
+    - name: Set up JDK 11
+      uses: actions/setup-java@v4
+      with:
+        java-version: '11'
+        distribution: 'adopt'
+        cache: gradle
+
+    - name: Load build outputs
+      uses: actions/cache@v4
+      with:
+        path: build
+        key: build-${{ github.sha }}
+
+    - name: Create properties file with empty API key
+      run: echo mapsApiKey="\"${{ secrets.mapsApiKey }}\"" >> local.properties
+
+    - name: Build App
+      run: ./gradlew assemble --stacktrace
+
+    - name: Build unit tests
+      run: ./gradlew assembleDebugUnitTest assembleReleaseUnitTest --stacktrace
+
+    - name: Build instrumentation tests
+      run: ./gradlew assembleAndroidTest --stacktrace
+
+  unit-test:
+    name: "Run all unit tests"
+    needs: compile
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout project
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        submodules: recursive
+
+    - name: Set up JDK 11
+      uses: actions/setup-java@v4
+      with:
+        java-version: '11'
+        distribution: 'adopt'
+        cache: gradle
+
+    - name: Load build outputs
+      uses: actions/cache@v4
+      with:
+        path: build
+        key: build-${{ github.sha }}
+
+    - name: Run Unit Tests
+      run: ./gradlew test --stacktrace
+
+    - name: Run Linter
+      run: ./gradlew lint --stacktrace
+      continue-on-error: true
+
+    - name: Upload reports
+      uses: actions/upload-artifact@v4
+      with:
+        name: Unit Test Reports
+        path: build/reports
+      if: failure()
+
+  instrumentation:
+    name: "Testing on API ${{ matrix.api-level }} for ${{ matrix.target }}"
+    needs: compile
+    # macOS provided hardware-accelerated emulator
+    # but now so does Linux
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        api-level: [ 15, 21, 24, 31 ]
+        target: [ default, google_apis, google_apis_playstore ]
+        exclude:
+          - api-level: 15
+            target: google_apis_playstore
+          - api-level: 21
+            target: google_apis_playstore
+          - api-level: 24
+            target: google_apis
+          - api-level: 31
+            target: google_apis
+
+    steps:
+    - name: Checkout project
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        submodules: recursive
+
+    - name: Enable KVM
+      run: |
+        echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+        sudo udevadm control --reload-rules
+        sudo udevadm trigger --name-match=kvm
+
+    - name: Set up JDK 11
+      uses: actions/setup-java@v4
+      with:
+        java-version: '11'
+        distribution: 'adopt'
+        cache: gradle
+
+    - name: Load build outputs
+      uses: actions/cache@v4
+      with:
+        path: build
+        key: build-${{ github.sha }}
+
+    - name: AVD cache
+      uses: actions/cache@v4
+      id: avd-cache
+      with:
+        path: |
+          ~/.android/avd/*
+          ~/.android/adb*
+        key: avd-${{ matrix.api-level }}-${{ matrix.target }}-sd
+
+    - name: Set up JRE 17
+      uses: actions/setup-java@v4
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        java-package: 'jre'
+        #cache: gradle
+
+    - name: Create AVD and generate snapshot for caching
+      if: steps.avd-cache.outputs.cache-hit != 'true'
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ matrix.api-level }}
+        target: ${{ matrix.target }}
+        arch: ${{ matrix.api-level >= 30 && 'x86_64' || 'x86' }}
+        force-avd-creation: false
+        sdcard-path-or-size: '64M'
+        emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+        disable-animations: false
+        script: echo "Generated AVD snapshot for caching."
+
+    - name: Run Instrumented Tests
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ matrix.api-level }}
+        target: ${{ matrix.target }}
+        arch: ${{ matrix.api-level >= 30 && 'x86_64' || 'x86' }}
+        profile: Nexus 6
+        force-avd-creation: false
+        sdcard-path-or-size: '64M'
+        emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+        disable-animations: true
+        script: adb logcat -c && adb logcat -f /sdcard/logcat.txt & JAVA_HOME="${JAVA_HOME_11_X64}" ./gradlew connectedCheck --stacktrace || ( adb pull /sdcard/logcat.txt build/reports/; exit 1 )
+
+    - name: Upload reports
+      uses: actions/upload-artifact@v4
+      with:
+        name: Instrument Test Reports API ${{ matrix.api-level }} ${{ matrix.target }}
+        path: build/reports
+      if: failure()
+
+    - name: Save successful debug APK
+      uses: actions/upload-artifact@v4
+      with:
+        name: Debug APK
+        path: build/outputs/apk/debug/aprsdroid-debug.apk
+      if: matrix.api-level == 31 && matrix.target == 'google_apis'

README.md

@@ -8,6 +8,8 @@ messages.
 
 APRSdroid is Open Source Software written in Scala and licensed under the GPLv2.
 
+master: [![Android CI](../../actions/workflows/android.yml/badge.svg?branch=master&event=push)](../../actions/workflows/android.yml)
+
 Quick links:
 
 - [Google Play](https://play.google.com/store/apps/details?id=org.aprsdroid.app)

androidTest/java/org/aprsdroid/app/CoordinateTest.java

@@ -0,0 +1,57 @@
+package org.aprsdroid.app;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.closeTo;
+
+import org.aprsdroid.app.testing.CoordinateMatcher;
+import org.junit.Test;
+
+import scala.Tuple2;
+
+public class CoordinateTest {
+    // Reference data generated from https://www.pgc.umn.edu/apps/convert/
+    private static final String providedNLatitude = "77° 15' 30\" N";
+    private static final float expectedNLatitude = 77.258333f;
+    private static final String providedELongitude = "164° 45' 15\" E";
+    private static final float expectedELongitude = 164.754167f;
+    private static final String providedSLatitude = "45° 30' 45\" S";
+    private static final float expectedSLatitude = -45.5125f;
+    private static final String providedWLongitude = "97° 20' 40\" W";
+    private static final float expectedWLongitude = -97.344444f;
+
+    @Test
+    public void givenLocationInNEHemisphere_whenFormattedAsDMSString_thenParseBackIntoDecimalValue() {
+        Tuple2<String, String> actual = AprsPacket$.MODULE$.formatCoordinates(expectedNLatitude, expectedELongitude);
+        float floatLatitude = CoordinateMatcher.matchLatitude(actual._1);
+        float floatLongitude = CoordinateMatcher.matchLongitude(actual._2);
+        assertThat("Latitude", (double) floatLatitude, closeTo((double) expectedNLatitude, 1e-7));
+        assertThat("Longitude", (double) floatLongitude, closeTo((double) expectedELongitude, 1e-7));
+    }
+
+    @Test
+    public void givenLocationInNWHemisphere_whenFormattedAsDMSString_thenParseBackIntoDecimalValue() {
+        Tuple2<String, String> actual = AprsPacket$.MODULE$.formatCoordinates(expectedNLatitude, expectedWLongitude);
+        float floatLatitude = CoordinateMatcher.matchLatitude(actual._1);
+        float floatLongitude = CoordinateMatcher.matchLongitude(actual._2);
+        assertThat("Latitude", (double) floatLatitude, closeTo((double) expectedNLatitude, 1e-7));
+        assertThat("Longitude", (double) floatLongitude, closeTo((double) expectedWLongitude, 1e-7));
+    }
+
+    @Test
+    public void givenLocationInSEHemisphere_whenFormattedAsDMSString_thenParseBackIntoDecimalValue() {
+        Tuple2<String, String> actual = AprsPacket$.MODULE$.formatCoordinates(expectedSLatitude, expectedELongitude);
+        float floatLatitude = CoordinateMatcher.matchLatitude(actual._1);
+        float floatLongitude = CoordinateMatcher.matchLongitude(actual._2);
+        assertThat("Latitude", (double) floatLatitude, closeTo((double) expectedSLatitude, 1e-7));
+        assertThat("Longitude", (double) floatLongitude, closeTo((double) expectedELongitude, 1e-7));
+    }
+
+    @Test
+    public void givenLocationInSWHemisphere_whenFormattedAsDMSString_thenParseBackIntoDecimalValue() {
+        Tuple2<String, String> actual = AprsPacket$.MODULE$.formatCoordinates(expectedSLatitude, expectedWLongitude);
+        float floatLatitude = CoordinateMatcher.matchLatitude(actual._1);
+        float floatLongitude = CoordinateMatcher.matchLongitude(actual._2);
+        assertThat("Latitude", (double) floatLatitude, closeTo((double) expectedSLatitude, 1e-7));
+        assertThat("Longitude", (double) floatLongitude, closeTo((double) expectedWLongitude, 1e-7));
+    }
+}

androidTest/java/org/aprsdroid/app/ExampleInstrumentedTest.java

@@ -2,8 +2,8 @@
 
 import android.content.Context;
 
-import android.support.test.InstrumentationRegistry;
-import android.support.test.runner.AndroidJUnit4;
+import androidx.test.platform.app.InstrumentationRegistry;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
 
 import org.junit.Test;
 import org.junit.runner.RunWith;

androidTest/java/org/aprsdroid/app/FirstRunDialog.java

@@ -0,0 +1,112 @@
+package org.aprsdroid.app;
+
+import static androidx.test.espresso.Espresso.onView;
+import static androidx.test.espresso.action.ViewActions.click;
+import static androidx.test.espresso.action.ViewActions.closeSoftKeyboard;
+import static androidx.test.espresso.action.ViewActions.typeText;
+import static androidx.test.espresso.assertion.ViewAssertions.doesNotExist;
+import static androidx.test.espresso.assertion.ViewAssertions.matches;
+import static androidx.test.espresso.matcher.RootMatchers.isDialog;
+import static androidx.test.espresso.matcher.ViewMatchers.hasDescendant;
+import static androidx.test.espresso.matcher.ViewMatchers.isRoot;
+import static androidx.test.espresso.matcher.ViewMatchers.withHint;
+import static androidx.test.espresso.matcher.ViewMatchers.withId;
+import static androidx.test.espresso.matcher.ViewMatchers.withText;
+import static org.hamcrest.core.AllOf.allOf;
+import static org.hamcrest.core.StringContains.containsString;
+
+import android.content.SharedPreferences;
+
+import androidx.test.ext.junit.rules.ActivityScenarioRule;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+
+import org.aprsdroid.app.testing.SharedPreferencesRule;
+import org.junit.Assert;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.RuleChain;
+import org.junit.runner.RunWith;
+
+@RunWith(AndroidJUnit4.class)
+public class FirstRunDialog {
+    private final String pref_callsign = "callsign";
+    private final String pref_passcode = "passcode";
+    public ActivityScenarioRule activityRule = new ActivityScenarioRule<>(LogActivity.class);
+    public SharedPreferencesRule prefsRule = new SharedPreferencesRule() {
+        @Override
+        protected void modifyPreferences(SharedPreferences preferences) {
+            preferences.edit().clear().commit();
+        }
+    };
+    @Rule
+    public RuleChain rules = RuleChain.outerRule(prefsRule).around(activityRule);
+
+    @Test
+    public void givenAFirstTimeRun_whenProvidedABadPasscode_ThenDialogStaysOpen() {
+        onView(isRoot())
+                .inRoot(isDialog())
+                .check(matches(allOf(
+                        hasDescendant(withText(containsString("Welcome to APRSdroid"))),
+                        hasDescendant(withId(R.id.callsign)),
+                        hasDescendant(withId(R.id.passcode)))));
+        onView(withId(R.id.callsign))
+                .check(matches(withHint(containsString("Callsign"))))
+                .perform(typeText("XA1AAA"), closeSoftKeyboard());
+        onView(withId(R.id.passcode))
+                .check(matches(withHint(containsString("Passcode"))))
+                .perform(typeText("12345"), closeSoftKeyboard());
+        onView(withId(android.R.id.button1)).perform(click());  // OK Button
+        onView(isRoot())
+                .inRoot(isDialog())
+                .check(matches(allOf(
+                        hasDescendant(withText(containsString("Welcome to APRSdroid"))),
+                        hasDescendant(withId(R.id.callsign)),
+                        hasDescendant(withId(R.id.passcode)))));
+        try {
+            Thread.sleep(5000);
+        } catch (InterruptedException ex) {
+        }
+        Assert.assertTrue(true);
+    }
+
+    @Test
+    public void givenAFirstTimeRun_whenProvidedAGoodPasscode_ThenDialogCloses() {
+        onView(isRoot())
+                .inRoot(isDialog())
+                .check(matches(allOf(
+                        hasDescendant(withText(containsString("Welcome to APRSdroid"))),
+                        hasDescendant(withId(R.id.callsign)),
+                        hasDescendant(withId(R.id.passcode)))));
+        onView(withId(R.id.callsign))
+                .check(matches(withHint(containsString("Callsign"))))
+                .perform(typeText("XA1AAA"), closeSoftKeyboard());
+        onView(withId(R.id.passcode))
+                .check(matches(withHint(containsString("Passcode"))))
+                .perform(typeText("23459"), closeSoftKeyboard());
+        onView(withId(android.R.id.button1)).perform(click());  // OK Button
+        onView(allOf(
+                isRoot(),
+                hasDescendant(withText(containsString("Welcome to APRSdroid"))),
+                hasDescendant(withId(R.id.callsign)),
+                hasDescendant(withId(R.id.passcode))))
+                .check(doesNotExist());
+    }
+
+    @Test
+    public void givenAFirstTimeRun_whenProvidedAGoodPasscode_ThenPrefsSaved() {
+        String expected_callsign = "XA1AAA";
+        String expected_passcode = "23459";
+        SharedPreferences prefs = prefsRule.getPreferences();
+        Assert.assertNull("Callsign", prefs.getString(pref_callsign, null));
+        Assert.assertNull("Passcode", prefs.getString(pref_passcode, null));
+        onView(withId(R.id.callsign))
+                .check(matches(withHint(containsString("Callsign"))))
+                .perform(typeText(expected_callsign), closeSoftKeyboard());
+        onView(withId(R.id.passcode))
+                .check(matches(withHint(containsString("Passcode"))))
+                .perform(typeText(expected_passcode), closeSoftKeyboard());
+        onView(withId(android.R.id.button1)).perform(click());  // OK Button
+        Assert.assertEquals("Callsign", expected_callsign, prefs.getString(pref_callsign, null));
+        Assert.assertEquals("Passcode", expected_passcode, prefs.getString(pref_passcode, null));
+    }
+}