Full Docs · Javadoc · Report Bug · Request Feature

Table of Contents

1. About
2. Getting Started
3. Contributing
4. Contacts
5. Acknowledgments

About

Spectrum is a test automation framework that leverages JUnit 5 and Selenium 4 to simplify e2e tests development providing these features automatically:

• Driver instantiation
• Html report generation
• Execution video generation
• Coverage report generation by reading a testbook
• Mail/Slack notifications with reports as attachments

Spectrum manages all the boilerplate code to get these features and many more, allowing you to focus on test logic.

• It is fully configurable via a declarative yaml file
• It provides out-of-the-box defaults to let you run tests with no additional configuration
• supports browsers automation via Selenium
• supports mobile and desktop applications automation via Appium

Getting Started

All you need to do is take the three steps listed below, as shown in this video:

Spectrum.project.creation.mp4

⚠️ JDK
Since Spectrum is compiled with a jdk 21, you need a jdk 21+ to be able to run your tests.

1. Generate a new project leveraging the Spectrum Archetype via your IDE or by running this in a terminal and providing values when prompted:

   mvn archetype:generate -DarchetypeGroupId=io.github.giulong -DarchetypeArtifactId=spectrum-archetype -DarchetypeVersion=LATEST
   

2. Run the LoginFormIT demo test injected by the archetype.

3. Once the execution is done, you will find the target/spectrum/reports/spectrum-report-<TIMESTAMP>/spectrum-report-<TIMESTAMP>.html report with the execution video attached.

⚠️ Default Browser
Tests run on Chrome by default. If you don't have it, you can run the demo test with:
-Dspectrum.driver=firefox, -Dspectrum.driver=edge or -Dspectrum.driver=safari

Here's a quick overview of the project created by the archetype, along with the generated report:

 

And here's the generated video:

video-readme.mp4

Additionally, you can configure Spectrum to automatically produce summary and coverage reports like these:

 

For all the available reports, how to customise them, and many more, please refer to the full documentation.

Contributing

Contributions to Spectrum are welcome! If you're interested, please check out the CONTRIBUTING.md.

If you're using Spectrum, please consider giving it a GitHub Star ⭐

Contacts

Creator	GitHub	Linkedin	Email
Giulio Longfils	giulong	Giulio Longfils	[email protected]

Acknowledgments

Spectrum leverages these projects you should definitely check out!

• JUnit 5
• Selenium
• Appium
• Lombok
• Extent Reports
• FreeMarker
• Simple Java Mail
• JCodec
• VicTools JsonSchema Generator
• Jekyll
• Modernist Theme