imagecomparison-parent


License

License

Categories

Categories

Net
GroupId

GroupId

net.avh4.util
ArtifactId

ArtifactId

imagecomparison-parent
Last Version

Last Version

0.3.2
Release Date

Release Date

Type

Type

pom
Description

Description

imagecomparison-parent
Project URL

Project URL

https://github.com/avh4/imagecomparison
Source Code Management

Source Code Management

https://github.com/avh4/imagecomparison

Download imagecomparison-parent

How to add to project

<!-- https://jarcasting.com/artifacts/net.avh4.util/imagecomparison-parent/ -->
<dependency>
    <groupId>net.avh4.util</groupId>
    <artifactId>imagecomparison-parent</artifactId>
    <version>0.3.2</version>
    <type>pom</type>
</dependency>
// https://jarcasting.com/artifacts/net.avh4.util/imagecomparison-parent/
implementation 'net.avh4.util:imagecomparison-parent:0.3.2'
// https://jarcasting.com/artifacts/net.avh4.util/imagecomparison-parent/
implementation ("net.avh4.util:imagecomparison-parent:0.3.2")
'net.avh4.util:imagecomparison-parent:pom:0.3.2'
<dependency org="net.avh4.util" name="imagecomparison-parent" rev="0.3.2">
  <artifact name="imagecomparison-parent" type="pom" />
</dependency>
@Grapes(
@Grab(group='net.avh4.util', module='imagecomparison-parent', version='0.3.2')
)
libraryDependencies += "net.avh4.util" % "imagecomparison-parent" % "0.3.2"
[net.avh4.util/imagecomparison-parent "0.3.2"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

  • imagecomparison
  • imagecomparison-swing
  • imagecomparison-swt

Build Status

Usage

Add the following dependencies to your pom.xml:

  <dependency>
    <groupId>net.avh4.util</groupId>
    <artifactId>imagecomparison</artifactId>
    <version>0.3.1</version>
  </dependency>
  <!-- if you will be comparing AWT components, Swing JComponents or JFrames: -->
  <dependency>
    <groupId>net.avh4.util</groupId>
    <artifactId>imagecomparison-swing</artifactId>
    <version>0.3.1</version>
    <scope>runtime</scope>
  </dependency>
  <!-- if you will be comparing SWT components -->
  <dependency>
    <groupId>net.avh4.util</groupId>
    <artifactId>imagecomparison-swt</artifactId>
    <version>0.3.1</version>
    <scope>runtime</scope>
  </dependency>

isApproved() hamcrest matcher

import static net.avh4.util.imagecomparison.hamcrest.ImageComparisonMatchers.*;

public class MyJComponentTest {
  @Test public void testInitialState() throws Exception {
    MyJComponent subject = new MyJComponent();
    assertThat(subject, isApproved());
  }
}

This will assert that the rendering of subject matches MyJComponentTest.testInitialState.png (taken from the test class and method name), which will be loaded from the classpath in the same package as the test class.

You'll probably see something like this:

Failed tests: 
  testInitialState(MyJComponentTest): 
Expected: something that looks like MyJComponentTest.testInitialState.png (800x600)
     but: images don't match: First incorrect pixel was (0, 0): expected 0xffffff, but got 0x0

The actual rendering of the object will be written to ./MyJComponentTest.testInitialState.png for you to inspect.

looksLike() hamcrest matcher

You can also compare objects to specific image files.

assertThat(subject, looksLike("snazzy-dashboard.png"));

Comparison API

ImageComparisonResult result = ImageComparison.compare(new MyJComponent(), "./snazzy-dashboard.png");
boolean renderingMatches = result.isEqual();
if (!renderingMatches) {
  System.out.println(result.getFailureMessage());
  result.writeActualImageToFile("failed-rendering.png");
}

What you can test

The looks-like checker currently can check the following types of objects:

  • java.awt.image.BufferedImage
  • with imagecomparison-swing: java.awt.Component
  • with imagecomparison-swing: javax.swing.JComponent
  • with imagecomparison-swing: javax.swing.JFrame
  • with imagecomparison-swt: org.eclipse.swt.graphics.Image
  • with imagecomparison-swt: org.eclipse.swt.graphics.ImageData
  • with imagecomparison-swt: org.eclipse.swt.widgets.Control

Additional renderers can be added by implementing net.avh4.util.imagerender.Renderer and registering in META-INF/services (see ServiceLoader).

Versions

Version
0.3.2
0.3.1
0.3.0
0.2.1
0.2.0
0.1.2
0.1.1
0.1.0
0.0.6
0.0.5