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.

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

fix(serviceuser): expose different port when sasl enabled #565

Merged
merged 1 commit into from
Dec 13, 2023
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- Expose `KAFKA_SCHEMA_REGISTRY_URI` and `KAFKA_REST_URI` to `Kafka` secret
- Expose `CONNECTIONPOOL_NAME` in `ConnectionPool` secret
- Fix `CONNECTIONPOOL_PORT` exposes service port instead of pool port
- Fix `SERVICEUSER_PORT` when `sasl` is the only authentication method

## v0.16.0 - 2023-12-07

Expand Down
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -271,9 +271,8 @@ catalog-build: opm ## Build a catalog image.
catalog-push: ## Push a catalog image.
$(MAKE) docker-push IMG=$(CATALOG_IMG)

# Release manifests
.PHONY: release-manifests
release-manifests: manifests kustomize
.PHONY: build-manifests
build-manifests: manifests kustomize
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
mkdir -p releases
$(KUSTOMIZE) build config/default > releases/aiven-operator-${IMG_TAG}.yaml
Expand Down Expand Up @@ -342,6 +341,7 @@ endif
aiven-operator charts/aiven-operator

# On MACOS requires gnu-sed. Run `brew info gnu-sed` and follow instructions to replace default sed.
.PHONY: imports
imports:
find . -type f -name '*.go' -exec sed -zi 's/"\n\+\t"/"\n"/g' {} +
goimports -local "github.com/aiven/aiven-operator" -w .
20 changes: 15 additions & 5 deletions controllers/serviceuser_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,17 @@ func (h ServiceUserHandler) get(ctx context.Context, avn *aiven.Client, obj clie
return nil, err
}

params := s.URIParams
var component *aiven.ServiceComponents
for _, c := range s.Components {
if c.Component == s.Type {
component = c
break
}
}

if component == nil {
return nil, fmt.Errorf("service component %q not found", s.Type)
}

caCert, err := avn.CA.Get(ctx, user.Spec.Project)
if err != nil {
Expand All @@ -121,16 +131,16 @@ func (h ServiceUserHandler) get(ctx context.Context, avn *aiven.Client, obj clie

prefix := getSecretPrefix(user)
stringData := map[string]string{
prefix + "HOST": params["host"],
prefix + "PORT": params["port"],
prefix + "HOST": component.Host,
prefix + "PORT": fmt.Sprintf("%d", component.Port),
prefix + "USERNAME": u.Username,
prefix + "PASSWORD": u.Password,
prefix + "ACCESS_CERT": u.AccessCert,
prefix + "ACCESS_KEY": u.AccessKey,
prefix + "CA_CERT": caCert,
// todo: remove in future releases
"HOST": params["host"],
"PORT": params["port"],
"HOST": component.Host,
"PORT": fmt.Sprintf("%d", component.Port),
"USERNAME": u.Username,
"PASSWORD": u.Password,
"ACCESS_CERT": u.AccessCert,
Expand Down
57 changes: 36 additions & 21 deletions tests/serviceuser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package tests
import (
"context"
"fmt"
"strconv"
"testing"

"github.com/stretchr/testify/assert"
Expand All @@ -11,10 +12,10 @@ import (
"github.com/aiven/aiven-operator/api/v1alpha1"
)

func getServiceUserYaml(project, pgName, userName, cloudName string) string {
func getServiceUserYaml(project, kafkaName, userName, cloudName string) string {
return fmt.Sprintf(`
apiVersion: aiven.io/v1alpha1
kind: PostgreSQL
kind: Kafka
metadata:
name: %[2]s
spec:
Expand All @@ -24,8 +25,12 @@ spec:

project: %[1]s
cloudName: %[4]s
plan: startup-4
plan: startup-2

userConfig:
kafka_authentication_methods:
sasl: true
certificate: false
---

apiVersion: aiven.io/v1alpha1
Expand All @@ -46,7 +51,7 @@ spec:

project: %[1]s
serviceName: %[2]s
`, project, pgName, userName, cloudName)
`, project, kafkaName, userName, cloudName)
}

func TestServiceUser(t *testing.T) {
Expand All @@ -55,41 +60,41 @@ func TestServiceUser(t *testing.T) {

// GIVEN
ctx := context.Background()
pgName := randName("connection-pool")
userName := randName("connection-pool")
yml := getServiceUserYaml(testProject, pgName, userName, testPrimaryCloudName)
kafkaName := randName("service-user")
userName := randName("service-user")
yml := getServiceUserYaml(testProject, kafkaName, userName, testPrimaryCloudName)
s := NewSession(k8sClient, avnClient, testProject)

// Cleans test afterwards
// Cleans test afterward
defer s.Destroy()

// WHEN
// Applies given manifest
require.NoError(t, s.Apply(yml))

// Waits kube objects
pg := new(v1alpha1.PostgreSQL)
require.NoError(t, s.GetRunning(pg, pgName))
kafka := new(v1alpha1.Kafka)
require.NoError(t, s.GetRunning(kafka, kafkaName))

user := new(v1alpha1.ServiceUser)
require.NoError(t, s.GetRunning(user, userName))

// THEN
// Validates PostgreSQL
pgAvn, err := avnClient.Services.Get(ctx, testProject, pgName)
// Validates Kafka
kafkaAvn, err := avnClient.Services.Get(ctx, testProject, kafkaName)
require.NoError(t, err)
assert.Equal(t, pgAvn.Name, pg.GetName())
assert.Equal(t, "RUNNING", pg.Status.State)
assert.Equal(t, pgAvn.State, pg.Status.State)
assert.Equal(t, pgAvn.Plan, pg.Spec.Plan)
assert.Equal(t, pgAvn.CloudName, pg.Spec.CloudName)
assert.Equal(t, kafkaAvn.Name, kafka.GetName())
assert.Equal(t, "RUNNING", kafka.Status.State)
assert.Equal(t, kafkaAvn.State, kafka.Status.State)
assert.Equal(t, kafkaAvn.Plan, kafka.Spec.Plan)
assert.Equal(t, kafkaAvn.CloudName, kafka.Spec.CloudName)

// Validates ServiceUser
userAvn, err := avnClient.ServiceUsers.Get(ctx, testProject, pgName, userName)
userAvn, err := avnClient.ServiceUsers.Get(ctx, testProject, kafkaName, userName)
require.NoError(t, err)
assert.Equal(t, userName, user.GetName())
assert.Equal(t, userName, userAvn.Username)
assert.Equal(t, pgName, user.Spec.ServiceName)
assert.Equal(t, kafkaName, user.Spec.ServiceName)

// Validates Secret
secret, err := s.GetSecret("my-service-user-secret")
Expand All @@ -111,12 +116,22 @@ func TestServiceUser(t *testing.T) {
assert.Equal(t, map[string]string{"foo": "bar"}, secret.Annotations)
assert.Equal(t, map[string]string{"baz": "egg"}, secret.Labels)

// This kafka has sasl enabled and cert auth disabled.
// Which means that the port is not the same as in uri params.
strPort := string(secret.Data["SERVICEUSER_PORT"])
assert.NotEmpty(t, kafkaAvn.URIParams["port"])
assert.NotEqual(t, kafkaAvn.URIParams["port"], strPort)

intPort, err := strconv.ParseInt(strPort, 10, 32)
assert.NoError(t, err)
assert.True(t, intPort > 0)

// We need to validate deletion,
// because we can get false positive here:
// if service is deleted, pool is destroyed in Aiven. No service — no pool. No pool — no pool.
// And we make sure that controller can delete db itself
// And we make sure that the controller can delete db itself
assert.NoError(t, s.Delete(user, func() error {
_, err = avnClient.ServiceUsers.Get(ctx, testProject, pgName, userName)
_, err = avnClient.ServiceUsers.Get(ctx, testProject, kafkaName, userName)
return err
}))
}