1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import * as chai from 'chai'
5 import { About } from '../../../../shared/models/server/about.model'
6 import { CustomConfig } from '../../../../shared/models/server/custom-config.model'
19 setAccessTokensToServers,
22 } from '../../../../shared/extra-utils'
23 import { ServerConfig } from '../../../../shared/models'
24 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
26 const expect = chai.expect
28 function checkInitialConfig (server: ServerInfo, data: CustomConfig) {
29 expect(data.instance.name).to.equal('PeerTube')
30 expect(data.instance.shortDescription).to.equal(
31 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
33 expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
35 expect(data.instance.terms).to.equal('No terms for now.')
36 expect(data.instance.creationReason).to.be.empty
37 expect(data.instance.codeOfConduct).to.be.empty
38 expect(data.instance.moderationInformation).to.be.empty
39 expect(data.instance.administrator).to.be.empty
40 expect(data.instance.maintenanceLifetime).to.be.empty
41 expect(data.instance.businessModel).to.be.empty
42 expect(data.instance.hardwareInformation).to.be.empty
44 expect(data.instance.languages).to.have.lengthOf(0)
45 expect(data.instance.categories).to.have.lengthOf(0)
47 expect(data.instance.defaultClientRoute).to.equal('/videos/trending')
48 expect(data.instance.isNSFW).to.be.false
49 expect(data.instance.defaultNSFWPolicy).to.equal('display')
50 expect(data.instance.customizations.css).to.be.empty
51 expect(data.instance.customizations.javascript).to.be.empty
53 expect(data.services.twitter.username).to.equal('@Chocobozzz')
54 expect(data.services.twitter.whitelisted).to.be.false
56 expect(data.cache.previews.size).to.equal(1)
57 expect(data.cache.captions.size).to.equal(1)
59 expect(data.signup.enabled).to.be.true
60 expect(data.signup.limit).to.equal(4)
61 expect(data.signup.requiresEmailVerification).to.be.false
63 expect(data.admin.email).to.equal('admin' + server.internalServerNumber + '@example.com')
64 expect(data.contactForm.enabled).to.be.true
66 expect(data.user.videoQuota).to.equal(5242880)
67 expect(data.user.videoQuotaDaily).to.equal(-1)
69 expect(data.transcoding.enabled).to.be.false
70 expect(data.transcoding.allowAdditionalExtensions).to.be.false
71 expect(data.transcoding.allowAudioFiles).to.be.false
72 expect(data.transcoding.threads).to.equal(2)
73 expect(data.transcoding.resolutions['240p']).to.be.true
74 expect(data.transcoding.resolutions['360p']).to.be.true
75 expect(data.transcoding.resolutions['480p']).to.be.true
76 expect(data.transcoding.resolutions['720p']).to.be.true
77 expect(data.transcoding.resolutions['1080p']).to.be.true
78 expect(data.transcoding.resolutions['1440p']).to.be.true
79 expect(data.transcoding.resolutions['2160p']).to.be.true
80 expect(data.transcoding.webtorrent.enabled).to.be.true
81 expect(data.transcoding.hls.enabled).to.be.true
83 expect(data.live.enabled).to.be.false
84 expect(data.live.allowReplay).to.be.false
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.resolutions['240p']).to.be.false
91 expect(data.live.transcoding.resolutions['360p']).to.be.false
92 expect(data.live.transcoding.resolutions['480p']).to.be.false
93 expect(data.live.transcoding.resolutions['720p']).to.be.false
94 expect(data.live.transcoding.resolutions['1080p']).to.be.false
95 expect(data.live.transcoding.resolutions['1440p']).to.be.false
96 expect(data.live.transcoding.resolutions['2160p']).to.be.false
98 expect(data.import.videos.http.enabled).to.be.true
99 expect(data.import.videos.torrent.enabled).to.be.true
100 expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.false
102 expect(data.followers.instance.enabled).to.be.true
103 expect(data.followers.instance.manualApproval).to.be.false
105 expect(data.followings.instance.autoFollowBack.enabled).to.be.false
106 expect(data.followings.instance.autoFollowIndex.enabled).to.be.false
107 expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('')
109 expect(data.broadcastMessage.enabled).to.be.false
110 expect(data.broadcastMessage.level).to.equal('info')
111 expect(data.broadcastMessage.message).to.equal('')
112 expect(data.broadcastMessage.dismissable).to.be.false
115 function checkUpdatedConfig (data: CustomConfig) {
116 expect(data.instance.name).to.equal('PeerTube updated')
117 expect(data.instance.shortDescription).to.equal('my short description')
118 expect(data.instance.description).to.equal('my super description')
120 expect(data.instance.terms).to.equal('my super terms')
121 expect(data.instance.creationReason).to.equal('my super creation reason')
122 expect(data.instance.codeOfConduct).to.equal('my super coc')
123 expect(data.instance.moderationInformation).to.equal('my super moderation information')
124 expect(data.instance.administrator).to.equal('Kuja')
125 expect(data.instance.maintenanceLifetime).to.equal('forever')
126 expect(data.instance.businessModel).to.equal('my super business model')
127 expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
129 expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
130 expect(data.instance.categories).to.deep.equal([ 1, 2 ])
132 expect(data.instance.defaultClientRoute).to.equal('/videos/recently-added')
133 expect(data.instance.isNSFW).to.be.true
134 expect(data.instance.defaultNSFWPolicy).to.equal('blur')
135 expect(data.instance.customizations.javascript).to.equal('alert("coucou")')
136 expect(data.instance.customizations.css).to.equal('body { background-color: red; }')
138 expect(data.services.twitter.username).to.equal('@Kuja')
139 expect(data.services.twitter.whitelisted).to.be.true
141 expect(data.cache.previews.size).to.equal(2)
142 expect(data.cache.captions.size).to.equal(3)
144 expect(data.signup.enabled).to.be.false
145 expect(data.signup.limit).to.equal(5)
146 expect(data.signup.requiresEmailVerification).to.be.false
148 // We override admin email in parallel tests, so skip this exception
149 if (parallelTests() === false) {
150 expect(data.admin.email).to.equal('superadmin1@example.com')
153 expect(data.contactForm.enabled).to.be.false
155 expect(data.user.videoQuota).to.equal(5242881)
156 expect(data.user.videoQuotaDaily).to.equal(318742)
158 expect(data.transcoding.enabled).to.be.true
159 expect(data.transcoding.threads).to.equal(1)
160 expect(data.transcoding.allowAdditionalExtensions).to.be.true
161 expect(data.transcoding.allowAudioFiles).to.be.true
162 expect(data.transcoding.resolutions['240p']).to.be.false
163 expect(data.transcoding.resolutions['360p']).to.be.true
164 expect(data.transcoding.resolutions['480p']).to.be.true
165 expect(data.transcoding.resolutions['720p']).to.be.false
166 expect(data.transcoding.resolutions['1080p']).to.be.false
167 expect(data.transcoding.resolutions['2160p']).to.be.false
168 expect(data.transcoding.hls.enabled).to.be.false
169 expect(data.transcoding.webtorrent.enabled).to.be.true
171 expect(data.live.enabled).to.be.true
172 expect(data.live.allowReplay).to.be.true
173 expect(data.live.maxDuration).to.equal(5000)
174 expect(data.live.maxInstanceLives).to.equal(-1)
175 expect(data.live.maxUserLives).to.equal(10)
176 expect(data.live.transcoding.enabled).to.be.true
177 expect(data.live.transcoding.threads).to.equal(4)
178 expect(data.live.transcoding.resolutions['240p']).to.be.true
179 expect(data.live.transcoding.resolutions['360p']).to.be.true
180 expect(data.live.transcoding.resolutions['480p']).to.be.true
181 expect(data.live.transcoding.resolutions['720p']).to.be.true
182 expect(data.live.transcoding.resolutions['1080p']).to.be.true
183 expect(data.live.transcoding.resolutions['2160p']).to.be.true
185 expect(data.import.videos.http.enabled).to.be.false
186 expect(data.import.videos.torrent.enabled).to.be.false
187 expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.true
189 expect(data.followers.instance.enabled).to.be.false
190 expect(data.followers.instance.manualApproval).to.be.true
192 expect(data.followings.instance.autoFollowBack.enabled).to.be.true
193 expect(data.followings.instance.autoFollowIndex.enabled).to.be.true
194 expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('https://updated.example.com')
196 expect(data.broadcastMessage.enabled).to.be.true
197 expect(data.broadcastMessage.level).to.equal('error')
198 expect(data.broadcastMessage.message).to.equal('super bad message')
199 expect(data.broadcastMessage.dismissable).to.be.true
202 describe('Test config', function () {
205 before(async function () {
208 server = await flushAndRunServer(1)
209 await setAccessTokensToServers([ server ])
212 it('Should have a correct config on a server with registration enabled', async function () {
213 const res = await getConfig(server.url)
214 const data: ServerConfig = res.body
216 expect(data.signup.allowed).to.be.true
219 it('Should have a correct config on a server with registration enabled and a users limit', async function () {
223 registerUser(server.url, 'user1', 'super password'),
224 registerUser(server.url, 'user2', 'super password'),
225 registerUser(server.url, 'user3', 'super password')
228 const res = await getConfig(server.url)
229 const data: ServerConfig = res.body
231 expect(data.signup.allowed).to.be.false
234 it('Should have the correct video allowed extensions', async function () {
235 const res = await getConfig(server.url)
236 const data: ServerConfig = res.body
238 expect(data.video.file.extensions).to.have.lengthOf(3)
239 expect(data.video.file.extensions).to.contain('.mp4')
240 expect(data.video.file.extensions).to.contain('.webm')
241 expect(data.video.file.extensions).to.contain('.ogv')
243 await uploadVideo(server.url, server.accessToken, { fixture: 'video_short.mkv' }, HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415)
244 await uploadVideo(server.url, server.accessToken, { fixture: 'sample.ogg' }, HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415)
246 expect(data.contactForm.enabled).to.be.true
249 it('Should get the customized configuration', async function () {
250 const res = await getCustomConfig(server.url, server.accessToken)
251 const data = res.body as CustomConfig
253 checkInitialConfig(server, data)
256 it('Should update the customized configuration', async function () {
257 const newCustomConfig: CustomConfig = {
259 name: 'PeerTube updated',
260 shortDescription: 'my short description',
261 description: 'my super description',
262 terms: 'my super terms',
263 codeOfConduct: 'my super coc',
265 creationReason: 'my super creation reason',
266 moderationInformation: 'my super moderation information',
267 administrator: 'Kuja',
268 maintenanceLifetime: 'forever',
269 businessModel: 'my super business model',
270 hardwareInformation: '2vCore 3GB RAM',
272 languages: [ 'en', 'es' ],
273 categories: [ 1, 2 ],
275 defaultClientRoute: '/videos/recently-added',
277 defaultNSFWPolicy: 'blur' as 'blur',
279 javascript: 'alert("coucou")',
280 css: 'body { background-color: red; }'
303 requiresEmailVerification: false
306 email: 'superadmin1@example.com'
313 videoQuotaDaily: 318742
317 allowAdditionalExtensions: true,
318 allowAudioFiles: true,
341 maxInstanceLives: -1,
387 indexUrl: 'https://updated.example.com'
394 message: 'super bad message',
404 url: 'https://search.joinpeertube.org',
405 disableLocalSearch: true,
406 isDefaultSearch: true
410 await updateCustomConfig(server.url, server.accessToken, newCustomConfig)
412 const res = await getCustomConfig(server.url, server.accessToken)
413 const data = res.body
415 checkUpdatedConfig(data)
418 it('Should have the correct updated video allowed extensions', async function () {
421 const res = await getConfig(server.url)
422 const data: ServerConfig = res.body
424 expect(data.video.file.extensions).to.have.length.above(4)
425 expect(data.video.file.extensions).to.contain('.mp4')
426 expect(data.video.file.extensions).to.contain('.webm')
427 expect(data.video.file.extensions).to.contain('.ogv')
428 expect(data.video.file.extensions).to.contain('.flv')
429 expect(data.video.file.extensions).to.contain('.wmv')
430 expect(data.video.file.extensions).to.contain('.mkv')
431 expect(data.video.file.extensions).to.contain('.mp3')
432 expect(data.video.file.extensions).to.contain('.ogg')
433 expect(data.video.file.extensions).to.contain('.flac')
435 await uploadVideo(server.url, server.accessToken, { fixture: 'video_short.mkv' }, HttpStatusCode.OK_200)
436 await uploadVideo(server.url, server.accessToken, { fixture: 'sample.ogg' }, HttpStatusCode.OK_200)
439 it('Should have the configuration updated after a restart', async function () {
442 killallServers([ server ])
444 await reRunServer(server)
446 const res = await getCustomConfig(server.url, server.accessToken)
447 const data = res.body
449 checkUpdatedConfig(data)
452 it('Should fetch the about information', async function () {
453 const res = await getAbout(server.url)
454 const data: About = res.body
456 expect(data.instance.name).to.equal('PeerTube updated')
457 expect(data.instance.shortDescription).to.equal('my short description')
458 expect(data.instance.description).to.equal('my super description')
459 expect(data.instance.terms).to.equal('my super terms')
460 expect(data.instance.codeOfConduct).to.equal('my super coc')
462 expect(data.instance.creationReason).to.equal('my super creation reason')
463 expect(data.instance.moderationInformation).to.equal('my super moderation information')
464 expect(data.instance.administrator).to.equal('Kuja')
465 expect(data.instance.maintenanceLifetime).to.equal('forever')
466 expect(data.instance.businessModel).to.equal('my super business model')
467 expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
469 expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
470 expect(data.instance.categories).to.deep.equal([ 1, 2 ])
473 it('Should remove the custom configuration', async function () {
476 await deleteCustomConfig(server.url, server.accessToken)
478 const res = await getCustomConfig(server.url, server.accessToken)
479 const data = res.body
481 checkInitialConfig(server, data)
484 after(async function () {
485 await cleanupTests([ server ])