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

Commit

Permalink
feat: support conditional policies (#110)
Browse files Browse the repository at this point in the history
* Base implementation

* Update with unit tests

* lint

* correct copyright date

* lint

* Revert removal of helper functions

* use auto-value

* reformat Binding.java and Condition.java

* remove unnecessary dep

* code format

* add dep on com.google.code.findbugs in google-cloud-core

* address comments

* Clean up

* respond to comments

* address comments

* format

* address feedback

* remove unnecessary null check

* lint

* address feedback

* remove ImmutableList from Binding AutoValue surface

* address feedback

* split up unit test

* use guava beta annotation

* surface ImmutableList<> for Binding class.

* use BetaApi from api.core

* return as expected

* partial addressing of feedback

* address feedback pt2

* address remaining feedback

* address one last feedback
  • Loading branch information
frankyn authored Feb 27, 2020
1 parent 28c9859 commit 61e2d19
Show file tree
Hide file tree
Showing 7 changed files with 682 additions and 79 deletions.
8 changes: 8 additions & 0 deletions google-cloud-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@
<groupId>com.google.api</groupId>
<artifactId>gax</artifactId>
</dependency>
<dependency>
<groupId>com.google.auto.value</groupId>
<artifactId>auto-value-annotations</artifactId>
</dependency>
<dependency>
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java-util</artifactId>
Expand Down Expand Up @@ -83,6 +87,10 @@
<artifactId>objenesis</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.code.findbugs</groupId>
<artifactId>jsr305</artifactId>
</dependency>
<dependency>
<groupId>com.google.truth</groupId>
<artifactId>truth</artifactId>
Expand Down
112 changes: 112 additions & 0 deletions google-cloud-core/src/main/java/com/google/cloud/Binding.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
/*
* Copyright 2020 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.base.Predicates.in;
import static com.google.common.base.Predicates.not;

import com.google.api.core.BetaApi;
import com.google.auto.value.AutoValue;
import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import javax.annotation.Nullable;

/**
* Class for Identity and Access Management (IAM) policies. IAM policies are used to specify access
* settings for Cloud Platform resources. A policy is a list of bindings. A binding assigns a set of
* identities to a role, where the identities can be user accounts, Google groups, Google domains,
* and service accounts. A role is a named list of permissions defined by IAM.
*
* @see <a href="https://cloud.google.com/iam/docs/reference/rest/v1/Policy">Policy</a>
*/
@BetaApi("This is a Beta API is not stable yet and may change in the future.")
@AutoValue
public abstract class Binding {
/** Get IAM Policy Binding Role */
public abstract String getRole();

/** Get IAM Policy Binding Members */
public abstract ImmutableList<String> getMembers();

/** Get IAM Policy Binding Condition */
@Nullable
public abstract Condition getCondition();

/** Create a Binding.Builder from an existing Binding */
public abstract Builder toBuilder();

/** Create a new Binding.Builder */
public static Builder newBuilder() {
List<String> emptyMembers = ImmutableList.of();
return new AutoValue_Binding.Builder().setMembers(emptyMembers);
}

@AutoValue.Builder
public abstract static class Builder {
/**
* Set IAM Role for Policy Binding
*
* @throws NullPointerException if the role is null.
*/
public abstract Builder setRole(String role);

/**
* Set IAM Members for Policy Binding
*
* @throws NullPointerException if a member is null.
*/
public abstract Builder setMembers(Iterable<String> members);

/** Set IAM Condition for Policy Binding */
public abstract Builder setCondition(Condition condition);

/** Internal use to getMembers() in addMembers() and removeMembers() */
abstract ImmutableList<String> getMembers();

/**
* Add members to Policy Binding.
*
* @throws NullPointerException if a member is null.
*/
public Builder addMembers(String member, String... moreMembers) {
ImmutableList.Builder<String> membersBuilder = ImmutableList.builder();
membersBuilder.addAll(getMembers());
membersBuilder.addAll(Lists.asList(member, moreMembers));
setMembers(membersBuilder.build());
return this;
}

/**
* Remove members to Policy Binding.
*
* @throws NullPointerException if a member is null.
*/
public Builder removeMembers(String... members) {
Predicate<String> selectMembersNotInList = not(in(Arrays.asList(members)));
Collection<String> filter = Collections2.filter(getMembers(), selectMembersNotInList);
setMembers(filter);
return this;
}

public abstract Binding build();
}
}
65 changes: 65 additions & 0 deletions google-cloud-core/src/main/java/com/google/cloud/Condition.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
* Copyright 2020 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 com.google.api.core.BetaApi;
import com.google.auto.value.AutoValue;

/**
* Class for Identity and Access Management (IAM) policies. IAM policies are used to specify access
* settings for Cloud Platform resources. A policy is a list of bindings. A binding assigns a set of
* identities to a role, where the identities can be user accounts, Google groups, Google domains,
* and service accounts. A role is a named list of permissions defined by IAM.
*
* @see <a href="https://cloud.google.com/iam/docs/reference/rest/v1/Policy">Policy</a>
* @see <a href="https://cloud.google.com/iam/docs/conditions-overview">IAM Conditions</a>
*/
@BetaApi("This is a Beta API is not stable yet and may change in the future.")
@AutoValue
public abstract class Condition {
/** Get IAM Policy Binding Condition Title */
public abstract String getTitle();

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

/** Get IAM Policy Binding Condition Expression */
public abstract String getExpression();

/** Create a new Condition.Builder from an existing Condition */
public abstract Builder toBuilder();

/** Create a new Condition.Builder */
public static Builder newBuilder() {
return new AutoValue_Condition.Builder();
}

@AutoValue.Builder
public abstract static class Builder {
/** Set IAM Policy Binding Condition Title */
public abstract Builder setTitle(String title);

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

/** Set IAM Policy Binding Condition Expression */
public abstract Builder setExpression(String expression);

/** Build Builder which creates a Condition instance */
public abstract Condition build();
}
}
Loading

0 comments on commit 61e2d19

Please sign in to comment.