feat: persist plugin raw_options blob in the config file#18
Closed
liamcervante wants to merge 4 commits into
Closed
feat: persist plugin raw_options blob in the config file#18liamcervante wants to merge 4 commits into
liamcervante wants to merge 4 commits into
Conversation
Thread the plugin-authored raw_options blob through identification: capture it from IdentifyProjects (directory-level seed) and IdentifyEnvironments (per environment), thread the seed into IdentifyEnvironments, and carry the resolved blob on the intermediate autodetect project. For plugins that don't yet emit a raw_options blob, backfill it from the data config derived itself (attributed var files + resolved workspace) so the persisted blob matches what the callers historically built. The backfill is isolated in autodetect/rawoptions_backfill.go and marked for removal once every plugin emits raw_options. The blob is captured but not yet emitted to the config file; that follows in a subsequent commit. Bumps github.com/infracost/proto to the commit introducing raw_options.
liamcervante
force-pushed
the
plugin-raw-options
branch
3 times, most recently
from
July 10, 2026 09:06
9c5e9b9 to
3085f9a
Compare
…level defaults Add a generic, plugin-keyed `plugins` section to the config file, keyed by the consuming plugin name (e.g. "terraform"). autodetect now emits each project's raw_options blob under plugins.<type>, stored as a native YAML map so it stays readable and editable. The existing terraform.* fields are still emitted alongside as backwards-compatible sugar for consumers that don't yet read the blob. Also add repo-level plugin defaults (top-level `plugins`) that deep-merge into each project's matching blob during normalization: nested maps merge recursively, lists concatenate, and per-project values win over the global default. The merge is schema-agnostic - config never interprets the blob. The field is additive within config version 0.3 (no version bump, which would make older parsers reject the file outright).
Generation now emits parse options only under plugins.<type> - the deprecated terraform.* / aws.* fields are no longer written. On read, any hand-authored deprecated fields (and the repo-level terraform.source_map) are folded into the plugins blob so old and hand-written configs still present the new style to consumers. The CLI and runner (updated to this config version) read plugins.<name> and are responsible for building the blob sent to the plugin. Folding is isolated in config_plugins_compat.go, marked for removal once the deprecated fields are gone.
liamcervante
force-pushed
the
plugin-raw-options
branch
from
July 10, 2026 09:41
3085f9a to
b3645b7
Compare
liamg
approved these changes
Jul 10, 2026
…to plugins
Previously autodetect backfilled a whole {tfVarsFiles, workspace} blob for
terraform-family projects when the plugin didn't author one. That duplicated
option schema config shouldn't own: workspace (and anything else) is the
plugin's to author via IdentifyEnvironments/IdentifyProjects.
Narrow config's responsibility to the one thing only it can compute:
tfVarsFiles, which depends on the cross-directory (sibling/pibling) attribution
that lives in config's tree passes. Instead of synthesising and replacing the
blob, sideloadTFVarsFiles now merges tfVarsFiles into whatever the plugin
authored (its per-env blob, the IdentifyProjects seed, or nothing), leaving
every other key untouched so the blob stays extensible. workspace is no longer
written by config - it comes from the plugin. Downstream this is safe: an unset
workspace and an empty one are identical in the CLI, runner, and parser (all
gate on == "" and the parser defaults to "default").
This is a deliberate, minimal special case expected to retire once
IdentifyAllProjects moves the multi-directory attribution plugin-side.
Test_Generate_EmitsPluginBlob's workspace assertion now depends on a terraform
plugin that emits raw_options from IdentifyEnvironments (proto >= v1.158.0).
installTestPlugins downloads the latest released plugin, which predates that, so
the assertion fails for now and starts passing once the new plugins are
released; the test is documented accordingly. tfVarsFiles and all other tests
pass.
Contributor
Author
|
closed in favour of #19 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Wires the plugin
raw_optionsblob (added in infracost/proto#81) through config-file generation and makesplugins.<name>the canonical config format — additive and backwards-compatible. Three commits.Commit 1 — capture + backfill (self-contained)
raw_optionsblob through identification: capture it fromIdentifyProjects(directory-level seed) andIdentifyEnvironments(per environment), thread the seed intoIdentifyEnvironments, and carry the resolved blob on the intermediate autodetect project.autodetect/rawoptions_backfill.go, marked for removal once every plugin emitsraw_options.Commit 2 — emit + merge
pluginssection to the config file (keyed by consuming plugin, e.g.terraform), emitted per project underplugins.<type>as a native YAML map.pluginsdefaults that deep-merge into each project's blob during normalization: nested maps merge recursively; every other value (scalars and lists) is atomic, with per-project winning over the global default. Schema-agnostic — config never interprets the blob.Commit 3 — make
plugins.<name>canonicalplugins.<type>; the deprecatedterraform.*/aws.*fields are no longer written.terraform.source_map) are folded into the plugins blob so old and hand-written configs still present the new style to consumers. Structured values win over the blob. Isolated inconfig_plugins_compat.go, marked for removal once the deprecated fields are gone.plugins.<name>and are responsible for building the blob sent to the plugin.Notes
CurrentVersionis already0.3and parsing is strict (KnownFields(true)); bumping would make older parsers reject the file outright, which is less backwards-compatible than addingplugins:additively within 0.3.go.modat a tagged proto release before merging.Testing
go build ./...andgo test ./...pass.plugins_blob_test.gocovers backfilled emission, the global→per-project merge, and folding deprecated fields; the shared generate-test assertions now read var files from the plugins blob.