Initial commit

Author: Emyrk

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/gotest.yml

@@ -0,0 +1,26 @@
+name: GoTests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test-go:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.22.8
+      - name: Install gotestsum
+        shell: bash
+        run: go install gotest.tools/gotestsum@latest
+      - name: Run tests
+        run: gotestsum ./...

.gitignore

@@ -0,0 +1 @@
+.idea

go.mod

@@ -0,0 +1,16 @@
+module github.com/coder/preview
+
+go 1.23.5
+
+require (
+	github.com/stretchr/testify v1.10.0
+	github.com/zclconf/go-cty v1.16.2
+)
+
+require (
+	github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	golang.org/x/text v0.11.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,18 @@
+github.com/apparentlymart/go-textseg/v15 v15.0.0 h1:uYvfpb3DyLSCGWnctWKGj857c6ew1u1fNQOlOtuGxQY=
+github.com/apparentlymart/go-textseg/v15 v15.0.0/go.mod h1:K8XmNZdhEBkdlyDdvbmmsvpAG721bKi0joRfFdHIWJ4=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-cmp v0.3.1 h1:Xye71clBPdm5HgqGwUkwhbynsUJZhDbS20FvLhQ2izg=
+github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/zclconf/go-cty v1.16.2 h1:LAJSwc3v81IRBZyUVQDUdZ7hs3SYs9jv0eZJDWHD/70=
+github.com/zclconf/go-cty v1.16.2/go.mod h1:VvMs5i0vgZdhYawQNq5kePSpLAoz8u1xvZgrPIxfnZE=
+golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4=
+golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

types/parameter.go

@@ -0,0 +1,68 @@
+package types
+
+import (
+	"crypto/sha256"
+	"encoding/json"
+	"fmt"
+
+	"github.com/zclconf/go-cty/cty"
+)
+
+type RichParameter struct {
+	Name         string                 `json:"name"`
+	Description  string                 `json:"description"`
+	Type         string                 `json:"type"`
+	Mutable      bool                   `json:"mutable"`
+	DefaultValue string                 `json:"default_value"`
+	Icon         string                 `json:"icon"`
+	Options      []*RichParameterOption `json:"options"`
+	Validation   *ParameterValidation   `json:"validation"`
+	Required     bool                   `json:"required"`
+	// legacy_variable_name was removed (= 14)
+	DisplayName string `json:"display_name"`
+	Order       int32  `json:"order"`
+	Ephemeral   bool   `json:"ephemeral"`
+}
+
+type ParameterValidation struct {
+	Regex     string `json:"validation_regex"`
+	Error     string `json:"validation_error"`
+	Min       *int32 `json:"validation_min"`
+	Max       *int32 `json:"validation_max"`
+	Monotonic string `json:"validation_monotonic"`
+}
+
+type RichParameterOption struct {
+	Name        string `json:"name,omitempty"`
+	Description string `json:"description,omitempty"`
+	Value       string `json:"value,omitempty"`
+	Icon        string `json:"icon,omitempty"`
+}
+
+// Hash can be used to compare two RichParameter objects at a glance.
+func (r *RichParameter) Hash() ([32]byte, error) {
+	// Option order matters, so just json marshal the whole thing.
+	data, err := json.Marshal(r)
+	if err != nil {
+		return [32]byte{}, fmt.Errorf("marshal: %w", err)
+	}
+
+	return sha256.Sum256(data), nil
+}
+
+// CtyType returns the cty.Type for the RichParameter.
+// A fixed set of types are supported.
+func (r *RichParameter) CtyType() (cty.Type, error) {
+	switch r.Type {
+	case "string":
+		return cty.String, nil
+	case "number":
+		return cty.Number, nil
+	case "bool":
+		return cty.Bool, nil
+	case "list(string)":
+		return cty.List(cty.String), nil
+	default:
+		return cty.Type{}, fmt.Errorf("unsupported type: %q", r.Type)
+	}
+}

types/parameter_test.go

@@ -0,0 +1,142 @@
+package types_test
+
+import (
+	"crypto/sha256"
+	"fmt"
+	"math/rand/v2"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/coder/preview/types"
+)
+
+// TestParameterEquality might be a bit pointless. It just ensures the
+// Hash function returns a consistent value for the same input.
+// TODO: Remove this, just wanted to create some random parameters
+func TestParameterEquality(t *testing.T) {
+	t.Parallel()
+
+	for i := 0; i < 100; i++ {
+		t.Run(fmt.Sprintf("EqualityCheck_%d", i), func(t *testing.T) {
+			t.Parallel()
+			seed := sha256.Sum256([]byte(t.Name()))
+			src := rand.NewChaCha8(seed)
+
+			param := randomParameter(src)
+			a, err := param.Hash()
+			require.NoError(t, err)
+
+			b, err := param.Hash()
+			require.NoError(t, err)
+
+			require.Equal(t, a, b)
+		})
+	}
+}
+
+func randomParameter(src *rand.ChaCha8) *types.RichParameter {
+	ty := randomElement(src, "string", "number", "bool", "list(string)")
+	opts := make([]*types.RichParameterOption, randomInt(src, 0, 5))
+	for i := range opts {
+		opts[i] = randomParameterOption(src, ty)
+	}
+
+	return &types.RichParameter{
+		Name:         randomString(src, 20),
+		Description:  randomString(src, 20),
+		Type:         ty,
+		Mutable:      randomElement(src, true, false),
+		DefaultValue: randomValue(src, ty),
+		Icon:         randomString(src, 10),
+		Options:      opts,
+		Validation:   randomValidation(src, ty),
+		Required:     randomElement(src, true, false),
+		DisplayName:  randomString(src, 10),
+		Order:        int32(randomInt(src, 0, 10)),
+		Ephemeral:    randomElement(src, true, false),
+	}
+}
+
+func randomValidation(src *rand.ChaCha8, ty string) *types.ParameterValidation {
+	var minVal, maxVal *int32
+	mono := ""
+	if ty == "number" {
+		mv := int32(randomInt(src, 0, 10))
+		mxv := int32(randomInt(src, uint64(mv), uint64(10+mv)))
+		minVal = &mv
+		maxVal = &mxv
+		mono = randomElement(src, "", "increasing", "decreasing")
+	}
+
+	return &types.ParameterValidation{
+		Regex:     randomString(src, 10),
+		Error:     randomString(src, 10),
+		Min:       minVal,
+		Max:       maxVal,
+		Monotonic: mono,
+	}
+}
+
+func randomParameterOption(src *rand.ChaCha8, ty string) *types.RichParameterOption {
+	return &types.RichParameterOption{
+		Name:        randomString(src, 10),
+		Description: randomString(src, 20),
+		Value:       randomValue(src, ty),
+		Icon:        randomString(src, 10),
+	}
+}
+
+func randomValue(src *rand.ChaCha8, ty string) string {
+	switch ty {
+	case "string":
+		return randomString(src, 20)
+	case "number":
+		return fmt.Sprintf("%d", randomInt(src, 0, 100))
+	case "bool":
+		return fmt.Sprintf("%t", randomElement(src, true, false))
+	case "list(string)":
+		elems := make([]string, randomInt(src, 0, 5))
+		for i := range elems {
+			elems[i] = fmt.Sprintf("%q", randomString(src, 7))
+		}
+		return fmt.Sprintf("[%s]", strings.Join(elems, ", "))
+	}
+	panic(fmt.Sprintf("unsupported type: %s", ty))
+}
+
+func randomInt(src *rand.ChaCha8, min, max uint64) int64 {
+	v := src.Uint64() % max
+	return int64(v) + int64(min)
+}
+
+func randomElement[T any](src *rand.ChaCha8, elements ...T) T {
+	if len(elements) > 255 {
+		panic(fmt.Sprintf("randomElement only supports 255 elements, got %d", len(elements)))
+	}
+	b := make([]byte, 1)
+	_, err := src.Read(b)
+	if err != nil {
+		panic(fmt.Errorf("rand.Read: %w", err))
+	}
+	return elements[int(b[0])%len(elements)]
+}
+
+func randomString(src *rand.ChaCha8, length int) string {
+	out := make([]byte, length)
+	_, err := src.Read(out)
+	if err != nil {
+		panic(fmt.Errorf("rand.Read: %w", err))
+	}
+
+	for i := range out {
+		out[i] = out[i] % (26 * 2)
+		if out[i] >= 26 {
+			out[i] += 'A' - 26 // subtract off the 0-26 lowercase
+		} else {
+			out[i] += 'a'
+		}
+	}
+	return string(out)
+}