-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add ActionEnvironment, which is a wrapper class for a fixed+inherited…
… env We are currently tracking the action environment (computed from --action_env), and the test action environment (computed from --test_env, and not including the action env) as two pairs of fields, and a lot of callers haven't been updated to handle both parts (TestRunnerAction does, but many 'normal' actions don't). However, both parts have always both be handled, and moving them into a single abstraction makes it harder to accidentally miss one part. We'll subsequently need to update all the action implementations to use the new abstraction, and also update the Skylark API (or bypass it and always apply the action environment for all actions, except we don't know which configuration to use). PiperOrigin-RevId: 160386181
- Loading branch information
Showing
5 changed files
with
150 additions
and
73 deletions.
There are no files selected for viewing
101 changes: 101 additions & 0 deletions
101
src/main/java/com/google/devtools/build/lib/actions/ActionEnvironment.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,101 @@ | ||
| // Copyright 2017 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.actions; | ||
|
|
||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.devtools.build.lib.util.Fingerprint; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.TreeMap; | ||
| import java.util.TreeSet; | ||
|
|
||
| /** | ||
| * Environment variables for build or test actions. | ||
| * | ||
| * <p>The action environment consists of two parts. | ||
| * <ol> | ||
| * <li>All the environment variables with a fixed value, stored in a map. | ||
| * <li>All the environment variables inherited from the client environment, stored in a set. | ||
| * </ol> | ||
| * | ||
| * <p>Inherited environment variables must be declared in the Action interface | ||
| * (see {@link Action#getClientEnvironmentVariables}), so that the dependency on the client | ||
| * environment is known to the execution framework for correct incremental builds. | ||
| */ | ||
| public final class ActionEnvironment { | ||
| /** | ||
| * Splits the given map into a map of variables with a fixed value, and a set of variables that | ||
| * should be inherited, the latter of which are identified by having a {@code null} value in the | ||
| * given map. Returns these two parts as a new {@link ActionEnvironment} instance. | ||
| */ | ||
| public static ActionEnvironment split(Map<String, String> env) { | ||
| // Care needs to be taken that the two sets don't overlap - the order in which the two parts are | ||
| // combined later is undefined. | ||
| Map<String, String> fixedEnv = new TreeMap<>(); | ||
| Set<String> inheritedEnv = new TreeSet<>(); | ||
| for (Map.Entry<String, String> entry : env.entrySet()) { | ||
| if (entry.getValue() != null) { | ||
| fixedEnv.put(entry.getKey(), entry.getValue()); | ||
| } else { | ||
| String key = entry.getKey(); | ||
| inheritedEnv.add(key); | ||
| } | ||
| } | ||
| return new ActionEnvironment(fixedEnv, inheritedEnv); | ||
| } | ||
|
|
||
| private final ImmutableMap<String, String> fixedEnv; | ||
| private final ImmutableSet<String> inheritedEnv; | ||
|
|
||
| /** | ||
| * Creates a new action environment. The order in which the environments are combined is | ||
| * undefined, so callers need to take care that the key set of the {@code fixedEnv} map and the | ||
| * set of {@code inheritedEnv} elements are disjoint. | ||
| */ | ||
| public ActionEnvironment(Map<String, String> fixedEnv, Set<String> inheritedEnv) { | ||
| this.fixedEnv = ImmutableMap.copyOf(fixedEnv); | ||
| this.inheritedEnv = ImmutableSet.copyOf(inheritedEnv); | ||
| } | ||
|
|
||
| public ImmutableMap<String, String> getFixedEnv() { | ||
| return fixedEnv; | ||
| } | ||
|
|
||
| public ImmutableSet<String> getInheritedEnv() { | ||
| return inheritedEnv; | ||
| } | ||
|
|
||
| /** | ||
| * Resolves the action environment and adds the resulting entries to the given {@code result} map, | ||
| * by looking up any inherited env variables in the given {@code clientEnv}. | ||
| * | ||
| * <p>We pass in a map to mutate to avoid creating and merging intermediate maps. | ||
| */ | ||
| public void resolve(Map<String, String> result, Map<String, String> clientEnv) { | ||
| Preconditions.checkNotNull(clientEnv); | ||
| result.putAll(fixedEnv); | ||
| for (String var : inheritedEnv) { | ||
| String value = clientEnv.get(var); | ||
| if (value != null) { | ||
| result.put(var, value); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void addTo(Fingerprint f) { | ||
| f.addStringMap(fixedEnv); | ||
| } | ||
| } |
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
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