GsonVersionDiagnosticsTest.java

/*
 * Copyright (C) 2018 Gson Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.gson.functional;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertThrows;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.util.regex.Pattern;
import org.junit.Before;
import org.junit.Test;

/**
 * Functional tests to validate printing of Gson version on AssertionErrors
 *
 * @author Inderjeet Singh
 */
public class GsonVersionDiagnosticsTest {
  // We require a patch number, even if it is .0, consistent with https://semver.org/#spec-item-2.
  private static final Pattern GSON_VERSION_PATTERN =
      Pattern.compile("(\\(GSON \\d\\.\\d+\\.\\d)(?:[-.][A-Z]+)?\\)$");

  private Gson gson;

  @Before
  public void setUp() {
    gson =
        new GsonBuilder()
            .registerTypeAdapter(
                TestType.class,
                new TypeAdapter<TestType>() {
                  @Override
                  public void write(JsonWriter out, TestType value) {
                    throw new AssertionError("Expected during serialization");
                  }

                  @Override
                  public TestType read(JsonReader in) {
                    throw new AssertionError("Expected during deserialization");
                  }
                })
            .create();
  }

  @Test
  public void testVersionPattern() {
    assertThat("(GSON 2.8.5)").matches(GSON_VERSION_PATTERN);
    assertThat("(GSON 2.8.5-SNAPSHOT)").matches(GSON_VERSION_PATTERN);
  }

  @Test
  public void testAssertionErrorInSerializationPrintsVersion() {
    AssertionError e = assertThrows(AssertionError.class, () -> gson.toJson(new TestType()));
    ensureAssertionErrorPrintsGsonVersion(e);
  }

  @Test
  public void testAssertionErrorInDeserializationPrintsVersion() {
    AssertionError e =
        assertThrows(AssertionError.class, () -> gson.fromJson("{'a':'abc'}", TestType.class));

    ensureAssertionErrorPrintsGsonVersion(e);
  }

  private static void ensureAssertionErrorPrintsGsonVersion(AssertionError expected) {
    String msg = expected.getMessage();
    // System.err.println(msg);
    int start = msg.indexOf("(GSON");
    assertThat(start > 0).isTrue();
    int end = msg.indexOf("):") + 1;
    assertThat(end > 0 && end > start + 6).isTrue();
    String version = msg.substring(start, end);
    // System.err.println(version);
    assertThat(version).matches(GSON_VERSION_PATTERN);
  }

  private static final class TestType {
    @SuppressWarnings("unused")
    String a;
  }
}