YamlReaderConfiguration.cpp

// Copyright 2022 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include <ddspipe_yaml/yaml_configuration_tags.hpp>
#include <ddspipe_yaml/Yaml.hpp>
#include <ddspipe_yaml/YamlManager.hpp>
#include <ddspipe_yaml/YamlReader.hpp>
#include <ddspipe_yaml/YamlValidator.hpp>

#include <ddsrouter_core/configuration/DdsRouterConfiguration.hpp>

#include <ddsrouter_yaml/YamlReaderConfiguration.hpp>
#include <ddsrouter_yaml/DdsRouterConfigSchema.hpp>

namespace eprosima {
namespace ddsrouter {
namespace yaml {

core::DdsRouterConfiguration
YamlReaderConfiguration::load_ddsrouter_configuration(
        const Yaml& yml,
        const CommandlineArgsRouter* args /*= nullptr*/)
{
    // Ensure the Yaml is valid
    ddspipe::yaml::YamlValidator validator = ddspipe::yaml::YamlValidator(
        ddspipe::yaml::YamlValidator::InputType::FROM_STRING,
        DDSROUTER_CONFIG_SCHEMA);
    if (!validator.validate_YAML(yml))
    {
        throw eprosima::utils::ConfigurationException(
                  utils::Formatter() << "Error, the provided yaml file is not a valid ddsrouter configuration.");
    }

    try
    {
        ddspipe::yaml::YamlReaderVersion version;
        // Get version if present
        if (ddspipe::yaml::YamlReader::is_tag_present(yml, ddspipe::yaml::VERSION_TAG))
        {
            version = ddspipe::yaml::YamlReader::get<ddspipe::yaml::YamlReaderVersion>(yml, ddspipe::yaml::VERSION_TAG,
                            ddspipe::yaml::YamlReaderVersion::LATEST);

            switch (version)
            {
                case ddspipe::yaml::YamlReaderVersion::V_5_0:
                case ddspipe::yaml::YamlReaderVersion::LATEST:
                    break;

                case ddspipe::yaml::YamlReaderVersion::V_1_0:
                case ddspipe::yaml::YamlReaderVersion::V_2_0:
                case ddspipe::yaml::YamlReaderVersion::V_3_0:
                case ddspipe::yaml::YamlReaderVersion::V_3_1:
                    throw eprosima::utils::ConfigurationException(
                              utils::Formatter()
                                  << "The yaml configuration version " << version
                                  << " is no longer supported. Please update to "
                                  << ddspipe::yaml::YamlReaderVersion::LATEST << ".");
                    break;

                case ddspipe::yaml::YamlReaderVersion::V_4_0:
                    EPROSIMA_LOG_WARNING(DDSROUTER_YAML,
                            "The yaml configuration version "
                            << version
                            << " is deprecated and will be removed in a future release. "
                            << "Please update to " << ddspipe::yaml::YamlReaderVersion::LATEST << ".");
                    break;

                default:
                    throw eprosima::utils::ConfigurationException(
                              utils::Formatter()
                                  << "The yaml configuration version " << version
                                  << " is unknown and not supported. Please update to "
                                  << ddspipe::yaml::YamlReaderVersion::LATEST << ".");
                    break;
            }
        }
        else
        {
            // Get default version
            version = default_yaml_version();
            EPROSIMA_LOG_WARNING(DDSROUTER_YAML,
                    "No version of yaml configuration given. Using version "
                    << version << " by default. "
                    << "Add " << ddspipe::yaml::VERSION_TAG
                    << " tag to your configuration in order to not break compatibility "
                    << "in future releases.");
        }

        EPROSIMA_LOG_INFO(DDSROUTER_YAML, "Loading DDSRouter configuration with version: " << version << ".");

        // Load DDS Router Configuration
        core::DdsRouterConfiguration router_configuration =
                ddspipe::yaml::YamlReader::get<core::DdsRouterConfiguration>(yml, version);


        if (args != nullptr)
        {
            router_configuration.ddspipe_configuration.log_configuration.set(args->log_verbosity);
            router_configuration.ddspipe_configuration.log_configuration.set(args->log_filter);
        }

        return router_configuration;
    }
    catch (const std::exception& e)
    {
        throw eprosima::utils::ConfigurationException(
                  utils::Formatter() << "Error loading DDS Router configuration from yaml:\n " << e.what());
    }
}

core::DdsRouterConfiguration
YamlReaderConfiguration::load_ddsrouter_configuration_from_file(
        const std::string& file_path,
        const CommandlineArgsRouter* args /*= nullptr*/)
{
    Yaml yml;

    // Load file
    try
    {
        yml = ddspipe::yaml::YamlManager::load_file(file_path);
    }
    catch (const std::exception& e)
    {
        throw eprosima::utils::ConfigurationException(
                  utils::Formatter() << "Error loading DDSRouter configuration from file: <" << file_path
                                     << "> :\n " << e.what());
    }

    if (yml.IsNull())
    {
        throw eprosima::utils::ConfigurationException(
                  utils::Formatter() << "Error loading DDSRouter configuration from file: <" << file_path
                                     << "> :\n " << "yaml node is null.");
    }

    return YamlReaderConfiguration::load_ddsrouter_configuration(yml, args);
}

ddspipe::yaml::YamlReaderVersion YamlReaderConfiguration::default_yaml_version()
{
    return ddspipe::yaml::V_5_0;
}

} // namespace yaml
} // namespace ddsrouter
} // namespace eprosima