Files
dokku/plugins/registry/report.go
Jose Diaz-Gonzalez 3bf6c72451 fix: align Go-plugin :report JSON keys with bash-strip convention
Every Go-implemented plugin's `:report --format json` now emits keys without the redundant `<plugin>-` head segment, matching the shape bash plugins have always emitted. The CLI flag names and `:set` semantics are unchanged. For backwards compatibility during the 0.38.x patch series, the legacy `<plugin>-<property>` keys are emitted side-by-side with the new keys, and a future major release will drop the legacy keys. `common.ReportSingleApp` is refactored to accept a `ReportSingleAppInput` struct with a `Validate()` method so the input is checked before any work runs, which also catches the latent `"docker options"` reportType bug at the API boundary.
2026-05-27 07:17:00 -04:00

159 lines
5.0 KiB
Go

package registry
import (
"strings"
"github.com/dokku/dokku/plugins/common"
)
// ReportSingleApp is an internal function that displays the registry report for one or more apps
func ReportSingleApp(appName string, format string, infoFlag string) error {
if appName != "--global" {
if err := common.VerifyAppName(appName); err != nil {
return err
}
}
var flags map[string]common.ReportFunc
if appName == "--global" {
flags = map[string]common.ReportFunc{
"--registry-computed-push-on-release": reportComputedPushOnRelease,
"--registry-global-push-on-release": reportGlobalPushOnRelease,
"--registry-computed-server": reportComputedServer,
"--registry-global-server": reportGlobalServer,
"--registry-computed-image-repo-template": reportComputedImageRepoTemplate,
"--registry-global-image-repo-template": reportGlobalImageRepoTemplate,
"--registry-computed-push-extra-tags": reportComputedPushExtraTags,
"--registry-global-push-extra-tags": reportGlobalPushExtraTags,
}
} else {
flags = map[string]common.ReportFunc{
"--registry-computed-image-repo": reportComputedImageRepo,
"--registry-image-repo": reportImageRepo,
"--registry-computed-push-on-release": reportComputedPushOnRelease,
"--registry-global-push-on-release": reportGlobalPushOnRelease,
"--registry-push-on-release": reportPushOnRelease,
"--registry-computed-server": reportComputedServer,
"--registry-global-server": reportGlobalServer,
"--registry-computed-image-repo-template": reportComputedImageRepoTemplate,
"--registry-global-image-repo-template": reportGlobalImageRepoTemplate,
"--registry-image-repo-template": reportImageRepoTemplate,
"--registry-server": reportServer,
"--registry-tag-version": reportTagVersion,
"--registry-push-extra-tags": reportPushExtraTags,
"--registry-global-push-extra-tags": reportGlobalPushExtraTags,
"--registry-computed-push-extra-tags": reportComputedPushExtraTags,
}
}
flagKeys := []string{}
for flagKey := range flags {
flagKeys = append(flagKeys, flagKey)
}
infoFlags := common.CollectReport(appName, infoFlag, flags)
return common.ReportSingleApp(common.ReportSingleAppInput{
ReportType: "registry",
AppName: appName,
InfoFlag: infoFlag,
InfoFlags: infoFlags,
InfoFlagKeys: flagKeys,
Format: format,
TrimPrefix: true,
UppercaseFirstCharacter: true,
EmitLegacyPrefix: true,
})
}
func reportComputedImageRepo(appName string) string {
imageRepo := strings.TrimSpace(reportImageRepo(appName))
if imageRepo == "" {
imageRepo, _ = getImageRepoFromTemplate(appName)
}
if imageRepo == "" {
imageRepo = common.GetAppImageRepo(appName)
}
return imageRepo
}
func reportImageRepo(appName string) string {
return common.PropertyGet("registry", appName, "image-repo")
}
func reportComputedPushOnRelease(appName string) string {
value := reportPushOnRelease(appName)
value = strings.TrimSpace(value)
if value == "" {
value = reportGlobalPushOnRelease(appName)
}
if value == "" {
value = DefaultProperties["push-on-release"]
}
return value
}
func reportGlobalPushOnRelease(appName string) string {
return common.PropertyGet("registry", "--global", "push-on-release")
}
func reportPushOnRelease(appName string) string {
return common.PropertyGet("registry", appName, "push-on-release")
}
func reportComputedServer(appName string) string {
server := getRegistryServerForApp(appName)
return strings.TrimSpace(server)
}
func reportImageRepoTemplate(appName string) string {
return common.PropertyGet("registry", appName, "image-repo-template")
}
func reportGlobalImageRepoTemplate(appName string) string {
return common.PropertyGet("registry", "--global", "image-repo-template")
}
func reportComputedImageRepoTemplate(appName string) string {
value := strings.TrimSpace(reportImageRepoTemplate(appName))
if value == "" {
value = reportGlobalImageRepoTemplate(appName)
}
return value
}
func reportGlobalServer(appName string) string {
return common.PropertyGet("registry", "--global", "server")
}
func reportServer(appName string) string {
return common.PropertyGet("registry", appName, "server")
}
func reportTagVersion(appName string) string {
tagVersion := common.PropertyGet("registry", appName, "tag-version")
return strings.TrimSpace(tagVersion)
}
func reportPushExtraTags(appName string) string {
return common.PropertyGet("registry", appName, "push-extra-tags")
}
func reportGlobalPushExtraTags(appName string) string {
return common.PropertyGet("registry", "--global", "push-extra-tags")
}
func reportComputedPushExtraTags(appName string) string {
value := strings.TrimSpace(reportPushExtraTags(appName))
if value == "" {
value = reportGlobalPushExtraTags(appName)
}
if value == "" {
value = DefaultProperties["push-extra-tags"]
}
return value
}