Merge pull request #2 from TeamControlium/master-candidate-1.0.2

Master candidate 1.0.2

Author: v-mwalk

Detokenizer.cs

@@ -2,7 +2,6 @@
 using System.Globalization;
 using System.Linq;
 using System.Text;
-using System.Threading.Tasks;
 
 namespace TeamControlium.Utilities
 {
@@ -161,10 +160,10 @@ private static string ProcessToken(string token)
                     }
                     break;
             }
+
             return processedToken;
         }
 
-
         private static string DoRandomToken(char delimiter, string TypeAndLength)
         {
             string[] typeAndLengthOrFormat = TypeAndLength.Split(new char[] { delimiter }, 2);
@@ -206,26 +205,20 @@ private static string DoRandomToken(char delimiter, string TypeAndLength)
                             select = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890";
                             break;
                         case "acn":
-                            {
-                                string acn = ProcessTokensInString("{random;digits;9}");
-                                return acn;
-                                break;
-                            }
+                            return ProcessTokensInString("{random;digits;9}");
                         case "abn":
                             {
                                 string acn = ProcessTokensInString("{random;acn}");
-                                result = ProcessTokensInString($"{{ABNFromACN;{acn}}}");
-                                return result;
-                                break;
+                                return ProcessTokensInString($"{{ABNFromACN;{acn}}}");
                             }
                         default:
                             throw new Exception($"Unrecognised random Type [{typeAndLengthOrFormat[0]}] - Expect letters, lowercaseletters, uppercaseletters digits or alphanumerics");
                     }
                 }
-                int number;
-                if (!int.TryParse(typeAndLengthOrFormat[1], out number)) throw new Exception($"Invalid number of characters in Random token {{random;<type>;<length>}}");
+                if (!int.TryParse(typeAndLengthOrFormat[1], out int number)) throw new Exception($"Invalid number of characters in Random token {{random;<type>;<length>}}");
                 result = new string(Enumerable.Repeat(select, number).Select(s => s[RandomGenerator.Next(s.Length)]).ToArray());
             }
+
             return result;
         }
 
@@ -237,6 +230,7 @@ private static string DoDateToken(char delimiter, string OffsetAndFormat)
             {
                 throw new Exception("Date token does not have a format parameter; example: {date" + delimiter + "today" + delimiter + "dd-MM-yyyy}");
             }
+
             DateTime dt;
             string verb = offsetAndFormat[0].ToLower().Trim();
             if (verb.StartsWith("random("))
@@ -284,31 +278,15 @@ private static string DoDateToken(char delimiter, string OffsetAndFormat)
                         }
                 }
             }
+
             return dt.ToString(offsetAndFormat[1]);
         }
 
-        //private static string DoSeleniumKey(string KeyName)
-        //{
-        //    try
-        //    {
-        //        //
-        //        // Selenium keys are static fields in the WebDriver Keys class.
-        //        //
-        //        return (string)typeof(Keys).GetField(KeyName).GetValue(null);
-        //    }
-        //    catch (Exception ex)
-        //    {
-        //        throw new ArgumentException($"[{KeyName ?? "null!!"}] not found as a field in Selenium Keys class", "KeyName");
-        //    }
-        //}
-
         private static string DoFinancialYearToken(char delimiter, string DateToWorkFromAndFormat, bool Start)
         {
             string[] dateToWorkFromAndFormat = DateToWorkFromAndFormat.Split(new char[] { delimiter }, 2);
 
-
-            DateTime dateToWorkFrom;
-            if (!DateTime.TryParseExact(dateToWorkFromAndFormat[0], new string[] { "dd/MM/yyyy", "d/MM/yyyy", "dd/M/yyyy", "d/M/yyyy", "dd/MM/yy", "d/MM/yy", "dd/M/yy", "d/M/yy" }, CultureInfo.InvariantCulture, DateTimeStyles.None, out dateToWorkFrom))
+            if (!DateTime.TryParseExact(dateToWorkFromAndFormat[0], new string[] { "dd/MM/yyyy", "d/MM/yyyy", "dd/M/yyyy", "d/M/yyyy", "dd/MM/yy", "d/MM/yy", "dd/M/yy", "d/M/yy" }, CultureInfo.InvariantCulture, DateTimeStyles.None, out DateTime dateToWorkFrom))
             {
                 throw new ArgumentException("Cannot parse date.  Must be in format d/M/y", "DateToWorkFromAndFormat (first element)");
             }
@@ -329,16 +307,15 @@ static private float DoRandomFloat(string MaxAndMinFloats)
             string[] MaxAndMin = MaxAndMinFloats.Split(delimiter);
             if (MaxAndMin.Length != 2)
                 throw new Exception($"Invalid Maximum and Minimum floats. Expect {{random.float(min;max),<format>}}. Max/min was: [{MaxAndMinFloats}]");
-            float Min;
-            float Max;
 
-            if (!float.TryParse(MaxAndMin[0], out Min))
+            if (!float.TryParse(MaxAndMin[0], out float Min))
                 throw new Exception($"Invalid Minimum float. Expect {{random.float(min;max),<format>}}. Max/min was: [{MaxAndMinFloats}]");
-            if (!float.TryParse(MaxAndMin[1], out Max))
+            if (!float.TryParse(MaxAndMin[1], out float Max))
                 throw new Exception($"Invalid Maximum float. Expect {{random.float(min;max),<format>}}. Max/min was: [{MaxAndMinFloats}]");
 
             return DoRandomFloat(Min, Max);
         }
+
         static public float DoRandomFloat(float MinFloat, float MaxFloat)
         {
             if (MinFloat >= MaxFloat)
@@ -352,21 +329,20 @@ static private DateTime DoRandomDate(string MaxAndMinDates)
             string[] MaxAndMin = MaxAndMinDates.Split(delimiter);
             if (MaxAndMin.Length != 2)
                 throw new Exception($"Invalid Maximum and Minimum dates. Expect {{random;date(dd-MM-yyyy,dd-MM-yyyy);<format>}}. Max/min was: [{MaxAndMinDates}]");
-            DateTime Min;
-            DateTime Max;
 
-            if (!DateTime.TryParseExact(MaxAndMin[0], "d-M-yyyy", CultureInfo.InstalledUICulture, DateTimeStyles.None, out Min))
+            if (!DateTime.TryParseExact(MaxAndMin[0], "d-M-yyyy", CultureInfo.InstalledUICulture, DateTimeStyles.None, out DateTime Min))
                 throw new Exception($"Invalid Minimum date. Expect {{random;date(dd-MM-yyyy,dd-MM-yyyy);<format>}}. Max/min was: [{MaxAndMinDates}]");
-            if (!DateTime.TryParseExact(MaxAndMin[1], "d-M-yyyy", CultureInfo.InstalledUICulture, DateTimeStyles.None, out Max))
+            if (!DateTime.TryParseExact(MaxAndMin[1], "d-M-yyyy", CultureInfo.InstalledUICulture, DateTimeStyles.None, out DateTime Max))
                 throw new Exception($"Invalid Maximum date. Expect {{random;date(dd-MM-yyyy,dd-MM-yyyy);<format>}}. Max/min was: [{MaxAndMinDates}]");
 
             return DoRandomDate(Min, Max);
         }
+
         static public DateTime DoRandomDate(DateTime MinDate, DateTime MaxDate)
         {
             if (MinDate > MaxDate)
                 throw new Exception($"Maximum date earlier than Maximum date! Expect {{random;date(dd-MM-yyyy,dd-MM-yyyy);<format>}} Mindate = {MinDate.ToString("dd/MM/yyyy")}, Maxdate = {MaxDate.ToString("dd/MM/yyyy")}");
             return MinDate.AddDays(RandomGenerator.Next((MaxDate - MinDate).Days));
         }
     }
-}
+}

General.cs

@@ -2,17 +2,12 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Text;
 using System.Text.RegularExpressions;
 
 namespace TeamControlium.Utilities
 {
     public class General
     {
-        /// <summary>
-        /// Delegate for processing Tokens.
-        /// </summary>
-        public static Func<string, string> TokenProcessor;
 
         /// <summary>
         /// If object is a string and <see cref="Settings.TokenProcessor"/> has been set, tokens with the string are processed
@@ -23,14 +18,6 @@ public class General
         /// <returns>Processed object</returns>
         public static T DetokeniseString<T>(T ObjectToProcess)
         {
-            //
-            // Make sure we are thread-safe. There is a possibility that the framework is in a multi-threaded apartment (MTA) and it is possible
-            // for TokenProcessor to become null between checking and use ( if (TokenProcessor!=null) option = (T)(object)TokenProcessor((string)(object)option); ). 
-            // Using the processor temporary variable forces .NET to make a copy of the handler.
-            // See https://blogs.msdn.microsoft.com/ericlippert/2009/04/29/events-and-races/ for details.
-            //
-            Func<string, string> processor = null;
-
             // Only do any processing if the object is a string.
             if (typeof(T) == typeof(String))
             {
@@ -44,18 +31,9 @@ public static T DetokeniseString<T>(T ObjectToProcess)
                 while (!StringToProcess.Equals(ProcessedString))
                 {
                     StringToProcess = string.Copy(ProcessedString);
-                    processor = TokenProcessor;
-                    if (processor != null)
-                    {
-                        ProcessedString = processor(StringToProcess);
-                        Logger.WriteLine(Logger.LogLevels.FrameworkDebug, "Processed [{0}] to [{1}]", StringToProcess, ProcessedString ?? string.Empty);
-                    }
-                    else
-                    {
-                        Logger.WriteLine(Logger.LogLevels.FrameworkDebug, "No Token Processor active. String not processed");
-                        ProcessedString = StringToProcess;
-                    }
-                    processor = null;
+
+                    ProcessedString = Detokenizer.ProcessTokensInString(StringToProcess);
+                    Logger.WriteLine(Logger.LogLevels.FrameworkDebug, "Processed [{0}] to [{1}]", StringToProcess, ProcessedString ?? string.Empty);
                 }
                 return (T)(object)ProcessedString;
             }
@@ -74,8 +52,7 @@ public static T DetokeniseString<T>(T ObjectToProcess)
         public static bool IsValueTrue(string Value)
         {
             if (string.IsNullOrEmpty(Value)) return false;
-            int i;
-            if (int.TryParse(Value, out i))
+            if (int.TryParse(Value, out int i))
                 if (i > 0) return true; else return false;
             return Value.ToLower().StartsWith("t") || Value.ToLower().StartsWith("y") || Value.ToLower().StartsWith("on");
         }
@@ -147,6 +124,5 @@ public static string GetTextFromHTML(string HtmlData)
 
             return document.DocumentNode.InnerHtml;
         }
-
     }
 }

Logger.cs

@@ -188,7 +188,7 @@ static public void LogException(Exception ex, string text, params Object[] args)
         static public void Write(LogLevels logLevel, string textString, params Object[] args)
         {
             StackFrame stackFrame = new StackFrame(1, true);
-            DoWrite((stackFrame == null) ? null : stackFrame.GetMethod(), logLevel, string.Format(textString, args));
+            DoWrite(stackFrame?.GetMethod(), logLevel, string.Format(textString, args));
         }
 
         /// <summary>
@@ -206,8 +206,7 @@ static public void Write(LogLevels logLevel, string textString, params Object[]
         static public void WriteLine(LogLevels logLevel, string textString, params Object[] args)
         {
             StackFrame stackFrame = new StackFrame(1, true);
-            DoWriteLine((stackFrame == null) ? null : stackFrame.GetMethod(), logLevel,
-                    string.Format(textString, args));
+            DoWriteLine(stackFrame?.GetMethod(), logLevel, string.Format(textString, args));
         }
 
         /// <summary>

TestArguments.cs

@@ -1,15 +1,14 @@
-using System;
-using System.Collections.Generic;
-using System.Collections.Specialized;
-using System.Linq;
-using System.Text;
+using System.Collections.Specialized;
 using System.Text.RegularExpressions;
 
 namespace TeamControlium.Utilities
 {
     /// <summary>
     /// Processes test command-line arguments and presents them to the test script as a string array
     /// </summary>
+    /// <remarks>
+    /// Thanks to Mike Burns (https://www.linkedin.com/in/maddogmikeb) for original
+    /// </remarks>
     public class TestArguments
     {
         // Variables

TestData.cs

@@ -1,14 +1,10 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace TeamControlium.Utilities
 {
     public class TestData
     {
-        private static TestDataRepository<dynamic> dataRepository = new TestDataRepository<dynamic>();
         private static Dictionary<string, Dictionary<string, dynamic>> testData = new Dictionary<string, Dictionary<string, dynamic>>();
 
         /// <summary>
@@ -31,15 +27,8 @@ public class TestData
         /// string myString = Utilities.TestData.Repository["MyCategory","MyName"];
         /// </code>
         /// </example>
-        public static TestDataRepository<dynamic> Repository
-        {
-            get
-            {
-                return dataRepository;
-            }
-        }
-
-
+        public static TestDataRepository<dynamic> Repository { get; } = new TestDataRepository<dynamic>();
+        
         /// <summary>
         /// Underlying TestData repository
         /// </summary>
@@ -87,9 +76,10 @@ public bool HasCategory(string key)
                         throw new ArgumentException(string.Format("Cannot be null or empty ({0})", name == null ? "Is Null" : "Is empty"), "name");
                     if (!this[category].ContainsKey(name))
                         throw new ArgumentOutOfRangeException("name", name, string.Format("Category [{0}] does not have item named", category));
+                    
                     // Get item named from category and return it
                     dynamic obtainedObject = (this[category])[name];
-                    // Do logging
+                    
                     Logger.Write(Logger.LogLevels.FrameworkDebug, "Got ");
                     if (obtainedObject is string)
                     {
@@ -132,7 +122,7 @@ public bool HasCategory(string key)
                     // Add Category if we dont already have it
                     if (!testData.ContainsKey(category))
                         testData.Add(category, new Dictionary<string, dynamic>());
-                    // Select Category
+                    
                     Dictionary<string, dynamic> wholeCategory = testData[category];
                     // Add Name if we dont already have it in the current category, otherwise change contents of name
                     if (wholeCategory.ContainsKey(name))
@@ -157,6 +147,7 @@ public bool HasCategory(string key)
                         throw new ArgumentException(string.Format("Cannot be null or empty ({0})", category == null ? "Is Null" : "Is empty"), "Category");
                     if (!testData.ContainsKey(category))
                         throw new ArgumentOutOfRangeException("category", category, "Category does not exist");
+
                     var wholeCategory = testData[category];
                     Logger.WriteLine(Logger.LogLevels.FrameworkDebug, "Got category [{0}] ({1} items)", category, wholeCategory.Count);
                     return wholeCategory;
@@ -168,6 +159,7 @@ public bool HasCategory(string key)
                     // Add Category if we dont already have it
                     if (!testData.ContainsKey(category))
                         testData.Add(category, new Dictionary<string, dynamic>());
+
                     Logger.WriteLine(Logger.LogLevels.FrameworkDebug, "Setting category [{0}] ({1} items)", category, value.Count);
                     testData[category] = value;
                 }
@@ -180,9 +172,11 @@ public bool HasCategory(string key)
             /// <returns>Object of Category and Name</returns>
             public U GetItem<U>(string category, string name)
             {
+                dynamic obtainedObject;
+
                 try
                 {
-                    dynamic obtainedObject = this[category, name];
+                    obtainedObject = this[category, name];
 
                     if (obtainedObject is U)
                     {
@@ -206,15 +200,14 @@ public U GetItem<U>(string category, string name)
                         }
                         catch { }
                     }
-
-                    throw new Exception(string.Format("Expected type [{0}] but got type [{1}].", typeof(U).Name, obtainedObject.GetType()));
                 }
                 catch (Exception ex)
                 {
                     throw new Exception(string.Format("Exception getting Category.Name ([{0}].[{1}])", category, name), ex);
                 }
-            }
 
+                throw new Exception(string.Format("Expected type [{0}] but got type [{1}].", typeof(U).Name, obtainedObject.GetType()));
+            }
 
             /// <summary>Returns named option from named category</summary>
             /// <param name="category">Category to obtain option from</param>
@@ -275,8 +268,6 @@ public Dictionary<string, dynamic> GetCategoryItems(string Category)
                     throw new Exception(string.Format("Exception getting itms in Category ([{0}])", Category), ex);
                 }
             }
-
         }
     }
-
-}
+}