Skip to content
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

Avoid completing static block inside a dynamic label #165

Merged
merged 3 commits into from
Nov 30, 2022
Merged

Avoid completing static block inside a dynamic label #165

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59b41cf
Add test case for label completion
dbanck Nov 25, 2022
ed6bd92
Only check block length if there is no dependent body
dbanck Nov 29, 2022
232fbe2
Turn else into else if
dbanck Nov 30, 2022
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
72 changes: 66 additions & 6 deletions decoder/body_extensions_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1695,6 +1695,7 @@ func TestCompletionAtPos_BodySchema_Extensions_DynamicBlock(t *testing.T) {
cfg string
pos hcl.Pos
expectedCandidates lang.Candidates
expectedErr string
}{
{
"dynamic block does not complete if not enabled",
Expand Down Expand Up @@ -1728,6 +1729,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
Byte: 77,
},
lang.CompleteCandidates([]lang.Candidate{}),
"",
},
{
"dynamic block does not complete without blocks",
Expand Down Expand Up @@ -1783,6 +1785,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
Kind: lang.AttributeCandidateKind,
},
}),
"",
},
{
"dynamic block completion",
Expand Down Expand Up @@ -1878,6 +1881,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
{
"dynamic block inner completion",
Expand Down Expand Up @@ -2001,6 +2005,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
{
"dynamic block content attribute completion",
Expand Down Expand Up @@ -2074,6 +2079,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
{
"dynamic block label only completes dependent blocks",
Expand Down Expand Up @@ -2136,6 +2142,52 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
{
"dynamic block label never completes static blocks",
&schema.BodySchema{
Blocks: map[string]*schema.BlockSchema{
"resource": {
Labels: []*schema.LabelSchema{
{
Name: "type",
IsDepKey: true,
Completable: true,
},
{Name: "name"},
},
Body: &schema.BodySchema{
Extensions: &schema.BodyExtensions{
DynamicBlocks: true,
},
Blocks: map[string]*schema.BlockSchema{
"lifecycle": {
Body: schema.NewBodySchema(),
},
},
},
DependentBody: map[schema.SchemaKey]*schema.BodySchema{
schema.NewSchemaKey(schema.DependencyKeys{
Labels: []schema.LabelDependent{
{Index: 0, Value: "aws_instance"},
},
}): {
Blocks: make(map[string]*schema.BlockSchema, 0),
},
},
},
},
},
`resource "aws_instance" "example" {
name = "example"
dynamic "" {

}
}`,
hcl.Pos{Line: 3, Column: 12, Byte: 66},
lang.CompleteCandidates([]lang.Candidate{}),
`test.tf (3,12): unknown block type "dynamic"`,
},
// completion nesting should work
{
Expand Down Expand Up @@ -2245,6 +2297,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
// completion after the thing =
{
Expand Down Expand Up @@ -2333,6 +2386,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
// check allows more than one dynamic
{
Expand Down Expand Up @@ -2409,6 +2463,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
// allows dynamic blocks in blocks
{
Expand Down Expand Up @@ -2496,6 +2551,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
// never complete dynamic as a dynamic label
{
Expand Down Expand Up @@ -2562,6 +2618,7 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
},
}),
"",
},
}

Expand All @@ -2576,14 +2633,17 @@ resource "aws_elastic_beanstalk_environment" "example" {
},
})

// We're triggering completion twice her, to cover any unintended side effects
_, err := d.CandidatesAtPos(ctx, "test.tf", tc.pos)
if err != nil {
t.Fatal(err)
}
candidates, err := d.CandidatesAtPos(ctx, "test.tf", tc.pos)

if err != nil {
t.Fatal(err)
if tc.expectedErr != "" && err.Error() != tc.expectedErr {
t.Fatalf("unexpected error: %q\nexpected: %q\n",
err, tc.expectedErr)
} else if tc.expectedErr == "" {
t.Fatal(err)
}
} else if tc.expectedErr != "" {
t.Fatalf("expected error: %q", tc.expectedErr)
}

if diff := cmp.Diff(tc.expectedCandidates, candidates); diff != "" {
Expand Down
8 changes: 4 additions & 4 deletions decoder/decoder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,6 @@ func mergeBlockBodySchemas(block *hcl.Block, blockSchema *schema.BlockSchema) (*
mergedSchema.ImpliedOrigins = make([]schema.ImpliedOrigin, 0)
}

if mergedSchema.Extensions != nil && mergedSchema.Extensions.DynamicBlocks && len(mergedSchema.Blocks) > 0 {
mergedSchema.Blocks["dynamic"] = buildDynamicBlockSchema(mergedSchema)
}

depSchema, _, ok := NewBlockSchema(blockSchema).DependentBodySchema(block)
if ok {
for name, attr := range depSchema.Attributes {
Expand Down Expand Up @@ -97,6 +93,10 @@ func mergeBlockBodySchemas(block *hcl.Block, blockSchema *schema.BlockSchema) (*
if depSchema.Extensions != nil {
mergedSchema.Extensions = depSchema.Extensions.Copy()
}
} else {
if mergedSchema.Extensions != nil && mergedSchema.Extensions.DynamicBlocks && len(mergedSchema.Blocks) > 0 {
mergedSchema.Blocks["dynamic"] = buildDynamicBlockSchema(mergedSchema)
}
dbanck marked this conversation as resolved.
Show resolved Hide resolved
}

return mergedSchema, nil
Expand Down