Skip to content

Commit d82333b

Browse files
sydney-munrogcf-owl-bot[bot]BenWhitehead
authored
docs: Adding Samples for Printing Bucket ACLs and Printing Bucket ACL for a specific user. (#1236)
Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
1 parent 6b08589 commit d82333b

8 files changed

Lines changed: 247 additions & 1 deletion

File tree

‎.kokoro/presubmit/samples.cfg‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,9 @@ env_vars: {
3030
env_vars: {
3131
key: "SECRET_MANAGER_KEYS"
3232
value: "java-docs-samples-service-account"
33-
}
33+
}
34+
35+
env_vars: {
36+
key: "IT_SERVICE_ACCOUNT_EMAIL"
37+
value: "java-docs-samples-testing@java-docs-samples-testing.iam.gserviceaccount.com"
38+
}

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,8 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-storage/tree/
229229
| --------------------------- | --------------------------------- | ------ |
230230
| Configure Retries | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/ConfigureRetries.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/ConfigureRetries.java) |
231231
| Quickstart Sample | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/QuickstartSample.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/QuickstartSample.java) |
232+
| Print Bucket Acl | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/bucket/PrintBucketAcl.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/PrintBucketAcl.java) |
233+
| Print Bucket Acl Filter By User | [source code](https://github.com/googleapis/java-storage/blob/main/samples/snippets/src/main/java/com/example/storage/bucket/PrintBucketAclFilterByUser.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/PrintBucketAclFilterByUser.java) |
232234

233235

234236

‎owlbot.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,6 @@
3131
'.kokoro/nightly/integration.cfg',
3232
'.kokoro/nightly/java11-integration.cfg',
3333
'.kokoro/presubmit/integration.cfg',
34+
'.kokoro/presubmit/samples.cfg',
3435
'CONTRIBUTING.md'
3536
])

‎samples/snippets/src/main/java/com/example/storage/bucket/PrintBucketAcl.java‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.example.storage.bucket;
18+
19+
// [START storage_print_bucket_acl]
20+
21+
import com.google.cloud.storage.Acl;
22+
import com.google.cloud.storage.Bucket;
23+
import com.google.cloud.storage.Storage;
24+
import com.google.cloud.storage.StorageOptions;
25+
import java.util.List;
26+
27+
public class PrintBucketAcl {
28+
29+
public static void printBucketAcl(String bucketName) {
30+
31+
// The ID to give your GCS bucket
32+
// String bucketName = "your-unique-bucket-name";
33+
34+
Storage storage = StorageOptions.newBuilder().build().getService();
35+
Bucket bucket = storage.get(bucketName);
36+
List<Acl> bucketAcls = bucket.getAcl();
37+
38+
for (Acl acl : bucketAcls) {
39+
40+
// This will give you the role.
41+
// See https://cloud.google.com/storage/docs/access-control/lists#permissions
42+
String role = acl.getRole().name();
43+
44+
// This will give you the Entity type (i.e. User, Group, Project etc.)
45+
// See https://cloud.google.com/storage/docs/access-control/lists#scopes
46+
String entityType = acl.getEntity().getType().name();
47+
48+
System.out.printf("%s: %s \n", role, entityType);
49+
}
50+
}
51+
}
52+
// [END storage_print_bucket_acl]

‎samples/snippets/src/main/java/com/example/storage/bucket/PrintBucketAclFilterByUser.java‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/*
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.example.storage.bucket;
18+
19+
// [START storage_print_bucket_acl_for_user]
20+
21+
import com.google.cloud.storage.Acl;
22+
import com.google.cloud.storage.Acl.User;
23+
import com.google.cloud.storage.Bucket;
24+
import com.google.cloud.storage.Storage;
25+
import com.google.cloud.storage.StorageOptions;
26+
27+
public class PrintBucketAclFilterByUser {
28+
29+
public static void printBucketAclFilterByUser(String bucketName, String userEmail) {
30+
31+
// The ID to give your GCS bucket
32+
// String bucketName = "your-unique-bucket-name";
33+
34+
// The email of the user whose acl is being retrieved.
35+
// String userEmail = "someuser@domain.com"
36+
37+
Storage storage = StorageOptions.newBuilder().build().getService();
38+
Bucket bucket = storage.get(bucketName);
39+
40+
Acl userAcl = bucket.getAcl(new User(userEmail));
41+
String userRole = userAcl.getRole().name();
42+
System.out.println("User " + userEmail + " has role " + userRole);
43+
}
44+
}
45+
46+
// [END storage_print_bucket_acl_for_user]

‎samples/snippets/src/test/java/com/example/storage/TestBase.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/*
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.example.storage;
18+
19+
import com.google.cloud.storage.Blob;
20+
import com.google.cloud.storage.BlobInfo;
21+
import com.google.cloud.storage.BucketInfo;
22+
import com.google.cloud.storage.Storage;
23+
import com.google.cloud.storage.StorageOptions;
24+
import com.google.cloud.storage.testing.RemoteStorageHelper;
25+
import com.google.cloud.testing.junit4.StdOutCaptureRule;
26+
import org.junit.After;
27+
import org.junit.Before;
28+
import org.junit.Rule;
29+
30+
public abstract class TestBase {
31+
32+
@Rule public StdOutCaptureRule stdOut = new StdOutCaptureRule();
33+
34+
protected String bucketName;
35+
protected Storage storage;
36+
protected String blobName;
37+
38+
protected Blob blob;
39+
40+
@Before
41+
public void setUp() {
42+
blobName = "blob";
43+
bucketName = RemoteStorageHelper.generateBucketName();
44+
storage = StorageOptions.getDefaultInstance().getService();
45+
storage.create(BucketInfo.of(bucketName));
46+
blob = storage.create(BlobInfo.newBuilder(bucketName, blobName).build());
47+
}
48+
49+
@After
50+
public void tearDown() {
51+
RemoteStorageHelper.forceDelete(storage, bucketName);
52+
}
53+
}

‎samples/snippets/src/test/java/com/example/storage/bucket/PrintBucketAclFilterByUserTest.java‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
/*
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.example.storage.bucket;
18+
19+
import static com.google.common.truth.Truth.assertThat;
20+
import static org.junit.Assert.assertNotNull;
21+
22+
import com.example.storage.TestBase;
23+
import com.google.cloud.storage.Acl;
24+
import com.google.cloud.storage.Acl.Entity;
25+
import com.google.cloud.storage.Acl.Role;
26+
import com.google.cloud.storage.Acl.User;
27+
import org.junit.Test;
28+
29+
public class PrintBucketAclFilterByUserTest extends TestBase {
30+
31+
public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL");
32+
33+
@Test
34+
public void testPrintBucketAclByUser() {
35+
// Check for user email before the actual test.
36+
assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL);
37+
38+
Entity testUser = new User(IT_SERVICE_ACCOUNT_EMAIL);
39+
storage.createAcl(bucketName, Acl.of(testUser, Role.READER));
40+
PrintBucketAclFilterByUser.printBucketAclFilterByUser(bucketName, IT_SERVICE_ACCOUNT_EMAIL);
41+
assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(IT_SERVICE_ACCOUNT_EMAIL);
42+
assertThat(stdOut.getCapturedOutputAsUtf8String()).contains(Role.READER.name());
43+
}
44+
}

‎samples/snippets/src/test/java/com/example/storage/bucket/PrintBucketAclTest.java‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.example.storage.bucket;
18+
19+
import static com.google.common.truth.Truth.assertThat;
20+
import static org.junit.Assert.assertNotNull;
21+
22+
import com.example.storage.TestBase;
23+
import com.google.cloud.storage.Acl;
24+
import com.google.cloud.storage.Acl.Entity;
25+
import com.google.cloud.storage.Acl.Role;
26+
import com.google.cloud.storage.Acl.User;
27+
import org.junit.Test;
28+
29+
public class PrintBucketAclTest extends TestBase {
30+
31+
public static final String IT_SERVICE_ACCOUNT_EMAIL = System.getenv("IT_SERVICE_ACCOUNT_EMAIL");
32+
33+
@Test
34+
public void testPrintBucketAcls() {
35+
// Check for user email before the actual test.
36+
assertNotNull("Unable to determine user email", IT_SERVICE_ACCOUNT_EMAIL);
37+
38+
Entity testUser = new User(IT_SERVICE_ACCOUNT_EMAIL);
39+
storage.createAcl(bucketName, Acl.of(testUser, Role.READER));
40+
PrintBucketAcl.printBucketAcl(bucketName);
41+
assertThat(stdOut.getCapturedOutputAsUtf8String()).contains("READER: USER");
42+
}
43+
}

0 commit comments

Comments
 (0)