Merge pull request #40 from Neko-Box-Coder/ImprovedConfig

Neko-Box-Coder · web-flow · commit 72edb8c73226 · 2025-01-19T20:37:40.000Z
Improving user config &amp; build process to be more flexible
diff --git a/DefaultYAMLs/DefaultUserConfig.yaml b/DefaultYAMLs/DefaultUserConfig.yaml
diff --git a/Include/runcpp2/CompilingLinking.hpp b/Include/runcpp2/CompilingLinking.hpp
@@ -35,8 +35,7 @@ namespace runcpp2
                                 const std::vector<Data::DependencyInfo*>& availableDependencies,
                                 const Data::Profile& profile,
                                 const std::vector<std::string>& compiledObjectsPaths,
-                                bool buildExecutable,
-                                const std::string exeExt);
+                                bool buildExecutable);
 }
 
 #endif
diff --git a/Include/runcpp2/Data/BuildTypeHelper.hpp b/Include/runcpp2/Data/BuildTypeHelper.hpp
@@ -12,18 +12,15 @@ namespace runcpp2
     {
         namespace BuildTypeHelper
         {
-            const FileProperties* GetOutputFileProperties(  const FilesTypesInfo& filesTypes,
-                                                            BuildType buildType,
-                                                            bool asExecutable);
-            
             bool NeedsLinking(BuildType buildType);
             
-            bool GetOutputPath( const ghc::filesystem::path& buildDir,
-                                const std::string& scriptName,
-                                const Profile& profile,
-                                const BuildType buildType,
-                                const bool asExecutable,
-                                ghc::filesystem::path& outPath);
+            bool GetPossibleOutputPaths(const ghc::filesystem::path& buildDir,
+                                        const std::string& scriptName,
+                                        const Profile& profile,
+                                        const BuildType buildType,
+                                        const bool asExecutable,
+                                        std::vector<ghc::filesystem::path>& outPaths,
+                                        std::vector<bool>& outIsRunnable);
         }
     }
 }
diff --git a/Include/runcpp2/Data/StageInfo.hpp b/Include/runcpp2/Data/StageInfo.hpp
@@ -40,6 +40,7 @@ namespace runcpp2
                     std::vector<std::string> Setup;
                     std::vector<std::string> Cleanup;
                     std::vector<RunPart> RunParts;
+                    std::vector<std::string> ExpectedOutputFiles;
                 };
                 
                 struct 
@@ -52,6 +53,7 @@ namespace runcpp2
                 
                 using SubstitutionMap = std::unordered_map<std::string, std::vector<std::string>>;
                 
+                //TODO: Make this static function?
                 bool PerformSubstituions(   const SubstitutionMap& substitutionMap, 
                                             std::string& inOutSubstitutedString) const;
                 
diff --git a/Include/runcpp2/PipelineSteps.hpp b/Include/runcpp2/PipelineSteps.hpp
@@ -102,19 +102,21 @@ namespace runcpp2
                         int& returnStatus);
 
     PipelineResult 
-    HandleBuildOutput(  const ghc::filesystem::path& target,
+    HandleBuildOutput(  const std::vector<ghc::filesystem::path>& targets,
                         const std::vector<std::string>& filesToCopyPaths,
                         const Data::ScriptInfo& scriptInfo,
                         const Data::Profile& profile,
                         const std::string& buildOutputDir,
                         const std::unordered_map<CmdOptions, std::string>& currentOptions);
 
-    PipelineResult GetTargetPath(   const ghc::filesystem::path& buildDir,
-                                    const std::string& scriptName,
-                                    const Data::Profile& profile,
-                                    const std::unordered_map<CmdOptions, std::string>& currentOptions,
-                                    const Data::ScriptInfo& scriptInfo,
-                                    ghc::filesystem::path& outTarget);
+    PipelineResult GetBuiltTargetPaths( const ghc::filesystem::path& buildDir,
+                                        const std::string& scriptName,
+                                        const Data::Profile& profile,
+                                        const std::unordered_map<   CmdOptions, 
+                                                                    std::string>& currentOptions,
+                                        const Data::ScriptInfo& scriptInfo,
+                                        std::vector<ghc::filesystem::path>& outTargets,
+                                        ghc::filesystem::path* outRunnableTarget);
     
     bool GatherSourceFiles( const ghc::filesystem::path& absoluteScriptPath, 
                             const Data::ScriptInfo& scriptInfo,
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -254,8 +254,12 @@ pipeline
                         bash    "cd ./Build && ./runcpp2 -l " + 
                                 "-c ../DefaultYAMLs/DefaultUserConfig.yaml " + 
                                 "--log-level info ../Examples/test.cpp"
-                    }
-                    {
+                        bash    "cd ./Build && ./runcpp2 -l -b " + 
+                                "-c ../DefaultYAMLs/DefaultUserConfig.yaml " + 
+                                "--log-level info ../Examples/test.cpp"
+                        bash "ls -lah ./Build"
+                        
+                        
                         cleanWs()
                         bash "ls -lah"
                         unstash 'linux_build'
@@ -264,6 +268,7 @@ pipeline
                         bash    "cd ./Build && ./runcpp2 -l -b " + 
                                 "-c ../DefaultYAMLs/DefaultUserConfig.yaml " + 
                                 "--log-level info ../Examples/test_static.cpp"
+                        bash "ls -lah ./Build"
                     }
                     post { failure { script { FAILED_STAGE = env.STAGE_NAME } } }
                 }
@@ -295,15 +300,20 @@ pipeline
                         bat "cd .\\Build\\Debug && .\\runcpp2.exe -l " + 
                             "-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " + 
                             "--log-level info ..\\..\\Examples\\test.cpp"
-                    }
-                    {
+                        bat "cd .\\Build\\Debug && .\\runcpp2.exe -l -b " + 
+                            "-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " + 
+                            "--log-level info ..\\..\\Examples\\test.cpp"
+                        bat "dir .\\Build\\Debug"
+                        
+                        
                         cleanWs()
                         bat 'dir'
                         unstash 'windows_build'
                         bat 'dir'
                         bat "cd .\\Build\\Debug && .\\runcpp2.exe -l -b " + 
                             "-c ..\\..\\DefaultYAMLs\\DefaultUserConfig.yaml " + 
                             "--log-level info ..\\..\\Examples\\test_static.cpp"
+                        bat "dir .\\Build\\Debug"
                     }
                     post { failure { script { FAILED_STAGE = env.STAGE_NAME } } }
                 }
diff --git a/Src/Tests/Data/BuildTypeTest.cpp b/Src/Tests/Data/BuildTypeTest.cpp
@@ -66,33 +66,26 @@ int main(int argc, char** argv)
 
         ssTEST_OUTPUT_EXECUTION
         (
-            ghc::filesystem::path outPath;
-            bool result = runcpp2::Data::BuildTypeHelper::GetOutputPath(
-                buildDir, scriptName, profile, runcpp2::Data::BuildType::STATIC, false, outPath);
+            std::vector<ghc::filesystem::path> outTargets;
+            std::vector<bool> outIsRunnable;
+            bool result = BuildTypeHelper::GetPossibleOutputPaths(  buildDir, 
+                                                                    scriptName, 
+                                                                    profile, 
+                                                                    BuildType::STATIC, 
+                                                                    false, 
+                                                                    outTargets, 
+                                                                    outIsRunnable);
         );
 
         ssTEST_OUTPUT_ASSERT("GetOutputPath should succeed", result == true);
+        ssTEST_OUTPUT_ASSERT("GetOutputPath should return a single target", outTargets.size() == 1);
         #ifdef _WIN32
-            ssTEST_OUTPUT_ASSERT("Static library path", outPath, "build/test.lib");
+            ssTEST_OUTPUT_ASSERT("Static library path", outTargets.at(0), "build/test.lib");
         #else
-            ssTEST_OUTPUT_ASSERT("Static library path", outPath, "build/libtest.a");
+            ssTEST_OUTPUT_ASSERT("Static library path", outTargets.at(0), "build/libtest.a");
         #endif
     };
     
-    ssTEST("BuildType Should Map To Correct File Types")
-    {
-        ssTEST_OUTPUT_SETUP
-        (
-            runcpp2::Data::FilesTypesInfo filesTypes;
-        );
-
-        ssTEST_OUTPUT_ASSERT(   "Static build type",
-                                BuildTypeHelper::GetOutputFileProperties(   filesTypes, 
-                                                                            BuildType::STATIC, 
-                                                                            false), 
-                                &filesTypes.StaticLinkFile);
-    };
-    
     ssTEST_END_TEST_GROUP();
     return 0;
 } 
diff --git a/Src/Tests/Data/DependencyInfoTest.cpp b/Src/Tests/Data/DependencyInfoTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 Name: MyLibrary
                 Platforms:
diff --git a/Src/Tests/Data/DependencyLinkPropertyTest.cpp b/Src/Tests/Data/DependencyLinkPropertyTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 MSVC:
                     SearchLibraryNames: [mylib, mylib_static]
diff --git a/Src/Tests/Data/DependencySourceTest.cpp b/Src/Tests/Data/DependencySourceTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 Git:
                     URL: https://github.com/user/repo.git
@@ -57,6 +58,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 Local:
                     Path: ../external/mylib
diff --git a/Src/Tests/Data/FilePropertiesTest.cpp b/Src/Tests/Data/FilePropertiesTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 Prefix:
                     Windows: lib
diff --git a/Src/Tests/Data/FilesToCopyInfoTest.cpp b/Src/Tests/Data/FilesToCopyInfoTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 MSVC:
                 -   bin/Debug/mylib.dll
diff --git a/Src/Tests/Data/FilesTypesInfoTest.cpp b/Src/Tests/Data/FilesTypesInfoTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 ObjectLinkFile:
                     Prefix:
diff --git a/Src/Tests/Data/FlagsOverrideInfoTest.cpp b/Src/Tests/Data/FlagsOverrideInfoTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 Remove: -Wall
                 Append: -O3
diff --git a/Src/Tests/Data/ProfileTest.cpp b/Src/Tests/Data/ProfileTest.cpp
@@ -11,6 +11,7 @@ int main(int argc, char** argv)
     
     ssTEST("Profile Should Parse Valid YAML")
     {
+        //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
         const char* yamlStr = R"(
             Name: "g++"
             NameAliases: ["mingw"]
@@ -69,6 +70,7 @@ int main(int argc, char** argv)
                                 CommandPart: " -I\"{IncludeDirectoryPath}\""
                             -   Type: Once
                                 CommandPart: " \"{InputFilePath}\" -o \"{OutputFilePath}\""
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
                     ExecutableShared:
                         DefaultPlatform:
                             Flags: "-std=c++17 -Wall -g -fpic"
@@ -80,20 +82,23 @@ int main(int argc, char** argv)
                                 CommandPart: " -I\"{IncludeDirectoryPath}\""
                             -   Type: Once
                                 CommandPart: " \"{InputFilePath}\" -o \"{OutputFilePath}\""
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
                     Static:
                         DefaultPlatform:
                             Flags: "-std=c++17 -Wall -g"
                             Executable: "g++"
                             RunParts:
                             -   Type: Once
                                 CommandPart: "{Executable} -c {CompileFlags}"
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
                     Shared:
                         DefaultPlatform:
                             Flags: "-std=c++17 -Wall -g -fpic"
                             Executable: "g++"
                             RunParts:
                             -   Type: Once
                                 CommandPart: "{Executable} -c {CompileFlags}"
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
             Linker:
                 PreRun:
                     DefaultPlatform: ""
@@ -107,33 +112,38 @@ int main(int argc, char** argv)
                             RunParts:
                             -   Type: Once
                                 CommandPart: "{Executable} {LinkFlags} -o \"{OutputFilePath}\""
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
                         Windows:
                             Flags: "-Wl,-rpath,\\$ORIGIN"
                             Executable: "g++"
                             RunParts:
                             -   Type: Once
                                 CommandPart: "{Executable} {LinkFlags} -o \"{OutputFilePath}\""
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
                     Static:
                         DefaultPlatform:
                             Flags: ""
                             Executable: "g++"
                             RunParts:
                             -   Type: Once
                                 CommandPart: "{Executable} {LinkFlags} -o \"{OutputFilePath}\""
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
                     Shared:
                         Unix:
                             Flags: "-shared -Wl,-rpath,\\$ORIGIN"
                             Executable: "g++"
                             RunParts:
                             -   Type: Once
                                 CommandPart: "{Executable} {LinkFlags} -o \"{OutputFilePath}\""
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
                     ExecutableShared:
                         Unix:
                             Flags: "-shared -Wl,-rpath,\\$ORIGIN"
                             Executable: "g++"
                             RunParts:
                             -   Type: Once
                                 CommandPart: "{Executable} {LinkFlags} -o \"{OutputFilePath}\""
+                            ExpectedOutputFiles: ["TestOutputFile", "TestOutputFile2"]
         )";
         
         ssTEST_OUTPUT_SETUP
@@ -208,11 +218,17 @@ int main(int argc, char** argv)
             const auto& executableCompile = profile.Compiler.OutputTypes.Executable.at("DefaultPlatform");
         );
         ssTEST_OUTPUT_ASSERT(   "Compiler Executable flags", 
-                                executableCompile.Flags == "-std=c++17 -Wall -g");
+                                executableCompile.Flags, 
+                                "-std=c++17 -Wall -g");
         ssTEST_OUTPUT_ASSERT(   "Compiler Executable executable", 
-                                executableCompile.Executable == "g++");
+                                executableCompile.Executable, 
+                                "g++");
         ssTEST_OUTPUT_ASSERT(   "Compiler Executable RunParts size", 
-                                executableCompile.RunParts.size() == 3);
+                                executableCompile.RunParts.size(), 
+                                3);
+        ssTEST_OUTPUT_ASSERT(   "Compiler Executable ExpectedOutputFiles size", 
+                                executableCompile.ExpectedOutputFiles.size(), 
+                                2);
         
         //Verify Compiler ExecutableShared
         ssTEST_OUTPUT_SETUP
@@ -229,6 +245,9 @@ int main(int argc, char** argv)
         ssTEST_OUTPUT_ASSERT(   "Compiler ExecutableShared RunParts size", 
                                 executableSharedCompile.RunParts.size(), 
                                 3);
+        ssTEST_OUTPUT_ASSERT(   "Compiler ExecutableShared ExpectedOutputFiles size", 
+                                executableSharedCompile.ExpectedOutputFiles.size(), 
+                                2);
         
         //Verify Linker
         ssTEST_OUTPUT_ASSERT(   "Linker CheckExistence DefaultPlatform", 
@@ -243,6 +262,9 @@ int main(int argc, char** argv)
                                 executableLink.Executable == "g++");
         ssTEST_OUTPUT_ASSERT(   "Linker Executable RunParts size", 
                                 executableLink.RunParts.size() == 1);
+        ssTEST_OUTPUT_ASSERT(   "Linker Executable ExpectedOutputFiles size", 
+                                executableLink.ExpectedOutputFiles.size(), 
+                                2);
         
         //Verify Linker ExecutableShared
         ssTEST_OUTPUT_SETUP
@@ -259,6 +281,9 @@ int main(int argc, char** argv)
         ssTEST_OUTPUT_ASSERT(   "Linker ExecutableShared RunParts size", 
                                 executableSharedLink.RunParts.size(), 
                                 1);
+        ssTEST_OUTPUT_ASSERT(   "Linker ExecutableShared ExpectedOutputFiles size", 
+                                executableSharedLink.ExpectedOutputFiles.size(), 
+                                2);
         
         //Test ToString() and Equals()
         ssTEST_OUTPUT_EXECUTION
diff --git a/Src/Tests/Data/ProfilesCommandsTest.cpp b/Src/Tests/Data/ProfilesCommandsTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 MSVC:
                 -   mkdir build
diff --git a/Src/Tests/Data/ProfilesDefinesTest.cpp b/Src/Tests/Data/ProfilesDefinesTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 MSVC:
                 -   _WIN32
diff --git a/Src/Tests/Data/ProfilesFlagsOverrideTest.cpp b/Src/Tests/Data/ProfilesFlagsOverrideTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 MSVC:
                     Remove: /W4
diff --git a/Src/Tests/Data/ProfilesProcessPathsTest.cpp b/Src/Tests/Data/ProfilesProcessPathsTest.cpp
@@ -13,6 +13,7 @@ int main(int argc, char** argv)
     {
         ssTEST_OUTPUT_SETUP
         (
+            //NOTE: This is just a test YAML for validating parsing, don't use it for actual config
             const char* yamlStr = R"(
                 MSVC:
                 -   src/main.cpp
diff --git a/Src/Tests/Data/ScriptInfoTest.cpp b/Src/Tests/Data/ScriptInfoTest.cpp
diff --git a/Src/Tests/Data/StageInfoTest.cpp b/Src/Tests/Data/StageInfoTest.cpp
diff --git a/Src/runcpp2/CompilingLinking.cpp b/Src/runcpp2/CompilingLinking.cpp
diff --git a/Src/runcpp2/Data/BuildTypeHelper.cpp b/Src/runcpp2/Data/BuildTypeHelper.cpp
diff --git a/Src/runcpp2/Data/StageInfo.cpp b/Src/runcpp2/Data/StageInfo.cpp
diff --git a/Src/runcpp2/PipelineSteps.cpp b/Src/runcpp2/PipelineSteps.cpp
diff --git a/Src/runcpp2/runcpp2.cpp b/Src/runcpp2/runcpp2.cpp

Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,7 @@ namespace runcpp2`
`35`	`35`	`const std::vector<Data::DependencyInfo*>& availableDependencies,`
`36`	`36`	`const Data::Profile& profile,`
`37`	`37`	`const std::vector<std::string>& compiledObjectsPaths,`
`38`		`- bool buildExecutable,`
`39`		`- const std::string exeExt);`
	`38`	`+ bool buildExecutable);`
`40`	`39`	`}`
`41`	`40`
`42`	`41`	`#endif`
Original file line number	Diff line number	Diff line change
`@@ -12,18 +12,15 @@ namespace runcpp2`
`12`	`12`	`{`
`13`	`13`	`namespace BuildTypeHelper`
`14`	`14`	`{`
`15`		`- const FileProperties* GetOutputFileProperties( const FilesTypesInfo& filesTypes,`
`16`		`- BuildType buildType,`
`17`		`- bool asExecutable);`
`18`		`-`
`19`	`15`	`bool NeedsLinking(BuildType buildType);`
`20`	`16`
`21`		`- bool GetOutputPath( const ghc::filesystem::path& buildDir,`
`22`		`- const std::string& scriptName,`
`23`		`- const Profile& profile,`
`24`		`- const BuildType buildType,`
`25`		`- const bool asExecutable,`
`26`		`- ghc::filesystem::path& outPath);`
	`17`	`+ bool GetPossibleOutputPaths(const ghc::filesystem::path& buildDir,`
	`18`	`+ const std::string& scriptName,`
	`19`	`+ const Profile& profile,`
	`20`	`+ const BuildType buildType,`
	`21`	`+ const bool asExecutable,`
	`22`	`+ std::vector<ghc::filesystem::path>& outPaths,`
	`23`	`+ std::vector<bool>& outIsRunnable);`
`27`	`24`	`}`
`28`	`25`	`}`
`29`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ int main(int argc, char** argv)`
`13`	`13`	`{`
`14`	`14`	`ssTEST_OUTPUT_SETUP`
`15`	`15`	`(`
	`16`	`+ //NOTE: This is just a test YAML for validating parsing, don't use it for actual config`
`16`	`17`	`const char* yamlStr = R"(`
`17`	`18`	`Name: MyLibrary`
`18`	`19`	`Platforms:`