preview

README

Cortex Preview

Cortex Preview is an RWSTech component used by Cortex Code to extract and manage workspace parameters from Terraform configurations.

It validates parameter selections and provides the dynamic form controls and dependency handling used by Cortex Code templates.

Support

Report incorrect workspace parameter behavior with the workspace template issue form. For other bugs and feature requests, open a general issue.

This repository is maintained publicly by RWSTech.

Documentation

Index

• type Input
  • func (i Input) RichParameterValue(key string) (string, bool)
• type Output
  • func Preview(ctx context.Context, input Input, dir fs.FS) (output *Output, diagnostics hcl.Diagnostics)
  • func (o Output) MarshalJSON() ([]byte, error)

Types

type Input

type Input struct {
	// PlanJSONPath is an optional path to a plan file. If PlanJSON isn't
	// specified, and PlanJSONPath is, then the file will be read and treated
	// as if the contents were passed in directly.
	PlanJSONPath    string
	PlanJSON        json.RawMessage
	ParameterValues map[string]string
	Owner           types.WorkspaceOwner
	Logger          *slog.Logger
	// TFVars will override any variables set in '.tfvars' files.
	// The value set must be a cty.Value, as the type can be anything.
	TFVars map[string]cty.Value
}

func (Input) RichParameterValue

func (i Input) RichParameterValue(key string) (string, bool)

type Output

type Output struct {
	// ModuleOutput is any 'output' values from the terraform files. This has 0
	// effect on the parameters, tags, etc. It can be helpful for debugging, as it
	// allows exporting some terraform values to the caller to review.
	//
	// JSON marshalling is handled in the custom methods.
	ModuleOutput cty.Value `json:"-"`

	Parameters    []types.Parameter `json:"parameters"`
	WorkspaceTags types.TagBlocks   `json:"workspace_tags"`
	Presets       []types.Preset    `json:"presets"`
	// Files is included for printing diagnostics.
	// They can be marshalled, but not unmarshalled. This is a limitation
	// of the HCL library.
	Files map[string]*hcl.File `json:"-"`
}

func Preview

func Preview(ctx context.Context, input Input, dir fs.FS) (output *Output, diagnostics hcl.Diagnostics)

func (Output) MarshalJSON

func (o Output) MarshalJSON() ([]byte, error)

MarshalJSON includes the ModuleOutput and files in the JSON output. Output should never be unmarshalled. Marshalling to JSON is strictly useful for debugging information.