Skip to content

Improve Pruning performed by the DirectRunnerApiSurfaceTest #3019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tgroh wants to merge 1 commit into from
Closed

Improve Pruning performed by the DirectRunnerApiSurfaceTest #3019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions .../direct-java/src/test/java/org/apache/beam/runners/direct/DirectRunnerApiSurfaceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@

import com.google.common.collect.ImmutableSet;
import java.util.Set;
import javax.annotation.Nullable;
import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.PipelineRunner;
import org.apache.beam.sdk.metrics.MetricResults;
import org.apache.beam.sdk.options.PipelineOptions;
import org.apache.beam.sdk.options.PipelineOptionsRegistrar;
import org.apache.beam.sdk.transforms.display.DisplayData;
import org.apache.beam.sdk.util.ApiSurface;
import org.junit.Test;
import org.junit.runner.RunWith;
Expand All @@ -43,9 +48,17 @@ public void testDirectRunnerApiSurface() throws Exception {
final ClassLoader thisClassLoader = getClass().getClassLoader();
ApiSurface apiSurface =
ApiSurface.ofPackage(thisPackage, thisClassLoader)
// Do not include dependencies that are required based on the known exposures. This
// could alternatively prune everything exposed by the public parts of the Core SDK
.pruningClass(Pipeline.class)
Copy link
Member

@kennknowles kennknowles May 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems OK, though org.apache.beam.sdk is already allowed so it should be made automatic. Perhaps this is part of BEAM-2231, making is lazy. Whenever you arrive at a class that is allowed, it should be presumed anything reachable from there is also allowed. Of course, this would make us miss when one of our dependencies mistakenly exposes Guava, for example.

.pruningClass(PipelineRunner.class)
.pruningClass(PipelineOptions.class)
.pruningClass(PipelineOptionsRegistrar.class)
.pruningClass(PipelineOptions.DirectRunner.class)
.pruningClass(DisplayData.Builder.class)
.pruningClass(MetricResults.class)
.pruningPattern("org[.]apache[.]beam[.].*Test.*")
.pruningPattern("org[.]apache[.]beam[.].*IT")
.pruningClass(Nullable.class)
.pruningPattern("java[.]io.*")
.pruningPattern("java[.]lang.*")
.pruningPattern("java[.]util.*");
Expand Down