Support explicitly setting proto field tags. #549
Conversation
The YANG to Protobuf specification mentions using extensions to explicitly set the field tag of generated Protobuf fields. Add support for annotating field tags. * Support setting the field number with occodegenext:field-number. * Support offsetting the field number with occodegenext:field-number-offset. * Reject field number annotations that result in a value in the Protobuf reserved range.
… into support-field-number-gen
Credits to @jasonewang for posting the first implementation at #339. I've modified this a bit to read the extension values from the new openconfig-codegen-extensions.yang model that's now in openconfig/public, and also to address some of the corner cases that were discussed in the PR. Spec: https://github.com/openconfig/ygot/blob/master/docs/yang-to-protobuf-transformations-spec.md#field-numbering Corner cases not mentioned in the spec: 1. multiple `field-number` extensions. - Error out. 1. multiple `field-number-offset` extensions. - Add them up. 1. `field-number` or `field-number-offset` extensions on non-leaves. - Silently ignore. 1. `field-number-offset` on non-uses statements, including leafs. - Allow. 1. Conflicts. - Allow. The proto compilation will of course fail. Automated checking can be added here if we'd prefer. I made some simple choices for the above items. Erroring out for 3 and 4 would likely require changing `goyang` to specifically support checking these cases, which I'm not sure is worth it here.
|
All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the ℹ️ Googlers: Go here for more info. |
1 similar comment
|
All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the ℹ️ Googlers: Go here for more info. |
|
@jasonewang would you be able to consent to this PR being submitted based on your prior commits? (please see googlebot's post) |
|
@googlebot I consent |
|
@jasonewang Do you think you can consent to your commits being contributed to this project? If so could you consent like I did above? Thanks a lot. |
|
Ok, I figured out you can push to the fork repository. So I just did that instead. |
Credits to @jasonewang for posting the first implementation at #339. I've modified this a bit to read the extension values from the new openconfig-codegen-extensions.yang model that's now in openconfig/public, and also to clarify the corner cases that were discussed in the PR.
Spec:
https://github.com/openconfig/ygot/blob/master/docs/yang-to-protobuf-transformations-spec.md#field-numbering
Corner cases not mentioned in the spec:
field-numberextensions.field-number-offsetextensions.field-numberorfield-number-offsetextensions on non-leaves.field-number-offseton non-uses statements, including leafs.I made some simple choices for the above items. Erroring out for 3 and 4 would likely require changing
goyangto specifically support checking these cases, which I'm not sure is worth it here.