Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions internal/kafka/command/command.go
Original file line number Diff line number Diff line change
@@ -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"
)
Expand All @@ -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, ", "))
}
}
10 changes: 8 additions & 2 deletions internal/kafka/command/credentials.go
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down Expand Up @@ -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),
Expand All @@ -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"
Expand Down
63 changes: 63 additions & 0 deletions internal/kafka/command/credentials_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ package command

import (
"bytes"
"encoding/json"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strings"
Expand All @@ -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)
Expand Down
106 changes: 106 additions & 0 deletions internal/kafka/command/environment_test.go
Original file line number Diff line number Diff line change
@@ -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)
}
})
}
}
1 change: 1 addition & 0 deletions internal/kafka/command/grant_access.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
9 changes: 5 additions & 4 deletions internal/kafka/command/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
5 changes: 4 additions & 1 deletion internal/kafka/command/list_grants.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
15 changes: 10 additions & 5 deletions internal/kafka/command/list_grants_choices_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand Down Expand Up @@ -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) {
Expand Down
5 changes: 4 additions & 1 deletion internal/kafka/command/revoke_grant.go
Original file line number Diff line number Diff line change
Expand Up @@ -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()
},
Expand Down
5 changes: 3 additions & 2 deletions internal/kafka/credentials.go
Original file line number Diff line number Diff line change
Expand Up @@ -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!,
Expand All @@ -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
Expand All @@ -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
}
8 changes: 8 additions & 0 deletions internal/naisapi/gql/generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions schema.graphql
Original file line number Diff line number Diff line change
Expand Up @@ -2914,6 +2914,10 @@ type CreateKafkaCredentialsPayload {
The generated credentials.
"""
credentials: KafkaCredentials!
"""
The environment the Kafka credentials were created for.
"""
environmentName: String!
}

input CreateOpenSearchCredentialsInput {
Expand Down