mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat(coderd/templatebuilder): add exampleID->OS map and base template .tf.tmpl files (#26115)
Add the bundled `exampleID -> OS` Go map for Docker, Kubernetes, and AWS
EC2 Linux base templates. Create `.tf.tmpl` Go template files for each
within `coderd/templatebuilder/bases/`, along with `BaseRenderContext`
and `RenderBaseTemplate` rendering helpers.
The `.tf.tmpl` files are independent copies of the example templates
with module blocks (code-server, jetbrains) removed, since the template
builder composes modules separately into `modules.tf`. When
`ImageOptions` is provided, the container image field references the
Terraform parameter; otherwise it uses the hardcoded value via Go
template whitespace control (`{{-`).
Golden file snapshot tests verify rendered output stability with an
`-update` flag for regeneration.
Depends on #25909
> [!NOTE]
> This PR was authored by Coder Agents on behalf of @jeremyruppel.
This commit is contained in:
@@ -0,0 +1,216 @@
|
||||
package templatebuilder
|
||||
|
||||
import (
|
||||
"testing"
|
||||
"testing/fstest"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestParseBasesFromFS(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
t.Run("ValidManifest", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/docker/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{
|
||||
"id": "docker",
|
||||
"display_name": "Docker",
|
||||
"os": "linux",
|
||||
"default_context": {
|
||||
"container_image": "codercom/enterprise-base:ubuntu"
|
||||
}
|
||||
}`),
|
||||
},
|
||||
"bases/docker/main.tf.tmpl": &fstest.MapFile{
|
||||
Data: []byte(`image = "{{ .ContainerImage }}"`),
|
||||
},
|
||||
}
|
||||
|
||||
bases, err := parseBasesFromFS(fsys)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, bases, 1)
|
||||
|
||||
b := bases["docker"]
|
||||
require.NotNil(t, b)
|
||||
require.Equal(t, "docker", b.Manifest.ID)
|
||||
require.Equal(t, "Docker", b.Manifest.DisplayName)
|
||||
require.Equal(t, "linux", b.Manifest.OS)
|
||||
require.Equal(t, "codercom/enterprise-base:ubuntu", b.Manifest.DefaultContext.ContainerImage)
|
||||
require.Contains(t, b.Templates, "main.tf.tmpl")
|
||||
})
|
||||
|
||||
t.Run("MultipleBases", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/alpha/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "alpha", "os": "linux"}`),
|
||||
},
|
||||
"bases/alpha/main.tf.tmpl": &fstest.MapFile{
|
||||
Data: []byte(`resource "alpha" {}`),
|
||||
},
|
||||
"bases/beta/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "beta", "os": "linux"}`),
|
||||
},
|
||||
"bases/beta/main.tf.tmpl": &fstest.MapFile{
|
||||
Data: []byte(`resource "beta" {}`),
|
||||
},
|
||||
}
|
||||
|
||||
bases, err := parseBasesFromFS(fsys)
|
||||
require.NoError(t, err)
|
||||
require.Len(t, bases, 2)
|
||||
require.NotNil(t, bases["alpha"])
|
||||
require.NotNil(t, bases["beta"])
|
||||
})
|
||||
|
||||
t.Run("EmptyCatalog", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/.keep": &fstest.MapFile{Data: []byte{}},
|
||||
}
|
||||
|
||||
bases, err := parseBasesFromFS(fsys)
|
||||
require.NoError(t, err)
|
||||
require.Empty(t, bases)
|
||||
})
|
||||
|
||||
t.Run("PreParsesTemplates", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/mybase/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "mybase", "os": "linux"}`),
|
||||
},
|
||||
"bases/mybase/main.tf.tmpl": &fstest.MapFile{
|
||||
Data: []byte(`image = "{{ .ContainerImage }}"`),
|
||||
},
|
||||
// .tftpl files are Terraform templatefile() inputs, not Go templates.
|
||||
"bases/mybase/cloud-init/config.yaml.tftpl": &fstest.MapFile{
|
||||
Data: []byte(`${some_terraform_var}`),
|
||||
},
|
||||
}
|
||||
|
||||
bases, err := parseBasesFromFS(fsys)
|
||||
require.NoError(t, err)
|
||||
|
||||
b := bases["mybase"]
|
||||
require.NotNil(t, b)
|
||||
require.Contains(t, b.Templates, "main.tf.tmpl")
|
||||
// .tftpl files should not be pre-parsed as Go templates.
|
||||
require.NotContains(t, b.Templates, "cloud-init/config.yaml.tftpl")
|
||||
})
|
||||
|
||||
t.Run("RejectsDirWithoutManifest", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/nobase/readme.txt": &fstest.MapFile{Data: []byte("hi")},
|
||||
}
|
||||
|
||||
_, err := parseBasesFromFS(fsys)
|
||||
require.ErrorContains(t, err, "read nobase/base.json")
|
||||
})
|
||||
|
||||
t.Run("RejectsEmptyID", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/bad/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "", "os": "linux"}`),
|
||||
},
|
||||
}
|
||||
|
||||
_, err := parseBasesFromFS(fsys)
|
||||
require.ErrorContains(t, err, "empty id")
|
||||
})
|
||||
|
||||
t.Run("RejectsDuplicateID", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/a/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "dupe", "os": "linux"}`),
|
||||
},
|
||||
"bases/b/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "dupe", "os": "linux"}`),
|
||||
},
|
||||
}
|
||||
|
||||
_, err := parseBasesFromFS(fsys)
|
||||
require.ErrorContains(t, err, "duplicate base id")
|
||||
})
|
||||
|
||||
t.Run("RejectsUnknownOS", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/bad/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "bad", "os": "beos"}`),
|
||||
},
|
||||
}
|
||||
|
||||
_, err := parseBasesFromFS(fsys)
|
||||
require.ErrorContains(t, err, `unknown os "beos"`)
|
||||
})
|
||||
|
||||
t.Run("RejectsUnknownField", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/bad/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "bad", "os": "linux", "dispaly_name": "typo"}`),
|
||||
},
|
||||
}
|
||||
|
||||
_, err := parseBasesFromFS(fsys)
|
||||
require.ErrorContains(t, err, "decode")
|
||||
})
|
||||
|
||||
t.Run("RejectsInvalidJSON", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/bad/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{not json`),
|
||||
},
|
||||
}
|
||||
|
||||
_, err := parseBasesFromFS(fsys)
|
||||
require.ErrorContains(t, err, "decode")
|
||||
})
|
||||
|
||||
t.Run("RejectsInvalidTemplate", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/bad/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "bad", "os": "linux"}`),
|
||||
},
|
||||
"bases/bad/main.tf.tmpl": &fstest.MapFile{
|
||||
Data: []byte(`{{ .Broken`),
|
||||
},
|
||||
}
|
||||
|
||||
_, err := parseBasesFromFS(fsys)
|
||||
require.ErrorContains(t, err, "parse templates")
|
||||
})
|
||||
|
||||
t.Run("AllowsEmptyOS", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
fsys := fstest.MapFS{
|
||||
"bases/nospec/base.json": &fstest.MapFile{
|
||||
Data: []byte(`{"id": "nospec"}`),
|
||||
},
|
||||
}
|
||||
|
||||
bases, err := parseBasesFromFS(fsys)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "", bases["nospec"].Manifest.OS)
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user