From 33f6089505eafdcc616c7bdc8d6ae95efb988596 Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 11:13:34 -0700
Subject: [PATCH 1/9] Improved readability of log messages by converting text
to use string interpolation.
---
BrowserEfficiencyTest/Arguments.cs | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/BrowserEfficiencyTest/Arguments.cs b/BrowserEfficiencyTest/Arguments.cs
index c9d4857..17ea042 100644
--- a/BrowserEfficiencyTest/Arguments.cs
+++ b/BrowserEfficiencyTest/Arguments.cs
@@ -200,7 +200,7 @@ private bool ProcessArgs(string[] args)
if (selectedWorkload == null)
{
argumentsAreValid = false;
- Logger.LogWriteLine(string.Format("The specified workload '{0}' was not found!", args[argNum]), false);
+ Logger.LogWriteLine($"The specified workload '{args[argNum]}' was not found!", false);
}
else
{
@@ -208,7 +208,7 @@ private bool ProcessArgs(string[] args)
if (!successfullyAddedScenarios)
{
argumentsAreValid = false;
- Logger.LogWriteLine(string.Format("Invalid scenario specified in workload '{0}'!", selectedWorkload.Name), false);
+ Logger.LogWriteLine($"Invalid scenario specified in workload '{selectedWorkload.Name}'!", false);
}
else
{
@@ -259,7 +259,7 @@ private bool ProcessArgs(string[] args)
else
{
argumentsAreValid = false;
- Logger.LogWriteLine(string.Format("The specified scenario '{0}' does not exist!", selectedScenario), false);
+ Logger.LogWriteLine($"The specified scenario '{selectedScenario}' does not exist!", false);
}
}
@@ -316,7 +316,7 @@ private bool ProcessArgs(string[] args)
if (!Directory.Exists(extensionsPath))
{
argumentsAreValid = false;
- Logger.LogWriteLine("Invalid extensions path: " + extensionsPath, false);
+ Logger.LogWriteLine($"Invalid extensions path: {extensionsPath}", false);
}
else
{
@@ -350,7 +350,7 @@ private bool ProcessArgs(string[] args)
{
// The specified measureset is invalid.
argumentsAreValid = false;
- Logger.LogWriteLine(string.Format("The specified measureset '{0}' does not exist!", measureSet), false);
+ Logger.LogWriteLine($"The specified measureset '{measureSet}' does not exist!", false);
}
}
@@ -417,7 +417,7 @@ private bool ProcessArgs(string[] args)
if (!Directory.Exists(BrowserProfilePath))
{
argumentsAreValid = false;
- Logger.LogWriteLine(string.Format("The profile path: {0} does not exist!", BrowserProfilePath), false);
+ Logger.LogWriteLine($"The profile path: {BrowserProfilePath} does not exist!", false);
}
}
else
@@ -444,7 +444,7 @@ private bool ProcessArgs(string[] args)
if (!File.Exists(CredentialPath))
{
argumentsAreValid = false;
- Logger.LogWriteLine(string.Format("The credential file: {0} does not exist!", CredentialPath), false);
+ Logger.LogWriteLine($"The credential file: {CredentialPath} does not exist!", false);
}
}
else
@@ -589,7 +589,7 @@ private bool ProcessArgs(string[] args)
break;
default:
argumentsAreValid = false;
- Logger.LogWriteLine(string.Format("Invalid argument encountered '{0}'", args[argNum]), false);
+ Logger.LogWriteLine($"Invalid argument encountered '{args[argNum]}'", false);
DisplayUsage();
break;
@@ -621,7 +621,7 @@ private bool ProcessArgs(string[] args)
}
}
- Logger.LogWriteLine(string.Format("BrowserEfficiencyTest Version: {0}", BrowserEfficiencyTestVersion), false);
+ Logger.LogWriteLine($"BrowserEfficiencyTest Version: {BrowserEfficiencyTestVersion}", false);
if (args.Length == 0)
{
@@ -682,12 +682,12 @@ private void DisplayAvailableWorkloads()
Logger.LogWriteLine("Available workloads and scenarios:", false);
foreach (var workload in _workloads)
{
- Logger.LogWriteLine(string.Format("Workload: {0}", workload.Name), false);
+ Logger.LogWriteLine($"Workload: {workload.Name}", false);
Logger.LogWriteLine(" Scenarios:", false);
foreach (var scenario in workload.Scenarios)
{
- Logger.LogWriteLine(string.Format(" {0}", scenario.ScenarioName), false);
+ Logger.LogWriteLine($" {scenario.ScenarioName}", false);
}
}
}
From 03d40d48fbb883f0bbb8f5fb55519957d56ff1bc Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 11:21:40 -0700
Subject: [PATCH 2/9] Converted text of Exception to utilize string
interpolation.
---
BrowserEfficiencyTest/CredentialManager.cs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/BrowserEfficiencyTest/CredentialManager.cs b/BrowserEfficiencyTest/CredentialManager.cs
index 0060841..f93c669 100644
--- a/BrowserEfficiencyTest/CredentialManager.cs
+++ b/BrowserEfficiencyTest/CredentialManager.cs
@@ -62,7 +62,7 @@ public UserInfo GetCredentials(string domain)
return item;
}
}
- throw new Exception("No credentials matching domain '" + domain + "' were found in " + _credentialsPath);
+ throw new Exception($"No credentials matching domain '{domain}' were found in {_credentialsPath}");
}
}
}
From 743283f5f9faaef84e49a3f3a28957e18dc5ee6f Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 11:42:50 -0700
Subject: [PATCH 3/9] Improved readability and reduced number of
String.Concat() invocations by converting text to use string interpolation.
---
BrowserEfficiencyTest/Logger.cs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/BrowserEfficiencyTest/Logger.cs b/BrowserEfficiencyTest/Logger.cs
index 4ee4b72..5263468 100644
--- a/BrowserEfficiencyTest/Logger.cs
+++ b/BrowserEfficiencyTest/Logger.cs
@@ -49,7 +49,7 @@ internal static class Logger
public static void SetupFileLogging(string path = null)
{
string _logPath = null;
- string fileName = string.Format("BrowserEfficiencyTestLog" + "_" + DateTime.Now.ToString("yyyyMMdd_HHmmss") + ".txt");
+ string fileName = $"BrowserEfficiencyTestLog_{DateTime.Now.ToString("yyyyMMdd_HHmmss")}.txt";
if (string.IsNullOrEmpty(path) )
{
@@ -87,7 +87,7 @@ public static void LogWriteLine(string logString, bool includeDateTimeStamp = tr
if (includeDateTimeStamp)
{
// prefix log message with the current date-time stamp
- dateTimeStamp = string.Format("[{0}] ", DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
+ dateTimeStamp = $"[{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss")}] ";
}
string logEntry = dateTimeStamp + logString;
From b73d626a69c2ba74cd62cd7446b05d766010fe2d Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 12:10:34 -0700
Subject: [PATCH 4/9] Improved readability and reduced number of
String.Concat() invocations by implementing string interpolation.
---
.../RemoteWebDriverExtension.cs | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/BrowserEfficiencyTest/RemoteWebDriverExtension.cs b/BrowserEfficiencyTest/RemoteWebDriverExtension.cs
index cf7d762..ac63f29 100644
--- a/BrowserEfficiencyTest/RemoteWebDriverExtension.cs
+++ b/BrowserEfficiencyTest/RemoteWebDriverExtension.cs
@@ -109,7 +109,7 @@ public static void CreateNewTab(this RemoteWebDriver remoteWebDriver)
// sanity check to make sure we in fact did get a new tab opened.
if (endingTabCount != (originalTabCount + 1))
{
- throw new Exception(string.Format("New tab was not created as expected! Expected {0} tabs but found {1} tabs.", (originalTabCount + 1), endingTabCount));
+ throw new Exception($"New tab was not created as expected! Expected {originalTabCount + 1} tabs but found {endingTabCount} tabs.");
}
// Go to that tab
@@ -280,7 +280,7 @@ public static void ClickElement(this RemoteWebDriver remoteWebDriver, IWebElemen
{
attempt++;
- Logger.LogWriteLine("Failed attempt " + attempt + " to click element " + element.ToString());
+ Logger.LogWriteLine($"Failed attempt {attempt} to click element {element.ToString()}");
Thread.Sleep(1000);
@@ -353,7 +353,7 @@ public static RemoteWebDriver CreateDriverAndMaximize(string browser, bool clear
edgeOptions.AddAdditionalCapability("extensionPaths", extensionPaths);
foreach (var path in extensionPaths)
{
- Logger.LogWriteLine("Sideloading extension(s) from " + path);
+ Logger.LogWriteLine($"Sideloading extension(s) from {path}");
}
}
@@ -372,7 +372,7 @@ public static RemoteWebDriver CreateDriverAndMaximize(string browser, bool clear
_port = edgeDriverService.Port;
_hostName = hostName;
- Logger.LogWriteLine(string.Format(" Instantiating EdgeDriver object for local execution - Host: {0} Port: {1}", _hostName, _port));
+ Logger.LogWriteLine($" Instantiating EdgeDriver object for local execution - Host: {_hostName} Port: {_port}");
ScenarioEventSourceProvider.EventLog.LaunchWebDriver(browser);
driver = new EdgeDriver(edgeDriverService, edgeOptions);
}
@@ -388,7 +388,7 @@ public static RemoteWebDriver CreateDriverAndMaximize(string browser, bool clear
_hostName = hostName;
var remoteUri = new Uri("http://" + _hostName + ":" + _port + "/");
- Logger.LogWriteLine(string.Format(" Instantiating RemoteWebDriver object for remote execution - Host: {0} Port: {1}", _hostName, _port));
+ Logger.LogWriteLine($" Instantiating RemoteWebDriver object for remote execution - Host: {_hostName} Port: {_port}");
ScenarioEventSourceProvider.EventLog.LaunchWebDriver(browser);
driver = new RemoteWebDriver(remoteUri, edgeOptions.ToCapabilities());
}
@@ -406,10 +406,10 @@ public static RemoteWebDriver CreateDriverAndMaximize(string browser, bool clear
}
_edgeBrowserBuildNumber = GetEdgeBuildNumber(driver);
- Logger.LogWriteLine(string.Format(" Browser Version - MicrosoftEdge Build Version: {0}", _edgeBrowserBuildNumber));
+ Logger.LogWriteLine($" Browser Version - MicrosoftEdge Build Version: {_edgeBrowserBuildNumber}");
_edgeWebDriverBuildNumber = GetEdgeWebDriverVersion(driver);
- Logger.LogWriteLine(string.Format(" WebDriver Server Version - MicrosoftWebDriver.exe File Version: {0}", _edgeWebDriverBuildNumber));
+ Logger.LogWriteLine($" WebDriver Server Version - MicrosoftWebDriver.exe File Version: {_edgeWebDriverBuildNumber}");
break;
}
@@ -443,7 +443,7 @@ private static int GetEdgeBuildNumber(RemoteWebDriver remoteWebDriver)
}
else
{
- Logger.LogWriteLine(string.Format(" Unable to extract Edge build version from {0}", edgeVersionToken));
+ Logger.LogWriteLine($" Unable to extract Edge build version from {edgeVersionToken}");
}
}
}
From 75faf67312b240f0dd3f98f300ddaa610155095c Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 12:48:32 -0700
Subject: [PATCH 5/9] Modified GetResults() to use the StringBuilder Class for
appending components - improving memory usage; Implemented string
interpolation to reduce number of String.Concat() invocations; Added
measureSet parameter comment and corrected a spelling error
---
BrowserEfficiencyTest/ResponsivenessTimer.cs | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/BrowserEfficiencyTest/ResponsivenessTimer.cs b/BrowserEfficiencyTest/ResponsivenessTimer.cs
index 011e0e6..be2ee93 100644
--- a/BrowserEfficiencyTest/ResponsivenessTimer.cs
+++ b/BrowserEfficiencyTest/ResponsivenessTimer.cs
@@ -56,7 +56,7 @@ public void SetBrowser(string browser, Dictionary<string, string> extensionsName
{
foreach (var extension in extensionsNameAndVersion)
{
- _browser = _browser + "|" + extension.Key + " " + extension.Value;
+ _browser = $"{_browser}|{extension.Key} {extension.Value}";
}
}
}
@@ -64,14 +64,14 @@ public void SetBrowser(string browser, Dictionary<string, string> extensionsName
/// <summary>
/// Sets the measureSet, which will be included when a measurement is recorded later.
/// </summary>
- /// <param name="measureSet"></param>
+ /// <param name="measureSet">The current measureSet</param>
public void SetMeasureSet(string measureSet)
{
_measureSet = measureSet;
}
/// <summary>
- /// Sets the sceanrio, which will be included when a measurement is recorded later.
+ /// Sets the scenario, which will be included when a measurement is recorded later.
/// </summary>
/// <param name="scenario">The current scenario</param>
public void SetScenario(string scenario)
@@ -105,16 +105,16 @@ public List<string> GetResults()
List<string> results = new List<string>();
foreach (List<string> result in _results)
{
- string resultString = "";
+ StringBuilder resultString = new StringBuilder();
foreach(string component in result)
{
- if (resultString != "")
+ if (resultString.ToString() != "")
{
- resultString += ",";
+ resultString.Append(",");
}
- resultString += component;
+ resultString.Append(component);
}
- results.Add(resultString);
+ results.Add(resultString.ToString());
}
return results;
}
@@ -134,7 +134,7 @@ public void ExtractPageLoadTime(string pageLoaded = null)
string measureName = "Page Load Time (ms)";
if (pageLoaded != null && pageLoaded != "")
{
- measureName += ": " + pageLoaded;
+ measureName += $": {pageLoaded}";
}
MakeRecord(measureName, timeToLoad.ToString());
}
@@ -157,7 +157,7 @@ private void MakeRecord(string measure, string result)
record.Add(_browser);
record.Add(now.ToString("yyyyMMdd"));
record.Add(now.ToString("HHmmss"));
- record.Add("responsiveness (" + _measureSet + ")");
+ record.Add($"responsiveness ({_measureSet})");
record.Add(measure);
record.Add(result);
_results.Add(record);
From 30bce16850ba7c17d2919916cfd6fefa4bc37ffe Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 12:52:17 -0700
Subject: [PATCH 6/9] Corrected parameter comment capitalization
---
BrowserEfficiencyTest/ResponsivenessTimer.cs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/BrowserEfficiencyTest/ResponsivenessTimer.cs b/BrowserEfficiencyTest/ResponsivenessTimer.cs
index be2ee93..f400db8 100644
--- a/BrowserEfficiencyTest/ResponsivenessTimer.cs
+++ b/BrowserEfficiencyTest/ResponsivenessTimer.cs
@@ -64,7 +64,7 @@ public void SetBrowser(string browser, Dictionary<string, string> extensionsName
/// <summary>
/// Sets the measureSet, which will be included when a measurement is recorded later.
/// </summary>
- /// <param name="measureSet">The current measureSet</param>
+ /// <param name="measureSet">The current measureset</param>
public void SetMeasureSet(string measureSet)
{
_measureSet = measureSet;
From ab88165a70724fe503b3d8ba152bfa69317f07e1 Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 13:10:08 -0700
Subject: [PATCH 7/9] Corrected a spelling error for a property name
---
BrowserEfficiencyTest/ResponsivenessTimer.cs | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/BrowserEfficiencyTest/ResponsivenessTimer.cs b/BrowserEfficiencyTest/ResponsivenessTimer.cs
index f400db8..8e908c3 100644
--- a/BrowserEfficiencyTest/ResponsivenessTimer.cs
+++ b/BrowserEfficiencyTest/ResponsivenessTimer.cs
@@ -18,7 +18,7 @@ namespace BrowserEfficiencyTest
internal class ResponsivenessTimer
{
private List<List<String>> _results;
- private string _currentSceanrio;
+ private string _currentScenario;
private int _iteration;
private string _browser;
private string _measureSet;
@@ -76,7 +76,7 @@ public void SetMeasureSet(string measureSet)
/// <param name="scenario">The current scenario</param>
public void SetScenario(string scenario)
{
- _currentSceanrio = scenario;
+ _currentScenario = scenario;
}
/// <summary>
@@ -152,7 +152,7 @@ private void MakeRecord(string measure, string result)
DateTime now = DateTime.Now;
List<String> record = new List<String>();
record.Add("no_etl");
- record.Add(_currentSceanrio);
+ record.Add(_currentScenario);
record.Add(_iteration.ToString());
record.Add(_browser);
record.Add(now.ToString("yyyyMMdd"));
From cc07c2fcf7c82ec1139bbc0c2513ad794e31c5f1 Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Thu, 2 Aug 2018 14:15:11 -0700
Subject: [PATCH 8/9] Implemented string interpolation to improve code
readability; Created string "noValidExtensionMessage" to store text due to
the message being multiple lines, reducing need to change text in multiple
places in the future.
---
BrowserEfficiencyTest/ScenarioRunner.cs | 80 ++++++++++++-------------
1 file changed, 40 insertions(+), 40 deletions(-)
diff --git a/BrowserEfficiencyTest/ScenarioRunner.cs b/BrowserEfficiencyTest/ScenarioRunner.cs
index a2866ff..83732b1 100644
--- a/BrowserEfficiencyTest/ScenarioRunner.cs
+++ b/BrowserEfficiencyTest/ScenarioRunner.cs
@@ -153,7 +153,7 @@ private List<string> GetExtensionPaths(string path)
var extensionStagingPath = Path.Combine(ExtensionsStagingRootPath, directoryName, extensionFolderName);
Directory.CreateDirectory(extensionStagingPath);
- Logger.LogWriteLine("Staging extensions files: Source='" + extensionPath + "' Destination='" + extensionStagingPath + "'", false);
+ Logger.LogWriteLine($"Staging extensions files: Source='{extensionPath}' Destination='{extensionStagingPath}'", false);
try
{
@@ -170,19 +170,19 @@ private List<string> GetExtensionPaths(string path)
}
catch (Exception ex)
{
- Logger.LogWriteLine("Copying of extension(s) failed with: \n" + ex.Message);
- throw new Exception("Copying of extension(s) failed with: \n" + ex.Message);
+ Logger.LogWriteLine($"Copying of extension(s) failed with: \n{ex.Message}");
+ throw new Exception($"Copying of extension(s) failed with: \n{ex.Message}");
}
}
}
else
{
- Logger.LogWriteLine("No valid extensions found in given path " + path +
- ". The folder structure should be as follows: \n" +
- "unpackedExtensions \n| ----extension1\n| ----| ----Assets\n| ----| ----AppXManifest.xml\n| ----| ----Extension\n| ----| ----| ----manifest.json\n| ----| ----| ---- < otherExtFiles >\n| ----extension2\n| ----| ----Assets\n| ----| ----AppXManifest.xml\n| ----| ----Extension\n| ----| ----| ----manifest.json\n| ----| ----| ---- < otherExtFiles >");
- throw new Exception("No valid extensions found in given path " + path +
- ". The folder structure should be as follows: \n" +
- "unpackedExtensions \n| ----extension1\n| ----| ----Assets\n| ----| ----AppXManifest.xml\n| ----| ----Extension\n| ----| ----| ----manifest.json\n| ----| ----| ---- < otherExtFiles >\n| ----extension2\n| ----| ----Assets\n| ----| ----AppXManifest.xml\n| ----| ----Extension\n| ----| ----| ----manifest.json\n| ----| ----| ---- < otherExtFiles >");
+ string noValidExtensionsMessage = "No valid extensions found in given path " + path
+ + ". The folder structure should be as follows: \n"
+ + "unpackedExtensions \n| ----extension1\n| ----| ----Assets\n| ----| ----AppXManifest.xml\n| ----| ----Extension\n| ----| ----| ----manifest.json\n| ----| ----| ---- < otherExtFiles >\n| ----extension2\n| ----| ----Assets\n| ----| ----AppXManifest.xml\n| ----| ----Extension\n| ----| ----| ----manifest.json\n| ----| ----| ---- < otherExtFiles >";
+
+ Logger.LogWriteLine(noValidExtensionsMessage);
+ throw new Exception(noValidExtensionsMessage);
}
return sideloadExtensionPaths;
@@ -226,7 +226,7 @@ private static void DirectoryCopy(string sourceDirectoryName, string destination
if (!sourceDirectory.Exists)
{
- throw new DirectoryNotFoundException("Source directory does not exist or could not be found: " + sourceDirectoryName);
+ throw new DirectoryNotFoundException($"Source directory does not exist or could not be found: {sourceDirectoryName}");
}
DirectoryInfo[] sourceSubDirectories = sourceDirectory.GetDirectories();
@@ -307,7 +307,7 @@ public void Run()
Logger.LogWriteLine(string.Format(" Executing warmup of {0} browser", browser));
// use -1 as the iteration value to denote warmup run
ExecuteWorkload(-1, browser, "None", "", "", true, false, elevatorClient);
- Logger.LogWriteLine(string.Format(" Completed warmup of {0} browser", browser));
+ Logger.LogWriteLine($" Completed warmup of {browser} browser");
}
}
ScenarioEventSourceProvider.EventLog.WarmupExecutionStop();
@@ -338,7 +338,7 @@ public void Run()
// TODO: Consider breaking up this large loop into smaller methods to ease readability.
for (int iteration = 0; iteration < _iterations; iteration++)
{
- Logger.LogWriteLine(string.Format("Iteration: {0} ------------------", iteration));
+ Logger.LogWriteLine($"Iteration: {iteration} ------------------");
_timer.SetIteration(iteration);
foreach (var currentMeasureSet in _measureSets)
{
@@ -349,7 +349,7 @@ public void Run()
// The idea is to get a baseline performance capture of the system without the browser and test pass so it
// can be used as a comparison.
- Logger.LogWriteLine(string.Format(" Starting capture of system baseline for {0} seconds - measureset {1} iteration {2}", _baselineCaptureSeconds, currentMeasureSet.Value.Item1, iteration));
+ Logger.LogWriteLine($" Starting capture of system baseline for {_baselineCaptureSeconds} seconds - measureset {currentMeasureSet.Value.Item1} iteration {iteration}");
// Start the trace capture for baseline scenario
elevatorClient.SendControllerMessageAsync($"{Elevator.Commands.START_BROWSER} BASE ITERATION {iteration} SCENARIO_NAME BaseLineCapture WPRPROFILE {currentMeasureSet.Value.Item1} MODE {currentMeasureSet.Value.Item2}").Wait();
@@ -360,7 +360,7 @@ public void Run()
ScenarioEventSourceProvider.EventLog.MeasurementRegionStop("BaselineCapture");
- Logger.LogWriteLine(string.Format(" Finished capture of system baseline of measureset {0} iteration {1}", currentMeasureSet.Value.Item1, iteration));
+ Logger.LogWriteLine($" Finished capture of system baseline of measureset {currentMeasureSet.Value.Item1} iteration {iteration}");
// End the trace capture for baseline scenario
elevatorClient.SendControllerMessageAsync($"{Elevator.Commands.END_BROWSER} BASE").Wait();
@@ -420,19 +420,19 @@ private bool ExecuteWorkload(int iteration, string browser, string measureSetNam
if(!string.IsNullOrEmpty(_executeScriptFileName))
{
// execute the selected script and pass "STARTSCENARIO"+<scenario>+<iteration>
- ExecuteScript(_executeScriptFileName, "STARTSCENARIO " + _scenarios[0].ScenarioName + " " + iteration.ToString());
+ ExecuteScript(_executeScriptFileName, $"STARTSCENARIO {_scenarios[0].ScenarioName} {iteration.ToString()}");
}
if (usingTraceController)
{
- Logger.LogWriteLine(string.Format(" Pausing {0} seconds after starting the trace session to reduce interference.", _e3RefreshDelaySeconds));
+ Logger.LogWriteLine($" Pausing {_e3RefreshDelaySeconds} seconds after starting the trace session to reduce interference.");
// E3 system aggregates energy data at regular intervals. For our test passes we use 10 second intervals. Waiting here for 12 seconds before continuing ensures
// that the browser energy data reported by E3 for this run is only for this run and does not bleed into any other runs.
Thread.Sleep(_e3RefreshDelaySeconds * 1000);
}
- Logger.LogWriteLine(string.Format(" Launching Browser Driver: '{0}'", browser));
+ Logger.LogWriteLine($" Launching Browser Driver: '{browser}'");
ScenarioEventSourceProvider.EventLog.WorkloadStart(_workloadName, browser, wprProfileName, iteration, attemptNumber);
using (var driver = RemoteWebDriverExtension.CreateDriverAndMaximize(browser, _clearBrowserCache, _enableVerboseLogging, _browserProfilePath, _extensionsPaths, _port, _hostName))
@@ -469,7 +469,7 @@ private bool ExecuteWorkload(int iteration, string browser, string measureSetNam
ExecuteScript(_executeScriptFileName, "ENDSCENARIO");
// execute the selected script and pass "STARTSCENARIO"+<scenario>+<iteration>
- ExecuteScript(_executeScriptFileName, "STARTSCENARIO " + currentScenario.ScenarioName + " " + iteration.ToString());
+ ExecuteScript(_executeScriptFileName, $"STARTSCENARIO {currentScenario.ScenarioName} {iteration.ToString()}");
}
// Save the name of the current scenarion in case an exception is thrown in which case the local variable 'currentScenario' will be lost
@@ -492,7 +492,7 @@ private bool ExecuteWorkload(int iteration, string browser, string measureSetNam
isFirstScenario = false;
- Logger.LogWriteLine(string.Format(" Executing - Scenario: {0} Iteration: {1} Attempt: {2} Browser: {3} MeasureSet: {4}", currentScenario.ScenarioName, iteration, attemptNumber, browser, measureSetName));
+ Logger.LogWriteLine($" Executing - Scenario: {currentScenario.ScenarioName} Iteration: {iteration} Attempt: {attemptNumber} Browser: {browser} MeasureSet: {measureSetName}");
ScenarioEventSourceProvider.EventLog.ScenarioExecutionStart(browser, currentScenario.ScenarioName);
// Here, control is handed to the scenario to navigate, and do whatever it wants
@@ -507,26 +507,26 @@ private bool ExecuteWorkload(int iteration, string browser, string measureSetNam
{
// Of course it's possible we don't get control back until after we were supposed to
// continue to the next scenario. In that case, invalidate the run by throwing.
- Logger.LogWriteLine(string.Format(" !!! Scenario {0} ran longer than expected! The browser ran for {1}s. The timeout for this scenario is {2}s.", currentScenario.ScenarioName, runTime.TotalSeconds, currentScenario.Duration));
- throw new Exception(string.Format("Scenario {0} ran longer than expected! The browser ran for {1}s. The timeout for this scenario is {2}s.", currentScenario.ScenarioName, runTime.TotalSeconds, currentScenario.Duration));
+ Logger.LogWriteLine($" !!! Scenario {currentScenario.ScenarioName} ran longer than expected! The browser ran for {runTime.TotalSeconds}s. The timeout for this scenario is {currentScenario.Duration}s.");
+ throw new Exception($"Scenario {currentScenario.ScenarioName} ran longer than expected! The browser ran for {runTime.TotalSeconds}s. The timeout for this scenario is {currentScenario.Duration}s.");
}
else if (!overrideTimeout)
{
ScenarioEventSourceProvider.EventLog.ScenarioIdleStart(currentScenario.ScenarioName, timeLeft.TotalSeconds);
- Logger.LogWriteLine(string.Format(" Scenario {0} returned in {1} seconds. Sleep for remaining {2} seconds.", currentScenario.ScenarioName, runTime.TotalSeconds, timeLeft.TotalSeconds));
+ Logger.LogWriteLine($" Scenario {currentScenario.ScenarioName} returned in {runTime.TotalSeconds} seconds. Sleep for remaining {timeLeft.TotalSeconds} seconds.");
Thread.Sleep((int)timeLeft.TotalMilliseconds);
ScenarioEventSourceProvider.EventLog.ScenarioIdleStop(currentScenario.ScenarioName, timeLeft.TotalSeconds);
}
ScenarioEventSourceProvider.EventLog.ScenarioExecutionStop(browser, currentScenario.ScenarioName);
- Logger.LogWriteLine(string.Format(" Completed - Scenario: {0} Iteration: {1} Attempt: {2} Browser: {3} MeasureSet: {4}", currentScenario.ScenarioName, iteration, attemptNumber, browser, measureSetName, runTime.TotalSeconds));
+ Logger.LogWriteLine($" Completed - Scenario: {currentScenario.ScenarioName} Iteration: {iteration} Attempt: {attemptNumber} Browser: {browser} MeasureSet: {measureSetName}");
scenarioIndex++;
}
driver.CloseBrowser(browser);
passSucceeded = true;
- Logger.LogWriteLine(string.Format(" SUCCESS! Completed Browser: {0} Iteration: {1} Attempt: {2} MeasureSet: {3}", browser, iteration, attemptNumber, measureSetName));
+ Logger.LogWriteLine($" SUCCESS! Completed Browser: {browser} Iteration: {iteration} Attempt: {attemptNumber} MeasureSet: {measureSetName}");
ScenarioEventSourceProvider.EventLog.WorkloadStop(_workloadName, browser, wprProfileName, iteration, attemptNumber);
}
catch (Exception ex)
@@ -564,12 +564,12 @@ private bool ExecuteWorkload(int iteration, string browser, string measureSetNam
driver.CloseBrowser(browser);
Logger.LogWriteLine("------ EXCEPTION caught while trying to run scenario! ------------------------------------");
- Logger.LogWriteLine(string.Format(" Iteration: {0}", iteration));
- Logger.LogWriteLine(string.Format(" Measure Set: {0}", measureSetName));
- Logger.LogWriteLine(string.Format(" Browser: {0}", browser));
- Logger.LogWriteLine(string.Format(" Attempt: {0}", attemptNumber));
- Logger.LogWriteLine(string.Format(" Scenario: {0}", currentScenarioName));
- Logger.LogWriteLine(" Exception: " + ex.ToString());
+ Logger.LogWriteLine($" Iteration: {iteration}");
+ Logger.LogWriteLine($" Measure Set: {measureSetName}");
+ Logger.LogWriteLine($" Browser: {browser}");
+ Logger.LogWriteLine($" Attempt: {attemptNumber}");
+ Logger.LogWriteLine($" Scenario: {currentScenarioName}");
+ Logger.LogWriteLine($" Exception: {ex.ToString()}");
if (usingTraceController)
{
@@ -582,7 +582,7 @@ private bool ExecuteWorkload(int iteration, string browser, string measureSetNam
{
if (usingTraceController)
{
- Logger.LogWriteLine(string.Format(" Pausing {0} seconds before stopping the trace session to reduce interference.", _e3RefreshDelaySeconds));
+ Logger.LogWriteLine($" Pausing {_e3RefreshDelaySeconds} seconds before stopping the trace session to reduce interference.");
// E3 system aggregates energy data at regular intervals. For our test passes we use 10 second intervals. Waiting here for 12 seconds before continuing ensures
// that the browser energy data reported by E3 for this run is only for this run and does not bleed into any other runs.
@@ -605,8 +605,8 @@ private bool ExecuteWorkload(int iteration, string browser, string measureSetNam
else
{
CleanupExtensions();
- Logger.LogWriteLine(string.Format("!!! Failed to successfully complete iteration {0} with browser '{1}' after {2} attempts!", iteration, browser, _maxAttempts));
- throw new Exception(string.Format("!!! Failed to successfully complete iteration {0} with browser '{1}' after {2} attempts!", iteration, browser, _maxAttempts));
+ Logger.LogWriteLine($"!!! Failed to successfully complete iteration {iteration} with browser '{browser}' after {_maxAttempts} attempts!");
+ throw new Exception($"!!! Failed to successfully complete iteration {iteration} with browser '{browser}' after {_maxAttempts} attempts!");
}
return passSucceeded;
@@ -618,9 +618,9 @@ private void LogOsVersion()
using (RegistryKey regKey = Registry.LocalMachine.OpenSubKey(@"software\microsoft\windows NT\currentVersion"))
{
Logger.LogWriteLine("--- OS Version ------");
- Logger.LogWriteLine(string.Format(" BuildLabEx: {0}", (string)regKey.GetValue("BuildLabEx")));
- Logger.LogWriteLine(string.Format(" EditionID: {0}", (string)regKey.GetValue("EditionID")));
- Logger.LogWriteLine(string.Format(" ProductName: {0}", (string)regKey.GetValue("ProductName")));
+ Logger.LogWriteLine($" BuildLabEx: {(string)regKey.GetValue("BuildLabEx")}");
+ Logger.LogWriteLine($" EditionID: {(string)regKey.GetValue("EditionID")}");
+ Logger.LogWriteLine($" ProductName: {(string)regKey.GetValue("ProductName")}");
Logger.LogWriteLine("---------------------");
}
}
@@ -630,7 +630,7 @@ private bool ExecuteScript(string scriptFileName, string parameterString)
{
bool isSuccess = false;
- Logger.LogWriteLine(string.Format(" Executing script: {0} {1}", scriptFileName, parameterString));
+ Logger.LogWriteLine($" Executing script: {scriptFileName} {parameterString}");
if (string.IsNullOrEmpty(scriptFileName))
{
@@ -654,9 +654,9 @@ private bool ExecuteScript(string scriptFileName, string parameterString)
catch (Exception ex)
{
Logger.LogWriteLine("------ EXCEPTION caught while trying to execute a script in a separate process! ------------------------------------");
- Logger.LogWriteLine(string.Format(" Script: {0}", scriptFileName));
- Logger.LogWriteLine(string.Format(" Parameters: {0}", parameterString));
- Logger.LogWriteLine(" Exception: " + ex.ToString());
+ Logger.LogWriteLine($" Script: {scriptFileName}");
+ Logger.LogWriteLine($" Parameters: {parameterString}");
+ Logger.LogWriteLine($" Exception: {ex.ToString()}");
throw;
}
From 80dfc5709859fb8703b8881dd14a0bb0cc3c482b Mon Sep 17 00:00:00 2001
From: paulritzman <ritzman.paul@gmail.com>
Date: Sat, 4 Aug 2018 01:51:33 -0700
Subject: [PATCH 9/9] Reimplemented String.Format for the fileName string
within the SetupFileLogging method in Logger.cs - due to readability
---
BrowserEfficiencyTest/Logger.cs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/BrowserEfficiencyTest/Logger.cs b/BrowserEfficiencyTest/Logger.cs
index 5263468..09dadfc 100644
--- a/BrowserEfficiencyTest/Logger.cs
+++ b/BrowserEfficiencyTest/Logger.cs
@@ -49,7 +49,7 @@ internal static class Logger
public static void SetupFileLogging(string path = null)
{
string _logPath = null;
- string fileName = $"BrowserEfficiencyTestLog_{DateTime.Now.ToString("yyyyMMdd_HHmmss")}.txt";
+ string fileName = String.Format("BrowserEfficiencyTestLog_{0}.txt", DateTime.Now.ToString("yyyyMMdd_HHmmss"));
if (string.IsNullOrEmpty(path) )
{