F114514/us769867 jenkins android automation

Jenkinsfile-android

@@ -0,0 +1,220 @@
+@Library('apim-jenkins-lib@master') _
+
+pipeline {
+    agent { label 'ng2AgentStable' }
+    environment { 
+        ARTIFACTORY_CREDS = credentials('ARTIFACTORY_USERNAME_PASSWORD')
+        ARTIFACTORY_USER = "$ARTIFACTORY_CREDS_USR"
+        ARTIFACTORY_PASSWORD = "$ARTIFACTORY_CREDS_PSW"  
+    }
+    parameters {
+        string(name: 'SDK_Branch_Name', defaultValue: 'develop', description: 'Android-MAS-SDK Git repo branch name')
+        string(name: 'MASUnit_Branch_Name', defaultValue: 'develop', description: 'Android-MAS-Unit Git repo branch name')
+        string(name: 'Emulator_Device_Name', defaultValue: 'device-api29', description: 'Emulator Device Name')
+        string(name: 'ADB', defaultValue: '/Users/qa/Library/Android/sdk/platform-tools/adb', description: 'adb path')
+        string(name: 'Android_Home', defaultValue: '/Users/qa/Library/Android/sdk', description: 'Android Home Path')
+        string(name: 'New_Test_Rail_Report', defaultValue: 'true', description: 'New Test Rail Report Status')
+        string(name: 'Foundation', defaultValue: 'true', description: 'MAS Foundation')
+        string(name: 'Storage', defaultValue: 'true', description: 'MAS Storage')
+        string(name: 'Messaging', defaultValue: 'true', description: 'MAS Messaging')
+    }
+    stages {
+        stage("Checkout") {
+            steps {  
+                echo "Checking out SDK Branch ..."
+                script {
+                    checkout([
+                        $class: 'GitSCM', 
+                        branches: [[name: '*/${SDK_Branch_Name}']],
+                        extensions: [[$class: 'RelativeTargetDirectory',
+                            relativeTargetDir: 'MASSDK']],
+                        userRemoteConfigs: [[credentialsId:'GITHUB_CAAPIM_TOKEN',url: 'https://github.com/CAAPIM/Android-MAS-SDK.git']]
+                     ])
+                    echo "Checking out MASUnit Branch ..."
+                    checkout([
+                        $class: 'GitSCM', 
+                        branches: [[name: '*/${MASUNIT_Branch_Name}']],
+                        extensions: [[$class: 'RelativeTargetDirectory',
+                            relativeTargetDir: 'MASUnit']],
+                        userRemoteConfigs: [[credentialsId:'GITHUB_CAAPIM_TOKEN',url: 'https://github.com/CAAPIM/Android-MAS-Unit.git']]
+                     ])
+
+                }
+            echo "Copy configs and build gradle ..." 
+            script {
+            sh 'echo "pwd=$(pwd)"'
+            sh '"ls -l=$(ls -l)"'
+            sh 'echo "emulatore name ${Emulator_Device_Name}"
+            sh 'cd ${Android_Home}/emulator;emulator -no-snapshot -avd ${Emulator_Device_Name} & echo -ne '\n''
+            sh './gradlew assembleAndroidTest build'
+            sh '${ADB} shell input keyevent 82'
+            sh '${ADB} shell input text 1111'
+            sh '${ADB} shell input keyevent 66'
+            }
+            script {
+            //Check new report
+            //Give emulator a safety margin to start
+            //Input password giving emulator enough time to respond
+            echo "Launching emulator ${ADB}" 
+            sleep 180
+            sh' ${ADB} shell input keyevent 82'
+            sleep 5
+            sh '${ADB} shell input text 1'
+            sleep 5
+            sh '${ADB} shell input text 1'
+            sleep 5
+            sh '${ADB} shell input text 1'
+            sleep 5
+            sh '${ADB} shell input text 1'
+            sleep 5
+            sh '${ADB} shell input keyevent 66'
+            if (${New_Test_Rail_Report}=='true') {
+            echo "Uninstall MASUnit App"
+            sh '${ADB} uninstall com.ca.mas.masunit'
+            }
+
+
+            //Install MASUnit-debug.apk
+            if (! -f MASUnit/build/outputs/apk/debug/MASUnit-debug.apk) {
+            echo "MASUnit-debug.apk not found"
+            exit 1
+            }       
+
+            sh '${ADB} push MASUnit/build/outputs/apk/debug/MASUnit-debug.apk /data/local/tmp/com.ca.mas.masunit'
+            if ( ! $? -eq 0 ) {
+            echo "Failed to push MASUnit-debug.apk to device"
+            exit 1
+            }
+            sh '${ADB} shell pm install -r "/data/local/tmp/com.ca.mas.masunit"'
+            if ( ! $? -eq 0 ) {
+            echo "Failed to intall MASUnit-debug.apk to device"
+            exit 1
+            }
+
+            //Install MASUnit-debug-androidTest.apk
+
+            if ( ! -f MASUnit/build/outputs/apk/androidTest/debug/MASUnit-debug-androidTest.apk ) {
+            echo "MASUnit-debug-androidTest.apk not found"
+             exit 1
+            }
+
+            sh '${ADB} push MASUnit/build/outputs/apk/androidTest/debug/MASUnit-debug-androidTest.apk  /data/local/tmp/com.ca.mas.masunit.test'
+            if ( ! $? -eq 0 ) {
+            echo "Failed to push MASUnit-debug-androidTest.apk to device"
+            exit 1
+            }
+            sh '${ADB} shell pm install -r "/data/local/tmp/com.ca.mas.masunit.test"'
+            if ( ! $? -eq 0 ) {
+            echo "Failed to intall MASUnit-debug-androidTest.apk to device"
+            exit 1
+            }  
+
+
+           //Running foundation tests
+            echo "Running tests..."
+
+           if (${Foundation}=='true') {
+           sh '${ADB} shell am instrument -w -r -e debug false -e class com.ca.mas.masunit2.test.foundation.MASUnitFoundationTestSuite com.ca.mas.masunit.test/androidx.test.runner.AndroidJUnitRunner'
+           }
+
+          if (${Storage}=='true') {
+          sh '${ADB} shell am instrument -w -r -e debug false -e class com.ca.mas.masunit2.test.storage.MASUnitStorageTestSuite com.ca.mas.masunit.test/androidx.test.runner.AndroidJUnitRunner'
+          }
+
+         if (${Messaging}=='true') {
+         sh '${ADB} shell am instrument -w -r -e debug false -e class com.ca.mas.masunit2.test.connecta.MASUnitMessagingTestSuite com.ca.mas.masunit.test/androidx.test.runner.AndroidJUnitRunner'
+         }
+
+        }
+
+       script{
+       echo "Running tests on Android....."
+        //Check new report
+
+        // Give emulator a safety margin to start
+        //Input password giving emulator enough time to respond
+        sh 'echo "Launching emulator ${ADB}" '
+        sleep 180
+        sh '${ADB} shell input keyevent 82'
+        sleep 5
+        sh '${ADB} shell input text 1'
+        sleep 5
+        sh '${ADB} shell input text 1'
+        sleep 5
+        sh '${ADB} shell input text 1'
+        sleep 5
+        sh '${ADB} shell input text 1'
+        sleep 5
+        sh '${ADB} shell input keyevent 66'
+        if (${New_Test_Rail_Report}=='true') {
+            echo "Uninstall MASUnit App"
+            sh '${ADB} uninstall com.ca.mas.masunit'
+        }
+
+
+        // Install MASUnit-debug.apk
+        if (! -f MASUnit/build/outputs/apk/debug/MASUnit-debug.apk ) {
+        echo "MASUnit-debug.apk not found"
+        exit 1
+        }
+
+        sh '${ADB} push MASUnit/build/outputs/apk/debug/MASUnit-debug.apk /data/local/tmp/com.ca.mas.masunit'
+        if ( ! $? -eq 0 ) {
+           echo "Failed to push MASUnit-debug.apk to device"
+           exit 1
+        }
+        sh '${ADB} shell pm install -r "/data/local/tmp/com.ca.mas.masunit"'
+        if ( ! $? -eq 0 ) {
+            echo "Failed to intall MASUnit-debug.apk to device"
+             exit 1
+        }
+
+        //Install MASUnit-debug-androidTest.apk
+
+        if ( ! -f MASUnit/build/outputs/apk/androidTest/debug/MASUnit-debug-androidTest.apk ) {
+            echo "MASUnit-debug-androidTest.apk not found"
+            exit 1
+        }
+
+        sh '${ADB} push MASUnit/build/outputs/apk/androidTest/debug/MASUnit-debug-androidTest.apk  /data/local/tmp/com.ca.mas.masunit.test'
+        if ( ! $? -eq 0 ) {
+            echo "Failed to push MASUnit-debug-androidTest.apk to device"
+            exit 1
+        }
+        sh '${ADB} shell pm install -r "/data/local/tmp/com.ca.mas.masunit.test"'
+        if ( ! $? -eq 0 ) {
+            echo "Failed to intall MASUnit-debug-androidTest.apk to device"
+            exit 1
+        }
+
+
+        //Running foundation tests
+        echo "Running tests..."
+
+        if (${Foundation}=='true') {
+           sh '${ADB} shell am instrument -w -r -e debug false -e class com.ca.mas.masunit2.test.foundation.MASUnitFoundationTestSuite com.ca.mas.masunit.test/androidx.test.runner.AndroidJUnitRunner'
+        }
+
+        if (${Storage}=='true') {
+        sh '${ADB} shell am instrument -w -r -e debug false -e class com.ca.mas.masunit2.test.storage.MASUnitStorageTestSuite com.ca.mas.masunit.test/androidx.test.runner.AndroidJUnitRunner'
+        }
+
+        if (${Messaging}=='true') {
+         sh '${ADB} shell am instrument -w -r -e debug false -e class com.ca.mas.masunit2.test.connecta.MASUnitMessagingTestSuite com.ca.mas.masunit.test/androidx.test.runner.AndroidJUnitRunner'
+        }
+        }
+
+        script {
+        echo "close emulator ...."
+        sh 'cd ${Android_Home}/platform-tools/adb; emu kill'
+        }
+            }
+        }
+    }
+
+    post {
+    always {
+      echo "end"
+    }
+  }
+}

mas-foundation/src/androidTest/java/com/ca/mas/foundation/MASMultiServerTest.java

@@ -145,7 +145,6 @@ public void testHttpOverrideContentType() throws InterruptedException {
         assertEquals(head, customCharset.toString());
     }
 
-
     @Test
     public void testMultiServerCertificatePinningWithCertChain() throws Exception {
         URL url = new URL("https://swapi.co:443");
@@ -593,6 +592,51 @@ public void testMultiServerGeneratedSecurityConfiguration() throws Exception {
         Assert.assertEquals(expectedResult, "CA Technologies");
     }
 
+    @Test
+    public void testMultiServerEnableSSLPinning() throws Exception {
+        MAS.setSSLPinningEnabled(false);
+        MASSecurityConfiguration configuration = new MASSecurityConfiguration.Builder()
+                .host(new Uri.Builder().encodedAuthority(HOST).build())
+                .add("ZHVtbXk=") //Dummy
+                .build();
+        MASConfiguration.getCurrentConfiguration().addSecurityConfiguration(configuration);
+
+        MASRequest request = new MASRequest.MASRequestBuilder(
+                new Uri.Builder().encodedAuthority(HOST)
+                        .scheme("https")
+                        .path("test")
+                        .build())
+                .build();
+        MASCallbackFuture<MASResponse<JSONObject>> callback = new MASCallbackFuture<>();
+        MAS.invoke(request, callback);
+
+        // Should pass as enableSSLPinning is false.
+        Assert.assertEquals(expectResponse.toString(), callback.get().getBody().getContent().toString());
+    }
+
+    @Test
+    public void testMultiServerAllowSSLPinning() throws Exception {
+        MAS.setSSLPinningEnabled(true);
+        MASSecurityConfiguration configuration = new MASSecurityConfiguration.Builder()
+                .host(new Uri.Builder().encodedAuthority(HOST).build())
+                .add("ZHVtbXk=") //Dummy
+                .allowSSLPinning(false)
+                .build();
+        MASConfiguration.getCurrentConfiguration().addSecurityConfiguration(configuration);
+
+        MASRequest request = new MASRequest.MASRequestBuilder(
+                new Uri.Builder().encodedAuthority(HOST)
+                        .scheme("https")
+                        .path("test")
+                        .build())
+                .build();
+        MASCallbackFuture<MASResponse<JSONObject>> callback = new MASCallbackFuture<>();
+        MAS.invoke(request, callback);
+
+        // Should pass as allowSSLPinning is set to False
+        Assert.assertEquals(expectResponse.toString(), callback.get().getBody().getContent().toString());
+    }
+
     private Certificate[] getCert(URL url) throws Exception {
         //URL url = new URL("https://mobile-staging-androidautomation.l7tech.com:8443");
         //URL url = new URL("https://swapi.co");

mas-foundation/src/main/java/com/ca/mas/core/MobileSsoConfig.java

@@ -255,7 +255,7 @@ public interface MobileSsoConfig {
      *
      * True if MSISDN information should be included.  False if MSISDN information should not be included.
      */
-     String PROP_MSISDN_ENABLED = "msso.msisdn.enabled";
+    String PROP_MSISDN_ENABLED = "msso.msisdn.enabled";
 
     /**
      * String.  URL suffix for client credentials endpoint.
@@ -310,7 +310,8 @@ public interface MobileSsoConfig {
     String PROP_DEVICE_METADATA_PATH = "msso_device_metadata";
 
 
+    String PROP_ALLOW_SSL_PINNING = "allow_ssl_pinning";
     // If you add any properties to this file, you must update MobileSsoFactory.createConfig()
     // or they will be ignored.
 
-}
+}

mas-foundation/src/main/java/com/ca/mas/core/conf/Config.java

@@ -56,6 +56,7 @@ public class Config {
     public static final Config TRUSTED_CERT_PINNED_PUBLIC_KEY_HASHES = new Config(false, MobileSsoConfig.PROP_TRUSTED_CERT_PINNED_PUBLIC_KEY_HASHES, "mag.mobile_sdk.trusted_cert_pinned_public_key_hashes", List.class);
     public static final Config CLIENT_CERT_RSA_KEYBITS = new Config(false, MobileSsoConfig.PROP_CLIENT_CERT_RSA_KEYBITS, "mag.mobile_sdk.client_cert_rsa_keybits", Integer.class);
     public static final Config CLIENT_STORAGE = new Config(false, MobileSsoConfig.PROP_STORAGE, "mag.mobile_sdk.storage", String.class);
+    public static final Config ALLOW_SSL_PINNING = new Config(false, MobileSsoConfig.PROP_ALLOW_SSL_PINNING, "mag.mobile_sdk.allow_ssl_pinning", Boolean.class);
 
     //mag.ble
     public static final Config BLE_SERVICE_UUID = new Config(false, MobileSsoConfig.PROP_BLE_SERVICE_UUID, "mag.ble.msso_ble_service_uuid", String.class);
@@ -66,7 +67,7 @@ public class Config {
             HOSTNAME, PORT, PREFIX, SERVER_CERTS, ORGANIZATION, CLIENT_KEY, CLIENT_SECRET, SCOPE, REDIRECT_URI, AUTHORIZE_PATH, REGISTER_TOKEN_PATH, REGISTER_TOKEN_PATH_SSO, LOGOUT_DEVICE_PATH, REVOKE_PATH,
             REMOVE_DEVICE_PATH, REGISTER_DEVICE_PATH, RENEW_DEVICE_PATH, REGISTER_DEVICE_PATH_CLIENT, CLIENT_CREDENTIAL_INIT_PATH, ENTERPRISE_APP_PATH, SSO_ENABLED, LOCATION_ENABLED, LOCATION_PROVIDER,
             MSISDN_ENABLED, TRUSTED_PUBLIC_PKI,DEVICE_METADATA_PATH, TRUSTED_CERT_PINNED_PUBLIC_KEY_HASHES, CLIENT_CERT_RSA_KEYBITS, CLIENT_STORAGE, BLE_SERVICE_UUID, BLE_USER_SESSION_CHARACTERISTIC_UUID,
-            BLE_RSSI, AUTHENTICATE_OTP_PATH
+            BLE_RSSI, AUTHENTICATE_OTP_PATH, ALLOW_SSL_PINNING
     };
 
     public boolean mandatory;
@@ -89,4 +90,4 @@ public Config(boolean mandatory, String key, String path, Class type) {
         this.type = type;
     }
 
-}
+}

mas-foundation/src/main/java/com/ca/mas/core/conf/ConfigurationManager.java

@@ -46,6 +46,7 @@ public class ConfigurationManager {
     private List<Config> appConfigs;
     private String configurationFileName = null;
     private boolean enablePKCE = true;
+    private boolean sslPinningEnabled = true;
     private boolean idTokenValidation = true;
     private boolean enableJwksPreload = false;
     private JSONObject jsonConfiguration;
@@ -78,6 +79,10 @@ public void enablePKCE(boolean enablePKCE) {
         this.enablePKCE = enablePKCE;
     }
 
+    public void setSSLPinningEnabled(boolean enable) {
+        this.sslPinningEnabled = enable;
+    }
+
     public void enableIdTokenValidation(boolean enableValidation) {
         this.idTokenValidation = enableValidation;
     }
@@ -90,6 +95,10 @@ public boolean isPKCEEnabled() {
         return enablePKCE;
     }
 
+    public boolean isSslPinningEnabled() {
+        return sslPinningEnabled;
+    }
+
     public void reset() {
         connectedGatewayConfigurationProvider = null;
     }
@@ -258,6 +267,12 @@ public ConfigurationProvider create(JSONObject jsonObject) throws JSONException
                 conf.setAlsoTrustPublicPki((Boolean) getValue(Config.TRUSTED_PUBLIC_PKI, jsonObject, Boolean.FALSE));
                 continue;
             }
+
+            if (attr == Config.ALLOW_SSL_PINNING) {
+                conf.setAllowSSLPinning((Boolean) getValue(Config.ALLOW_SSL_PINNING, jsonObject, Boolean.TRUE));
+                continue;
+            }
+
             Object value = getValue(attr, jsonObject);
             if (value != null) {
                 conf.putProperty(attr.key, value);
@@ -477,4 +492,4 @@ public void enableJwksPreload(boolean enableJwksPreload) {
     public void setJsonConfig(JSONObject jsonConfig) {
         this.jsonConfiguration = jsonConfig;
     }
-}
+}

mas-foundation/src/main/java/com/ca/mas/core/conf/ConfigurationProvider.java

@@ -90,6 +90,13 @@ public interface ConfigurationProvider extends TrustedCertificateConfiguration,
      */
     String getPrefix();
 
+    /**
+     * Based on the provided configuration the SDK, retrieve the ssl_pinning_enabled attribute.
+     *
+     * @return the ssl pinning enabled flag configured for the Gateway.
+     */
+    boolean isSSLPinningAllowed();
+
     // Configuration properties that are not currently documented as part of the public API.
 
     /**