Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/otto-de/jlineup

An easy-to-use visual acceptance test tool to automatically detect design changes of your website. Works on the command line or as a web service.
https://github.com/otto-de/jlineup

acceptance-testing continuous-deployment continuous-integration frontend-testing headless test-automation visual-acceptance-testing

Last synced: 4 months ago
JSON representation

An easy-to-use visual acceptance test tool to automatically detect design changes of your website. Works on the command line or as a web service.

Awesome Lists containing this project

README 

          



## Status

[![Build](https://github.com/otto-de/jlineup/workflows/Build/badge.svg)](https://github.com/otto-de/jlineup/actions?query=workflow%3ABuild)

[![Maven Central](https://img.shields.io/maven-central/v/de.otto/jlineup-cli?label=maven-central cli)](https://search.maven.org/search?q=g:de.otto%20a:jlineup-cli%20v:RELEASE%20p:jar)

[![Maven Central](https://img.shields.io/maven-central/v/de.otto/jlineup-web?label=maven-central web)](https://search.maven.org/search?q=g:de.otto%20a:jlineup-web%20v:RELEASE%20p:jar)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/otto-de/jlineup?label=GitHub Release)](https://github.com/otto-de/jlineup/releases)

![OSS Lifecycle](https://img.shields.io/osslifecycle?file_url=https%3A%2F%2Fraw.githubusercontent.com%2Fotto-de%2Fjlineup%2Fmain%2FOSSMETADATA)

[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/otto-de/jlineup/badge)](https://scorecard.dev/viewer/?uri=github.com/otto-de/jlineup)



## About



JLineup is a tool which is useful for automated visual regression tests of web pages, especially in continuous delivery pipelines.

It can be used as a simple command line tool or as a small web service which is controlled via REST API. The comparison screenshots

can even be made in AWS Lambda functions, which makes it blazing fast, even with multiple resolutions and device emulations.



JLineup shoots and compares screenshots of a web page at two consecutive points in time.

It does a pixel by pixel comparison of both runs and generates an HTML and a JSON report.

Behind the scenes, it uses Selenium and a browser of choice (currently Chrome, Chromium and Firefox are supported).



JLineup has no other dependencies than a web browser (Firefox or Chrome/Chromium) and a JVM. If the configured

browser is not installed, it will be downloaded automatically by JLineup.

*Experimental*: There's also a self-contained Linux AMD64 build of the CLI version that doesn't even require a JVM.



## Example



Let's take this little example [config](docs/CONFIGURATION.md) for a check of otto.de during a deployment:



```json

{

  "urls": {

    "https://www.otto.de": {

      "paths": [ 

	    "/"

      ],

      "devices" : [ {

        "width" : 850,

        "height" : 600,

        "pixel-ratio" : 1.0,

        "device-name" : "DESKTOP",

        "touch" : false

      }, {

        "width" : 1000,

        "height" : 850,

        "pixel-ratio" : 1.0,

        "device-name" : "DESKTOP",

        "touch" : false

      }, {

        "width" : 1200,

        "height" : 1000,

        "pixel-ratio" : 1.0,

        "device-name" : "DESKTOP",

        "touch" : false

      } ]

    }

  },

  "wait-after-page-load" : 0.5,

  "browser" : "chrome-headless"

}

```



JLineup runs before and after the deployment and generates a report like this:



[![Screenshot of HTML report](docs/html-report.png)](https://otto-de.github.io/jlineup/docs/example-report/report.html)



There's also a JSON report, which is great if you want to check things by script:



[Example JLineup JSON Report](docs/example-report/report.json)



## Quick Howto



JLineup CLI comes as executable Java Archive. Java 17 or higher has to be available to run it.



Open a terminal and download it like this:



    wget https://repo1.maven.org/maven2/de/otto/jlineup-cli/4.13.7/jlineup-cli-4.13.7.jar -O jlineup.jar



Then type



    java -jar jlineup.jar --help



to see the command line help.



See the [CLI documentation](docs/CLI.md) for more details and a small tutorial.



## Integration example



This is an example, how JLineup can be helpful in your automated build and deploy pipeline.

Let's assume, this is part of a continuous integration pipeline:



![Pipeline exampe](docs/pipeline-example.png)



## Browser Compatibility



JLineup 4.13.8 was tested successfully with latest Chrome and Firefox. If not installed,

the configured browser is downloaded automatically by

[Selenium's integrated manager](https://www.selenium.dev/documentation/selenium_manager/).



## Documentation



[JLineup as CLI tool](docs/CLI.md)



[JLineup as web server](docs/WEB.md)



[JLineup Job Configuration](docs/CONFIGURATION.md)



## Third Party Libraries



JLineup uses some third party tools and libraries



##### Selenium



* [Selenium](http://www.seleniumhq.org/) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).



##### Webdrivermanager



* [Webdrivermanager](https://github.com/bonigarcia/webdrivermanager) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).



##### Jackson



* [Jackson](https://github.com/FasterXML/jackson) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).



##### Logback



* [Logback](http://logback.qos.ch/) is licensed under the [Eclipse Public License](http://www.eclipse.org/legal/epl-v10.html).

* The [SLF4J](http://www.slf4j.org) API is licensed under the [MIT License](http://www.slf4j.org/license.html).



##### Thymeleaf



* [Thymeleaf](http://www.thymeleaf.org/) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).



##### Edison Microservice



* [Edison Microservice](https://github.com/otto-de/edison-microservice) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).



##### Spring Boot



* [Spring Boot](http://spring.io/projects/spring-boot) is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).



##### GraalVM Community Edition



* The binary cli version is built with [GraalVM Community Edition](https://github.com/oracle/graal/). GraalVM CE brings it's own [Product License](https://github.com/oracle/graal/blob/master/LICENSE).



##### Image Compare Viewer



* [Image Compare Viewer](https://github.com/kylewetton/image-compare-viewer) is licensed under the [MIT License](https://github.com/kylewetton/image-compare-viewer/blob/master/LICENSE).



##### Google Fonts



* [Google Fonts](https://developers.google.com/fonts/) are used in the HTML report. These are the [terms](https://developers.google.com/fonts/terms).



##### AWS SDK



* [AWS SDK for Java 2.0](https://github.com/aws/aws-sdk-java-v2) is licensed under the [Apache 2.0 License](https://github.com/aws/aws-sdk-java-v2?tab=Apache-2.0-1-ov-file#readme).



##### Pixelmatch



Some code from Pixelmatch was ported to Java for JLineup.

* [Pixelmatch](https://github.com/mapbox/pixelmatch) is licensed under the [ISC License](https://github.com/mapbox/pixelmatch?tab=ISC-1-ov-file#readme).



##### Looks-same



Some code from Looks-same was ported to Java for JLineup.

* [Looks-same](https://github.com/gemini-testing/looks-same) is licensed under the [MIT License](https://github.com/gemini-testing/looks-same#MIT-1-ov-file).



### Historic Facts



JLineup is a configuration compatible replacement

for Lineup, implemented in Java. The original

[Lineup](https://github.com/otto-de-legacy/lineup) was

a Ruby tool, but is not maintained any more.



Credit for original Lineup goes to [Finn Lorbeer](http://www.lor.beer/).



## Publishing to Sonatype's Central Publisher Portal was challenging



This is a note regarding the migration of JLineup's publishing process because of https://central.sonatype.org/news/20250326_ossrh_sunset/.



During migration from OSSRH on oss.sonatype.org to the Central Publisher Portal central.sonatype.com I faced

a problem uploading the JLineup artifacts, that were accepted by the old publishing process without problems:



```

Component Summary

1 failed Deployment Validation

Failed to process deployment: Error on building manifests: No Archiver found for the stream signature Details: No Archiver found for the stream signature

```



![Maven Central Error Screenshot](docs/maven-central-publishing-failure.png)



After some investigation I found out, that the problem was caused by the fact, that some JLineup jar files were executable jar files,

which were enriched by the Spring Boot Gradle Plugin with the `launchScript()` functionality. This is obviously not supported by the new

publishing API and leads to problems after the uploading of the bundle.zip.



I commented the 'launchScript()' functionality in the build.gradle file and was able to publish the artifacts successfully.



```

bootJar {

  enabled = true

  //launchScript()

}

```



I just leave this here to help others, who might face the same problem.



### Contact



If you have questions or proposals, please open an issue or write an email to marco DOT geweke AT otto.de