PeerTube/server/tests/api/check-params/config.ts

357 lines
8.4 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import { omit } from 'lodash'
import 'mocha'
2018-02-28 18:04:46 +01:00
import { CustomConfig } from '../../../../shared/models/server/custom-config.model'
import {
cleanupTests,
createUser,
flushAndRunServer,
immutableAssign,
makeDeleteRequest,
makeGetRequest,
makePutBodyRequest,
ServerInfo,
setAccessTokensToServers,
userLogin
} from '../../../../shared/extra-utils'
import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
describe('Test config API validators', function () {
const path = '/api/v1/config/custom'
let server: ServerInfo
let userAccessToken: string
const updateParams: CustomConfig = {
instance: {
name: 'PeerTube updated',
2018-03-15 14:31:08 +01:00
shortDescription: 'my short description',
description: 'my super description',
terms: 'my super terms',
2019-08-23 15:23:27 +02:00
codeOfConduct: 'my super coc',
2019-09-03 09:49:04 +02:00
creationReason: 'my super reason',
2019-08-23 15:23:27 +02:00
moderationInformation: 'my super moderation information',
administrator: 'Kuja',
maintenanceLifetime: 'forever',
businessModel: 'my super business model',
hardwareInformation: '2vCore 3GB RAM',
2019-08-23 15:23:27 +02:00
languages: [ 'en', 'es' ],
categories: [ 1, 2 ],
2019-02-20 15:36:43 +01:00
isNSFW: true,
defaultNSFWPolicy: 'blur',
defaultClientRoute: '/videos/recently-added',
customizations: {
javascript: 'alert("coucou")',
css: 'body { background-color: red; }'
}
},
2019-07-09 11:45:19 +02:00
theme: {
default: 'default'
},
services: {
twitter: {
username: '@MySuperUsername',
whitelisted: true
}
},
cache: {
previews: {
size: 2
2018-07-12 19:02:00 +02:00
},
captions: {
size: 3
},
torrents: {
size: 4
}
},
signup: {
enabled: false,
limit: 5,
requiresEmailVerification: false,
minimumAge: 16
},
admin: {
email: 'superadmin1@example.com'
},
2019-01-09 15:14:29 +01:00
contactForm: {
enabled: false
},
user: {
videoQuota: 5242881,
videoQuotaDaily: 318742
},
transcoding: {
enabled: true,
2018-12-11 14:52:50 +01:00
allowAdditionalExtensions: true,
2019-05-16 16:55:34 +02:00
allowAudioFiles: true,
concurrency: 1,
threads: 1,
profile: 'vod_profile',
resolutions: {
'0p': false,
'240p': false,
'360p': true,
'480p': true,
'720p': false,
2019-06-12 17:33:29 +02:00
'1080p': false,
'1440p': false,
2019-06-12 17:33:29 +02:00
'2160p': false
2019-01-29 08:37:25 +01:00
},
webtorrent: {
enabled: true
},
2019-01-29 08:37:25 +01:00
hls: {
enabled: false
}
2018-08-03 11:10:31 +02:00
},
live: {
enabled: true,
2020-09-25 16:19:35 +02:00
allowReplay: false,
2020-12-15 09:23:28 +01:00
maxDuration: 30,
2020-10-28 15:24:40 +01:00
maxInstanceLives: -1,
maxUserLives: 50,
2020-09-25 16:19:35 +02:00
transcoding: {
enabled: true,
threads: 4,
profile: 'live_profile',
resolutions: {
'240p': true,
'360p': true,
'480p': true,
'720p': true,
'1080p': true,
'1440p': true,
'2160p': true
}
}
},
2018-08-03 11:10:31 +02:00
import: {
videos: {
concurrency: 1,
2018-08-03 11:10:31 +02:00
http: {
enabled: false
2018-08-07 10:07:53 +02:00
},
torrent: {
enabled: false
2018-08-03 11:10:31 +02:00
}
}
},
2021-01-27 17:15:21 +01:00
trending: {
videos: {
algorithms: {
enabled: [ 'best', 'hot', 'most-viewed', 'most-liked' ],
2021-01-27 17:15:21 +01:00
default: 'most-viewed'
}
}
},
autoBlacklist: {
videos: {
ofUsers: {
enabled: false
}
}
2019-04-08 14:04:57 +02:00
},
followers: {
instance: {
enabled: false,
manualApproval: true
2019-04-08 14:04:57 +02:00
}
},
followings: {
instance: {
autoFollowBack: {
enabled: true
},
autoFollowIndex: {
enabled: true,
indexUrl: 'https://index.example.com'
}
}
2020-05-28 11:15:38 +02:00
},
broadcastMessage: {
enabled: true,
dismissable: true,
message: 'super message',
level: 'warning'
2020-05-29 16:16:24 +02:00
},
search: {
remoteUri: {
users: true,
anonymous: true
},
searchIndex: {
enabled: true,
url: 'https://search.joinpeertube.org',
disableLocalSearch: true,
isDefaultSearch: true
}
}
}
// ---------------------------------------------------------------
before(async function () {
2018-01-18 18:10:45 +01:00
this.timeout(30000)
2019-04-24 10:53:40 +02:00
server = await flushAndRunServer(1)
await setAccessTokensToServers([ server ])
const user = {
username: 'user1',
password: 'password'
}
2019-04-15 10:49:46 +02:00
await createUser({ url: server.url, accessToken: server.accessToken, username: user.username, password: user.password })
userAccessToken = await userLogin(server, user)
})
describe('When getting the configuration', function () {
it('Should fail without token', async function () {
await makeGetRequest({
url: server.url,
path,
statusCodeExpected: HttpStatusCode.UNAUTHORIZED_401
})
})
it('Should fail if the user is not an administrator', async function () {
await makeGetRequest({
url: server.url,
path,
token: userAccessToken,
statusCodeExpected: HttpStatusCode.FORBIDDEN_403
})
})
})
describe('When updating the configuration', function () {
it('Should fail without token', async function () {
await makePutBodyRequest({
url: server.url,
path,
fields: updateParams,
statusCodeExpected: HttpStatusCode.UNAUTHORIZED_401
})
})
it('Should fail if the user is not an administrator', async function () {
await makePutBodyRequest({
url: server.url,
path,
fields: updateParams,
token: userAccessToken,
statusCodeExpected: HttpStatusCode.FORBIDDEN_403
})
})
it('Should fail if it misses a key', async function () {
const newUpdateParams = omit(updateParams, 'admin.email')
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should fail with a bad default NSFW policy', async function () {
const newUpdateParams = immutableAssign(updateParams, {
instance: {
defaultNSFWPolicy: 'hello'
}
})
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should fail if email disabled and signup requires email verification', async function () {
2019-04-24 15:10:37 +02:00
// opposite scenario - success when enable enabled - covered via tests/api/users/user-verification.ts
const newUpdateParams = immutableAssign(updateParams, {
signup: {
enabled: true,
limit: 5,
requiresEmailVerification: true
}
})
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should fail with a disabled webtorrent & hls transcoding', async function () {
const newUpdateParams = immutableAssign(updateParams, {
transcoding: {
hls: {
enabled: false
},
webtorrent: {
enabled: false
}
}
})
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should success with the correct parameters', async function () {
await makePutBodyRequest({
url: server.url,
path,
fields: updateParams,
token: server.accessToken,
statusCodeExpected: HttpStatusCode.OK_200
})
})
})
describe('When deleting the configuration', function () {
it('Should fail without token', async function () {
await makeDeleteRequest({
url: server.url,
path,
statusCodeExpected: HttpStatusCode.UNAUTHORIZED_401
})
})
it('Should fail if the user is not an administrator', async function () {
await makeDeleteRequest({
url: server.url,
path,
token: userAccessToken,
statusCodeExpected: HttpStatusCode.FORBIDDEN_403
})
})
})
2019-04-24 15:10:37 +02:00
after(async function () {
await cleanupTests([ server ])
})
})