commit d13ab52fc527d9c71a4e5feb94a337f995197631 Author: Burak Kaygusuz Date: Tue Jun 23 17:30:27 2020 +0300 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7b78331 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# Gradle metadata +.gradle/ +build +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar +wrapper/gradle-wrapper.jar + +# Gradle build output +build/ + +#Intellj Idea +.idea +bin +.DS_Store +target + +# VSCode +.vscode +.settings +.classpath +.project + +#Project +logs +.log diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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 + + http://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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..2164ccd --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Selenium Automation Architecture + +This demo that created as a template, demonstrates how to do the settings of the Chrome ve Firefox web driver for distributed parallel testing with Selenium 4 Grid using Kubernetes and Docker. + + +## Requirements + + - This project requires [Java 8 JDK](https://adoptopenjdk.net/). + - Install [Docker](https://www.docker.com/) for parallel testing. + - Install [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/), Kubernetes command-line tool. + - Install [Minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/) to run Kubernetes as locally. + - Specify any VM driver appropriate for your OS. Review the doc for driver list : [https://minikube.sigs.k8s.io/docs/drivers/](https://minikube.sigs.k8s.io/docs/drivers/) \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..5390050 --- /dev/null +++ b/build.gradle @@ -0,0 +1,46 @@ +plugins { + id 'java' +} + +version '1.0' + +sourceCompatibility = JavaVersion.VERSION_1_8 +targetCompatibility = JavaVersion.VERSION_1_8 + +description = "Selenium Automation Architecture" + +compileJava.options.encoding = 'UTF-8' + +repositories { + mavenCentral() +} + +dependencies { + + def selenium_version = '4.0.0-alpha-6' + def webDriver_manager_version = '4.0.0' + def junit_version = '5.6.2' + + implementation( + "org.seleniumhq.selenium:selenium-java:$selenium_version", + "org.seleniumhq.selenium:selenium-support:$selenium_version", + "org.seleniumhq.selenium:selenium-support:$selenium_version", + "org.seleniumhq.selenium:selenium-remote-driver:$selenium_version", + "io.github.bonigarcia:webdrivermanager:$webDriver_manager_version", + "org.apache.logging.log4j:log4j-core:2.13.3", + "org.apache.logging.log4j:log4j-api:2.13.3" + ) + + testImplementation( + "org.junit.jupiter:junit-jupiter-api:$junit_version" + ) + + testRuntimeOnly( + "org.junit.jupiter:junit-jupiter-engine:$junit_version" + ) +} + +test { + useJUnitPlatform() + testLogging.events("passed", "skipped", "failed") +} diff --git a/deploy.yml b/deploy.yml new file mode 100644 index 0000000..9d1fde9 --- /dev/null +++ b/deploy.yml @@ -0,0 +1,33 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: selenium-hub +spec: + selector: + matchLabels: + app: selenium-hub + strategy: + type: RollingUpdate + rollingUpdate: + maxSurge: 1 + maxUnavailable: 0 + template: + metadata: + labels: + app: selenium-hub + spec: + containers: + - name: selenium-hub + image: selenium/hub:4.0.0 + resources: + limits: + memory: "128Mi" + cpu: "500m" + ports: + - containerPort: 4444 + livenessProbe: + httpGet: + path: /wd/hub/status + port: 4444 + initialDelaySeconds: 30 + timeoutSeconds: 5 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..f3d88b1 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..43f6317 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-all.zip +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStorePath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..a9fb9f9 --- /dev/null +++ b/gradlew @@ -0,0 +1,183 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed 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. +# + +############################################################################## +## +## Gradle start up script for UNIX +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ]; do + ls=$(ls -ld "$PRG") + link=$(expr "$ls" : '.*-> \(.*\)$') + if expr "$link" : '/.*' >/dev/null; then + PRG="$link" + else + PRG=$(dirname "$PRG")"/$link" + fi +done +SAVED="$(pwd)" +cd "$(dirname \"$PRG\")/" >/dev/null +APP_HOME="$(pwd -P)" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=$(basename "$0") + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn() { + echo "$*" +} + +die() { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$(uname)" in +CYGWIN*) + cygwin=true + ;; +Darwin*) + darwin=true + ;; +MINGW*) + msys=true + ;; +NONSTOP*) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +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 + if [ ! -x "$JAVACMD" ]; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ]; then + MAX_FD_LIMIT=$(ulimit -H -n) + if [ $? -eq 0 ]; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ]; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ]; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ]; then + APP_HOME=$(cygpath --path --mixed "$APP_HOME") + CLASSPATH=$(cygpath --path --mixed "$CLASSPATH") + JAVACMD=$(cygpath --unix "$JAVACMD") + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=$(find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null) + SEP="" + for dir in $ROOTDIRSRAW; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ]; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@"; do + CHECK=$(echo "$arg" | egrep -c "$OURCYGPATTERN" -) + CHECK2=$(echo "$arg" | egrep -c "^-") ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ]; then ### Added a condition + eval $(echo args$i)=$(cygpath --path --ignore --mixed "$arg") + else + eval $(echo args$i)="\"$arg\"" + fi + i=$(expr $i + 1) + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save() { + for i; do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/"; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9618d8d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,100 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem 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, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/repchrome.yml b/repchrome.yml new file mode 100644 index 0000000..5b07539 --- /dev/null +++ b/repchrome.yml @@ -0,0 +1,24 @@ +apiVersion: v1 +kind: ReplicationController +metadata: + name: selenium-rep +spec: + replicas: 2 + selector: + app: selenium-chrome + template: + metadata: + name: selenium-chrome + labels: + app: selenium-chrome + spec: + containers: + - name: node-chrome + image: selenium/node-chrome:4.0.0 + ports: + - containerPort: 5555 + env: + - name: HUB_HOST + value: "selenium-srv" + - name: HUB_PORT + value: "4444" diff --git a/service.yml b/service.yml new file mode 100644 index 0000000..50a1022 --- /dev/null +++ b/service.yml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: Service +metadata: + name: selenium-srv + labels: + app: selenium-srv +spec: + selector: + app: selenium-hub + ports: + - port: 4444 + nodePort: 30001 + type: NodePort diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..02b6f87 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'Selenium Automation Architecture' + diff --git a/src/test/java/com/automation/BaseTest.java b/src/test/java/com/automation/BaseTest.java new file mode 100644 index 0000000..fa7f648 --- /dev/null +++ b/src/test/java/com/automation/BaseTest.java @@ -0,0 +1,64 @@ +package com.automation; + +import com.automation.config.DriverFactory; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.apache.logging.log4j.core.LoggerContext; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.openqa.selenium.remote.RemoteWebDriver; +import org.openqa.selenium.support.ui.WebDriverWait; + +import java.io.File; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +public class BaseTest { + + public static final List webDriverThreadPool = Collections.synchronizedList(new ArrayList<>()); + public static ThreadLocal driverFactoryThread; + + public static final Logger log = LogManager.getLogger(BaseTest.class); + private static final LoggerContext context = (LoggerContext) LogManager.getContext(false); + + public BaseTest() { + context.setConfigLocation(new File("src/test/resources/log4j2.properties").toURI()); // Log configuration + } + + @BeforeAll + public static void setUp() { + driverFactoryThread = ThreadLocal.withInitial(() -> { + DriverFactory driverFactory = new DriverFactory(); + webDriverThreadPool.add(driverFactory); + return driverFactory; + }); + + log.info("The web driver initialized"); + + getWebDriver().get("https://wikipedia.org/"); + + log.info("The web page opened"); + } + + public static RemoteWebDriver getWebDriver() { + return driverFactoryThread.get().getWebDriver(); + } + + public static RemoteWebDriver getStoredDriver() { + return driverFactoryThread.get().getStoredDriver(); + } + + public static WebDriverWait getDriverWait() { + return driverFactoryThread.get().getWebDriverWait(getStoredDriver(), 10, 0); + } + + @AfterAll + public static void tearDown() { + for (DriverFactory driverFactory : webDriverThreadPool) { + driverFactory.quitWebDriver(); + } + + log.info("The web driver closed"); + } +} diff --git a/src/test/java/com/automation/config/DriverFactory.java b/src/test/java/com/automation/config/DriverFactory.java new file mode 100644 index 0000000..b907fbe --- /dev/null +++ b/src/test/java/com/automation/config/DriverFactory.java @@ -0,0 +1,96 @@ +package com.automation.config; + +import io.github.bonigarcia.wdm.WebDriverManager; +import io.github.bonigarcia.wdm.config.DriverManagerType; +import io.github.bonigarcia.wdm.config.WebDriverManagerException; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import org.openqa.selenium.Platform; +import org.openqa.selenium.remote.DesiredCapabilities; +import org.openqa.selenium.remote.RemoteWebDriver; +import org.openqa.selenium.support.ui.WebDriverWait; + +import java.net.MalformedURLException; +import java.net.URL; +import java.time.Duration; + +public class DriverFactory { + + private static final Logger log = LogManager.getLogger(DriverFactory.class); + private static WebDriverWait wait; + private final DriverType selectedDriverType; + private RemoteWebDriver driver; + + private final boolean useRemoteWebDriver = Boolean.getBoolean("remoteDriver"); + + public DriverFactory() { + DriverType driverType = DriverType.CHROME; + String browser = System.getProperty("browser", driverType.toString()).toUpperCase(); + DriverManagerType driverManagerType = DriverManagerType.valueOf(browser.toUpperCase()); + + try { + driverType = DriverType.valueOf(browser); + WebDriverManager.getInstance(driverManagerType).setup(); + } catch (IllegalArgumentException | NullPointerException ignored) { + log.error(String.format("Unknown driver or no driver specified, defaulting to '%s'...", driverType)); + } catch (WebDriverManagerException e) { + log.error(String.format("Setup failed: %s", e.getMessage())); + } + + selectedDriverType = driverType; + } + + public RemoteWebDriver getStoredDriver() { + return driver; + } + + public RemoteWebDriver getWebDriver() { + if (driver == null) + instantiateWebDriver(selectedDriverType); + return driver; + } + + public WebDriverWait getWebDriverWait(RemoteWebDriver driver, int seconds, int milliSeconds) { + if (wait == null) + wait = new WebDriverWait(driver, Duration.ofSeconds(seconds), Duration.ofMillis(milliSeconds)); + return wait; + } + + public void quitWebDriver() { + if (driver != null) { + driver.quit(); + driver = null; + } + } + + private void instantiateWebDriver(DriverType driverType) { + DesiredCapabilities caps = new DesiredCapabilities(); + + log.info("Local Operating System : " + System.getProperty("os.name").toUpperCase().toUpperCase()); + log.info("Local Version : " + System.getProperty("os.arch")); + log.info("Local Architecture : " + System.getProperty("os.version")); + log.info("Browser : " + selectedDriverType.toString().toUpperCase()); + log.info("Connecting to Selenium Grid : " + useRemoteWebDriver); + + if (useRemoteWebDriver) { + String desiredBrowserVersion = System.getProperty("desiredBrowserVersion"); + String desiredPlatform = System.getProperty("desiredPlatform"); + + if (desiredPlatform != null && !desiredPlatform.isEmpty()) + caps.setPlatform(Platform.valueOf(desiredPlatform.toUpperCase())); + + if (desiredBrowserVersion != null && !desiredBrowserVersion.isEmpty()) + caps.setVersion(desiredBrowserVersion); + + caps.setBrowserName(selectedDriverType.toString()); + + try { + driver = new RemoteWebDriver(new URL("http://192.168.99.100:30001/wd/hub"), caps); + } catch (MalformedURLException e) { + log.error(String.format("An error occurred while the driver instantiates: %s", e.getMessage())); + } + } else { + driver = driverType.getDriverOptions(caps); + } + } +} diff --git a/src/test/java/com/automation/config/DriverOptions.java b/src/test/java/com/automation/config/DriverOptions.java new file mode 100644 index 0000000..4ad367a --- /dev/null +++ b/src/test/java/com/automation/config/DriverOptions.java @@ -0,0 +1,9 @@ +package com.automation.config; + +import org.openqa.selenium.remote.DesiredCapabilities; +import org.openqa.selenium.remote.RemoteWebDriver; + +public interface DriverOptions { + + RemoteWebDriver getDriverOptions(DesiredCapabilities capabilities); +} diff --git a/src/test/java/com/automation/config/DriverType.java b/src/test/java/com/automation/config/DriverType.java new file mode 100644 index 0000000..51ae0b8 --- /dev/null +++ b/src/test/java/com/automation/config/DriverType.java @@ -0,0 +1,69 @@ +package com.automation.config; + +import org.openqa.selenium.chrome.ChromeDriver; +import org.openqa.selenium.chrome.ChromeDriverService; +import org.openqa.selenium.chrome.ChromeOptions; +import org.openqa.selenium.firefox.FirefoxBinary; +import org.openqa.selenium.firefox.FirefoxDriver; +import org.openqa.selenium.firefox.FirefoxOptions; +import org.openqa.selenium.firefox.FirefoxProfile; +import org.openqa.selenium.remote.DesiredCapabilities; +import org.openqa.selenium.remote.RemoteWebDriver; + +import java.util.logging.Level; +import java.util.logging.Logger; + +public enum DriverType implements DriverOptions { + + CHROME { + @Override + public RemoteWebDriver getDriverOptions(DesiredCapabilities capabilities) { + System.setProperty(ChromeDriverService.CHROME_DRIVER_SILENT_OUTPUT_PROPERTY, "true"); + Logger.getLogger("org.openqa.selenium").setLevel(Level.SEVERE); //To get rid of chrome driver logs + + final ChromeOptions options = new ChromeOptions(); + options.merge(capabilities); + + options.addArguments("test-type"); + options.addArguments("disable-popup-blocking"); + options.addArguments("ignore-certificate-errors"); + options.addArguments("disable-translate"); + options.addArguments("--start-maximized"); + options.addArguments("--no-sandbox"); + options.addArguments("--enable-automation"); + options.addArguments("--headless"); //Headless mode + + return new ChromeDriver(options); + } + }, + + FIREFOX { + @Override + public RemoteWebDriver getDriverOptions(DesiredCapabilities capabilities) { + System.setProperty(FirefoxDriver.SystemProperty.DRIVER_USE_MARIONETTE, "true"); + System.setProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE, "/dev/null"); + Logger.getLogger("org.openqa.selenium").setLevel(Level.SEVERE); //To get rid of firefox driver logs + + final FirefoxBinary firefoxBinary = new FirefoxBinary(); + final FirefoxOptions options = new FirefoxOptions(); + final FirefoxProfile profile = new FirefoxProfile(); + + profile.setAcceptUntrustedCertificates(true); + profile.setAssumeUntrustedCertificateIssuer(false); + profile.setPreference("network.proxy.type", 0); //No proxy + profile.setPreference("dom.webnotifications.enabled", false); //Disable pop-up + + firefoxBinary.addCommandLineOptions("--headless"); //Headless mode + + options.setBinary(firefoxBinary); + options.setCapability(FirefoxDriver.Capability.PROFILE, profile); + + return new FirefoxDriver(options); + } + }; + + @Override + public String toString() { + return super.toString().toLowerCase(); + } +} diff --git a/src/test/java/com/automation/pages/HomePage.java b/src/test/java/com/automation/pages/HomePage.java new file mode 100644 index 0000000..fb84049 --- /dev/null +++ b/src/test/java/com/automation/pages/HomePage.java @@ -0,0 +1,63 @@ +package com.automation.pages; + +import org.junit.jupiter.api.Assertions; +import org.openqa.selenium.WebElement; +import org.openqa.selenium.remote.RemoteWebDriver; +import org.openqa.selenium.support.FindBy; +import org.openqa.selenium.support.PageFactory; +import org.openqa.selenium.support.ui.LoadableComponent; +import org.openqa.selenium.support.ui.Select; + +import static com.automation.BaseTest.getStoredDriver; + +public class HomePage extends LoadableComponent { + + private static final RemoteWebDriver driver = getStoredDriver(); + private static final String BASE_URL = "https://wikipedia.org"; + + @FindBy(id = "searchInput") + private WebElement searchInput; + + @FindBy(xpath= "//button[@class='pure-button pure-button-primary-progressive']") + private WebElement searchButton; + + @FindBy(id = "searchLanguage") + private WebElement selectLanguage; + + private HomePage() { + PageFactory.initElements(driver, this); + } + + public static HomePage getHomePage() { + return new HomePage(); + } + + @Override + protected void load() { + driver.get(BASE_URL); + } + + @Override + protected void isLoaded() throws Error { + Assertions.assertTrue(driver.getCurrentUrl().contains(BASE_URL), "Wiki page is not loaded"); + } + + public HomePage selectLanguage(String language) { + Select dropdownList = new Select(selectLanguage); + dropdownList.selectByVisibleText(language); + return this; + } + + public HomePage clearAndType(String input) { + searchInput.clear(); + searchInput.sendKeys(input); + return this; + } + + public HomePage submitButton(){ + searchButton.click(); + return this; + } + + +} diff --git a/src/test/java/com/automation/pages/SeleniumPage.java b/src/test/java/com/automation/pages/SeleniumPage.java new file mode 100644 index 0000000..4803c91 --- /dev/null +++ b/src/test/java/com/automation/pages/SeleniumPage.java @@ -0,0 +1,49 @@ +package com.automation.pages; + +import org.junit.jupiter.api.Assertions; +import org.openqa.selenium.WebElement; +import org.openqa.selenium.remote.RemoteWebDriver; +import org.openqa.selenium.support.FindBy; +import org.openqa.selenium.support.PageFactory; +import org.openqa.selenium.support.ui.LoadableComponent; + +import static com.automation.BaseTest.getStoredDriver; + +public class SeleniumPage extends LoadableComponent { + + private static final String searchInput = "Selenium_(software)"; + private LoadableComponent parent; + private static final RemoteWebDriver driver = getStoredDriver(); + + @FindBy(xpath = "//div[@class='hatnote navigation-not-searchable']") + private WebElement definition; + + public SeleniumPage(LoadableComponent parent) { + this.parent = parent; + } + + private SeleniumPage() { + PageFactory.initElements(driver, this); + } + + public static SeleniumPage getSeleniumPage() { + return new SeleniumPage(); + } + + @Override + protected void load() { + parent.get() + .selectLanguage("English") + .clearAndType(searchInput) + .submitButton(); + } + + @Override + protected void isLoaded() throws Error { + Assertions.assertTrue(driver.getCurrentUrl().endsWith(searchInput), "Selenium page is not loaded"); + } + + public String getDefinitionText(){ + return definition.getText(); + } +} diff --git a/src/test/java/com/automation/tests/SeleniumPageTests.java b/src/test/java/com/automation/tests/SeleniumPageTests.java new file mode 100644 index 0000000..025b85e --- /dev/null +++ b/src/test/java/com/automation/tests/SeleniumPageTests.java @@ -0,0 +1,31 @@ +package com.automation.tests; + +import com.automation.BaseTest; +import com.automation.pages.HomePage; +import com.automation.pages.SeleniumPage; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static com.automation.pages.HomePage.getHomePage; +import static com.automation.pages.SeleniumPage.getSeleniumPage; +import static org.junit.jupiter.api.Assertions.*; + +@DisplayName("Selenium Page Tests") +public class SeleniumPageTests extends BaseTest { + + private final HomePage homePage = getHomePage(); + private final SeleniumPage wikiPage = getSeleniumPage(); + + @Test + @DisplayName("Get the wiki page of Selenium") + public void getSeleniumWikiPage() { + + homePage.selectLanguage("English") + .clearAndType("Selenium (software)") + .submitButton(); + + assertAll("Selenium wiki page should open as successfully", + () -> assertEquals("Selenium (software) - Wikipedia", getStoredDriver().getTitle()), + () -> assertTrue(wikiPage.getDefinitionText().startsWith("This article is about the software testing framework"))); + } +} diff --git a/src/test/resources/log4j2.properties b/src/test/resources/log4j2.properties new file mode 100644 index 0000000..f14196f --- /dev/null +++ b/src/test/resources/log4j2.properties @@ -0,0 +1,23 @@ +status=error + +name=Selenium Automation Architecture + +filters=threshold +filter.threshold.type=ThresholdFilter +filter.threshold.level=info + +appenders=console, file +appender.console.type=Console +appender.console.name=STDOUT +appender.console.layout.type=PatternLayout +appender.console.layout.pattern=%d{dd-MM-yyyy HH:mm:ss} | %-5p | %c{1} | %m%n + +appender.file.type=File +appender.file.name=LOGFILE +appender.file.fileName=logs/app.log +appender.file.layout.type=PatternLayout +appender.file.layout.pattern=[%-5level] | %d{dd-MM-yyyy HH:mm:ss} | [%t] | %c{1} | %msg%n + +rootLogger.level=debug +rootLogger.appenderRefs=stdout +rootLogger.appenderRef.stdout.ref=STDOUT \ No newline at end of file