aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.UnitTesting/Helper.cs
blob: 6a4f860b9ad437401cf6552ccc628f832ad961ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /*
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading.Tasks;
using Tango.Logging;
using DeepEqual;
using DeepEqual.Syntax;

namespace Tango.UnitTesting
{
    /// <summary>
    /// Contains several unit testing helper methods.
    /// </summary>
    public static class Helper
    {
        /// <summary>
        /// Gets the absolute path to the specified file name in the solution 'Resources' folder.
        /// </summary>
        /// <param name="fileName">Name of the file.</param>
        /// <returns></returns>
        public static String GetResourcePath(String fileName)
        {
            return Path.GetFullPath(@"..\..\..\Resources\" + fileName);
        }

        /// <summary>
        /// Gets the PMR (Protobuf Messages Repository) path.
        /// </summary>
        /// <returns></returns>
        public static String GetPMRPath()
        {
            return Path.GetFullPath(@"..\..\..\PMR\Messages\");
        }

        /// <summary>
        /// Gets the machine studio exe path.
        /// </summary>
        /// <returns></returns>
        public static String GetMachineStudioPath()
        {
            return Path.GetFullPath(@"..\..\Build\Debug\Tango.MachineStudio.UI.exe");
        }

        /// <summary>
        /// Gets the tango build path.
        /// </summary>
        /// <returns></returns>
        public static String GetBuildPath()
        {
            return Path.GetFullPath(@"..\..\Build\Debug");
        }

        /// <summary>
        /// Gets the SQLite database file path in DB folder.
        /// </summary>
        /// <returns></returns>
        public static String GetSQLiteFilePath()
        {
            return Path.GetFullPath(@"..\..\..\DB\Tango.db");
        }

        /// <summary>
        /// Initializes the logging manager.
        /// </summary>
        public static ConsoleLogger InitializeLogging(bool useConsole = false, [CallerMemberName] string testName = null)
        {
            LogManager.Default.RegisterLogger(new FileLogger(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "Twine", "Tango", "logs", "Unit Testing"), "Unit_Testing"));
            if (useConsole)
            {
                var consoleLogger = new ConsoleLogger(testName);
                LogManager.Default.RegisterLogger(consoleLogger);
                return consoleLogger;
            }

            return null;
        }

        /// <summary>
        /// Creates a temporary folder and returns it's path.
        /// </summary>
        /// <returns></returns>
        public static String GetTempFolderPathAppend(String customFolder, [CallerMemberName] string testName = null)
        {
            String tempDirectory = Path.Combine(Path.GetTempPath(), "Twine", "Unit Testing", testName, customFolder);
            Directory.CreateDirectory(tempDirectory);
            return tempDirectory;
        }

        /// <summary>
        /// Creates a temporary folder and returns it's path.
        /// </summary>
        /// <returns></returns>
        public static String GetTempFolderPath([CallerMemberName] string testName = null)
        {
            String tempDirectory = Path.Combine(Path.GetTempPath(), "Twine", "Unit Testing", testName, Path.GetRandomFileName());
            Directory.CreateDirectory(tempDirectory);
            return tempDirectory;
        }

        /// <summary>
        /// Tries to delete folder.
        /// </summary>
        /// <param name="path">The path.</param>
        /// <returns></returns>
        public static bool TryDeleteFolder(String path)
        {
            try
            {
                Directory.Delete(path, true);
                return true;
            }
            catch
            {
                return false;
            }
        }

        /// <summary>
        /// Shows the file in explorer.
        /// </summary>
        /// <param name="path">Name of the file/folder.</param>
        public static void ShowInExplorer(String path)
        {
            Process.Start("explorer.exe", string.Format("/select,\"{0}\"", path));
        }

        /// <summary>
        /// Returns true if the two objects are equal by using deep equal.
        /// </summary>
        /// <param name="obj1">First object.</param>
        /// <param name="obj2">Second object.</param>
        /// <returns></returns>
        public static bool IsDeepEqual(Object obj1, Object obj2)
        {
            return obj1.IsDeepEqual(obj2);
        }
    }
}