Implementing Galadriel Server Management Handlers API (#150)

Implementing Admin Handlers

Signed-off-by: Victor Vieira Barros Leal da Silveira <[email protected]>

pkg/common/http/http.go

@@ -3,27 +3,26 @@ package http
 import (
 	"errors"
 	"fmt"
-	"net/http"
 
 	"github.com/labstack/echo/v4"
 )
 
 // WriteResponse parses a struct into a json and writes in the response
-func WriteResponse(ctx echo.Context, body interface{}) error {
+func WriteResponse(ctx echo.Context, code int, body interface{}) error {
 	if body == nil {
 		return errors.New("body is required")
 	}
 
-	if err := ctx.JSON(http.StatusOK, body); err != nil {
+	if err := ctx.JSON(code, body); err != nil {
 		return fmt.Errorf("failed to write response body: %v", err)
 	}
 
 	return nil
 }
 
-// BodylessResponse wraps error echo body-less responses.
-func BodylessResponse(ctx echo.Context) error {
-	if err := ctx.NoContent(http.StatusOK); err != nil {
+// BodilessResponse wraps error echo body-less responses.
+func BodilessResponse(ctx echo.Context, code int) error {
+	if err := ctx.NoContent(code); err != nil {
 		return fmt.Errorf("failed to respond without body: %v", err)
 	}
 

pkg/common/http/http_test.go

@@ -34,21 +34,22 @@ func Setup() *HTTPSetup {
 func TestWriteResponse(t *testing.T) {
 	t.Run("Error when nil body is passed", func(t *testing.T) {
 		setup := Setup()
-		err := WriteResponse(setup.EchoContext, nil)
+		err := WriteResponse(setup.EchoContext, http.StatusOK, nil)
 		assert.EqualError(t, err, "body is required")
 		assert.Empty(t, setup.Recorder.Body)
 	})
 
 	t.Run("No error when an empty body is passed", func(t *testing.T) {
 		setup := Setup()
-		err := WriteResponse(setup.EchoContext, TestBody{})
+		err := WriteResponse(setup.EchoContext, http.StatusOK, TestBody{})
 		assert.NoError(t, err)
+		assert.Equal(t, http.StatusOK, setup.Recorder.Code)
 	})
 
 	t.Run("Ensuring that the body is being full filled with the entity", func(t *testing.T) {
 		expectedResponseBody := TestBody{Name: "teste"}
 		setup := Setup()
-		err := WriteResponse(setup.EchoContext, expectedResponseBody)
+		err := WriteResponse(setup.EchoContext, http.StatusOK, expectedResponseBody)
 		assert.NoError(t, err)
 
 		responseBody := TestBody{}
@@ -60,10 +61,10 @@ func TestWriteResponse(t *testing.T) {
 	})
 }
 
-func TestBodylessResponse(t *testing.T) {
+func TestBodilessResponse(t *testing.T) {
 	t.Run("Ensuring that the body is empty", func(t *testing.T) {
 		setup := Setup()
-		err := BodylessResponse(setup.EchoContext)
+		err := BodilessResponse(setup.EchoContext, http.StatusOK)
 		assert.NoError(t, err)
 
 		assert.NoError(t, err)
@@ -75,7 +76,7 @@ func TestBodylessResponse(t *testing.T) {
 func TestFromBody(t *testing.T) {
 	t.Run("Ensuring that the body is empty", func(t *testing.T) {
 		setup := Setup()
-		err := BodylessResponse(setup.EchoContext)
+		err := BodilessResponse(setup.EchoContext, http.StatusOK)
 		assert.NoError(t, err)
 
 		assert.NoError(t, err)

pkg/server/api/admin/admin.yaml

@@ -23,6 +23,7 @@ tags:
 paths:
   /trust-domain/{trustDomainName}:
     get: 
+      operationId: GetTrustDomainByName
       tags:
         - Trust Domain
       summary: Get a specific trust domain
@@ -43,6 +44,7 @@ paths:
         default:
           $ref: '#/components/responses/Default'
     put:
+      operationId: PutTrustDomainByName
       tags:
         - Trust Domain
       summary: Update a specific trust domain
@@ -70,6 +72,7 @@ paths:
 
   /trust-domain:
     put:
+      operationId: PutTrustDomain
       tags:
         - Trust Domain
       summary: Add a specific trust domain
@@ -90,15 +93,15 @@ paths:
 
   /relationships:
     get:
+      operationId: GetRelationships
       tags:
         - Relationships
       summary: Get relationships
       parameters:
         - name: status
           in: query
           schema:
-            type: string
-            enum: [approved, denied, pending]
+            $ref: '../../../common/api/schemas.yaml#/components/schemas/ConsentStatus'
           description: relationship status from a Trust Domain perspective,
         - name: trustDomainName
           in: query
@@ -117,6 +120,7 @@ paths:
         default:
           $ref: '#/components/responses/Default'
     put:
+      operationId: PutRelationship
       tags:
         - Relationships
       summary: Create a relationship request between two Trust Domains
@@ -138,6 +142,7 @@ paths:
 
   /relationships/{relationshipID}:
     get:
+      operationId: GetRelationshipByID
       tags:
         - Relationships
       summary: Get a specific relationship

pkg/server/datastore/fakedatabase.go

@@ -74,14 +74,15 @@ func (db *FakeDatabase) CreateOrUpdateTrustDomain(ctx context.Context, req *enti
 		return nil, err
 	}
 
-	req.ID = uuid.NullUUID{
-		UUID:  uuid.New(),
-		Valid: true,
+	if !req.ID.Valid {
+		req.ID = uuid.NullUUID{
+			UUID:  uuid.New(),
+			Valid: true,
+		}
+		req.CreatedAt = time.Now()
 	}
 
-	req.CreatedAt = time.Now()
 	req.UpdatedAt = time.Now()
-
 	db.trustDomains[req.ID.UUID] = req
 
 	return req, nil
@@ -174,9 +175,7 @@ func (db *FakeDatabase) CreateOrUpdateBundle(ctx context.Context, req *entity.Bu
 		}
 	}
 
-	req.CreatedAt = time.Now()
 	req.UpdatedAt = time.Now()
-
 	db.bundles[req.ID.UUID] = req
 
 	return req, nil
@@ -390,7 +389,18 @@ func (db *FakeDatabase) CreateOrUpdateRelationship(ctx context.Context, req *ent
 		return nil, err
 	}
 
-	return nil, nil
+	if !req.ID.Valid {
+		req.ID = uuid.NullUUID{
+			Valid: true,
+			UUID:  uuid.New(),
+		}
+		req.CreatedAt = time.Now()
+	}
+
+	req.UpdatedAt = time.Now()
+	db.relationships[req.ID.UUID] = req
+
+	return req, nil
 }
 
 func (db *FakeDatabase) FindRelationshipByID(ctx context.Context, relationshipID uuid.UUID) (*entity.Relationship, error) {

pkg/server/endpoints/auth_test.go

@@ -19,8 +19,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-const testTrustDomain = "test.com"
-
 type AuthNTestSetup struct {
 	EchoCtx      echo.Context
 	Middleware   *AuthenticationMiddleware

pkg/server/endpoints/harvester.go

@@ -85,7 +85,7 @@ func (h *HarvesterAPIHandlers) GetRelationships(echoCtx echo.Context, params har
 		apiRelationships = append(apiRelationships, api.RelationshipFromEntity(r))
 	}
 
-	return chttp.WriteResponse(echoCtx, apiRelationships)
+	return chttp.WriteResponse(echoCtx, http.StatusOK, apiRelationships)
 }
 
 // PatchRelationship accept/denies relationships requests - (PATCH /relationships/{relationshipID})
@@ -145,7 +145,7 @@ func (h *HarvesterAPIHandlers) PatchRelationship(echoCtx echo.Context, relations
 		return h.handleErrorAndLog(err, msg, http.StatusInternalServerError)
 	}
 
-	if err = chttp.BodylessResponse(echoCtx); err != nil {
+	if err = chttp.BodilessResponse(echoCtx, http.StatusOK); err != nil {
 		return h.handleErrorAndLog(err, err.Error(), http.StatusInternalServerError)
 	}
 
@@ -215,7 +215,7 @@ func (h *HarvesterAPIHandlers) Onboard(echoCtx echo.Context, params harvester.On
 		return h.handleErrorAndLog(err, msg, http.StatusInternalServerError)
 	}
 
-	return chttp.WriteResponse(echoCtx, jwtToken)
+	return chttp.WriteResponse(echoCtx, http.StatusOK, jwtToken)
 }
 
 // GetNewJWTToken renews a JWT access token - (GET /trust-domain/jwt)
@@ -255,7 +255,7 @@ func (h *HarvesterAPIHandlers) GetNewJWTToken(echoCtx echo.Context) error {
 		return h.handleErrorAndLog(err, msg, http.StatusInternalServerError)
 	}
 
-	return chttp.WriteResponse(echoCtx, newToken)
+	return chttp.WriteResponse(echoCtx, http.StatusOK, newToken)
 }
 
 // BundleSync synchronize the status of trust bundles between server and harvester - (POST /trust-domain/{trustDomainName}/bundles/sync)
@@ -294,7 +294,7 @@ func (h *HarvesterAPIHandlers) BundleSync(echoCtx echo.Context, trustDomainName
 		return h.handleErrorAndLog(err, msg, http.StatusInternalServerError)
 	}
 
-	return chttp.WriteResponse(echoCtx, resp)
+	return chttp.WriteResponse(echoCtx, http.StatusOK, resp)
 }
 
 // BundlePut uploads a new trust bundle to the server  - (PUT /trust-domain/{trustDomainName}/bundles)
@@ -351,7 +351,7 @@ func (h *HarvesterAPIHandlers) BundlePut(echoCtx echo.Context, trustDomainName a
 		return h.handleErrorAndLog(err, msg, http.StatusInternalServerError)
 	}
 
-	if err = chttp.BodylessResponse(echoCtx); err != nil {
+	if err = chttp.BodilessResponse(echoCtx, http.StatusOK); err != nil {
 		return h.handleErrorAndLog(err, err.Error(), http.StatusInternalServerError)
 	}