errors when installing latest v1 and v2 but only when tool present in tools.go file

[nathani-axis]

Hey,

I'm updating dependencies, and among them oapi-codegen in my project.
I have this issue both in the latest v1.16.2 and when updating to v2.0.0.

If I install the tool with these commands, it works:

go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@latest
go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.16.2
go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@latest
go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@v2.0.0

But if I install the tool with these commands, it fails:

go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen
go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen

this is the error:

# github.com/deepmap/oapi-codegen/pkg/codegen
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/codegen.go:231:53: cannot use spec.Components.Responses (variable of type openapi3.ResponseBodies) as openapi3.Re
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/codegen.go:403:54: cannot use swagger.Components.Responses (variable of type openapi3.ResponseBodies) as openapi3
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/codegen.go:564:29: invalid operation: cannot index responses (variable of type openapi3.Responses)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/filter.go:7:29: cannot use swagger.Paths (variable of type *openapi3.Paths) as openapi3.Paths value in argument t
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/filter.go:10:29: cannot use swagger.Paths (variable of type *openapi3.Paths) as openapi3.Paths value in argument 
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/filter.go:19:27: cannot range over paths (variable of type openapi3.Paths)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/operations.go:278:45: cannot use responses (variable of type *openapi3.Responses) as openapi3.Responses value in 
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/operations.go:280:27: invalid operation: cannot index responses (variable of type *openapi3.Responses)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/operations.go:539:46: cannot use swagger.Paths (variable of type *openapi3.Paths) as openapi3.Paths value in argu
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/operations.go:540:28: invalid operation: cannot index swagger.Paths (variable of type *openapi3.Paths)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen@v1.16.2/pkg/codegen/operations.go:540:28: too many errors

In the latter case, I have the following files in the project:

tools.go

//go:build tools
// +build tools

package tools

import (
	_ "github.com/deepmap/oapi-codegen/cmd/oapi-codegen"
}

go.mod

module foo

go 1.21

require (
	github.com/deepmap/oapi-codegen v1.16.2
	github.com/deepmap/v2/oapi-codegen v2.0.0 //one line or the other, not both, depending on the version
)

edit: I pressed enter too fast, here's more information. As I'm writing this I'm finding more things, I'll update this as I find more things. I was going to write that I can't reproduce in previous versions, but I'm already using v1.16.2 before, and it's working well before. Maybe there's some other dependency that's causing issues

[jamietanna]

Hey! So the thing that's probably causing you the issue here is that tools.go needs to update to the new module import path:

 //go:build tools
 // +build tools
 
 package tools
 
 import (
-	_ "github.com/deepmap/oapi-codegen/cmd/oapi-codegen"
+	_ "github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen"
 }

That should then allow you to upgrade to the v2 module in your go.mod

https://gitlab.com/tanna.dev/dependency-management-data/-/merge_requests/145 is an example on one of my own projects for the upgrade.

[totemcaf]

I'm having same issue. Similar dependencies, but I couldn't make it work with any version of kin-openapi.

I could run oapi-codegenfrom command line using the installed v2 of it.

Also if I tried to run oapi-codegen by means of go generate ./... using:

//go:generate go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen --config=dpa-api.dtos.cfg.yaml ../specs/dpa-api.v1.yaml

or

//go:generate oapi-codegen --config=dpa-api.dtos.cfg.yaml ../specs/dpa-api.v1.yaml

same problem.

I'll try to research a little more, but it is very annoying.

[totemcaf]

I could reproduce it:

tools.go:

//go:build tools
// +build tools

package tools

import (
	_ "github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen"
)

Running go mod tidy it completes dependencies (go.mod):

module testoapi

go 1.20

require (
	github.com/AltScore/gothic/v2 v2.5.0
	github.com/deepmap/oapi-codegen/v2 v2.0.0
	github.com/oapi-codegen/runtime v1.1.0
)

require (
	github.com/getkin/kin-openapi v0.118.0 // indirect
	github.com/go-openapi/jsonpointer v0.19.5 // indirect
	github.com/go-openapi/swag v0.19.5 // indirect
	github.com/google/uuid v1.5.0 // indirect
	github.com/invopop/yaml v0.1.0 // indirect
	github.com/josharian/intern v1.0.0 // indirect
	github.com/mailru/easyjson v0.7.7 // indirect
	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
	github.com/perimeterx/marshmallow v1.1.4 // indirect
	go.mongodb.org/mongo-driver v1.13.1 // indirect
	golang.org/x/mod v0.14.0 // indirect
	golang.org/x/text v0.14.0 // indirect
	golang.org/x/tools v0.16.1 // indirect
	gopkg.in/yaml.v2 v2.4.0 // indirect
	gopkg.in/yaml.v3 v3.0.1 // indirect
)

Having a source with:

//go:generate go run github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen --config=dtos.cfg.yaml ../specs/api.v1.yaml

I could run

go generate ./...

The I did:

$ go get github.com/getkin/kin-openapi

go: upgraded github.com/getkin/kin-openapi v0.118.0 => v0.122.0
go: upgraded github.com/go-openapi/jsonpointer v0.19.5 => v0.19.6
go: upgraded github.com/go-openapi/swag v0.19.5 => v0.22.4
go: upgraded github.com/invopop/yaml v0.1.0 => v0.2.0
go: upgraded github.com/perimeterx/marshmallow v1.1.4 => v1.1.5

I ran again the go generate and it broke with:

../../../../go/pkg/mod/github.com/getkin/kin-openapi@v0.122.0/openapi3/components.go:9:2: missing go.sum entry for module providing package github.com/go-openapi/jsonpointer (imported by github.com/getkin/kin-openapi/openapi3); to add:
        go get github.com/getkin/kin-openapi/openapi3@v0.122.0
../../../../go/pkg/mod/github.com/getkin/kin-openapi@v0.122.0/openapi3/marsh.go:8:2: missing go.sum entry for module providing package github.com/invopop/yaml (imported by github.com/getkin/kin-openapi/openapi3); to add:
        go get github.com/getkin/kin-openapi/openapi3@v0.122.0
../../../../go/pkg/mod/github.com/getkin/kin-openapi@v0.122.0/openapi3/refs.go:10:2: missing go.sum entry for module providing package github.com/perimeterx/marshmallow (imported by github.com/getkin/kin-openapi/openapi3); to add:
        go get github.com/getkin/kin-openapi/openapi3@v0.122.0
internal/app.go:5: running "go": exit status 1

I ran go mod tidy, run generate again:

# github.com/deepmap/oapi-codegen/v2/pkg/codegen
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/codegen.go:231:53: cannot use spec.Components.Responses (variable of type openapi3.ResponseBodies) as openapi3.Responses value in argument to GenerateResponseDefinitions
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/codegen.go:403:54: cannot use swagger.Components.Responses (variable of type openapi3.ResponseBodies) as openapi3.Responses value in argument to GenerateTypesForResponses
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/codegen.go:564:29: invalid operation: cannot index responses (variable of type openapi3.Responses)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/filter.go:7:29: cannot use swagger.Paths (variable of type *openapi3.Paths) as openapi3.Paths value in argument to excludeOperationsWithTags
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/filter.go:10:29: cannot use swagger.Paths (variable of type *openapi3.Paths) as openapi3.Paths value in argument to includeOperationsWithTags
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/filter.go:19:27: cannot range over paths (variable of type openapi3.Paths)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/operations.go:278:45: cannot use responses (variable of type *openapi3.Responses) as openapi3.Responses value in argument to SortedResponsesKeys
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/operations.go:280:27: invalid operation: cannot index responses (variable of type *openapi3.Responses)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/operations.go:539:46: cannot use swagger.Paths (variable of type *openapi3.Paths) as openapi3.Paths value in argument to SortedPathsKeys
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/operations.go:540:28: invalid operation: cannot index swagger.Paths (variable of type *openapi3.Paths)
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/operations.go:540:28: too many errors
internal/app.go:5: running "go": exit status 1

I reverted all versions of dependencies, except for kin-openapi, and it breaks with v0.122.0

With v0.121.0:

# github.com/deepmap/oapi-codegen/v2/pkg/codegen
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/codegen.go:231:53: cannot use spec.Components.Responses (variable of type openapi3.ResponseBodies) as openapi3.Responses value in argument to GenerateResponseDefinitions
../../../../go/pkg/mod/github.com/deepmap/oapi-codegen/v2@v2.0.0/pkg/codegen/codegen.go:403:54: cannot use swagger.Components.Responses (variable of type openapi3.ResponseBodies) as openapi3.Responses value in argument to GenerateTypesForResponses
internal/app.go:5: running "go": exit status 1

with v0.122.0 it works !!, culprit: v0.121.0

[jamietanna]

This may be resolved by #1364 then - if you pin to the latest commit in HEAD does that resolve it?

[totemcaf]

I added to my go.mod:

replace github.com/deepmap/oapi-codegen/v2 => github.com/deepmap/oapi-codegen/v2 v2.0.1-0.20231213133025-4ceb1d567792

and it worked like a charm !!!

Thanks