537 lines
16 KiB
C++
537 lines
16 KiB
C++
/**
|
|
* @file tests/test_cases.cc
|
|
*
|
|
* Copyright (c) 2021-2024 Bartek Kryza <bkryza@gmail.com>
|
|
*
|
|
* 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 "test_cases.h"
|
|
|
|
#include "cli/cli_handler.h"
|
|
#include "common/compilation_database.h"
|
|
#include "common/generators/generators.h"
|
|
#include "util/util.h"
|
|
|
|
#include <spdlog/spdlog.h>
|
|
|
|
#include <vector>
|
|
|
|
void inject_diagram_options(std::shared_ptr<clanguml::config::diagram> diagram)
|
|
{
|
|
// Inject links config to all test cases
|
|
clanguml::config::generate_links_config links_config{
|
|
R"(https://github.com/bkryza/clang-uml/blob/{{ git.commit }}/{{ element.source.path }}#L{{ element.source.line }})",
|
|
R"({% if existsIn(element, "comment") and existsIn(element.comment, "brief") %}{{ abbrv(trim(replace(element.comment.brief.0, "\n+", " ")), 256) }}{% else %}{{ element.name }}{% endif %})"};
|
|
|
|
diagram->generate_links.set(links_config);
|
|
}
|
|
|
|
std::pair<clanguml::config::config, clanguml::common::compilation_database_ptr>
|
|
load_config(const std::string &test_name)
|
|
{
|
|
std::pair<clanguml::config::config,
|
|
clanguml::common::compilation_database_ptr>
|
|
res;
|
|
|
|
// Load configuration file from the project source tree instead of
|
|
// the test build directory
|
|
const auto test_config_path =
|
|
fmt::format("../../tests/{}/.clang-uml", test_name);
|
|
|
|
const auto compilation_database_dir = canonical(
|
|
std::filesystem::current_path() / std::filesystem::path{".."});
|
|
const auto output_directory = weakly_canonical(
|
|
std::filesystem::current_path() / std::filesystem::path{"diagrams"});
|
|
|
|
res.first = clanguml::config::load(test_config_path, true, false, true);
|
|
|
|
res.first.compilation_database_dir.set(compilation_database_dir.string());
|
|
res.first.output_directory.set(output_directory.string());
|
|
|
|
LOG_DBG("Loading compilation database from {}",
|
|
res.first.compilation_database_dir());
|
|
|
|
std::vector<std::string> remove_compile_flags{
|
|
std::string{"-Wno-class-memaccess"}};
|
|
|
|
res.first.remove_compile_flags.set(remove_compile_flags);
|
|
|
|
res.second =
|
|
clanguml::common::compilation_database::auto_detect_from_directory(
|
|
res.first);
|
|
|
|
return res;
|
|
}
|
|
|
|
namespace detail {
|
|
template <typename DiagramConfig>
|
|
auto generate_diagram_impl(clanguml::common::compilation_database &db,
|
|
std::shared_ptr<clanguml::config::diagram> diagram)
|
|
{
|
|
LOG_INFO("All paths will be evaluated relative to {}",
|
|
diagram->root_directory().string());
|
|
|
|
using diagram_config = DiagramConfig;
|
|
using diagram_model =
|
|
typename clanguml::common::generators::diagram_model_t<
|
|
diagram_config>::type;
|
|
using diagram_visitor =
|
|
typename clanguml::common::generators::diagram_visitor_t<
|
|
diagram_config>::type;
|
|
|
|
inject_diagram_options(diagram);
|
|
|
|
auto model = clanguml::common::generators::generate<diagram_model,
|
|
diagram_config, diagram_visitor>(db, diagram->name,
|
|
dynamic_cast<diagram_config &>(*diagram),
|
|
diagram->get_translation_units());
|
|
|
|
return model;
|
|
}
|
|
|
|
template <typename DiagramConfig, typename DiagramModel>
|
|
auto generate_diagram_puml(
|
|
std::shared_ptr<clanguml::config::diagram> config, DiagramModel &model)
|
|
{
|
|
using diagram_config = DiagramConfig;
|
|
using diagram_model = DiagramModel;
|
|
using diagram_generator =
|
|
typename clanguml::common::generators::diagram_generator_t<
|
|
DiagramConfig,
|
|
clanguml::common::generators::plantuml_generator_tag>::type;
|
|
|
|
std::stringstream ss;
|
|
|
|
ss << diagram_generator(dynamic_cast<diagram_config &>(*config), model);
|
|
|
|
return ss.str();
|
|
}
|
|
|
|
template <typename DiagramConfig, typename DiagramModel>
|
|
auto generate_diagram_json(
|
|
std::shared_ptr<clanguml::config::diagram> config, DiagramModel &model)
|
|
{
|
|
using diagram_config = DiagramConfig;
|
|
using diagram_model = DiagramModel;
|
|
using diagram_generator =
|
|
typename clanguml::common::generators::diagram_generator_t<
|
|
DiagramConfig,
|
|
clanguml::common::generators::json_generator_tag>::type;
|
|
|
|
std::stringstream ss;
|
|
|
|
ss << diagram_generator(dynamic_cast<diagram_config &>(*config), model);
|
|
|
|
return nlohmann::json::parse(ss.str());
|
|
}
|
|
|
|
template <typename DiagramConfig, typename DiagramModel>
|
|
auto generate_diagram_mermaid(
|
|
std::shared_ptr<clanguml::config::diagram> config, DiagramModel &model)
|
|
{
|
|
using diagram_config = DiagramConfig;
|
|
using diagram_model = DiagramModel;
|
|
using diagram_generator =
|
|
typename clanguml::common::generators::diagram_generator_t<
|
|
DiagramConfig,
|
|
clanguml::common::generators::mermaid_generator_tag>::type;
|
|
|
|
std::stringstream ss;
|
|
|
|
ss << diagram_generator(dynamic_cast<diagram_config &>(*config), model);
|
|
|
|
return ss.str();
|
|
}
|
|
}
|
|
|
|
std::unique_ptr<clanguml::class_diagram::model::diagram> generate_class_diagram(
|
|
clanguml::common::compilation_database &db,
|
|
std::shared_ptr<clanguml::config::diagram> diagram)
|
|
{
|
|
return detail::generate_diagram_impl<clanguml::config::class_diagram>(
|
|
db, diagram);
|
|
}
|
|
|
|
std::unique_ptr<clanguml::sequence_diagram::model::diagram>
|
|
generate_sequence_diagram(clanguml::common::compilation_database &db,
|
|
std::shared_ptr<clanguml::config::diagram> diagram)
|
|
{
|
|
return detail::generate_diagram_impl<clanguml::config::sequence_diagram>(
|
|
db, diagram);
|
|
}
|
|
|
|
std::unique_ptr<clanguml::package_diagram::model::diagram>
|
|
generate_package_diagram(clanguml::common::compilation_database &db,
|
|
std::shared_ptr<clanguml::config::diagram> diagram)
|
|
{
|
|
return detail::generate_diagram_impl<clanguml::config::package_diagram>(
|
|
db, diagram);
|
|
}
|
|
|
|
std::unique_ptr<clanguml::include_diagram::model::diagram>
|
|
generate_include_diagram(clanguml::common::compilation_database &db,
|
|
std::shared_ptr<clanguml::config::diagram> diagram)
|
|
{
|
|
return detail::generate_diagram_impl<clanguml::config::include_diagram>(
|
|
db, diagram);
|
|
}
|
|
|
|
std::string generate_class_puml(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::class_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_puml<clanguml::config::class_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
std::string generate_sequence_puml(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::sequence_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_puml<clanguml::config::sequence_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
std::string generate_package_puml(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::package_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_puml<clanguml::config::package_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
std::string generate_include_puml(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::include_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_puml<clanguml::config::include_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
nlohmann::json generate_class_json(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::class_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_json<clanguml::config::class_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
nlohmann::json generate_sequence_json(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::sequence_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_json<clanguml::config::sequence_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
nlohmann::json generate_package_json(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::package_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_json<clanguml::config::package_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
nlohmann::json generate_include_json(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::include_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_json<clanguml::config::include_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
std::string generate_class_mermaid(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::class_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_mermaid<clanguml::config::class_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
std::string generate_sequence_mermaid(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::sequence_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_mermaid<clanguml::config::sequence_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
std::string generate_package_mermaid(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::package_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_mermaid<clanguml::config::package_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
std::string generate_include_mermaid(
|
|
std::shared_ptr<clanguml::config::diagram> config,
|
|
clanguml::include_diagram::model::diagram &model)
|
|
{
|
|
return detail::generate_diagram_mermaid<clanguml::config::include_diagram>(
|
|
config, model);
|
|
}
|
|
|
|
template <typename T>
|
|
void save_diagram(const std::filesystem::path &path, const T &diagram)
|
|
{
|
|
static_assert(
|
|
std::is_same_v<T, std::string> || std::is_same_v<T, nlohmann::json>);
|
|
|
|
std::filesystem::create_directories(path.parent_path());
|
|
std::ofstream ofs;
|
|
ofs.open(path, std::ofstream::out | std::ofstream::trunc);
|
|
if constexpr (std::is_same_v<T, nlohmann::json>) {
|
|
ofs << std::setw(2) << diagram;
|
|
}
|
|
else {
|
|
ofs << diagram;
|
|
}
|
|
|
|
ofs.close();
|
|
}
|
|
|
|
void save_puml(const std::string &path, const std::string &filename,
|
|
const std::string &puml)
|
|
{
|
|
std::filesystem::path p{path};
|
|
p /= filename;
|
|
save_diagram(p, puml);
|
|
}
|
|
|
|
void save_json(const std::string &path, const std::string &filename,
|
|
const nlohmann::json &j)
|
|
{
|
|
std::filesystem::path p{path};
|
|
p /= filename;
|
|
save_diagram(p, j);
|
|
}
|
|
|
|
void save_mermaid(const std::string &path, const std::string &filename,
|
|
const std::string &mmd)
|
|
{
|
|
std::filesystem::path p{path};
|
|
p /= filename;
|
|
save_diagram(p, mmd);
|
|
}
|
|
|
|
using namespace clanguml::test::matchers;
|
|
|
|
///
|
|
/// Class diagram tests
|
|
///
|
|
#include "t00002/test_case.h"
|
|
#include "t00003/test_case.h"
|
|
#include "t00004/test_case.h"
|
|
#include "t00005/test_case.h"
|
|
#include "t00006/test_case.h"
|
|
#include "t00007/test_case.h"
|
|
#include "t00008/test_case.h"
|
|
#include "t00009/test_case.h"
|
|
#include "t00010/test_case.h"
|
|
#include "t00011/test_case.h"
|
|
#include "t00012/test_case.h"
|
|
#include "t00013/test_case.h"
|
|
#include "t00014/test_case.h"
|
|
#include "t00015/test_case.h"
|
|
#include "t00016/test_case.h"
|
|
#include "t00017/test_case.h"
|
|
#include "t00018/test_case.h"
|
|
#include "t00019/test_case.h"
|
|
#include "t00020/test_case.h"
|
|
#include "t00021/test_case.h"
|
|
#include "t00022/test_case.h"
|
|
#include "t00023/test_case.h"
|
|
#include "t00024/test_case.h"
|
|
#include "t00025/test_case.h"
|
|
#include "t00026/test_case.h"
|
|
#include "t00027/test_case.h"
|
|
#include "t00028/test_case.h"
|
|
#include "t00029/test_case.h"
|
|
#include "t00030/test_case.h"
|
|
#include "t00031/test_case.h"
|
|
#include "t00032/test_case.h"
|
|
#include "t00033/test_case.h"
|
|
#include "t00034/test_case.h"
|
|
#include "t00035/test_case.h"
|
|
#include "t00036/test_case.h"
|
|
#include "t00037/test_case.h"
|
|
#include "t00038/test_case.h"
|
|
#include "t00039/test_case.h"
|
|
#include "t00040/test_case.h"
|
|
#include "t00041/test_case.h"
|
|
#include "t00042/test_case.h"
|
|
#include "t00043/test_case.h"
|
|
#include "t00044/test_case.h"
|
|
#include "t00045/test_case.h"
|
|
#include "t00046/test_case.h"
|
|
#include "t00047/test_case.h"
|
|
#include "t00048/test_case.h"
|
|
#include "t00049/test_case.h"
|
|
#include "t00050/test_case.h"
|
|
#include "t00051/test_case.h"
|
|
#include "t00052/test_case.h"
|
|
#include "t00053/test_case.h"
|
|
#include "t00054/test_case.h"
|
|
#include "t00055/test_case.h"
|
|
#if defined(ENABLE_CXX_STD_20_TEST_CASES)
|
|
#include "t00056/test_case.h"
|
|
#endif
|
|
#include "t00057/test_case.h"
|
|
#if defined(ENABLE_CXX_STD_20_TEST_CASES)
|
|
#include "t00058/test_case.h"
|
|
#include "t00059/test_case.h"
|
|
#endif
|
|
#include "t00060/test_case.h"
|
|
#include "t00061/test_case.h"
|
|
#include "t00062/test_case.h"
|
|
#include "t00063/test_case.h"
|
|
#include "t00064/test_case.h"
|
|
#if defined(ENABLE_CXX_STD_20_TEST_CASES)
|
|
#include "t00065/test_case.h"
|
|
#endif
|
|
#include "t00066/test_case.h"
|
|
#include "t00067/test_case.h"
|
|
#include "t00068/test_case.h"
|
|
#if defined(ENABLE_CXX_STD_20_TEST_CASES)
|
|
#if __has_include(<coroutine>)
|
|
#include "t00069/test_case.h"
|
|
#endif
|
|
#endif
|
|
#if defined(ENABLE_CXX_MODULES_TEST_CASES)
|
|
#include "t00070/test_case.h"
|
|
#include "t00071/test_case.h"
|
|
#include "t00072/test_case.h"
|
|
#endif
|
|
#include "t00073/test_case.h"
|
|
#if defined(ENABLE_CXX_STD_20_TEST_CASES)
|
|
#include "t00074/test_case.h"
|
|
#include "t00075/test_case.h"
|
|
#endif
|
|
|
|
///
|
|
/// Sequence diagram tests
|
|
///
|
|
#include "t20001/test_case.h"
|
|
#include "t20002/test_case.h"
|
|
#ifndef _MSC_VER
|
|
#include "t20003/test_case.h"
|
|
#endif
|
|
#include "t20004/test_case.h"
|
|
#ifndef _MSC_VER
|
|
#include "t20005/test_case.h"
|
|
#endif
|
|
#include "t20006/test_case.h"
|
|
#include "t20007/test_case.h"
|
|
#include "t20008/test_case.h"
|
|
#include "t20009/test_case.h"
|
|
#include "t20010/test_case.h"
|
|
#include "t20011/test_case.h"
|
|
#include "t20012/test_case.h"
|
|
#include "t20013/test_case.h"
|
|
#include "t20014/test_case.h"
|
|
#include "t20015/test_case.h"
|
|
#include "t20016/test_case.h"
|
|
#include "t20017/test_case.h"
|
|
#include "t20018/test_case.h"
|
|
#include "t20019/test_case.h"
|
|
#include "t20020/test_case.h"
|
|
#include "t20021/test_case.h"
|
|
#include "t20022/test_case.h"
|
|
#include "t20023/test_case.h"
|
|
#include "t20024/test_case.h"
|
|
#include "t20025/test_case.h"
|
|
#include "t20026/test_case.h"
|
|
#include "t20027/test_case.h"
|
|
#include "t20028/test_case.h"
|
|
#include "t20029/test_case.h"
|
|
#include "t20030/test_case.h"
|
|
#include "t20031/test_case.h"
|
|
#include "t20032/test_case.h"
|
|
#include "t20033/test_case.h"
|
|
#include "t20034/test_case.h"
|
|
#include "t20035/test_case.h"
|
|
#include "t20036/test_case.h"
|
|
#include "t20037/test_case.h"
|
|
#include "t20038/test_case.h"
|
|
#include "t20039/test_case.h"
|
|
#include "t20040/test_case.h"
|
|
#include "t20041/test_case.h"
|
|
#include "t20042/test_case.h"
|
|
|
|
///
|
|
/// Package diagram tests
|
|
///
|
|
#include "t30001/test_case.h"
|
|
#include "t30002/test_case.h"
|
|
#include "t30003/test_case.h"
|
|
#include "t30004/test_case.h"
|
|
#include "t30005/test_case.h"
|
|
#include "t30006/test_case.h"
|
|
#include "t30007/test_case.h"
|
|
#include "t30008/test_case.h"
|
|
#include "t30009/test_case.h"
|
|
#include "t30010/test_case.h"
|
|
#include "t30011/test_case.h"
|
|
#if defined(ENABLE_CXX_MODULES_TEST_CASES)
|
|
#include "t30012/test_case.h"
|
|
#include "t30013/test_case.h"
|
|
#include "t30014/test_case.h"
|
|
#include "t30015/test_case.h"
|
|
#endif
|
|
///
|
|
/// Include diagram tests
|
|
///
|
|
#include "t40001/test_case.h"
|
|
#include "t40002/test_case.h"
|
|
#include "t40003/test_case.h"
|
|
|
|
///
|
|
/// Other tests (e.g. configuration file)
|
|
///
|
|
#include "t90000/test_case.h"
|
|
|
|
///
|
|
/// Main test function
|
|
///
|
|
int main(int argc, char *argv[])
|
|
{
|
|
Catch::Session session;
|
|
using namespace Catch::clara;
|
|
|
|
bool debug_log{false};
|
|
auto cli = session.cli() |
|
|
Opt(debug_log, "debug_log")["-u"]["--debug-log"]("Enable debug logs");
|
|
|
|
session.cli(cli);
|
|
|
|
int returnCode = session.applyCommandLine(argc, argv);
|
|
if (returnCode != 0)
|
|
return returnCode;
|
|
|
|
clanguml::cli::cli_handler clih;
|
|
|
|
std::vector<const char *> argvv = {
|
|
"clang-uml", "--config", "./test_config_data/simple.yml"};
|
|
|
|
if (debug_log)
|
|
argvv.push_back("-vvv");
|
|
else
|
|
argvv.push_back("-q");
|
|
|
|
clih.handle_options(argvv.size(), argvv.data());
|
|
|
|
return session.run();
|
|
}
|