https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/YANGTOOLS-766 yangtools <p>There is a slight difference between how instance-identifiers are encoded in <a href="https://tools.ietf.org/html/draft-lhotka-netmod-yang-json-02" class="external-link" target="_blank" rel="nofollow noopener">https://tools.ietf.org/html/draft-lhotka-netmod-yang-json-02</a> (used by draft-bierman-netconf-restconf-02) and <a href="https://tools.ietf.org/html/rfc7951" class="external-link" target="_blank" rel="nofollow noopener">https://tools.ietf.org/html/rfc7951</a> (used by RFC8040).</p> <p>For RFC8040 we need to use a different JSON codec to handle prefixes.</p> <p>While we are in the area, I suspect key encoding does not work correctly (for both XML and JSON) with respect to complex types &#8211; i.e. when we are encoding an instance identifier which uses one of:</p> <ul class="alternate" type="square"> <li>empty</li> <li>identityref</li> <li>instance-identifier<br/> as type of a key leaf.</li> </ul> <p>Operating System: All<br/> Platform: All</p> YANGTOOLS-766

yang-data-codec-gson: compressed instance-identifier codec

Bug Resolved Done Robert Varga Robert Varga Mon, 27 Mar 2017 09:20:03 +0000 Sun, 10 Apr 2022 18:35:58 +0000 Thu, 28 Dec 2017 15:34:39 +0000 2.0.0 1.2.1 1.2.2 2.0.1 0 2 <p>I wrote a bunch of unit tests - <a href="https://git.opendaylight.org/gerrit/#/c/54106/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/54106/</a><br/> Here's what I found out:</p> <p>JSON parsing:</p> <p>Currently, an instance-identifier value must have all its node-identifiers prefixed to be parsed without failing. Thus, if we want to follow the rules defined in RFC7951, we'll have to modify the JSON instance-identifier codec so that values like this can be parsed:<br/> /ietf-interfaces:interfaces/interface<span class="error">&#91;name=&#39;eth0&#39;&#93;</span>/ietf-ip:ipv4/ip</p> <p>An instance-identifier which has a list with a key of type empty in its path - this does not work because the key value (in JSON it's <span class="error">&#91;null&#93;</span>) is deserialized to null which leads to a NPE when inserting it into a key-value map here: XpathStringParsingPathArgumentBuilder.java:166</p> <p>An instance-identifier which has a list with a key of type identityref in its path - this works whether the key value contains a prefix or not.</p> <p>An instance-identifier which has a list with a key of type instance-identifier in its path - this works only when the key value contains prefixes.</p> <p>XML parsing:</p> <p>An instance-identifier which has a list with a key of type empty in its path - this does not work because the key value (in XML it's an empty/self-closed element) is deserialized to null which leads to a NPE when inserting it into key-value map here: XpathStringParsingPathArgumentBuilder.java:166</p> <p>An instance-identifier which has a list with a key of type identityref in its path - this works whether the key value contains a prefix or not.</p> <p>An instance-identifier which has a list with a key of type instance-identifier in its path - this works only when the key value contains prefixes.</p> <p>Since the above analysis was done we have moved a bit. empty leaves are now properly represented with a non-null Empty object, allowing them to be used in keys. <a href="https://jira.opendaylight.org/browse/YANGTOOLS-678" title="[Yang 1.1] Allow type &quot;empty&quot; in a key" class="issue-link" data-issue-key="YANGTOOLS-678"><del>YANGTOOLS-678</del></a> is taking care of enabling the @Ignore'd JSON test.</p> <p> </p> <p>This leaves this issue to deal with the original problem, which is YangInstanceIdentifier parsing/emission without repeating prefixes. The JSON parser API change to enable users to select proper JSONCodecFactory is at <a href="https://git.opendaylight.org/gerrit/66765" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/66765</a>.</p> <p>As it turns out, this issue affects both parsing and emission of YangInstanceIdentifier, as RFC7951 explicitly forbids the use of prefixes when the subsequent node identifier has the same namespace.</p> <p>At any rate, the next step is to wire a slightly different version of XpathStringParsingPathArgumentBuilder into RFC7951, one that is memoizing last used prefix (or even resulting QNameModule) when parsing an argument, but not when parsing predicates.</p> <p>Support for parsing RFC7951 instance identifiers: <a href="https://git.opendaylight.org/gerrit/66772" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/66772</a></p> <p>Nitrogen cherry-picks:</p> <p><a href="https://git.opendaylight.org/gerrit/66773" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/66773</a></p> <p><a href="https://git.opendaylight.org/gerrit/66774" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/66774</a></p> <p> </p> Blocks NETCONF-494 YANGTOOLS-758 YANGTOOLS-759 Duplicate YANGTOOLS-782 Relates YANGTOOLS-678 Development External issue ID 8083 External issue URL Issue Type Rank 0|i02993: