/// <summary>
/// Constructor
/// </summary>
public PipEnvironment(LoggingContext loggingContext)
{
m_loggingContext = loggingContext;
FullEnvironmentVariables =
GetFactory(ReportDuplicateVariable)
.PopulateFromEnvironment();
#if PLATFORM_WIN
var comspec = Path.Combine(SpecialFolderUtilities.SystemDirectory, "cmd.exe");
var pathExt = ".COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC";
#endif
var path =
string.Join(
OperatingSystemHelper.IsUnixOS ? ":" : ";",
SpecialFolderUtilities.SystemDirectory,
#if PLATFORM_WIN
SpecialFolderUtilities.GetFolderPath(Environment.SpecialFolder.Windows),
Path.Combine(SpecialFolderUtilities.SystemDirectory, "wbem")
#else
MacPaths.UsrBin,
MacPaths.UsrSbin,
MacPaths.Bin,
MacPaths.Sbin
#endif
);
// the environment variable names below should use the casing appropriate for the target OS
// (on Windows it won't matter, but on Unix-like systems, including Cygwin environment on Windows,
// it matters, and has to be all upper-cased). See also doc comment for IBuildParameters.Select
m_baseEnvironmentVariables = FullEnvironmentVariables
.Select(new[]
{
"NUMBER_OF_PROCESSORS",
"OS",
"PROCESSOR_ARCHITECTURE",
"PROCESSOR_IDENTIFIER",
"PROCESSOR_LEVEL",
"PROCESSOR_REVISION",
"SystemDrive",
"SystemRoot",
"SYSTEMTYPE",
})
.Override(new Dictionary <string, string>()
{
{ "PATH", path },
#if PLATFORM_WIN
{ "ComSpec", comspec },
{ "PATHEXT", pathExt }
#endif
})
.Override(DisallowedTempVariables
.Select(tmp => new KeyValuePair <string, string>(tmp, RestrictedTemp)));
}
/// <summary>
/// Gets the effective environment variables, taking into account default and machine-specific values
/// </summary>
public IBuildParameters GetEffectiveEnvironmentVariables(Process pip, PipFragmentRenderer pipFragmentRenderer, int currentUserRetryCount, IReadOnlyList <string> globalUnsafePassthroughEnvironmentVariables = null)
{
Contract.Requires(pipFragmentRenderer != null);
Contract.Requires(pip != null);
Contract.Ensures(Contract.Result <IBuildParameters>() != null);
Contract.Requires(currentUserRetryCount >= 0);
var trackedEnv = pip.EnvironmentVariables.Where(envVar => !envVar.IsPassThrough);
var passThroughEnvNames = pip.EnvironmentVariables.Where(envVar => envVar.IsPassThrough).Select(envVar => pipFragmentRenderer.Render(envVar.Name));
// Append any passthrough environment variables if they're specified
passThroughEnvNames = globalUnsafePassthroughEnvironmentVariables != null?passThroughEnvNames.Union(globalUnsafePassthroughEnvironmentVariables) : passThroughEnvNames;
IBuildParameters fullEnvironmentForPassThrough = MasterEnvironmentVariables != null?
// We first look at the env variables from the worker,
// then if the pass through variable is unset, we look at the env variables from the master.
// That's why, if MasterEnvironmentVariables is not null, it is overridden by the current environment variables.
GetFactory(ReportDuplicateVariable).PopulateFromDictionary(MasterEnvironmentVariables).Override(FullEnvironmentVariables.ToDictionary()) :
FullEnvironmentVariables;
IBuildParameters effectiveVariables = m_baseEnvironmentVariables
.Override(trackedEnv.ToDictionary(
envVar => pipFragmentRenderer.Render(envVar.Name),
envVar => envVar.Value.ToString(pipFragmentRenderer)))
.Override(fullEnvironmentForPassThrough.Select(passThroughEnvNames).ToDictionary());
// If the variable to indicate the retry attempt is set, make sure it gets populated
if (pip.RetryAttemptEnvironmentVariable.IsValid)
{
effectiveVariables = effectiveVariables.Override(
new[] { new KeyValuePair <string, string>(pipFragmentRenderer.Render(pip.RetryAttemptEnvironmentVariable), currentUserRetryCount.ToString()) });
}
return(effectiveVariables);
}
/// <summary>
/// Gets the effective environment variables, taking into account default and machine-specific values
/// </summary>
public IBuildParameters GetEffectiveEnvironmentVariables(Process pip, PipFragmentRenderer pipFragmentRenderer, IReadOnlyList <string> globalUnsafePassthroughEnvironmentVariables = null)
{
Contract.Requires(pipFragmentRenderer != null);
Contract.Requires(pip != null);
Contract.Ensures(Contract.Result <IBuildParameters>() != null);
var trackedEnv = pip.EnvironmentVariables.Where(envVar => !envVar.IsPassThrough);
var passThroughEnvNames = pip.EnvironmentVariables.Where(envVar => envVar.IsPassThrough).Select(envVar => pipFragmentRenderer.Render(envVar.Name));
// Append any passthrough environment variables if they're specified
passThroughEnvNames = globalUnsafePassthroughEnvironmentVariables != null?passThroughEnvNames.Union(globalUnsafePassthroughEnvironmentVariables) : passThroughEnvNames;
IBuildParameters fullEnvironmentForPassThrough = MasterEnvironmentVariables != null?
// We first look at the env variables from the worker,
// then if the pass through variable is unset, we look at the env variables from the master.
// That's why, if MasterEnvironmentVariables is not null, it is overridden by the current environment variables.
GetFactory(ReportDuplicateVariable).PopulateFromDictionary(MasterEnvironmentVariables).Override(FullEnvironmentVariables.ToDictionary()) :
FullEnvironmentVariables;
return(m_baseEnvironmentVariables
.Override(trackedEnv.ToDictionary(
envVar => pipFragmentRenderer.Render(envVar.Name),
envVar => envVar.Value.ToString(pipFragmentRenderer)))
.Override(fullEnvironmentForPassThrough.Select(passThroughEnvNames).ToDictionary()));
}
