/* * SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file) * * SPDX-License-Identifier: AGPL-3.0-only */ import { INestApplication } from '@nestjs/common'; import { ConfigModule } from '@nestjs/config'; import { Test } from '@nestjs/testing'; import { TypeOrmModule } from '@nestjs/typeorm'; import * as request from 'supertest'; import { PublicApiModule } from '../../src/api/public/public-api.module'; import mediaConfigMock from '../../src/config/media.config.mock'; import { NotInDBError } from '../../src/errors/errors'; import { GroupsModule } from '../../src/groups/groups.module'; import { LoggerModule } from '../../src/logger/logger.module'; import { NotesModule } from '../../src/notes/notes.module'; import { NotesService } from '../../src/notes/notes.service'; import { PermissionsModule } from '../../src/permissions/permissions.module'; import { AuthModule } from '../../src/auth/auth.module'; import { TokenAuthGuard } from '../../src/auth/token-auth.guard'; import { MockAuthGuard } from '../../src/auth/mock-auth.guard'; import { UsersService } from '../../src/users/users.service'; import { User } from '../../src/users/user.entity'; import { UsersModule } from '../../src/users/users.module'; describe('Notes', () => { let app: INestApplication; let notesService: NotesService; let user: User; let content: string; beforeAll(async () => { const moduleRef = await Test.createTestingModule({ imports: [ ConfigModule.forRoot({ isGlobal: true, load: [mediaConfigMock], }), PublicApiModule, NotesModule, PermissionsModule, GroupsModule, TypeOrmModule.forRoot({ type: 'sqlite', database: './hedgedoc-e2e-notes.sqlite', autoLoadEntities: true, synchronize: true, dropSchema: true, }), LoggerModule, AuthModule, UsersModule, ], }) .overrideGuard(TokenAuthGuard) .useClass(MockAuthGuard) .compile(); app = moduleRef.createNestApplication(); await app.init(); notesService = moduleRef.get(NotesService); const userService = moduleRef.get(UsersService); user = await userService.createUser('hardcoded', 'Testy'); content = 'This is a test note.'; }); it('POST /notes', async () => { const response = await request(app.getHttpServer()) .post('/notes') .set('Content-Type', 'text/markdown') .send(content) .expect('Content-Type', /json/) .expect(201); expect(response.body.metadata?.id).toBeDefined(); expect( await notesService.getCurrentContent( await notesService.getNoteByIdOrAlias(response.body.metadata.id), ), ).toEqual(content); }); describe('GET /notes/{note}', () => { it('works with an existing note', async () => { // check if we can succefully get a note that exists await notesService.createNote(content, 'test1', user); const response = await request(app.getHttpServer()) .get('/notes/test1') .expect('Content-Type', /json/) .expect(200); expect(response.body.content).toEqual(content); }); it('fails with an non-existing note', async () => { // check if a missing note correctly returns 404 await request(app.getHttpServer()) .get('/notes/i_dont_exist') .expect('Content-Type', /json/) .expect(404); }); }); describe('POST /notes/{note}', () => { it('works with a non-existing alias', async () => { const response = await request(app.getHttpServer()) .post('/notes/test2') .set('Content-Type', 'text/markdown') .send(content) .expect('Content-Type', /json/) .expect(201); expect(response.body.metadata?.id).toBeDefined(); return expect( await notesService.getCurrentContent( await notesService.getNoteByIdOrAlias(response.body.metadata?.id), ), ).toEqual(content); }); }); describe('DELETE /notes/{note}', () => { it('works with an existing alias', async () => { await notesService.createNote(content, 'test3', user); await request(app.getHttpServer()).delete('/notes/test3').expect(200); await expect(notesService.getNoteByIdOrAlias('test3')).rejects.toEqual( new NotInDBError("Note with id/alias 'test3' not found."), ); }); it('fails with a non-existing alias', async () => { await request(app.getHttpServer()) .delete('/notes/i_dont_exist') .expect(404); }); }); describe('PUT /notes/{note}', () => { const changedContent = 'New note text'; it('works with existing alias', async () => { await notesService.createNote(content, 'test4', user); const response = await request(app.getHttpServer()) .put('/notes/test4') .set('Content-Type', 'text/markdown') .send(changedContent) .expect(200); await expect( await notesService.getCurrentContent( await notesService.getNoteByIdOrAlias('test4'), ), ).toEqual(changedContent); expect(response.body.content).toEqual(changedContent); }); it('fails with a non-existing alias', async () => { await request(app.getHttpServer()) .put('/notes/i_dont_exist') .set('Content-Type', 'text/markdown') .expect('Content-Type', /json/) .expect(404); }); }); describe('GET /notes/{note}/metadata', () => { it('returns complete metadata object', async () => { await notesService.createNote(content, 'test5', user); const metadata = await request(app.getHttpServer()) .get('/notes/test5/metadata') .expect(200); expect(typeof metadata.body.id).toEqual('string'); expect(metadata.body.alias).toEqual('test5'); expect(metadata.body.title).toBeNull(); expect(metadata.body.description).toBeNull(); expect(typeof metadata.body.createTime).toEqual('string'); expect(metadata.body.editedBy).toEqual([]); expect(metadata.body.permissions.owner.userName).toEqual('hardcoded'); expect(metadata.body.permissions.sharedToUsers).toEqual([]); expect(metadata.body.permissions.sharedToUsers).toEqual([]); expect(metadata.body.tags).toEqual([]); expect(typeof metadata.body.updateTime).toEqual('string'); expect(typeof metadata.body.updateUser.displayName).toEqual('string'); expect(typeof metadata.body.updateUser.userName).toEqual('string'); expect(typeof metadata.body.updateUser.email).toEqual('string'); expect(typeof metadata.body.updateUser.photo).toEqual('string'); expect(typeof metadata.body.viewCount).toEqual('number'); expect(metadata.body.editedBy).toEqual([]); }); it('fails with non-existing alias', async () => { // check if a missing note correctly returns 404 await request(app.getHttpServer()) .get('/notes/i_dont_exist/metadata') .expect('Content-Type', /json/) .expect(404); }); it('has the correct update/create dates', async () => { // create a note const note = await notesService.createNote(content, 'test5a', user); // save the creation time const createDate = (await note.revisions)[0].createdAt; // wait one second await new Promise((r) => setTimeout(r, 1000)); // update the note await notesService.updateNoteByIdOrAlias('test5a', 'More test content'); const metadata = await request(app.getHttpServer()) .get('/notes/test5a/metadata') .expect(200); expect(metadata.body.createTime).toEqual(createDate.toISOString()); expect(metadata.body.updateTime).not.toEqual(createDate.toISOString()); }); }); describe('GET /notes/{note}/revisions', () => { it('works with existing alias', async () => { await notesService.createNote(content, 'test6', user); const response = await request(app.getHttpServer()) .get('/notes/test6/revisions') .expect('Content-Type', /json/) .expect(200); expect(response.body).toHaveLength(1); }); it('fails with non-existing alias', async () => { // check if a missing note correctly returns 404 await request(app.getHttpServer()) .get('/notes/i_dont_exist/revisions') .expect('Content-Type', /json/) .expect(404); }); }); describe('GET /notes/{note}/revisions/{revision-id}', () => { it('works with an existing alias', async () => { const note = await notesService.createNote(content, 'test7', user); const revision = await notesService.getLatestRevision(note); const response = await request(app.getHttpServer()) .get('/notes/test7/revisions/' + revision.id) .expect('Content-Type', /json/) .expect(200); expect(response.body.content).toEqual(content); }); it('fails with non-existing alias', async () => { // check if a missing note correctly returns 404 await request(app.getHttpServer()) .get('/notes/i_dont_exist/revisions/1') .expect('Content-Type', /json/) .expect(404); }); }); describe('GET /notes/{note}/content', () => { it('works with an existing alias', async () => { await notesService.createNote(content, 'test8', user); const response = await request(app.getHttpServer()) .get('/notes/test8/content') .expect(200); expect(response.text).toEqual(content); }); it('fails with non-existing alias', async () => { // check if a missing note correctly returns 404 await request(app.getHttpServer()) .get('/notes/i_dont_exist/content') .expect('Content-Type', /text\/markdown/) .expect(404); }); }); afterAll(async () => { await app.close(); }); });