misskey/packages/backend/test/_e2e/api.ts

process.env.NODE_ENV = 'test';

import * as assert from 'assert';
import * as childProcess from 'child_process';
import { async, signup, request, post, react, uploadFile, startServer, shutdownServer } from '../utils.js';

describe('API', () => {
	let p: childProcess.ChildProcess;
	let alice: any;
	let bob: any;
	let carol: any;

	beforeAll(async () => {
		p = await startServer();
		alice = await signup({ username: 'alice' });
		bob = await signup({ username: 'bob' });
		carol = await signup({ username: 'carol' });
	}, 1000 * 30);

	afterAll(async () => {
		await shutdownServer(p);
	});

	describe('General validation', () => {
		test('wrong type', async(async () => {
			const res = await request('/test', {
				required: true,
				string: 42,
			});
			assert.strictEqual(res.status, 400);
		}));

		test('missing require param', async(async () => {
			const res = await request('/test', {
				string: 'a',
			});
			assert.strictEqual(res.status, 400);
		}));

		test('invalid misskey:id (empty string)', async(async () => {
			const res = await request('/test', {
				required: true,
				id: '',
			});
			assert.strictEqual(res.status, 400);
		}));

		test('valid misskey:id', async(async () => {
			const res = await request('/test', {
				required: true,
				id: '8wvhjghbxu',
			});
			assert.strictEqual(res.status, 200);
		}));

		test('default value', async(async () => {
			const res = await request('/test', {
				required: true,
				string: 'a',
			});
			assert.strictEqual(res.status, 200);
			assert.strictEqual(res.body.default, 'hello');
		}));

		test('can set null even if it has default value', async(async () => {
			const res = await request('/test', {
				required: true,
				nullableDefault: null,
			});
			assert.strictEqual(res.status, 200);
			assert.strictEqual(res.body.nullableDefault, null);
		}));

		test('cannot set undefined if it has default value', async(async () => {
			const res = await request('/test', {
				required: true,
				nullableDefault: undefined,
			});
			assert.strictEqual(res.status, 200);
			assert.strictEqual(res.body.nullableDefault, 'hello');
		}));
	});
});