Skip to content

xds: temporary flag protection of GcpAuthenticationFilter #12075

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

Merged
merged 5 commits into from
May 22, 2025
Merged

xds: temporary flag protection of GcpAuthenticationFilter #12075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
56250b6
xds: Add GcpAuthenticationFilter to FilterRegistry
shivaspeaks May 16, 2025
c8d41dd
guard by flag
shivaspeaks May 19, 2025
16d5679
use method instead of const
shivaspeaks May 19, 2025
3a008b9
address comment
shivaspeaks May 20, 2025
6b59c2c
address comment
shivaspeaks May 22, 2025
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
7 changes: 7 additions & 0 deletions xds/src/main/java/io/grpc/xds/FilterRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package io.grpc.xds;

import com.google.common.annotations.VisibleForTesting;
import io.grpc.internal.GrpcUtil;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.Nullable;
Expand All @@ -32,12 +33,18 @@

private FilterRegistry() {}

static boolean isEnabledGcpAuthnFilter =
GrpcUtil.getFlag("GRPC_EXPERIMENTAL_XDS_GCP_AUTHENTICATION_FILTER", false);

static synchronized FilterRegistry getDefaultRegistry() {
if (instance == null) {
instance = newRegistry().register(
new FaultFilter.Provider(),
new RouterFilter.Provider(),
new RbacFilter.Provider());
if (isEnabledGcpAuthnFilter) {
instance.register(new GcpAuthenticationFilter.Provider());

Check warning on line 46 in xds/src/main/java/io/grpc/xds/FilterRegistry.java

View check run for this annotation

Codecov / codecov/patch

xds/src/main/java/io/grpc/xds/FilterRegistry.java#L46 

Added line #L46 was not covered by tests
}
}
return instance;
}
Expand Down
5 changes: 5 additions & 0 deletions xds/src/main/java/io/grpc/xds/GcpAuthenticationFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package io.grpc.xds;

import static com.google.common.base.Preconditions.checkNotNull;
import static io.grpc.xds.FilterRegistry.isEnabledGcpAuthnFilter;
import static io.grpc.xds.XdsNameResolver.CLUSTER_SELECTION_KEY;
import static io.grpc.xds.XdsNameResolver.XDS_CONFIG_CALL_OPTION_KEY;

Expand Down Expand Up @@ -312,6 +313,10 @@
public AudienceWrapper parse(Any any) throws ResourceInvalidException {
Audience audience;
try {
if (!isEnabledGcpAuthnFilter) {
throw new InvalidProtocolBufferException("Environment variable for GCP Authentication "

Check warning on line 317 in xds/src/main/java/io/grpc/xds/GcpAuthenticationFilter.java

View check run for this annotation

Codecov / codecov/patch

xds/src/main/java/io/grpc/xds/GcpAuthenticationFilter.java#L317 

Added line #L317 was not covered by tests
+ "Filter is Not Set");
}
audience = any.unpack(Audience.class);
} catch (InvalidProtocolBufferException ex) {
throw new ResourceInvalidException("Invalid Resource in address proto", ex);
Expand Down
6 changes: 6 additions & 0 deletions xds/src/test/java/io/grpc/xds/GcpAuthenticationFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
Expand All @@ -89,6 +90,11 @@ public class GcpAuthenticationFilterTest {
private static final RdsUpdate rdsUpdate = getRdsUpdate();
private static final CdsUpdate cdsUpdate = getCdsUpdate();

@Before
public void setUp() {
System.setProperty("GRPC_EXPERIMENTAL_XDS_GCP_AUTHENTICATION_FILTER", "true");
}

@Test
public void testNewFilterInstancesPerFilterName() {
assertThat(new GcpAuthenticationFilter("FILTER_INSTANCE_NAME1", 10))
Expand Down
13 changes: 9 additions & 4 deletions xds/src/test/java/io/grpc/xds/GrpcXdsClientImplDataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2417,6 +2417,7 @@ public Object parse(Any value) {

@Test
public void processCluster_parsesAudienceMetadata() throws Exception {
FilterRegistry.isEnabledGcpAuthnFilter = true;
Copy link
Contributor

Choose a reason for hiding this comment

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

Use try - finally to undo this setting before the test exits. Example
Also in the other test case.

MetadataRegistry.getInstance();

Audience audience = Audience.newBuilder()
Expand Down Expand Up @@ -2460,10 +2461,14 @@ public void processCluster_parsesAudienceMetadata() throws Exception {
"FILTER_METADATA", ImmutableMap.of(
"key1", "value1",
"key2", 42.0));
assertThat(update.parsedMetadata().get("FILTER_METADATA"))
.isEqualTo(expectedParsedMetadata.get("FILTER_METADATA"));
assertThat(update.parsedMetadata().get("AUDIENCE_METADATA"))
.isInstanceOf(AudienceWrapper.class);
try {
assertThat(update.parsedMetadata().get("FILTER_METADATA"))
.isEqualTo(expectedParsedMetadata.get("FILTER_METADATA"));
assertThat(update.parsedMetadata().get("AUDIENCE_METADATA"))
.isInstanceOf(AudienceWrapper.class);
} finally {
FilterRegistry.isEnabledGcpAuthnFilter = false;
}
}

@Test
Expand Down