test/doclava/ApiCheckTest.java

/*
 * Copyright (C) 2010 Google Inc.
 *
 * 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 doclava;

import com.google.doclava.Errors;
import com.google.doclava.Errors.ErrorMessage;
import com.google.doclava.apicheck.ApiCheck;
import com.google.doclava.apicheck.ApiCheck.Report;

import org.junit.Before;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertTrue;

import java.util.Iterator;

public class ApiCheckTest {

  @Before
  public void setUp() {
    // Clear all errors and make sure all future errors will be recorded.
    Errors.clearErrors();
    for (Errors.Error error : Errors.sErrors) {
      Errors.setErrorLevel(error.code, Errors.ERROR);
    }
  }

  @Test
  public void testEquivalentApi() {
    String[] args = { "test/api/medium.xml", "test/api/medium.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(report.errors().size(), 0);
  }

  @Test
  public void testMethodReturnTypeChanged() {
    String[] args = { "test/api/return-type-changed-1.xml", "test/api/return-type-changed-2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_TYPE, report.errors().iterator().next().error());
  }

  @Test
  public void testMethodParameterChanged() {
    String[] args = { "test/api/parameter-changed-1.xml", "test/api/parameter-changed-2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(2, report.errors().size());

    Iterator<ErrorMessage> errors = report.errors().iterator();
    ErrorMessage m1 = errors.next();
    ErrorMessage m2 = errors.next();
    assertNotSame(m1.error(), m2.error());
    assertTrue(m1.error().equals(Errors.ADDED_METHOD) || m1.error().equals(Errors.REMOVED_METHOD));
    assertTrue(m2.error().equals(Errors.ADDED_METHOD) || m2.error().equals(Errors.REMOVED_METHOD));
  }

  @Test
  public void testConstructorParameterChanged() {
    String[] args = { "test/api/parameter-changed-1.xml", "test/api/parameter-changed-3.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(2, report.errors().size());
    Iterator<ErrorMessage> errors = report.errors().iterator();
    ErrorMessage m1 = errors.next();
    ErrorMessage m2 = errors.next();
    assertNotSame(m1.error(), m2.error());
    assertTrue(m1.error().equals(Errors.ADDED_METHOD) || m1.error().equals(Errors.REMOVED_METHOD));
    assertTrue(m2.error().equals(Errors.ADDED_METHOD) || m2.error().equals(Errors.REMOVED_METHOD));
  }

  @Test
  public void testAddedClass() {
    String[] args = { "test/api/simple.xml", "test/api/added-class.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.ADDED_CLASS, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedClass() {
    String[] args = { "test/api/added-class.xml", "test/api/simple.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_CLASS, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedDeprecatedClass() {
    String[] args = { "test/api/added-deprecated-class.xml", "test/api/simple.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_DEPRECATED_CLASS, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedSuper() {
    String[] args = { "test/api/simple.xml", "test/api/changed-super.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_SUPERCLASS, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedAssignableReturn() {
    String[] args = {
        "test/api/changed-assignable-return-1.xml",
        "test/api/changed-assignable-return-2.xml"
    };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_TYPE, report.errors().iterator().next().error());
  }

  @Test
  public void testInsertedSuper() {
    String[] args = { "test/api/inserted-super-1.xml", "test/api/inserted-super-2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(0, report.errors().size());
  }

  @Test
  public void testAddedInterface() {
    String[] args = { "test/api/removed-interface.xml", "test/api/medium.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.ADDED_INTERFACE, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedInterface() {
    String[] args = { "test/api/medium.xml", "test/api/removed-interface.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_INTERFACE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedAbstractClass() {
    String[] args = { "test/api/medium.xml", "test/api/changed-abstract.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_ABSTRACT, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedAbstractClass2() {
    String[] args = { "test/api/changed-abstract.xml", "test/api/medium.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_ABSTRACT, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedAbstractMethod() {
    String[] args = { "test/api/medium.xml", "test/api/changed-abstract2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_ABSTRACT, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedAbstractMethod2() {
    String[] args = { "test/api/changed-abstract2.xml", "test/api/medium.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_ABSTRACT, report.errors().iterator().next().error());
  }

  @Test
  public void testAddedPackage() {
    String[] args = { "test/api/medium.xml", "test/api/added-package.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.ADDED_PACKAGE, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedPackage() {
    String[] args = { "test/api/added-package.xml", "test/api/medium.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_PACKAGE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedValue() {
    String[] args = { "test/api/constants.xml", "test/api/changed-value.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_VALUE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedValue2() {
    String[] args = { "test/api/constants.xml", "test/api/changed-value2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_VALUE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedType() {
    String[] args = { "test/api/constants.xml", "test/api/changed-type.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_TYPE, report.errors().iterator().next().error());
  }

  @Test
  public void testAddedFinalField() {
    String[] args = { "test/api/constants.xml", "test/api/changed-final.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.ADDED_FINAL, report.errors().iterator().next().error());
  }

  @Test
  public void testAddedFinalMethod() {
    String[] args = { "test/api/constants.xml", "test/api/changed-final2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.ADDED_FINAL, report.errors().iterator().next().error());
  }

  @Test
  public void testAddedFinalClass() {
    String[] args = { "test/api/constants.xml", "test/api/changed-final3.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    // One error for the class, one for the constructor, one for the method.
    assertEquals(3, report.errors().size());
    assertEquals(Errors.ADDED_FINAL, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedFinalClass() {
    String[] args = { "test/api/changed-final3.xml", "test/api/constants.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    // One error for the class, one for the constructor, one for the method.
    assertEquals(3, report.errors().size());
    assertEquals(Errors.REMOVED_FINAL, report.errors().iterator().next().error());
  }

  @Test
  public void testAddedField() {
    String[] args = { "test/api/constants.xml", "test/api/added-field.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.ADDED_FIELD, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedField() {
    String[] args = { "test/api/added-field.xml", "test/api/constants.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_FIELD, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedDeprecatedField() {
    String[] args = { "test/api/added-deprecated-field.xml", "test/api/constants.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_DEPRECATED_FIELD, report.errors().iterator().next().error());
  }

  @Test
  public void testAddedMethod() {
    String[] args = { "test/api/constants.xml", "test/api/added-method.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.ADDED_METHOD, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedMethod() {
    String[] args = { "test/api/added-method.xml", "test/api/constants.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_METHOD, report.errors().iterator().next().error());
  }

  @Test
  public void testRemovedDeprecatedMethod() {
    String[] args = { "test/api/added-deprecated-method.xml", "test/api/constants.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.REMOVED_DEPRECATED_METHOD, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedStaticMethod() {
    String[] args = { "test/api/constants.xml", "test/api/changed-static.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_STATIC, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedStaticClass() {
    String[] args = { "test/api/constants.xml", "test/api/changed-static2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_STATIC, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedStaticField() {
    String[] args = { "test/api/constants.xml", "test/api/changed-static3.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_STATIC, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedTransient() {
    String[] args = { "test/api/constants.xml", "test/api/changed-transient.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_TRANSIENT, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedSynchronized() {
    String[] args = { "test/api/constants.xml", "test/api/changed-synchronized.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
  }

  @Test
  public void testChangedVolatile() {
    String[] args = { "test/api/constants.xml", "test/api/changed-volatile.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_VOLATILE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedNative() {
    String[] args = { "test/api/constants.xml", "test/api/changed-native.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_NATIVE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedScopeMethod() {
    String[] args = { "test/api/constants.xml", "test/api/changed-scope.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_SCOPE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedScopeClass() {
    String[] args = { "test/api/changed-scope.xml", "test/api/constants.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_SCOPE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedScopeClass2() {
    String[] args = { "test/api/constants.xml", "test/api/changed-scope2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_SCOPE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedScopeField() {
    String[] args = { "test/api/constants.xml", "test/api/changed-scope3.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_SCOPE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedConstructorScope() {
    String[] args = { "test/api/constants.xml", "test/api/changed-scope4.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_SCOPE, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedMethodThrows() {
    String[] args = { "test/api/throws.xml", "test/api/removed-exception.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_THROWS, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedMethodThrows2() {
    String[] args = { "test/api/removed-exception.xml", "test/api/throws.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_THROWS, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedConstructorThrows() {
    String[] args = { "test/api/throws.xml", "test/api/added-exception.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_THROWS, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedConstructorThrows2() {
    String[] args = { "test/api/added-exception.xml", "test/api/throws.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_THROWS, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedMethodDeprecated() {
    String[] args = { "test/api/constants.xml", "test/api/changed-deprecated.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_DEPRECATED, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedConstructorDeprecated() {
    String[] args = { "test/api/constants.xml", "test/api/changed-deprecated2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_DEPRECATED, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedFieldDeprecated() {
    String[] args = { "test/api/constants.xml", "test/api/changed-deprecated3.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_DEPRECATED, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedClassToInterface() {
    String[] args = { "test/api/changed-class-info2.xml", "test/api/changed-class-info.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_CLASS, report.errors().iterator().next().error());
  }

  @Test
  public void testChangedInterfaceToClass() {
    String[] args = { "test/api/changed-class-info.xml", "test/api/changed-class-info2.xml" };
    ApiCheck apiCheck = new ApiCheck();
    Report report = apiCheck.checkApi(args);
    assertEquals(1, report.errors().size());
    assertEquals(Errors.CHANGED_CLASS, report.errors().iterator().next().error());
  }
}