Skip to content

feat: [policytroubleshooter] include errors in troubleshoot response #9649

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.

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 2 commits into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions java-policy-troubleshooter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.16.0</version>
<version>26.18.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-stable-green
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-policy-troubleshooter.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-policy-troubleshooter/1.18.0
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-policy-troubleshooter/1.20.0
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,8 @@ public IamCheckerStub getStub() {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Checks whether a member has a specific permission for a specific resource, and explains why the
* member does or does not have that permission.
* Checks whether a principal has a specific permission for a specific resource, and explains why
* the principal does or does not have that permission.
*
* <p>Sample code:
*
Expand Down Expand Up @@ -197,8 +197,8 @@ public final TroubleshootIamPolicyResponse troubleshootIamPolicy(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Checks whether a member has a specific permission for a specific resource, and explains why the
* member does or does not have that permission.
* Checks whether a principal has a specific permission for a specific resource, and explains why
* the principal does or does not have that permission.
*
* <p>Sample code:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import com.google.api.gax.rpc.StatusCode;
import com.google.api.gax.rpc.testing.FakeStatusCode;
import com.google.cloud.policytroubleshooter.v1.stub.HttpJsonIamCheckerStub;
import com.google.rpc.Status;
import google.cloud.policytroubleshooter.v1.Explanations;
import java.io.IOException;
import java.util.ArrayList;
Expand Down Expand Up @@ -78,6 +79,7 @@ public void troubleshootIamPolicyTest() throws Exception {
TroubleshootIamPolicyResponse.newBuilder()
.setAccess(Explanations.AccessState.forNumber(0))
.addAllExplainedPolicies(new ArrayList<Explanations.ExplainedPolicy>())
.addAllErrors(new ArrayList<Status>())
.build();
mockService.addResponse(expectedResponse);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.InvalidArgumentException;
import com.google.protobuf.AbstractMessage;
import com.google.rpc.Status;
import google.cloud.policytroubleshooter.v1.Explanations;
import io.grpc.StatusRuntimeException;
import java.io.IOException;
Expand Down Expand Up @@ -83,6 +84,7 @@ public void troubleshootIamPolicyTest() throws Exception {
TroubleshootIamPolicyResponse.newBuilder()
.setAccess(Explanations.AccessState.forNumber(0))
.addAllExplainedPolicies(new ArrayList<Explanations.ExplainedPolicy>())
.addAllErrors(new ArrayList<Status>())
.build();
mockIamChecker.addResponse(expectedResponse);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,9 @@ public interface AsyncService {
*
*
* <pre>
* Checks whether a member has a specific permission for a specific resource,
* and explains why the member does or does not have that permission.
* Checks whether a principal has a specific permission for a specific
* resource, and explains why the principal does or does not have that
* permission.
* </pre>
*/
default void troubleshootIamPolicy(
Expand Down Expand Up @@ -191,8 +192,9 @@ protected IamCheckerStub build(io.grpc.Channel channel, io.grpc.CallOptions call
*
*
* <pre>
* Checks whether a member has a specific permission for a specific resource,
* and explains why the member does or does not have that permission.
* Checks whether a principal has a specific permission for a specific
* resource, and explains why the principal does or does not have that
* permission.
* </pre>
*/
public void troubleshootIamPolicy(
Expand Down Expand Up @@ -231,8 +233,9 @@ protected IamCheckerBlockingStub build(
*
*
* <pre>
* Checks whether a member has a specific permission for a specific resource,
* and explains why the member does or does not have that permission.
* Checks whether a principal has a specific permission for a specific
* resource, and explains why the principal does or does not have that
* permission.
* </pre>
*/
public com.google.cloud.policytroubleshooter.v1.TroubleshootIamPolicyResponse
Expand Down Expand Up @@ -266,8 +269,9 @@ protected IamCheckerFutureStub build(io.grpc.Channel channel, io.grpc.CallOption
*
*
* <pre>
* Checks whether a member has a specific permission for a specific resource,
* and explains why the member does or does not have that permission.
* Checks whether a principal has a specific permission for a specific
* resource, and explains why the principal does or does not have that
* permission.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,29 +49,30 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
+ "shooter.v1\0327google/cloud/policytroublesh"
+ "ooter/v1/explanations.proto\032\034google/api/"
+ "annotations.proto\032\027google/api/client.pro"
+ "to\"g\n\034TroubleshootIamPolicyRequest\022G\n\014ac"
+ "cess_tuple\030\001 \001(\01321.google.cloud.policytr"
+ "oubleshooter.v1.AccessTuple\"\265\001\n\035Troubles"
+ "hootIamPolicyResponse\022A\n\006access\030\001 \001(\01621."
+ "google.cloud.policytroubleshooter.v1.Acc"
+ "essState\022Q\n\022explained_policies\030\002 \003(\01325.g"
+ "oogle.cloud.policytroubleshooter.v1.Expl"
+ "ainedPolicy2\251\002\n\nIamChecker\022\301\001\n\025Troublesh"
+ "ootIamPolicy\022B.google.cloud.policytroubl"
+ "eshooter.v1.TroubleshootIamPolicyRequest"
+ "\032C.google.cloud.policytroubleshooter.v1."
+ "TroubleshootIamPolicyResponse\"\037\202\323\344\223\002\031\"\024/"
+ "v1/iam:troubleshoot:\001*\032W\312A#policytrouble"
+ "shooter.googleapis.com\322A.https://www.goo"
+ "gleapis.com/auth/cloud-platformB\226\002\n(com."
+ "google.cloud.policytroubleshooter.v1B\017IA"
+ "MCheckerProtoP\001Z\\cloud.google.com/go/pol"
+ "icytroubleshooter/apiv1/policytroublesho"
+ "oterpb;policytroubleshooterpb\370\001\001\252\002$Googl"
+ "e.Cloud.PolicyTroubleshooter.V1\312\002$Google"
+ "\\Cloud\\PolicyTroubleshooter\\V1\352\002\'Google:"
+ ":Cloud::PolicyTroubleshooter::V1P\000b\006prot"
+ "o3"
+ "to\032\027google/rpc/status.proto\"g\n\034Troublesh"
+ "ootIamPolicyRequest\022G\n\014access_tuple\030\001 \001("
+ "\01321.google.cloud.policytroubleshooter.v1"
+ ".AccessTuple\"\331\001\n\035TroubleshootIamPolicyRe"
+ "sponse\022A\n\006access\030\001 \001(\01621.google.cloud.po"
+ "licytroubleshooter.v1.AccessState\022Q\n\022exp"
+ "lained_policies\030\002 \003(\01325.google.cloud.pol"
+ "icytroubleshooter.v1.ExplainedPolicy\022\"\n\006"
+ "errors\030\003 \003(\0132\022.google.rpc.Status2\251\002\n\nIam"
+ "Checker\022\301\001\n\025TroubleshootIamPolicy\022B.goog"
+ "le.cloud.policytroubleshooter.v1.Trouble"
+ "shootIamPolicyRequest\032C.google.cloud.pol"
+ "icytroubleshooter.v1.TroubleshootIamPoli"
+ "cyResponse\"\037\202\323\344\223\002\031\"\024/v1/iam:troubleshoot"
+ ":\001*\032W\312A#policytroubleshooter.googleapis."
+ "com\322A.https://www.googleapis.com/auth/cl"
+ "oud-platformB\226\002\n(com.google.cloud.policy"
+ "troubleshooter.v1B\017IAMCheckerProtoP\001Z\\cl"
+ "oud.google.com/go/policytroubleshooter/a"
+ "piv1/policytroubleshooterpb;policytroubl"
+ "eshooterpb\370\001\001\252\002$Google.Cloud.PolicyTroub"
+ "leshooter.V1\312\002$Google\\Cloud\\PolicyTroubl"
+ "eshooter\\V1\352\002\'Google::Cloud::PolicyTroub"
+ "leshooter::V1P\000b\006proto3"
};
descriptor =
com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom(
Expand All @@ -80,6 +81,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
google.cloud.policytroubleshooter.v1.Explanations.getDescriptor(),
com.google.api.AnnotationsProto.getDescriptor(),
com.google.api.ClientProto.getDescriptor(),
com.google.rpc.StatusProto.getDescriptor(),
});
internal_static_google_cloud_policytroubleshooter_v1_TroubleshootIamPolicyRequest_descriptor =
getDescriptor().getMessageTypes().get(0);
Expand All @@ -95,7 +97,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
new com.google.protobuf.GeneratedMessageV3.FieldAccessorTable(
internal_static_google_cloud_policytroubleshooter_v1_TroubleshootIamPolicyResponse_descriptor,
new java.lang.String[] {
"Access", "ExplainedPolicies",
"Access", "ExplainedPolicies", "Errors",
});
com.google.protobuf.ExtensionRegistry registry =
com.google.protobuf.ExtensionRegistry.newInstance();
Expand All @@ -107,6 +109,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() {
google.cloud.policytroubleshooter.v1.Explanations.getDescriptor();
com.google.api.AnnotationsProto.getDescriptor();
com.google.api.ClientProto.getDescriptor();
com.google.rpc.StatusProto.getDescriptor();
}

// @@protoc_insertion_point(outer_class_scope)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
*
*
* <pre>
* Request for [TroubleshootIamPolicy][google.cloud.policytroubleshooter.v1.IamChecker.TroubleshootIamPolicy].
* Request for
* [TroubleshootIamPolicy][google.cloud.policytroubleshooter.v1.IamChecker.TroubleshootIamPolicy].
* </pre>
*
* Protobuf type {@code google.cloud.policytroubleshooter.v1.TroubleshootIamPolicyRequest}
Expand Down Expand Up @@ -66,8 +67,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -82,8 +83,8 @@ public boolean hasAccessTuple() {
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -100,8 +101,8 @@ public google.cloud.policytroubleshooter.v1.Explanations.AccessTuple getAccessTu
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand Down Expand Up @@ -284,7 +285,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Request for [TroubleshootIamPolicy][google.cloud.policytroubleshooter.v1.IamChecker.TroubleshootIamPolicy].
* Request for
* [TroubleshootIamPolicy][google.cloud.policytroubleshooter.v1.IamChecker.TroubleshootIamPolicy].
* </pre>
*
* Protobuf type {@code google.cloud.policytroubleshooter.v1.TroubleshootIamPolicyRequest}
Expand Down Expand Up @@ -483,8 +485,8 @@ public Builder mergeFrom(
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -498,8 +500,8 @@ public boolean hasAccessTuple() {
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -519,8 +521,8 @@ public google.cloud.policytroubleshooter.v1.Explanations.AccessTuple getAccessTu
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -543,8 +545,8 @@ public Builder setAccessTuple(
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -564,8 +566,8 @@ public Builder setAccessTuple(
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand Down Expand Up @@ -593,8 +595,8 @@ public Builder mergeAccessTuple(
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -613,8 +615,8 @@ public Builder clearAccessTuple() {
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -629,8 +631,8 @@ public Builder clearAccessTuple() {
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -649,8 +651,8 @@ public Builder clearAccessTuple() {
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ public interface TroubleshootIamPolicyRequestOrBuilder
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -40,8 +40,8 @@ public interface TroubleshootIamPolicyRequestOrBuilder
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand All @@ -53,8 +53,8 @@ public interface TroubleshootIamPolicyRequestOrBuilder
*
*
* <pre>
* The information to use for checking whether a member has a permission for a
* resource.
* The information to use for checking whether a principal has a permission
* for a resource.
* </pre>
*
* <code>.google.cloud.policytroubleshooter.v1.AccessTuple access_tuple = 1;</code>
Expand Down
Loading