add -update flag to update goldens

Emyrk · Emyrk · commit 72d87887f8cf · 2024-04-11T15:57:58.000-05:00
diff --git a/scripts/apitypings/main_test.go b/scripts/apitypings/main_test.go
@@ -7,7 +7,7 @@
 package main
 
 import (
-	"fmt"
+	"flag"
 	"os"
 	"path/filepath"
 	"strings"
@@ -16,6 +16,9 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+// updateGoldenFiles is a flag that can be set to update golden files.
+var updateGoldenFiles = flag.Bool("update", false, "Update golden files")
+
 func TestGeneration(t *testing.T) {
 	t.Parallel()
 	files, err := os.ReadDir("testdata")
@@ -38,8 +41,12 @@ func TestGeneration(t *testing.T) {
 			require.NoErrorf(t, err, "read file %s", golden)
 			expectedString := strings.TrimSpace(string(expected))
 			output = strings.TrimSpace(output)
-			fmt.Println(string(output))
-			require.Equal(t, expectedString, output, "matched output")
+			if *updateGoldenFiles {
+				err := os.WriteFile(golden, []byte(output), 0644)
+				require.NoError(t, err, "write golden file")
+			} else {
+				require.Equal(t, expectedString, output, "matched output")
+			}
 		})
 	}
 }
diff --git a/scripts/apitypings/testdata/enums/enums.go b/scripts/apitypings/testdata/enums/enums.go
@@ -1,8 +1,8 @@
 package codersdk
 
 type (
-	Enum  string
-	Enums []Enum
+	Enum          string
+	EnumSliceType []Enum
 )
 
 const (
diff --git a/scripts/apitypings/testdata/enums/enums.ts b/scripts/apitypings/testdata/enums/enums.ts
@@ -1,5 +1,5 @@
 // From codersdk/enums.go
-export type Enums = readonly Enum[]
+export type EnumSliceType = (readonly Enum[])
 
 // From codersdk/enums.go
 export type Enum = "bar" | "baz" | "foo" | "qux"
diff --git a/scripts/apitypings/testdata/genericmap/genericmap.go b/scripts/apitypings/testdata/genericmap/genericmap.go
@@ -1,22 +1,22 @@
 package codersdk
 
-type Foo struct {
-	Bar string `json:"bar"`
-}
-
 type Buzz struct {
 	Foo  `json:"foo"`
 	Bazz string `json:"bazz"`
 }
 
-type Custom interface {
-	Foo | Buzz
+type Foo struct {
+	Bar string `json:"bar"`
 }
 
 type FooBuzz[R Custom] struct {
 	Something []R `json:"something"`
 }
 
+type Custom interface {
+	Foo | Buzz
+}
+
 // Not yet supported
 //type FooBuzzMap[R Custom] struct {
 //	Something map[string]R `json:"something"`
diff --git a/scripts/apitypings/testdata/genericmap/genericmap.ts b/scripts/apitypings/testdata/genericmap/genericmap.ts
@@ -11,8 +11,8 @@ export interface Foo {
 
 // From codersdk/genericmap.go
 export interface FooBuzz<R extends Custom> {
-  readonly something: readonly R[]
+  readonly something: (readonly R[])
 }
 
 // From codersdk/genericmap.go
-export type Custom = Foo | Buzz
+export type Custom = Foo | Buzz
diff --git a/scripts/apitypings/testdata/generics/generics.ts b/scripts/apitypings/testdata/generics/generics.ts
@@ -33,9 +33,9 @@ export interface Static {
 }
 
 // From codersdk/generics.go
-export type Custom = string | boolean | number | readonly string[] | null
+export type Custom = string | boolean | number | (readonly string[]) | null
 
 // From codersdk/generics.go
 export type Single = string
 
-export type comparable = boolean | number | string | any
+export type comparable = boolean | number | string | any
diff --git a/scripts/apitypings/testdata/genericslice/genericslice.ts b/scripts/apitypings/testdata/genericslice/genericslice.ts
@@ -1,10 +1,10 @@
 // From codersdk/genericslice.go
 export interface Bar {
-	readonly Bar: string
+  readonly Bar: string
 }
 
 // From codersdk/genericslice.go
 export interface Foo<R extends any> {
-	readonly Slice: readonly R[]
-	readonly TwoD: readonly (readonly R[])[]
-}
+  readonly Slice: (readonly R[])
+  readonly TwoD: (readonly (readonly R[])[])
+}

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`package codersdk`
`2`	`2`
`3`	`3`	`type (`
`4`		`- Enum string`
`5`		`- Enums []Enum`
	`4`	`+ Enum string`
	`5`	`+ EnumSliceType []Enum`
`6`	`6`	`)`
`7`	`7`
`8`	`8`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ export interface Foo {`
`11`	`11`
`12`	`12`	`// From codersdk/genericmap.go`
`13`	`13`	`export interface FooBuzz<R extends Custom> {`
`14`		`- readonly something: readonly R[]`
	`14`	`+ readonly something: (readonly R[])`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`// From codersdk/genericmap.go`
`18`		`-export type Custom = Foo \| Buzz`
	`18`	`+export type Custom = Foo \| Buzz`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,9 @@ export interface Static {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`// From codersdk/generics.go`
`36`		`-export type Custom = string \| boolean \| number \| readonly string[] \| null`
	`36`	`+export type Custom = string \| boolean \| number \| (readonly string[]) \| null`
`37`	`37`
`38`	`38`	`// From codersdk/generics.go`
`39`	`39`	`export type Single = string`
`40`	`40`
`41`		`-export type comparable = boolean \| number \| string \| any`
	`41`	`+export type comparable = boolean \| number \| string \| any`