-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathtests.rs
More file actions
795 lines (636 loc) · 15.1 KB
/
Copy pathtests.rs
File metadata and controls
795 lines (636 loc) · 15.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
use super::*;
#[test]
fn test_class_diagram_basic() {
let source = "
class TestClass:
def __init__(self, x: int, y: int) -> None:
self.x = x
self.y = y
def add(self, x: int, y: int) -> int:
return x + y
def subtract(self, x: int, y: int) -> int:
return x - y
";
let expected_output = r"classDiagram
class TestClass {
+ \_\_init__(self, x, y) None
+ add(self, x, y) int
+ subtract(self, x, y) int
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_raw_mermaid_has_no_fences() {
let source = r#"
class TestClass:
def add(self, x: int, y: int) -> int:
return x + y
"#;
let mut diagram = ClassDiagram::default();
diagram.add_source(source);
let raw = diagram.render().unwrap_or_default();
assert!(!raw.contains("```mermaid"));
assert!(raw.contains("classDiagram"));
assert!(raw.contains("class TestClass"));
}
#[test]
fn test_class_diagram_generic_class() {
let source = "
class Thing[T]: ...
";
let expected_output = r#"classDiagram
class Thing ~T~"#;
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_generic_inner_class() {
let source = "
class Thing(Inner[T]): ...
";
let expected_output = r#"classDiagram
class Thing
Thing --|> Inner"#;
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_generic() {
let source = r#"
from typing import TypeVar, Generic
from abc import ABC
FancyType = TypeVar("FancyType")
class Thing(ABC, Generic[FancyType]): ...
"#;
let expected_output = r#"classDiagram
class Thing ~FancyType~ {
<<abstract>>
}"#;
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_generic_class_multiple() {
let source = "
class Thing[T, U, V]: ...
";
let expected_output = r#"classDiagram
class Thing ~T, U, V~"#;
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_final() {
let source = "
from typing import final
@final
class Thing: ...
";
let expected_output = "classDiagram
class Thing {
<<final>>
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_ellipsis() {
let source = "
class Thing: ...
";
let expected_output = "classDiagram
class Thing
";
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_complex() {
// this tests async, classmethod, args, return type
let source = "
class Thing:
@classmethod
async def foo(cls, first, /, *second, kwarg: bool = True, **unpack_this) -> dict[str, str]: ...
";
let expected_output = "classDiagram
class Thing {
+ @classmethod async foo(cls, first, /, *second, kwarg, **unpack_this) dict[str, str]
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_dataclass() {
let source = "
from dataclasses import dataclass
@dataclass
class Person:
name: str
age: int
def greet(self) -> str:
return f'Hello, I am {self.name}'
";
let expected_output = "classDiagram
class Person {
<<dataclass>>
+ str name
+ int age
+ greet(self) str
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_protocol() {
let source = "
from typing import Protocol
class Drawable(Protocol):
def draw(self) -> None:
...
class Circle(Drawable):
def draw(self) -> None:
pass
";
let expected_output = "classDiagram
class Drawable {
<<interface>>
+ draw(self) None
}
class Circle {
+ draw(self) None
}
Circle ..|> Drawable
";
test_diagram(source, expected_output);
}
#[test]
fn test_composition_relationships() {
let source = "
class Engine:
horsepower: int
class Wheel:
diameter: int
class Car:
engine: Engine
wheels: list[Wheel]
def drive(self) -> None:
pass
";
let expected_output = r#"classDiagram
class Engine {
+ int horsepower
}
class Wheel {
+ int diameter
}
class Car {
+ Engine engine
+ list[Wheel] wheels
+ drive(self) None
}
Car "1" *-- "1" Engine
Car "1" o-- "0..*" Wheel"#;
test_diagram(source, expected_output);
}
#[test]
fn test_composition_relationships_union_types() {
let source = "
class Engine:
horsepower: int
class Wheel:
diameter: int
class Car:
part: Engine | Wheel
";
let expected_output = r#"classDiagram
class Engine {
+ int horsepower
}
class Wheel {
+ int diameter
}
class Car {
+ Engine | Wheel part
}
Car "1" *-- "1" Engine
Car "1" *-- "1" Wheel"#;
test_diagram(source, expected_output);
}
#[test]
fn test_pydantic_example() {
let source = "
from pydantic import BaseModel
class ItemBase(BaseModel):
title: str
description: str | None = None
class ItemCreate(ItemBase):
pass
class Item(ItemBase):
id: int
owner_id: int
class Config:
orm_mode = True
class UserBase(BaseModel):
email: str
class UserCreate(UserBase):
password: str
class User(UserBase):
id: int
is_active: bool
items: list[Item] = []
class Config:
orm_mode = True
";
let expected_output = r#"classDiagram
class ItemBase {
+ str title
+ str | None description
}
class Item {
+ int id
+ int owner_id
}
class ItemCreate
class UserBase {
+ str email
}
class User {
+ int id
+ bool is_active
+ list[Item] items
}
class UserCreate {
+ str password
}
ItemBase --|> pydantic.BaseModel
ItemCreate --|> ItemBase
Item --|> ItemBase
UserBase --|> pydantic.BaseModel
UserCreate --|> UserBase
User --|> UserBase
User "1" o-- "0..*" Item"#;
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_unique_overloads() {
let source = "
from typing import overload
class Thing:
@overload
def __init__(self, x: int, y: int) -> None: ...
@overload
def __init__(self, x: str, y: str) -> None: ...
def __init__(self, x: int | str, y: int | str) -> None: ...
";
let expected_output = r"classDiagram
class Thing {
+ @overload \_\_init__(self, x, y) None
+ \_\_init__(self, x, y) None
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_object_base() {
let source = "
class Thing(object): ...
";
let expected_output = "classDiagram
class Thing
";
test_diagram(source, expected_output);
}
#[test]
fn test_class_diagram_dundermagic_infer() {
let source = "
class Thing:
def __complex__(self): ...
def __bytes__(self): ...
";
let expected_output = r"classDiagram
class Thing {
+ \_\_complex__(self) complex
+ \_\_bytes__(self) bytes
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_notimplemented() {
let source = "
class Thing:
def do_thing(self):
raise NotImplementedError
";
let expected_output = "classDiagram
class Thing {
+ do_thing(self)
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_abstract_base_class() {
let source = r#"
from abc import ABC, abstractmethod
class Thing(ABC):
@abstractmethod
def do_thing(self) -> None:
"""Must be implemented by subclasses"""
pass
"#;
let expected_output = "classDiagram
class Thing {
<<abstract>>
+ do_thing(self) None*
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_enum() {
let source = "
from enum import Enum
class Color(Enum):
RED = 1
GREEN = 2
BLUE = 3
";
let expected_output = "classDiagram
class Color {
<<enumeration>>
+ int RED
+ int GREEN
+ int BLUE
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_staticmethod() {
let source = "
class Thing:
@staticmethod
def static_method(x: int, y: int) -> int:
return x + y
";
let expected_output = "classDiagram
class Thing {
+ @staticmethod static_method(x, y) int$
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_property_as_attribute() {
let source = "
class Person:
@property
def name(self) -> str:
return self._name
@name.setter
def name(self, value: str) -> None:
self._name = value
@name.deleter
def name(self) -> None:
del self._name
";
let expected_output = "classDiagram
class Person {
+ str name
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_property_no_return_annotation() {
let source = "
class Thing:
@property
def value(self):
return 42
";
let expected_output = "classDiagram
class Thing {
+ Any value
}
";
test_diagram(source, expected_output);
}
#[test]
fn test_concrete_generic_base() {
let source = r#"
from typing import TypeVar, Generic
IndexType = TypeVar("IndexType")
class Store(Generic[IndexType]):
def insert(self, data) -> None:
pass
class MemoryStore(Store[int]):
def insert(self, data) -> None:
self.storage.append(data)
"#;
let expected_output = r#"classDiagram
class Store ~IndexType~ {
+ insert(self, data) None
}
class MemoryStore {
+ insert(self, data) None
}
MemoryStore --|> Store"#;
test_diagram(source, expected_output);
}
#[test]
fn test_abstract_generic_inheritance() {
let source = r#"
from typing import TypeVar, Generic
from abc import ABC, abstractmethod
IndexType = TypeVar("IndexType")
class Store(ABC, Generic[IndexType]):
@abstractmethod
def insert(self, data) -> None:
pass
class MemoryStore(Store[int]):
def insert(self, data) -> None:
self.storage.append(data)
"#;
let expected_output = r#"classDiagram
class Store ~IndexType~ {
<<abstract>>
+ insert(self, data) None*
}
class MemoryStore {
+ insert(self, data) None
}
MemoryStore ..|> Store"#;
test_diagram(source, expected_output);
}
#[test]
fn test_full_generics_example() {
let source = r#"
from typing import TypeVar, Generic
from abc import ABC, abstractmethod
from datetime import datetime
IndexType = TypeVar("IndexType")
FancyStorage = TypeVar("FancyStorage")
class Store(ABC, Generic[IndexType]):
@abstractmethod
def insert(self, data) -> None:
pass
class MemoryStore(Store[datetime]):
def insert(self, data) -> None:
self.storage.append(data)
class FancyStore(Store[datetime], Generic[FancyStorage]):
def __init__(self, fancy_store: FancyStorage) -> None:
self.storage = fancy_store
def insert(self, data) -> None:
self.storage.insert(data)
"#;
let expected_output = r#"classDiagram
class Store ~IndexType~ {
<<abstract>>
+ insert(self, data) None*
}
class FancyStore ~FancyStorage~ {
+ \_\_init__(self, fancy_store) None
+ insert(self, data) None
}
class MemoryStore {
+ insert(self, data) None
}
MemoryStore ..|> Store
FancyStore ..|> Store"#;
test_diagram(source, expected_output);
}
#[test]
fn test_non_default_direction_emitted() {
use crate::render::mermaid_renderer::RenderOptions;
use crate::render::renderer::DiagramDirection;
let source = "class Thing: ...";
let expected = "classDiagram
direction LR
class Thing
";
let options = RenderOptions {
direction: DiagramDirection::LR,
hide_private_members: false,
};
let mut diagram = ClassDiagram::new(options);
diagram.add_source(source);
let output = diagram.render().unwrap_or_default();
assert_eq!(output.trim(), expected.trim());
}
#[test]
fn test_hide_private_members() {
use crate::render::mermaid_renderer::RenderOptions;
let source = "
class Foo:
x: int
_private: str
def bar(self) -> None: ...
def _helper(self) -> None: ...
";
let mut diagram = ClassDiagram::new(RenderOptions::default());
diagram.add_source(source);
let with_private = diagram.render().unwrap_or_default();
assert!(
with_private.contains("_private"),
"private attr should appear when not hidden; got: {with_private}"
);
assert!(
with_private.contains("_helper"),
"private method should appear when not hidden; got: {with_private}"
);
diagram.set_hide_private_members(true);
let without_private = diagram.render().unwrap_or_default();
assert!(
without_private.contains("+ int x"),
"public attr should appear"
);
assert!(
without_private.contains("+ bar(self)"),
"public method should appear"
);
assert!(
!without_private.contains("_private"),
"private attr should be hidden; got: {without_private}"
);
assert!(
!without_private.contains("_helper"),
"private method should be hidden; got: {without_private}"
);
}
#[test]
fn test_cardinality_composition() {
let source = r#"
class Engine:
power: int
class Car:
engine: Engine
"#;
let mut diagram = ClassDiagram::default();
diagram.add_source(source);
let result = diagram.render().unwrap_or_default();
assert!(
result.contains(r#"Car "1" *-- "1" Engine"#),
"bare type should be composition with cardinality 1; got: {result}"
);
}
#[test]
fn test_cardinality_optional() {
let source = r#"
from typing import Optional
class Engine:
power: int
class Car:
engine: Optional[Engine]
"#;
let mut diagram = ClassDiagram::default();
diagram.add_source(source);
let result = diagram.render().unwrap_or_default();
assert!(
result.contains(r#"Car "1" o-- "0..1" Engine"#),
"Optional should be aggregation with cardinality 0..1; got: {result}"
);
}
#[test]
fn test_cardinality_union_with_none() {
let source = r#"
class Engine:
power: int
class Car:
engine: Engine | None
"#;
let mut diagram = ClassDiagram::default();
diagram.add_source(source);
let result = diagram.render().unwrap_or_default();
assert!(
result.contains(r#"Car "1" o-- "0..1" Engine"#),
"X|None should be aggregation with cardinality 0..1; got: {result}"
);
}
#[test]
fn test_cardinality_collection() {
let source = r#"
class Wheel:
diameter: int
class Car:
wheels: list[Wheel]
"#;
let mut diagram = ClassDiagram::default();
diagram.add_source(source);
let result = diagram.render().unwrap_or_default();
assert!(
result.contains(r#"Car "1" o-- "0..*" Wheel"#),
"list type should be aggregation with cardinality 0..*; got: {result}"
);
}
fn test_diagram(source: &str, expected_output: &str) {
let mut diagram = ClassDiagram::default();
diagram.add_source(source);
let output = diagram.render().unwrap_or_default();
assert_eq!(output.trim(), expected_output.trim());
}
#[expect(dead_code)]
fn test_diagram_print(source: &str) {
// for making new tests and debugging :P
let mut diagram = ClassDiagram::default();
diagram.add_source(source);
println!("{}", diagram.render().unwrap_or_default());
assert_eq!(1, 2);
}