feat: Only return api keys when creating a new user, tests for it and…

… Create method returns a new user (to prepare for api keys generation)
Knoblauchpilze · Mar 31, 2024 · 28f4ed1 · 28f4ed1
1 parent 9f1ee78
commit 28f4ed1
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 18 deletions.
diff --git a/cmd/users/internal/users.go b/cmd/users/internal/users.go
@@ -49,12 +49,12 @@ func createUser(c echo.Context, repo repositories.UserRepository) error {
 	}
 
 	user := communication.FromUserDtoRequest(userDtoRequest)
-	err = repo.Create(c.Request().Context(), user)
+	created, err := repo.Create(c.Request().Context(), user)
 	if err != nil {
 		return c.JSON(http.StatusInternalServerError, err)
 	}
 
-	out := communication.ToUserDtoResponse(user)
+	out := communication.ToUserDtoResponse(created, true)
 	return c.JSON(http.StatusCreated, out)
 }
 
@@ -74,7 +74,8 @@ func getUser(c echo.Context, repo repositories.UserRepository) error {
 		return c.JSON(http.StatusInternalServerError, err)
 	}
 
-	out := communication.ToUserDtoResponse(user)
+	out := communication.ToUserDtoResponse(user, false)
+
 	return c.JSON(http.StatusOK, out)
 }
 
@@ -121,7 +122,7 @@ func updateUser(c echo.Context, repo repositories.UserRepository) error {
 		return c.JSON(http.StatusInternalServerError, err)
 	}
 
-	out := communication.ToUserDtoResponse(user)
+	out := communication.ToUserDtoResponse(user, false)
 	return c.JSON(http.StatusOK, out)
 }
 

diff --git a/cmd/users/internal/users_test.go b/cmd/users/internal/users_test.go
@@ -51,6 +51,7 @@ type mockDbConnection struct {
 }
 
 var defaultUuid = uuid.MustParse("08ce96a3-3430-48a8-a3b2-b1c987a207ca")
+var defaultApiKey = uuid.MustParse("cc1742fa-77b4-4f5f-ac92-058c2e47a5d6")
 var defaultUserRequest = communication.UserDtoRequest{
 	Email:    "[email protected]",
 	Password: "password",
@@ -59,7 +60,7 @@ var defaultUser = persistence.User{
 	Id:        defaultUuid,
 	Email:     "[email protected]",
 	Password:  "password",
-	ApiKeys:   []uuid.UUID{},
+	ApiKeys:   []uuid.UUID{defaultApiKey},
 	CreatedAt: time.Date(2009, 11, 17, 20, 34, 58, 651387237, time.UTC),
 	UpdatedAt: time.Date(2009, 11, 17, 20, 34, 59, 651387237, time.UTC),
 }
@@ -128,9 +129,17 @@ func TestCreateUser_WhenRepositorySucceeds_ReturnsExpectedUser(t *testing.T) {
 
 	_, err := uuid.Parse(actual.Id.String())
 	assert.Nil(err)
-	assert.Equal(defaultUserRequest.Email, actual.Email)
-	assert.Equal(defaultUserRequest.Password, actual.Password)
-	assert.True(actual.CreatedAt.Before(time.Now()))
+
+	expected := communication.UserDtoResponse{
+		Id:       defaultUuid,
+		Email:    "[email protected]",
+		Password: "password",
+
+		ApiKeys: []uuid.UUID{defaultApiKey},
+
+		CreatedAt: time.Date(2009, 11, 17, 20, 34, 58, 651387237, time.UTC),
+	}
+	assert.Equal(expected, actual)
 }
 
 func TestCreateUser_WhenRepositorySucceeds_SavesExpectedUser(t *testing.T) {
@@ -697,10 +706,10 @@ func (m *mockContext) NoContent(status int) error {
 	return nil
 }
 
-func (m *mockUserRepository) Create(ctx context.Context, user persistence.User) error {
+func (m *mockUserRepository) Create(ctx context.Context, user persistence.User) (persistence.User, error) {
 	m.createCalled++
 	m.createdUser = user
-	return m.err
+	return m.user, m.err
 }
 
 func (m *mockUserRepository) Get(ctx context.Context, id uuid.UUID) (persistence.User, error) {

diff --git a/pkg/communication/user_dto.go b/pkg/communication/user_dto.go
@@ -22,9 +22,9 @@ type UserDtoResponse struct {
 	CreatedAt time.Time
 }
 
-func ToUserDtoResponse(user persistence.User) UserDtoResponse {
+func ToUserDtoResponse(user persistence.User, copyApiKeys bool) UserDtoResponse {
 	apiKeys := make([]uuid.UUID, 0)
-	if user.ApiKeys != nil {
+	if copyApiKeys && user.ApiKeys != nil {
 		apiKeys = user.ApiKeys
 	}
 

diff --git a/pkg/communication/user_dto_test.go b/pkg/communication/user_dto_test.go
@@ -26,7 +26,7 @@ func TestToUserDtoResponse(t *testing.T) {
 		CreatedAt: someTime,
 	}
 
-	actual := ToUserDtoResponse(u)
+	actual := ToUserDtoResponse(u, true)
 
 	assert.Equal(defaultUuid, actual.Id)
 	assert.Equal("email", actual.Email)
@@ -48,7 +48,25 @@ func TestToUserDtoResponse_WhenApiKeysIsNull_OutptusAnEmptySlice(t *testing.T) {
 		CreatedAt: someTime,
 	}
 
-	actual := ToUserDtoResponse(u)
+	actual := ToUserDtoResponse(u, true)
+
+	assert.Equal([]uuid.UUID{}, actual.ApiKeys)
+}
+
+func TestToUserDtoResponse_WhenApiKeysIsValidButRequestedToNotPersisteThem_OutptusAnEmptySlice(t *testing.T) {
+	assert := assert.New(t)
+
+	u := persistence.User{
+		Id:       defaultUuid,
+		Email:    "email",
+		Password: "password",
+
+		ApiKeys: []uuid.UUID{defaultApiKey},
+
+		CreatedAt: someTime,
+	}
+
+	actual := ToUserDtoResponse(u, false)
 
 	assert.Equal([]uuid.UUID{}, actual.ApiKeys)
 }

diff --git a/pkg/repositories/user_repository.go b/pkg/repositories/user_repository.go
@@ -10,7 +10,7 @@ import (
 )
 
 type UserRepository interface {
-	Create(ctx context.Context, user persistence.User) error
+	Create(ctx context.Context, user persistence.User) (persistence.User, error)
 	Get(ctx context.Context, id uuid.UUID) (persistence.User, error)
 	List(ctx context.Context) ([]uuid.UUID, error)
 	Update(ctx context.Context, user persistence.User) (persistence.User, error)
@@ -29,9 +29,9 @@ func NewUserRepository(conn db.Connection) UserRepository {
 
 const createUserSqlTemplate = "INSERT INTO api_user (id, email, password, created_at) VALUES($1, $2, $3, $4)"
 
-func (r *userRepositoryImpl) Create(ctx context.Context, user persistence.User) error {
+func (r *userRepositoryImpl) Create(ctx context.Context, user persistence.User) (persistence.User, error) {
 	_, err := r.conn.Exec(ctx, createUserSqlTemplate, user.Id, user.Email, user.Password, user.CreatedAt)
-	return err
+	return user, err
 }
 
 const getUserSqlTemplate = "SELECT id, email, password, created_at, updated_at, version FROM api_user WHERE id = $1"

diff --git a/pkg/repositories/user_repository_test.go b/pkg/repositories/user_repository_test.go
@@ -89,11 +89,23 @@ func TestUserRepository_Create_PropagatesQueryFailure(t *testing.T) {
 	}
 	repo := NewUserRepository(mc)
 
-	err := repo.Create(context.Background(), defaultUser)
+	_, err := repo.Create(context.Background(), defaultUser)
 
 	assert.Equal(errDefault, err)
 }
 
+func TestUserRepository_Create_ReturnsInputUser(t *testing.T) {
+	assert := assert.New(t)
+
+	mc := &mockConnection{}
+	repo := NewUserRepository(mc)
+
+	actual, err := repo.Create(context.Background(), defaultUser)
+
+	assert.Nil(err)
+	assert.Equal(defaultUser, actual)
+}
+
 func TestUserRepository_Get_UsesConnectionToQuery(t *testing.T) {
 	assert := assert.New(t)