-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
[credentialhelper] Implement invoking credential helper as subprocess #15861
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 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
This file contains 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
75 changes: 75 additions & 0 deletions
75
...om/google/devtools/build/lib/authandtls/credentialhelper/CredentialHelperEnvironment.java
This file contains 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,75 @@ | ||
// Copyright 2022 The Bazel Authors. All rights reserved. | ||
// | ||
// 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.devtools.build.lib.authandtls.credentialhelper; | ||
|
||
import com.google.auto.value.AutoValue; | ||
import com.google.common.collect.ImmutableMap; | ||
import com.google.devtools.build.lib.events.Reporter; | ||
import com.google.devtools.build.lib.vfs.Path; | ||
import java.time.Duration; | ||
|
||
/** Environment for running {@link CredentialHelper}s in. */ | ||
@AutoValue | ||
public abstract class CredentialHelperEnvironment { | ||
/** Returns the reporter for reporting events related to {@link CredentialHelper}s. */ | ||
public abstract Reporter getEventReporter(); | ||
|
||
/** | ||
* Returns the (absolute) path to the workspace. | ||
* | ||
* <p>Used as working directory when invoking the subprocess. | ||
*/ | ||
public abstract Path getWorkspacePath(); | ||
|
||
/** | ||
* Returns the environment from the Bazel client. | ||
* | ||
* <p>Passed as environment variables to the subprocess. | ||
*/ | ||
public abstract ImmutableMap<String, String> getClientEnvironment(); | ||
|
||
/** Returns the execution timeout for the helper subprocess. */ | ||
public abstract Duration getHelperExecutionTimeout(); | ||
|
||
/** Returns a new builder for {@link CredentialHelperEnvironment}. */ | ||
public static CredentialHelperEnvironment.Builder newBuilder() { | ||
return new AutoValue_CredentialHelperEnvironment.Builder(); | ||
} | ||
|
||
/** Builder for {@link CredentialHelperEnvironment}. */ | ||
@AutoValue.Builder | ||
public abstract static class Builder { | ||
/** Sets the reporter for reporting events related to {@link CredentialHelper}s. */ | ||
public abstract Builder setEventReporter(Reporter reporter); | ||
|
||
/** | ||
* Sets the (absolute) path to the workspace to use as working directory when invoking the | ||
* subprocess. | ||
*/ | ||
public abstract Builder setWorkspacePath(Path path); | ||
|
||
/** | ||
* Sets the environment from the Bazel client to pass as environment variables to the | ||
* subprocess. | ||
*/ | ||
public abstract Builder setClientEnvironment(ImmutableMap<String, String> environment); | ||
|
||
/** Sets the execution timeout for the helper subprocess. */ | ||
public abstract Builder setHelperExecutionTimeout(Duration timeout); | ||
|
||
/** Returns the newly constructed {@link CredentialHelperEnvironment}. */ | ||
public abstract CredentialHelperEnvironment build(); | ||
} | ||
} |
This file contains 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
This file contains 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
Oops, something went wrong.
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.
Should we have a timeout here to avoid hanging Bazel indefinitely? (Just some food for thought, this can be done in a followup)
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.
We should!
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.
FYI, I will change the timeout error message before submitting internally, because
Duration#toString
doesn't produce a human-readable format.