Preparing version 2025.02

.github/workflows/android.yml

@@ -27,8 +27,8 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 
-      - name: Build with Gradle # skip tests, coverage, etc.
-        run: ./gradlew assembleDebug --stacktrace -x test
+      - name: Build with Gradle
+        run: ./gradlew assembleDebug --stacktrace
 
       - name: Rename output APK
         run: |
@@ -41,3 +41,25 @@ jobs:
         with:
           name: debug-${{ env.ARTIFACT_DATE }}
           path: app/build/outputs/apk/debug/OSMTracker-debug-*.apk
+
+      - name: Run unit tests and jacoco coverage
+        run: ./gradlew testDebugUnitTest jacocoTestReport --stacktrace
+
+      - 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: Run connected tests
+        uses: ReactiveCircus/android-emulator-runner@v2
+        with:
+          api-level: 26
+          script: |
+            adb logcat &
+            ./gradlew connectedCheck --no-parallel
+
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/github-action@v2
+        with:
+          format: jacoco

README.md

@@ -1,12 +1,28 @@
+# OSMTracker for Android™
+
+![Build](https://github.com/labexp/osmtracker-android/actions/workflows/android.yml/badge.svg?branch=develop)
+[![Coverage Status](https://coveralls.io/repos/github/labexp/osmtracker-android/badge.svg?branch=develop)](https://coveralls.io/github/labexp/osmtracker-android?branch=develop)
+
+**OSMTracker for Android™** is a mobile app designed for OpenStreetMap mappers and outdoor adventurers. It lets you log a GPS track to document your journey. Its customizable buttons let you simply add POIs as track points directly inside your GPX track.
+
+It also supports voice recording, picture taking, and note-taking. This is the perfect app to survey a place or a path whether you are hiking, cycling, or exploring new areas.
+
+![Main screen](https://wiki.openstreetmap.org/w/images/thumb/7/7b/OSMTracker-Android-main-screen-en.jpg/200px-OSMTracker-Android-main-screen-en.jpg)
+
+Here is a screenshot of the main screen with its default buttons. You can [customize](https://github.com/labexp/osmtracker-android/wiki/Custom-buttons-layouts) these buttons to your liking.
+
+## Get the App 📲
+
 [<img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png' height="80"/>](https://play.google.com/store/apps/details?id=net.osmtracker)
 [<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/app/net.osmtracker)
 
-OSMTracker for Android™ official source code repository is [https://github.com/labexp/osmtracker-android](https://github.com/labexp/osmtracker-android).
+## More Info ℹ️
 
-[![Build Status](https://travis-ci.org/labexp/osmtracker-android.svg?branch=master)](https://travis-ci.org/labexp/osmtracker-android)
+- Find more information in the [documentation](https://github.com/labexp/osmtracker-android/wiki)
+- Submit bug reports in the [issue tracker](https://github.com/labexp/osmtracker-android/issues)
+- Contributions are welcome, please visit our [contributor guide](https://github.com/labexp/osmtracker-android/blob/master/CONTRIBUTING.md)
+- Translations can be done on [Transifex](https://explore.transifex.com/labexp/osmtracker-android/)
 
-For more information about the project, documentation and bug reports please visit https://github.com/labexp/osmtracker-android/wiki
+## Note 📝
 
-If you are interested in contribute to this project, please visit https://github.com/labexp/osmtracker-android/blob/master/CONTRIBUTING.md to know the way you could do it. 
-
-To help translate OSMTracker, please visit https://www.transifex.com/projects/p/osmtracker-android/
+OSMTracker for Android™ official source code repository is [https://github.com/labexp/osmtracker-android](https://github.com/labexp/osmtracker-android).

app/build.gradle

@@ -1,25 +1,47 @@
-apply plugin: 'com.android.application'
-apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-android-extensions'
+plugins {
+    id 'com.android.application'
+    id 'kotlin-android'
+    id 'jacoco'
+}
 
 android {
-
-    useLibrary 'org.apache.http.legacy'
-    compileSdk 33
+    namespace 'net.osmtracker'
+    compileSdk 35
 
     defaultConfig {
         applicationId "net.osmtracker"
-        minSdkVersion 25
-        targetSdkVersion 33
+        minSdk 25
+        targetSdk 35
         multiDexEnabled true
 
+        // Version code should be increased after each release
+        versionCode 65
+        versionName new Date().format('yyyy.MM.dd')
+
         testApplicationId "net.osmtracker.test"
-        testInstrumentationRunner "android.test.InstrumentationTestRunner"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+            signingConfig signingConfigs.findByName('release')
+        }
+        debug {
+            versionNameSuffix "-dev"
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_17
     }
 
     signingConfigs {
-        // Create a file $HOME/.gradle/gradle.properties
-        // containing the values signing.storeFile=..., etc.
         if (project.hasProperty('signing.storeFile')) {
             release {
                 storeFile file(project.property('signing.storeFile'))
@@ -30,92 +52,72 @@ android {
         }
     }
 
-    buildTypes {
-        release {
-            minifyEnabled false
-            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.txt'
-            if (signingConfigs.hasProperty('release')) {
-                signingConfig signingConfigs.release
-            }
-
-
-        }
-    }
-
     packagingOptions {
-        exclude 'META-INF/DEPENDENCIES'
-        exclude 'META-INF/LICENSE.txt'
-        exclude 'META-INF/NOTICE.txt'
-    }
-    android {
-        lintOptions {
-            abortOnError false
-        }
+        resources.excludes += [
+            'META-INF/DEPENDENCIES', 
+            'META-INF/LICENSE.txt', 
+            'META-INF/NOTICE.txt'
+        ]
     }
-
-    defaultConfig {
-        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
-    }
-
     testOptions {
         unitTests.returnDefaultValues = true
+        unitTests.all {
+            it.jvmArgs = [
+                '--add-opens', 'java.base/java.io=ALL-UNNAMED',
+                       '--add-opens', 'java.base/java.lang=ALL-UNNAMED',
+                       '--add-opens', 'java.base/java.lang.reflect=ALL-UNNAMED',
+                       '--add-opens', 'java.base/java.util=ALL-UNNAMED'
+            ]
+        }
         animationsDisabled = true
     }
-    namespace 'net.osmtracker'
-
 }
 
 dependencies {
-
-    //implementation 'org.apache.james:apache-mime4j-core:0.8.3'
-
-    //implementation 'org.apache.httpcomponents:httpmime:4.5.6'
-
-    implementation 'org.osmdroid:osmdroid-android:6.1.5'
-    //implementation 'org.apache.httpcomponents:httpcore:4.4.13'
-
-    //implementation 'oauth.signpost:signpost-commonshttp4:1.2.1.2'
-    implementation 'org.slf4j:slf4j-android:1.7.30'
-    implementation 'androidx.core:core:1.6.0'
-    //implementation 'org.apache.commons:commons-io:1.3.2'
-
-    // For upload traces to osm server
+    // Lib to show OSM map as background
+    implementation 'org.osmdroid:osmdroid-android:6.1.20'
+    // OAuth
     implementation 'net.openid:appauth:0.11.1'
-    implementation 'de.westnordost:osmapi-traces:3.1'
-
-    // Required for local unit tests (JUnit 4 framework)
-    testImplementation 'junit:junit:4.12'
-    testImplementation 'org.mockito:mockito-core:2.4.0'
+    // For upload traces to osm server
+    implementation('de.westnordost:osmapi-traces:3.1') {
+        // Already included in Android
+        exclude group: 'net.sf.kxml', module: 'kxml2'
+        exclude group: 'xmlpull', module: 'xmlpull'
+    }
+    // App intro
+    implementation 'com.github.AppIntro:AppIntro:6.3.1'
 
-    testImplementation 'org.powermock:powermock-core:1.7.0RC2'
-    testImplementation 'org.powermock:powermock-module-junit4:1.7.0RC2'
-    testImplementation 'org.powermock:powermock-api-mockito2:1.7.0RC2'
+    implementation 'com.google.android.material:material:1.12.0'
+    implementation 'org.slf4j:slf4j-android:1.7.30'
+    implementation 'org.apache.commons:commons-io:1.3.2'
+    implementation 'androidx.core:core:1.15.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.2.0'
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+    implementation 'androidx.appcompat:appcompat:1.7.0'
+
+    // Required -- JUnit 4 framework
+    testImplementation 'junit:junit:4.13.2'
+    // Robolectric environment
+    testImplementation "androidx.test:core:1.6.1"
+    // Mockito framework
+    testImplementation "org.mockito:mockito-core:3.12.4"
+
+    testImplementation 'org.powermock:powermock-core:2.0.9'
+    testImplementation 'org.powermock:powermock-api-mockito2:2.0.9'
+    testImplementation 'org.powermock:powermock-module-junit4:2.0.9'
+    // Required for local unit tests. Prevent null in JSONObject, JSONArray, etc.
+    testImplementation 'org.json:json:20240303'
 
     // Required for instrumented tests
-    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
-    androidTestImplementation 'androidx.test:rules:1.4.0'
-
-    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation 'androidx.appcompat:appcompat:1.3.0'
-
-    //compileOnly 'org.jbundle.util.osgi.wrapped:org.jbundle.util.osgi.wrapped.org.apache.http.client:4.1.2'
-
-    // AndroidX Capable version
-    implementation 'com.github.AppIntro:AppIntro:6.0.0'
-    implementation 'com.google.android.material:material:1.4.0'
-
-
-}
-
-configurations.all {
-    // it's already included in Android and not need from osmapi
-    exclude group:'net.sf.kxml', module:'kxml2'
-    exclude group: 'xmlpull', module: 'xmlpull'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
+    androidTestImplementation 'androidx.test.ext:junit:1.2.1'
+    androidTestImplementation 'androidx.test:rules:1.6.1'
 }
 
 repositories {
+    google()
     mavenCentral()
     maven { url "https://jitpack.io" }
 }
+
+apply from: "jacoco.gradle"

app/jacoco.gradle

@@ -0,0 +1,25 @@
+jacoco {
+    toolVersion = jacocoVersion
+}
+
+tasks.withType(Test).configureEach {
+    jacoco.includeNoLocationClasses = true
+    jacoco.excludes = ['jdk.internal.*']
+}
+
+tasks.register("jacocoTestReport", JacocoReport) {
+    dependsOn testDebugUnitTest
+
+    reports {
+        xml.required = true
+    }
+
+    def fileFilter = ['**/R.class', '**/R$*.class', '**/BuildConfig.*', '**/Manifest*.*', '**/*Test*.*']
+    def mainSrc = "${project.projectDir}/src/main/java"
+
+    sourceDirectories.setFrom(files([mainSrc]))
+    classDirectories.setFrom(fileTree(dir: layout.buildDirectory.dir("intermediates/javac/debug").get().asFile, excludes: fileFilter))
+    executionData.setFrom(fileTree(dir: layout.buildDirectory.get(), includes: [
+            'jacoco/testDebugUnitTest.exec', 'outputs/unit_test_code_coverage/debugUnitTest/testDebugUnitTest.exec'
+    ]))
+}

app/src/androidTest/java/net/osmtracker/layouts/DeleteLayoutTest.java

@@ -8,6 +8,7 @@
 import net.osmtracker.activity.ButtonsPresets;
 import net.osmtracker.activity.Preferences;
 import net.osmtracker.util.CustomLayoutsUtils;
+import net.osmtracker.util.TestUtils;
 
 import org.junit.Rule;
 import org.junit.Test;
@@ -32,6 +33,9 @@
 
 public class DeleteLayoutTest {
 
+    @Rule
+    public GrantPermissionRule storagePermission = GrantPermissionRule.grant(Manifest.permission.WRITE_EXTERNAL_STORAGE);
+
     @Rule
     public ActivityTestRule<ButtonsPresets> mRule = new ActivityTestRule(ButtonsPresets.class) {
         @Override
@@ -47,10 +51,6 @@ protected void beforeActivityLaunched() {
         }
     };
 
-    // Storage permissions are required
-    @Rule
-    public GrantPermissionRule writePermission = GrantPermissionRule.grant(Manifest.permission.WRITE_EXTERNAL_STORAGE);
-
     private static String layoutName = "mock";
     private static String ISOLanguageCode = "es";