schnauzer: implement v2 template parser #3284
Conversation
sources/api/schnauzer/tests/templates/succeeds/04_comments.template
Outdated
Show resolved
Hide resolved
sources/api/schnauzer/tests/templates/succeeds/04_comments.template
Outdated
Show resolved
Hide resolved
|
^ Addresses feedback from @bcressey |
|
^ Addresses feedback from @zmrow |
| @@ -0,0 +1,6 @@ | |||
| [required-extensions] | |||
| beagle = """ | |||
| +++ | |||
| } | ||
|
|
||
| #[test] | ||
| fn fails_00_invalid_toml() { |
There was a problem hiding this comment.
I appreciate that you have written these as separate tests instead of cycling through directory templates. Separate tests are much better!
| .context(error::GrammarParseSnafu)? | ||
| .flatten(); | ||
|
|
||
| // If the template succesfully parses, we know there's always exactly one TOML document and one template body. |
There was a problem hiding this comment.
Is this true even if front matter is not present? Is front matter always required in a template, or are there cases where front matter would be optional?
There was a problem hiding this comment.
As written, the frontmatter is required, but it can be an empty document. In these cases, the template is like this:
+++
template body
We actually have a template in Bottlerocket right now which is a static file, and looks just like this (I can't recall which offhand).
There was a problem hiding this comment.
I will add a testcase that does this.
| } | ||
| pub use error::Error; |
There was a problem hiding this comment.
nit
| } | |
| pub use error::Error; | |
| } | |
| pub use error::Error; |
The v2 template format requires all templates to include a frontmatter section which explicitly specifies each setting and helper that is used to render the template.
|
Comments from @webern had me realize that there was a mismatch in my own understanding of static-text templates and my implementation. The two changes above fix that, and also address a stylistic nit. For what it's worth, we must always require the |
Issue number:
#3133
Description of changes:
The v2 template format requires all templates to include a frontmatter section which explicitly specifies each setting and helper that is used to render the template.
We use
pestto separate the frontmatter of the document from its body, then serde to parse the frontmatter document.Testing done:
The included tests pass.
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.