twoliter icon indicating copy to clipboard operation
twoliter copied to clipboard

buildsys: validate manifest metadata when deserializing

Open webern opened this issue 1 year ago • 0 comments

The ManifestInfo type deserializes certain sections from Cargo.toml

  • package.metadata.build-package
  • package.metadata.build-kit
  • package.metadata.build-variant

Currently the differences between build-package, build-kit and build-variant is not constrained by an enum. This leads to a lot of "late binding" errors if an expected field is missing. Instead a different type for each of these should be created. For example:

struct BuildPackageInfo { }
struct BuildKitInfo { }
struct BuildVariantInfo { }

enum BuildsysMetadata {
    Package(BuildPackageInfo),
    Kit(BuildKitInfo),
    Variant(BuildVariantInfo),
}

If serde is used correctly with this structure, then missing information will cause an error at deserialization time and get rid of Options and errors downstream when fields are being accessed.


          We should create an issue, if we don't have one already, for deserializing these manifest metadata sections with Serde in a validating manner. We should catch these errors earlier.

Originally posted by @webern in https://github.com/bottlerocket-os/twoliter/pull/271#discussion_r1628513941

webern avatar Jun 06 '24 20:06 webern