mission syntax validation

Author: EthanMBoos

include/scrimmage/parse/MissionValidation.h

@@ -0,0 +1,111 @@
+/*!
+ * @file
+ *
+ * @section LICENSE
+ *
+ * Copyright (C) 2017 by the Georgia Tech Research Institute (GTRI)
+ *
+ * This file is part of SCRIMMAGE.
+ *
+ *   SCRIMMAGE is free software: you can redistribute it and/or modify it under
+ *   the terms of the GNU Lesser General Public License as published by the
+ *   Free Software Foundation, either version 3 of the License, or (at your
+ *   option) any later version.
+ *
+ *   SCRIMMAGE is distributed in the hope that it will be useful, but WITHOUT
+ *   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ *   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ *   License for more details.
+ *
+ *   You should have received a copy of the GNU Lesser General Public License
+ *   along with SCRIMMAGE.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @author Ethan M Boos <ethan.boos@gtri.gatech.edu>
+ * @date 06 April 2026
+ * @version 0.1.0
+ * @brief Brief file description.
+ * @section DESCRIPTION
+ * A Long description goes here.
+ *
+ */
+
+#ifndef INCLUDE_SCRIMMAGE_PARSE_MISSIONVALIDATION_H_
+#define INCLUDE_SCRIMMAGE_PARSE_MISSIONVALIDATION_H_
+
+#include <list>
+#include <map>
+#include <memory>
+#include <set>
+#include <string>
+#include <vector>
+
+namespace scrimmage {
+
+class FileSearch;
+class MissionParse;
+
+struct ValidationError {
+    enum class Type {
+        PLUGIN_CONFIG_NOT_FOUND,
+        PLUGIN_LIBRARY_NOT_FOUND,
+        PLUGIN_LIBRARY_INVALID,
+        UNKNOWN_PLUGIN_TYPE
+    };
+
+    Type type;
+    std::string plugin_name;
+    std::string plugin_type;  // autonomy, controller, motion_model, etc.
+    std::string context;      // location in mission file (entity block index or "global")
+    std::string message;
+    std::vector<std::string> suggestions;
+};
+
+struct ValidationResult {
+    bool valid() const { return errors.empty(); }
+    std::vector<ValidationError> errors;
+    std::map<std::string, std::set<std::string>> available_plugins;
+};
+
+class MissionValidation {
+ public:
+    ValidationResult validate(
+        const std::shared_ptr<MissionParse>& mp,
+        FileSearch& file_search);
+
+    void print_errors(
+        const ValidationResult& result,
+        const std::string& mission_filename) const;
+
+    void set_verbose(bool verbose) { verbose_ = verbose; }
+
+ protected:
+    bool check_plugin_config(
+        const std::string& plugin_name,
+        const std::string& env_var,
+        FileSearch& file_search);
+
+    std::map<std::string, std::set<std::string>> discover_plugins_by_type(
+        const std::string& env_var,
+        FileSearch& file_search);
+
+    std::vector<std::string> find_similar(
+        const std::string& name,
+        const std::set<std::string>& available,
+        size_t max_suggestions = 3) const;
+
+    size_t levenshtein_distance(
+        const std::string& s1,
+        const std::string& s2) const;
+
+    void extract_entity_plugins(
+        const std::map<int, std::map<std::string, std::string>>& entity_descs,
+        std::map<std::string, std::list<std::pair<std::string, std::string>>>& plugin_names) const;
+
+ private:
+    bool verbose_ = false;
+    std::set<std::string> validated_plugins_;
+};
+
+}  // namespace scrimmage
+
+#endif  // INCLUDE_SCRIMMAGE_PARSE_MISSIONVALIDATION_H_

src/CMakeLists.txt

@@ -21,7 +21,7 @@ set(SRCS
     math/StateWithCovariance.cpp
     metrics/Metrics.cpp
     network/Interface.cpp network/ScrimmageServiceImpl.cpp
-    parse/ConfigParse.cpp parse/MissionParse.cpp parse/ParseUtils.cpp
+    parse/ConfigParse.cpp parse/MissionParse.cpp parse/MissionValidation.cpp parse/ParseUtils.cpp
     #parse/XMLParser/RapidXMLParser.cpp
     plugin_manager/MotionModel.cpp plugin_manager/Plugin.cpp
     plugin_manager/PluginManager.cpp