1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
2 import { merge } from 'lodash'
3 import { omit } from '@shared/core-utils'
4 import { CustomConfig, HttpStatusCode } from '@shared/models'
12 setAccessTokensToServers
13 } from '@shared/server-commands'
15 describe('Test config API validators', function () {
16 const path = '/api/v1/config/custom'
17 let server: PeerTubeServer
18 let userAccessToken: string
19 const updateParams: CustomConfig = {
21 name: 'PeerTube updated',
22 shortDescription: 'my short description',
23 description: 'my super description',
24 terms: 'my super terms',
25 codeOfConduct: 'my super coc',
27 creationReason: 'my super reason',
28 moderationInformation: 'my super moderation information',
29 administrator: 'Kuja',
30 maintenanceLifetime: 'forever',
31 businessModel: 'my super business model',
32 hardwareInformation: '2vCore 3GB RAM',
34 languages: [ 'en', 'es' ],
38 defaultNSFWPolicy: 'blur',
40 defaultClientRoute: '/videos/recently-added',
43 javascript: 'alert("coucou")',
44 css: 'body { background-color: red; }'
52 username: '@MySuperUsername',
59 preferAuthorDisplayName: false
64 redirectOnSingleExternalAuth: false
82 requiresApproval: false,
83 requiresEmailVerification: false,
87 email: 'superadmin1@example.com'
99 videoQuotaDaily: 318742
106 allowAdditionalExtensions: true,
107 allowAudioFiles: true,
110 profile: 'vod_profile',
122 alwaysTranscodeOriginalResolution: false,
138 maxInstanceLives: -1,
144 profile: 'live_profile',
155 alwaysTranscodeOriginalResolution: false
171 videoChannelSynchronization: {
179 enabled: [ 'hot', 'most-viewed', 'most-liked' ],
180 default: 'most-viewed'
204 indexUrl: 'https://index.example.com'
211 message: 'super message',
221 url: 'https://search.joinpeertube.org',
222 disableLocalSearch: true,
223 isDefaultSearch: true
228 // ---------------------------------------------------------------
230 before(async function () {
233 server = await createSingleServer(1)
235 await setAccessTokensToServers([ server ])
241 await server.users.create({ username: user.username, password: user.password })
242 userAccessToken = await server.login.getAccessToken(user)
245 describe('When getting the configuration', function () {
246 it('Should fail without token', async function () {
247 await makeGetRequest({
250 expectedStatus: HttpStatusCode.UNAUTHORIZED_401
254 it('Should fail if the user is not an administrator', async function () {
255 await makeGetRequest({
258 token: userAccessToken,
259 expectedStatus: HttpStatusCode.FORBIDDEN_403
264 describe('When updating the configuration', function () {
265 it('Should fail without token', async function () {
266 await makePutBodyRequest({
269 fields: updateParams,
270 expectedStatus: HttpStatusCode.UNAUTHORIZED_401
274 it('Should fail if the user is not an administrator', async function () {
275 await makePutBodyRequest({
278 fields: updateParams,
279 token: userAccessToken,
280 expectedStatus: HttpStatusCode.FORBIDDEN_403
284 it('Should fail if it misses a key', async function () {
285 const newUpdateParams = { ...updateParams, admin: omit(updateParams.admin, [ 'email' ]) }
287 await makePutBodyRequest({
290 fields: newUpdateParams,
291 token: server.accessToken,
292 expectedStatus: HttpStatusCode.BAD_REQUEST_400
296 it('Should fail with a bad default NSFW policy', async function () {
297 const newUpdateParams = {
301 defaultNSFWPolicy: 'hello'
305 await makePutBodyRequest({
308 fields: newUpdateParams,
309 token: server.accessToken,
310 expectedStatus: HttpStatusCode.BAD_REQUEST_400
314 it('Should fail if email disabled and signup requires email verification', async function () {
315 // opposite scenario - success when enable enabled - covered via tests/api/users/user-verification.ts
316 const newUpdateParams = {
322 requiresApproval: true,
323 requiresEmailVerification: true
327 await makePutBodyRequest({
330 fields: newUpdateParams,
331 token: server.accessToken,
332 expectedStatus: HttpStatusCode.BAD_REQUEST_400
336 it('Should fail with a disabled webtorrent & hls transcoding', async function () {
337 const newUpdateParams = {
350 await makePutBodyRequest({
353 fields: newUpdateParams,
354 token: server.accessToken,
355 expectedStatus: HttpStatusCode.BAD_REQUEST_400
359 it('Should fail with a disabled http upload & enabled sync', async function () {
360 const newUpdateParams: CustomConfig = merge({}, updateParams, {
363 http: { enabled: false }
365 videoChannelSynchronization: { enabled: true }
369 await makePutBodyRequest({
372 fields: newUpdateParams,
373 token: server.accessToken,
374 expectedStatus: HttpStatusCode.BAD_REQUEST_400
378 it('Should succeed with the correct parameters', async function () {
379 await makePutBodyRequest({
382 fields: updateParams,
383 token: server.accessToken,
384 expectedStatus: HttpStatusCode.OK_200
389 describe('When deleting the configuration', function () {
390 it('Should fail without token', async function () {
391 await makeDeleteRequest({
394 expectedStatus: HttpStatusCode.UNAUTHORIZED_401
398 it('Should fail if the user is not an administrator', async function () {
399 await makeDeleteRequest({
402 token: userAccessToken,
403 expectedStatus: HttpStatusCode.FORBIDDEN_403
408 after(async function () {
409 await cleanupTests([ server ])