UnrealEngineUWP/Engine/Source/Programs/AutomationTool/BuildGraph/Tasks/DockerTask.cs

// Copyright Epic Games, Inc. All Rights Reserved.

using EpicGames.Core;
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using System.Xml;

namespace AutomationTool.Tasks
{
	/// <summary>
	/// Parameters for a Docker task
	/// </summary>
	public class DockerTaskParameters
	{
		/// <summary>
		/// Docker command line arguments
		/// </summary>
		[TaskParameter(Optional = true)]
		public string Arguments;

		/// <summary>
		/// Base directory for running the command
		/// </summary>
		[TaskParameter(Optional = true)]
		public string BaseDir;

		/// <summary>
		/// The minimum exit code, which is treated as an error.
		/// </summary>
		[TaskParameter(Optional = true)]
		public int ErrorLevel = 1;

		/// <summary>
		/// Whether or not to show the console output from the Docker command.
		/// </summary>
		[TaskParameter(Optional = true)]
		public bool Verbose = true;

		/// <summary>
		/// Path to a file containing the credentials needed to run the Docker command
		/// </summary>
		[TaskParameter(Optional = true)]
		public string CredentialsFile;
	}

	/// <summary>
	/// Spawns Docker and waits for it to complete.
	/// </summary>
	[TaskElement("Docker", typeof(DockerTaskParameters))]
	public class DockerTask : CustomTask
	{
		/// <summary>
		/// Parameters for this task
		/// </summary>
		DockerTaskParameters Parameters;

		/// <summary>
		/// Construct a Docker task
		/// </summary>
		/// <param name="InParameters">Parameters for the task</param>
		public DockerTask(DockerTaskParameters InParameters)
		{
			Parameters = InParameters;
		}

		/// <summary>
		/// Execute the task.
		/// </summary>
		/// <param name="Job">Information about the current job</param>
		/// <param name="BuildProducts">Set of build products produced by this node.</param>
		/// <param name="TagNameToFileSet">Mapping from tag names to the set of files they include</param>
		public override void Execute(JobContext Job, HashSet<FileReference> BuildProducts, Dictionary<string, HashSet<FileReference>> TagNameToFileSet)
		{
			FileReference ToolFile = CommandUtils.FindToolInPath("docker");
			if(ToolFile == null)
			{
				throw new AutomationException("Unable to find path to Docker. Check you have it installed, and it is on your PATH.");
			}

			string DockerArgs = Parameters.Arguments;
			string CmdString = $"{ToolFile.FullName} {DockerArgs}";
			string DockerInput = null;

			if (!string.IsNullOrWhiteSpace(Parameters.CredentialsFile))
			{
				if (!File.Exists(Parameters.CredentialsFile))
				{
					throw new AutomationException("Credentials file {0} could not be found.", Parameters.CredentialsFile);
				}

				string[] CredentialTokens = File.ReadAllText(Parameters.CredentialsFile).Split(':');
				if (CredentialTokens.Length == 2)
				{
					DockerArgs += $" --username {CredentialTokens[0]} --password-stdin";
					DockerInput = CredentialTokens[1];
				}
				else if (CredentialTokens.Length == 1)
				{
					DockerArgs += $" --password-stdin";
					DockerInput = CredentialTokens[0];
				}
				else
				{
					throw new AutomationException("Expected password or username:password in credentials file ({0})", Parameters.CredentialsFile);
				}
			}

			CommandUtils.ERunOptions Options = CommandUtils.ERunOptions.AppMustExist;
			if (Parameters.Verbose)
			{
				Options |= CommandUtils.ERunOptions.AllowSpew;
			}
			IProcessResult Result = CommandUtils.Run(ToolFile.FullName, DockerArgs, DockerInput, WorkingDir: Parameters.BaseDir, Options: Options);
			if (Result.ExitCode < 0 || Result.ExitCode >= Parameters.ErrorLevel)
			{
				throw new AutomationException("Docker terminated with an exit code indicating an error ({0})", Result.ExitCode);
			}
		}

		/// <summary>
		/// Output this task out to an XML writer.
		/// </summary>
		public override void Write(XmlWriter Writer)
		{
			Write(Writer, Parameters);
		}

		/// <summary>
		/// Find all the tags which are used as inputs to this task
		/// </summary>
		/// <returns>The tag names which are read by this task</returns>
		public override IEnumerable<string> FindConsumedTagNames()
		{
			yield break;
		}

		/// <summary>
		/// Find all the tags which are modified by this task
		/// </summary>
		/// <returns>The tag names which are modified by this task</returns>
		public override IEnumerable<string> FindProducedTagNames()
		{
			yield break;
		}
	}
}