Skip to content

Commit 7be26d1

Browse files
Update to README.md
1 parent dfe28a8 commit 7be26d1

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
66
<!-- ALL-CONTRIBUTORS-BADGE:END -->
77

8-
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.
8+
**We've released version 1.0.0!**
9+
10+
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 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.
911

1012
You'll find no junk (hopefully) here, but it's a fairly opinionated approach:
1113
- There's no mass "wrapper" on Selenium - that's dumb
@@ -15,12 +17,14 @@ You'll find no junk (hopefully) here, but it's a fairly opinionated approach:
1517
- 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)
1618
- There's an externalised (and overridable) configuration system, based on JSON
1719
- We handle providing JUnit (we use version 5), Selenium and Hamcrest (for writing good assertions)
20+
- Our framework is unit and integration tested as well as monitored for code quality; we treat this as a production code base, not a second class citizen.
21+
- We have a (developing) open roadmap in GitHub Issues (click the Issues tab to see what we have so far)
1822

1923
Coming soon:
20-
- SauceLabs and BrowserStack configuration.
21-
- Published artefacts to Maven Central (so you can get the framework without a GitHub membership).
22-
- Tutorials for writing tests using our toolkit.
23-
- Builds for Java 13 and older versions of Java.
24+
- SauceLabs and BrowserStack configuration (issues #2 and #3).
25+
- Instrumentation of the framework components to help visualise slow or under performing checks over time (issue #44).
26+
- Published artefacts to Maven Central (so you can get the framework without a GitHub membership) (issue #27).
27+
- Expand documentation and tutorials (issue #45)
2428
- And lots more marked in the issues list: https://github.com/digital-delivery-academy/selenium-pom-framework/issues
2529

2630
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.
@@ -107,6 +111,12 @@ An example configuration (`settings.xml`) would be:
107111
</settings>
108112
```
109113

114+
## References/thanks
115+
We're using repositories from the guys below to provide some of our features:
116+
- https://github.com/bonigarcia/webdrivermanager from Boni Garcia (for getting WebDriver binaries in a lovely way)
117+
- https://github.com/nomemory/mockneat from nomemory (for generating random test data easily)
118+
- https://github.com/dwp/nino-format-validation from UK Gov. Department for Work and Pensions (for testing Ninos)
119+
110120
## Contributors
111121
<!-- markdownlint-enable -->
112122
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)