feat(admin): delete org route (#37)

Co-authored-by: braddf <info@bradfulford.co.uk>

Author: devsjc

internal/server/dummy/adminserverimpl.go

@@ -25,6 +25,13 @@ func NewDataPlatformAdministrationServiceServerImpl() *DataPlatformAdministratio
 
 type DataPlatformAdministrationServiceServerImpl struct{}
 
+func (d *DataPlatformAdministrationServiceServerImpl) DeleteOrganisation(
+	ctx context.Context,
+	req *pb.DeleteOrganisationRequest,
+) (*pb.DeleteOrganisationResponse, error) {
+	return &pb.DeleteOrganisationResponse{}, nil
+}
+
 // CreateLocationPolicyGroup implements dp.DataPlatformAdministrationServiceServer.
 func (d *DataPlatformAdministrationServiceServerImpl) CreateLocationPolicyGroup(
 	ctx context.Context,

internal/server/postgres/adminserver_test.go

@@ -80,6 +80,51 @@ func TestCreateOrganisation(t *testing.T) {
 	}
 }
 
+func TestDeleteOrganisation(t *testing.T) {
+	metadata, err := structpb.NewStruct(map[string]any{"source": "test"})
+	require.NoError(t, err)
+
+	orgResp, err := ac.CreateOrganisation(context.Background(), &pb.CreateOrganisationRequest{
+		OrgName:  "test_delete_organisation_1",
+		Metadata: metadata,
+	})
+
+	require.NoError(t, err)
+
+	testCases := []struct {
+		name      string
+		deleteReq *pb.DeleteOrganisationRequest
+	}{
+		{
+			name: "Should delete existing organisation",
+			deleteReq: &pb.DeleteOrganisationRequest{
+				OrgName: orgResp.OrgName,
+			},
+		},
+		{
+			name: "Should handle deleting a non-existent organisation",
+			deleteReq: &pb.DeleteOrganisationRequest{
+				OrgName: "non_existent_delete_organisation",
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			_, err := ac.DeleteOrganisation(t.Context(), tc.deleteReq)
+			if strings.Contains(tc.name, "Shouldn't") {
+				require.Error(t, err)
+			} else {
+				require.NoError(t, err)
+				_, err := ac.GetOrganisation(t.Context(), &pb.GetOrganisationRequest{
+					OrgName: tc.deleteReq.OrgName,
+				})
+				require.Error(t, err)
+			}
+		})
+	}
+}
+
 func TestAddRemoveLocationPolicyGroupToOrganisation(t *testing.T) {
 	orgResp, err := ac.CreateOrganisation(t.Context(), &pb.CreateOrganisationRequest{
 		OrgName: "test_add_remove_location_policy_group_organisation",

internal/server/postgres/adminserverimpl.go

@@ -34,6 +34,30 @@ func NewDataPlatformAdministrationServiceServerImpl() *DataPlatformAdministratio
 // It also expects a zerolog logger to be set in the context.
 type DataPlatformAdministrationServiceServerImpl struct{}
 
+func (d *DataPlatformAdministrationServiceServerImpl) DeleteOrganisation(
+	ctx context.Context,
+	req *pb.DeleteOrganisationRequest,
+) (*pb.DeleteOrganisationResponse, error) {
+	l := zerolog.Ctx(ctx)
+	querier := db.New(ix.GetTxFromContext(ctx))
+
+	dobnParams := db.DeleteOrgByNameParams{
+		OrgName: req.OrgName,
+	}
+
+	err := querier.DeleteOrgByName(ctx, dobnParams)
+	if err != nil {
+		l.Error().Err(err).Msgf("querier.DeleteOrgByName(%+v)", dobnParams)
+
+		return nil, status.Error(
+			codes.Internal,
+			"Encountered database error. Check application logs.",
+		)
+	}
+
+	return &pb.DeleteOrganisationResponse{}, nil
+}
+
 func (d *DataPlatformAdministrationServiceServerImpl) CreateLocationPolicyGroup(
 	ctx context.Context,
 	req *pb.CreateLocationPolicyGroupRequest,

internal/server/postgres/sql/migrations/00005_iam.sql

@@ -71,7 +71,6 @@ CREATE TABLE iam.users (
     PRIMARY KEY (user_uuid),
     UNIQUE (oauth_id)
 );
-CREATE INDEX ON iam.users (oauth_id);
 CREATE INDEX ON iam.users (org_uuid);
 
 /*

internal/server/postgres/sql/queries/iam.sql

@@ -40,9 +40,9 @@ SELECT
 FROM iam.orgs
 ORDER BY org_name;
 
--- name: DeleteOrg :exec
+-- name: DeleteOrgByName :exec
 DELETE FROM iam.orgs
-WHERE org_uuid = $1;
+WHERE org_name = LOWER(sqlc.arg(org_name)::TEXT);
 
 -- name: AddUserToOrgByOAuthIDAndName :exec
 INSERT INTO iam.users (org_uuid, oauth_id)

proto/ocf/dp/dp-admin.messages.proto

@@ -98,6 +98,15 @@ message GetOrganisationResponse {
   repeated string user_oauth_ids = 6;
 }
 
+message DeleteOrganisationRequest {
+  string org_name = 1 [
+    (buf.validate.field).string.min_len = 2,
+    (buf.validate.field).string.max_len = 128
+  ];
+}
+
+message DeleteOrganisationResponse {}
+
 message AddLocationPolicyGroupToOrganisationRequest {
   string org_name = 1 [
     (buf.validate.field).string.min_len = 2,

proto/ocf/dp/dp-admin.service.proto

@@ -14,6 +14,7 @@ service DataPlatformAdministrationService {
 
   rpc CreateOrganisation(CreateOrganisationRequest) returns (CreateOrganisationResponse) {}
   rpc GetOrganisation(GetOrganisationRequest) returns (GetOrganisationResponse) {}
+  rpc DeleteOrganisation(DeleteOrganisationRequest) returns (DeleteOrganisationResponse) {}
   rpc AddUserToOrganisation(AddUserToOrganisationRequest) returns (AddUserToOrganisationResponse) {}
   rpc RemoveUserFromOrganisation(RemoveUserFromOrganisationRequest) returns (RemoveUserFromOrganisationResponse) {}
   rpc AddLocationPolicyGroupToOrganisation(AddLocationPolicyGroupToOrganisationRequest) returns (AddLocationPolicyGroupToOrganisationResponse) {}