TechbloxModdingAPI/GamecraftModdingAPI/Tests/Assert.cs

using System;
using System.Collections.Concurrent;
using System.IO;
using System.Runtime.CompilerServices;

namespace GamecraftModdingAPI.Tests
{
    /// <summary>
    /// API test system assertion utilities.
    /// </summary>
    public static class Assert
    {
		private static StreamWriter logFile = null;

		private static ConcurrentDictionary<string, string> callbacks = new ConcurrentDictionary<string, string>();

		private const string PASS = "SUCCESS: ";

		private const string FAIL = "FAILURE: ";

		private const string WARN = "WARNING: ";

		private const string INFO = "DEBUG: ";

        /// <summary>
        /// Log a message to the test log.
        /// </summary>
        /// <param name="msg">Message.</param>
        /// <param name="end">Message ending.</param>
		[MethodImpl(MethodImplOptions.AggressiveInlining)]
		public static void Log(string msg, string end = "\n")
		{
			if (logFile == null) openTestLog();
			logFile.Write(msg + end);
			logFile.Flush();
		}

        /// <summary>
        /// Asserts that the event receives a callback... eventually.
		/// Add the eventhandler returned by this method to the relevant event.
		/// This does not assert that the callback happens under that event's intended circumstances.
		/// Add another event handler to assert specific circumstance requirements.
        /// </summary>
        /// <returns>The callback event handler.</returns>
        /// <param name="eventName">Event name.</param>
        /// <param name="eventMsg">Event error message.</param>
        /// <typeparam name="T">The event handler callback argument object.</typeparam>
		public static EventHandler<T> CallsBack<T>(string eventName, string eventMsg = null)
		{
			if (eventMsg == null) eventMsg = $"expected callback to {eventName} but it never occurred...";
			callbacks[eventName] = eventMsg;
            
			return (sender, args) =>
			{
				string value = null;
				if (!callbacks.TryRemove(eventName, out value)) { Log(WARN + $"callback to {eventName} occurred again or a related error occurred... (Received '{args.ToString()}' from '{(sender == null ? (string)sender : sender.ToString())}')"); }
				Log(PASS + $"callback to {eventName} occurred... (Received '{args.ToString()}' from '{(sender == null ? (string)sender : sender.ToString())}')");
				TestRoot.TestsPassed = true;
			};
		}

        internal static void CallsComplete()
		{
			foreach(string key in callbacks.Keys)
			{
				Log(FAIL + callbacks[key]);
				TestRoot.TestsPassed = false;
			}
		}

        internal static void CloseLog()
		{
			if (logFile != null) logFile.Close();
		}

		[MethodImpl(MethodImplOptions.AggressiveInlining)]
        private static void openTestLog()
		{
			logFile = File.CreateText(TestRoot.ReportFile);
		}
    }
}