chore(tests): add test case for x-go-type and -skip-optional-pointer

jamietanna · jamietanna · commit dee66f8dd812 · 2025-05-07T08:35:48.000+01:00
As part of future changes, we'll be modifying the way this works, so we
should capture the current behaviour.
diff --git a/internal/test/go.mod b/internal/test/go.mod
@@ -9,6 +9,7 @@ require (
 	github.com/gin-gonic/gin v1.9.1
 	github.com/go-chi/chi/v5 v5.0.10
 	github.com/gofiber/fiber/v2 v2.49.1
+	github.com/google/uuid v1.4.0
 	github.com/gorilla/mux v1.8.1
 	github.com/kataras/iris/v12 v12.2.6-0.20230908161203-24ba4e8933b9
 	github.com/labstack/echo/v4 v4.11.3
@@ -47,7 +48,6 @@ require (
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/gomarkdown/markdown v0.0.0-20230716120725-531d2d74bc12 // indirect
-	github.com/google/uuid v1.4.0 // indirect
 	github.com/gorilla/css v1.0.0 // indirect
 	github.com/invopop/yaml v0.3.1 // indirect
 	github.com/iris-contrib/schema v0.0.6 // indirect
diff --git a/internal/test/issues/issue1957/config.yaml b/internal/test/issues/issue1957/config.yaml
@@ -0,0 +1,6 @@
+package: issue1957
+generate:
+  models: true
+output: issue1957.gen.go
+output-options:
+  skip-prune: true
diff --git a/internal/test/issues/issue1957/generate.go b/internal/test/issues/issue1957/generate.go
@@ -0,0 +1,3 @@
+package issue1957
+
+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml openapi.yaml
diff --git a/internal/test/issues/issue1957/issue1957.gen.go b/internal/test/issues/issue1957/issue1957.gen.go
diff --git a/internal/test/issues/issue1957/issue1957_test.go b/internal/test/issues/issue1957/issue1957_test.go
@@ -0,0 +1,58 @@
+package issue1957
+
+import (
+	"testing"
+
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/require"
+)
+
+func TestGeneratedCode(t *testing.T) {
+	t.Run("For an object", func(t *testing.T) {
+		t.Run("A required field should be a non-pointer", func(t *testing.T) {
+			theType := TypeWithOptionalField{
+				AtRequired: uuid.New(),
+			}
+
+			require.NotZero(t, theType.AtRequired)
+		})
+
+		t.Run("An optional field with x-go-type-skip-optional-pointer should be a non-pointer", func(t *testing.T) {
+			theType := TypeWithOptionalField{
+				AtRequired: uuid.New(),
+			}
+
+			require.NotZero(t, theType.AtRequired)
+		})
+	})
+
+	t.Run("For a query parameter", func(t *testing.T) {
+		// TODO that this is NOT wanted behaviour, but it is our current behaviour
+		t.Run("An optional field with x-go-type-skip-optional-pointer should be a pointer", func(t *testing.T) {
+
+			u := uuid.New()
+
+			theType := GetRootParams{
+				At: &u,
+			}
+
+			require.NotNil(t, theType.At)
+			require.NotZero(t, *theType.At)
+		})
+	})
+
+	t.Run("For a field with an AllOf", func(t *testing.T) {
+		// TODO that this is NOT wanted behaviour, but it is our current behaviour
+		t.Run("An optional field with x-go-type-skip-optional-pointer should be a pointer", func(t *testing.T) {
+
+			u := uuid.New()
+
+			theType := TypeWithAllOf{
+				Id: &u,
+			}
+
+			require.NotNil(t, theType.Id)
+			require.NotZero(t, *theType.Id)
+		})
+	})
+}
diff --git a/internal/test/issues/issue1957/openapi.yaml b/internal/test/issues/issue1957/openapi.yaml
@@ -0,0 +1,55 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: "x-go-type and x-go-type-skip-optional-pointer should be possible to use together"
+paths:
+  /root:
+    get:
+      operationId: getRoot
+      parameters:
+        - in: query
+          name: at
+          schema:
+            type: string
+            format: date-time
+            x-go-type-skip-optional-pointer: true
+            x-go-type: googleuuid.UUID
+            x-go-type-import:
+              path: github.com/google/uuid
+              name: googleuuid
+      responses:
+        "200":
+          description: Some data
+components:
+  schemas:
+    TypeWithOptionalField:
+      type: object
+      properties:
+        at:
+          type: string
+          x-go-type-skip-optional-pointer: true
+          x-go-type: googleuuid.UUID
+          x-go-type-import:
+            path: github.com/google/uuid
+            name: googleuuid
+        at_required:
+          type: string
+          x-go-type: googleuuid.UUID
+          x-go-type-import:
+            path: github.com/google/uuid
+            name: googleuuid
+      required:
+        - at_required
+    ID:
+      type: string
+      x-go-type: googleuuid.UUID
+      x-go-type-import:
+        path: github.com/google/uuid
+        name: googleuuid
+    TypeWithAllOf:
+      type: object
+      properties:
+        id:
+          allOf:
+            - $ref: '#/components/schemas/ID'
+            - x-go-type-skip-optional-pointer: true
diff --git a/internal/test/strict-server/stdhttp/go.sum b/internal/test/strict-server/stdhttp/go.sum
@@ -134,8 +134,8 @@ golang.org/x/sys v0.0.0-20210112080510-489259a85091/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.20.0 h1:Od9JTbYCk261bKm4M/mw7AklTlFYIa0bIp9BgSm1S8Y=
-golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
+golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package issue1957`
	`2`	`+`
	`3`	`+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml openapi.yaml`