Merge branch 'master' of github.com:digital-delivery-academy/selenium-pom-framework

Author: travis-ci

README.md

@@ -5,7 +5,9 @@
 [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-This toolkit is really a culmination in 10 years of working with teams building automated UI checks with Selenium.  We've found time and again that we refactor or rewrite "frameworks" that wrap the entirity of the Selenium API (to little benefit).  On top of this, we see so much brittle code that we wanted to put something out there that people could use and benefit from our experience.  As a result, this toolkit provides an simple, lightweight (and well structured) way to launch, control and configure tests for Selenium/WebDriver in Java.  It's a curation of all of the little libraries and fixes we've used over the years.  So if you're at the start of your automation journey or you're just bored of writing the same "framework" over and over again, you're in the right place.
+**We've released version 1.0.0!**
+
+This toolkit is really a culmination of 10 years of working with teams building automated UI checks with Selenium.  We've found time and again that we refactor or rewrite "frameworks" that wrap the entirity of the Selenium API (to little benefit).  On top of this, we see so much brittle code that we wanted to put something out there that people could use and benefit from our experience.  As a result, this toolkit provides an simple, lightweight (and well structured) way to launch, control and configure checks for Selenium/WebDriver in Java.  It's a curation of all of the little libraries and fixes we've used over the years.  So if you're at the start of your automation journey or you're just bored of writing the same "framework" over and over again, you're in the right place.
 
 You'll find no junk (hopefully) here, but it's a fairly opinionated approach:
 - There's no mass "wrapper" on Selenium - that's dumb
@@ -15,36 +17,38 @@ You'll find no junk (hopefully) here, but it's a fairly opinionated approach:
 - We provide random test data generators from Mockneat (https://github.com/nomemory/mockneat) and UK Gov (https://github.com/dwp/nino-format-validation) as well as some of our own (for dates and stuff)
 - There's an externalised (and overridable) configuration system, based on JSON
 - We handle providing JUnit (we use version 5), Selenium and Hamcrest (for writing good assertions)
+- Our framework is unit and integration checked as well as monitored for code quality; we treat this as a production code base, not a second class citizen.
+- We have a (developing) open roadmap in GitHub Issues (click the Issues tab to see what we have so far)
 
 Coming soon:
-- SauceLabs and BrowserStack configuration.
-- Published artefacts to Maven Central (so you can get the framework without a GitHub membership).
-- Tutorials for writing tests using our toolkit.
-- Builds for Java 13 and older versions of Java.
+- SauceLabs and BrowserStack configuration (issues #2 and #3).
+- Instrumentation of the framework components to help visualise slow or under performing checks over time (issue #44).
+- Published artefacts to Maven Central (so you can get the framework without a GitHub membership) (issue #27).
+- Expand documentation and tutorials (issue #45)
 - And lots more marked in the issues list: https://github.com/digital-delivery-academy/selenium-pom-framework/issues
 
-It really is a one stop shop for getting up and running with a robust toolkit for building Selenium tests, without the massive investment that many business make in hand rolling their own.
+It really is a one stop shop for getting up and running with a robust toolkit for building Selenium checks, without the massive investment that many business make in hand rolling their own.
 
-All of our code is unit or integration tested.
+All of our code is unit or integration checked.
 
 It's highly unlikely that you need anything more complicated than this.  If you do, then you probably have the scope of what you're trying to check a little wrong.
 
-Remember that testing through a browser is brittle, slow and should be at the very top of your automation pyramid.
+Remember that checking through a browser is brittle, slow and should be at the very top of your automation pyramid.
 
-5-10% of all of your projects automated tests (if you're building bespoke software) should be here.  
-If you end up with 500 Selenium tests then it's quite possible that you took a wrong turn.  We'd be happy to talk about getting you back on the right path (get in touch: [email protected]).
+5-10% of all of your projects automated checks (if you're building bespoke software) should be here.  
+If you end up with 500 Selenium checks then it's quite possible that you took a wrong turn.  We'd be happy to talk about getting you back on the right path (get in touch: [email protected]).
 
 If you have questions please feel free to contact me ([email protected]) or if you find issues raise a PR or 
 submit an issue ticket.
 
 ## Documentation
 
 - A full reference guide is here: https://github.com/digital-delivery-academy/selenium-pom-framework/wiki
-- Technical reference documentation (javadocs) are here: https://digital-delivery-academy.github.io/selenium-pom-framework/javadoc-0.0.13
+- Technical reference documentation (javadocs) are here: https://digital-delivery-academy.github.io/selenium-pom-framework/javadoc-1.0.0
 
-## Example tests
+## Example checks/project
 
-See https://github.com/digital-delivery-academy/selenium-pom-example repository for an example of how to write Selenium tests using the Page Object Model.  This repository uses this framework.
+See https://github.com/digital-delivery-academy/selenium-pom-example repository for an example of how to write Selenium checks using the Page Object Model.  This repository uses this framework.
 
 ## Usage
 
@@ -54,7 +58,7 @@ Put this in your POM.xml.
 <dependency>
   <groupId>uk.co.evoco</groupId>
   <artifactId>selenium-pom-framework</artifactId>
-  <version>0.0.13</version>
+  <version>1.0.0</version>
 </dependency>
 ```
 
@@ -107,6 +111,12 @@ An example configuration (`settings.xml`) would be:
 </settings>
 ```
 
+## References/thanks
+We're using repositories from the guys below to provide some of our features:
+- https://github.com/bonigarcia/webdrivermanager from Boni Garcia (for getting WebDriver binaries in a lovely way)
+- https://github.com/nomemory/mockneat from nomemory (for generating random test data easily)
+- https://github.com/dwp/nino-format-validation from UK Gov. Department for Work and Pensions (for checking Ninos)
+
 ## Contributors
 <!-- markdownlint-enable -->
 <!-- prettier-ignore-end -->

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>uk.co.evoco</groupId>
     <artifactId>selenium-pom-framework</artifactId>
-    <version>0.0.13</version>
+    <version>1.0.0</version>
 
     <contributors>
         <contributor>