AdblockWebView Flutter

.gitlab-ci.yml

@@ -54,10 +54,10 @@ checkstyle:
     - sed -i -e "s|$(pwd)/./||g" checkstyle-report.xml
     # Convert the checkstyle output to code-climate format so gitlab can parse it
     - |
-        violations-command-line \
-          -detail-level COMPACT \
-          -code-climate code-climate-report.json \
-          --violations "CHECKSTYLE" "$(pwd)" ".*checkstyle-report.xml" "Checkstyle"
+      violations-command-line \
+        -detail-level COMPACT \
+        -code-climate code-climate-report.json \
+        --violations "CHECKSTYLE" "$(pwd)" ".*checkstyle-report.xml" "Checkstyle"
   artifacts:
     reports:
       codequality:
@@ -240,23 +240,25 @@ testobject_tests:
     reports:
       junit: test-results/*/philll-adblockwebview-app-*.xml
 
-# automated regression tests using Appium
-automated_tests:
+# automated regression tests template using Appium
+.template_automation:
   stage: device_tests
   interruptible: true
+  retry: 1
   variables:
     GIT_STRATEGY: "none"
     # overridable automation repo; url uses CI_JOB_TOKEN for temporary authorization
     GIT_AUTOMATION_REPO: "https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/eyeo/sandbox/abp-webview-test-automation"
-    # demo app debug apk
     GIT_AUTOMATION_BRANCH: "master"
-    PLATFORM_VERSIONS: "10"
     # demo app debug apk
     TEST_APK: "adblock-android-webviewapp/build/outputs/apk/debug/adblock-android-webviewapp-debug.apk"
-  script:
-    # TESTOBJ_PROJECT_KEY should exist, testing it
-    - test -z ${TESTOBJ_PROJECT_KEY} && echo "echo TESTOBJ_PROJECT_KEY not set. Unable to run tests." && exit 1
+  before_script:
+    - find . -iname "*.apk"
+    - test -z ${SAUCE_USERNAME} && echo "echo SAUCE_USERNAME not set. Unable to run tests." && exit 1
+    - test -z ${SAUCE_ACCESS_KEY} && echo "echo SAUCE_ACCESS_KEY not set. Unable to run tests." && exit 1
+    - curl -v -u "${SAUCE_USERNAME}:${SAUCE_ACCESS_KEY}" --location --request POST 'https://api.eu-central-1.saucelabs.com/v1/storage/upload' --form 'payload=@"adblock-android-webviewapp/build/outputs/apk/debug/adblock-android-webviewapp-debug.apk"' --form 'name="adblock-android-webviewapp-debug.apk"'
     # we are not using submodules, because automation is not a part of repository functionality
+  script:
     # its rather a standalone set of scripts
     - git clone $GIT_AUTOMATION_REPO automation
     - cd automation
@@ -267,8 +269,8 @@ automated_tests:
     - |
       for PLATFORM_VERSION in $PLATFORM_VERSIONS
         do export PLATFORM_VERSION
-        echo "Starting job for version ${PLATFORM_VERSION}"
-        (./gradlew automatedTesting &> platform_version-${PLATFORM_VERSION}.log ; echo $? > result_${PLATFORM_VERSION}) &
+        echo Starting job for version ${PLATFORM_VERSION}
+        (./gradlew ${GRADLE_TASK} &> platform_version-${PLATFORM_VERSION}.log ; echo $? > result_${PLATFORM_VERSION}) &
         pids="$pids $!"
       done
     - wait $pids
@@ -304,78 +306,77 @@ automated_tests:
     reports:
       junit: "automation/target/cucumber-reports/*.xml"
     paths:
-      - "automation/tag-*.log"
+      - "automation/platform_version-*.log"
       - "automation/result_*"
 
-# automated functional tests using Appium
-functional_tests:
-  only:
-    - schedules
-    - web
+master_autojob:
+  extends: .template_automation
+  variables:
+    PLATFORM_VERSIONS: "7 10 11"
+    GRADLE_TASK: "automatedTesting"
+  rules:
+    - if: '$FORCE_MASTER == "true"'
+    - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "master"'
+
+dev_regression_autojob:
+  extends: .template_automation
+  variables:
+    PLATFORM_VERSIONS: "10"
+    GRADLE_TASK: "regression"
+# Commenting Rules, webview CI having issues running develop branch with them
+#  rules:
+#    - if: '$FORCE_REGRESSION == "true"'
+#    - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop"'
+
+dev_functional_autojob:
+  extends: .template_automation
+  variables:
+    PLATFORM_VERSIONS: "7 10 11"
+    GRADLE_TASK: "functional"
+  rules:
+    - if: '$FORCE_FUNCTIONAL == "true"'
+    - if: '$CI_COMMIT_BRANCH == "develop" && $CI_PIPELINE_SOURCE == "schedule"'
+
+plt_tests:
   stage: device_tests
   interruptible: true
+  tags:
+    - "ce11171b5399805a0c"
+  retry: 1
+  image: "registry.gitlab.com/eyeo/docker/appium:1.16.0"
   variables:
     GIT_STRATEGY: "none"
-    # overridable automation repo; url uses CI_JOB_TOKEN for temporary authorization
+    PLATFORM_VERSIONS: "10"
     GIT_AUTOMATION_REPO: "https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/eyeo/sandbox/abp-webview-test-automation"
-    # demo app debug apk
     GIT_AUTOMATION_BRANCH: "master"
-    PLATFORM_VERSIONS: "9 10 11"
-    # demo app debug apk
-    TEST_APK: "adblock-android-webviewapp/build/outputs/apk/debug/adblock-android-webviewapp-debug.apk"
+    TEST_APK: "../adblock-android-webviewapp/build/outputs/apk/debug/adblock-android-webviewapp-debug.apk"
+  before_script:
+    - apt-get -y update
+    - apt-get -y install openjdk-8-jdk git
+    - if [ "${ANDROID_KEY_FILE}" ] ; then cp -f ${ANDROID_KEY_FILE} ~/.android/adbkey; fi
+    - if [ "${ANDROID_KEY_PUB_FILE}" ] ; then cp -f ${ANDROID_KEY_PUB_FILE} ~/.android/adbkey.pub; fi
+    - curl -u "${SAUCE_USERNAME}:${SAUCE_ACCESS_KEY}" --location --request POST 'https://api.eu-central-1.saucelabs.com/v1/storage/upload'
+      --form 'payload=@adblock-android-webviewapp/build/outputs/apk/debug/adblock-android-webviewapp-debug.apk'
+      --form 'name="${TEST_APK}"'
   script:
-    # TESTOBJ_PROJECT_KEY should exist, testing it
-    - test -z ${TESTOBJ_PROJECT_KEY} && echo "echo TESTOBJ_PROJECT_KEY not set. Unable to run tests." && exit 1
-    # we are not using submodules, because automation is not a part of repository functionality
-    # its rather a standalone set of scripts
+    - CHROMEDRIVER_AUTODOWNLOAD=true /root/entry_point.sh &> appium.log &
+    - echo $! > appium_pid
     - git clone $GIT_AUTOMATION_REPO automation
     - cd automation
     - git checkout ${GIT_AUTOMATION_BRANCH:-master}
-    # Launch an instance of gradle for each bunch of tags we want to test
-    - set +e
-    - pids=""
-    - |
-      for PLATFORM_VERSION in $PLATFORM_VERSIONS
-        do export PLATFORM_VERSION
-        echo Starting job for version ${PLATFORM_VERSION}
-        (./gradlew functional &> platform_version-${PLATFORM_VERSION}.log ; echo $? > result_${PLATFORM_VERSION}) &
-        pids="$pids $!"
-      done
-    - wait $pids
-    # Check for any failures and re-run them
-    - |
-      for PLATFORM_VERSION in $PLATFORM_VERSIONS
-        do if [ -s target/rerun${PLATFORM_VERSION}.txt ] ; then
-          echo "Rerunning failed test cases for platform version ${PLATFORM_VERSION}"
-          mv target/rerun${PLATFORM_VERSION}.txt target/rerun.txt
-          ./gradlew rerunFailed
-          echo $? > result_${PLATFORM_VERSION}
-          rm -f target/rerun.txt
-        fi
-      done
-    # check the exit codes of all processes were 0
-    - |
-      for PLATFORM_VERSION in $PLATFORM_VERSIONS
-        do test $(cat result_${PLATFORM_VERSION}) = 0
-      done
-  after_script:
-    - cd automation
-    - |
-      for PLATFORM_VERSION in $PLATFORM_VERSIONS
-        do
-        echo "**********************************"
-        echo "Logs for tests with platform_version ${PLATFORM_VERSION}"
-        echo "**********************************"
-        cat platform_version-${PLATFORM_VERSION}.log
-      done
+    - APPIUM_HOST="localhost:4723" ./gradlew pltWebview
+  rules:
+    - if: '$FORCE_PLT == "true"'
+    #- if: '$CI_COMMIT_BRANCH == "develop" && $CI_PIPELINE_SOURCE == "schedule"'
+    #- if: '$CI_COMMIT_BRANCH == "develop" && $CI_PIPELINE_SOURCE == "manual"'
   artifacts:
     when: always
     expire_in: 6 months
     reports:
       junit: "automation/target/cucumber-reports/*.xml"
     paths:
-      - "automation/platform_version-*.log"
-      - "automation/result_*"
+      - "automation/plt/webviewPLT.json"
+      - "appium.log"
 
 # FilterEngine performance benchmarking and memory
 benchmark:
@@ -409,18 +410,14 @@ benchmark:
   stage: publish
   <<: *cache_readonly
   script:
-    - |
-      if [ -z "${BINTRAY_USERNAME}" ] || [ -z "${BINTRAY_KEY}" ] ; then
-        echo "BINTRAY_USERNAME and BINTRAY_KEY need to be set for publishing to work"
-        echo "Make sure this is running on a protected branch/tag to get those variables set"
-      fi
     - |
       if [[ ${DRY_RUN:-true} == "true" ]] ; then
-        echo 'Note: $DRY_RUN is currently "true", run pipeline manually and set to "false" to actually publish to bintray'
+        echo 'Note: $DRY_RUN is currently "true", run pipeline manually and set to "false" to actually publish to gitlab'
+      else
+        ./gradlew publish
       fi
-    - ./gradlew bintrayUpload -PbintrayUser=${BINTRAY_USERNAME:-unset} -PbintrayKey=${BINTRAY_KEY:-unset} -PdryRun=${DRY_RUN:-true}
 
-publish_rc_to_bintray:
+publish_rc_to_gitlab:
   <<: *publish_template
   only:
     variables:
@@ -430,7 +427,7 @@ publish_rc_to_bintray:
     # Append '-rcX' to the version to publish
     - sed -i -e "/moduleVersion/s/'$/-rc${RC}'/g" build.gradle
 
-publish_to_bintray:
+publish_to_gitlab:
   <<: *publish_template
   stage: publish
   only:

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "libadblockplus"]
 	path = libadblockplus
-	url = ../libadblockplus.git
+	url = ../../adblockplus/libadblockplus.git

README.md

@@ -1,7 +1,3 @@
- [ ![adblock-android](https://img.shields.io/bintray/v/adblockplus/maven/adblock-android?label=adblock-android) ](https://bintray.com/adblockplus/maven/adblock-android/_latestVersion)
- [ ![adblock-android-webview](https://img.shields.io/bintray/v/adblockplus/maven/adblock-android-webview?label=adblock-android-webview) ](https://bintray.com/adblockplus/maven/adblock-android-webview/_latestVersion)
- [ ![adblock-android-settings](https://img.shields.io/bintray/v/adblockplus/maven/adblock-android-settings?label=adblock-android-settings) ](https://bintray.com/adblockplus/maven/adblock-android-settings/_latestVersion)
-
 Adblock Android SDK
 ================================
 
@@ -22,7 +18,15 @@ You can find it in the 'adblock-android' directory.
 
 ### Using as a Gradle dependency
 
-Make sure you have `jcenter()` in the list of repositories and then add the following dependency:
+Make sure you have:  
+
+```groovy
+maven {
+    url 'https://gitlab.com/api/v4/projects/8817162/packages/maven'
+}
+```
+
+in the list of repositories and then add the following dependencies:
 
 ```groovy
 dependencies {
@@ -202,11 +206,19 @@ You can select the test class/method and click 'Run ..Test'.
 An Android library that provides a configuration interface for Adblock Plus.
 You can find it in the 'adblock-android-settings' directory:
 * GeneralSettingsFragment - main fragment
-* WhitelistedDomainsSettingsFragment - whitelisted domains fragment
+* AllowlistedDomainsSettingsFragment - allowlisted domains fragment
 
 ### Using as a Gradle dependency
 
-Make sure you have `jcenter()` in the list of repositories and then add the following dependency:
+Make sure you have:  
+
+```groovy
+maven {
+    url 'https://gitlab.com/api/v4/projects/8817162/packages/maven'
+}
+```
+
+in the list of repositories and then add the following dependency:
 
 ```groovy
 dependencies {
@@ -262,7 +274,7 @@ Implement the following interfaces in your settings activity:
 
 * `BaseSettingsFragment.Provider`
 * `GeneralSettingsFragment.Listener`
-* `WhitelistedDomainsSettingsFragment.Listener`
+* `AllowlistedDomainsSettingsFragment.Listener`
 
 and return created instance or AdblockHelper instances:
 
@@ -403,7 +415,15 @@ You can find it in the 'adblock-android-webview' directory.
 
 ### Using as a Gradle dependency
 
-Make sure you have `jcenter()` in the list of repositories and then add the following dependency:
+Make sure you have:  
+
+```groovy
+maven {
+    url 'https://gitlab.com/api/v4/projects/8817162/packages/maven'
+}
+```
+
+in the list of repositories and then add the following dependency:
 
 ```groovy
 dependencies {
@@ -467,7 +487,7 @@ The simplest solution is to use `AdblockHelper` from `-settings` as an external
 
 If the adblock engine provider is not set, it's created by the AdblockWebView instance automatically.
 
-Use `setSiteKeysConfiguration(..)` to support sitekeys whitelisting.
+Use `setSiteKeysConfiguration(..)` to support sitekeys allowlisting.
 This is optional but highly suggested. See `TabFragment.java` on usage example.
 
 Please note that the AdblockWebView does intercept some of the HTTP(S) requests done by the subclassed WebView and does them internally by means of `java.net.HttpURLConnection`. 
@@ -480,10 +500,14 @@ This is an optional feature that rewrites the HTML content under the hood in ord
 This feature also requires `setSiteKeysConfiguration(..)` to be called beforehand, otherwise, an IllegalStateException is thrown.
 See `TabFragment.java` on usage example.
 
-Use `setEventsListener()` to subscribe and unsubscribe to ad blocking and whitelisting events, eg.
-"resource loading blocked" or "resource loading whitelisted" event that can be used for stats.
+Use `setEventsListener()` to subscribe and unsubscribe to ad blocking and allowlisting events, eg.
+"resource loading blocked" or "resource loading allowlisted" event that can be used for stats.
 For the latter, there is a convenience class `WebViewCounters` which can be bound to `EventsListener`
 and notify your View about new values. See an example of usage in WebView Application.
+Blocking and allowlisting events are fired only for blocking and allowing network request events
+and not for element hiding. Allowing network request event is triggered when there is a corresponding
+allowlisting filter for an url, no matter if it is an Acceptable Ads filter or any other filter,
+including a custom domain allowlisting filter.
 
 Use `dispose(Runnable disposeFinished)` to release resources (**required**).
 Note it can be invoked from the background thread.