From c7753f472bbd7e248689a273125b3b75d7b63ead Mon Sep 17 00:00:00 2001
From: jonawals <jonawals@amazon.com>
Date: Tue, 1 Jun 2021 16:11:25 +0100
Subject: [PATCH] Add API comment and rename factory

---
 .../Console/Static/Code/Source/TestImpactConsoleMain.cpp      | 4 ++--
 ...nFactory.cpp => TestImpactRuntimeConfigurationFactory.cpp} | 4 ++--
 ...ationFactory.h => TestImpactRuntimeConfigurationFactory.h} | 3 ++-
 3 files changed, 6 insertions(+), 5 deletions(-)
 rename Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/{TestImpactConfigurationFactory.cpp => TestImpactRuntimeConfigurationFactory.cpp} (98%)
 rename Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/{TestImpactConfigurationFactory.h => TestImpactRuntimeConfigurationFactory.h} (76%)

diff --git a/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConsoleMain.cpp b/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConsoleMain.cpp
index 0d4f08406e..84e16c2332 100644
--- a/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConsoleMain.cpp
+++ b/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConsoleMain.cpp
@@ -24,7 +24,7 @@
 
 #include <TestImpactConsoleTestSequenceEventHandler.h>
 #include <TestImpactCommandLineOptions.h>
-#include <TestImpactConfigurationFactory.h>
+#include <TestImpactRuntimeConfigurationFactory.h>
 #include <TestImpactCommandLineOptionsException.h>
 
 #include <AzCore/IO/SystemFile.h>
@@ -166,7 +166,7 @@ namespace TestImpact
 
                 std::cout << "Constructing in-memory model of source tree and test coverage, this may take a moment...\n";
                 Runtime runtime(
-                    ConfigurationFactory(ReadFileContents<CommandLineOptionsException>(options.GetConfigurationFile())),
+                    RuntimeConfigurationFactory(ReadFileContents<CommandLineOptionsException>(options.GetConfigurationFile())),
                     options.GetExecutionFailurePolicy(),
                     options.GetExecutionFailureDraftingPolicy(),
                     options.GetTestFailurePolicy(),
diff --git a/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConfigurationFactory.cpp b/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactRuntimeConfigurationFactory.cpp
similarity index 98%
rename from Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConfigurationFactory.cpp
rename to Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactRuntimeConfigurationFactory.cpp
index a6e8ee9639..4ac97bef49 100644
--- a/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConfigurationFactory.cpp
+++ b/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactRuntimeConfigurationFactory.cpp
@@ -12,7 +12,7 @@
 
 #include <TestImpactFramework/TestImpactConfigurationException.h>
 
-#include <TestImpactConfigurationFactory.h>
+#include <TestImpactRuntimeConfigurationFactory.h>
 
 #include <AzCore/JSON/document.h>
 #include <AzCore/std/functional.h>
@@ -185,7 +185,7 @@ namespace TestImpact
         return targetConfig;
     }
 
-    RuntimeConfig ConfigurationFactory(const AZStd::string& configurationData)
+    RuntimeConfig RuntimeConfigurationFactory(const AZStd::string& configurationData)
     {
         RuntimeConfig runtimeConfig;
         rapidjson::Document configurationFile;
diff --git a/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConfigurationFactory.h b/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactRuntimeConfigurationFactory.h
similarity index 76%
rename from Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConfigurationFactory.h
rename to Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactRuntimeConfigurationFactory.h
index 2cc75ab0fa..ac7dbbac94 100644
--- a/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactConfigurationFactory.h
+++ b/Code/Tools/TestImpactFramework/Frontend/Console/Static/Code/Source/TestImpactRuntimeConfigurationFactory.h
@@ -14,5 +14,6 @@
 
 namespace TestImpact
 {
-    RuntimeConfig ConfigurationFactory(const AZStd::string& configurationData);
+    //! Parses the configuration data (in JSON format) and returns the constructed runtime configuration.
+    RuntimeConfig RuntimeConfigurationFactory(const AZStd::string& configurationData);
 } // namespace TestImpact