445 lines
16 KiB
C++
445 lines
16 KiB
C++
/**
|
|
* @file tests/test_config.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.
|
|
*/
|
|
#define CATCH_CONFIG_RUNNER
|
|
#define CATCH_CONFIG_CONSOLE_WIDTH 512
|
|
#include "catch.h"
|
|
|
|
#include "cli/cli_handler.h"
|
|
#include "config/config.h"
|
|
#include "util/util.h"
|
|
|
|
TEST_CASE("Test config simple", "[unit-test]")
|
|
{
|
|
using clanguml::common::model::access_t;
|
|
using clanguml::common::model::relationship_t;
|
|
using clanguml::config::method_type;
|
|
using clanguml::util::contains;
|
|
|
|
auto cfg = clanguml::config::load("./test_config_data/simple.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 1);
|
|
auto &diagram = *cfg.diagrams["class_main"];
|
|
CHECK(diagram.type() == clanguml::common::model::diagram_t::kClass);
|
|
CHECK(diagram.glob().size() == 2);
|
|
CHECK(clanguml::util::contains(diagram.using_namespace(), "clanguml"));
|
|
CHECK(diagram.generate_method_arguments() ==
|
|
clanguml::config::method_arguments::full);
|
|
CHECK(diagram.generate_packages() == true);
|
|
CHECK(diagram.generate_template_argument_dependencies() == false);
|
|
CHECK(diagram.generate_links == true);
|
|
CHECK(diagram.generate_links().link ==
|
|
"https://github.com/bkryza/clang-uml/blob/{{ git.branch }}/{{ "
|
|
"element.source.file }}#L{{ element.source.line }}");
|
|
CHECK(diagram.generate_links().tooltip == "{{ element.comment }}");
|
|
|
|
CHECK(
|
|
diagram.comment_parser() == clanguml::config::comment_parser_t::clang);
|
|
|
|
CHECK(contains(diagram.include().access, access_t::kPublic));
|
|
CHECK(contains(diagram.include().access, access_t::kProtected));
|
|
CHECK(contains(diagram.include().access, access_t::kPrivate));
|
|
|
|
CHECK(
|
|
contains(diagram.include().relationships, relationship_t::kExtension));
|
|
CHECK(contains(
|
|
diagram.include().relationships, relationship_t::kAggregation));
|
|
CHECK(contains(
|
|
diagram.include().relationships, relationship_t::kAssociation));
|
|
CHECK(contains(
|
|
diagram.include().relationships, relationship_t::kComposition));
|
|
CHECK(contains(
|
|
diagram.include().relationships, relationship_t::kContainment));
|
|
CHECK(
|
|
contains(diagram.include().relationships, relationship_t::kDependency));
|
|
CHECK(
|
|
contains(diagram.include().relationships, relationship_t::kFriendship));
|
|
CHECK(contains(
|
|
diagram.include().relationships, relationship_t::kInstantiation));
|
|
CHECK(
|
|
contains(diagram.include().relationships, relationship_t::kOwnership));
|
|
|
|
CHECK(contains(diagram.exclude().relationships, relationship_t::kNone));
|
|
|
|
CHECK(contains(diagram.exclude().method_types, method_type::operator_));
|
|
CHECK(contains(diagram.exclude().method_types, method_type::constructor));
|
|
CHECK(contains(diagram.exclude().method_types, method_type::deleted));
|
|
|
|
CHECK(diagram.relationship_hints().at("std::vector").get(0) ==
|
|
relationship_t::kComposition);
|
|
CHECK(diagram.relationship_hints().at("std::tuple").get(10) ==
|
|
relationship_t::kAggregation);
|
|
CHECK(diagram.relationship_hints().at("std::map").get(0) ==
|
|
relationship_t::kNone);
|
|
CHECK(diagram.relationship_hints().at("std::map").get(1) ==
|
|
relationship_t::kComposition);
|
|
CHECK(diagram.relationship_hints().at("std::shared_ptr").get(0) ==
|
|
relationship_t::kAssociation);
|
|
CHECK(diagram.relationship_hints().at("std::weak_ptr").get(0) ==
|
|
relationship_t::kAssociation);
|
|
CHECK(diagram.relationship_hints().at("std::unique_ptr").get(0) ==
|
|
relationship_t::kAggregation);
|
|
CHECK(diagram.relationship_hints().at("ns1::n2::some_template").get(0) ==
|
|
relationship_t::kAssociation);
|
|
CHECK(diagram.relationship_hints().at("ns1::n2::some_template").get(2) ==
|
|
relationship_t::kComposition);
|
|
CHECK(diagram.relationship_hints().at("ns1::n2::some_template").get(10) ==
|
|
relationship_t::kAggregation);
|
|
}
|
|
|
|
TEST_CASE("Test config inherited", "[unit-test]")
|
|
{
|
|
auto cfg = clanguml::config::load("./test_config_data/inherited.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 2);
|
|
auto &def = *cfg.diagrams["class_default"];
|
|
CHECK(def.type() == clanguml::common::model::diagram_t::kClass);
|
|
CHECK(def.glob().size() == 2);
|
|
CHECK(def.glob()[0] == "src/**/*.cc");
|
|
CHECK(def.glob()[1] == "src/**/*.h");
|
|
CHECK(clanguml::util::contains(def.using_namespace(), "clanguml"));
|
|
CHECK(def.generate_packages() == false);
|
|
CHECK(def.generate_links == false);
|
|
|
|
auto &cus = *cfg.diagrams["class_custom"];
|
|
CHECK(cus.type() == clanguml::common::model::diagram_t::kClass);
|
|
CHECK(cus.glob().size() == 1);
|
|
CHECK(cus.glob()[0] == "src/main.cc");
|
|
CHECK(cus.using_namespace().starts_with({"clanguml::ns1"}));
|
|
CHECK(cus.include_relations_also_as_members());
|
|
CHECK(cus.generate_packages() == false);
|
|
CHECK(cus.generate_links == false);
|
|
CHECK(cus.puml().before.size() == 2);
|
|
CHECK(cus.puml().before.at(0) == "title This is diagram A");
|
|
CHECK(cus.puml().before.at(1) == "This is a common header");
|
|
CHECK(cus.puml().after.size() == 2);
|
|
CHECK(cus.puml().after.at(0) == "note left of A: This is a note");
|
|
CHECK(cus.puml().after.at(1) == "This is a common footnote");
|
|
}
|
|
|
|
TEST_CASE("Test config includes", "[unit-test]")
|
|
{
|
|
auto cfg = clanguml::config::load("./test_config_data/includes.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 2);
|
|
auto &def = *cfg.diagrams["class_1"];
|
|
CHECK(def.type() == clanguml::common::model::diagram_t::kClass);
|
|
CHECK(def.glob().size() == 2);
|
|
CHECK(def.glob()[0] == "src/**/*.cc");
|
|
CHECK(def.glob()[1] == "src/**/*.h");
|
|
CHECK(clanguml::util::contains(def.using_namespace(), "clanguml"));
|
|
CHECK(def.generate_method_arguments() ==
|
|
clanguml::config::method_arguments::none);
|
|
|
|
auto &cus = *cfg.diagrams["class_2"];
|
|
CHECK(cus.type() == clanguml::common::model::diagram_t::kClass);
|
|
CHECK(cus.glob().size() == 1);
|
|
CHECK(cus.glob()[0] == "src/main.cc");
|
|
CHECK(cus.using_namespace().starts_with({"clanguml::ns1"}));
|
|
CHECK(cus.include_relations_also_as_members());
|
|
CHECK(cus.generate_method_arguments() ==
|
|
clanguml::config::method_arguments::none);
|
|
}
|
|
|
|
TEST_CASE("Test config layout", "[unit-test]")
|
|
{
|
|
using namespace std::string_literals;
|
|
|
|
auto cfg = clanguml::config::load("./test_config_data/layout.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 2);
|
|
|
|
[[maybe_unused]] auto &def = static_cast<clanguml::config::class_diagram &>(
|
|
*cfg.diagrams["class_main"]);
|
|
|
|
auto check_class_layout =
|
|
[](const clanguml::config::class_diagram &diagram,
|
|
const clanguml::common::model::diagram_t type) {
|
|
CHECK(diagram.type() == type);
|
|
|
|
const auto &ABCD = diagram.layout().at("ABCD");
|
|
|
|
CHECK(ABCD.size() == 3);
|
|
|
|
CHECK(ABCD[0].hint == clanguml::config::hint_t::up);
|
|
CHECK(std::get<std::string>(ABCD[0].entity) == "ABCD_SUBCLASS");
|
|
|
|
CHECK(ABCD[1].hint == clanguml::config::hint_t::left);
|
|
CHECK(std::get<std::string>(ABCD[1].entity) == "ABCD_SIBLING");
|
|
|
|
CHECK(ABCD[2].hint == clanguml::config::hint_t::together);
|
|
CHECK(std::get<std::vector<std::string>>(ABCD[2].entity) ==
|
|
std::vector{"A"s, "B"s, "C"s, "D"s});
|
|
|
|
CHECK(diagram.get_together_group("ABCD").value() == "ABCD");
|
|
CHECK(
|
|
diagram.get_together_group("clanguml::ABCD").value() == "ABCD");
|
|
CHECK(diagram.get_together_group("B").value() == "ABCD");
|
|
CHECK(diagram.get_together_group("clanguml::B").value() == "ABCD");
|
|
CHECK(!diagram.get_together_group("clanguml::E"));
|
|
CHECK(!diagram.get_together_group("E"));
|
|
|
|
const auto &ABCD_SIBLING = diagram.layout().at("ABCD_SIBLING");
|
|
CHECK(ABCD_SIBLING.size() == 2);
|
|
|
|
CHECK(ABCD_SIBLING[0].hint == clanguml::config::hint_t::right);
|
|
CHECK(std::get<std::string>(ABCD_SIBLING[0].entity) ==
|
|
"ABCD_OTHER_SIBLING");
|
|
|
|
CHECK(ABCD_SIBLING[1].hint == clanguml::config::hint_t::down);
|
|
CHECK(std::get<std::string>(ABCD_SIBLING[1].entity) ==
|
|
"ABCD_SIBLING_SIBLING");
|
|
};
|
|
|
|
auto check_package_layout =
|
|
[](const clanguml::config::package_diagram &diagram,
|
|
const clanguml::common::model::diagram_t type) {
|
|
CHECK(diagram.type() == type);
|
|
|
|
const auto &ABCD = diagram.layout().at("ABCD");
|
|
|
|
CHECK(ABCD.size() == 2);
|
|
|
|
CHECK(ABCD[0].hint == clanguml::config::hint_t::up);
|
|
CHECK(std::get<std::string>(ABCD[0].entity) == "ABCD_SUBCLASS");
|
|
|
|
CHECK(ABCD[1].hint == clanguml::config::hint_t::left);
|
|
CHECK(std::get<std::string>(ABCD[1].entity) == "ABCD_SIBLING");
|
|
|
|
const auto &ABCD_SIBLING = diagram.layout().at("ABCD_SIBLING");
|
|
CHECK(ABCD_SIBLING.size() == 2);
|
|
|
|
CHECK(ABCD_SIBLING[0].hint == clanguml::config::hint_t::right);
|
|
CHECK(std::get<std::string>(ABCD_SIBLING[0].entity) ==
|
|
"ABCD_OTHER_SIBLING");
|
|
|
|
CHECK(ABCD_SIBLING[1].hint == clanguml::config::hint_t::down);
|
|
CHECK(std::get<std::string>(ABCD_SIBLING[1].entity) ==
|
|
"ABCD_SIBLING_SIBLING");
|
|
};
|
|
|
|
check_class_layout(static_cast<clanguml::config::class_diagram &>(
|
|
*cfg.diagrams["class_main"]),
|
|
clanguml::common::model::diagram_t::kClass);
|
|
|
|
check_package_layout(static_cast<clanguml::config::package_diagram &>(
|
|
*cfg.diagrams["package_main"]),
|
|
clanguml::common::model::diagram_t::kPackage);
|
|
}
|
|
|
|
TEST_CASE("Test config emitters", "[unit-test]")
|
|
{
|
|
auto cfg = clanguml::config::load("./test_config_data/complete.yml");
|
|
|
|
YAML::Emitter out;
|
|
out.SetIndent(2);
|
|
|
|
out << cfg;
|
|
out << YAML::Newline;
|
|
|
|
// Write the emitted YAML to a temp file
|
|
auto tmp_file = std::filesystem::temp_directory_path() /
|
|
fmt::format("clang-uml-{:016}", rand());
|
|
|
|
{
|
|
std::ofstream stream(tmp_file.string().c_str(), std::ios::binary);
|
|
stream << out.c_str();
|
|
}
|
|
|
|
auto cfg_emitted = clanguml::config::load(tmp_file.string());
|
|
|
|
REQUIRE(cfg.diagrams.size() == cfg_emitted.diagrams.size());
|
|
|
|
std::filesystem::remove(tmp_file);
|
|
}
|
|
|
|
TEST_CASE("Test config diagram_templates", "[unit-test]")
|
|
{
|
|
auto cfg =
|
|
clanguml::config::load("./test_config_data/diagram_templates.yml");
|
|
|
|
REQUIRE(cfg.diagram_templates().size() == 4);
|
|
|
|
REQUIRE(cfg.diagram_templates()["parents_hierarchy_tmpl"].type ==
|
|
clanguml::common::model::diagram_t::kClass);
|
|
REQUIRE(cfg.diagram_templates()["parents_hierarchy_tmpl"].jinja_template ==
|
|
"{{ diagram_name }}:"
|
|
R"(
|
|
type: class
|
|
{% if exists("glob") %}
|
|
glob: [{{ glob }}]
|
|
{% endif %}
|
|
{% if exists("using_namespace") %}
|
|
using_namespace: {{ using_namespace }}
|
|
{% endif %}
|
|
include:
|
|
parents: [{{ class_name }}]
|
|
namespaces: [{{ namespace_name }}]
|
|
relationships:
|
|
- inheritance
|
|
exclude:
|
|
access: [public, protected, private]
|
|
plantuml:
|
|
before:
|
|
- left to right direction
|
|
)");
|
|
|
|
REQUIRE(cfg.diagram_templates()["children_hierarchy_tmpl"].type ==
|
|
clanguml::common::model::diagram_t::kClass);
|
|
REQUIRE(cfg.diagram_templates()["subclass_hierarchy_tmpl"].jinja_template ==
|
|
"{{ diagram_name }}:"
|
|
R"(
|
|
type: class
|
|
{% if exists("glob") %}
|
|
glob: [{{ glob }}]
|
|
{% endif %}
|
|
{% if exists("using_namespace") %}
|
|
using_namespace: {{ using_namespace }}
|
|
{% endif %}
|
|
include:
|
|
parents: [{{ class_name }}]
|
|
namespaces: [{{ namespace_name }}]
|
|
relationships:
|
|
- inheritance
|
|
exclude:
|
|
access: [public, protected, private]
|
|
plantuml:
|
|
before:
|
|
- left to right direction
|
|
)");
|
|
|
|
REQUIRE(cfg.diagram_templates()["main_sequence_tmpl"].type ==
|
|
clanguml::common::model::diagram_t::kSequence);
|
|
}
|
|
|
|
TEST_CASE("Test config sequence inherited", "[unit-test]")
|
|
{
|
|
auto cfg = clanguml::config::load(
|
|
"./test_config_data/sequence_inheritable_options.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 2);
|
|
auto &def = *cfg.diagrams["sequence_default"];
|
|
CHECK(def.type() == clanguml::common::model::diagram_t::kSequence);
|
|
CHECK(def.combine_free_functions_into_file_participants() == true);
|
|
CHECK(def.generate_return_types() == true);
|
|
|
|
def = *cfg.diagrams["sequence_default2"];
|
|
CHECK(def.type() == clanguml::common::model::diagram_t::kSequence);
|
|
CHECK(def.combine_free_functions_into_file_participants() == false);
|
|
CHECK(def.generate_return_types() == false);
|
|
}
|
|
|
|
TEST_CASE("Test config relative paths handling", "[unit-test]")
|
|
{
|
|
auto cfg = clanguml::config::load("./test_config_data/relative_to.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 2);
|
|
auto &def = *cfg.diagrams["class1"];
|
|
CHECK(def.get_relative_to()() == "/tmp");
|
|
#ifdef _MSC_VER
|
|
CHECK(def.root_directory().string() == "C:\\tmp");
|
|
#elif __APPLE__
|
|
CHECK(def.root_directory().string() == "/private/tmp");
|
|
#else
|
|
CHECK(def.root_directory().string() == "/tmp");
|
|
#endif
|
|
|
|
def = *cfg.diagrams["class2"];
|
|
CHECK(def.get_relative_to()() == ".");
|
|
CHECK(def.root_directory() ==
|
|
fmt::format(
|
|
"{}/test_config_data", std::filesystem::current_path().string()));
|
|
|
|
auto cfg2 =
|
|
clanguml::config::load("./test_config_data/relative_to_default.yml");
|
|
|
|
CHECK(cfg2.diagrams.size() == 1);
|
|
def = *cfg2.diagrams["class1"];
|
|
CHECK(def.get_relative_to()() ==
|
|
fmt::format(
|
|
"{}/test_config_data", std::filesystem::current_path().string()));
|
|
CHECK(def.root_directory() ==
|
|
fmt::format(
|
|
"{}/test_config_data", std::filesystem::current_path().string()));
|
|
}
|
|
|
|
TEST_CASE("Test using_module relative to", "[unit-test]")
|
|
{
|
|
auto cfg = clanguml::config::load("./test_config_data/using_module.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 2);
|
|
auto &def = *cfg.diagrams["class1"];
|
|
CHECK(def.make_module_relative(std::make_optional<std::string>(
|
|
"mod1.mod2.mod3")) == std::vector{std::string{"mod3"}});
|
|
CHECK(def.make_module_relative(std::make_optional<std::string>(
|
|
"mod1.mod2")) == std::vector<std::string>{});
|
|
CHECK(def.make_module_relative(
|
|
std::make_optional<std::string>("modA.modB.modC")) ==
|
|
std::vector{
|
|
std::string{"modA"}, std::string{"modB"}, std::string{"modC"}});
|
|
|
|
def = *cfg.diagrams["class2"];
|
|
CHECK(def.make_module_relative(
|
|
std::make_optional<std::string>("mod1.mod2.mod3")) ==
|
|
std::vector{std::string{"mod2"}, std::string{"mod3"}});
|
|
CHECK(def.make_module_relative(
|
|
std::make_optional<std::string>("modA.modB.modC")) ==
|
|
std::vector{
|
|
std::string{"modA"}, std::string{"modB"}, std::string{"modC"}});
|
|
}
|
|
|
|
TEST_CASE("Test config full clang uml dump", "[unit-test]")
|
|
{
|
|
auto cfg =
|
|
clanguml::config::load("./test_config_data/clang_uml_config.yml");
|
|
|
|
CHECK(cfg.diagrams.size() == 32);
|
|
}
|
|
|
|
///
|
|
/// 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();
|
|
}
|