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,208 @@
|
||||
package templatebuilder
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"embed"
|
||||
"encoding/json"
|
||||
"io/fs"
|
||||
"path"
|
||||
"strings"
|
||||
"sync"
|
||||
"text/template"
|
||||
|
||||
"golang.org/x/xerrors"
|
||||
)
|
||||
|
||||
// BaseOS enumerates operating systems for base template filtering.
|
||||
type BaseOS string
|
||||
|
||||
const (
|
||||
BaseOSLinux BaseOS = "linux"
|
||||
)
|
||||
|
||||
// validBaseOS maps base.json os strings to their typed equivalents.
|
||||
var validBaseOS = map[string]BaseOS{
|
||||
"linux": BaseOSLinux,
|
||||
}
|
||||
|
||||
//go:embed bases
|
||||
var basesFS embed.FS
|
||||
|
||||
const basesDir = "bases"
|
||||
|
||||
// templateSuffix identifies Go template files that are pre-parsed at load time.
|
||||
// Terraform templatefile() inputs (.tftpl) are not Go templates and are left
|
||||
// as raw files in the embedded FS.
|
||||
const templateSuffix = ".tf.tmpl"
|
||||
|
||||
// BaseManifest is the on-disk schema for a base.json file.
|
||||
type BaseManifest struct {
|
||||
ID string `json:"id"`
|
||||
DisplayName string `json:"display_name"`
|
||||
OS string `json:"os"`
|
||||
DefaultContext BaseDefaultContext `json:"default_context"`
|
||||
}
|
||||
|
||||
// BaseDefaultContext holds default render values stored in base.json.
|
||||
type BaseDefaultContext struct {
|
||||
ContainerImage string `json:"container_image,omitempty"`
|
||||
}
|
||||
|
||||
// parsedBase holds the result of loading and pre-parsing a single base
|
||||
// template directory.
|
||||
type parsedBase struct {
|
||||
Manifest BaseManifest
|
||||
Templates map[string]*template.Template
|
||||
FS fs.FS
|
||||
}
|
||||
|
||||
var loadBases = sync.OnceValues(func() (map[string]*parsedBase, error) {
|
||||
return parseBasesFromFS(basesFS)
|
||||
})
|
||||
|
||||
// parseBasesFromFS reads and validates all base.json manifests and pre-parses
|
||||
// Go template files from the given filesystem. Most callers should use the
|
||||
// exported accessors, which read from the cached embedded catalog.
|
||||
func parseBasesFromFS(fsys fs.FS) (map[string]*parsedBase, error) {
|
||||
sub, err := fs.Sub(fsys, basesDir)
|
||||
if err != nil {
|
||||
return nil, xerrors.Errorf("open embedded base catalog: %w", err)
|
||||
}
|
||||
|
||||
dirs, err := fs.ReadDir(sub, ".")
|
||||
if err != nil {
|
||||
return nil, xerrors.Errorf("list base catalog entries: %w", err)
|
||||
}
|
||||
|
||||
bases := make(map[string]*parsedBase)
|
||||
for _, dir := range dirs {
|
||||
if !dir.IsDir() {
|
||||
continue
|
||||
}
|
||||
|
||||
manifestPath := path.Join(dir.Name(), "base.json")
|
||||
data, err := fs.ReadFile(sub, manifestPath)
|
||||
if err != nil {
|
||||
return nil, xerrors.Errorf("read %s: %w", manifestPath, err)
|
||||
}
|
||||
|
||||
var manifest BaseManifest
|
||||
dec := json.NewDecoder(bytes.NewReader(data))
|
||||
dec.DisallowUnknownFields()
|
||||
if err := dec.Decode(&manifest); err != nil {
|
||||
return nil, xerrors.Errorf("decode %s: %w", manifestPath, err)
|
||||
}
|
||||
|
||||
if manifest.ID == "" {
|
||||
return nil, xerrors.Errorf("base in %s has empty id", dir.Name())
|
||||
}
|
||||
if _, ok := validBaseOS[manifest.OS]; !ok && manifest.OS != "" {
|
||||
return nil, xerrors.Errorf("base %q has unknown os %q", manifest.ID, manifest.OS)
|
||||
}
|
||||
if bases[manifest.ID] != nil {
|
||||
return nil, xerrors.Errorf("duplicate base id %q", manifest.ID)
|
||||
}
|
||||
|
||||
baseFS, err := fs.Sub(sub, dir.Name())
|
||||
if err != nil {
|
||||
return nil, xerrors.Errorf("sub fs for %s: %w", dir.Name(), err)
|
||||
}
|
||||
|
||||
templates, err := parseTemplatesFromFS(baseFS)
|
||||
if err != nil {
|
||||
return nil, xerrors.Errorf("parse templates for base %q: %w", manifest.ID, err)
|
||||
}
|
||||
|
||||
bases[manifest.ID] = &parsedBase{
|
||||
Manifest: manifest,
|
||||
Templates: templates,
|
||||
FS: baseFS,
|
||||
}
|
||||
}
|
||||
|
||||
return bases, nil
|
||||
}
|
||||
|
||||
// parseTemplatesFromFS walks the filesystem and pre-parses all .tf.tmpl files
|
||||
// into Go templates. Returned keys are paths relative to the FS root.
|
||||
func parseTemplatesFromFS(fsys fs.FS) (map[string]*template.Template, error) {
|
||||
templates := make(map[string]*template.Template)
|
||||
|
||||
err := fs.WalkDir(fsys, ".", func(p string, d fs.DirEntry, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if d.IsDir() || !strings.HasSuffix(p, templateSuffix) {
|
||||
return nil
|
||||
}
|
||||
|
||||
raw, err := fs.ReadFile(fsys, p)
|
||||
if err != nil {
|
||||
return xerrors.Errorf("read %s: %w", p, err)
|
||||
}
|
||||
|
||||
tmpl, err := template.New(p).Parse(string(raw))
|
||||
if err != nil {
|
||||
return xerrors.Errorf("parse %s: %w", p, err)
|
||||
}
|
||||
|
||||
templates[p] = tmpl
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return templates, nil
|
||||
}
|
||||
|
||||
// BaseTemplateOS resolves the OS for a given example ID.
|
||||
// Returns empty string if the example is not a known base template.
|
||||
func BaseTemplateOS(exampleID string) BaseOS {
|
||||
bases, err := loadBases()
|
||||
if err != nil || bases[exampleID] == nil {
|
||||
return ""
|
||||
}
|
||||
return validBaseOS[bases[exampleID].Manifest.OS]
|
||||
}
|
||||
|
||||
// DefaultBaseRenderContext returns the render context that produces the
|
||||
// canonical default output for a base template.
|
||||
func DefaultBaseRenderContext(exampleID string) BaseRenderContext {
|
||||
bases, err := loadBases()
|
||||
if err != nil || bases[exampleID] == nil {
|
||||
return BaseRenderContext{}
|
||||
}
|
||||
dc := bases[exampleID].Manifest.DefaultContext
|
||||
return BaseRenderContext{
|
||||
ContainerImage: dc.ContainerImage,
|
||||
}
|
||||
}
|
||||
|
||||
// BaseTemplateIDs returns the set of known base template example IDs.
|
||||
func BaseTemplateIDs() []string {
|
||||
bases, err := loadBases()
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
ids := make([]string, 0, len(bases))
|
||||
for id := range bases {
|
||||
ids = append(ids, id)
|
||||
}
|
||||
return ids
|
||||
}
|
||||
|
||||
// BaseTemplateFS returns a filesystem rooted at the given base template
|
||||
// directory within the embedded bases catalog. Returns an error if
|
||||
// exampleID is not a known base template.
|
||||
func BaseTemplateFS(exampleID string) (fs.FS, error) {
|
||||
bases, err := loadBases()
|
||||
if err != nil {
|
||||
return nil, xerrors.Errorf("load base catalog: %w", err)
|
||||
}
|
||||
base, ok := bases[exampleID]
|
||||
if !ok {
|
||||
return nil, xerrors.Errorf("unknown base template %q", exampleID)
|
||||
}
|
||||
return base.FS, nil
|
||||
}
|
||||
Reference in New Issue
Block a user