Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-5912

Implement a human friendly PCore serialization format

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 5.0.0
    • Component/s: Type System
    • Labels:
      None
    • Template:
    • Sub-team:
    • Team:
      Agent
    • Story Points:
      3
    • Sprint:
      Agent 2017-06-14
    • Release Notes:
      Not Needed
    • Release Notes Summary:
      Part of experimental - not yet publically released feature.
    • QA Risk Assessment:
      No Action
    • QA Risk Assessment Reason:
      Covered by spec tests

      Description

      The serializers in PUP-5908 and PUP-5909 focus on machine to machine communication. They will contain many optimizations and tricks to make those formats as efficient as possible for the underlying encoding. They will look like complete gibberish to a human.

      In order to make models humanly readable (although not exclusively targeting humans) we should implement a serializer that has verbose output. This format may also be used for someone that is writing utility tools in a language/environment where the investment to support the Machine to Machine formats is prohibiting. (There are many tasks you can perform with something like json-query on such a format; defining the json query that can make sense out of the highly optimized and tabulated machine to machine formats is almost impossible).

      We should use JSON for this.

      When we have this format, it is easy to transform between them. A file with a MM format can be deserialized and re-serialized possibly even without having to create a representation. This enables writing a tool for inspection of binary serialization and other similar use cases.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              henrik.lindberg Henrik Lindberg
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support