Library - Validate CBOR structs according to the cddl schema for `nodes/models` misc

nazmulidris commented 1 year ago

The ockam_api crate exchanges many structs with the Controller. Those structs are serialized using CBOR and should conform to the cddl schema.

Currently there are only a handful of structs tested for conformance to the schema:

project (and related structs)
space (and related structs)
subscription (and related structs)

The purpose of this issue is to complete the testing by:

adding more quickcheck properties similar to the ones above
adding missing schema.cddl definitions where necessary
additionally remove the lifetime annotations on structs, like this one (and replace CowStr<'a> with String)

To the following list of structs:

nodes/models/base/NodeStatus
nodes/models/credentials/GetCredentialRequest
nodes/models/credentials/PresentCredentialRequest
nodes/models/flow_controls/AddConsumer
nodes/models/forwarder/CreateForwarder
nodes/models/forwarder/ForwarderInfo
nodes/models/identity/LongIdentityResponse
nodes/models/identity/ShortIdentityResponse
nodes/models/policy/Policy
nodes/models/policy/PolicyList
nodes/models/policy/Expression

[!NOTE] Related epic: https://github.com/build-trust/ockam/issues/6235

We love helping new contributors! ❤️ If you have questions or need help as you explore, please join us on Discord. If you're looking for other issues to contribute to, please checkout our good first issues.

shautvast commented 11 months ago

did the first 2, looks easy enough. please assign

mrinalwadhwa commented 11 months ago

@shautvast That's awesome, all yours.

Please let us know if your have any questions as you explore. You can also ask questions on the contributors discord https://discord.ockam.io

shautvast commented 10 months ago

submitted PR https://github.com/build-trust/ockam/pull/7169

build-trust / ockam

Library - Validate CBOR structs according to the cddl schema for `nodes/models` misc #6690