feat: added a method in ConfigurationParser to validate if a file is …

…a valid yaml file
wazuh · Nov 12, 2024 · a1b61a3 · a1b61a3
1 parent 4fb8806
commit a1b61a3
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 0 deletions.
diff --git a/src/agent/configuration_parser/include/configuration_parser.hpp b/src/agent/configuration_parser/include/configuration_parser.hpp
@@ -75,5 +75,14 @@ namespace configuration
                 throw;
             }
         }
+
+        /// @brief Checks if the specified YAML file is valid.
+        ///
+        /// This function attempts to load the YAML file located at the given path.
+        /// If the file can be loaded without throwing an exception, it is considered valid.
+        ///
+        /// @param configFile The path to the YAML file to be validated.
+        /// @return `true` if the file is a valid YAML file; `false` otherwise.
+        bool isValidYamlFile(const std::filesystem::path& configFile) const;
     };
 } // namespace configuration
diff --git a/src/agent/configuration_parser/src/configuration_parser.cpp b/src/agent/configuration_parser/src/configuration_parser.cpp
@@ -98,4 +98,17 @@ namespace configuration
         }
     }
 
+    bool ConfigurationParser::isValidYamlFile(const std::filesystem::path& configFile) const
+    {
+        try
+        {
+            YAML::LoadFile(configFile.string());
+            return true;
+        }
+        catch (const std::exception&)
+        {
+            return false;
+        }
+    }
+
 } // namespace configuration
diff --git a/src/agent/configuration_parser/tests/configuration_parser_test.cpp b/src/agent/configuration_parser/tests/configuration_parser_test.cpp
@@ -307,6 +307,36 @@ TEST_F(ConfigurationParserInvalidYamlFileTest, InvalidConfigFileLoadsDefault)
     }
 }
 
+TEST_F(ConfigurationParserInvalidYamlFileTest, isValidYamlFileInvalid)
+{
+    try
+    {
+        const auto parser = std::make_unique<configuration::ConfigurationParser>();
+
+        EXPECT_FALSE(parser->isValidYamlFile(m_tempConfigFilePath));
+    }
+    catch (const std::exception&)
+    {
+        std::filesystem::remove(m_tempConfigFilePath);
+        throw;
+    }
+}
+
+TEST_F(ConfigurationParserFileTest, isValidYamlFileValid)
+{
+    try
+    {
+        const auto parser = std::make_unique<configuration::ConfigurationParser>();
+
+        EXPECT_TRUE(parser->isValidYamlFile(m_tempConfigFilePath));
+    }
+    catch (const std::exception&)
+    {
+        std::filesystem::remove(m_tempConfigFilePath);
+        throw;
+    }
+}
+
 int main(int argc, char** argv)
 {
     ::testing::InitGoogleTest(&argc, argv);