Skip to content

Commit 4ba4208

Browse files
dbanckdbanck
committed
features: Add feature for modules
This moves all logic related to module files into a feature. The feature contains all state, jobs, hooks, and decoder related files.
1 parent 104a979 commit 4ba4208

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+6646
-0
lines changed

‎internal/features/modules/ast/module.go

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
4+
package ast
5+
6+
import (
7+
"strings"
8+
9+
"github.com/hashicorp/hcl/v2"
10+
globalAst "github.com/hashicorp/terraform-ls/internal/terraform/ast"
11+
)
12+
13+
type ModFilename string
14+
15+
func (mf ModFilename) String() string {
16+
return string(mf)
17+
}
18+
19+
func (mf ModFilename) IsJSON() bool {
20+
return strings.HasSuffix(string(mf), ".json")
21+
}
22+
23+
func (mf ModFilename) IsIgnored() bool {
24+
return globalAst.IsIgnoredFile(string(mf))
25+
}
26+
27+
func IsModuleFilename(name string) bool {
28+
return strings.HasSuffix(name, ".tf") ||
29+
strings.HasSuffix(name, ".tf.json")
30+
}
31+
32+
type ModFiles map[ModFilename]*hcl.File
33+
34+
func ModFilesFromMap(m map[string]*hcl.File) ModFiles {
35+
mf := make(ModFiles, len(m))
36+
for name, file := range m {
37+
mf[ModFilename(name)] = file
38+
}
39+
return mf
40+
}
41+
42+
func (mf ModFiles) AsMap() map[string]*hcl.File {
43+
m := make(map[string]*hcl.File, len(mf))
44+
for name, file := range mf {
45+
m[string(name)] = file
46+
}
47+
return m
48+
}
49+
50+
func (mf ModFiles) Copy() ModFiles {
51+
m := make(ModFiles, len(mf))
52+
for name, file := range mf {
53+
m[name] = file
54+
}
55+
return m
56+
}
57+
58+
type ModDiags map[ModFilename]hcl.Diagnostics
59+
60+
func ModDiagsFromMap(m map[string]hcl.Diagnostics) ModDiags {
61+
mf := make(ModDiags, len(m))
62+
for name, file := range m {
63+
mf[ModFilename(name)] = file
64+
}
65+
return mf
66+
}
67+
68+
func (md ModDiags) AutoloadedOnly() ModDiags {
69+
diags := make(ModDiags)
70+
for name, f := range md {
71+
if !name.IsIgnored() {
72+
diags[name] = f
73+
}
74+
}
75+
return diags
76+
}
77+
78+
func (md ModDiags) AsMap() map[string]hcl.Diagnostics {
79+
m := make(map[string]hcl.Diagnostics, len(md))
80+
for name, diags := range md {
81+
m[string(name)] = diags
82+
}
83+
return m
84+
}
85+
86+
func (md ModDiags) Copy() ModDiags {
87+
m := make(ModDiags, len(md))
88+
for name, diags := range md {
89+
m[name] = diags
90+
}
91+
return m
92+
}
93+
94+
func (md ModDiags) Count() int {
95+
count := 0
96+
for _, diags := range md {
97+
count += len(diags)
98+
}
99+
return count
100+
}
101+
102+
type SourceModDiags map[globalAst.DiagnosticSource]ModDiags
103+
104+
func (smd SourceModDiags) Count() int {
105+
count := 0
106+
for _, diags := range smd {
107+
count += diags.Count()
108+
}
109+
return count
110+
}

‎internal/features/modules/ast/module_test.go

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
4+
package ast
5+
6+
import (
7+
"testing"
8+
9+
"github.com/google/go-cmp/cmp"
10+
"github.com/hashicorp/hcl/v2"
11+
"github.com/zclconf/go-cty-debug/ctydebug"
12+
)
13+
14+
func TestModuleDiags_autoloadedOnly(t *testing.T) {
15+
md := ModDiagsFromMap(map[string]hcl.Diagnostics{
16+
"alpha.tf": {},
17+
"beta.tf": {
18+
{
19+
Severity: hcl.DiagError,
20+
Summary: "Test error",
21+
Detail: "Test description",
22+
},
23+
},
24+
".hidden.tf": {},
25+
})
26+
diags := md.AutoloadedOnly().AsMap()
27+
expectedDiags := map[string]hcl.Diagnostics{
28+
"alpha.tf": {},
29+
"beta.tf": {
30+
{
31+
Severity: hcl.DiagError,
32+
Summary: "Test error",
33+
Detail: "Test description",
34+
},
35+
},
36+
}
37+
38+
if diff := cmp.Diff(expectedDiags, diags, ctydebug.CmpOptions); diff != "" {
39+
t.Fatalf("unexpected diagnostics: %s", diff)
40+
}
41+
}

‎internal/features/modules/decoder/decoder_test.go

+179
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
4+
package decoder_test
5+
6+
import (
7+
"bytes"
8+
"compress/gzip"
9+
"context"
10+
"io"
11+
"io/fs"
12+
"log"
13+
"path"
14+
"path/filepath"
15+
"sync"
16+
"testing"
17+
"testing/fstest"
18+
19+
"github.com/hashicorp/go-version"
20+
"github.com/hashicorp/hcl-lang/decoder"
21+
"github.com/hashicorp/hcl-lang/lang"
22+
lsctx "github.com/hashicorp/terraform-ls/internal/context"
23+
fdecoder "github.com/hashicorp/terraform-ls/internal/features/modules/decoder"
24+
"github.com/hashicorp/terraform-ls/internal/features/modules/jobs"
25+
"github.com/hashicorp/terraform-ls/internal/features/modules/state"
26+
globalState "github.com/hashicorp/terraform-ls/internal/state"
27+
tfmod "github.com/hashicorp/terraform-schema/module"
28+
)
29+
30+
type RootReaderMock struct{}
31+
32+
func (r RootReaderMock) InstalledModuleCalls(modPath string) (map[string]tfmod.InstalledModuleCall, error) {
33+
return nil, nil
34+
}
35+
36+
func (r RootReaderMock) TerraformVersion(modPath string) *version.Version {
37+
return nil
38+
}
39+
40+
func TestDecoder_CodeLensesForFile_concurrencyBug(t *testing.T) {
41+
globalStore, err := globalState.NewStateStore()
42+
if err != nil {
43+
t.Fatal(err)
44+
}
45+
ss, err := state.NewModuleStore(globalStore.ProviderSchemas, globalStore.RegistryModules, globalStore.ChangeStore)
46+
if err != nil {
47+
t.Fatal(err)
48+
}
49+
50+
logger := log.New(io.Discard, "", 0)
51+
testCfg := `data "terraform_remote_state" "vpc" { }
52+
`
53+
dirNames := []string{"testdir1", "testdir2"}
54+
55+
mapFs := fstest.MapFS{}
56+
for _, dirName := range dirNames {
57+
mapFs[dirName] = &fstest.MapFile{Mode: fs.ModeDir}
58+
mapFs[path.Join(dirName, "main.tf")] = &fstest.MapFile{Data: []byte(testCfg)}
59+
mapFs[filepath.Join(dirName, "main.tf")] = &fstest.MapFile{Data: []byte(testCfg)}
60+
}
61+
62+
ctx := context.Background()
63+
64+
dataDir := "data"
65+
schemasFs := fstest.MapFS{
66+
dataDir: &fstest.MapFile{Mode: fs.ModeDir},
67+
dataDir + "/terraform.io": &fstest.MapFile{Mode: fs.ModeDir},
68+
dataDir + "/terraform.io/builtin": &fstest.MapFile{Mode: fs.ModeDir},
69+
dataDir + "/terraform.io/builtin/terraform": &fstest.MapFile{Mode: fs.ModeDir},
70+
dataDir + "/terraform.io/builtin/terraform/1.0.0": &fstest.MapFile{Mode: fs.ModeDir},
71+
dataDir + "/terraform.io/builtin/terraform/1.0.0/schema.json.gz": &fstest.MapFile{
72+
Data: gzipCompressBytes(t, []byte(tfSchemaJSON)),
73+
},
74+
}
75+
76+
for _, dirName := range dirNames {
77+
err := ss.Add(dirName)
78+
if err != nil {
79+
t.Error(err)
80+
}
81+
ctx = lsctx.WithDocumentContext(ctx, lsctx.Document{})
82+
err = jobs.ParseModuleConfiguration(ctx, mapFs, ss, dirName)
83+
if err != nil {
84+
t.Error(err)
85+
}
86+
err = jobs.LoadModuleMetadata(ctx, ss, dirName)
87+
if err != nil {
88+
t.Error(err)
89+
}
90+
err = jobs.PreloadEmbeddedSchema(ctx, logger, schemasFs, ss, globalStore.ProviderSchemas, dirName)
91+
if err != nil {
92+
t.Error(err)
93+
}
94+
}
95+
96+
d := decoder.NewDecoder(&fdecoder.PathReader{
97+
StateReader: ss,
98+
RootReader: RootReaderMock{},
99+
})
100+
101+
var wg sync.WaitGroup
102+
for _, dirName := range dirNames {
103+
dirName := dirName
104+
wg.Add(1)
105+
go func(t *testing.T) {
106+
defer wg.Done()
107+
_, err := d.CodeLensesForFile(ctx, lang.Path{
108+
Path: dirName,
109+
LanguageID: "terraform",
110+
}, "main.tf")
111+
if err != nil {
112+
t.Error(err)
113+
}
114+
}(t)
115+
}
116+
wg.Wait()
117+
}
118+
119+
func gzipCompressBytes(t *testing.T, b []byte) []byte {
120+
var compressedBytes bytes.Buffer
121+
gw := gzip.NewWriter(&compressedBytes)
122+
_, err := gw.Write(b)
123+
if err != nil {
124+
t.Fatal(err)
125+
}
126+
err = gw.Close()
127+
if err != nil {
128+
t.Fatal(err)
129+
}
130+
return compressedBytes.Bytes()
131+
}
132+
133+
var tfSchemaJSON = `{
134+
"format_version": "1.0",
135+
"provider_schemas": {
136+
"terraform.io/builtin/terraform": {
137+
"data_source_schemas": {
138+
"terraform_remote_state": {
139+
"version": 0,
140+
"block": {
141+
"attributes": {
142+
"backend": {
143+
"type": "string",
144+
"description": "The remote backend to use, e.g. remote or http.",
145+
"description_kind": "markdown",
146+
"required": true
147+
},
148+
"config": {
149+
"type": "dynamic",
150+
"description": "The configuration of the remote backend. Although this is optional, most backends require some configuration.\n\nThe object can use any arguments that would be valid in the equivalent terraform { backend \"\u003cTYPE\u003e\" { ... } } block.",
151+
"description_kind": "markdown",
152+
"optional": true
153+
},
154+
"defaults": {
155+
"type": "dynamic",
156+
"description": "Default values for outputs, in case the state file is empty or lacks a required output.",
157+
"description_kind": "markdown",
158+
"optional": true
159+
},
160+
"outputs": {
161+
"type": "dynamic",
162+
"description": "An object containing every root-level output in the remote state.",
163+
"description_kind": "markdown",
164+
"computed": true
165+
},
166+
"workspace": {
167+
"type": "string",
168+
"description": "The Terraform workspace to use, if the backend supports workspaces.",
169+
"description_kind": "markdown",
170+
"optional": true
171+
}
172+
},
173+
"description_kind": "plain"
174+
}
175+
}
176+
}
177+
}
178+
}
179+
}`

‎internal/features/modules/decoder/functions.go

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Copyright (c) HashiCorp, Inc.
2+
// SPDX-License-Identifier: MPL-2.0
3+
4+
package decoder
5+
6+
import (
7+
"github.com/hashicorp/go-version"
8+
"github.com/hashicorp/hcl-lang/schema"
9+
"github.com/hashicorp/terraform-ls/internal/features/modules/state"
10+
tfmodule "github.com/hashicorp/terraform-schema/module"
11+
tfschema "github.com/hashicorp/terraform-schema/schema"
12+
)
13+
14+
func functionsForModule(mod *state.ModuleRecord, stateReader CombinedReader) (map[string]schema.FunctionSignature, error) {
15+
resolvedVersion := tfschema.ResolveVersion(stateReader.TerraformVersion(mod.Path()), mod.Meta.CoreRequirements)
16+
sm := tfschema.NewFunctionsMerger(mustFunctionsForVersion(resolvedVersion))
17+
sm.SetTerraformVersion(resolvedVersion)
18+
sm.SetStateReader(stateReader)
19+
20+
meta := &tfmodule.Meta{
21+
Path: mod.Path(),
22+
ProviderRequirements: mod.Meta.ProviderRequirements,
23+
ProviderReferences: mod.Meta.ProviderReferences,
24+
}
25+
26+
return sm.FunctionsForModule(meta)
27+
}
28+
29+
func mustFunctionsForVersion(v *version.Version) map[string]schema.FunctionSignature {
30+
s, err := tfschema.FunctionsForVersion(v)
31+
if err != nil {
32+
// this should never happen
33+
panic(err)
34+
}
35+
return s
36+
}

0 commit comments

Comments
 (0)