[add] Test cases of Award Assignment API

[fix] some Field bugs of Award models & controllers

Signed-off-by: TechQuery <shiy2008@gmail.com>

Author: TechQuery

source/controller/Award.ts

@@ -11,7 +11,8 @@ import {
     OnUndefined,
     Param,
     Post,
-    Put
+    Put,
+    QueryParams
 } from 'routing-controllers';
 import { ResponseSchema } from 'routing-controllers-openapi';
 
@@ -38,7 +39,7 @@ export class AwardController {
     @HttpCode(201)
     @ResponseSchema(Award)
     async createOne(
-        @CurrentUser() currentUser: User,
+        @CurrentUser() createdBy: User,
         @Param('name') name: string,
         @Body() award: Award
     ) {
@@ -47,11 +48,11 @@ export class AwardController {
         if (!hackathon)
             throw new NotFoundError(`Hackathon ${name} is not found`);
 
-        await HackathonController.ensureAdmin(currentUser.id, name);
+        await HackathonController.ensureAdmin(createdBy.id, name);
 
-        const saved = await awardStore.save({ ...award, hackathon });
+        const saved = await awardStore.save({ ...award, createdBy, hackathon });
 
-        await ActivityLogController.logCreate(currentUser, 'Award', saved.id);
+        await ActivityLogController.logCreate(createdBy, 'Award', saved.id);
 
         return saved;
     }
@@ -67,7 +68,7 @@ export class AwardController {
     @Authorized()
     @ResponseSchema(Award)
     async updateOne(
-        @CurrentUser() currentUser: User,
+        @CurrentUser() updatedBy: User,
         @Param('name') name: string,
         @Param('id') id: number,
         @Body() updateData: Award
@@ -76,18 +77,19 @@ export class AwardController {
 
         if (!award) throw new NotFoundError(`Award ${id} is not found`);
 
-        await HackathonController.ensureAdmin(currentUser.id, name);
+        await HackathonController.ensureAdmin(updatedBy.id, name);
 
         // update only allowed fields
         const updatedAward = {
             ...award,
             ...updateData,
             id, // make sure id is not overridden
+            updatedBy,
             hackathon: award.hackathon // make sure hackathon relationship is not changed
         };
         const saved = await awardStore.save(updatedAward);
 
-        await ActivityLogController.logUpdate(currentUser, 'Award', saved.id);
+        await ActivityLogController.logUpdate(updatedBy, 'Award', saved.id);
 
         return saved;
     }
@@ -96,26 +98,27 @@ export class AwardController {
     @Authorized()
     @OnUndefined(204)
     async deleteOne(
-        @CurrentUser() currentUser: User,
+        @CurrentUser() deletedBy: User,
         @Param('name') name: string,
         @Param('id') id: number
     ) {
         const award = await awardStore.findOneBy({ id });
 
         if (!award) throw new NotFoundError(`Award "${id}" is not found`);
 
-        await HackathonController.ensureAdmin(currentUser.id, name);
+        await HackathonController.ensureAdmin(deletedBy.id, name);
 
+        await awardStore.save({ ...award, deletedBy });
         await awardStore.softDelete(award.id);
 
-        await ActivityLogController.logDelete(currentUser, 'Award', award.id);
+        await ActivityLogController.logDelete(deletedBy, 'Award', award.id);
     }
 
     @Get()
     @ResponseSchema(AwardListChunk)
     async getList(
         @Param('name') name: string,
-        { pageSize, pageIndex }: BaseFilter
+        @QueryParams() { pageSize, pageIndex }: BaseFilter
     ) {
         const [list, count] = await awardStore.findAndCount({
             where: { hackathon: { name } },
@@ -212,10 +215,13 @@ export class AwardAssignmentController {
 
     @Get()
     @ResponseSchema(AwardAssignmentListChunk)
-    getList(@Param('id') id: number, { pageSize, pageIndex }: BaseFilter) {
+    getList(
+        @Param('aid') aid: number,
+        @QueryParams() { pageSize, pageIndex }: BaseFilter
+    ) {
         return AwardAssignmentController.getList(
             'award',
-            id,
+            aid,
             pageSize,
             pageIndex
         );
@@ -226,7 +232,10 @@ export class AwardAssignmentController {
 export class TeamAwardAssignmentController {
     @Get()
     @ResponseSchema(AwardAssignmentListChunk)
-    getList(@Param('id') id: number, { pageSize, pageIndex }: BaseFilter) {
+    getList(
+        @Param('id') id: number,
+        @QueryParams() { pageSize, pageIndex }: BaseFilter
+    ) {
         return AwardAssignmentController.getList(
             'team',
             id,

source/model/Award.ts

@@ -7,7 +7,7 @@ import {
     Min,
     ValidateNested
 } from 'class-validator';
-import { Column, Entity } from 'typeorm';
+import { Column, Entity, JoinColumn, ManyToOne, OneToOne } from 'typeorm';
 
 import { ListChunk, Media } from './Base';
 import { HackathonBase } from './Hackathon';
@@ -63,18 +63,24 @@ export class AwardAssignment extends HackathonBase {
     @Type(() => Award)
     @Transform(({ value }) => Award.from(value))
     @ValidateNested()
+    @IsOptional()
+    @ManyToOne(() => Award)
     award: Award;
 
     @Type(() => User)
     @Transform(({ value }) => User.from(value))
     @ValidateNested()
     @IsOptional()
+    @OneToOne(() => User, { nullable: true })
+    @JoinColumn()
     user?: User;
 
     @Type(() => Team)
     @Transform(({ value }) => Team.from(value))
     @ValidateNested()
     @IsOptional()
+    @OneToOne(() => Team, { nullable: true })
+    @JoinColumn()
     team?: Team;
 }
 

test/main.test.ts

@@ -395,24 +395,6 @@ describe('Main business logic', () => {
         }
     });
 
-    it('should delete an award', async () => {
-        await client.hackathon.awardControllerDeleteOne(
-            testHackathon.name,
-            testAward.id,
-            { headers: { Authorization: `Bearer ${hackathonCreator.token}` } }
-        );
-
-        try {
-            await client.hackathon.awardControllerGetOne(
-                testHackathon.name,
-                testAward.id
-            );
-            fail('Should have thrown a 404 error');
-        } catch (error) {
-            expect((error as HttpResponse<unknown>).status).toBe(404);
-        }
-    });
-
     it('should enroll a user in the hackathon', async () => {
         const { data: enrollment } =
             await client.hackathon.enrollmentControllerCreateOne(
@@ -511,6 +493,42 @@ describe('Main business logic', () => {
         expect(teamList.list[0].id).toBe(testTeam.id);
     });
 
+    it('should assign an award to a team by hackathon staffs', async () => {
+        const { data: assignment } =
+            await client.hackathon.awardAssignmentControllerCreateOne(
+                testHackathon.name,
+                testAward.id,
+                { team: testTeam },
+                {
+                    headers: {
+                        Authorization: `Bearer ${hackathonCreator.token}`
+                    }
+                }
+            );
+        expect(assignment.award.id).toBe(testAward.id);
+        expect(assignment.team.id).toBe(testTeam.id);
+    });
+
+    it('should get the list of award assignments for a hackathon', async () => {
+        const { data: awardAssignments } =
+            await client.hackathon.awardAssignmentControllerGetList(
+                testHackathon.name,
+                testAward.id
+            );
+        expect(awardAssignments.count).toBe(1);
+        expect(awardAssignments.list[0].award.id).toBe(testAward.id);
+        expect(awardAssignments.list[0].team.id).toBe(testTeam.id);
+
+        const { data: teamAssignments } =
+            await client.hackathon.teamAwardAssignmentControllerGetList(
+                testHackathon.name,
+                testTeam.id
+            );
+        expect(teamAssignments.count).toBe(1);
+        expect(teamAssignments.list[0].award.id).toBe(testAward.id);
+        expect(teamAssignments.list[0].team.id).toBe(testTeam.id);
+    });
+
     it('should delete a hackathon by its admin', async () => {
         const { name } = testHackathon;
         const { status, data } =