BuildMessage.cs

// ReSharper disable InconsistentNaming
// ReSharper disable NotAccessedPositionalProperty.Global
// ReSharper disable InconsistentNaming

namespace HostApi;

using JetBrains.TeamCity.ServiceMessages;

/// <summary>
/// Represents a build event.
/// </summary>
/// <param name="Output">Event from the running command line.</param>
/// <param name="State">State of the build message. Defines the specifics of the build message, what information it contains.</param>
/// <param name="ServiceMessage">Associated service message.</param>
/// <param name="Text">Text of the build message.</param>
/// <param name="ErrorDetails">Details of the build message error.</param>
/// <param name="Code">Message code of the build message.</param>
/// <param name="File">A file that is relevant to the build event.</param>
/// <param name="Subcategory">Message subcategory of the build message.</param>
/// <param name="ProjectFile">A project that is relevant to the build event.</param>
/// <param name="SenderName">The task that initiated the build message.</param>
/// <param name="ColumnNumber">Start position in a line of the file relevant to the build event.</param>
/// <param name="EndColumnNumber">End position in a line of the file relevant to the build event.</param>
/// <param name="LineNumber">First line of the file relating to the build event.</param>
/// <param name="EndLineNumber">Last line of the file relating to the build event.</param>
/// <param name="Importance">Importance of the build event.</param>
[ExcludeFromCodeCoverage]
[Target]
public record BuildMessage(
    Output Output,
    BuildMessageState State,
    IServiceMessage? ServiceMessage = null,
    string Text = "",
    string ErrorDetails = "",
    string Code = "",
    string File = "",
    string Subcategory = "",
    string ProjectFile = "",
    string SenderName = "",
    int? ColumnNumber = null,
    int? EndColumnNumber = null,
    int? LineNumber = null,
    int? EndLineNumber = null,
    DotNetMessageImportance? Importance = null)
{
    /// <summary>
    /// Contains the result of test execution when <see cref="State"/> is set to <see cref="BuildMessageState.TestResult"/>.
    /// </summary>
    public TestResult? TestResult =>
        ServiceMessage != null && TryGetTestState(ServiceMessage.Name, out var testState)
            ? CreateResult(CreateKey(ServiceMessage), ServiceMessage, testState)
            : null;

    /// <inheritdoc />
    public override string ToString() => Text;

    internal static TestResult CreateResult(TestKey key, IServiceMessage message, TestState state)
    {
        var testSource = message.GetValue("testSource") ?? string.Empty;
        var displayName = message.GetValue("displayName") ?? string.Empty;
        var resultDisplayName = message.GetValue("resultDisplayName") ?? string.Empty;
        var codeFilePath = message.GetValue("codeFilePath") ?? string.Empty;
        var fullyQualifiedName = message.GetValue("fullyQualifiedName") ?? string.Empty;
        var (flowId, suiteName, testName) = key;
        var result = new TestResult(state, testName)
            .WithSuiteName(suiteName)
            .WithFlowId(flowId)
            .WithSource(testSource)
            .WithDisplayName(displayName)
            .WithResultDisplayName(resultDisplayName)
            .WithCodeFilePath(codeFilePath)
            .WithFullyQualifiedName(fullyQualifiedName);

        if (Guid.TryParse(message.GetValue("id"), out var id))
        {
            result = result.WithId(id);
        }

        if (Uri.TryCreate(message.GetValue("executorUri"), UriKind.RelativeOrAbsolute, out var executorUri))
        {
            result = result.WithExecutorUri(executorUri);
        }

        if (int.TryParse(message.GetValue("lineNumber"), out var lineNumber))
        {
            result = result.WithLineNumber(lineNumber);
        }

        return result;
    }

    internal static TestKey CreateKey(IServiceMessage message)
    {
        var flowId = message.GetValue("flowId") ?? string.Empty;
        var suiteName = message.GetValue("suiteName") ?? string.Empty;
        var name = message.GetValue("name") ?? string.Empty;
        return new TestKey(flowId, suiteName, name);
    }

    private static bool TryGetTestState(string? name, out TestState state)
    {
        switch (name?.ToLowerInvariant())
        {
            case "testfinished":
                state = TestState.Finished;
                return true;

            case "testignored":
                state = TestState.Ignored;
                return true;

            case "testfailed":
                state = TestState.Failed;
                return true;
        }

        state = default;
        return false;
    }

    // ReSharper disable once NotAccessedPositionalProperty.Local
    internal readonly record struct TestKey(string FlowId, string SuiteName, string TestName);
}