├── .gitignore ├── LICENSE ├── NOTICE ├── README.md ├── changelog.txt ├── pom.xml └── src └── main └── resources ├── META-INF └── maven │ └── archetype-metadata.xml └── archetype-resources ├── pom.xml └── src ├── main ├── java │ ├── pages │ │ ├── HomePage.java │ │ └── Page.java │ ├── util │ │ ├── Browser.java │ │ └── PropertyLoader.java │ └── webdriver │ │ ├── AuthenticatedHtmlUnitDriver.java │ │ └── WebDriverFactory.java └── resources │ ├── application.properties │ ├── drivers │ └── chrome │ │ └── README.txt │ └── grid2 │ └── README.txt └── test ├── java └── pages │ ├── HomePageTest.java │ └── TestBase.java └── resources └── testng.xml /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /.project 3 | /.settings 4 | /.classpath -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Selenium2 Java QuickStart Archetype 2 | Copyright 2011 sebarmeli 3 | 4 | This product includes software developed by 5 | Sebastiano Armeli-Battana 6 | Licensed under the Apache License 2.0. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Introduction 2 | ============ 3 | 4 | This archetype generates a small Maven project with Selenium 2 and TestNG embedded to make it easy to get started testing with Selenium Web Driver. 5 | 6 | This project provides just a starting point to get up to speed with Selenium 2 infrastructure. 7 | 8 | To install the archetype in your local repo: 9 | 10 | git clone https://github.com/sebarmeli/Selenium2-Java-QuickStart-Archetype.git 11 | cd Selenium2-Java-QuickStart-Archetype 12 | mvn install 13 | 14 | Now, you can use the archetype in a new project typing: 15 | 16 | mvn archetype:generate -DarchetypeGroupId=com.sebarmeli -DarchetypeArtifactId=selenium2-java-quickstart-archetype -DarchetypeVersion=0.3 -DgroupId= -DartifactId= 17 | 18 | where *mygroupId* : group id of the project you are creating; *myartifactId* : artifact id of the project you are creating 19 | 20 | It uses Java bindings for Selenium version 2.47.2 and TestNG version 6.9.6. OperaDriver 1.5, Appium's ios-driver 3.2.0 and Selendroid 0.16.0 are also included for convenience. 21 | 22 | Project Structure 23 | ----------------------------------- 24 | 25 | The project follows the standard Maven structure, so all the tests go in the *src/test/java* folder. Tests should inherit from the **TestBase** class. In this class a factory method 26 | from **WebDriverFactory** class is in charge of generating the instance of the WebDriver interface you need. Different parameters are passed into the factory: 27 | 28 | * base URL : base URL of the AUT (application under test) 29 | * Grid 2 hub URL : URL of the hub (if using Grid 2) 30 | * browser fatures: a) name b) version c) platform 31 | * username / password : in case of BASIC authenticated site 32 | 33 | Those parameters are retrieved from the *src/main/resources/application.properties* file. You can also populate the properties file from command line (through -D:@ondemand.saucelabs.com:80/wd/hub* 71 | 72 | Further Notes 73 | ------- 74 | The project is just a starting point, feel free to modify it according to your needs. 75 | 76 | Credits 77 | ------- 78 | The selenium2-java-quickstart-archetype project is an open source project licensed under the Apache License 2.0. 79 | -------------------------------------------------------------------------------- /changelog.txt: -------------------------------------------------------------------------------- 1 | Version 0.2 2 | ------------- 3 | * Upgrade to Archetype Plugin version 2 4 | * Mobile testing supported 5 | 6 | Version 0.1 7 | ------------- 8 | * Initial release -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 8 | 10 | 4.0.0 11 | com.sebarmeli 12 | selenium2-java-quickstart-archetype 13 | 0.3 14 | Selenium2 Java QuickStart Archetype 15 | Generates a QuickStart project with Selenium 2 and TestNG 16 | 17 | 2.4 18 | 19 | 20 | 21 | The Apache Software License, Version 2.0 22 | http://www.apache.org/licenses/LICENSE-2.0.txt 23 | 24 | 25 | 26 | 27 | 28 | org.apache.maven.archetype 29 | archetype-packaging 30 | ${archetype.version} 31 | 32 | 33 | 34 | 35 | 36 | maven-archetype-plugin 37 | ${archetype.version} 38 | true 39 | 40 | 41 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/maven/archetype-metadata.xml: -------------------------------------------------------------------------------- 1 | 8 | 9 | 10 | 11 | src/main/java 12 | 13 | **/* 14 | 15 | 16 | 17 | src/test/java 18 | 19 | **/* 20 | 21 | 22 | 23 | src/main/resources 24 | 25 | **/* 26 | 27 | 28 | 29 | src/test/resources 30 | 31 | **/* 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/pom.xml: -------------------------------------------------------------------------------- 1 | 3 | 4.0.0 4 | ${groupId} 5 | ${artifactId} 6 | ${version} 7 | jar 8 | 9 | 10 | 11 | commons-io 12 | commons-io 13 | 2.4 14 | 15 | 16 | org.apache.commons 17 | commons-exec 18 | 1.3 19 | 20 | 21 | org.apache.httpcomponents 22 | httpclient 23 | 4.5.1 24 | 25 | 26 | org.testng 27 | testng 28 | 6.9.6 29 | 30 | 31 | org.seleniumhq.selenium 32 | selenium-java 33 | 2.48.2 34 | 35 | 36 | io.selendroid 37 | 0.16.0 38 | selendroid-standalone 39 | 40 | 41 | io.selendroid 42 | 0.16.0 43 | selendroid-client 44 | 45 | 46 | io.appium 47 | java-client 48 | 3.2.0 49 | 50 | 51 | com.opera 52 | operadriver 53 | 1.5 54 | 55 | 56 | 57 | 58 | 59 | src/main/resources 60 | true 61 | 62 | 63 | 64 | 65 | org.apache.maven.plugins 66 | maven-resources-plugin 67 | 2.7 68 | 69 | UTF-8 70 | 71 | 72 | 73 | maven-surefire-plugin 74 | 2.18.1 75 | 76 | 77 | src/test/resources/testng.xml 78 | 79 | 80 | 81 | 82 | maven-compiler-plugin 83 | 3.3 84 | 85 | 1.8 86 | 1.8 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | local 95 | 96 | local 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | true 107 | 108 | 109 | 110 | dev 111 | 112 | dev 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | test 124 | 125 | test 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | prod 137 | 138 | prod 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | force-local-driver 150 | 151 | 152 | 153 | 154 | 155 | 156 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/java/pages/HomePage.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.pages; 5 | 6 | import org.openqa.selenium.WebDriver; 7 | import org.openqa.selenium.WebElement; 8 | import org.openqa.selenium.support.CacheLookup; 9 | import org.openqa.selenium.support.FindBy; 10 | import org.openqa.selenium.support.How; 11 | 12 | /* 13 | * Sample page 14 | * 15 | * @author Sebastiano Armeli-Battana 16 | */ 17 | public class HomePage extends Page { 18 | 19 | private final String H1_TAG = "h1"; 20 | 21 | @FindBy(how = How.TAG_NAME, using = H1_TAG) 22 | @CacheLookup 23 | private WebElement h1Element; 24 | 25 | public HomePage(WebDriver webDriver) { 26 | super(webDriver); 27 | } 28 | 29 | public String getH1() { 30 | return h1Element.getText(); 31 | } 32 | 33 | } 34 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/java/pages/Page.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.pages; 5 | 6 | import org.openqa.selenium.WebDriver; 7 | 8 | /* 9 | * Abstract class representation of a Page in the UI. Page object pattern 10 | * 11 | * @author Sebastiano Armeli-Battana 12 | */ 13 | public abstract class Page { 14 | 15 | protected WebDriver webDriver; 16 | 17 | /* 18 | * Constructor injecting the WebDriver interface 19 | * 20 | * @param webDriver 21 | */ 22 | public Page(WebDriver webDriver) { 23 | this.webDriver = webDriver; 24 | } 25 | 26 | public WebDriver getWebDriver() { 27 | return webDriver; 28 | } 29 | 30 | public String getTitle() { 31 | return webDriver.getTitle(); 32 | } 33 | 34 | } 35 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/java/util/Browser.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.util; 5 | 6 | /* 7 | * Bean representing a browser. It contains name, version and platform fields. 8 | * 9 | * @author Sebastiano Armeli-Battana 10 | */ 11 | public class Browser { 12 | 13 | private String name; 14 | private String version; 15 | private String platform; 16 | 17 | public String getName() { 18 | return name; 19 | } 20 | 21 | public void setName(String name) { 22 | this.name = name; 23 | } 24 | 25 | public String getVersion() { 26 | return version; 27 | } 28 | 29 | public void setVersion(String version) { 30 | this.version = version; 31 | } 32 | 33 | public String getPlatform() { 34 | return platform; 35 | } 36 | 37 | public void setPlatform(String platform) { 38 | this.platform = platform; 39 | } 40 | 41 | } -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/java/util/PropertyLoader.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.util; 5 | 6 | import java.io.IOException; 7 | import java.util.Properties; 8 | 9 | /* 10 | * Class that extracts properties from the prop file. 11 | * 12 | * @author Sebastiano Armeli-Battana 13 | */ 14 | public class PropertyLoader { 15 | 16 | private static final String PROP_FILE = "/application.properties"; 17 | 18 | private PropertyLoader() {} 19 | 20 | public static String loadProperty(String name) { 21 | Properties props = new Properties(); 22 | try { 23 | props.load(PropertyLoader.class.getResourceAsStream(PROP_FILE)); 24 | } catch (IOException e) { 25 | e.printStackTrace(); 26 | } 27 | 28 | String value = ""; 29 | 30 | if (name != null) { 31 | value = props.getProperty(name); 32 | } 33 | return value; 34 | } 35 | } -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/java/webdriver/AuthenticatedHtmlUnitDriver.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.webdriver; 5 | 6 | import org.openqa.selenium.WebDriver; 7 | import org.openqa.selenium.htmlunit.HtmlUnitDriver; 8 | 9 | import com.gargoylesoftware.htmlunit.BrowserVersion; 10 | import com.gargoylesoftware.htmlunit.DefaultCredentialsProvider; 11 | import com.gargoylesoftware.htmlunit.WebClient; 12 | 13 | /* 14 | * Class extending HtmlUnitDriver to support BASIC authentication 15 | * 16 | * @author Sebastiano Armeli-Battana 17 | */ 18 | public class AuthenticatedHtmlUnitDriver extends HtmlUnitDriver { 19 | private static String USERNAME; 20 | private static String PASSWORD; 21 | 22 | private AuthenticatedHtmlUnitDriver() { 23 | } 24 | 25 | public static WebDriver create(String username, String password) { 26 | USERNAME = username; 27 | PASSWORD = password; 28 | return new AuthenticatedHtmlUnitDriver(); 29 | } 30 | 31 | @Override 32 | protected WebClient newWebClient(BrowserVersion browserVersion) { 33 | WebClient client = super.newWebClient(browserVersion); 34 | DefaultCredentialsProvider provider = new DefaultCredentialsProvider(); 35 | provider.addCredentials(USERNAME, PASSWORD); 36 | client.setCredentialsProvider(provider); 37 | return client; 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/java/webdriver/WebDriverFactory.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.webdriver; 5 | 6 | import java.net.MalformedURLException; 7 | import java.net.URL; 8 | 9 | import org.openqa.selenium.Platform; 10 | import org.openqa.selenium.WebDriver; 11 | import org.openqa.selenium.chrome.ChromeDriver; 12 | import org.openqa.selenium.firefox.FirefoxDriver; 13 | import org.openqa.selenium.firefox.FirefoxProfile; 14 | import org.openqa.selenium.htmlunit.HtmlUnitDriver; 15 | import org.openqa.selenium.ie.InternetExplorerDriver; 16 | import org.openqa.selenium.remote.CapabilityType; 17 | import org.openqa.selenium.remote.DesiredCapabilities; 18 | import org.openqa.selenium.remote.RemoteWebDriver; 19 | import org.openqa.selenium.safari.SafariDriver; 20 | 21 | import com.opera.core.systems.OperaDriver; 22 | import ${groupId}.util.Browser; 23 | import ${groupId}.webdriver.AuthenticatedHtmlUnitDriver; 24 | 25 | /* 26 | * Factory to instantiate a WebDriver object. It returns an instance of the driver (local invocation) or an instance of RemoteWebDriver 27 | * 28 | * @author Sebastiano Armeli-Battana 29 | */ 30 | public class WebDriverFactory { 31 | 32 | /* Browsers constants */ 33 | public static final String CHROME = "chrome"; 34 | public static final String FIREFOX = "firefox"; 35 | public static final String OPERA = "opera"; 36 | public static final String INTERNET_EXPLORER = "ie"; 37 | public static final String SAFARI = "safari"; 38 | public static final String HTML_UNIT = "htmlunit"; 39 | public static final String IPHONE = "iphone"; 40 | 41 | /* Platform constants */ 42 | public static final String WINDOWS = "windows"; 43 | public static final String ANDROID = "android"; 44 | public static final String XP = "xp"; 45 | public static final String VISTA = "vista"; 46 | public static final String MAC = "mac"; 47 | public static final String LINUX = "linux"; 48 | 49 | private WebDriverFactory(){} 50 | 51 | /* 52 | * Factory method to return a RemoteWebDriver instance given the url of the 53 | * Grid hub and a Browser instance. 54 | * 55 | * @param gridHubUrl : grid hub URI 56 | * 57 | * @param browser : Browser object containing info around the browser to hit 58 | * 59 | * @param username : username for BASIC authentication on the page to test 60 | * 61 | * @param password : password for BASIC authentication on the page to test 62 | * 63 | * @return RemoteWebDriver 64 | */ 65 | public static WebDriver getInstance(String gridHubUrl, Browser browser, 66 | String username, String password) { 67 | 68 | WebDriver webDriver = null; 69 | 70 | DesiredCapabilities capability = new DesiredCapabilities(); 71 | String browserName = browser.getName(); 72 | capability.setJavascriptEnabled(true); 73 | 74 | // In case there is no Hub 75 | if (gridHubUrl == null || gridHubUrl.length() == 0) { 76 | return getInstance(browserName, username, password); 77 | } 78 | 79 | if (CHROME.equals(browserName)) { 80 | capability = DesiredCapabilities.chrome(); 81 | } else if (FIREFOX.equals(browserName)) { 82 | capability = DesiredCapabilities.firefox(); 83 | 84 | FirefoxProfile ffProfile = new FirefoxProfile(); 85 | 86 | // Authenication Hack for Firefox 87 | if (username != null && password != null) { 88 | ffProfile.setPreference("network.http.phishy-userpass-length", 89 | 255); 90 | capability.setCapability(FirefoxDriver.PROFILE, ffProfile); 91 | } 92 | 93 | capability.setCapability(CapabilityType.TAKES_SCREENSHOT, true); 94 | } else if (INTERNET_EXPLORER.equals(browserName)) { 95 | 96 | capability = DesiredCapabilities.internetExplorer(); 97 | capability 98 | .setCapability( 99 | InternetExplorerDriver.INTRODUCE_FLAKINESS_BY_IGNORING_SECURITY_DOMAINS, 100 | true); 101 | } else if (OPERA.equals(browserName)) { 102 | capability = DesiredCapabilities.operaBlink(); 103 | } else if (SAFARI.equals(browserName)) { 104 | capability = DesiredCapabilities.safari(); 105 | } else if (ANDROID.equals(browserName)) { 106 | capability = DesiredCapabilities.android(); 107 | } else if (IPHONE.equals(browserName)) { 108 | capability = DesiredCapabilities.iphone(); 109 | } else { 110 | 111 | capability = DesiredCapabilities.htmlUnit(); 112 | // HTMLunit Check 113 | if (username != null && password != null) { 114 | webDriver = (HtmlUnitDriver) AuthenticatedHtmlUnitDriver 115 | .create(username, password); 116 | } else { 117 | webDriver = new HtmlUnitDriver(true); 118 | } 119 | 120 | return webDriver; 121 | } 122 | 123 | capability = setVersionAndPlatform(capability, browser.getVersion(), 124 | browser.getPlatform()); 125 | 126 | // Create Remote WebDriver 127 | try { 128 | webDriver = new RemoteWebDriver(new URL(gridHubUrl), capability); 129 | } catch (MalformedURLException e) { 130 | e.printStackTrace(); 131 | } 132 | 133 | return webDriver; 134 | } 135 | 136 | /* 137 | * Factory method to return a WebDriver instance given the browser to hit 138 | * 139 | * @param browser : String representing the local browser to hit 140 | * 141 | * @param username : username for BASIC authentication on the page to test 142 | * 143 | * @param password : password for BASIC authentication on the page to test 144 | * 145 | * @return WebDriver instance 146 | */ 147 | public static WebDriver getInstance(String browser, String username, 148 | String password) { 149 | 150 | WebDriver webDriver = null; 151 | 152 | if (CHROME.equals(browser)) { 153 | setChromeDriver(); 154 | 155 | webDriver = new ChromeDriver(); 156 | } else if (FIREFOX.equals(browser)) { 157 | 158 | FirefoxProfile ffProfile = new FirefoxProfile(); 159 | 160 | // Authenication Hack for Firefox 161 | if (username != null && password != null) { 162 | ffProfile.setPreference("network.http.phishy-userpass-length", 163 | 255); 164 | } 165 | 166 | webDriver = new FirefoxDriver(ffProfile); 167 | 168 | } else if (INTERNET_EXPLORER.equals(browser)) { 169 | isSupportedPlatform(browser); 170 | webDriver = new InternetExplorerDriver(); 171 | 172 | } else if (OPERA.equals(browser)) { 173 | webDriver = new OperaDriver(); 174 | 175 | } else if (SAFARI.equals(browser)) { 176 | isSupportedPlatform(browser); 177 | webDriver = new SafariDriver(); 178 | 179 | } else if (IPHONE.equals(browser)) { 180 | webDriver = new RemoteWebDriver(DesiredCapabilities.iphone()); 181 | 182 | } else if (ANDROID.equals(browser)) { 183 | webDriver = new RemoteWebDriver(DesiredCapabilities.android()); 184 | 185 | } else { 186 | 187 | // HTMLunit Check 188 | if (username != null && password != null) { 189 | webDriver = (HtmlUnitDriver) AuthenticatedHtmlUnitDriver 190 | .create(username, password); 191 | } else { 192 | webDriver = new HtmlUnitDriver(true); 193 | } 194 | } 195 | 196 | return webDriver; 197 | } 198 | 199 | /* 200 | * Helper method to set version and platform for a specific browser 201 | * 202 | * @param capability : DesiredCapabilities object coming from the selected 203 | * browser 204 | * 205 | * @param version : browser version 206 | * 207 | * @param platform : browser platform 208 | * 209 | * @return DesiredCapabilities 210 | */ 211 | private static DesiredCapabilities setVersionAndPlatform( 212 | DesiredCapabilities capability, String version, String platform) { 213 | if (MAC.equalsIgnoreCase(platform)) { 214 | capability.setPlatform(Platform.MAC); 215 | } else if (LINUX.equalsIgnoreCase(platform)) { 216 | capability.setPlatform(Platform.LINUX); 217 | } else if (XP.equalsIgnoreCase(platform)) { 218 | capability.setPlatform(Platform.XP); 219 | } else if (VISTA.equalsIgnoreCase(platform)) { 220 | capability.setPlatform(Platform.VISTA); 221 | } else if (WINDOWS.equalsIgnoreCase(platform)) { 222 | capability.setPlatform(Platform.WINDOWS); 223 | } else if (ANDROID.equalsIgnoreCase(platform)) { 224 | capability.setPlatform(Platform.ANDROID); 225 | } else { 226 | capability.setPlatform(Platform.ANY); 227 | } 228 | 229 | if (version != null) { 230 | capability.setVersion(version); 231 | } 232 | return capability; 233 | } 234 | 235 | /* 236 | * Helper method to set ChromeDriver location into the right ststem property 237 | */ 238 | private static void setChromeDriver() { 239 | String os = System.getProperty("os.name").toLowerCase().substring(0, 3); 240 | String chromeBinary = "src/main/resources/drivers/chrome/chromedriver" 241 | + (os.equals("win") ? ".exe" : ""); 242 | System.setProperty("webdriver.chrome.driver", chromeBinary); 243 | } 244 | 245 | private static void isSupportedPlatform(String browser) { 246 | boolean is_supported = true; 247 | Platform current = Platform.getCurrent(); 248 | if (INTERNET_EXPLORER.equals(browser)) { 249 | is_supported = Platform.WINDOWS.is(current); 250 | } else if (SAFARI.equals(browser)) { 251 | is_supported = Platform.MAC.is(current) || Platform.WINDOWS.is(current); 252 | } 253 | assert is_supported : "Platform is not supported by " + browser.toUpperCase() + " browser"; 254 | } 255 | } 256 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | user.username=${symbol_dollar}{user.username} 5 | user.password=${symbol_dollar}{user.password} 6 | 7 | grid2.hub=${symbol_dollar}{grid2.hub} 8 | 9 | site.url=${symbol_dollar}{site.url} 10 | 11 | browser.name=${symbol_dollar}{browser.name} 12 | browser.version=${symbol_dollar}{browser.version} 13 | browser.platform=${symbol_dollar}{browser.platform} 14 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/resources/drivers/chrome/README.txt: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | Place in this folder the chrome driver for your OS (chromedriver.exe for Win or chromedriver for Mac or Linux) if you need it. -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/main/resources/grid2/README.txt: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | Place in this folder the selenium-server-standalone jar to use for the Grid 2, if you need. -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/test/java/pages/HomePageTest.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.pages; 5 | 6 | import org.openqa.selenium.support.PageFactory; 7 | import org.testng.Assert; 8 | import org.testng.annotations.BeforeClass; 9 | import org.testng.annotations.Parameters; 10 | import org.testng.annotations.Test; 11 | 12 | public class HomePageTest extends TestBase { 13 | 14 | HomePage homepage; 15 | 16 | @Parameters({ "path" }) 17 | @BeforeClass 18 | public void testInit(String path) { 19 | 20 | // Load the page in the browser 21 | webDriver.get(websiteUrl + path); 22 | homepage = PageFactory.initElements(webDriver, HomePage.class); 23 | } 24 | 25 | @Test 26 | public void testH1Existing() throws InterruptedException { 27 | Assert.assertTrue(homepage.getH1() != null); 28 | } 29 | 30 | @Test 31 | public void test2() throws InterruptedException { 32 | Assert.assertTrue(true); 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/test/java/pages/TestBase.java: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | package ${groupId}.pages; 5 | 6 | import java.io.File; 7 | import java.io.IOException; 8 | import java.util.concurrent.TimeUnit; 9 | 10 | import org.apache.commons.io.FileUtils; 11 | import org.openqa.selenium.OutputType; 12 | import org.openqa.selenium.TakesScreenshot; 13 | import org.openqa.selenium.WebDriver; 14 | import org.openqa.selenium.remote.Augmenter; 15 | import org.openqa.selenium.remote.ScreenshotException; 16 | import org.testng.ITestResult; 17 | import org.testng.annotations.AfterMethod; 18 | import org.testng.annotations.AfterSuite; 19 | import org.testng.annotations.BeforeClass; 20 | 21 | import ${groupId}.util.PropertyLoader; 22 | import ${groupId}.util.Browser; 23 | import ${groupId}.webdriver.WebDriverFactory; 24 | 25 | /* 26 | * Base class for all the test classes 27 | * 28 | * @author Sebastiano Armeli-Battana 29 | */ 30 | 31 | public class TestBase { 32 | private static final String SCREENSHOT_FOLDER = "target/screenshots/"; 33 | private static final String SCREENSHOT_FORMAT = ".png"; 34 | 35 | protected WebDriver webDriver; 36 | 37 | protected String gridHubUrl; 38 | 39 | protected String websiteUrl; 40 | 41 | protected Browser browser; 42 | 43 | @BeforeClass 44 | public void init() { 45 | websiteUrl = PropertyLoader.loadProperty("site.url"); 46 | gridHubUrl = PropertyLoader.loadProperty("grid2.hub"); 47 | 48 | browser = new Browser(); 49 | browser.setName(PropertyLoader.loadProperty("browser.name")); 50 | browser.setVersion(PropertyLoader.loadProperty("browser.version")); 51 | browser.setPlatform(PropertyLoader.loadProperty("browser.platform")); 52 | 53 | String username = PropertyLoader.loadProperty("user.username"); 54 | String password = PropertyLoader.loadProperty("user.password"); 55 | 56 | webDriver = WebDriverFactory.getInstance(gridHubUrl, browser, username, 57 | password); 58 | webDriver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS); 59 | } 60 | 61 | @AfterSuite(alwaysRun = true) 62 | public void tearDown() { 63 | if (webDriver != null) { 64 | webDriver.quit(); 65 | } 66 | } 67 | 68 | @AfterMethod 69 | public void setScreenshot(ITestResult result) { 70 | if (!result.isSuccess()) { 71 | try { 72 | WebDriver returned = new Augmenter().augment(webDriver); 73 | if (returned != null) { 74 | File f = ((TakesScreenshot) returned).getScreenshotAs(OutputType.FILE); 75 | try { 76 | FileUtils.copyFile(f, 77 | new File(SCREENSHOT_FOLDER + result.getName() + SCREENSHOT_FORMAT)); 78 | } catch (IOException e) { 79 | e.printStackTrace(); 80 | } 81 | } 82 | } catch (ScreenshotException se) { 83 | se.printStackTrace(); 84 | } 85 | } 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /src/main/resources/archetype-resources/src/test/resources/testng.xml: -------------------------------------------------------------------------------- 1 | #set( $symbol_pound = '#' ) 2 | #set( $symbol_dollar = '$' ) 3 | #set( $symbol_escape = '\' ) 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | --------------------------------------------------------------------------------