com.cedarsoft.test.utils.JsonUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-utils Show documentation
There is a newer version: 8.9.2
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.test.utils;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Charsets;
import java.nio.charset.Charset;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.junit.*;
import org.xml.sax.SAXException;

import java.io.IOException;
import java.io.StringWriter;
import java.net.URL;

/**
 * @author Johannes Schneider ([email protected])
 */
public class JsonUtils {
  private JsonUtils() {
  }

  public static void assertJsonEquals( @Nonnull URL control, @Nullable String test ) throws SAXException, IOException {
    assertJsonEquals(control, test, Charsets.UTF_8);
  }
  
  public static void assertJsonEquals( @Nonnull URL control, @Nullable String test , @Nonnull Charset charset) throws SAXException, IOException {
    assertJsonEquals( AssertUtils.toString( control, charset), test );
  }

  public static void assertJsonEquals( @Nullable String control, @Nullable String test ) throws IOException {
    if ( test == null || test.trim().isEmpty() ) {
      throw new ComparisonFailure( "Empty test json", formatJson( control ).trim(), formatJson( test ).trim() );
    }
    if ( control == null || control.trim().isEmpty() ) {
      throw new ComparisonFailure( "Empty control json", formatJson( control ).trim(), formatJson( test ).trim() );
    }

    try {
      ObjectMapper mapper = new ObjectMapper();
      JsonNode testTree = mapper.readTree( test );
      JsonNode controlTree = mapper.readTree( control );

      if ( !controlTree.equals( testTree ) ) {
        throw new ComparisonFailure( "JSON comparison failed", formatJson( control ).trim(), formatJson( test ).trim() );
      }
    } catch ( JsonProcessingException e ) {
      throw new ComparisonFailure( "JSON parsing error (" + e.getMessage() + ")", formatJson( control ).trim(), formatJson( test ).trim() );
    }
  }

  @Deprecated
  public static void assertJsonEquals( @Nullable String err, @Nullable String control, @Nullable String test ) throws IOException, ComparisonFailure {
    assertJsonEquals(control, test);
  }

  @Nonnull
  public static String formatJson( @Nullable String unformated ) {
    try {
      ObjectMapper mapper = new ObjectMapper();
      JsonNode tree = mapper.readTree( unformated );

      StringWriter out = new StringWriter();
      JsonGenerator jsonGenerator = mapper.getJsonFactory().createJsonGenerator( out );

      jsonGenerator.useDefaultPrettyPrinter();
      jsonGenerator.writeTree( tree );

      return out.toString();
    } catch ( Exception ignore ) {
      //Do not format if it is not possible...
      return String.valueOf( unformated );
    }
  }
}