Skip to content
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

Jump to bottom

fix(cli): move deprecation warnings to stderr #1075

Merged
merged 2 commits into from
Nov 2, 2023
Merged

fix(cli): move deprecation warnings to stderr #1075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cabaae5
fix(cli): move deprecation warnings to stderr
Tieske Nov 2, 2023
6699a4d
tests(cli): update tests
Tieske Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/file_convert.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ func executeConvert(_ *cobra.Command, _ []string) error {
}
}
if convertCmdDestinationFormat == "konnect" {
cprint.UpdatePrintf("Warning: konnect format type was deprecated in v1.12 and it will be removed\n" +
"in a future version. Please use your Kong configuration files with deck <cmd>.\n" +
fmt.Fprintf(os.Stderr, "Warning: konnect format type was deprecated in v1.12 and it will be removed\n"+
"in a future version. Please use your Kong configuration files with deck <cmd>.\n"+
"Please see https://docs.konghq.com/konnect/getting-started/import/.\n")
}
return nil
Expand Down
4 changes: 2 additions & 2 deletions cmd/gateway_diff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ package cmd

import (
"fmt"
"os"

"github.com/kong/deck/cprint"
"github.com/spf13/cobra"
)

Expand Down Expand Up @@ -38,7 +38,7 @@ func newDiffCmd(deprecated bool) *cobra.Command {
use = "diff"
short = "[deprecated] use 'gateway diff' instead"
execute = func(cmd *cobra.Command, args []string) error {
cprint.UpdatePrintf("Warning: 'deck diff' is DEPRECATED and will be removed in a future version. " +
fmt.Fprintf(os.Stderr, "Warning: 'deck diff' is DEPRECATED and will be removed in a future version. "+
"Use 'deck gateway diff' instead.\n")
return executeDiff(cmd, args)
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/gateway_dump.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ package cmd
import (
"context"
"fmt"
"os"
"strings"

"github.com/kong/deck/cprint"
"github.com/kong/deck/dump"
"github.com/kong/deck/file"
"github.com/kong/deck/state"
Expand Down Expand Up @@ -151,7 +151,7 @@ func newDumpCmd(deprecated bool) *cobra.Command {
short = "[deprecated] use 'gateway dump' instead"
execute = func(cmd *cobra.Command, args []string) error {
dumpCmdKongStateFile = dumpCmdKongStateFileDeprecated
cprint.UpdatePrintf("Warning: 'deck dump' is DEPRECATED and will be removed in a future version. " +
fmt.Fprintf(os.Stderr, "Warning: 'deck dump' is DEPRECATED and will be removed in a future version. "+
"Use 'deck gateway dump' instead.\n")
return executeDump(cmd, args)
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/gateway_ping.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"context"
"fmt"
"os"

"github.com/kong/deck/cprint"
"github.com/kong/deck/utils"
"github.com/spf13/cobra"
)
Expand All @@ -27,7 +27,7 @@ func newPingCmd(deprecated bool) *cobra.Command {
if deprecated {
short = "[deprecated] use 'gateway ping' instead"
execute = func(cmd *cobra.Command, args []string) error {
cprint.UpdatePrintf("Warning: 'deck ping' is DEPRECATED and will be removed in a future version. " +
fmt.Fprintf(os.Stderr, "Warning: 'deck ping' is DEPRECATED and will be removed in a future version. "+
"Use 'deck gateway ping' instead.\n")
return executePing(cmd, args)
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/gateway_reset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ package cmd

import (
"fmt"
"os"

"github.com/kong/deck/cprint"
"github.com/kong/deck/state"
"github.com/kong/deck/utils"
"github.com/spf13/cobra"
Expand Down Expand Up @@ -112,7 +112,7 @@ func newResetCmd(deprecated bool) *cobra.Command {
if deprecated {
short = "[deprecated] use 'gateway reset' instead"
execute = func(cmd *cobra.Command, args []string) error {
cprint.UpdatePrintf("Warning: 'deck reset' is DEPRECATED and will be removed in a future version. " +
fmt.Fprintf(os.Stderr, "Warning: 'deck reset' is DEPRECATED and will be removed in a future version. "+
"Use 'deck gateway reset' instead.\n")
return executeReset(cmd, args)
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/gateway_sync.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ package cmd

import (
"fmt"
"os"

"github.com/kong/deck/cprint"
"github.com/spf13/cobra"
)

Expand Down Expand Up @@ -39,7 +39,7 @@ func newSyncCmd(deprecated bool) *cobra.Command {
use = "sync"
short = "[deprecated] use 'gateway sync' instead"
execute = func(cmd *cobra.Command, args []string) error {
cprint.UpdatePrintf("Warning: 'deck sync' is DEPRECATED and will be removed in a future version. " +
fmt.Fprintf(os.Stderr, "Warning: 'deck sync' is DEPRECATED and will be removed in a future version. "+
"Use 'deck gateway sync' instead.\n")
return executeSync(cmd, args)
}
Expand Down
4 changes: 2 additions & 2 deletions cmd/gateway_validate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ package cmd
import (
"context"
"fmt"
"os"

"github.com/kong/deck/cprint"
"github.com/kong/deck/dump"
"github.com/kong/deck/file"
"github.com/kong/deck/state"
Expand Down Expand Up @@ -105,7 +105,7 @@ this command unless --online flag is used.
`

execute = func(cmd *cobra.Command, args []string) error {
cprint.UpdatePrintf("Warning: 'deck validate' is DEPRECATED and will be removed in a future version. " +
fmt.Fprintf(os.Stderr, "Warning: 'deck validate' is DEPRECATED and will be removed in a future version. "+
"Use 'deck gateway validate' instead.\n")
return executeValidate(cmd, args)
}
Expand Down
18 changes: 6 additions & 12 deletions tests/integration/diff_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ import (
)

var (
expectedOutputMasked = `Warning: 'deck diff' is DEPRECATED and will be removed in a future version. Use 'deck gateway diff' instead.
updating service svc1 {
expectedOutputMasked = `updating service svc1 {
"connect_timeout": 60000,
"enabled": true,
"host": "[masked]",
Expand All @@ -38,8 +37,7 @@ Summary:
Deleted: 0
`

expectedOutputUnMasked = `Warning: 'deck diff' is DEPRECATED and will be removed in a future version. Use 'deck gateway diff' instead.
updating service svc1 {
expectedOutputUnMasked = `updating service svc1 {
"connect_timeout": 60000,
"enabled": true,
"host": "mockbin.org",
Expand Down Expand Up @@ -70,8 +68,7 @@ Summary:
"DECK_FOO": "foo_test", // unused, partial match
}

expectedOutputUnMaskedJSON = `Warning: 'deck diff' is DEPRECATED and will be removed in a future version. Use 'deck gateway diff' instead.
{
expectedOutputUnMaskedJSON = `{
"changes": {
"creating": [
{
Expand Down Expand Up @@ -167,8 +164,7 @@ Summary:

`

expectedOutputMaskedJSON = `Warning: 'deck diff' is DEPRECATED and will be removed in a future version. Use 'deck gateway diff' instead.
{
expectedOutputMaskedJSON = `{
"changes": {
"creating": [
{
Expand Down Expand Up @@ -268,8 +264,7 @@ Summary:

`

expectedOutputUnMaskedJSON30x = `Warning: 'deck diff' is DEPRECATED and will be removed in a future version. Use 'deck gateway diff' instead.
{
expectedOutputUnMaskedJSON30x = `{
"changes": {
"creating": [
{
Expand Down Expand Up @@ -363,8 +358,7 @@ Summary:

`

expectedOutputMaskedJSON30x = `Warning: 'deck diff' is DEPRECATED and will be removed in a future version. Use 'deck gateway diff' instead.
{
expectedOutputMaskedJSON30x = `{
"changes": {
"creating": [
{
Expand Down