https://github.com/magodo/tfstate

Helper types for Terraform state on top of https://github.com/hashicorp/terraform-json
https://github.com/magodo/tfstate

terraform

Last synced: 12 days ago
JSON representation

Helper types for Terraform state on top of https://github.com/hashicorp/terraform-json

• Host: GitHub
• URL: https://github.com/magodo/tfstate
• Owner: magodo
• License: mpl-2.0
• Created: 2022-03-31T08:19:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T04:39:33.000Z (23 days ago)
• Last Synced: 2024-10-17T19:43:11.752Z (21 days ago)
• Topics: terraform
• Language: Go
• Homepage:
• Size: 57.6 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PkgGoDev](https://pkg.go.dev/badge/github.com/magodo/tfstate)](https://pkg.go.dev/github.com/magodo/tfstate)

# tfstate

Helper types for Terraform state on top of https://github.com/hashicorp/terraform-json.

## Why

Currently, there is no good way to interact with Terraform state. This makes sense as Terraform core intentionally hide the details of the state as it is evolving quickly. If you look into the Terraform core codebase, you'll notce that [there are multiple formats defined for states along the lifetime of Terraform](https://github.com/hashicorp/terraform/tree/d3e7c5e8a9162617f9cc12ccd005347978825d02/internal/states/statefile).

Whilst for some reason, developers still want a way to inspect the Terraform state file via some means. Currently, the correct way to do so is via https://github.com/hashicorp/terraform-exec. Where it provides a method [`Show()`](https://pkg.go.dev/github.com/hashicorp/[email protected]/tfexec#Terraform.Show), that returns you a [`tfjson.State`](https://pkg.go.dev/github.com/hashicorp/terraform-json#State).

Everything works just fine, the only problem is for each resource instance inside `tfjson.State`, its main content [`AttributeValues`](https://pkg.go.dev/github.com/hashicorp/terraform-json#StateResource) is of type `map[string]interface{}`. This makes the user can hardly do some fancy inspection on the resource attributes, as they are not typed.

This package aims to fix this last gap by defining a thin wrapper `tfstate.State` around the `tfjson.State`, which has almost the same structure, except the `AttributeValues` is replaced with `Value`, which is of type `cty.Value`.

## Note

This package only works for the V4 format of state file, which is the used since Terraform v0.12.

## Example

See: https://github.com/magodo/tfstate/blob/main/state_example_test.go.