Skip to content

feat: preserve original order of rich parameters #6747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 24, 2023
Merged

feat: preserve original order of rich parameters #6747

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1faf49d
WIP
mtojek Mar 22, 2023
39db601
Merge branch 'main' into 6362-order-real
mtojek Mar 23, 2023
d143e38
orderedParameters
mtojek Mar 23, 2023
e825450
fix
mtojek Mar 23, 2023
b794115
WIP
mtojek Mar 23, 2023
8bdbbd6
TestS
mtojek Mar 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
orderedParameters
  • Loading branch information
@mtojek
mtojek committed Mar 23, 2023
commit d143e38a65936b3db40535c3523976656fc14511
10 changes: 9 additions & 1 deletion provisioner/terraform/executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,15 @@ func (e *executor) planResources(ctx, killCtx context.Context, planfilePath stri
modules = append(modules, plan.PriorState.Values.RootModule)
}
modules = append(modules, plan.PlannedValues.RootModule)
return ConvertState(modules, rawGraph)
state, err := ConvertState(modules, rawGraph)
if err != nil {
return nil, err
}
state, err = orderResources(e.workdir, *state)
if err != nil {
return nil, xerrors.Errorf("order resources: %w", err)
}
return state, nil
}

// showPlan must only be called while the lock is held.
Expand Down
77 changes: 77 additions & 0 deletions provisioner/terraform/parameters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
package terraform

import (
"fmt"
"os"
"path"
"strings"

"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/hclparse"

"github.com/coder/coder/provisionersdk/proto"
)

var terraformWithCoderParametersSchema = &hcl.BodySchema{
Blocks: []hcl.BlockHeaderSchema{
{
Type: "data",
LabelNames: []string{"coder_parameter", "*"},
},
},
}

func orderResources(workdir string, state State) (*State, error) {
entries, err := os.ReadDir(workdir)
if err != nil {
return nil, err
}

var coderParameterNames []string
for _, entry := range entries {
if !strings.HasSuffix(entry.Name(), ".tf") {
continue
}
hclFilepath := path.Join(workdir, entry.Name())

parser := hclparse.NewParser()
parsedHCL, diags := parser.ParseHCLFile(hclFilepath)
if diags.HasErrors() {
return nil, hcl.Diagnostics{
{
Severity: hcl.DiagError,
Summary: "Failed to parse HCL file",
Detail: fmt.Sprintf("parser.ParseHCLFile can't parse %q file", hclFilepath),
},
}
}

content, _, _ := parsedHCL.Body.PartialContent(terraformWithCoderParametersSchema)
for _, block := range content.Blocks {
if block.Type == "data" && block.Labels[0] == "coder_parameter" && len(block.Labels) == 2 {
coderParameterNames = append(coderParameterNames, block.Labels[1])
}
}
}

if len(coderParameterNames) != len(state.Parameters) {
return &state, nil // Return the original state, parameters will be order alphabetically.
}

var orderedParameters []*proto.RichParameter
for _, coderParameterName := range coderParameterNames {
for _, p := range orderedParameters {
if p.Name != coderParameterName {
continue
}
orderedParameters = append(orderedParameters, p)
}
}

if len(orderedParameters) != len(state.Parameters) {
return &state, nil // Return the original state, most likely a parameter was placed twice.
}

state.Parameters = orderedParameters
return &state, nil
}