Skip to content

Fix swagger package migration targets #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReneWerner87 merged 1 commit into from
Dec 1, 2025
Merged

Fix swagger package migration targets #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions cmd/internal/migrations/v3/swagger_packages.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

const (
contribSwaggerOld = "github.com/gofiber/contrib/swagger"
contribSwaggerNew = "github.com/gofiber/contrib/v3/swaggo"
contribSwaggerNew = "github.com/gofiber/contrib/v3/swaggerui"
fiberSwaggerOld = "github.com/gofiber/swagger"
fiberSwaggerNew = "github.com/gofiber/contrib/v3/swaggerui"
fiberSwaggerNew = "github.com/gofiber/contrib/v3/swaggo"
goModVersionPattern = `v[a-zA-Z0-9.+-]+`
)

Expand Down Expand Up @@ -81,31 +81,31 @@ func migrateSwaggerModules(cwd string) (bool, error) {
}
content := string(b)

needsSwaggo := strings.Contains(content, contribSwaggerOld) || strings.Contains(content, contribSwaggerNew)
needsSwaggerUI := strings.Contains(content, fiberSwaggerOld) || strings.Contains(content, fiberSwaggerNew)
needsSwaggerUI := strings.Contains(content, contribSwaggerOld) || strings.Contains(content, contribSwaggerNew)
needsSwaggo := strings.Contains(content, fiberSwaggerOld) || strings.Contains(content, fiberSwaggerNew)
if !needsSwaggo && !needsSwaggerUI {
return nil
}

if needsSwaggo && swaggoVersion == "" {
swaggoVersion, err = contribV3Version("swaggo")
if err != nil {
return fmt.Errorf("fetch swaggo version: %w", err)
}
}
if needsSwaggerUI && swaggerUIVersion == "" {
swaggerUIVersion, err = contribV3Version("swaggerui")
if err != nil {
return fmt.Errorf("fetch swaggerui version: %w", err)
}
}
if needsSwaggo && swaggoVersion == "" {
swaggoVersion, err = contribV3Version("swaggo")
if err != nil {
return fmt.Errorf("fetch swaggo version: %w", err)
}
}

updated := content
if needsSwaggo {
updated = updateGoModModule(updated, contribSwaggerOld, contribSwaggerNew, swaggoVersion)
}
if needsSwaggerUI {
updated = updateGoModModule(updated, fiberSwaggerOld, fiberSwaggerNew, swaggerUIVersion)
updated = updateGoModModule(updated, contribSwaggerOld, contribSwaggerNew, swaggerUIVersion)
}
if needsSwaggo {
updated = updateGoModModule(updated, fiberSwaggerOld, fiberSwaggerNew, swaggoVersion)
}

if updated == content {
Expand Down
18 changes: 9 additions & 9 deletions cmd/internal/migrations/v3/swagger_packages_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ func Test_MigrateSwaggerPackages(t *testing.T) {
restore := v3.SetContribV3VersionFetcher(func(module string) (string, error) {
switch module {
case swaggoModule:
return "v3.0.1", nil
case swaggerUIModule:
return "v3.1.0", nil
case swaggerUIModule:
return "v3.0.1", nil
Comment thread
ReneWerner87 marked this conversation as resolved.
default:
return "", fmt.Errorf("unexpected module %s", module)
}
Expand Down Expand Up @@ -54,11 +54,11 @@ replace github.com/gofiber/contrib/swagger => ../local`
require.NoError(t, v3.MigrateSwaggerPackages(cmd, dir, nil, nil))

content := readFile(t, file)
assert.Contains(t, content, `swagger "github.com/gofiber/contrib/v3/swaggo"`)
assert.Contains(t, content, `swagger "github.com/gofiber/contrib/v3/swaggerui"`)

mod := readFile(t, filepath.Join(dir, "go.mod"))
assert.Contains(t, mod, "github.com/gofiber/contrib/v3/swaggo v3.0.1")
assert.Contains(t, mod, "replace github.com/gofiber/contrib/v3/swaggo => ../local")
assert.Contains(t, mod, "github.com/gofiber/contrib/v3/swaggerui v3.0.1")
assert.Contains(t, mod, "replace github.com/gofiber/contrib/v3/swaggerui => ../local")

assert.Contains(t, buf.String(), "Migrating swagger packages")
}
Expand All @@ -67,9 +67,9 @@ func Test_MigrateSwaggerPackages_FiberSwagger(t *testing.T) {
restore := v3.SetContribV3VersionFetcher(func(module string) (string, error) {
switch module {
case swaggoModule:
return "v3.0.0", nil
case swaggerUIModule:
return "v3.2.0", nil
case swaggerUIModule:
return "v3.0.0", nil
Comment thread
ReneWerner87 marked this conversation as resolved.
default:
return "", fmt.Errorf("unexpected module %s", module)
}
Expand Down Expand Up @@ -101,10 +101,10 @@ require github.com/gofiber/swagger v1.1.0
require.NoError(t, v3.MigrateSwaggerPackages(cmd, dir, nil, nil))

content := readFile(t, file)
assert.Contains(t, content, `swagger "github.com/gofiber/contrib/v3/swaggerui"`)
assert.Contains(t, content, `swagger "github.com/gofiber/contrib/v3/swaggo"`)

mod := readFile(t, filepath.Join(dir, "go.mod"))
assert.Contains(t, mod, "github.com/gofiber/contrib/v3/swaggerui v3.2.0")
assert.Contains(t, mod, "github.com/gofiber/contrib/v3/swaggo v3.2.0")

assert.Contains(t, buf.String(), "Migrating swagger packages")
}
Expand Down
Loading