Setup Testing

.github/workflows/test.yml

@@ -0,0 +1,180 @@
+name: Test Suite
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+env:
+  GOPRIVATE: github.com/getlantern
+
+jobs:
+  test-suite:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest-16-cores, windows-latest ]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Pull LFS objects
+        run: git lfs pull
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: "go.mod"
+
+      - name: Granting private modules access
+        run: git config --global url."https://${{ secrets.GH_TOKEN }}:[email protected]/".insteadOf "https://github.com/"
+
+      - name: GCloud Auth
+        uses: google-github-actions/auth@v2
+        with:
+          credentials_json: ${{ secrets.GCP_CREDENTIALS }}
+
+      - name: 'Set up Cloud SDK'
+        uses: google-github-actions/setup-gcloud@v2
+
+      - name: Setup protoc
+        uses: arduino/setup-protoc@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install latest protoc-gen-go
+        run: go install github.com/golang/protobuf/protoc-gen-go@latest
+
+      - name: Setup JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 17
+          cache: 'gradle'
+
+      - name: Install Flutter
+        uses: subosito/flutter-action@v2
+        with:
+          channel: "stable"
+
+      - name: Activate dart plugins
+        run: |
+          dart pub global activate protoc_plugin
+          dart pub global activate patrol_cli
+
+      - name: Install dependencies
+        run: flutter pub get
+
+      - name: Generate app.env
+        env:
+          ANDROID_INTERSTITIAL_AD_ID: ${{ secrets.INTERSTITIAL_AD_UNIT_ID }}
+          IOS_INTERSTITIAL_AD_ID: ${{ secrets.INTERSTITIAL_AD_UNIT_ID_IOS }}
+          TAPSELL_VIDEO_INTERSTITIAL_ZONE_ID: ${{ secrets.TAPSELL_VIDEO_INTERSTITIAL_ZONE_ID }}
+          TAPSELL_INTERSTITIAL_ZONE_ID: ${{ secrets.TAPSELL_INTERSTITIAL_ZONE_ID }}
+        run: |
+          touch app.env
+          echo "Android_interstitialAd=$ANDROID_INTERSTITIAL_AD_ID" > app.env
+          echo "IOS_interstitialAd=$IOS_INTERSTITIAL_AD_ID" >> app.env
+          echo "VideoInterstitialZoneId=$TAPSELL_VIDEO_INTERSTITIAL_ZONE_ID" >> app.env
+          echo "InterstitialZoneId=$TAPSELL_INTERSTITIAL_ZONE_ID" >> app.env  
+
+      - name: Setup Xcode
+        uses: maxim-lobanov/setup-xcode@v1
+        if: runner.os == 'macOS'
+        with:
+          xcode-version: latest-stable
+
+      - name: Install Linux dependencies
+        if: runner.os == 'linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y network-manager dbus-x11
+          sudo apt-get install -y libwebkit2gtk-4.1-dev
+          sudo apt-get install -y libunwind-dev libstdc++-12-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-d cmake
+          sudo apt-get install -y libgtk-3-0 libblkid1 liblzma5
+          sudo apt-get install -y libpcap-dev libgtk-3-dev libayatana-appindicator3-dev ruby ruby-dev && sudo gem install bundler -v 2.2.26
+
+      - name: Install the ninja build tool
+        if: runner.os == 'linux'
+        uses: seanmiddleditch/gha-setup-ninja@master
+
+      - name: Install WebView2 Runtime
+        if: matrix.os == 'windows-latest'
+        shell: pwsh
+        run: |
+          Invoke-WebRequest -Uri "https://go.microsoft.com/fwlink/p/?LinkId=2124703" -OutFile "MicrosoftEdgeWebView2Setup.exe"
+          Start-Process -FilePath ".\MicrosoftEdgeWebView2Setup.exe" -ArgumentList "/silent", "/install" -Wait
+
+      - name: Set up MinGW
+        if: matrix.os == 'windows-latest'
+        run: choco install mingw -y
+
+      - name: Build for Windows
+        if: matrix.os == 'windows-latest'
+        run: |
+          echo "Building for Windows..."
+          make windows
+          make ffigen
+
+      - name: Build linux Libraries
+        shell: bash
+        if: runner.os == 'linux'
+        run: |
+          make android ANDROID_ARCH=all
+          make linux
+          make ffigen
+
+      - name: Build for IOS
+        if: runner.os == 'macOS'
+        run: |
+          make ios
+          make ffigen
+
+      - name: Running widget tests
+        run: make widget-tests
+
+        # Run firebase test only on one OS runner
+        # Does not make sense to run on all OS runners
+      - name: Running workflow test for android on Firebase test labs
+        if: runner.os == 'linux'
+        run: make ci-android-test
+
+      - name: Starting Simulator
+        id: simulator
+        if: runner.os == 'macOS'
+        uses: futureware-tech/simulator-action@v4
+        with:
+          model: 'iPhone 15 Pro'
+
+      - name: Running workflow test for iOS
+        run: patrol test -d ${{ steps.simulator.outputs.udid }}
+        if: runner.os == 'macOS'
+        timeout-minutes: 70
+
+      - name: Upload xc result
+        if: runner.os == 'macOS' && always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: xc-result
+          path: ${{ github.workspace }}/build/ios
+          retention-days: 2
+
+      - name: Running workflow test for linux
+        uses: coactions/setup-xvfb@v1
+        if: runner.os == 'linux'
+        timeout-minutes: 60
+        with:
+          run: |
+            sudo systemctl start dbus
+            sudo systemctl start NetworkManager
+            make linuxDesktopTest
+
+      - name: Running workflow test for windows
+        run: make windowsDesktopTest
+        if: runner.os == 'windows'
+        timeout-minutes: 60

.gitignore

@@ -85,3 +85,5 @@ lib/generated_bindings.dart
 
 *.env
 ExportOptions.plist
+integration_test/test_bundle.dart
+integration_test/test_bundle.dart

Makefile

@@ -44,7 +44,7 @@ test:
 TEST ?= *_test
 
 # integration-test:
-# 	@flutter drive --driver test_driver/integration_driver.dart --debug --flavor prod --target `ls integration_test/$(TEST).dart`
+# 	@flutter drive --driver test_driver/integration_test.dart --debug --flavor prod --target `ls integration_test/$(TEST).dart`
 
 APP ?= lantern
 CAPITALIZED_APP := Lantern
@@ -88,6 +88,7 @@ ADB       := $(call get-command,adb)
 OPENSSL   := $(call get-command,openssl)
 GMSAAS    := $(call get-command,gmsaas)
 SENTRY    := $(call get-command,sentry-cli)
+PATROL    := $(call get-command,patrol)
 BASE64    := $(call get-command,base64)
 
 GIT_REVISION_SHORTCODE := $(shell git rev-parse --short HEAD)
@@ -745,3 +746,86 @@ clean:
 	rm -f `which gomobile` && \
 	rm -f `which gobind`
 	rm -Rf "$(FLASHLIGHT_FRAMEWORK_PATH)" "$(INTERMEDIATE_FLASHLIGHT_FRAMEWORK_PATH)"
+
+
+# Test environment scripts and other utilities
+
+require-patrol:
+	@if [[ -z "$(PATROL)" ]]; then echo 'patrol-cli is not installed. Please install it with dart pub global activate patrol_cli'; exit 1; fi
+
+
+# Build android apk for test
+test-build-android:
+	@echo "Building apk for test..."
+	@patrol build android
+
+# Application test cases
+
+# Run all native tests
+nativeTest: require-patrol
+	@echo "Running native tests..."
+	patrol test --target integration_test/features/vpn/vpn_flow_test.dart --dart-define native=true --flavor=prod --verbose
+
+# Run specific native tests
+
+runNativeTest: require-patrol
+	@ARGUMENTS=$(filter-out $@,$(MAKECMDGOALS)); \
+	echo "Running  patrol native tests on: $$ARGUMENTS" && \
+	patrol test --target $$ARGUMENTS --flavor=prod
+
+
+#Runs all integration tests
+appWorkflowTest:
+	@echo "Running all integration tests..."
+	patrol test
+
+
+# Run specific integration tests
+# Usage: make run-specific-integration-tests integration_test/app_startup_flow_test.dart
+runTest:
+	@ARGUMENTS=$(filter-out $@,$(MAKECMDGOALS)); \
+	echo "Running tests on: $$ARGUMENTS" && \
+	patrol test --target $$ARGUMENTS
+
+
+#------- Desktop test and utils ------------
+
+# Run all workflow tests on desktop
+maOSWorkflowTest:
+	@echo "Running all integration tests..."
+	sh $(CURDIR)/integration_test/run_macos_test.sh
+
+linuxDesktopTest:
+	@echo "Running all integration tests..."
+	sh $(CURDIR)/integration_test/run_linux_test.sh
+
+windowsDesktopTest:
+	@echo "Running all integration tests..."
+	sh $(CURDIR)/integration_test/run_windows_test.sh
+
+# Run specific tests on desktop
+#you can pass DEVICE=<platform> (e.g., macOS, linux, windows)
+runDesktopTest:
+	@ARGUMENTS=$(filter-out $@,$(MAKECMDGOALS)); \
+	DEVICE=$(DEVICE); \
+	if [ -z "$$DEVICE" ]; then \
+		echo "Error: DEVICE is not specified. Use DEVICE=<platform> (e.g., macOS, linux, android)"; \
+		exit 1; \
+	fi; \
+	echo "Running tests on: $$ARGUMENTS" && \
+	flutter test $$ARGUMENTS -d $$DEVICE -r expanded
+
+
+# Run all android test on Firebase test lab
+ci-android-test:test-build-android
+	@echo "Running tests on Firebase test labs..."
+	sh $(CURDIR)/integration_test/run_android_testlabs.sh
+
+
+#Runs widget tets
+widget-tests:
+	@echo "Running widget tests..."
+	flutter test test/
+
+
+