Skip to content
This repository has been archived by the owner on Dec 3, 2023. It is now read-only.

Commit

Permalink
fix: make title and description of Condition Nullable
Browse files Browse the repository at this point in the history
According to https://cloud.google.com/iam/docs/conditions-overview#syntax_overview both title and description are optional.

Currently, AutoValue treats these fields as non-null which goes against the definition from the API.

This change may be considered breaking by some criteria, however this class is annotated @BetaApi.
  • Loading branch information
BenWhitehead committed Jan 3, 2023
1 parent e7159c2 commit 419a713
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

import com.google.api.core.BetaApi;
import com.google.auto.value.AutoValue;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
* Class for Identity and Access Management (IAM) policies. IAM policies are used to specify access
Expand All @@ -32,9 +33,11 @@
@AutoValue
public abstract class Condition {
/** Get IAM Policy Binding Condition Title */
@Nullable
public abstract String getTitle();

/** Get IAM Policy Binding Condition Description */
@Nullable
public abstract String getDescription();

/** Get IAM Policy Binding Condition Expression */
Expand All @@ -51,10 +54,10 @@ public static Builder newBuilder() {
@AutoValue.Builder
public abstract static class Builder {
/** Set IAM Policy Binding Condition Title */
public abstract Builder setTitle(String title);
public abstract Builder setTitle(@Nullable String title);

/** Set IAM Policy Binding Condition Description */
public abstract Builder setDescription(String description);
public abstract Builder setDescription(@Nullable String description);

/** Set IAM Policy Binding Condition Expression */
public abstract Builder setExpression(String expression);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
* Copyright 2023 Google LLC
*
* 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.cloud;

import static com.google.common.truth.Truth.assertThat;

import org.junit.Test;

public final class ConditionTest {

@Test
public void title_nullable() {
Condition condition =
Condition.newBuilder().setTitle(null).setDescription("desc").setExpression("expr").build();

assertThat(condition.getTitle()).isNull();
}

@Test
public void description_nullable() {
Condition condition =
Condition.newBuilder().setTitle("title").setDescription(null).setExpression("expr").build();

assertThat(condition.getDescription()).isNull();
}
}

0 comments on commit 419a713

Please sign in to comment.