Skip to content
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] Add parser for flag syntax #15906

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public final class CredentialHelper {
}

@VisibleForTesting
tjgq marked this conversation as resolved.
Show resolved Hide resolved
Path getPath() {
public Path getPath() {
return path;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,23 @@ private void checkHelper(Path path) throws IOException {
path.isExecutable(), "Credential helper %s is not executable", path);
}

/**
* Adds a credential helper to use for all {@link URI}s matching the provided pattern, or as
* default credential helper if {@code pattern} is empty.
*
* <p>See {@link #add(String, Path)} for the syntax of {@code pattern}.
*/
public Builder add(Optional<String> pattern, Path helper) throws IOException {
Yannic marked this conversation as resolved.
Show resolved Hide resolved
Preconditions.checkNotNull(pattern);
Preconditions.checkNotNull(helper);

if (pattern.isPresent()) {
return add(pattern.get(), helper);
} else {
return add(helper);
}
}

/**
* Adds a default credential helper to use for all {@link URI}s that don't specify a more
* specific credential helper.
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/google/devtools/build/lib/remote/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ java_library(
"//src/main/java/com/google/devtools/build/lib/analysis:top_level_artifact_context",
"//src/main/java/com/google/devtools/build/lib/analysis/platform:platform_utils",
"//src/main/java/com/google/devtools/build/lib/authandtls",
"//src/main/java/com/google/devtools/build/lib/authandtls/credentialhelper",
"//src/main/java/com/google/devtools/build/lib/bazel/repository/downloader",
"//src/main/java/com/google/devtools/build/lib/buildeventstream",
"//src/main/java/com/google/devtools/build/lib/clock",
Expand Down Expand Up @@ -102,6 +103,7 @@ java_library(
"//src/main/java/com/google/devtools/common/options",
"//src/main/protobuf:failure_details_java_proto",
"//third_party:auth",
"//third_party:auto_value",
"//third_party:caffeine",
"//third_party:flogger",
"//third_party:guava",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import build.bazel.remote.execution.v2.DigestFunction;
import build.bazel.remote.execution.v2.ServerCapabilities;
import com.google.auth.Credentials;
import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Ascii;
import com.google.common.base.Preconditions;
Expand Down Expand Up @@ -50,6 +51,8 @@
import com.google.devtools.build.lib.authandtls.Netrc;
import com.google.devtools.build.lib.authandtls.NetrcCredentials;
import com.google.devtools.build.lib.authandtls.NetrcParser;
import com.google.devtools.build.lib.authandtls.credentialhelper.CredentialHelperEnvironment;
import com.google.devtools.build.lib.authandtls.credentialhelper.CredentialHelperProvider;
import com.google.devtools.build.lib.bazel.repository.downloader.Downloader;
import com.google.devtools.build.lib.buildeventstream.BuildEventArtifactUploader;
import com.google.devtools.build.lib.buildeventstream.LocalFilesArtifactUploader;
Expand Down Expand Up @@ -78,6 +81,7 @@
import com.google.devtools.build.lib.runtime.BuildEventArtifactUploaderFactory;
import com.google.devtools.build.lib.runtime.Command;
import com.google.devtools.build.lib.runtime.CommandEnvironment;
import com.google.devtools.build.lib.runtime.CommandLinePathFactory;
import com.google.devtools.build.lib.runtime.RepositoryRemoteExecutor;
import com.google.devtools.build.lib.runtime.RepositoryRemoteExecutorFactory;
import com.google.devtools.build.lib.runtime.ServerBuilder;
Expand Down Expand Up @@ -1130,4 +1134,53 @@ static Credentials newCredentials(

return creds;
}

@VisibleForTesting
static CredentialHelperProvider newCredentialHelperProvider(
CredentialHelperEnvironment environment,
CommandLinePathFactory pathFactory,
List<String> inputs)
throws IOException {
Preconditions.checkNotNull(environment);
Preconditions.checkNotNull(pathFactory);
Preconditions.checkNotNull(inputs);

CredentialHelperProvider.Builder builder = CredentialHelperProvider.builder();
for (String input : inputs) {
ScopedCredentialHelper helper = parseCredentialHelperFlag(environment, pathFactory, input);
builder.add(helper.getScope(), helper.getPath());
}
return builder.build();
}

@VisibleForTesting
static ScopedCredentialHelper parseCredentialHelperFlag(
CredentialHelperEnvironment environment, CommandLinePathFactory pathFactory, String input)
throws IOException {
Preconditions.checkNotNull(environment);
Preconditions.checkNotNull(pathFactory);
Preconditions.checkNotNull(input);

int pos = input.indexOf('=');
if (pos > 0) {
String scope = input.substring(0, pos);
String path = input.substring(pos + 1);
Yannic marked this conversation as resolved.
Show resolved Hide resolved
return new AutoValue_RemoteModule_ScopedCredentialHelper(
Optional.of(scope), pathFactory.create(environment.getClientEnvironment(), path));
}

// `input` does not specify a scope.
return new AutoValue_RemoteModule_ScopedCredentialHelper(
Optional.empty(), pathFactory.create(environment.getClientEnvironment(), input));
}

@VisibleForTesting
@AutoValue
static abstract class ScopedCredentialHelper {
/** Returns the scope of the credential helper (if any). */
public abstract Optional<String> getScope();

/** Returns the path of the credential helper. */
public abstract Path getPath();
}
}
1 change: 1 addition & 0 deletions src/test/java/com/google/devtools/build/lib/remote/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ java_test(
"//src/main/java/com/google/devtools/build/lib/analysis:server_directories",
"//src/main/java/com/google/devtools/build/lib/analysis/platform:platform_utils",
"//src/main/java/com/google/devtools/build/lib/authandtls",
"//src/main/java/com/google/devtools/build/lib/authandtls/credentialhelper",
"//src/main/java/com/google/devtools/build/lib/buildeventstream",
"//src/main/java/com/google/devtools/build/lib/clock",
"//src/main/java/com/google/devtools/build/lib/collect/nestedset",
Expand Down