diff --git a/.github/workflows/java-ios.yml b/.github/workflows/java-ios.yml new file mode 100644 index 00000000..122dffd0 --- /dev/null +++ b/.github/workflows/java-ios.yml @@ -0,0 +1,61 @@ +name: Java iOS Tests + +on: + push: + paths: + - 'java-ios-app/**' + - '.github/workflows/java-ios.yml' + branches: + - main + pull_request: + paths: + - 'java-ios-app/**' + - '.github/workflows/java-ios.yml' + branches: + - main + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} + cancel-in-progress: true + +jobs: + java-ios-app: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Install saucectl + uses: saucelabs/saucectl-run-action@v4 + env: + GITHUB_TOKEN: ${{ github.token }} + with: + skip-run: true + + - name: Pre-Upload App + id: upload + working-directory: ./wdio-ios-app/ + env: + SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} + SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} + run: | + APP_FILEID=$(saucectl storage upload ./app/SauceLabs-Demo-App.ipa -o json | jq -r '.id') + SIMULATOR_APP_FILEID=$(saucectl storage upload ./app/SauceLabs-Demo-App.Simulator.ipa -o json | jq -r '.id') + echo "APP_FILEID=${APP_FILEID}" >> $GITHUB_OUTPUT + echo "SIMULATOR_APP_FILEID=${SIMULATOR_APP_FILEID}" >> $GITHUB_OUTPUT + + - name: Build example + uses: docker/build-push-action@v6.9.0 + env: + SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }} + SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }} + with: + context: ./java-ios-app + file: ./java-ios-app/Dockerfile + build-args: | + APP_FILEID=${{ steps.upload.outputs.APP_FILEID }} + SIMULATOR_APP_FILEID=${{ steps.upload.outputs.SIMULATOR_APP_FILEID }} + push: false + secret-envs: | + "SAUCE_USERNAME=SAUCE_USERNAME" + "SAUCE_ACCESS_KEY=SAUCE_ACCESS_KEY" diff --git a/java-ios-app/.gitignore b/java-ios-app/.gitignore new file mode 100644 index 00000000..8b830ae3 --- /dev/null +++ b/java-ios-app/.gitignore @@ -0,0 +1,4 @@ +target/ +.idea/ +.DS_Store +*.iml diff --git a/java-ios-app/.mvn/wrapper/maven-wrapper.jar b/java-ios-app/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 00000000..cb28b0e3 Binary files /dev/null and b/java-ios-app/.mvn/wrapper/maven-wrapper.jar differ diff --git a/java-ios-app/.mvn/wrapper/maven-wrapper.properties b/java-ios-app/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..308007b5 --- /dev/null +++ b/java-ios-app/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.2/maven-wrapper-3.3.2.jar diff --git a/java-ios-app/Dockerfile b/java-ios-app/Dockerfile new file mode 100644 index 00000000..2fc5b568 --- /dev/null +++ b/java-ios-app/Dockerfile @@ -0,0 +1,23 @@ +# syntax=docker/dockerfile:1 + +FROM eclipse-temurin:8u432-b06-jdk-jammy AS runner + +# Install curl +RUN apt-get update && apt-get install -y curl +# Install runme +RUN curl -sSL https://download.stateful.com/runme/3.9.2/runme_linux_x86_64.tar.gz | tar -xz -C /usr/local/bin runme + +FROM runner +RUN mkdir -p /workspace +WORKDIR /workspace +COPY . . + +ARG APP_FILEID + +RUN --mount=type=secret,id=SAUCE_USERNAME,env=SAUCE_USERNAME \ + --mount=type=secret,id=SAUCE_ACCESS_KEY,env=SAUCE_ACCESS_KEY \ + runme run mvn-run-ios-test + +RUN --mount=type=secret,id=SAUCE_USERNAME,env=SAUCE_USERNAME \ + --mount=type=secret,id=SAUCE_ACCESS_KEY,env=SAUCE_ACCESS_KEY \ + runme run mvn-run-ios-test-modified diff --git a/java-ios-app/README.md b/java-ios-app/README.md new file mode 100644 index 00000000..e6b670d7 --- /dev/null +++ b/java-ios-app/README.md @@ -0,0 +1,58 @@ +# Getting started with Sauce Labs Visual Java + iOS Native App [![](https://badgen.net/badge/Run%20this%20/README/5B3ADF?icon=https://runme.dev/img/logo.svg)](https://runme.dev/api/runme?repository=git%40github.com%3Asaucelabs%2Fvisual-examples.git) + +## Prerequisites + +- For macOS Ventura: Git and Homebrew +- For Linux: Git and Eclipse Temurin JDK 8+ (https://adoptium.net/temurin/releases/) +- Sauce Labs Account + +## Run the demo + +- Install Eclipse Temurin JDK (for macOS Ventura): + +```sh { "name":"java" } +brew install --cask temurin +``` + +- Clone the repository: + +```sh { "name":"clone" } +git clone https://github.com/saucelabs/visual-examples +cd visual-examples/java-ios-app +``` + +- Configure with your Sauce credentials from https://app.saucelabs.com/user-settings + +```sh { "name":"set-credentials" } +export SAUCE_USERNAME=__YOUR_SAUCE_USERNAME__ +export SAUCE_ACCESS_KEY=__YOUR_SAUCE_ACCESS_KEY__ +``` + +- Run the test + +```sh { "name":"mvn-run-ios-test" } +./mvnw clean test +``` + +- Review your screenshots by clicking on the url printed in the test or go to https://app.saucelabs.com/visual/builds. +- Accept all diffs, so they become new baselines. +- Re-run the tests + +```sh { "name":"mvn-run-ios-test-modified" } +VISUAL_CHECK=enabled ./mvnw clean test +``` + +- Open the test or go to https://app.saucelabs.com/visual/builds to review changes. + + +**NOTE**: If you'd like run the full page screenshot test additionally, + you need to pass the environment variable FPS=enabled when running the test. + +```sh { "name":"mvn-run-ios-test-fps" } +FPS=enabled ./mvnw clean test +``` + +## Installation & Usage + +View installation and usage instructions on +the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/java/). diff --git a/java-ios-app/app/SauceLabs-Demo-App.Simulator.ipa b/java-ios-app/app/SauceLabs-Demo-App.Simulator.ipa new file mode 120000 index 00000000..f1feaf7d --- /dev/null +++ b/java-ios-app/app/SauceLabs-Demo-App.Simulator.ipa @@ -0,0 +1 @@ +../../wdio-ios-app/app/SauceLabs-Demo-App.Simulator.ipa \ No newline at end of file diff --git a/java-ios-app/app/SauceLabs-Demo-App.ipa b/java-ios-app/app/SauceLabs-Demo-App.ipa new file mode 120000 index 00000000..ad9350fd --- /dev/null +++ b/java-ios-app/app/SauceLabs-Demo-App.ipa @@ -0,0 +1 @@ +../../wdio-ios-app/app/SauceLabs-Demo-App.ipa \ No newline at end of file diff --git a/java-ios-app/mvnw b/java-ios-app/mvnw new file mode 100755 index 00000000..66df2854 --- /dev/null +++ b/java-ios-app/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/java-ios-app/mvnw.cmd b/java-ios-app/mvnw.cmd new file mode 100644 index 00000000..95ba6f54 --- /dev/null +++ b/java-ios-app/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM https://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/java-ios-app/pom.xml b/java-ios-app/pom.xml new file mode 100644 index 00000000..66178528 --- /dev/null +++ b/java-ios-app/pom.xml @@ -0,0 +1,43 @@ + + + 4.0.0 + + com.example + java-ios-app + 0.0.1 + + + 8 + 8 + UTF-8 + + + + + com.saucelabs.visual + java-client + 0.11.2 + test + + + io.appium + java-client + 8.6.0 + test + + + org.junit.jupiter + junit-jupiter-api + 5.11.3 + test + + + org.slf4j + slf4j-simple + 2.0.13 + + + + \ No newline at end of file diff --git a/java-ios-app/src/test/java/com/example/TestUtils.java b/java-ios-app/src/test/java/com/example/TestUtils.java new file mode 100644 index 00000000..abfa4cdd --- /dev/null +++ b/java-ios-app/src/test/java/com/example/TestUtils.java @@ -0,0 +1,59 @@ +package com.example; + +import io.appium.java_client.ios.IOSDriver; +import java.net.MalformedURLException; +import java.net.URL; +import java.time.Instant; +import org.openqa.selenium.Capabilities; +import org.openqa.selenium.MutableCapabilities; +import org.openqa.selenium.remote.RemoteWebDriver; + +public class TestUtils { + + static RemoteWebDriver getDriver(String username, String accessKey) throws MalformedURLException { + return new IOSDriver(getDriverUrl(username, accessKey), getCapabilities()); + } + + /** + * For all capabilities please check Platform Configurator For + * available devices please check Available + * Devices + */ + private static Capabilities getCapabilities() { + // You should always target a specific device and OS version. + // Different devices will generate different baselines as their screen size and pixel density + // are different. + // See: https://docs.saucelabs.com/visual-testing/mobile-native-testing/#best-practices + MutableCapabilities caps = new MutableCapabilities(); + caps.setCapability("appium:deviceName", "iPhone 14 Pro"); + caps.setCapability("appium:platformVersion", "17"); + caps.setCapability("platformName", "iOS"); + caps.setCapability("appium:automationName", "XCUITest"); + caps.setCapability("appium:app", "storage:" + System.getenv("APP_FILEID")); + MutableCapabilities sauceOptions = new MutableCapabilities(); + sauceOptions.setCapability("appiumVersion", "latest"); + sauceOptions.setCapability("name", "java-ios-app - Real Device"); + sauceOptions.setCapability("build", "Sauce Demo Test " + Instant.now()); + caps.setCapability("sauce:options", sauceOptions); + return caps; + } + + private static URL getDriverUrl(String username, String accessKey) throws MalformedURLException { + if (username == null + || accessKey == null + || username.trim().isEmpty() + || accessKey.trim().isEmpty()) { + String err = + "Sauce Labs credentials not found. Please set SAUCE_USERNAME and SAUCE_ACCESS_KEY in your environment"; + throw new RuntimeException(err); + } + String dataCenter = System.getenv("SAUCE_REGION"); + if (dataCenter == null || dataCenter.trim().isEmpty()) { + dataCenter = "us-west-1"; + } + return new URL( + String.format( + "https://%s:%s@ondemand.%s.saucelabs.com:443/wd/hub", username, accessKey, dataCenter)); + } +} diff --git a/java-ios-app/src/test/java/com/example/VisualTest.java b/java-ios-app/src/test/java/com/example/VisualTest.java new file mode 100644 index 00000000..ac6742af --- /dev/null +++ b/java-ios-app/src/test/java/com/example/VisualTest.java @@ -0,0 +1,90 @@ +package com.example; + +import com.example.pageobjects.CatalogPage; +import com.example.pageobjects.LoginPage; +import com.example.pageobjects.MenuPage; +import com.saucelabs.visual.CheckOptions; +import com.saucelabs.visual.VisualApi; +import com.saucelabs.visual.junit5.TestMetaInfoExtension; +import com.saucelabs.visual.model.FullPageScreenshotConfig; +import java.net.MalformedURLException; +import java.util.ArrayList; +import java.util.List; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable; +import org.junit.jupiter.api.extension.ExtendWith; +import org.openqa.selenium.WebElement; +import org.openqa.selenium.remote.RemoteWebDriver; + +@ExtendWith({TestMetaInfoExtension.class}) +public class VisualTest { + + private static final String SAUCE_USERNAME = System.getenv("SAUCE_USERNAME"); + private static final String SAUCE_ACCESS_KEY = System.getenv("SAUCE_ACCESS_KEY"); + private static final String VISUAL_CHECK = System.getenv("VISUAL_CHECK"); + + private static VisualApi visual; + private static RemoteWebDriver driver; + + @BeforeAll + public static void init() throws MalformedURLException { + driver = TestUtils.getDriver(SAUCE_USERNAME, SAUCE_ACCESS_KEY); + visual = + new VisualApi.Builder(driver, SAUCE_USERNAME, SAUCE_ACCESS_KEY) + .withBuild("Sauce Demo Test") + .withBranch("main") + .withProject("Java iOS Native App") + .build(); + } + + @Test + void checkAppCatalog() { + visual.sauceVisualCheck("Startup"); + + MenuPage menuPage = new MenuPage(driver); + menuPage.open(); + menuPage.clickLoginButton(); + + LoginPage loginPage = new LoginPage(driver); + if (VISUAL_CHECK != null && !VISUAL_CHECK.isEmpty()) { + loginPage.clickVisualUserButton(); + } else { + loginPage.clickBobUserButton(); + } + loginPage.clickLoginButton(); + + CatalogPage catalogPage = new CatalogPage(driver); + + WebElement firstImage = catalogPage.getProductImages().get(0); + List prices = catalogPage.getVisibleProductPrices(); + List ignore = new ArrayList<>(); + ignore.add(firstImage); + ignore.addAll(prices); + + visual.sauceVisualCheck( + "App Catalog", new CheckOptions.Builder().withIgnoreElements(ignore).build()); + } + + @Test + void captureOnlyCatalogContent() { + CatalogPage catalogPage = new CatalogPage(driver); + visual.sauceVisualCheck( + "Catalog Fragment", + new CheckOptions.Builder().withClipElement(catalogPage.getCatalogContent()).build()); + } + + @Test + @EnabledIfEnvironmentVariable(named = "FPS", matches = "enabled") + void checkFullPageCatalog() { + CatalogPage catalogPage = new CatalogPage(driver); + visual.sauceVisualCheck( + "Full page app catalog", + new CheckOptions.Builder() + .withFullPageConfig( + new FullPageScreenshotConfig.Builder() + .withScrollElement(catalogPage.getFullPageCatalog()) + .build()) + .build()); + } +} diff --git a/java-ios-app/src/test/java/com/example/pageobjects/CatalogPage.java b/java-ios-app/src/test/java/com/example/pageobjects/CatalogPage.java new file mode 100644 index 00000000..e3e4d69d --- /dev/null +++ b/java-ios-app/src/test/java/com/example/pageobjects/CatalogPage.java @@ -0,0 +1,32 @@ +package com.example.pageobjects; + +import io.appium.java_client.AppiumBy; +import java.util.List; +import org.openqa.selenium.WebElement; +import org.openqa.selenium.remote.RemoteWebDriver; + +public class CatalogPage { + + private final RemoteWebDriver driver; + + public CatalogPage(RemoteWebDriver driver) { + this.driver = driver; + } + + public List getProductImages() { + return driver.findElements(AppiumBy.accessibilityId("Product Image")); + } + + public List getVisibleProductPrices() { + return driver.findElements(AppiumBy.accessibilityId("Product Price")).subList(0, 4); + } + + public WebElement getCatalogContent() { + return driver.findElement( + AppiumBy.xpath("//XCUIElementTypeOther[@name=\"Catalog-screen\"]/XCUIElementTypeOther[2]")); + } + + public WebElement getFullPageCatalog() { + return driver.findElement(AppiumBy.xpath("//XCUIElementTypeCollectionView")); + } +} diff --git a/java-ios-app/src/test/java/com/example/pageobjects/LoginPage.java b/java-ios-app/src/test/java/com/example/pageobjects/LoginPage.java new file mode 100644 index 00000000..969ae053 --- /dev/null +++ b/java-ios-app/src/test/java/com/example/pageobjects/LoginPage.java @@ -0,0 +1,38 @@ +package com.example.pageobjects; + +import io.appium.java_client.AppiumBy; +import org.openqa.selenium.WebElement; +import org.openqa.selenium.remote.RemoteWebDriver; + +public class LoginPage { + + private final RemoteWebDriver driver; + + public LoginPage(RemoteWebDriver driver) { + this.driver = driver; + } + + public WebElement getBobUserButton() { + return driver.findElement(AppiumBy.accessibilityId("bob@example.com")); + } + + public WebElement getVisualUserButton() { + return driver.findElement(AppiumBy.accessibilityId("visual@example.com")); + } + + public WebElement getLoginButton() { + return driver.findElement(AppiumBy.accessibilityId("Login")); + } + + public void clickBobUserButton() { + getBobUserButton().click(); + } + + public void clickVisualUserButton() { + getVisualUserButton().click(); + } + + public void clickLoginButton() { + getLoginButton().click(); + } +} diff --git a/java-ios-app/src/test/java/com/example/pageobjects/MenuPage.java b/java-ios-app/src/test/java/com/example/pageobjects/MenuPage.java new file mode 100644 index 00000000..27fcad08 --- /dev/null +++ b/java-ios-app/src/test/java/com/example/pageobjects/MenuPage.java @@ -0,0 +1,30 @@ +package com.example.pageobjects; + +import io.appium.java_client.AppiumBy; +import org.openqa.selenium.WebElement; +import org.openqa.selenium.remote.RemoteWebDriver; + +public class MenuPage { + + private final RemoteWebDriver driver; + + public MenuPage(RemoteWebDriver driver) { + this.driver = driver; + } + + public WebElement getLoginButton() { + return driver.findElement(AppiumBy.accessibilityId("LogOut-menu-item")); + } + + public WebElement getMenuButton() { + return driver.findElement(AppiumBy.accessibilityId("More-tab-item")); + } + + public void open() { + getMenuButton().click(); + } + + public void clickLoginButton() { + getLoginButton().click(); + } +}