nkhancock
commented
1 year ago The following examples illustrate what has been fixed.
The following YANG data models were used to test these fixes:
test-module-common
``` module test-module-common { namespace "http://www.example.com/ns/yang/test-module-common"; prefix tst-mod-c; revision 2023-07-17 { description "Initial revision."; reference "None."; } identity base-identity { description "..."; } } ```test-module-1
``` module test-module-1 { namespace "http://www.example.com/ns/yang/test-module-1"; prefix tst-mod-1; import test-module-common { prefix tst-mod-c; } revision 2023-07-17 { description "Initial revision."; reference "None."; } identity base-id { description "Base identity for my identities."; } identity id-1 { base base-id; description "..."; } identity id-2 { base base-id; description "..."; } identity id-3 { base id-2; description "..."; } identity module-1-identity { base tst-mod-c:base-identity; description "..."; } typedef direction { type enumeration { enum up { description "..."; } enum down { description "..."; } } } typedef base-id-ref { type identityref { base base-id; } description "..."; } container refs { description "..."; list list { key name; description "..."; leaf name { type string; description "..."; } leaf id { type identityref { base base-id; } description "..."; } } } } ```test-module-2
``` module test-module-2 { namespace "http://www.example.com/ns/yang/test-module-2"; prefix tst-mod-2; import test-module-1 { prefix tst-mod-1; } revision 2023-07-17 { description "Initial revision."; reference "None."; } identity another-id { base tst-mod-1:base-id; description "..."; } typedef list-ref { type leafref { path "/tst-mod-1:refs" + "/tst-mod-1:list" + "/tst-mod-1:name"; } description "---."; } typedef selection-ref { type leafref { path "/tst-mod-1:refs" + "/tst-mod-1:list" + "/tst-mod-2:select" + "/tst-mod-2:name"; } description "---."; } typedef id-2-ref { type identityref { base tst-mod-1:id-2; } description "..."; } augment "/tst-mod-1:refs/tst-mod-1:list" { description "..."; list select { key name; description "..."; leaf name { type string; description "..."; } leaf thing-1 { type list-ref; description "..."; } leaf thing-2 { type leafref { path "/tst-mod-1:refs" + "/tst-mod-1:list" + "/tst-mod-1:name"; } description "..."; } leaf remote-identity { type identityref { base tst-mod-1:id-3; } description ".."; } } } } ```test-identifier-clash
``` module test-identifier-clash { yang-version 1.1; namespace "http://www.example.com/ns/yang/test-identifier-clash"; prefix tst-id-clsh; revision 2023-07-17 { description "Initial revision."; reference "None."; } feature direction { description "Indicates that directions as typedef are supported."; } identity direction { if-feature direction; description "Base identity for my identities."; } identity up { base direction; description "..."; } identity down { base direction; description "..."; } typedef direction { type enumeration { enum up { description "..."; } enum down { description "..."; } } } container direction { description ""; leaf direction { type direction; description "..."; } leaf another-direction { type identityref { base direction; } description "..."; } } } ```Example 1
Before the fixes:
- Blue: Missing stereotype \<\<enumeration>> on enum class direction (addressed by fix 1).
- Yellow: Incorrect relation from \<\<module>> class test-module-1 to \<\<identity>> class base-id; this relation should be from \<\<typedef>> class base-id-ref to \<\<identity>> class base-id (addressed by fix 2).
After the fixes:
Example 2
Before the fixes:
- Blue, green: Missing \<\<identity>> placeholder classes for identities id-2 and id-3 from test-module-1 (addressed by fix 6).
- Yellow: Incorrect relation from \<\<module>> class test-module-2 to class tst_mod_1_id_2; this relation should be from \<\<typedef>> class id-2-ref to an \<\<identity>> placeholder class tst-mod-2:id-2 (see green) (addressed by fix 2).
- Red-orange: Missing circle and \<\<list>> stereotype on \<\<list>> class select. This was due to a keyword clash resulting from a placeholder class defined to represent a leafref whose target was not in this module (addressed by fix 9).
After the fixes:
Example 3
Before the fixes:
- Yellow: The \<\<identity>> class tst-mod-c:base-identity is only used as a base in test-module-1 but is also rendered in test-module-2 (addressed by fix 5).
- Green: Incorrect relation from \<\<module>> class test-module-2 to class tst_mod_1_id_2; this relation should be from \<\<typedef>> class id-2-ref to \<\<identity>> class id-2 in test-module-1 (addressed by fixes 2 and 6).
- Blue: A relation is not created between the \<\<list>> class select in test-module-2 to the \<\<identity>> class id-3 in test-module-1 but to a placeholder class tst_mod_1_id_3 in test-module-2 (addressed by fixes 7 and 8).
- Red-orange: \<\<identity>> placeholder class tst-mod-1:base-id is incorrectly defined in test-module-2 (addressed by fix 8)
After the fixes:
Example 4
Before the fixes:
Blue: The keywords generated for the enumeration class direction and the \<\<container>> class direction are identical, i.e., _test_identifier_clash_Idirection and thus clash (addressed by fix 8).
This pull request fixes issues with the rendering of identities, identities, typedefs and leafrefs and relations associated with them:
Note that other issues need addressing in a future pull requests such as the issue where individual node prefixes within XPath expressions are not taken into account when defining keywords for data nodes which leads to issues when handling XPaths for augmentations, e.g., when 2 augmentations augment the same named node but under different module prefixes, e.g., the nodes ‘line’ in the modules bbf-fast and bbf-vdsl. Due to its impact on the existing code, this issue was not addressed with this pull request.