// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System.Collections.Generic;

namespace Microsoft.VisualStudio.TestPlatform.ObjectModel.Engine;

/// <summary>
/// The Test Case level events.
/// </summary>
public interface ITestCaseEventsHandler
{
    /// <summary>
    ///  Report start of executing a test case.
    /// </summary>
    /// <param name="testCase">Details of the test case whose execution is just started.</param>
    void SendTestCaseStart(TestCase testCase);

    /// <summary>
    /// Report end of executing a test case.
    /// </summary>
    /// <param name="testCase">Details of the test case.</param>
    /// <param name="outcome">Result of the test case executed.</param>
    void SendTestCaseEnd(TestCase testCase, TestOutcome outcome);

    /// <summary>
    /// Sends the test result
    /// </summary>
    /// <param name="result"> The result. </param>
    void SendTestResult(TestResult result);

    /// <summary>
    /// Send session start event.
    /// The purpose of this is to perform any initialization before the test case level events are sent.
    /// </summary>
    /// <param name="properties"> The session start properties. </param>
    void SendSessionStart(IDictionary<string, object?> properties);

    /// <summary>
    /// Sends session end event.
    /// The purpose of this is to perform any cleanup after the test case level events are sent.
    /// </summary>
    void SendSessionEnd();
}