Skip to content

fix(diagrams): initialize PlantUML operand IDs #2829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pcristin wants to merge 1 commit into from
Closed

fix(diagrams): initialize PlantUML operand IDs #2829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions internal/cbm/diagram.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,6 +1228,7 @@ static bool dg_word_at(dg_str_t s, const char *word) {
* an id, or `[*]`; its id in *id; the position after it (i when none). */
static size_t dg_puml_operand(dg_str_t s, size_t i, dg_str_t *id, dg_str_t *label) {
i = dg_skip_ws(s, i);
*id = dg_s(NULL, 0);
*label = dg_s(NULL, 0);
if (i + CBM_SZ_3 <= s.n && memcmp(s.p + i, "[*]", CBM_SZ_3) == 0) {
*id = dg_s(s.p + i, CBM_SZ_3);
Expand Down
62 changes: 62 additions & 0 deletions tests/test_diagrams.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,66 @@ TEST(diagrams_plantuml) {
PASS();
}

/* Missing endpoints must not reuse an uninitialized operand (#2818). */
TEST(diagrams_plantuml_edge_messages) {
static const char *const messages[] = {"Alice ->: x", "Alice <-: x", "[-> Alice: x"};
for (size_t i = 0; i < sizeof(messages) / sizeof(messages[0]); i++) {
char src[512];
snprintf(src, sizeof(src),
"@startuml\n!include header.puml\nparticipant Alice\nparticipant Bob\n"
"%s\nAlice -> Bob : hello\n@enduml\n",
messages[i]);
CBMFileResult *r = dg_file(src, "docs/edge.puml");
ASSERT_NOT_NULL(r);
ASSERT_NOT_NULL(dg_def(r, "edge#diagram-1.Alice"));
ASSERT_NOT_NULL(dg_def(r, "edge#diagram-1.Bob"));
ASSERT_EQ(r->diagram_arrows.count, 1);
ASSERT_EQ(dg_arrows(r, "#diagram-1.Alice", "#diagram-1.Bob", "message", "hello"), 1);
ASSERT_EQ(dm_count_tokens(r, "header.puml"), 1);
cbm_free_result(r);
}
PASS();
}

TEST(diagrams_plantuml_unterminated_operands) {
static const char *const lines[] = {"[Missing -> Bob",
"(Missing -> Bob",
":Missing -> Bob",
"\"Missing -> Bob",
"Alice -> [Missing",
"Alice -> (Missing",
"Alice -> :Missing",
"Alice -> \"Missing",
"participant [Missing",
"participant (Missing",
"participant :Missing",
"participant \"Missing",
"participant \"Label\" as [Missing",
"participant \"Label\" as (Missing",
"participant \"Label\" as :Missing",
"participant \"Label\" as \"Missing"};
for (size_t i = 0; i < sizeof(lines) / sizeof(lines[0]); i++) {
char src[512];
snprintf(src, sizeof(src),
"@startuml\nparticipant Alice\nparticipant Bob\n%s\n"
"Alice -> Bob : hello\n@enduml\n",
lines[i]);
CBMFileResult *r = dg_file(src, "docs/invalid.puml");
ASSERT_NOT_NULL(r);
int elements = 0;
for (int j = 0; j < r->defs.count; j++) {
elements += strcmp(r->defs.items[j].label, "DiagramElement") == 0;
}
ASSERT_EQ(elements, 2);
ASSERT_NOT_NULL(dg_def(r, "invalid#diagram-1.Alice"));
ASSERT_NOT_NULL(dg_def(r, "invalid#diagram-1.Bob"));
ASSERT_EQ(r->diagram_arrows.count, 1);
ASSERT_EQ(dg_arrows(r, "#diagram-1.Alice", "#diagram-1.Bob", "message", "hello"), 1);
cbm_free_result(r);
}
PASS();
}

TEST(diagrams_dot) {
CBMFileResult *r =
dg_file("digraph G {\n"
Expand Down Expand Up @@ -1101,6 +1161,8 @@ SUITE(diagrams) {
RUN_TEST(diagrams_mermaid_kinds);
RUN_TEST(diagrams_other_fences);
RUN_TEST(diagrams_plantuml);
RUN_TEST(diagrams_plantuml_edge_messages);
RUN_TEST(diagrams_plantuml_unterminated_operands);
RUN_TEST(diagrams_dot);
RUN_TEST(diagrams_d2);
RUN_TEST(diagrams_drawio);
Expand Down
Loading