diff --git a/internal/kafka/command/command.go b/internal/kafka/command/command.go index e907badd..9bc56846 100644 --- a/internal/kafka/command/command.go +++ b/internal/kafka/command/command.go @@ -1,8 +1,14 @@ package command import ( + "context" + "fmt" + "slices" + "strings" + "github.com/nais/cli/internal/flags" "github.com/nais/cli/internal/kafka/command/flag" + "github.com/nais/cli/internal/naisapi" "github.com/nais/cli/internal/validation" "github.com/nais/naistrix" ) @@ -25,3 +31,20 @@ func Kafka(parentFlags *flags.GlobalFlags) *naistrix.Command { }, } } + +func validateEnvironment(flags *flag.Kafka) naistrix.ValidateFlagsFunc { + return func(ctx context.Context) error { + if flags.Environment == "" { + return nil + } + environments, err := naisapi.GetAllEnvironments(ctx) + if err != nil { + return fmt.Errorf("validating Kafka environment: %w", err) + } + if slices.Contains(environments, string(flags.Environment)) { + return nil + } + slices.Sort(environments) + return fmt.Errorf("unknown Nais environment %q; available environments: %s", flags.Environment, strings.Join(environments, ", ")) + } +} diff --git a/internal/kafka/command/credentials.go b/internal/kafka/command/credentials.go index 44fdfee4..61e58e11 100644 --- a/internal/kafka/command/credentials.go +++ b/internal/kafka/command/credentials.go @@ -21,7 +21,7 @@ func credentials(parentFlags *flag.Kafka) *naistrix.Command { return &naistrix.Command{ Name: "credentials", Title: "Create temporary credentials for Kafka.", - Description: "Creates temporary credentials for accessing Kafka. Output format can be env (default), kcat, or java. The env format prints environment variables to stdout. The kcat and java formats write configuration files to a temporary directory.", + Description: "Creates temporary Kafka credentials in the selected Nais environment. Output format can be env (default), kcat, or java.", Flags: flags, ValidateFlagsFunc: naistrix.ValidateFlagsFuncs( validation.RequireEnvironmentFlag(flags), @@ -51,7 +51,7 @@ func credentials(parentFlags *flag.Kafka) *naistrix.Command { }, }, RunFunc: func(ctx context.Context, args *naistrix.Arguments, out *naistrix.OutputWriter) error { - creds, err := kafka.CreateCredentials( + result, err := kafka.CreateCredentials( ctx, flags.Team, string(flags.Environment), @@ -61,6 +61,12 @@ func credentials(parentFlags *flag.Kafka) *naistrix.Command { return fmt.Errorf("creating Kafka credentials: %w", err) } + // TODO: Remove this legacy alias warning on 2027-02-11, after the 90-day transition. + if result.EnvironmentName != "" && result.EnvironmentName != string(flags.Environment) { + _, _ = fmt.Fprintf(os.Stderr, "Warning: environment %q is a legacy alias; use --environment %s instead.\n", flags.Environment, result.EnvironmentName) + } + creds := &result.Credentials + output := string(flags.Output) if output == "" { output = "env" diff --git a/internal/kafka/command/credentials_test.go b/internal/kafka/command/credentials_test.go index 8f3e325b..6082482d 100644 --- a/internal/kafka/command/credentials_test.go +++ b/internal/kafka/command/credentials_test.go @@ -2,6 +2,9 @@ package command import ( "bytes" + "encoding/json" + "net/http" + "net/http/httptest" "os" "path/filepath" "strings" @@ -11,6 +14,66 @@ import ( "github.com/nais/naistrix" ) +// TODO: Remove legacy alias coverage on 2027-02-11, after the 90-day transition. +func TestCredentialsEnvironment(t *testing.T) { + for _, tt := range []struct { + name, requested, canonical, warning string + }{ + {name: "canonical NAV environment", requested: "dev-gcp", canonical: "dev-gcp"}, + {name: "canonical dev in another tenant", requested: "dev", canonical: "dev"}, + {name: "legacy alias", requested: "dev", canonical: "dev-gcp", warning: `Warning: environment "dev" is a legacy alias; use --environment dev-gcp instead.`}, + } { + t.Run(tt.name, func(t *testing.T) { + creds := testKafkaCreds() + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + var request struct { + Variables struct{ EnvironmentName string } + } + if err := json.NewDecoder(r.Body).Decode(&request); err != nil { + t.Error(err) + } + if request.Variables.EnvironmentName != tt.requested { + t.Errorf("requested environment = %q, want %q", request.Variables.EnvironmentName, tt.requested) + } + w.Header().Set("Content-Type", "application/json") + _ = json.NewEncoder(w).Encode(map[string]any{"data": map[string]any{"createKafkaCredentials": map[string]any{ + "environmentName": tt.canonical, + "credentials": creds, + }}}) + })) + defer server.Close() + t.Setenv("NAIS_API_LOCAL_HOST", strings.TrimPrefix(server.URL, "http://")) + stderr, err := os.CreateTemp(t.TempDir(), "stderr") + if err != nil { + t.Fatal(err) + } + previous := os.Stderr + os.Stderr = stderr + t.Cleanup(func() { os.Stderr = previous; _ = stderr.Close() }) + var output bytes.Buffer + app := newKafkaTestApplication(t, &output) + args := []string{"kafka", "credentials", "-t", "my-team", "-e", tt.requested, "--ttl", "1d"} + err = app.Run(naistrix.RunWithArgs(args)) + if err != nil { + t.Fatal(err) + } + diagnostics, err := os.ReadFile(stderr.Name()) + if err != nil { + t.Fatal(err) + } + if got := strings.TrimSpace(string(diagnostics)); got != tt.warning { + t.Errorf("stderr = %q, want %q", got, tt.warning) + } + if strings.Contains(output.String(), "legacy alias") { + t.Error("alias warning contaminated credential output") + } + if !strings.Contains(output.String(), `KAFKA_BROKERS="`+creds.Brokers+`"`) { + t.Error("missing credential output") + } + }) + } +} + func newTestOutputWriter(buf *bytes.Buffer) *naistrix.OutputWriter { level := naistrix.OutputVerbosityLevelNormal return naistrix.NewOutputWriter(buf, &level) diff --git a/internal/kafka/command/environment_test.go b/internal/kafka/command/environment_test.go new file mode 100644 index 00000000..2dda8738 --- /dev/null +++ b/internal/kafka/command/environment_test.go @@ -0,0 +1,106 @@ +package command + +import ( + "encoding/json" + "fmt" + "io" + "net/http" + "net/http/httptest" + "path/filepath" + "strings" + "testing" + + "github.com/nais/cli/internal/flags" + "github.com/nais/naistrix" +) + +func newKafkaTestApplication(t *testing.T, writer io.Writer) *naistrix.Application { + t.Helper() + t.Setenv("HOME", t.TempDir()) + t.Setenv("NAIS_TEAM", "") + t.Setenv("NAIS_ENVIRONMENT", "") + app, global, err := naistrix.NewApplication("test", "Test Kafka", "test", naistrix.ApplicationWithWriter(writer)) + if err != nil { + t.Fatal(err) + } + global.Config = filepath.Join(t.TempDir(), "config.yaml") + additional := &flags.AdditionalFlags{} + if err := app.AddGlobalFlags(additional); err != nil { + t.Fatal(err) + } + if err := app.AddCommand(Kafka(&flags.GlobalFlags{GlobalFlags: global, AdditionalFlags: additional})); err != nil { + t.Fatal(err) + } + return app +} + +// TODO: Remove legacy alias rejection coverage on 2027-02-11, after the 90-day transition. +func TestKafkaTopicEnvironment(t *testing.T) { + for _, tt := range []struct { + name, environment, environments, wantError string + command []string + apiError bool + }{ + {name: "list rejects alias", command: []string{"list"}, environment: "dev", wantError: `unknown Nais environment "dev"; available environments: dev-gcp, prod-gcp`}, + {name: "grant rejects alias", command: []string{"grant-access", "alice", "orders"}, environment: "dev", wantError: `unknown Nais environment "dev"`}, + {name: "list-grants rejects alias", command: []string{"list-grants", "orders"}, environment: "dev", wantError: `unknown Nais environment "dev"`}, + {name: "revoke rejects alias", command: []string{"revoke-grant", "alice", "orders", "read"}, environment: "dev", wantError: `unknown Nais environment "dev"`}, + {name: "canonical environment", environment: "dev-gcp"}, + {name: "dev is valid in another tenant", environment: "dev", environments: `[{"name":"dev"}]`}, + {name: "list without environment"}, + {name: "API error preserved", environment: "dev-gcp", apiError: true, wantError: "access denied"}, + } { + t.Run(tt.name, func(t *testing.T) { + server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + var request struct{ OperationName string } + if err := json.NewDecoder(r.Body).Decode(&request); err != nil { + t.Error(err) + return + } + w.Header().Set("Content-Type", "application/json") + switch request.OperationName { + case "Environments": + if tt.environment == "" { + t.Error("listing all environments should not need environment validation") + } + if tt.apiError { + _, _ = io.WriteString(w, `{"errors":[{"message":"access denied"}]}`) + return + } + environments := tt.environments + if environments == "" { + environments = `[{"name":"prod-gcp"},{"name":"dev-gcp"}]` + } + _, _ = fmt.Fprintf(w, `{"data":{"environments":{"nodes":%s}}}`, environments) + case "GetTeamKafkaTopics": + if tt.wantError != "" { + t.Error("invalid environment reached a topic query") + } + _, _ = io.WriteString(w, `{"data":{"team":{"kafkaTopics":{"nodes":[]}}}}`) + default: + t.Errorf("unexpected operation: %s", request.OperationName) + } + })) + defer server.Close() + t.Setenv("NAIS_API_LOCAL_HOST", strings.TrimPrefix(server.URL, "http://")) + app := newKafkaTestApplication(t, io.Discard) + command := tt.command + if command == nil { + command = []string{"list", "-o", "json"} + } + args := append([]string{"kafka"}, command...) + args = append(args, "-t", "my-team") + if tt.environment != "" { + args = append(args, "-e", tt.environment) + } + err := app.Run(naistrix.RunWithArgs(args)) + if tt.wantError != "" { + if err == nil || !strings.Contains(err.Error(), tt.wantError) { + t.Errorf("error = %v, want %q", err, tt.wantError) + } + } else if err != nil { + t.Fatal(err) + } + }) + } +} diff --git a/internal/kafka/command/grant_access.go b/internal/kafka/command/grant_access.go index 4d006464..9b221a2b 100644 --- a/internal/kafka/command/grant_access.go +++ b/internal/kafka/command/grant_access.go @@ -30,6 +30,7 @@ func grantAccess(parentFlags *flag.Kafka) *naistrix.Command { func(context.Context) error { return grantAccessTopicFlags.Access.Validate() }, + validateEnvironment(parentFlags), ), RunFunc: func(ctx context.Context, args *naistrix.Arguments, out *naistrix.OutputWriter) error { topicName := args.Get("topic") diff --git a/internal/kafka/command/list.go b/internal/kafka/command/list.go index d359a693..8f8f40db 100644 --- a/internal/kafka/command/list.go +++ b/internal/kafka/command/list.go @@ -16,10 +16,11 @@ func list(parentFlags *flag.Kafka) *naistrix.Command { flags := &flag.List{Kafka: parentFlags} return &naistrix.Command{ - Name: "list", - Title: "List Kafka topics in a team.", - Description: "Shows all Kafka topics owned by the team. Use --environment to filter by environment.", - Flags: flags, + Name: "list", + Title: "List Kafka topics in a team.", + Description: "Shows all Kafka topics owned by the team. Use --environment to filter by Nais environment.", + Flags: flags, + ValidateFlagsFunc: validateEnvironment(parentFlags), RunFunc: func(ctx context.Context, args *naistrix.Arguments, out *naistrix.OutputWriter) error { labelFilters, err := labels.ParseFilters(flags.Labels) if err != nil { diff --git a/internal/kafka/command/list_grants.go b/internal/kafka/command/list_grants.go index 59154639..6884f18b 100644 --- a/internal/kafka/command/list_grants.go +++ b/internal/kafka/command/list_grants.go @@ -39,7 +39,10 @@ func listGrants(parentFlags *flag.Kafka) *naistrix.Command { }, }, }, - ValidateFlagsFunc: validation.RequireTeamAndEnvironmentFlags(flags), + ValidateFlagsFunc: naistrix.ValidateFlagsFuncs( + validation.RequireTeamAndEnvironmentFlags(flags), + validateEnvironment(parentFlags), + ), RunFunc: func(ctx context.Context, args *naistrix.Arguments, out *naistrix.OutputWriter) error { grants, err := kafka.GetKafkaTopicGrants(ctx, args.Get("topic"), flags.Team, flags.Environment) if err != nil { diff --git a/internal/kafka/command/list_grants_choices_test.go b/internal/kafka/command/list_grants_choices_test.go index c0149492..3789dfda 100644 --- a/internal/kafka/command/list_grants_choices_test.go +++ b/internal/kafka/command/list_grants_choices_test.go @@ -34,7 +34,7 @@ func TestListGrantsDynamicTopicChoices(t *testing.T) { {name: "completion reports API error", completion: true, apiError: true, wantError: "access denied"}, {name: "completion validates team before lookup", completion: true, omitTeam: true, wantError: "missing required team"}, {name: "completion validates environment before lookup", completion: true, omitEnvironment: true, wantError: "missing required environment"}, - {name: "no lookup after final argument", completion: true, completeAfterValue: true}, + {name: "no topic lookup after final argument", completion: true, completeAfterValue: true}, } { t.Run(tt.name, func(t *testing.T) { var operations []string @@ -53,6 +53,8 @@ func TestListGrantsDynamicTopicChoices(t *testing.T) { v := request.Variables var response string switch request.OperationName { + case "Environments": + response = `{"data":{"environments":{"nodes":[{"name":"dev"}]}}}` case "GetTeamKafkaTopics": if v.Team != "my-team" || !slices.Equal(v.Filter.Environments, []string{"dev"}) { t.Errorf("incorrect topic lookup: %+v", v) @@ -150,10 +152,13 @@ func TestListGrantsDynamicTopicChoices(t *testing.T) { t.Fatal(err) } var wantOperations []string - if !tt.omitTeam && !tt.omitEnvironment && !tt.completeAfterValue { - wantOperations = append(wantOperations, "GetTeamKafkaTopics") - if !tt.completion && tt.wantError == "" { - wantOperations = append(wantOperations, "GetKafkaTopicGrants") + if !tt.omitTeam && !tt.omitEnvironment { + wantOperations = append(wantOperations, "Environments") + if !tt.completeAfterValue { + wantOperations = append(wantOperations, "GetTeamKafkaTopics") + if !tt.completion && tt.wantError == "" { + wantOperations = append(wantOperations, "GetKafkaTopicGrants") + } } } if !slices.Equal(operations, wantOperations) { diff --git a/internal/kafka/command/revoke_grant.go b/internal/kafka/command/revoke_grant.go index c4723f0d..f1c03346 100644 --- a/internal/kafka/command/revoke_grant.go +++ b/internal/kafka/command/revoke_grant.go @@ -22,7 +22,10 @@ func revokeGrant(parentFlags *flag.Kafka) *naistrix.Command { {Name: "topic", Prompt: "Name of the Kafka topic to revoke access to"}, {Name: "access", Prompt: "Access level to revoke", Choices: flag.KafkaTopicGrantAccessChoices(), ChoicesCaseInsensitive: true}, }, - ValidateFlagsFunc: validation.RequireTeamAndEnvironmentFlags(parentFlags), + ValidateFlagsFunc: naistrix.ValidateFlagsFuncs( + validation.RequireTeamAndEnvironmentFlags(parentFlags), + validateEnvironment(parentFlags), + ), ValidateArgsFunc: func(_ context.Context, args *naistrix.Arguments) error { return flag.KafkaTopicGrantAccess(args.Get("access")).Validate() }, diff --git a/internal/kafka/credentials.go b/internal/kafka/credentials.go index 69d513f2..0723a4bc 100644 --- a/internal/kafka/credentials.go +++ b/internal/kafka/credentials.go @@ -7,7 +7,7 @@ import ( "github.com/nais/cli/internal/naisapi/gql" ) -func CreateCredentials(ctx context.Context, teamSlug, environmentName, ttl string) (*gql.CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayloadCredentialsKafkaCredentials, error) { +func CreateCredentials(ctx context.Context, teamSlug, environmentName, ttl string) (*gql.CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayload, error) { _ = `# @genqlient mutation CreateKafkaCredentials( $teamSlug: Slug!, @@ -17,6 +17,7 @@ func CreateCredentials(ctx context.Context, teamSlug, environmentName, ttl strin createKafkaCredentials( input: { teamSlug: $teamSlug, environmentName: $environmentName, ttl: $ttl } ) { + environmentName credentials { username accessCert @@ -39,5 +40,5 @@ func CreateCredentials(ctx context.Context, teamSlug, environmentName, ttl strin return nil, err } - return &resp.CreateKafkaCredentials.Credentials, nil + return &resp.CreateKafkaCredentials, nil } diff --git a/internal/naisapi/gql/generated.go b/internal/naisapi/gql/generated.go index ef2ec03f..12c69627 100644 --- a/internal/naisapi/gql/generated.go +++ b/internal/naisapi/gql/generated.go @@ -856,10 +856,17 @@ func (v *CreateConfigResponse) GetCreateConfig() CreateConfigCreateConfigCreateC // CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayload includes the requested fields of the GraphQL type CreateKafkaCredentialsPayload. type CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayload struct { + // The environment the Kafka credentials were created for. + EnvironmentName string `json:"environmentName"` // The generated credentials. Credentials CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayloadCredentialsKafkaCredentials `json:"credentials"` } +// GetEnvironmentName returns CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayload.EnvironmentName, and is useful for accessing the field via an interface. +func (v *CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayload) GetEnvironmentName() string { + return v.EnvironmentName +} + // GetCredentials returns CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayload.Credentials, and is useful for accessing the field via an interface. func (v *CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayload) GetCredentials() CreateKafkaCredentialsCreateKafkaCredentialsCreateKafkaCredentialsPayloadCredentialsKafkaCredentials { return v.Credentials @@ -39004,6 +39011,7 @@ func CreateConfig( const CreateKafkaCredentials_Operation = ` mutation CreateKafkaCredentials ($teamSlug: Slug!, $environmentName: String!, $ttl: String!) { createKafkaCredentials(input: {teamSlug:$teamSlug,environmentName:$environmentName,ttl:$ttl}) { + environmentName credentials { username accessCert diff --git a/schema.graphql b/schema.graphql index 9494cbbe..6ba9c460 100644 --- a/schema.graphql +++ b/schema.graphql @@ -2914,6 +2914,10 @@ type CreateKafkaCredentialsPayload { The generated credentials. """ credentials: KafkaCredentials! +""" +The environment the Kafka credentials were created for. +""" + environmentName: String! } input CreateOpenSearchCredentialsInput {