├── snapshot-matcher-example ├── .idea │ ├── .name │ ├── markdown-navigator │ │ └── profiles_settings.xml │ ├── modules.xml │ ├── compiler.xml │ └── misc.xml ├── src │ ├── test │ │ ├── resources │ │ │ ├── snapshots │ │ │ │ └── com │ │ │ │ │ └── zenika │ │ │ │ │ └── snapshotmatcherexample │ │ │ │ │ ├── SimpleTypesTest │ │ │ │ │ ├── testBoolean.json │ │ │ │ │ ├── testNumber.json │ │ │ │ │ └── testString.json │ │ │ │ │ ├── JsonNodeTest │ │ │ │ │ └── testJsonNode.json │ │ │ │ │ └── starwars │ │ │ │ │ ├── PlanetConverterTest │ │ │ │ │ └── converterTest.json │ │ │ │ │ └── StarWarsServiceTest │ │ │ │ │ └── getPlanetTest.json │ │ │ └── data │ │ │ │ ├── Planet │ │ │ │ └── tatooine.json │ │ │ │ ├── PeopleDTO │ │ │ │ └── luke-skywalker.json │ │ │ │ └── FilmDTO │ │ │ │ └── attack-of-the-clones.json │ │ └── java │ │ │ └── com │ │ │ └── zenika │ │ │ └── snapshotmatcherexample │ │ │ ├── SimpleTypesTest.java │ │ │ ├── JsonNodeTest.java │ │ │ └── starwars │ │ │ ├── PlanetConverterTest.java │ │ │ └── StarWarsServiceTest.java │ └── main │ │ ├── resources │ │ └── application.yml │ │ └── java │ │ └── com │ │ └── zenika │ │ └── snapshotmatcherexample │ │ ├── SnapshotMatcherExampleApplication.java │ │ ├── starwars │ │ ├── dtos │ │ │ ├── FilmDTO.java │ │ │ ├── PeopleDTO.java │ │ │ └── PlanetDTO.java │ │ ├── StarWarsRest.java │ │ ├── StarWarsService.java │ │ ├── entities │ │ │ └── Planet.java │ │ └── PlanetConverter.java │ │ └── configuration │ │ ├── RestTemplateConfiguration.java │ │ └── UserAgentRequestInterceptor.java ├── .gitignore ├── pom.xml └── snapshot-matcher-example.iml ├── .idea ├── markdown-navigator │ └── profiles_settings.xml ├── modules.xml ├── compiler.xml └── misc.xml ├── snapshot-matcher ├── .idea │ ├── markdown-navigator │ │ └── profiles_settings.xml │ ├── modules.xml │ ├── compiler.xml │ └── misc.xml ├── snapshotmatcherexample.iml ├── src │ └── main │ │ └── java │ │ └── com │ │ └── zenika │ │ └── snapshotmatcher │ │ ├── utils │ │ └── TestUtils.java │ │ ├── DeterministicObjectMapper.java │ │ └── SnapshotMatcher.java ├── .gitignore ├── snapshot-matcher.iml └── pom.xml ├── .circleci └── config.yml ├── .gitignore ├── README.md └── LICENSE.md /snapshot-matcher-example/.idea/.name: -------------------------------------------------------------------------------- 1 | snapshotmatcherexample -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/snapshots/com/zenika/snapshotmatcherexample/SimpleTypesTest/testBoolean.json: -------------------------------------------------------------------------------- 1 | false -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/snapshots/com/zenika/snapshotmatcherexample/SimpleTypesTest/testNumber.json: -------------------------------------------------------------------------------- 1 | 17711 -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/snapshots/com/zenika/snapshotmatcherexample/SimpleTypesTest/testString.json: -------------------------------------------------------------------------------- 1 | "MyString" -------------------------------------------------------------------------------- /.idea/markdown-navigator/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/snapshots/com/zenika/snapshotmatcherexample/JsonNodeTest/testJsonNode.json: -------------------------------------------------------------------------------- 1 | { 2 | "a" : 2, 3 | "z" : 1 4 | } -------------------------------------------------------------------------------- /snapshot-matcher/.idea/markdown-navigator/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /snapshot-matcher-example/.idea/markdown-navigator/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/resources/application.yml: -------------------------------------------------------------------------------- 1 | spring: 2 | application: 3 | name: "@project.artifactId@" 4 | 5 | starwars-api: https://swapi.co/api 6 | 7 | endpoints: 8 | planets: ${starwars-api}/planets/ 9 | 10 | -------------------------------------------------------------------------------- /snapshot-matcher/.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /snapshot-matcher-example/.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /snapshot-matcher/snapshotmatcherexample.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/SnapshotMatcherExampleApplication.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class SnapshotMatcherExampleApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(SnapshotMatcherExampleApplication.class, args); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/data/Planet/tatooine.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Tatooine", 3 | "rotation_period": "23", 4 | "orbital_period": "304", 5 | "diameter": "10465", 6 | "climate": "arid", 7 | "gravity": "1 standard", 8 | "terrain": "desert", 9 | "surface_water": "1", 10 | "population": "200000", 11 | "residents": [ 12 | "https://swapi.co/api/people/1/" 13 | ], 14 | "films": [ 15 | "https://swapi.co/api/films/5/" 16 | ], 17 | "created": "2014-12-09T13:50:49.641000Z", 18 | "edited": "2014-12-21T20:48:04.175778Z", 19 | "url": "https://swapi.co/api/planets/1/" 20 | } 21 | -------------------------------------------------------------------------------- /snapshot-matcher/.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/java/com/zenika/snapshotmatcherexample/SimpleTypesTest.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample; 2 | 3 | import static com.zenika.snapshotmatcher.SnapshotMatcher.matchesSnapshot; 4 | import static org.hamcrest.MatcherAssert.assertThat; 5 | 6 | import org.junit.Test; 7 | 8 | public class SimpleTypesTest { 9 | 10 | @Test 11 | public void testString() { 12 | String s = "MyString"; 13 | 14 | assertThat(s, matchesSnapshot()); 15 | } 16 | 17 | @Test 18 | public void testNumber() { 19 | assertThat(17711L, matchesSnapshot()); 20 | } 21 | 22 | @Test 23 | public void testBoolean() { 24 | assertThat(false, matchesSnapshot()); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/java/com/zenika/snapshotmatcherexample/JsonNodeTest.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample; 2 | 3 | import com.fasterxml.jackson.databind.JsonNode; 4 | import com.fasterxml.jackson.databind.ObjectMapper; 5 | import org.junit.Test; 6 | 7 | import java.io.IOException; 8 | 9 | import static com.zenika.snapshotmatcher.SnapshotMatcher.matchesSnapshot; 10 | import static org.hamcrest.MatcherAssert.assertThat; 11 | 12 | public class JsonNodeTest { 13 | @Test 14 | public void testJsonNode () throws IOException { 15 | ObjectMapper mapper = new ObjectMapper(); 16 | JsonNode json = mapper.readTree("{\"z\": 1, \"a\": 2 }"); 17 | assertThat(json, matchesSnapshot()); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /snapshot-matcher-example/.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/starwars/dtos/FilmDTO.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars.dtos; 2 | 3 | import java.io.Serializable; 4 | import java.util.ArrayList; 5 | 6 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 7 | import com.fasterxml.jackson.annotation.JsonProperty; 8 | 9 | @JsonIgnoreProperties(ignoreUnknown = true) 10 | public class FilmDTO implements Serializable { 11 | public String title; 12 | 13 | @JsonProperty("episode_id") 14 | public int episodeId; 15 | 16 | @JsonProperty("opening_crawl") 17 | public String openingCrawl; 18 | 19 | public String director; 20 | public String producer; 21 | public String url; 22 | public String created; 23 | public String edited; 24 | 25 | } 26 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /snapshot-matcher/src/main/java/com/zenika/snapshotmatcher/utils/TestUtils.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcher.utils; 2 | 3 | import java.io.IOException; 4 | import java.net.URL; 5 | 6 | import com.fasterxml.jackson.databind.ObjectMapper; 7 | 8 | public class TestUtils { 9 | private static final ObjectMapper objectMapper = new ObjectMapper(); 10 | 11 | public static T fromJson(String fileName, Class clazz) { 12 | ClassLoader classLoader = TestUtils.class.getClassLoader(); 13 | URL resource = classLoader.getResource(String.format("data/%s/%s.json", clazz.getSimpleName(), fileName)); 14 | 15 | try { 16 | return objectMapper.readValue(resource, clazz); 17 | } catch (IOException e) { 18 | e.printStackTrace(); 19 | return null; 20 | } 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | 3 | jobs: 4 | build: 5 | docker: 6 | - image: circleci/openjdk:8 7 | steps: 8 | - checkout 9 | - restore_cache: 10 | key: java-snapshot-matcher-{{ checksum "snapshot-matcher/pom.xml" }}-{{ checksum "snapshot-matcher-example/pom.xml" }} 11 | - run: cd snapshot-matcher && mvn dependency:go-offline 12 | - run: cd snapshot-matcher && mvn install 13 | - run: cd snapshot-matcher-example && mvn dependency:go-offline 14 | - run: cd snapshot-matcher-example && mvn -Dsurefire.useSystemClassLoader=false test 15 | - save_cache: 16 | paths: 17 | - ~/.m2 18 | key: java-snapshot-matcher-{{ checksum "snapshot-matcher/pom.xml" }}-{{ checksum "snapshot-matcher-example/pom.xml" }} 19 | - store_test_results: 20 | path: snapshot-matcher-example/target/surefire-reports 21 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/configuration/RestTemplateConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.configuration; 2 | 3 | import static java.util.Collections.singletonList; 4 | 5 | import org.springframework.beans.factory.annotation.Autowired; 6 | import org.springframework.context.annotation.Bean; 7 | import org.springframework.context.annotation.Configuration; 8 | import org.springframework.web.client.RestTemplate; 9 | 10 | @Configuration 11 | public class RestTemplateConfiguration { 12 | 13 | @Autowired 14 | private UserAgentRequestInterceptor requestInterceptor; 15 | 16 | @Bean 17 | public RestTemplate restTemplate(){ 18 | RestTemplate restTemplate = new RestTemplate(); 19 | 20 | restTemplate.setInterceptors(singletonList(requestInterceptor)); 21 | 22 | return restTemplate; 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/starwars/StarWarsRest.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars; 2 | 3 | import org.springframework.beans.factory.annotation.Autowired; 4 | import org.springframework.web.bind.annotation.PathVariable; 5 | import org.springframework.web.bind.annotation.RequestMapping; 6 | import org.springframework.web.bind.annotation.RequestMethod; 7 | import org.springframework.web.bind.annotation.RestController; 8 | 9 | import com.zenika.snapshotmatcherexample.starwars.dtos.PlanetDTO; 10 | 11 | @RestController 12 | @RequestMapping("planets") 13 | public class StarWarsRest { 14 | 15 | @Autowired 16 | private StarWarsService starWarsService; 17 | 18 | @RequestMapping(value = "/{id}", method = RequestMethod.GET) 19 | public PlanetDTO getPlanet(@PathVariable Long id){ 20 | return starWarsService.getPlanet(id); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/starwars/dtos/PeopleDTO.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars.dtos; 2 | 3 | import java.io.Serializable; 4 | import java.util.ArrayList; 5 | 6 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 7 | import com.fasterxml.jackson.annotation.JsonProperty; 8 | 9 | @JsonIgnoreProperties(ignoreUnknown = true) 10 | public class PeopleDTO implements Serializable { 11 | public String name; 12 | 13 | @JsonProperty("birth_year") 14 | public String birthYear; 15 | 16 | public String gender; 17 | 18 | @JsonProperty("hair_color") 19 | public String hairColor; 20 | 21 | public String height; 22 | 23 | public String mass; 24 | 25 | @JsonProperty("skin_color") 26 | public String skinColor; 27 | 28 | public String created; 29 | public String edited; 30 | public String url; 31 | } 32 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/starwars/StarWarsService.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars; 2 | 3 | import org.springframework.beans.factory.annotation.Autowired; 4 | import org.springframework.beans.factory.annotation.Value; 5 | import org.springframework.stereotype.Service; 6 | import org.springframework.web.client.RestTemplate; 7 | 8 | import com.zenika.snapshotmatcherexample.starwars.dtos.PlanetDTO; 9 | import com.zenika.snapshotmatcherexample.starwars.entities.Planet; 10 | 11 | @Service 12 | public class StarWarsService { 13 | 14 | @Autowired 15 | private RestTemplate restTemplate; 16 | 17 | @Autowired 18 | private PlanetConverter planetConverter; 19 | 20 | @Value("${endpoints.planets}") 21 | private String endpoint; 22 | 23 | public PlanetDTO getPlanet(Long id){ 24 | return planetConverter.convertPlanet(restTemplate.getForObject(endpoint + id, Planet.class)); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/data/PeopleDTO/luke-skywalker.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Luke Skywalker", 3 | "height": "172", 4 | "mass": "77", 5 | "hair_color": "blond", 6 | "skin_color": "fair", 7 | "eye_color": "blue", 8 | "birth_year": "19BBY", 9 | "gender": "male", 10 | "homeworld": "https://swapi.co/api/planets/1/", 11 | "films": [ 12 | "https://swapi.co/api/films/2/", 13 | "https://swapi.co/api/films/6/", 14 | "https://swapi.co/api/films/3/", 15 | "https://swapi.co/api/films/1/", 16 | "https://swapi.co/api/films/7/" 17 | ], 18 | "species": [ 19 | "https://swapi.co/api/species/1/" 20 | ], 21 | "vehicles": [ 22 | "https://swapi.co/api/vehicles/14/", 23 | "https://swapi.co/api/vehicles/30/" 24 | ], 25 | "starships": [ 26 | "https://swapi.co/api/starships/12/", 27 | "https://swapi.co/api/starships/22/" 28 | ], 29 | "created": "2014-12-09T13:50:51.644000Z", 30 | "edited": "2014-12-20T21:17:56.891000Z", 31 | "url": "https://swapi.co/api/people/1/" 32 | } 33 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/starwars/entities/Planet.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars.entities; 2 | 3 | import java.io.Serializable; 4 | import java.util.ArrayList; 5 | import java.util.List; 6 | 7 | import com.fasterxml.jackson.annotation.JsonProperty; 8 | 9 | public class Planet implements Serializable { 10 | public String name; 11 | public String diameter; 12 | public String gravity; 13 | public String population; 14 | public String climate; 15 | public String terrain; 16 | public String created; 17 | public String edited; 18 | public String url; 19 | 20 | @JsonProperty("rotation_period") 21 | public String rotationPeriod; 22 | 23 | @JsonProperty("orbital_period") 24 | public String orbitalPeriod; 25 | 26 | @JsonProperty("surface_water") 27 | public String surfaceWater; 28 | 29 | @JsonProperty("residents") 30 | public List residentsUrls; 31 | 32 | @JsonProperty("films") 33 | public List filmsUrls; 34 | } 35 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/starwars/dtos/PlanetDTO.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars.dtos; 2 | 3 | import java.io.Serializable; 4 | import java.util.List; 5 | 6 | import com.fasterxml.jackson.annotation.JsonProperty; 7 | 8 | public class PlanetDTO implements Serializable { 9 | public String name; 10 | public String diameter; 11 | public String gravity; 12 | public String population; 13 | public String climate; 14 | public String terrain; 15 | public String created; 16 | public String edited; 17 | public String url; 18 | 19 | @JsonProperty("rotation_period") 20 | public String rotationPeriod; 21 | 22 | @JsonProperty("orbital_period") 23 | public String orbitalPeriod; 24 | 25 | @JsonProperty("surface_water") 26 | public String surfaceWater; 27 | 28 | @JsonProperty(access = JsonProperty.Access.READ_ONLY) 29 | public List residents; 30 | 31 | @JsonProperty(access = JsonProperty.Access.READ_ONLY) 32 | public List films; 33 | } 34 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/configuration/UserAgentRequestInterceptor.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.configuration; 2 | 3 | import java.io.IOException; 4 | 5 | import org.springframework.beans.factory.annotation.Value; 6 | import org.springframework.http.HttpHeaders; 7 | import org.springframework.http.HttpRequest; 8 | import org.springframework.http.client.ClientHttpRequestExecution; 9 | import org.springframework.http.client.ClientHttpRequestInterceptor; 10 | import org.springframework.http.client.ClientHttpResponse; 11 | import org.springframework.stereotype.Component; 12 | 13 | /** 14 | * Request interceptor which add a User-Agent header to each request. 15 | */ 16 | @Component 17 | public class UserAgentRequestInterceptor implements ClientHttpRequestInterceptor { 18 | 19 | @Value("${spring.application.name}") 20 | private String applicationName; 21 | 22 | @Override 23 | public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException { 24 | httpRequest.getHeaders().set(HttpHeaders.USER_AGENT, applicationName); 25 | 26 | return clientHttpRequestExecution.execute(httpRequest, bytes); 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/main/java/com/zenika/snapshotmatcherexample/starwars/PlanetConverter.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars; 2 | 3 | import java.util.stream.Collectors; 4 | 5 | import org.springframework.beans.factory.annotation.Autowired; 6 | import org.springframework.stereotype.Component; 7 | import org.springframework.web.client.RestTemplate; 8 | 9 | import com.fasterxml.jackson.databind.ObjectMapper; 10 | import com.zenika.snapshotmatcherexample.starwars.dtos.FilmDTO; 11 | import com.zenika.snapshotmatcherexample.starwars.dtos.PeopleDTO; 12 | import com.zenika.snapshotmatcherexample.starwars.dtos.PlanetDTO; 13 | import com.zenika.snapshotmatcherexample.starwars.entities.Planet; 14 | 15 | @Component 16 | public class PlanetConverter { 17 | 18 | @Autowired 19 | private ObjectMapper objectMapper; 20 | 21 | @Autowired 22 | private RestTemplate restTemplate; 23 | 24 | public PlanetDTO convertPlanet(Planet planet) { 25 | PlanetDTO dto = objectMapper.convertValue(planet, PlanetDTO.class); 26 | 27 | dto.films = planet.filmsUrls.stream() 28 | .map(filmUrl -> restTemplate.getForObject(filmUrl, FilmDTO.class)) 29 | .collect(Collectors.toList()); 30 | 31 | dto.residents = planet.residentsUrls.stream() 32 | .map(filmUrl -> restTemplate.getForObject(filmUrl, PeopleDTO.class)) 33 | .collect(Collectors.toList()); 34 | 35 | return dto; 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled class file 2 | *.class 3 | 4 | # Log file 5 | *.log 6 | 7 | # BlueJ files 8 | *.ctxt 9 | 10 | # Mobile Tools for Java (J2ME) 11 | .mtj.tmp/ 12 | 13 | # Package Files # 14 | *.jar 15 | *.war 16 | *.ear 17 | *.zip 18 | *.tar.gz 19 | *.rar 20 | 21 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 22 | hs_err_pid* 23 | 24 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm 25 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 26 | 27 | # User-specific stuff: 28 | .idea/**/workspace.xml 29 | .idea/**/tasks.xml 30 | .idea/dictionaries 31 | 32 | # Sensitive or high-churn files: 33 | .idea/**/dataSources/ 34 | .idea/**/dataSources.ids 35 | .idea/**/dataSources.xml 36 | .idea/**/dataSources.local.xml 37 | .idea/**/sqlDataSources.xml 38 | .idea/**/dynamic.xml 39 | .idea/**/uiDesigner.xml 40 | 41 | # Gradle: 42 | .idea/**/gradle.xml 43 | .idea/**/libraries 44 | 45 | # CMake 46 | cmake-build-debug/ 47 | cmake-build-release/ 48 | 49 | # Mongo Explorer plugin: 50 | .idea/**/mongoSettings.xml 51 | 52 | ## File-based project format: 53 | *.iws 54 | 55 | ## Plugin-specific files: 56 | 57 | # IntelliJ 58 | out/ 59 | 60 | # mpeltonen/sbt-idea plugin 61 | .idea_modules/ 62 | 63 | # JIRA plugin 64 | atlassian-ide-plugin.xml 65 | 66 | # Cursive Clojure plugin 67 | .idea/replstate.xml 68 | 69 | # Crashlytics plugin (for Android Studio and IntelliJ) 70 | com_crashlytics_export_strings.xml 71 | crashlytics.properties 72 | crashlytics-build.properties 73 | fabric.properties -------------------------------------------------------------------------------- /snapshot-matcher-example/.gitignore: -------------------------------------------------------------------------------- 1 | */target/ 2 | pom.xml.tag 3 | pom.xml.releaseBackup 4 | pom.xml.versionsBackup 5 | pom.xml.next 6 | release.properties 7 | dependency-reduced-pom.xml 8 | buildNumber.properties 9 | .mvn/timing.properties 10 | 11 | # Avoid ignoring Maven wrapper jar file (.jar files are usually ignored) 12 | !/.mvn/wrapper/maven-wrapper.jar 13 | 14 | target/ 15 | 16 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm 17 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 18 | 19 | # User-specific stuff: 20 | .idea/**/workspace.xml 21 | .idea/**/tasks.xml 22 | .idea/dictionaries 23 | 24 | # Sensitive or high-churn files: 25 | .idea/**/dataSources/ 26 | .idea/**/dataSources.ids 27 | .idea/**/dataSources.xml 28 | .idea/**/dataSources.local.xml 29 | .idea/**/sqlDataSources.xml 30 | .idea/**/dynamic.xml 31 | .idea/**/uiDesigner.xml 32 | 33 | # Gradle: 34 | .idea/**/gradle.xml 35 | .idea/**/libraries 36 | 37 | # CMake 38 | cmake-build-debug/ 39 | cmake-build-release/ 40 | 41 | # Mongo Explorer plugin: 42 | .idea/**/mongoSettings.xml 43 | 44 | ## File-based project format: 45 | *.iws 46 | 47 | ## Plugin-specific files: 48 | 49 | # IntelliJ 50 | out/ 51 | 52 | # mpeltonen/sbt-idea plugin 53 | .idea_modules/ 54 | 55 | # JIRA plugin 56 | atlassian-ide-plugin.xml 57 | 58 | # Cursive Clojure plugin 59 | .idea/replstate.xml 60 | 61 | # Crashlytics plugin (for Android Studio and IntelliJ) 62 | com_crashlytics_export_strings.xml 63 | crashlytics.properties 64 | crashlytics-build.properties 65 | fabric.properties -------------------------------------------------------------------------------- /snapshot-matcher/.gitignore: -------------------------------------------------------------------------------- 1 | */target/ 2 | pom.xml.tag 3 | pom.xml.releaseBackup 4 | pom.xml.versionsBackup 5 | pom.xml.next 6 | release.properties 7 | dependency-reduced-pom.xml 8 | buildNumber.properties 9 | .mvn/timing.properties 10 | 11 | # Avoid ignoring Maven wrapper jar file (.jar files are usually ignored) 12 | !/.mvn/wrapper/maven-wrapper.jar 13 | 14 | target/ 15 | 16 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm 17 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 18 | 19 | # User-specific stuff: 20 | .idea/**/workspace.xml 21 | .idea/**/tasks.xml 22 | .idea/dictionaries 23 | 24 | # Sensitive or high-churn files: 25 | .idea/**/dataSources/ 26 | .idea/**/dataSources.ids 27 | .idea/**/dataSources.xml 28 | .idea/**/dataSources.local.xml 29 | .idea/**/sqlDataSources.xml 30 | .idea/**/dynamic.xml 31 | .idea/**/uiDesigner.xml 32 | 33 | # Gradle: 34 | .idea/**/gradle.xml 35 | .idea/**/libraries 36 | 37 | # CMake 38 | cmake-build-debug/ 39 | cmake-build-release/ 40 | 41 | # Mongo Explorer plugin: 42 | .idea/**/mongoSettings.xml 43 | 44 | ## File-based project format: 45 | *.iws 46 | 47 | ## Plugin-specific files: 48 | 49 | # IntelliJ 50 | out/ 51 | 52 | # mpeltonen/sbt-idea plugin 53 | .idea_modules/ 54 | 55 | # JIRA plugin 56 | atlassian-ide-plugin.xml 57 | 58 | # Cursive Clojure plugin 59 | .idea/replstate.xml 60 | 61 | # Crashlytics plugin (for Android Studio and IntelliJ) 62 | com_crashlytics_export_strings.xml 63 | crashlytics.properties 64 | crashlytics-build.properties 65 | fabric.properties 66 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/snapshots/com/zenika/snapshotmatcherexample/starwars/PlanetConverterTest/converterTest.json: -------------------------------------------------------------------------------- 1 | { 2 | "climate" : "arid", 3 | "created" : "2014-12-09T13:50:49.641000Z", 4 | "diameter" : "10465", 5 | "edited" : "2014-12-21T20:48:04.175778Z", 6 | "films" : [ { 7 | "created" : "2014-12-20T10:57:57.886000Z", 8 | "director" : "George Lucas", 9 | "edited" : "2015-04-11T09:45:01.623982Z", 10 | "episode_id" : 2, 11 | "opening_crawl" : "There is unrest in the Galactic\r\nSenate. Several thousand solar\r\nsystems have declared their\r\nintentions to leave the Republic.\r\n\r\nThis separatist movement,\r\nunder the leadership of the\r\nmysterious Count Dooku, has\r\nmade it difficult for the limited\r\nnumber of Jedi Knights to maintain \r\npeace and order in the galaxy.\r\n\r\nSenator Amidala, the former\r\nQueen of Naboo, is returning\r\nto the Galactic Senate to vote\r\non the critical issue of creating\r\nan ARMY OF THE REPUBLIC\r\nto assist the overwhelmed\r\nJedi....", 12 | "producer" : "Rick McCallum", 13 | "title" : "Attack of the Clones", 14 | "url" : "https://swapi.co/api/films/5/" 15 | } ], 16 | "gravity" : "1 standard", 17 | "name" : "Tatooine", 18 | "orbital_period" : "304", 19 | "population" : "200000", 20 | "residents" : [ { 21 | "birth_year" : "19BBY", 22 | "created" : "2014-12-09T13:50:51.644000Z", 23 | "edited" : "2014-12-20T21:17:56.891000Z", 24 | "gender" : "male", 25 | "hair_color" : "blond", 26 | "height" : "172", 27 | "mass" : "77", 28 | "name" : "Luke Skywalker", 29 | "skin_color" : "fair", 30 | "url" : "https://swapi.co/api/people/1/" 31 | } ], 32 | "rotation_period" : "23", 33 | "surface_water" : "1", 34 | "terrain" : "desert", 35 | "url" : "https://swapi.co/api/planets/1/" 36 | } -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/snapshots/com/zenika/snapshotmatcherexample/starwars/StarWarsServiceTest/getPlanetTest.json: -------------------------------------------------------------------------------- 1 | { 2 | "climate" : "arid", 3 | "created" : "2014-12-09T13:50:49.641000Z", 4 | "diameter" : "10465", 5 | "edited" : "2014-12-21T20:48:04.175778Z", 6 | "films" : [ { 7 | "created" : "2014-12-20T10:57:57.886000Z", 8 | "director" : "George Lucas", 9 | "edited" : "2015-04-11T09:45:01.623982Z", 10 | "episode_id" : 2, 11 | "opening_crawl" : "There is unrest in the Galactic\r\nSenate. Several thousand solar\r\nsystems have declared their\r\nintentions to leave the Republic.\r\n\r\nThis separatist movement,\r\nunder the leadership of the\r\nmysterious Count Dooku, has\r\nmade it difficult for the limited\r\nnumber of Jedi Knights to maintain \r\npeace and order in the galaxy.\r\n\r\nSenator Amidala, the former\r\nQueen of Naboo, is returning\r\nto the Galactic Senate to vote\r\non the critical issue of creating\r\nan ARMY OF THE REPUBLIC\r\nto assist the overwhelmed\r\nJedi....", 12 | "producer" : "Rick McCallum", 13 | "title" : "Attack of the Clones", 14 | "url" : "https://swapi.co/api/films/5/" 15 | } ], 16 | "gravity" : "1 standard", 17 | "name" : "Tatooine", 18 | "orbital_period" : "304", 19 | "population" : "200000", 20 | "residents" : [ { 21 | "birth_year" : "19BBY", 22 | "created" : "2014-12-09T13:50:51.644000Z", 23 | "edited" : "2014-12-20T21:17:56.891000Z", 24 | "gender" : "male", 25 | "hair_color" : "blond", 26 | "height" : "172", 27 | "mass" : "77", 28 | "name" : "Luke Skywalker", 29 | "skin_color" : "fair", 30 | "url" : "https://swapi.co/api/people/1/" 31 | } ], 32 | "rotation_period" : "23", 33 | "surface_water" : "1", 34 | "terrain" : "desert", 35 | "url" : "https://swapi.co/api/planets/1/" 36 | } -------------------------------------------------------------------------------- /snapshot-matcher/snapshot-matcher.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/java/com/zenika/snapshotmatcherexample/starwars/PlanetConverterTest.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars; 2 | 3 | import static com.zenika.snapshotmatcher.SnapshotMatcher.matchesSnapshot; 4 | import static com.zenika.snapshotmatcher.utils.TestUtils.fromJson; 5 | import static org.junit.Assert.assertThat; 6 | import static org.mockito.Mockito.when; 7 | 8 | import org.junit.Before; 9 | import org.junit.Test; 10 | import org.junit.runner.RunWith; 11 | import org.mockito.InjectMocks; 12 | import org.mockito.Mock; 13 | import org.springframework.beans.factory.annotation.Autowired; 14 | import org.springframework.boot.test.context.SpringBootTest; 15 | import org.springframework.test.context.junit4.SpringRunner; 16 | import org.springframework.web.client.RestTemplate; 17 | 18 | import com.zenika.snapshotmatcherexample.starwars.dtos.FilmDTO; 19 | import com.zenika.snapshotmatcherexample.starwars.dtos.PeopleDTO; 20 | import com.zenika.snapshotmatcherexample.starwars.dtos.PlanetDTO; 21 | import com.zenika.snapshotmatcherexample.starwars.entities.Planet; 22 | 23 | @RunWith(SpringRunner.class) 24 | @SpringBootTest 25 | public class PlanetConverterTest { 26 | 27 | @Mock 28 | private RestTemplate restTemplate; 29 | 30 | @Autowired 31 | @InjectMocks 32 | private PlanetConverter converter; 33 | 34 | private PeopleDTO lukeSkywalker = fromJson("luke-skywalker", PeopleDTO.class); 35 | private FilmDTO attackOfTheClones = fromJson("attack-of-the-clones", FilmDTO.class); 36 | private Planet tatooine = fromJson("tatooine", Planet.class); 37 | 38 | @Before 39 | public void setUp() { 40 | when(restTemplate.getForObject("https://swapi.co/api/people/1/", PeopleDTO.class)) 41 | .thenReturn(lukeSkywalker); 42 | when(restTemplate.getForObject("https://swapi.co/api/films/5/", FilmDTO.class)) 43 | .thenReturn(attackOfTheClones); 44 | } 45 | 46 | @Test 47 | public void converterTest() { 48 | PlanetDTO planet = converter.convertPlanet(tatooine); 49 | 50 | assertThat(planet, matchesSnapshot()); 51 | } 52 | } -------------------------------------------------------------------------------- /snapshot-matcher/src/main/java/com/zenika/snapshotmatcher/DeterministicObjectMapper.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcher; 2 | 3 | import com.fasterxml.jackson.annotation.JsonInclude; 4 | import com.fasterxml.jackson.core.JsonProcessingException; 5 | import com.fasterxml.jackson.core.TreeNode; 6 | import com.fasterxml.jackson.databind.JsonNode; 7 | import com.fasterxml.jackson.databind.MapperFeature; 8 | import com.fasterxml.jackson.databind.ObjectMapper; 9 | import com.fasterxml.jackson.databind.SerializationFeature; 10 | 11 | import java.io.IOException; 12 | import java.io.Writer; 13 | 14 | /** 15 | * Deterministic {@link ObjectMapper} to avoid unpredictable serialization 16 | * 17 | * - Sorts properties and map entries by keys 18 | * 19 | * - Uses pretty printer by default to have readable diffs 20 | * 21 | * - Ignore null fields to reduce snapshot size 22 | * 23 | * Be aware that we don't sort collections, so avoid using 24 | * {@link java.util.Set} implementations that have unpredictable iteration 25 | * order, e.g {@link java.util.HashSet} 26 | */ 27 | class DeterministicObjectMapper { 28 | 29 | private final ObjectMapper objectMapper; 30 | 31 | DeterministicObjectMapper() { 32 | objectMapper = new ObjectMapper() 33 | .configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true) 34 | .configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, true) 35 | .setSerializationInclusion(JsonInclude.Include.NON_NULL); 36 | } 37 | 38 | public void writeValue(Writer writer, Object o) throws IOException { 39 | objectMapper.writerWithDefaultPrettyPrinter().writeValue(writer, getSnapshotableObject(o)); 40 | } 41 | 42 | public String writeValueAsString(T o) throws JsonProcessingException { 43 | return objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(getSnapshotableObject(o)); 44 | } 45 | 46 | public Object getSnapshotableObject (Object o) throws JsonProcessingException { 47 | if (o instanceof JsonNode) return objectMapper.treeToValue((TreeNode) o, Object.class); 48 | return o; 49 | } 50 | } 51 | 52 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/java/com/zenika/snapshotmatcherexample/starwars/StarWarsServiceTest.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcherexample.starwars; 2 | 3 | import static com.zenika.snapshotmatcher.SnapshotMatcher.matchesSnapshot; 4 | import static com.zenika.snapshotmatcher.utils.TestUtils.fromJson; 5 | import static org.junit.Assert.assertThat; 6 | import static org.mockito.Mockito.when; 7 | 8 | import org.junit.Before; 9 | import org.junit.Test; 10 | import org.junit.runner.RunWith; 11 | import org.mockito.InjectMocks; 12 | import org.mockito.Mock; 13 | import org.springframework.beans.factory.annotation.Autowired; 14 | import org.springframework.boot.test.context.SpringBootTest; 15 | import org.springframework.test.context.junit4.SpringRunner; 16 | import org.springframework.web.client.RestTemplate; 17 | 18 | import com.zenika.snapshotmatcherexample.starwars.dtos.FilmDTO; 19 | import com.zenika.snapshotmatcherexample.starwars.dtos.PeopleDTO; 20 | import com.zenika.snapshotmatcherexample.starwars.dtos.PlanetDTO; 21 | import com.zenika.snapshotmatcherexample.starwars.entities.Planet; 22 | 23 | @RunWith(SpringRunner.class) 24 | @SpringBootTest 25 | public class StarWarsServiceTest { 26 | 27 | @Mock 28 | private RestTemplate restTemplate; 29 | 30 | @Autowired 31 | @InjectMocks 32 | private StarWarsService service; 33 | 34 | private PeopleDTO lukeSkywalker = fromJson("luke-skywalker", PeopleDTO.class); 35 | private FilmDTO attackOfTheClones = fromJson("attack-of-the-clones", FilmDTO.class); 36 | private Planet tatooine = fromJson("tatooine", Planet.class); 37 | 38 | @Before 39 | public void setUp() { 40 | when(restTemplate.getForObject("https://swapi.co/api/people/1/", PeopleDTO.class)) 41 | .thenReturn(lukeSkywalker); 42 | when(restTemplate.getForObject("https://swapi.co/api/films/5/", FilmDTO.class)) 43 | .thenReturn(attackOfTheClones); 44 | when(restTemplate.getForObject("https://swapi.co/api/planets/1", Planet.class)) 45 | .thenReturn(tatooine); 46 | } 47 | 48 | @Test 49 | public void getPlanetTest() { 50 | PlanetDTO planet = service.getPlanet(1L); 51 | 52 | assertThat(planet, matchesSnapshot()); 53 | } 54 | } -------------------------------------------------------------------------------- /snapshot-matcher/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.zenika 8 | snapshot-matcher 9 | 1.0-SNAPSHOT 10 | jar 11 | 12 | 13 | 1.8 14 | 2.10.0 15 | 1.3.0 16 | 1.3 17 | 3.1 18 | 19 | 20 | 21 | 22 | 23 | org.apache.maven.plugins 24 | maven-compiler-plugin 25 | ${maven-compiler-plugin.version} 26 | 27 | ${jdk.version} 28 | ${jdk.version} 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | com.googlecode.java-diff-utils 37 | diffutils 38 | ${diffutils.version} 39 | 40 | 41 | org.hamcrest 42 | hamcrest-all 43 | ${hamcrest.version} 44 | 45 | 46 | com.fasterxml.jackson.core 47 | jackson-core 48 | ${jackson.version} 49 | 50 | 51 | com.fasterxml.jackson.core 52 | jackson-databind 53 | ${jackson.version} 54 | 55 | 56 | -------------------------------------------------------------------------------- /snapshot-matcher-example/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.zenika 8 | snapshot-matcher-example 9 | 1.0-SNAPSHOT 10 | 11 | 12 | org.springframework.boot 13 | spring-boot-starter-parent 14 | 1.5.9.RELEASE 15 | 16 | 17 | 18 | 19 | 1.8 20 | 3.1 21 | 22 | 23 | 24 | 25 | 26 | org.apache.maven.plugins 27 | maven-compiler-plugin 28 | ${maven-compiler-plugin.version} 29 | 30 | ${jdk.version} 31 | ${jdk.version} 32 | 33 | 34 | 35 | org.springframework.boot 36 | spring-boot-maven-plugin 37 | 38 | 39 | 40 | 41 | 42 | 43 | org.springframework.boot 44 | spring-boot-starter-web 45 | 46 | 47 | 48 | org.springframework.boot 49 | spring-boot-starter-test 50 | test 51 | 52 | 53 | 54 | com.zenika 55 | snapshot-matcher 56 | 1.0-SNAPSHOT 57 | 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Snapshot testing with Java 2 | _Avoid serial assertions when testing serializable objects._ 3 | 4 | ## Simple usage 5 | ```java 6 | @Test 7 | public void test() { 8 | String s = "StringToTest"; 9 | 10 | assertThat(s, matchesSnapshot()); 11 | } 12 | ``` 13 | On the first execution of this test, it will generate a snapshot file in resources folder. This file looks like this: 14 | ```json 15 | "StringToTest" 16 | ``` 17 | This file **must be committed**. 18 | Next executions of this test will read said file and compare with actual value. 19 | 20 | Assertion will fail if serialized values are different. 21 | 22 | We use [Jackson](https://github.com/FasterXML/jackson) to handle serialization/deserialization to JSON format. 23 | This library therefore can handle any object that is serializable by Jackson. 24 | 25 | ## Real world example 26 | Full example available [here](https://github.com/Zenika/java-snapshot-matcher/tree/master/snapshot-matcher-example). 27 | 28 | I want to test a converter, which transforms a `Planet` into a `PlanetDTO`. 29 | ```java 30 | @Component 31 | public class PlanetConverter { 32 | 33 | @Autowired 34 | private ObjectMapper objectMapper; 35 | 36 | @Autowired 37 | private RestTemplate restTemplate; 38 | 39 | public PlanetDTO convertPlanet(Planet planet) { 40 | PlanetDTO dto = objectMapper.convertValue(planet, PlanetDTO.class); 41 | 42 | dto.films = planet.filmsUrls.stream() 43 | .map(filmUrl -> restTemplate.getForObject(filmUrl, FilmDTO.class)) 44 | .collect(Collectors.toList()); 45 | 46 | dto.residents = planet.residentsUrls.stream() 47 | .map(filmUrl -> restTemplate.getForObject(filmUrl, PeopleDTO.class)) 48 | .collect(Collectors.toList()); 49 | 50 | return dto; 51 | } 52 | } 53 | ``` 54 | 55 | As it can be difficult to generate input object and to perform assertions on returned object, we use the snapshot matcher to handle assertions. 56 | 57 | ```java 58 | @RunWith(SpringRunner.class) 59 | @SpringBootTest 60 | public class PlanetConverterTest { 61 | 62 | // RestTemplate needs to be mocked to ensure stability of snapshots. 63 | // Note that ObjectMapper is not mocked 64 | @Mock 65 | private RestTemplate restTemplate; 66 | 67 | @Autowired 68 | @InjectMocks 69 | private PlanetConverter converter; 70 | 71 | // Create input objects from JSON files 72 | private PeopleDTO lukeSkywalker = fromJson("luke-skywalker", PeopleDTO.class); 73 | private FilmDTO attackOfTheClones = fromJson("attack-of-the-clones", FilmDTO.class); 74 | private Planet tatooine = fromJson("tatooine", Planet.class); 75 | 76 | @Before 77 | public void setUp() { 78 | // Mock return values of RestTemplate 79 | when(restTemplate.getForObject("https://swapi.co/api/people/1/", PeopleDTO.class)) 80 | .thenReturn(lukeSkywalker); 81 | when(restTemplate.getForObject("https://swapi.co/api/films/5/", FilmDTO.class)) 82 | .thenReturn(attackOfTheClones); 83 | } 84 | 85 | @Test 86 | public void converterTest() { 87 | // Call method 88 | PlanetDTO planet = converter.convertPlanet(tatooine); 89 | 90 | // Do assertion 91 | assertThat(planet, matchesSnapshot()); 92 | } 93 | } 94 | ``` 95 | 96 | ## Limitations 97 | - Only one snapshot assertion per test method 98 | -------------------------------------------------------------------------------- /snapshot-matcher-example/src/test/resources/data/FilmDTO/attack-of-the-clones.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Attack of the Clones", 3 | "episode_id": 2, 4 | "opening_crawl": "There is unrest in the Galactic\r\nSenate. Several thousand solar\r\nsystems have declared their\r\nintentions to leave the Republic.\r\n\r\nThis separatist movement,\r\nunder the leadership of the\r\nmysterious Count Dooku, has\r\nmade it difficult for the limited\r\nnumber of Jedi Knights to maintain \r\npeace and order in the galaxy.\r\n\r\nSenator Amidala, the former\r\nQueen of Naboo, is returning\r\nto the Galactic Senate to vote\r\non the critical issue of creating\r\nan ARMY OF THE REPUBLIC\r\nto assist the overwhelmed\r\nJedi....", 5 | "director": "George Lucas", 6 | "producer": "Rick McCallum", 7 | "release_date": "2002-05-16", 8 | "characters": [ 9 | "https://swapi.co/api/people/2/", 10 | "https://swapi.co/api/people/3/", 11 | "https://swapi.co/api/people/6/", 12 | "https://swapi.co/api/people/7/", 13 | "https://swapi.co/api/people/10/", 14 | "https://swapi.co/api/people/11/", 15 | "https://swapi.co/api/people/20/", 16 | "https://swapi.co/api/people/21/", 17 | "https://swapi.co/api/people/22/", 18 | "https://swapi.co/api/people/33/", 19 | "https://swapi.co/api/people/36/", 20 | "https://swapi.co/api/people/40/", 21 | "https://swapi.co/api/people/43/", 22 | "https://swapi.co/api/people/46/", 23 | "https://swapi.co/api/people/51/", 24 | "https://swapi.co/api/people/52/", 25 | "https://swapi.co/api/people/53/", 26 | "https://swapi.co/api/people/58/", 27 | "https://swapi.co/api/people/59/", 28 | "https://swapi.co/api/people/60/", 29 | "https://swapi.co/api/people/61/", 30 | "https://swapi.co/api/people/62/", 31 | "https://swapi.co/api/people/63/", 32 | "https://swapi.co/api/people/64/", 33 | "https://swapi.co/api/people/65/", 34 | "https://swapi.co/api/people/66/", 35 | "https://swapi.co/api/people/67/", 36 | "https://swapi.co/api/people/68/", 37 | "https://swapi.co/api/people/69/", 38 | "https://swapi.co/api/people/70/", 39 | "https://swapi.co/api/people/71/", 40 | "https://swapi.co/api/people/72/", 41 | "https://swapi.co/api/people/73/", 42 | "https://swapi.co/api/people/74/", 43 | "https://swapi.co/api/people/75/", 44 | "https://swapi.co/api/people/76/", 45 | "https://swapi.co/api/people/77/", 46 | "https://swapi.co/api/people/78/", 47 | "https://swapi.co/api/people/82/", 48 | "https://swapi.co/api/people/35/" 49 | ], 50 | "planets": [ 51 | "https://swapi.co/api/planets/8/", 52 | "https://swapi.co/api/planets/9/", 53 | "https://swapi.co/api/planets/10/", 54 | "https://swapi.co/api/planets/11/", 55 | "https://swapi.co/api/planets/1/" 56 | ], 57 | "starships": [ 58 | "https://swapi.co/api/starships/21/", 59 | "https://swapi.co/api/starships/39/", 60 | "https://swapi.co/api/starships/43/", 61 | "https://swapi.co/api/starships/47/", 62 | "https://swapi.co/api/starships/48/", 63 | "https://swapi.co/api/starships/49/", 64 | "https://swapi.co/api/starships/32/", 65 | "https://swapi.co/api/starships/52/", 66 | "https://swapi.co/api/starships/58/" 67 | ], 68 | "vehicles": [ 69 | "https://swapi.co/api/vehicles/4/", 70 | "https://swapi.co/api/vehicles/44/", 71 | "https://swapi.co/api/vehicles/45/", 72 | "https://swapi.co/api/vehicles/46/", 73 | "https://swapi.co/api/vehicles/50/", 74 | "https://swapi.co/api/vehicles/51/", 75 | "https://swapi.co/api/vehicles/53/", 76 | "https://swapi.co/api/vehicles/54/", 77 | "https://swapi.co/api/vehicles/55/", 78 | "https://swapi.co/api/vehicles/56/", 79 | "https://swapi.co/api/vehicles/57/" 80 | ], 81 | "species": [ 82 | "https://swapi.co/api/species/32/", 83 | "https://swapi.co/api/species/33/", 84 | "https://swapi.co/api/species/2/", 85 | "https://swapi.co/api/species/35/", 86 | "https://swapi.co/api/species/6/", 87 | "https://swapi.co/api/species/1/", 88 | "https://swapi.co/api/species/12/", 89 | "https://swapi.co/api/species/34/", 90 | "https://swapi.co/api/species/13/", 91 | "https://swapi.co/api/species/15/", 92 | "https://swapi.co/api/species/28/", 93 | "https://swapi.co/api/species/29/", 94 | "https://swapi.co/api/species/30/", 95 | "https://swapi.co/api/species/31/" 96 | ], 97 | "created": "2014-12-20T10:57:57.886000Z", 98 | "edited": "2015-04-11T09:45:01.623982Z", 99 | "url": "https://swapi.co/api/films/5/" 100 | } 101 | -------------------------------------------------------------------------------- /snapshot-matcher/.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 36 | 37 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 78 | 79 | 80 | 81 | 82 | -------------------------------------------------------------------------------- /snapshot-matcher-example/.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 36 | 37 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 78 | 79 | 80 | 81 | 82 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 48 | 49 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 91 | 92 | 93 | 94 | 95 | -------------------------------------------------------------------------------- /snapshot-matcher/src/main/java/com/zenika/snapshotmatcher/SnapshotMatcher.java: -------------------------------------------------------------------------------- 1 | package com.zenika.snapshotmatcher; 2 | 3 | import static java.util.Arrays.asList; 4 | 5 | import java.io.BufferedReader; 6 | import java.io.BufferedWriter; 7 | import java.io.IOException; 8 | import java.nio.charset.Charset; 9 | import java.nio.file.Files; 10 | import java.nio.file.Path; 11 | import java.nio.file.Paths; 12 | import java.util.ArrayList; 13 | import java.util.List; 14 | import java.util.stream.Collectors; 15 | import java.util.stream.Stream; 16 | 17 | import org.hamcrest.Description; 18 | import org.hamcrest.Factory; 19 | import org.hamcrest.TypeSafeMatcher; 20 | 21 | import difflib.DiffUtils; 22 | import difflib.Patch; 23 | 24 | public class SnapshotMatcher extends TypeSafeMatcher { 25 | /** 26 | * Factory method to instantiate a snapshot matcher with the given type 27 | * 28 | * @param Type of object to snapshot 29 | * @return The snapshot matcher instance 30 | */ 31 | @Factory 32 | public static SnapshotMatcher matchesSnapshot() { 33 | return new SnapshotMatcher<>(); 34 | } 35 | 36 | /** 37 | * Private constructor, use factory method {@link SnapshotMatcher#matchesSnapshot()} create a new matcher 38 | */ 39 | private SnapshotMatcher() { 40 | } 41 | 42 | private final DeterministicObjectMapper objectMapper = new DeterministicObjectMapper(); 43 | 44 | @Override 45 | public boolean matchesSafely(T o) { 46 | Path snapshotPath = getPath(); 47 | 48 | if (Files.exists(snapshotPath)) { 49 | // File exists => Compare snapshot file to given object 50 | return compareSnapshot(o, snapshotPath); 51 | } else { 52 | // File doesn't exist => Create snapshot file and return true 53 | createSnapshot(o, snapshotPath); 54 | return true; 55 | } 56 | } 57 | 58 | /** 59 | * Perform serialization of o and save result to snapshotPath 60 | * 61 | * @param o Object to serialize 62 | * @param snapshotPath Path to file to create 63 | */ 64 | private void createSnapshot(T o, Path snapshotPath) { 65 | try { 66 | Files.createDirectories(snapshotPath.getParent()); 67 | Files.createFile(snapshotPath); 68 | 69 | try (BufferedWriter writer = Files.newBufferedWriter(snapshotPath, Charset.forName("UTF-8"))) { 70 | objectMapper.writeValue(writer, o); 71 | } 72 | } catch (IOException e) { 73 | e.printStackTrace(); 74 | } 75 | } 76 | 77 | /** 78 | * Compares snapshot at the given path with the given object 79 | * 80 | * @param o Actual object to serialize then compare 81 | * @param snapshotPath Path to the corresponding snapshot file 82 | * @return true if snapshot matches the actual, false otherwise 83 | */ 84 | private boolean compareSnapshot(T o, Path snapshotPath) { 85 | try (BufferedReader reader = Files.newBufferedReader(snapshotPath, Charset.forName("UTF-8"))) { 86 | List actual = asList(objectMapper.writeValueAsString(o).split(System.lineSeparator())); 87 | List expected = new ArrayList<>(actual.size()); 88 | 89 | String line; 90 | while ((line = reader.readLine()) != null) { 91 | expected.add(line); 92 | } 93 | 94 | Patch patch = DiffUtils.diff(actual, expected); 95 | 96 | if (patch.getDeltas().isEmpty()) { 97 | return true; 98 | } else { 99 | System.out.print( 100 | patch.getDeltas().stream() 101 | .map(delta -> String.format("Expected\t<%s>\nbut found\t<%s>", delta.getOriginal(), delta.getRevised())) 102 | .collect( 103 | Collectors.joining( 104 | System.lineSeparator() + System.lineSeparator(), 105 | String.format("Snapshot mismatch (%d differences found):\n", patch.getDeltas().size()), 106 | System.lineSeparator()))); 107 | return false; 108 | } 109 | } catch (IOException e) { 110 | e.printStackTrace(); 111 | } 112 | 113 | return false; 114 | } 115 | 116 | @Override 117 | public void describeTo(Description description) { 118 | description.appendText("Object should match snapshot at " + getPath().toString()); 119 | } 120 | 121 | /** 122 | * Find out path of the snapshot using caller name and class 123 | * 124 | * @return Path to the snapshot file 125 | */ 126 | private Path getPath() { 127 | StackTraceElement caller = getCaller(); 128 | 129 | String callerClassName = caller.getClassName().replace('.', '/'); 130 | String callerMethodName = caller.getMethodName(); 131 | 132 | return Paths.get(String.format("src/test/resources/snapshots/%s/%s.json", callerClassName, callerMethodName)); 133 | } 134 | 135 | /** 136 | * Find out caller StackTraceElement, ie. the test method which instantiated the matcher 137 | * 138 | * @return StackTraceElement of the test method 139 | */ 140 | private StackTraceElement getCaller() { 141 | final StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace(); 142 | 143 | return Stream.of(stackTraceElements) 144 | // Filter out java.lang package 145 | .filter(stackTraceElement -> !stackTraceElement.getClassName().startsWith(Thread.class.getPackage().getName())) 146 | // Filter out org.hamcrest package 147 | .filter(stackTraceElement -> !stackTraceElement.getClassName().startsWith(TypeSafeMatcher.class.getPackage().getName())) 148 | // Filter out junit package 149 | .filter(stackTraceElement -> !stackTraceElement.getClassName().startsWith("org.junit")) 150 | // Filter out current class 151 | .filter(stackTraceElement -> !stackTraceElement.getClassName().equals(SnapshotMatcher.class.getName())) 152 | .findFirst() 153 | .orElse(null); 154 | } 155 | 156 | } 157 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License.: 202 | -------------------------------------------------------------------------------- /snapshot-matcher-example/snapshot-matcher-example.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | --------------------------------------------------------------------------------