sdks/java/core/src/test/java/org/apache/beam/SdkCoreApiSurfaceTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.beam;

import static org.apache.beam.sdk.util.ApiSurface.containsOnlyPackages;
import static org.hamcrest.MatcherAssert.assertThat;

import java.io.IOException;
import java.util.Set;
import org.apache.beam.sdk.util.ApiSurface;
import org.apache.beam.vendor.guava.v20_0.com.google.common.collect.ImmutableSet;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** API surface verification for {@link org.apache.beam}. */
@RunWith(JUnit4.class)
public class SdkCoreApiSurfaceTest {

  /**
   * All classes transitively reachable via only public method signatures of the SDK.
   *
   * <p>Note that our idea of "public" does not include various internal-only APIs.
   */
  public static ApiSurface getSdkApiSurface(final ClassLoader classLoader) throws IOException {
    return ApiSurface.ofPackage("org.apache.beam", classLoader)
        .pruningPattern("org[.]apache[.]beam[.].*Test")
        // Exposes Guava, but not intended for users
        .pruningClassName("org.apache.beam.sdk.util.common.ReflectHelpers")
        // test only
        .pruningClassName("org.apache.beam.sdk.testing.InterceptingUrlClassLoader")
        // test only
        .pruningPrefix("org.apache.beam.model.")
        .pruningPrefix("org.apache.beam.vendor.")
        .pruningPrefix("java");
  }

  @Test
  public void testSdkApiSurface() throws Exception {

    @SuppressWarnings("unchecked")
    final Set<String> allowed =
        ImmutableSet.of(
            "org.apache.beam",
            "com.fasterxml.jackson.annotation",
            "com.fasterxml.jackson.core",
            "com.fasterxml.jackson.databind",
            "org.apache.avro",
            "org.hamcrest",
            // via DataflowMatchers
            "org.codehaus.jackson",
            // via Avro
            "org.joda.time",
            "org.junit");

    assertThat(getSdkApiSurface(getClass().getClassLoader()), containsOnlyPackages(allowed));
  }
}