https://github.com/chavaillaz/automated-browser
Library to quickly implement an automated application controlling a browser for multiple purposes.
https://github.com/chavaillaz/automated-browser
automation browser java selenium
Last synced: 5 months ago
JSON representation
Library to quickly implement an automated application controlling a browser for multiple purposes.
- Host: GitHub
- URL: https://github.com/chavaillaz/automated-browser
- Owner: Chavaillaz
- License: apache-2.0
- Created: 2022-09-10T23:04:42.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-02T14:28:43.000Z (over 1 year ago)
- Last Synced: 2025-07-10T22:50:09.681Z (12 months ago)
- Topics: automation, browser, java, selenium
- Language: Java
- Size: 54.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Automated Browser
[](https://maven-badges.herokuapp.com/maven-central/com.chavaillaz/automated-browser)
[](https://opensource.org/licenses/Apache-2.0)
This library allows to quickly do an automated application controlling a browser for multiple purposes. An example of
usage is to automate the generation of reports for external parties by accessing internal services, highlighting
elements, taking screenshots and creating documents with them.
## Installation
The dependency is available in maven central (see badge for version):
```xml
com.chavaillaz
automated-browser
```
## Usage
An example of usage is available in the ```MavenCentralTest``` class. Its goal is to search the last version of a Maven
artifact and take a screenshot of the code snippet to use.
### Implementing your requirements
#### Stateful
In order to benefit from this library, create new classes extending `AutomatedBrowser` and use the methods available in
it to simplify the implementation of your requirements.
An example of extension available in the tests of the project is the `MavenCentral` class. It can be used with:
```java
try (MavenCentral browser = new MavenCentral(driver)) {
browser.searchArtifact("org.slf4j:slf4j-api");
}
```
#### Stateful - Flow
There is also a possibility to have a flow with multiple steps defining your requirements, using the classes extending
`AutomatedBrowser` you created:
```java
try (MavenCentral browser = new MavenCentral(driver)) {
browser.setData(new MavenCentralData("org.slf4j:slf4j-api"));
new AutomatedBrowserFlow<>(browser)
.withStep(MavenCentral::stepSearchArtifact)
.withStep(MavenCentral::stepLogLastVersion)
.withStep(MavenCentral::stepHighlightSnippet);
}
```
Note that you can also give a default exception handler for all step or a specific one overriding it for some steps.
#### Stateless - Flow
Also with the same flow system, you can have stateless calls to static methods. Those methods can have:
- No parameter
- One parameter: the class extending `AutomatedBrowser` you gave in the constructor (defaulting to `AutomatedBrowser`)
- Two parameters: first same as above and second the context data instance you can set with `withContext` method
```java
try (MavenCentral browser = new MavenCentral(driver)) {
new AutomatedBrowserFlow(browser)
.withContext(new MavenCentralData("org.slf4j:slf4j-api"))
.withStep(MavenCentralStep::stepSearchArtifact)
.withStep(MavenCentralStep::stepLogLastVersion)
.withStep(MavenCentralStep::stepHighlightSnippet);
}
```
### Running your application
#### As a standalone application
Creates your preferred the driver using the methods in `BrowserUtils`:
- Chrome (`getChromeDriver`)
- Firefox (`getFirefoxDriver`)
- Edge (`getEdgeDriver`)
Then pass it to the classes you created (see chapter above) and start using them directly. Note that this will use the
browsers available on your computer, meaning when you choose a browser driver in the code, you need that browser
installed on your computer to make it working.
#### As a docker container
Thanks to test containers, you can also directly run it in a docker container containing the browser you want to use.
For that, include the following dependencies in your project:
```xml
org.testcontainers
selenium
${test-containers.version}
org.testcontainers
junit-jupiter
${test-containers.version}
```
When it's done, add the `@Testcontainers` annotation on your test classes and the following attribute for the
container (in this example Google Chrome):
```java
@Container
public BrowserWebDriverContainer> chrome = new BrowserWebDriverContainer<>()
.withCapabilities(getChromeOptions())
.withRecordingMode(SKIP, null);
```
You can then access the driver with `chrome.getWebDriver()` and pass it when instantiating your classes.
## Contributing
If you have a feature request or found a bug, you can:
- Write an issue
- Create a pull request
If you want to contribute then
- Please write tests covering all your changes
- Ensure you didn't break the build by running `mvn test`
- Fork the repo and create a pull request
## License
This project is under Apache 2.0 License.