// Copyright Epic Games, Inc. All Rights Reserved. using System; using System.Collections.Generic; using System.Text.RegularExpressions; using System.Threading.Tasks; using System.Xml; using EpicGames.Core; using Microsoft.Extensions.Logging; using UnrealBuildBase; namespace AutomationTool.Tasks { /// /// Parameters for the submit task /// public class SubmitTaskParameters { /// /// The description for the submitted changelist. /// [TaskParameter] public string Description { get; set; } /// /// The files to submit. /// [TaskParameter(ValidationType = TaskParameterValidationType.FileSpec)] public string Files { get; set; } /// /// The Perforce file type for the submitted files (for example, binary+FS32). /// [TaskParameter(Optional = true)] public string FileType { get; set; } /// /// The workspace name. If specified, a new workspace will be created using the given stream and root directory to submit the files. If not, the current workspace will be used. /// [TaskParameter(Optional = true)] public string Workspace { get; set; } /// /// The stream for the workspace -- defaults to the current stream. Ignored unless the Workspace attribute is also specified. /// [TaskParameter(Optional = true)] public string Stream { get; set; } /// /// Branch for the workspace (legacy P4 depot path). May not be used in conjunction with Stream. /// [TaskParameter(Optional = true)] public string Branch { get; set; } /// /// Root directory for the stream. If not specified, defaults to the current root directory. /// [TaskParameter(Optional = true)] public DirectoryReference RootDir { get; set; } /// /// Whether to revert unchanged files before attempting to submit. /// [TaskParameter(Optional = true)] public bool RevertUnchanged { get; set; } /// /// Force the submit to happen -- even if a resolve is needed (always accept current version). /// [TaskParameter(Optional = true)] public bool Force { get; set; } /// /// Allow verbose P4 output (spew). /// [TaskParameter(Optional = true)] public bool P4Verbose { get; set; } } /// /// Creates a new changelist and submits a set of files to a Perforce stream. /// [TaskElement("Submit", typeof(SubmitTaskParameters))] public class SubmitTask : BgTaskImpl { readonly SubmitTaskParameters _parameters; /// /// Construct a version task /// /// Parameters for this task public SubmitTask(SubmitTaskParameters parameters) { _parameters = parameters; } /// /// ExecuteAsync the task. /// /// Information about the current job /// Set of build products produced by this node. /// Mapping from tag names to the set of files they include public override Task ExecuteAsync(JobContext job, HashSet buildProducts, Dictionary> tagNameToFileSet) { HashSet files = ResolveFilespec(Unreal.RootDirectory, _parameters.Files, tagNameToFileSet); if (files.Count == 0) { Logger.LogInformation("No files to submit."); } else if (!CommandUtils.AllowSubmit) { Logger.LogWarning("Submitting to Perforce is disabled by default. Run with the -submit argument to allow."); } else { try { // Get the connection that we're going to submit with P4Connection submitP4 = CommandUtils.P4; if (_parameters.Workspace != null) { // Create a brand new workspace P4ClientInfo client = new P4ClientInfo(); client.Owner = CommandUtils.P4Env.User; client.Host = Unreal.MachineName; client.RootPath = _parameters.RootDir.FullName ?? Unreal.RootDirectory.FullName; client.Name = $"{_parameters.Workspace}_{Regex.Replace(client.Host, "[^a-zA-Z0-9]", "-")}_{ContentHash.MD5((CommandUtils.P4Env.ServerAndPort ?? "").ToUpperInvariant())}"; client.Options = P4ClientOption.NoAllWrite | P4ClientOption.Clobber | P4ClientOption.NoCompress | P4ClientOption.Unlocked | P4ClientOption.NoModTime | P4ClientOption.RmDir; client.LineEnd = P4LineEnd.Local; if (!String.IsNullOrEmpty(_parameters.Branch)) { client.View.Add(new KeyValuePair($"{_parameters.Branch}/...", $"/...")); } else { client.Stream = _parameters.Stream ?? CommandUtils.P4Env.Branch; } CommandUtils.P4.CreateClient(client, AllowSpew: _parameters.P4Verbose); // Create a new connection for it submitP4 = new P4Connection(client.Owner, client.Name); } // Get the latest version of it int newCl = submitP4.CreateChange(Description: _parameters.Description.Replace("\\n", "\n", StringComparison.Ordinal)); foreach (FileReference file in files) { submitP4.Revert(String.Format("-k \"{0}\"", file.FullName), AllowSpew: _parameters.P4Verbose); submitP4.Sync(String.Format("-k \"{0}\"", file.FullName), AllowSpew: _parameters.P4Verbose); submitP4.Add(newCl, String.Format("\"{0}\"", file.FullName)); submitP4.Edit(newCl, String.Format("\"{0}\"", file.FullName), AllowSpew: _parameters.P4Verbose); if (_parameters.FileType != null) { submitP4.P4(String.Format("reopen -t \"{0}\" \"{1}\"", _parameters.FileType, file.FullName), AllowSpew: _parameters.P4Verbose); } } // Revert any unchanged files if (_parameters.RevertUnchanged) { submitP4.RevertUnchanged(newCl); if (submitP4.TryDeleteEmptyChange(newCl)) { Logger.LogInformation("No files to submit; ignored."); return Task.CompletedTask; } } // Submit it int submittedCl; submitP4.Submit(newCl, out submittedCl, Force: _parameters.Force); if (submittedCl <= 0) { throw new AutomationException("Submit failed."); } Logger.LogInformation("Submitted in changelist {SubmittedCL}", submittedCl); } catch (P4Exception ex) { Logger.LogError(KnownLogEvents.Systemic_Perforce, "{Message}", ex.Message); throw new AutomationException(ex.ErrorCode, ex, "{0}", ex.Message) { OutputFormat = AutomationExceptionOutputFormat.Silent }; } } return Task.CompletedTask; } /// /// Output this task out to an XML writer. /// public override void Write(XmlWriter writer) { Write(writer, _parameters); } /// /// Find all the tags which are used as inputs to this task /// /// The tag names which are read by this task public override IEnumerable FindConsumedTagNames() { return FindTagNamesFromFilespec(_parameters.Files); } /// /// Find all the tags which are modified by this task /// /// The tag names which are modified by this task public override IEnumerable FindProducedTagNames() { yield break; } } }