diff --git a/README.md b/README.md index 5ba53400..95fd4e6a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.6.0/jar) -[![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.6.0) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.6.1/jar) +[![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.6.1) [![Coverage Status](https://coveralls.io/repos/github/skuzzle/snapshot-tests/badge.svg?branch=main)](https://coveralls.io/github/skuzzle/snapshot-tests?branch=main) [![Twitter Follow](https://img.shields.io/twitter/follow/skuzzleOSS.svg?style=social)](https://twitter.com/skuzzleOSS) @@ -13,17 +13,17 @@ serialized version of the object during the first test execution and during subs actual object against the stored snapshot. Supported snapshot formats: -- [x] generic plain text via [snapshot-tests-core](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-core/1.6.0/jar) -- [x] Json via [snapshot-tests-jackson](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jackson/1.6.0/jar) -- [x] XML via [snapshot-tests-jaxb](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.6.0/jar) -- [x] HTML via [snapshot-tests-html](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.6.0/jar) +- [x] generic plain text via [snapshot-tests-core](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-core/1.6.1/jar) +- [x] Json via [snapshot-tests-jackson](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jackson/1.6.1/jar) +- [x] XML via [snapshot-tests-jaxb](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.6.1/jar) +- [x] HTML via [snapshot-tests-html](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.6.1/jar) Read more about snapshot testing in this accompanying [blog post](https://simon.taddiken.net/the-case-for-snapshot-testing/). ### Latest Maven Central coordinates Please check out the GitHub release page to find Maven & Gradle coordinates for the latest -release [1.6.0](https://github.com/skuzzle/snapshot-tests/releases/tag/v1.6.0) +release [1.6.1](https://github.com/skuzzle/snapshot-tests/releases/tag/v1.6.1) ## Quick start _(assumes using `snapshot-tests-jackson` artifact)_ diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index de441602..7e5c6263 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,10 +1,4 @@ -* [#42](https://github.com/skuzzle/snapshot-tests/issues/42): Publish flattened version of our artifact to fix BOM distribution -* [#43](https://github.com/skuzzle/snapshot-tests/issues/43): Allow XML structure comparison for String input -* Add `XmlSnapshot.withEnableXPathDebugging(...)` and `HtmlSnapshot.withEnableXPathDebugging(...)` to print results of applying custom comparison rules -* Fixed bugs and performance issues in XPath comparison engine -* `toString()` of `TestFile` and `TestDirectory` contain full absoulte path to the file instead of just the file name -* Deprecate `FilesFrom.directory` in favor of `FilesFrom.testResourcesDirectory` and `FilesFrom.projectDirectory` -* Deprecate `DirectoriesFrom.directory` in favor of `DirectoriesFrom.testResourcesDirectory` and `DirectoriesFrom.projectDirectory` +* Deprecated property `DirectoriesFrom.directory` should not be mandatory Maven Central coordinates for this release: @@ -12,128 +6,128 @@ Maven Central coordinates for this release: ## BOM Artifact Manages the versions of all modules in case you are using multiple in your project -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.6.0/jar) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-bom/1.6.1/jar) ```xml de.skuzzle.test snapshot-tests-bom - 1.6.0 + 1.6.1 pom import ``` ``` -testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.6.0")) +testImplementation(platform("de.skuzzle.test:snapshot-tests-bom:1.6.1")) ``` ## Artifacts If you only need text based snapshots: -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-core/1.6.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.6.0) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-core/1.6.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-core/1.6.1) ```xml de.skuzzle.test snapshot-tests-core - 1.6.0 + 1.6.1 test ``` ``` -testImplementation 'de.skuzzle.test:snapshot-tests-core:1.6.0' -testImplementation("de.skuzzle.test:snapshot-tests-core:1.6.0") +testImplementation 'de.skuzzle.test:snapshot-tests-core:1.6.1' +testImplementation("de.skuzzle.test:snapshot-tests-core:1.6.1") ``` If you need json based snapshots (includes `-core`): -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jackson/1.6.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jackson/1.6.0) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jackson/1.6.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jackson/1.6.1) ```xml de.skuzzle.test snapshot-tests-jackson - 1.6.0 + 1.6.1 test ``` ``` -testImplementation 'de.skuzzle.test:snapshot-tests-jackson:1.6.0' -testImplementation("de.skuzzle.test:snapshot-tests-jackson:1.6.0") +testImplementation 'de.skuzzle.test:snapshot-tests-jackson:1.6.1' +testImplementation("de.skuzzle.test:snapshot-tests-jackson:1.6.1") ``` If you need xml based snapshots (includes `-core`): -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.6.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb/1.6.0) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-jaxb/1.6.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-jaxb/1.6.1) ```xml de.skuzzle.test snapshot-tests-jaxb - 1.6.0 + 1.6.1 test ``` ``` -testImplementation 'de.skuzzle.test:snapshot-tests-jaxb:1.6.0' -testImplementation("de.skuzzle.test:snapshot-tests-jaxb:1.6.0") +testImplementation 'de.skuzzle.test:snapshot-tests-jaxb:1.6.1' +testImplementation("de.skuzzle.test:snapshot-tests-jaxb:1.6.1") ``` If you need HTML based snapshots (includes `-core`): -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.6.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-html/1.6.0) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-html/1.6.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-html/1.6.1) ```xml de.skuzzle.test snapshot-tests-html - 1.6.0 + 1.6.1 test ``` ``` -testImplementation 'de.skuzzle.test:snapshot-tests-html:1.6.0' -testImplementation("de.skuzzle.test:snapshot-tests-html:1.6.0") +testImplementation 'de.skuzzle.test:snapshot-tests-html:1.6.1' +testImplementation("de.skuzzle.test:snapshot-tests-html:1.6.1") ``` ## Experimental Directory Params -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-directory-params/1.6.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-directory-params/1.6.0) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-directory-params/1.6.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-directory-params/1.6.1) ```xml de.skuzzle.test snapshot-tests-directory-params - 1.6.0 + 1.6.1 test ``` ``` -testImplementation 'de.skuzzle.test:snapshot-tests-directory-params:1.6.0' -testImplementation("de.skuzzle.test:snapshot-tests-directory-params:1.6.0") +testImplementation 'de.skuzzle.test:snapshot-tests-directory-params:1.6.1' +testImplementation("de.skuzzle.test:snapshot-tests-directory-params:1.6.1") ``` Object normalization -[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.0&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-normalize/1.6.0/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.0&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-normalize/1.6.0) +[![Maven Central](https://img.shields.io/static/v1?label=MavenCentral&message=1.6.1&color=blue)](https://search.maven.org/artifact/de.skuzzle.test/snapshot-tests-normalize/1.6.1/jar) [![JavaDoc](https://img.shields.io/static/v1?label=JavaDoc&message=1.6.1&color=orange)](http://www.javadoc.io/doc/de.skuzzle.test/snapshot-tests-normalize/1.6.1) ```xml de.skuzzle.test snapshot-tests-normalize - 1.6.0 + 1.6.1 test ``` ``` -testImplementation 'de.skuzzle.test:snapshot-tests-normalize:1.6.0' -testImplementation("de.skuzzle.test:snapshot-tests-normalize:1.6.0") +testImplementation 'de.skuzzle.test:snapshot-tests-normalize:1.6.1' +testImplementation("de.skuzzle.test:snapshot-tests-normalize:1.6.1") ``` \ No newline at end of file diff --git a/pom.xml b/pom.xml index 33a716e4..6e9518f5 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 pom Snapshot Tests Parent diff --git a/readme/RELEASE_NOTES.md b/readme/RELEASE_NOTES.md index 479a2813..c2826858 100644 --- a/readme/RELEASE_NOTES.md +++ b/readme/RELEASE_NOTES.md @@ -1,10 +1,4 @@ -* [#42](https://github.com/skuzzle/snapshot-tests/issues/42): Publish flattened version of our artifact to fix BOM distribution -* [#43](https://github.com/skuzzle/snapshot-tests/issues/43): Allow XML structure comparison for String input -* Add `XmlSnapshot.withEnableXPathDebugging(...)` and `HtmlSnapshot.withEnableXPathDebugging(...)` to print results of applying custom comparison rules -* Fixed bugs and performance issues in XPath comparison engine -* `toString()` of `TestFile` and `TestDirectory` contain full absoulte path to the file instead of just the file name -* Deprecate `FilesFrom.directory` in favor of `FilesFrom.testResourcesDirectory` and `FilesFrom.projectDirectory` -* Deprecate `DirectoriesFrom.directory` in favor of `DirectoriesFrom.testResourcesDirectory` and `DirectoriesFrom.projectDirectory` +* Deprecated property `DirectoriesFrom.directory` should not be mandatory Maven Central coordinates for this release: diff --git a/snapshot-tests-bom/pom.xml b/snapshot-tests-bom/pom.xml index 1d064a23..08f5350f 100644 --- a/snapshot-tests-bom/pom.xml +++ b/snapshot-tests-bom/pom.xml @@ -4,7 +4,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-bom diff --git a/snapshot-tests-common/pom.xml b/snapshot-tests-common/pom.xml index fc9f3601..abaa1a90 100644 --- a/snapshot-tests-common/pom.xml +++ b/snapshot-tests-common/pom.xml @@ -4,7 +4,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-common diff --git a/snapshot-tests-core/pom.xml b/snapshot-tests-core/pom.xml index 9d799c65..634e62ff 100644 --- a/snapshot-tests-core/pom.xml +++ b/snapshot-tests-core/pom.xml @@ -6,7 +6,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-core diff --git a/snapshot-tests-dependencies/pom.xml b/snapshot-tests-dependencies/pom.xml index 1d2801aa..1a393352 100644 --- a/snapshot-tests-dependencies/pom.xml +++ b/snapshot-tests-dependencies/pom.xml @@ -4,7 +4,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-dependencies diff --git a/snapshot-tests-directory-params/pom.xml b/snapshot-tests-directory-params/pom.xml index 145ecebd..d321c978 100644 --- a/snapshot-tests-directory-params/pom.xml +++ b/snapshot-tests-directory-params/pom.xml @@ -5,7 +5,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-directory-params diff --git a/snapshot-tests-directory-params/src/main/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFrom.java b/snapshot-tests-directory-params/src/main/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFrom.java index 50f2354d..8e14698e 100644 --- a/snapshot-tests-directory-params/src/main/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFrom.java +++ b/snapshot-tests-directory-params/src/main/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFrom.java @@ -51,7 +51,7 @@ * relative to the current project. */ @Deprecated(since = "1.6.0", forRemoval = true) - String directory(); + String directory() default ""; /** * The directory, relative to src/test/resources, from which to list the files. Mutual diff --git a/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFromTest.java b/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFromTest.java index c698afc4..149ebfb2 100644 --- a/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFromTest.java +++ b/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/DirectoriesFromTest.java @@ -12,7 +12,7 @@ public class DirectoriesFromTest { @ParameterizedTest - @DirectoriesFrom(directory = "test-directories") + @DirectoriesFrom(testResourcesDirectory = "test-directories") void testDirectories(TestDirectory directory, Snapshot snapshot) throws IOException { // Given final String input1 = directory.resolve("input1.txt").asText(StandardCharsets.UTF_8); diff --git a/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/FilesFromTest.java b/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/FilesFromTest.java index 47151109..fab87abd 100644 --- a/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/FilesFromTest.java +++ b/snapshot-tests-directory-params/src/test/java/de/skuzzle/test/snapshots/directoryparams/FilesFromTest.java @@ -13,7 +13,7 @@ public class FilesFromTest { @ParameterizedTest - @FilesFrom(directory = "test-input", extensions = "txt") + @FilesFrom(testResourcesDirectory = "test-input", extensions = "txt") void test(TestFile testFile, Snapshot snapshot) throws IOException { // Given final String testInput = testFile.asText(StandardCharsets.UTF_8, Map.of("variable", testFile.name())); diff --git a/snapshot-tests-html/pom.xml b/snapshot-tests-html/pom.xml index c847f145..5a38e5eb 100644 --- a/snapshot-tests-html/pom.xml +++ b/snapshot-tests-html/pom.xml @@ -4,7 +4,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-html diff --git a/snapshot-tests-jackson/pom.xml b/snapshot-tests-jackson/pom.xml index 1d321084..bdc0dfc8 100644 --- a/snapshot-tests-jackson/pom.xml +++ b/snapshot-tests-jackson/pom.xml @@ -5,7 +5,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-jackson diff --git a/snapshot-tests-jaxb/pom.xml b/snapshot-tests-jaxb/pom.xml index dafb66a2..51b9dd77 100644 --- a/snapshot-tests-jaxb/pom.xml +++ b/snapshot-tests-jaxb/pom.xml @@ -5,7 +5,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-jaxb diff --git a/snapshot-tests-normalize/pom.xml b/snapshot-tests-normalize/pom.xml index 01cf1739..8a1aef84 100644 --- a/snapshot-tests-normalize/pom.xml +++ b/snapshot-tests-normalize/pom.xml @@ -5,7 +5,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-normalize diff --git a/snapshot-tests-release-test/pom.xml b/snapshot-tests-release-test/pom.xml index 170aca5d..5e2d69e1 100644 --- a/snapshot-tests-release-test/pom.xml +++ b/snapshot-tests-release-test/pom.xml @@ -5,7 +5,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-release-test diff --git a/snapshot-tests-xmlunit/pom.xml b/snapshot-tests-xmlunit/pom.xml index e6271a9f..b6fd81be 100644 --- a/snapshot-tests-xmlunit/pom.xml +++ b/snapshot-tests-xmlunit/pom.xml @@ -5,7 +5,7 @@ de.skuzzle.test snapshot-tests-parent - 1.6.0 + 1.6.1 snapshot-tests-xmlunit