Add JSON schema documenting logs #69
Conversation
abailly-iohk
force-pushed
the
abailly-iohk/test-conformance-of-logs
branch
from
532379b
to
2039547
Compare
abailly-iohk
force-pushed
the
abailly-iohk/test-conformance-of-logs
branch
from
0f096ed
to
2791ac8
Compare
|
@KtorZ I think I have addressed your concerns about the holes in checking specs. |
hydra-node/test/Hydra/JSONSchema.hs
Outdated
| Text -> | ||
| FilePath -> | ||
| Property | ||
| prop_validateToJSON specFile namespace inputFile = |
There was a problem hiding this comment.
Could: The inputFile is redundant (and complicates the interface of having two filepaths). Instead the function could require Typeable and use typeOf to create a filename unique per-type to test in a temporary directory.
hydra-node/test/Hydra/JSONSchema.hs
Outdated
| , -- This second sub-property ensures that any key found in the | ||
| -- specification corresponds to a constructor in the corresponding | ||
| -- data-type. This in order the document in sync and make sure we don't | ||
| -- left behind constructors which no longer exists. |
There was a problem hiding this comment.
Does this also apply to the log api? If so, the given namespace "logs" is nowhere found in the api-logs.yaml and I wonder whether this works.
This will need specific tests for roundtripping, stability of JSON format and conformance with the published schema
This extracts and generalises code previously from the APISpec module to be used by LoggingSpec module in order to test conformance of log entries with JSON schema.
Added log entries for Events
Also provide fields for the PostChainTx constructors
The completeness property is very dependent on some specific structure of the specification YAML and not suited for all types which are specified in different places in the Yaml
Co-authored-by: Sebastian Nagel <[email protected]>
Also addresses some review comments: * Unify punctuation in yaml spec * Move Envelope to Logging module and use it * Add more comments to prop_specIsComplete
abailly-iohk
force-pushed
the
abailly-iohk/test-conformance-of-logs
branch
from
fa97b09
to
e729aef
Compare
|
|
||
| -- NOTE(AB): This is a bit contrived but we want a numeric threadId and we | ||
| -- get some text which we know the structure of | ||
| mkThreadId = fromMaybe 0 . readMaybe . Text.unpack . Text.drop 9 . show |
There was a problem hiding this comment.
What's stopping us from having a threadId :: Text?
There was a problem hiding this comment.
The schema would not fit, so we would need to change both. I agree this expression is annoying hence my comment.
| -- - title: APIServer | ||
| -- type: object | ||
| -- ... | ||
| -- @@ |
| ] | ||
|
|
||
| apiSpecificationSelector :: SpecificationSelector | ||
| apiSpecificationSelector = key "properties" . key "message" |
There was a problem hiding this comment.
Could: inline as it's short enough now.
There was a problem hiding this comment.
Will do it in master
This adds the schema file and the related conformance tests adapted from
APISpecto check generated JSON conforms with the specification.NOTE: Not all log entries are documented (yet)