-
Notifications
You must be signed in to change notification settings - Fork 93
docs: fix broken link for TESTING.md #2126
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| ## Testing code that uses Google Cloud Storage | ||
|
|
||
| `RemoteStorageHelper` contains convenience methods to make setting up and cleaning up the test buckets easier. To use this class: | ||
|
|
||
| 1. Create a test Google Cloud project. | ||
|
|
||
| 2. Download a JSON service account credentials file from the Google Developer's Console. See more about this on the [Google Cloud Platform Storage Authentication page][cloud-platform-storage-authentication]. | ||
|
|
||
| 3. Create a `RemoteStorageHelper` object using your project ID and JSON key. | ||
| Here is an example that uses the `RemoteStorageHelper` to create a bucket. | ||
| ```java | ||
| RemoteStorageHelper helper = | ||
| RemoteStorageHelper.create(PROJECT_ID, new FileInputStream("/path/to/my/JSON/key.json")); | ||
| Storage storage = helper.getOptions().getService(); | ||
| String bucket = RemoteStorageHelper.generateBucketName(); | ||
| storage.create(BucketInfo.of(bucket)); | ||
| ``` | ||
|
|
||
| 4. Run your tests. | ||
|
|
||
| 5. Clean up the test project by using `forceDelete` to clear any buckets used. | ||
| Here is an example that clears the bucket created in Step 3 with a timeout of 5 seconds. | ||
| ```java | ||
| RemoteStorageHelper.forceDelete(storage, bucket, 5, TimeUnit.SECONDS); | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't a complete story for Storage but it does resolve the broken link. I think there's an additional AI here to flesh this file out more?