Merge pull request #452 from ForgeRock/SDKS-3373

SDKS-3373 - ReCaptcha e2e test cases
ForgeRock · Oct 1, 2024 · 0dec587 · 0dec587
2 parents b59cfab + 522a5d9
commit 0dec587
Show file tree

Hide file tree

Showing 8 changed files with 692 additions and 16 deletions.
diff --git a/...ock-auth/src/main/java/org/forgerock/android/auth/callback/ReCaptchaEnterpriseCallback.kt b/...ock-auth/src/main/java/org/forgerock/android/auth/callback/ReCaptchaEnterpriseCallback.kt
@@ -26,13 +26,20 @@ class ReCaptchaEnterpriseCallback : AbstractCallback {
     lateinit var reCaptchaSiteKey: String
         private set
 
+    /**
+     * Retrieves the token result.
+     *
+     * @return the token result.
+     */
+    lateinit var tokenResult: String
+        private set
+
     companion object {
         private val TAG = ReCaptchaEnterpriseCallback::class.java.simpleName
         private const val INVALID_CAPTCHA_TOKEN = "INVALID_CAPTCHA_TOKEN"
         private const val UNKNOWN_ERROR = "UNKNOWN_ERROR"
     }
 
-
     @Keep
     @JvmOverloads
     constructor()
@@ -59,15 +66,6 @@ class ReCaptchaEnterpriseCallback : AbstractCallback {
         super.setValue(value, 0)
     }
 
-    /**
-     * Set the Action for the ReCAPTCHA
-     *
-     * @param value The Action
-     */
-    fun setAction(value: String) {
-        super.setValue(value, 1)
-    }
-
     /**
      * Input the Client Error to the server
      * @param value Error String.
@@ -85,6 +83,15 @@ class ReCaptchaEnterpriseCallback : AbstractCallback {
         super.setValue(value.toString(), 3)
     }
 
+    /**
+     * Set the Action for the ReCAPTCHA
+     *
+     * @param value The Action
+     */
+    private fun setAction(value: String) {
+        super.setValue(value, 1)
+    }
+
     override fun getType(): String {
         return "ReCaptchaEnterpriseCallback"
     }
@@ -111,7 +118,9 @@ class ReCaptchaEnterpriseCallback : AbstractCallback {
             if (token == null) {
                 throw Exception(INVALID_CAPTCHA_TOKEN)
             }
+            tokenResult = token
             setValue(token)
+            setAction(action)
         }
         catch (e: Exception) {
             Logger.error(TAG, e.message)

diff --git a/...auth/src/test/java/org/forgerock/android/auth/callback/ReCaptchaEnterpriseCallbackTest.kt b/...auth/src/test/java/org/forgerock/android/auth/callback/ReCaptchaEnterpriseCallbackTest.kt
@@ -30,7 +30,7 @@ import org.mockito.kotlin.whenever
 @RunWith(AndroidJUnit4::class)
 class ReCaptchaEnterpriseCallbackTest {
 
-    val application: Application = ApplicationProvider.getApplicationContext()
+    private val application: Application = ApplicationProvider.getApplicationContext()
 
     private lateinit var callback: ReCaptchaEnterpriseCallback
 
@@ -98,7 +98,7 @@ class ReCaptchaEnterpriseCallbackTest {
             verify(recaptchaClientProvider).execute(recaptchaClient, RecaptchaAction.custom("login"), 15000L)
 
             assert(callback.content.contains("test-token"))
-
+            assert(callback.tokenResult == "test-token")
     }
 
     @Test
@@ -153,16 +153,15 @@ class ReCaptchaEnterpriseCallbackTest {
         )
         whenever(recaptchaClientProvider.execute(any(), any<RecaptchaAction>(), anyLong())).thenReturn("test-token")
 
-        callback.execute(application, "login", 15000L, recaptchaClientProvider)
+        callback.execute(application, "custom-action", 15000L, recaptchaClientProvider)
 
         callback.setPayload(JSONObject().put("key", "value"))
-        callback.setAction("custom-action")
 
         verify(recaptchaClientProvider).fetchClient(
             application,
             "6Lf3tbYUAAAAAEm78fAOFRKb-n1M67FDtmpczIBK"
         )
-        verify(recaptchaClientProvider).execute(recaptchaClient, RecaptchaAction.custom("login"), 15000L)
+        verify(recaptchaClientProvider).execute(recaptchaClient, RecaptchaAction.custom("custom-action"), 15000L)
 
         assert(callback.content.contains("test-token"))
         assert(callback.content.contains("key"))

diff --git a/forgerock-integration-tests/build.gradle.kts b/forgerock-integration-tests/build.gradle.kts
@@ -43,11 +43,16 @@ dependencies {
     androidTestImplementation(libs.androidx.biometric.ktx)
     androidTestImplementation(libs.nimbus.jose.jwt)
     androidTestImplementation(libs.okhttp)
+    androidTestImplementation(libs.kotlinx.coroutines.test)
 
     //For Application Pin
     androidTestImplementation(libs.bcpkix.jdk15on)
     androidTestImplementation(libs.androidx.security.crypto)
 
     //App Integrity
     androidTestImplementation(libs.integrity)
+
+    // Captcha
+    androidTestImplementation(libs.play.services.safetynet)
+    androidTestImplementation(libs.recaptchaEnterprise)
 }
diff --git a/...droidTest/java/org/forgerock/android/auth/callback/ReCaptchaEnterpriseCallbackBaseTest.kt b/...droidTest/java/org/forgerock/android/auth/callback/ReCaptchaEnterpriseCallbackBaseTest.kt
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2024 ForgeRock. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+package org.forgerock.android.auth.callback
+
+import android.app.Application
+import android.content.Context
+import androidx.test.core.app.ApplicationProvider
+import org.forgerock.android.auth.FRAuth
+import org.forgerock.android.auth.FROptionsBuilder
+import org.forgerock.android.auth.FRSession
+import org.forgerock.android.auth.Logger
+import org.forgerock.android.auth.Logger.Companion.set
+import org.junit.After
+import org.junit.BeforeClass
+
+/**
+ * e2e tests for [ReCaptchaEnterpriseCallback]
+ */
+open class ReCaptchaEnterpriseCallbackBaseTest {
+    @After
+    fun logoutSession() {
+        if (FRSession.getCurrentSession() != null) {
+            FRSession.getCurrentSession().logout()
+        }
+    }
+
+    companion object {
+        val context: Context = ApplicationProvider.getApplicationContext()
+        val application: Application = ApplicationProvider.getApplicationContext()
+
+        protected const val AM_URL: String = "https://openam-recaptcha.forgeblocks.com/am"
+        protected const val REALM: String = "alpha"
+        protected const val OAUTH_CLIENT: String = "AndroidTest"
+        protected const val OAUTH_REDIRECT_URI: String = "org.forgerock.demo:/oauth2redirect"
+        protected const val SCOPE: String = "openid profile email address phone"
+        const val TREE: String = "TEST-e2e-recaptcha-enterprise"
+        const val USERNAME: String = "sdkuser"
+        const val RECAPTCHA_SITE_KEY: String = "6LfAykUqAAAAAE6aZOg9pNiS3XduyGZ5y-8U-z8B"
+
+        @JvmStatic
+        @BeforeClass
+        fun setUpSDK(): Unit {
+            set(Logger.Level.DEBUG)
+
+            val options = FROptionsBuilder.build {
+                server {
+                    url = AM_URL
+                    cookieName = "b431aeda2ba0e98"
+                    realm = REALM
+                }
+                oauth {
+                    oauthClientId = OAUTH_CLIENT
+                    oauthRedirectUri = OAUTH_REDIRECT_URI
+                    oauthCacheSeconds = 0
+                    oauthScope = SCOPE
+                }
+                service {
+                    authServiceName = TREE
+                }
+            }
+
+            FRAuth.start(context, options)
+        }
+    }
+}
+
+
+
+