Visual GUI Testing made easy!
Scout is a tool using a novel approach we call Augmented Testing (AT) to simplify Visual GUI Testing (VGT).
Scout is developed in Java and therefore requires the Java Runtime Environment (JRE). JRE version 8 or later is suitable for running Scout.
You can run Scout either by clicking on the Scout.jar or using the command java -jar Scout.jar.
Before you can run Scout for the first time you have to build all plugins with make build.
Scout is a highly customizable tool due its plugin architecture. If you want to extend Scout's functionalities just create a new plugin in the plugin/ folder.
A plugin should be independent and therefore should not contain any external dependencies. If necessary, external libs must be copied to the bin/ directory. A good idea for plugin development (and development in general) is to follow the Keep it Simple/Stupid (KISS) principle.
If you are interested in developing a single plugin without the whole Scout environment you should have a look at the Single-Plugin-Template repository.
If you have to mange multiple Java versions you could use the tool SDKMAN which helps to maintain multiple JDK versions.
Build automation is accomplished using a Makefile. To get an overview of all provided make targets run make help.
- To build all plugins:
make build. - To build all plugins and run Scout:
make run.
If you decide to use VSCode as IDE than you have to install the Java Extension Pack to be able to develop a plugin.
You can find more information about how to manage Java projects in VSCode following this link.
If you use IntelliJ we recommend you to use the Makefile Language extension to use the already defined build and run tasks. See the screenshot.
The folder docs/ contains additional documentation as well as the JavaDocs for Scout. JavaDocs are also accessible online via this link.
Copyright (c) 2021 Michel Nass, Andreas Bauer
This work (source code) is licensed under MIT.
Files other than source code are licensed as follows:
- Documentation and screenshots are licensed under CC BY-SA 4.0.
See the LICENSES folder in the root of this project for license details.