docs: Adding Samples for printing all Acls for a file and for a specific user (#1288)

* docs: Adding Samples for printing all Acls for a file and for a specific user * Addressing PR comments * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: sydney-munro

README.md

@@ -56,13 +56,13 @@ implementation 'com.google.cloud:google-cloud-storage'
 If you are using Gradle without BOM, add this to your dependencies
 
 ```Groovy
-implementation 'com.google.cloud:google-cloud-storage:2.4.4'
+implementation 'com.google.cloud:google-cloud-storage:2.4.5'
 ```
 
 If you are using SBT, add this to your dependencies
 
 ```Scala
-libraryDependencies += "com.google.cloud" % "google-cloud-storage" % "2.4.4"
+libraryDependencies += "com.google.cloud" % "google-cloud-storage" % "2.4.5"
 ```
 
 ## Authentication
@@ -236,6 +236,8 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-storage/tree/
 | Remove Bucket Default Owner | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/bucket/RemoveBucketDefaultOwner.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-storage&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/storage/bucket/RemoveBucketDefaultOwner.java) |
 | Remove Bucket Owner | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/bucket/RemoveBucketOwner.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-storage&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/storage/bucket/RemoveBucketOwner.java) |
 | Add File Owner | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/object/AddFileOwner.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-storage&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/storage/object/AddFileOwner.java) |
+| Print File Acl | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/object/PrintFileAcl.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-storage&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/storage/object/PrintFileAcl.java) |
+| Print File Acl For User | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/object/PrintFileAclForUser.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-storage&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/storage/object/PrintFileAclForUser.java) |
 | Remove File Owner | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/object/RemoveFileOwner.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-storage&page=editor&open_in_editor=samples/snippets/src/main/java/com/example/storage/object/RemoveFileOwner.java) |
 
 

samples/snippets/src/main/java/com/example/storage/object/PrintFileAcl.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2022 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.example.storage.object;
+
+// [START storage_print_file_acl]
+
+import com.google.cloud.storage.Acl;
+import com.google.cloud.storage.Blob;
+import com.google.cloud.storage.BlobId;
+import com.google.cloud.storage.Storage;
+import com.google.cloud.storage.StorageOptions;
+import java.util.List;
+
+public class PrintFileAcl {
+
+ public static void printFileAcl(String bucketName, String blobName) {
+
+ // The ID to give your GCS bucket
+ // String bucketName = "your-unique-bucket-name";
+
+ // The name of the blob/file that you wish to view Acls of
+ // String blobName = "your-blob-name";
+
+ Storage storage = StorageOptions.newBuilder().build().getService();
+ Blob blob = storage.get(BlobId.of(bucketName, blobName));
+ List<Acl> blobAcls = blob.getAcl();
+
+ for (Acl acl : blobAcls) {
+
+ // This will give you the role.
+ // See https://cloud.google.com/storage/docs/access-control/lists#permissions
+ String role = acl.getRole().name();
+
+ // This will give you the Entity type (i.e. User, Group, Project etc.)
+ // See https://cloud.google.com/storage/docs/access-control/lists#scopes
+ String entityType = acl.getEntity().getType().name();
+
+ System.out.printf("%s: %s %n", role, entityType);
+ }
+ }
+}
+// [END storage_print_file_acl]

samples/snippets/src/main/java/com/example/storage/object/PrintFileAclForUser.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2022 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.example.storage.object;
+
+// [START storage_print_file_acl_for_user]
+
+import com.google.cloud.storage.Acl;
+import com.google.cloud.storage.Acl.User;
+import com.google.cloud.storage.Blob;
+import com.google.cloud.storage.BlobId;
+import com.google.cloud.storage.Storage;
+import com.google.cloud.storage.StorageOptions;
+
+public class PrintFileAclForUser {
+
+ public static void printFileAclForUser(String bucketName, String blobName, String userEmail) {
+
+ // The ID to give your GCS bucket
+ // String bucketName = "your-unique-bucket-name";
+
+ // The name of the blob/file that you wish to view Acls of
+ // String blobName = "your-blob-name";
+
+ // The email of the user whose acl is being retrieved.
+ // String userEmail = "someuser@domain.com"
+
+ Storage storage = StorageOptions.newBuilder().build().getService();
+ Blob blob = storage.get(BlobId.of(bucketName, blobName));
+ Acl blobAcl = blob.getAcl(new User(userEmail));
+ if (blobAcl != null) {
+ String userRole = blobAcl.getRole().name();
+ System.out.println("User " + userEmail + " has role " + userRole);
+ } else {
+ System.out.println("User " + userEmail + " not found");
+ }
+ }
+}
+// [END storage_print_file_acl_for_user]

samples/snippets/src/test/java/com/example/storage/object/PrintFileAclForUserTest.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2022 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.example.storage.object;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.junit.Assert.assertNotNull;
+
+import com.example.storage.TestBase;
+import com.google.cloud.storage.Acl;
+import com.google.cloud.storage.Acl.Entity;
+import com.google.cloud.storage.Acl.Role;
+import com.google.cloud.storage.Acl.User;
+import org.junit.Test;
+
+public class PrintFileAclForUserTest extends TestBase {
+
+ public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL");
+
+ @Test
+ public void testPrintBucketAclByUser() {
+ // Check for user email before the actual test.
+ assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL);
+
+ Entity testUser = new User(IT_SERVICE_ACCOUNT_EMAIL);
+ blob.createAcl(Acl.of(testUser, Role.READER));
+ PrintFileAclForUser.printFileAclForUser(bucketName, blobName, IT_SERVICE_ACCOUNT_EMAIL);
+ assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(IT_SERVICE_ACCOUNT_EMAIL);
+ assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(Role.READER.name());
+ }
+
+ @Test
+ public void testUserNotFound() {
+ // Check for user email before the actual test.
+ assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL);
+
+ // Delete Acl just in case to make sure the User ACL is not present
+ blob.deleteAcl(new User(IT_SERVICE_ACCOUNT_EMAIL));
+ PrintFileAclForUser.printFileAclForUser(bucketName, blobName, IT_SERVICE_ACCOUNT_EMAIL);
+ assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(IT_SERVICE_ACCOUNT_EMAIL);
+ assertThat(stdOut.getCapturedOutputAsUtf8String()).contains("not found");
+ }
+}

samples/snippets/src/test/java/com/example/storage/object/PrintFileAclTest.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2022 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.example.storage.object;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.junit.Assert.assertNotNull;
+
+import com.example.storage.TestBase;
+import com.google.cloud.storage.Acl;
+import com.google.cloud.storage.Acl.Entity;
+import com.google.cloud.storage.Acl.Role;
+import com.google.cloud.storage.Acl.User;
+import org.junit.Test;
+
+public class PrintFileAclTest extends TestBase {
+
+ public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL");
+
+ @Test
+ public void testPrintFileAcls() {
+ // Check for user email before the actual test.
+ assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL);
+
+ Entity testUser = new User(IT_SERVICE_ACCOUNT_EMAIL);
+ blob.createAcl(Acl.of(testUser, Role.READER));
+ PrintFileAcl.printFileAcl(bucketName, blobName);
+ assertThat(stdOut.getCapturedOutputAsUtf8String()).contains("READER: USER");
+ }
+}