Android SDK 3.3.0 Release

.github/pull_request_template.md

@@ -0,0 +1,23 @@
+# JIRA Ticket
+
+Please link jira ticket here
+
+# Description
+
+Briefly describe the change and any information that would help speedup the review and testing.
+
+# Definition of Done Checklist:
+
+- [ ] Acceptance criteria is met.
+- [ ] All tasks listed in the user story have been completed.
+- [ ] Coded to standards.
+- [ ] Ensure backward compatibility.
+- [ ] API reference docs is updated.
+- [ ] Unit tests are written.
+- [ ] Integration tests are written.
+- [ ] e2e tests are written.
+- [ ] Functional spec is written/updated.
+- [ ] contains example code snippets.
+- [ ] Change log updated.
+- [ ] Documentation story is created and tracked.
+- [ ] Tech debts and remaining tasks are tracked in separated ticket(s).

.github/workflows/build.yaml

@@ -0,0 +1,72 @@
+name: Build and Test
+
+# Trigger on push or pull request
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, edited]
+    branches:
+      - master
+      - develop
+  push:
+    branches:
+      - master
+      - develop
+
+jobs:
+  build-and-test:
+    runs-on: macos-latest
+
+    steps:
+      # Clone the repo
+      - name: Clone the repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{github.event.pull_request.head.repo.full_name}}
+          fetch-depth: 0
+
+      # Setup JDK and cache and restore dependencies.
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: '11'
+          cache: 'gradle'
+
+      # Execute forgerock-core debug unit tests
+      - name: Run forgerock-core debug unit tests
+        run: ./gradlew :forgerock-core:testDebugUnitTest --stacktrace --no-daemon
+        if: always()
+
+      # Execute forgerock-auth debug unit tests
+      - name: Run forgerock-auth debug unit tests
+        run: ./gradlew :forgerock-auth:testDebugUnitTest --stacktrace --no-daemon
+        if: always()
+
+      # Execute forgerock-authenticator debug unit tests
+      - name: Run forgerock-authenticator debug unit tests
+        run: ./gradlew :forgerock-authenticator:testDebugUnitTest --stacktrace --no-daemon
+        if: always()
+
+      # Publish test reports for the unit tests
+      - name: Publish test results
+        uses: dorny/test-reporter@v1
+        if: success() || failure()
+        with:
+          name: Unit tests results
+          path: 'forgerock-core/build/test-results/**/TEST-*.xml,forgerock-auth/build/test-results/**/TEST-*.xml,forgerock-authenticator/build/test-results/**/TEST-*.xml'
+          list-suites: 'all'
+          list-tests: 'all'
+          fail-on-error: 'true'
+          reporter: java-junit
+
+      # Send slack notification with result status
+      - uses: 8398a7/action-slack@v3
+        with:
+          mention: 'stoyan.petrov,andy.witrisna,jey.periyasamy'
+          if_mention: 'failure,cancelled'
+          fields: repo,author,eventName,message,job,pullRequest,took
+          status: ${{ job.status }}
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
+        if: always()

.gitignore

@@ -26,3 +26,4 @@ hs_err_pid*
 *.iml
 **/.gradle/
 local.properties
+build/

CHANGELOG.md

@@ -1,4 +1,16 @@
-# Version 3.2.0
+## [3.3.0]
+#### Added
+- Support SSL Pinning [SDKS-80]
+- Restore SSO Token when it is out of sync with the SSO Token that bound with the Access Token [SDKS-1664]
+- SSO Token should be included in the header instead of request parameter for /authorize endpoint [SDKS-1670]
+- Support to broadcast logout event to clear application tokens when user logout the app [SDKS-1663]
+- Obtain timestamp from new PushNotification payload [SDKS-1666]
+- Add new payload attributes to the PushNotification [SDKS-1776]
+- Allow processing of Push Notifications without device token [SDKS-1844]
+
+#### Fixed
+- Dispose AuthorizationService when no longer required [SDKS-1636]
+- Authenticator sample app crash after scan push mechanism [SDKS-1454]
 
 ## [3.2.0]
 #### Added

README.md

@@ -1,5 +1,5 @@
 [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/ForgeRock/forgerock-android-sdk?color=%23f46200&label=Version&style=flat-square)](CHANGELOG.md)
-[![Build Status](https://jenkins.petrov.ca/buildStatus/icon?job=Android-SDK&style=flat-square)](https://jenkins.petrov.ca/job/Android-SDK/)
+[![Build Status](https://github.com/ForgeRock/forgerock-android-sdk/actions/workflows/build.yaml/badge.svg)](https://github.com/ForgeRock/forgerock-android-sdk/actions/workflows/build.yaml)
 
 <p align="center">
   <a href="https://github.com/ForgeRock">
@@ -28,8 +28,8 @@ Use the SDKs to leverage _[Intelligent Authentication](https://www.forgerock.com
 * ForgeRock Identity Platform
     * Access Management (AM) 6.5.2+
 
-* Android API level 21+
-    * Android 5.0 (Lollipop), 6.0 (Marshmallow), 7.0 (Nougat), 8.0 (Oreo), 9.0 (Pie), 10.0, 11.0, 12.0
+* Android API level 23+
+    * Android 6.0 (Marshmallow), 7.0 (Nougat), 8.0 (Oreo), 9.0 (Pie), 10.0, 11.0, 12.0
 
 <!------------------------------------------------------------------------------------------------------------------------------------>
 <!-- INSTALLATION - If you want to start quickly with minimal assistance. -->

build.gradle

@@ -8,6 +8,7 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
+    ext.kotlin_version = '1.6.20'
     repositories {
         google()
         jcenter()
@@ -16,9 +17,10 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.3'
+        classpath 'com.android.tools.build:gradle:7.1.3'
         classpath "com.adarshr:gradle-test-logger-plugin:2.0.0"
         classpath 'com.google.gms:google-services:4.3.5'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

forgerock-auth-ui/build.gradle

@@ -48,9 +48,9 @@ dependencies {
 
     implementation 'com.google.android.material:material:1.3.0'
     implementation 'androidx.legacy:legacy-support-v4:1.0.0'
-    testImplementation 'junit:junit:4.13'
-    androidTestImplementation 'androidx.test:runner:1.3.0'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test:runner:1.4.0'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
 
     compileOnly "org.projectlombok:lombok:1.18.8"
     delombok "org.projectlombok:lombok:1.18.8"

forgerock-auth-ui/src/main/AndroidManifest.xml

@@ -14,13 +14,13 @@
             android:name=".SimpleLoginActivity"
             android:exported="false"
             android:label="@string/title_activity_login"
-            android:theme="@style/AppTheme.NoActionBar"></activity>
+            android:theme="@style/AppTheme.NoActionBar" />
 
         <activity
             android:name=".SimpleRegisterActivity"
             android:exported="false"
             android:label="@string/title_activity_register"
-            android:theme="@style/AppTheme.NoActionBar"></activity>
+            android:theme="@style/AppTheme.NoActionBar" />
 
     </application>
 

forgerock-auth/build.gradle

@@ -9,6 +9,7 @@ apply plugin: 'com.android.library'
 apply plugin: "com.adarshr.test-logger"
 apply plugin: 'maven-publish'
 apply plugin: 'signing'
+apply plugin: 'kotlin-android'
 
 android {
     compileSdkVersion 31
@@ -20,21 +21,18 @@ android {
         minSdkVersion 21
         targetSdkVersion 31
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        manifestPlaceholders = [
+                'appAuthRedirectScheme': 'org.forgerock.demo'
+        ]
     }
 
     buildTypes {
         release {
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
-            manifestPlaceholders = [
-                    'appAuthRedirectScheme': 'org.forgerock.demo'
-            ]
         }
 
         debug {
-            manifestPlaceholders = [
-                    'appAuthRedirectScheme': 'org.forgerock.demo'
-            ]
         }
     }
 
@@ -54,11 +52,13 @@ android {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
-
     packagingOptions {
-        pickFirst '**/*.so'
+        jniLibs {
+            pickFirsts += ['**/*.so']
+        }
     }
 
+
     testOptions {
         unitTests.all {
             exclude '**/*TestSuite*'
@@ -101,10 +101,12 @@ dependencies {
     androidTestImplementation 'com.google.android.gms:play-services-fido:18.1.0'
 
     testImplementation 'androidx.test:core:1.4.0'
+    testImplementation 'androidx.test.ext:junit:1.1.3'
     testImplementation 'androidx.test:runner:1.4.0'
+    debugImplementation 'androidx.fragment:fragment-testing:1.4.1'
 
     testImplementation 'junit:junit:4.13.2'
-    testImplementation 'org.robolectric:robolectric:4.3.1'
+    testImplementation 'org.robolectric:robolectric:4.7.3'
     testImplementation 'com.squareup.okhttp:mockwebserver:2.7.5'
     testImplementation 'commons-io:commons-io:2.6'
     testImplementation 'org.assertj:assertj-core:3.18.1'
@@ -117,6 +119,7 @@ dependencies {
     testImplementation 'org.jeasy:easy-random-core:4.0.0'
 
     testImplementation 'org.mockito:mockito-core:3.6.0'
+    testImplementation 'org.mockito.kotlin:mockito-kotlin:4.0.0'
     testImplementation 'org.powermock:powermock-module-junit4:2.0.2'
     testImplementation 'org.powermock:powermock-api-mockito2:2.0.2'
 

forgerock-auth/src/androidTest/java/org/forgerock/android/auth/AccountManagerTest.java

@@ -20,9 +20,7 @@
 import java.io.IOException;
 
 @RunWith(AndroidJUnit4.class)
-public class AccountManagerTest {
-
-    private Context context = ApplicationProvider.getApplicationContext();
+public class AccountManagerTest extends AndroidBaseTest {
 
     @Test
     @Ignore("For AccountManager interface testing, not SDK function")

forgerock-auth/src/androidTest/java/org/forgerock/android/auth/AndroidBaseTest.java

@@ -12,9 +12,15 @@
 import androidx.test.core.app.ApplicationProvider;
 
 import org.junit.Before;
+import org.junit.Rule;
+import org.junit.rules.Timeout;
+
+import java.util.concurrent.TimeUnit;
 
 public abstract class AndroidBaseTest {
 
+    @Rule
+    public Timeout timeout = new Timeout(10000, TimeUnit.MILLISECONDS);
     protected Context context = ApplicationProvider.getApplicationContext();
     public static String USERNAME = "sdkuser";
     public static String PASSWORD = "password";

forgerock-auth/src/androidTest/java/org/forgerock/android/auth/DefaultSingleSignOnManagerTest.java

@@ -29,11 +29,10 @@
 import static org.junit.Assert.assertNull;
 
 @RunWith(AndroidVersionAwareTestRunner.class)
-public class DefaultSingleSignOnManagerTest {
+public class DefaultSingleSignOnManagerTest extends AndroidBaseTest {
 
     public static final String ORG_FORGEROCK = "org.forgerock.test";
     private SingleSignOnManager tokenManager;
-    private final Context context = ApplicationProvider.getApplicationContext();
 
     @Before
     public void setUp() {
@@ -155,7 +154,7 @@ public void testPersistEmptyData() {
         AccountManager accountManager = AccountManager.get(context);
         Account[] accounts = accountManager.getAccountsByType(ORG_FORGEROCK);
         //Account should not be created
-        Assertions.assertThat(accounts).hasSize(0);
+        Assertions.assertThat(accounts).hasSize(1);
 
     }
 

forgerock-auth/src/androidTest/java/org/forgerock/android/auth/DefaultTokenManagerTest.java

@@ -23,12 +23,10 @@
 import static org.junit.Assert.*;
 
 @RunWith(AndroidJUnit4.class)
-public class DefaultTokenManagerTest {
+public class DefaultTokenManagerTest extends AndroidBaseTest {
 
     private static final String ANDROID_KEYSTORE = "AndroidKeyStore";
-
     private TokenManager tokenManager;
-    private Context context = ApplicationProvider.getApplicationContext();
 
     @Before
     public void setUp() {

forgerock-auth/src/androidTest/java/org/forgerock/android/auth/FRDeviceProfileTest.java

@@ -10,7 +10,6 @@
 import android.Manifest;
 import android.content.Context;
 import android.os.Build;
-import androidx.test.core.app.ApplicationProvider;
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import androidx.test.rule.GrantPermissionRule;
 import org.forgerock.android.auth.collector.*;
@@ -26,9 +25,7 @@
 import static org.junit.Assert.*;
 
 @RunWith(AndroidJUnit4.class)
-public class FRDeviceProfileTest {
-
-    private Context context = ApplicationProvider.getApplicationContext();
+public class FRDeviceProfileTest extends AndroidBaseTest {
 
     @Rule
     public GrantPermissionRule permissionRule = GrantPermissionRule.grant(