1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
3 import { expect } from 'chai'
4 import { parallelTests } from '@shared/core-utils'
5 import { CustomConfig, HttpStatusCode } from '@shared/models'
12 setAccessTokensToServers
13 } from '@shared/server-commands'
15 function checkInitialConfig (server: PeerTubeServer, data: CustomConfig) {
16 expect(data.instance.name).to.equal('PeerTube')
17 expect(data.instance.shortDescription).to.equal(
18 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
20 expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
22 expect(data.instance.terms).to.equal('No terms for now.')
23 expect(data.instance.creationReason).to.be.empty
24 expect(data.instance.codeOfConduct).to.be.empty
25 expect(data.instance.moderationInformation).to.be.empty
26 expect(data.instance.administrator).to.be.empty
27 expect(data.instance.maintenanceLifetime).to.be.empty
28 expect(data.instance.businessModel).to.be.empty
29 expect(data.instance.hardwareInformation).to.be.empty
31 expect(data.instance.languages).to.have.lengthOf(0)
32 expect(data.instance.categories).to.have.lengthOf(0)
34 expect(data.instance.defaultClientRoute).to.equal('/videos/trending')
35 expect(data.instance.isNSFW).to.be.false
36 expect(data.instance.defaultNSFWPolicy).to.equal('display')
37 expect(data.instance.customizations.css).to.be.empty
38 expect(data.instance.customizations.javascript).to.be.empty
40 expect(data.services.twitter.username).to.equal('@Chocobozzz')
41 expect(data.services.twitter.whitelisted).to.be.false
43 expect(data.client.videos.miniature.preferAuthorDisplayName).to.be.false
44 expect(data.client.menu.login.redirectOnSingleExternalAuth).to.be.false
46 expect(data.cache.previews.size).to.equal(1)
47 expect(data.cache.captions.size).to.equal(1)
48 expect(data.cache.torrents.size).to.equal(1)
50 expect(data.signup.enabled).to.be.true
51 expect(data.signup.limit).to.equal(4)
52 expect(data.signup.minimumAge).to.equal(16)
53 expect(data.signup.requiresApproval).to.be.false
54 expect(data.signup.requiresEmailVerification).to.be.false
56 expect(data.admin.email).to.equal('admin' + server.internalServerNumber + '@example.com')
57 expect(data.contactForm.enabled).to.be.true
59 expect(data.user.videoQuota).to.equal(5242880)
60 expect(data.user.videoQuotaDaily).to.equal(-1)
62 expect(data.videoChannels.maxPerUser).to.equal(20)
64 expect(data.transcoding.enabled).to.be.false
65 expect(data.transcoding.allowAdditionalExtensions).to.be.false
66 expect(data.transcoding.allowAudioFiles).to.be.false
67 expect(data.transcoding.threads).to.equal(2)
68 expect(data.transcoding.concurrency).to.equal(2)
69 expect(data.transcoding.profile).to.equal('default')
70 expect(data.transcoding.resolutions['144p']).to.be.false
71 expect(data.transcoding.resolutions['240p']).to.be.true
72 expect(data.transcoding.resolutions['360p']).to.be.true
73 expect(data.transcoding.resolutions['480p']).to.be.true
74 expect(data.transcoding.resolutions['720p']).to.be.true
75 expect(data.transcoding.resolutions['1080p']).to.be.true
76 expect(data.transcoding.resolutions['1440p']).to.be.true
77 expect(data.transcoding.resolutions['2160p']).to.be.true
78 expect(data.transcoding.alwaysTranscodeOriginalResolution).to.be.true
79 expect(data.transcoding.webtorrent.enabled).to.be.true
80 expect(data.transcoding.hls.enabled).to.be.true
82 expect(data.live.enabled).to.be.false
83 expect(data.live.allowReplay).to.be.false
84 expect(data.live.latencySetting.enabled).to.be.true
85 expect(data.live.maxDuration).to.equal(-1)
86 expect(data.live.maxInstanceLives).to.equal(20)
87 expect(data.live.maxUserLives).to.equal(3)
88 expect(data.live.transcoding.enabled).to.be.false
89 expect(data.live.transcoding.threads).to.equal(2)
90 expect(data.live.transcoding.profile).to.equal('default')
91 expect(data.live.transcoding.resolutions['144p']).to.be.false
92 expect(data.live.transcoding.resolutions['240p']).to.be.false
93 expect(data.live.transcoding.resolutions['360p']).to.be.false
94 expect(data.live.transcoding.resolutions['480p']).to.be.false
95 expect(data.live.transcoding.resolutions['720p']).to.be.false
96 expect(data.live.transcoding.resolutions['1080p']).to.be.false
97 expect(data.live.transcoding.resolutions['1440p']).to.be.false
98 expect(data.live.transcoding.resolutions['2160p']).to.be.false
99 expect(data.live.transcoding.alwaysTranscodeOriginalResolution).to.be.true
101 expect(data.videoStudio.enabled).to.be.false
103 expect(data.import.videos.concurrency).to.equal(2)
104 expect(data.import.videos.http.enabled).to.be.true
105 expect(data.import.videos.torrent.enabled).to.be.true
106 expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.false
108 expect(data.followers.instance.enabled).to.be.true
109 expect(data.followers.instance.manualApproval).to.be.false
111 expect(data.followings.instance.autoFollowBack.enabled).to.be.false
112 expect(data.followings.instance.autoFollowIndex.enabled).to.be.false
113 expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('')
115 expect(data.broadcastMessage.enabled).to.be.false
116 expect(data.broadcastMessage.level).to.equal('info')
117 expect(data.broadcastMessage.message).to.equal('')
118 expect(data.broadcastMessage.dismissable).to.be.false
121 function checkUpdatedConfig (data: CustomConfig) {
122 expect(data.instance.name).to.equal('PeerTube updated')
123 expect(data.instance.shortDescription).to.equal('my short description')
124 expect(data.instance.description).to.equal('my super description')
126 expect(data.instance.terms).to.equal('my super terms')
127 expect(data.instance.creationReason).to.equal('my super creation reason')
128 expect(data.instance.codeOfConduct).to.equal('my super coc')
129 expect(data.instance.moderationInformation).to.equal('my super moderation information')
130 expect(data.instance.administrator).to.equal('Kuja')
131 expect(data.instance.maintenanceLifetime).to.equal('forever')
132 expect(data.instance.businessModel).to.equal('my super business model')
133 expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
135 expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
136 expect(data.instance.categories).to.deep.equal([ 1, 2 ])
138 expect(data.instance.defaultClientRoute).to.equal('/videos/recently-added')
139 expect(data.instance.isNSFW).to.be.true
140 expect(data.instance.defaultNSFWPolicy).to.equal('blur')
141 expect(data.instance.customizations.javascript).to.equal('alert("coucou")')
142 expect(data.instance.customizations.css).to.equal('body { background-color: red; }')
144 expect(data.services.twitter.username).to.equal('@Kuja')
145 expect(data.services.twitter.whitelisted).to.be.true
147 expect(data.client.videos.miniature.preferAuthorDisplayName).to.be.true
148 expect(data.client.menu.login.redirectOnSingleExternalAuth).to.be.true
150 expect(data.cache.previews.size).to.equal(2)
151 expect(data.cache.captions.size).to.equal(3)
152 expect(data.cache.torrents.size).to.equal(4)
154 expect(data.signup.enabled).to.be.false
155 expect(data.signup.limit).to.equal(5)
156 expect(data.signup.requiresApproval).to.be.false
157 expect(data.signup.requiresEmailVerification).to.be.false
158 expect(data.signup.minimumAge).to.equal(10)
160 // We override admin email in parallel tests, so skip this exception
161 if (parallelTests() === false) {
162 expect(data.admin.email).to.equal('superadmin1@example.com')
165 expect(data.contactForm.enabled).to.be.false
167 expect(data.user.videoQuota).to.equal(5242881)
168 expect(data.user.videoQuotaDaily).to.equal(318742)
170 expect(data.videoChannels.maxPerUser).to.equal(24)
172 expect(data.transcoding.enabled).to.be.true
173 expect(data.transcoding.threads).to.equal(1)
174 expect(data.transcoding.concurrency).to.equal(3)
175 expect(data.transcoding.allowAdditionalExtensions).to.be.true
176 expect(data.transcoding.allowAudioFiles).to.be.true
177 expect(data.transcoding.profile).to.equal('vod_profile')
178 expect(data.transcoding.resolutions['144p']).to.be.false
179 expect(data.transcoding.resolutions['240p']).to.be.false
180 expect(data.transcoding.resolutions['360p']).to.be.true
181 expect(data.transcoding.resolutions['480p']).to.be.true
182 expect(data.transcoding.resolutions['720p']).to.be.false
183 expect(data.transcoding.resolutions['1080p']).to.be.false
184 expect(data.transcoding.resolutions['2160p']).to.be.false
185 expect(data.transcoding.alwaysTranscodeOriginalResolution).to.be.false
186 expect(data.transcoding.hls.enabled).to.be.false
187 expect(data.transcoding.webtorrent.enabled).to.be.true
189 expect(data.live.enabled).to.be.true
190 expect(data.live.allowReplay).to.be.true
191 expect(data.live.latencySetting.enabled).to.be.false
192 expect(data.live.maxDuration).to.equal(5000)
193 expect(data.live.maxInstanceLives).to.equal(-1)
194 expect(data.live.maxUserLives).to.equal(10)
195 expect(data.live.transcoding.enabled).to.be.true
196 expect(data.live.transcoding.threads).to.equal(4)
197 expect(data.live.transcoding.profile).to.equal('live_profile')
198 expect(data.live.transcoding.resolutions['144p']).to.be.true
199 expect(data.live.transcoding.resolutions['240p']).to.be.true
200 expect(data.live.transcoding.resolutions['360p']).to.be.true
201 expect(data.live.transcoding.resolutions['480p']).to.be.true
202 expect(data.live.transcoding.resolutions['720p']).to.be.true
203 expect(data.live.transcoding.resolutions['1080p']).to.be.true
204 expect(data.live.transcoding.resolutions['2160p']).to.be.true
205 expect(data.live.transcoding.alwaysTranscodeOriginalResolution).to.be.false
207 expect(data.videoStudio.enabled).to.be.true
209 expect(data.import.videos.concurrency).to.equal(4)
210 expect(data.import.videos.http.enabled).to.be.false
211 expect(data.import.videos.torrent.enabled).to.be.false
212 expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.true
214 expect(data.followers.instance.enabled).to.be.false
215 expect(data.followers.instance.manualApproval).to.be.true
217 expect(data.followings.instance.autoFollowBack.enabled).to.be.true
218 expect(data.followings.instance.autoFollowIndex.enabled).to.be.true
219 expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('https://updated.example.com')
221 expect(data.broadcastMessage.enabled).to.be.true
222 expect(data.broadcastMessage.level).to.equal('error')
223 expect(data.broadcastMessage.message).to.equal('super bad message')
224 expect(data.broadcastMessage.dismissable).to.be.true
227 const newCustomConfig: CustomConfig = {
229 name: 'PeerTube updated',
230 shortDescription: 'my short description',
231 description: 'my super description',
232 terms: 'my super terms',
233 codeOfConduct: 'my super coc',
235 creationReason: 'my super creation reason',
236 moderationInformation: 'my super moderation information',
237 administrator: 'Kuja',
238 maintenanceLifetime: 'forever',
239 businessModel: 'my super business model',
240 hardwareInformation: '2vCore 3GB RAM',
242 languages: [ 'en', 'es' ],
243 categories: [ 1, 2 ],
246 defaultNSFWPolicy: 'blur' as 'blur',
248 defaultClientRoute: '/videos/recently-added',
251 javascript: 'alert("coucou")',
252 css: 'body { background-color: red; }'
267 preferAuthorDisplayName: true
272 redirectOnSingleExternalAuth: true
290 requiresApproval: false,
291 requiresEmailVerification: false,
295 email: 'superadmin1@example.com'
302 videoQuotaDaily: 318742
309 allowAdditionalExtensions: true,
310 allowAudioFiles: true,
313 profile: 'vod_profile',
325 alwaysTranscodeOriginalResolution: false,
340 maxInstanceLives: -1,
345 profile: 'live_profile',
356 alwaysTranscodeOriginalResolution: false
372 videoChannelSynchronization: {
380 enabled: [ 'hot', 'most-viewed', 'most-liked' ],
405 indexUrl: 'https://updated.example.com'
412 message: 'super bad message',
422 url: 'https://search.joinpeertube.org',
423 disableLocalSearch: true,
424 isDefaultSearch: true
429 describe('Test static config', function () {
430 let server: PeerTubeServer = null
432 before(async function () {
435 server = await createSingleServer(1, { webadmin: { configuration: { edition: { allowed: false } } } })
436 await setAccessTokensToServers([ server ])
439 it('Should tell the client that edits are not allowed', async function () {
440 const data = await server.config.getConfig()
442 expect(data.webadmin.configuration.edition.allowed).to.be.false
445 it('Should error when client tries to update', async function () {
446 await server.config.updateCustomConfig({ newCustomConfig, expectedStatus: 405 })
449 after(async function () {
450 await cleanupTests([ server ])
454 describe('Test config', function () {
455 let server: PeerTubeServer = null
457 before(async function () {
460 server = await createSingleServer(1)
461 await setAccessTokensToServers([ server ])
464 it('Should have a correct config on a server with registration enabled', async function () {
465 const data = await server.config.getConfig()
467 expect(data.signup.allowed).to.be.true
470 it('Should have a correct config on a server with registration enabled and a users limit', async function () {
474 server.registrations.register({ username: 'user1' }),
475 server.registrations.register({ username: 'user2' }),
476 server.registrations.register({ username: 'user3' })
479 const data = await server.config.getConfig()
481 expect(data.signup.allowed).to.be.false
484 it('Should have the correct video allowed extensions', async function () {
485 const data = await server.config.getConfig()
487 expect(data.video.file.extensions).to.have.lengthOf(3)
488 expect(data.video.file.extensions).to.contain('.mp4')
489 expect(data.video.file.extensions).to.contain('.webm')
490 expect(data.video.file.extensions).to.contain('.ogv')
492 await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 })
493 await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 })
495 expect(data.contactForm.enabled).to.be.true
498 it('Should get the customized configuration', async function () {
499 const data = await server.config.getCustomConfig()
501 checkInitialConfig(server, data)
504 it('Should update the customized configuration', async function () {
505 await server.config.updateCustomConfig({ newCustomConfig })
507 const data = await server.config.getCustomConfig()
508 checkUpdatedConfig(data)
511 it('Should have the correct updated video allowed extensions', async function () {
514 const data = await server.config.getConfig()
516 expect(data.video.file.extensions).to.have.length.above(4)
517 expect(data.video.file.extensions).to.contain('.mp4')
518 expect(data.video.file.extensions).to.contain('.webm')
519 expect(data.video.file.extensions).to.contain('.ogv')
520 expect(data.video.file.extensions).to.contain('.flv')
521 expect(data.video.file.extensions).to.contain('.wmv')
522 expect(data.video.file.extensions).to.contain('.mkv')
523 expect(data.video.file.extensions).to.contain('.mp3')
524 expect(data.video.file.extensions).to.contain('.ogg')
525 expect(data.video.file.extensions).to.contain('.flac')
527 await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.OK_200 })
528 await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.OK_200 })
531 it('Should have the configuration updated after a restart', async function () {
534 await killallServers([ server ])
538 const data = await server.config.getCustomConfig()
540 checkUpdatedConfig(data)
543 it('Should fetch the about information', async function () {
544 const data = await server.config.getAbout()
546 expect(data.instance.name).to.equal('PeerTube updated')
547 expect(data.instance.shortDescription).to.equal('my short description')
548 expect(data.instance.description).to.equal('my super description')
549 expect(data.instance.terms).to.equal('my super terms')
550 expect(data.instance.codeOfConduct).to.equal('my super coc')
552 expect(data.instance.creationReason).to.equal('my super creation reason')
553 expect(data.instance.moderationInformation).to.equal('my super moderation information')
554 expect(data.instance.administrator).to.equal('Kuja')
555 expect(data.instance.maintenanceLifetime).to.equal('forever')
556 expect(data.instance.businessModel).to.equal('my super business model')
557 expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
559 expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
560 expect(data.instance.categories).to.deep.equal([ 1, 2 ])
563 it('Should remove the custom configuration', async function () {
566 await server.config.deleteCustomConfig()
568 const data = await server.config.getCustomConfig()
569 checkInitialConfig(server, data)
572 it('Should enable frameguard', async function () {
576 const res = await makeGetRequest({
578 path: '/api/v1/config',
582 expect(res.headers['x-frame-options']).to.exist
585 await killallServers([ server ])
589 frameguard: { enabled: false }
592 await server.run(config)
595 const res = await makeGetRequest({
597 path: '/api/v1/config',
601 expect(res.headers['x-frame-options']).to.not.exist
605 after(async function () {
606 await cleanupTests([ server ])