Added package diagram generation from C++20 modules (#101)

This commit is contained in:
Bartek Kryza
2023-12-21 23:39:59 +01:00
parent f09edd8b47
commit a8d646d1bc
18 changed files with 285 additions and 12 deletions

View File

@@ -7,7 +7,7 @@ file(GLOB_RECURSE TEST_CONFIG_YMLS test_config_data/*.yml
test_compilation_database_data/*.json)
set(TEST_CASES_REQUIRING_CXX20 t00056 t00058 t00059 t00065 t00069)
set(TEST_CASES_REQUIRING_CXX20_MODULES t00070 t00071)
set(TEST_CASES_REQUIRING_CXX20_MODULES t00070 t00071 t30012)
if(ENABLE_CXX_MODULES_TEST_CASES)
foreach(CXX20_MOD_TC ${TEST_CASES_REQUIRING_CXX20_MODULES})

10
tests/t30012/.clang-uml Normal file
View File

@@ -0,0 +1,10 @@
diagrams:
t30012_package:
type: package
glob:
- t30012.cc
package_type: module
include:
modules:
- t30012
using_module: t30012

View File

@@ -0,0 +1,13 @@
export module t30012.app.lib1;
export namespace clanguml::t30012 {
class B { };
template <typename T> class BB {
T t;
};
namespace detail {
enum class BBB { bbb1, bbb2 };
} // namespace detail
}

View File

@@ -0,0 +1,5 @@
export module t30012.app.lib1.mod1;
export namespace clanguml::t30012 {
class D { };
}

View File

@@ -0,0 +1,5 @@
export module t30012.app.lib1.mod2;
export namespace clanguml::t30012 {
class E { };
}

View File

@@ -0,0 +1,13 @@
export module t30012.app.lib2;
export namespace clanguml::t30012 {
class C { };
template <typename T> class CC {
T t;
};
namespace detail {
enum class CCC { ccc1, ccc2 };
}
}

View File

@@ -0,0 +1,11 @@
export module t30012.app;
export import t30012.app.lib1;
export import t30012.app.lib2;
export namespace clanguml::t30012 {
class A {
int get() { return a; }
int a;
};
}

15
tests/t30012/t30012.cc Normal file
View File

@@ -0,0 +1,15 @@
import t30012.app;
import t30012.app.lib1;
import t30012.app.lib1.mod1;
import t30012.app.lib1.mod2;
import t30012.app.lib2;
namespace clanguml {
namespace t30012 {
class R {
A *a;
B *b;
C *c;
};
}
}

70
tests/t30012/test_case.h Normal file
View File

@@ -0,0 +1,70 @@
/**
* tests/t30012/test_case.h
*
* Copyright (c) 2021-2023 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.
*/
TEST_CASE("t30012", "[test-case][package]")
{
auto [config, db] = load_config("t30012");
auto diagram = config.diagrams["t30012_package"];
REQUIRE(diagram->name == "t30012_package");
auto model = generate_package_diagram(*db, diagram);
REQUIRE(model->name() == "t30012_package");
{
auto src = generate_package_puml(diagram, *model);
AliasMatcher _A(src);
REQUIRE_THAT(src, StartsWith("@startuml"));
REQUIRE_THAT(src, EndsWith("@enduml\n"));
// Check if all packages exist
REQUIRE_THAT(src, IsPackage("app"));
REQUIRE_THAT(src, IsPackage("lib1"));
REQUIRE_THAT(src, IsPackage("lib2"));
REQUIRE_THAT(src, IsPackage("mod1"));
REQUIRE_THAT(src, IsPackage("mod2"));
save_puml(config.output_directory(), diagram->name + ".puml", src);
}
{
auto j = generate_package_json(diagram, *model);
using namespace json;
save_json(config.output_directory(), diagram->name + ".json", j);
}
{
auto src = generate_package_mermaid(diagram, *model);
mermaid::AliasMatcher _A(src);
using mermaid::IsPackage;
REQUIRE_THAT(src, IsPackage(_A("app")));
REQUIRE_THAT(src, IsPackage(_A("lib1")));
REQUIRE_THAT(src, IsPackage(_A("lib2")));
REQUIRE_THAT(src, IsPackage(_A("mod1")));
REQUIRE_THAT(src, IsPackage(_A("mod2")));
save_mermaid(config.output_directory(), diagram->name + ".mmd", src);
}
}

View File

@@ -472,7 +472,9 @@ using namespace clanguml::test::matchers;
#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"
#endif
///
/// Include diagram tests
///