server/tests/api/server/config.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   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'
   7 import {
   8   cleanupTests,
   9   deleteCustomConfig,
  10   flushAndRunServer,
  11   getAbout,
  12   getConfig,
  13   getCustomConfig,
  14   killallServers,
  15   parallelTests,
  16   registerUser,
  17   reRunServer,
  18   ServerInfo,
  19   setAccessTokensToServers,
  20   updateCustomConfig,
  21   uploadVideo
  22 } from '../../../../shared/extra-utils'
  23 import { ServerConfig } from '../../../../shared/models'
  24
  25 const expect = chai.expect
  26
  27 function checkInitialConfig (server: ServerInfo, data: CustomConfig) {
  28   expect(data.instance.name).to.equal('PeerTube')
  29   expect(data.instance.shortDescription).to.equal(
  30     'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
  31   )
  32   expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
  33
  34   expect(data.instance.terms).to.equal('No terms for now.')
  35   expect(data.instance.creationReason).to.be.empty
  36   expect(data.instance.codeOfConduct).to.be.empty
  37   expect(data.instance.moderationInformation).to.be.empty
  38   expect(data.instance.administrator).to.be.empty
  39   expect(data.instance.maintenanceLifetime).to.be.empty
  40   expect(data.instance.businessModel).to.be.empty
  41   expect(data.instance.hardwareInformation).to.be.empty
  42
  43   expect(data.instance.languages).to.have.lengthOf(0)
  44   expect(data.instance.categories).to.have.lengthOf(0)
  45
  46   expect(data.instance.defaultClientRoute).to.equal('/videos/trending')
  47   expect(data.instance.isNSFW).to.be.false
  48   expect(data.instance.defaultNSFWPolicy).to.equal('display')
  49   expect(data.instance.customizations.css).to.be.empty
  50   expect(data.instance.customizations.javascript).to.be.empty
  51
  52   expect(data.services.twitter.username).to.equal('@Chocobozzz')
  53   expect(data.services.twitter.whitelisted).to.be.false
  54
  55   expect(data.cache.previews.size).to.equal(1)
  56   expect(data.cache.captions.size).to.equal(1)
  57
  58   expect(data.signup.enabled).to.be.true
  59   expect(data.signup.limit).to.equal(4)
  60   expect(data.signup.requiresEmailVerification).to.be.false
  61
  62   expect(data.admin.email).to.equal('admin' + server.internalServerNumber + '@example.com')
  63   expect(data.contactForm.enabled).to.be.true
  64
  65   expect(data.user.videoQuota).to.equal(5242880)
  66   expect(data.user.videoQuotaDaily).to.equal(-1)
  67
  68   expect(data.transcoding.enabled).to.be.false
  69   expect(data.transcoding.allowAdditionalExtensions).to.be.false
  70   expect(data.transcoding.allowAudioFiles).to.be.false
  71   expect(data.transcoding.threads).to.equal(2)
  72   expect(data.transcoding.resolutions['240p']).to.be.true
  73   expect(data.transcoding.resolutions['360p']).to.be.true
  74   expect(data.transcoding.resolutions['480p']).to.be.true
  75   expect(data.transcoding.resolutions['720p']).to.be.true
  76   expect(data.transcoding.resolutions['1080p']).to.be.true
  77   expect(data.transcoding.resolutions['2160p']).to.be.true
  78   expect(data.transcoding.webtorrent.enabled).to.be.true
  79   expect(data.transcoding.hls.enabled).to.be.true
  80
  81   expect(data.live.enabled).to.be.false
  82   expect(data.live.allowReplay).to.be.true
  83   expect(data.live.maxDuration).to.equal(1000 * 3600 * 5)
  84   expect(data.live.transcoding.enabled).to.be.false
  85   expect(data.live.transcoding.threads).to.equal(2)
  86   expect(data.live.transcoding.resolutions['240p']).to.be.false
  87   expect(data.live.transcoding.resolutions['360p']).to.be.false
  88   expect(data.live.transcoding.resolutions['480p']).to.be.false
  89   expect(data.live.transcoding.resolutions['720p']).to.be.false
  90   expect(data.live.transcoding.resolutions['1080p']).to.be.false
  91   expect(data.live.transcoding.resolutions['2160p']).to.be.false
  92
  93   expect(data.import.videos.http.enabled).to.be.true
  94   expect(data.import.videos.torrent.enabled).to.be.true
  95   expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.false
  96
  97   expect(data.followers.instance.enabled).to.be.true
  98   expect(data.followers.instance.manualApproval).to.be.false
  99
 100   expect(data.followings.instance.autoFollowBack.enabled).to.be.false
 101   expect(data.followings.instance.autoFollowIndex.enabled).to.be.false
 102   expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('')
 103
 104   expect(data.broadcastMessage.enabled).to.be.false
 105   expect(data.broadcastMessage.level).to.equal('info')
 106   expect(data.broadcastMessage.message).to.equal('')
 107   expect(data.broadcastMessage.dismissable).to.be.false
 108 }
 109
 110 function checkUpdatedConfig (data: CustomConfig) {
 111   expect(data.instance.name).to.equal('PeerTube updated')
 112   expect(data.instance.shortDescription).to.equal('my short description')
 113   expect(data.instance.description).to.equal('my super description')
 114
 115   expect(data.instance.terms).to.equal('my super terms')
 116   expect(data.instance.creationReason).to.equal('my super creation reason')
 117   expect(data.instance.codeOfConduct).to.equal('my super coc')
 118   expect(data.instance.moderationInformation).to.equal('my super moderation information')
 119   expect(data.instance.administrator).to.equal('Kuja')
 120   expect(data.instance.maintenanceLifetime).to.equal('forever')
 121   expect(data.instance.businessModel).to.equal('my super business model')
 122   expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
 123
 124   expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
 125   expect(data.instance.categories).to.deep.equal([ 1, 2 ])
 126
 127   expect(data.instance.defaultClientRoute).to.equal('/videos/recently-added')
 128   expect(data.instance.isNSFW).to.be.true
 129   expect(data.instance.defaultNSFWPolicy).to.equal('blur')
 130   expect(data.instance.customizations.javascript).to.equal('alert("coucou")')
 131   expect(data.instance.customizations.css).to.equal('body { background-color: red; }')
 132
 133   expect(data.services.twitter.username).to.equal('@Kuja')
 134   expect(data.services.twitter.whitelisted).to.be.true
 135
 136   expect(data.cache.previews.size).to.equal(2)
 137   expect(data.cache.captions.size).to.equal(3)
 138
 139   expect(data.signup.enabled).to.be.false
 140   expect(data.signup.limit).to.equal(5)
 141   expect(data.signup.requiresEmailVerification).to.be.false
 142
 143   // We override admin email in parallel tests, so skip this exception
 144   if (parallelTests() === false) {
 145     expect(data.admin.email).to.equal('superadmin1@example.com')
 146   }
 147
 148   expect(data.contactForm.enabled).to.be.false
 149
 150   expect(data.user.videoQuota).to.equal(5242881)
 151   expect(data.user.videoQuotaDaily).to.equal(318742)
 152
 153   expect(data.transcoding.enabled).to.be.true
 154   expect(data.transcoding.threads).to.equal(1)
 155   expect(data.transcoding.allowAdditionalExtensions).to.be.true
 156   expect(data.transcoding.allowAudioFiles).to.be.true
 157   expect(data.transcoding.resolutions['240p']).to.be.false
 158   expect(data.transcoding.resolutions['360p']).to.be.true
 159   expect(data.transcoding.resolutions['480p']).to.be.true
 160   expect(data.transcoding.resolutions['720p']).to.be.false
 161   expect(data.transcoding.resolutions['1080p']).to.be.false
 162   expect(data.transcoding.resolutions['2160p']).to.be.false
 163   expect(data.transcoding.hls.enabled).to.be.false
 164   expect(data.transcoding.webtorrent.enabled).to.be.true
 165
 166   expect(data.live.enabled).to.be.true
 167   expect(data.live.allowReplay).to.be.false
 168   expect(data.live.maxDuration).to.equal(5000)
 169   expect(data.live.transcoding.enabled).to.be.true
 170   expect(data.live.transcoding.threads).to.equal(4)
 171   expect(data.live.transcoding.resolutions['240p']).to.be.true
 172   expect(data.live.transcoding.resolutions['360p']).to.be.true
 173   expect(data.live.transcoding.resolutions['480p']).to.be.true
 174   expect(data.live.transcoding.resolutions['720p']).to.be.true
 175   expect(data.live.transcoding.resolutions['1080p']).to.be.true
 176   expect(data.live.transcoding.resolutions['2160p']).to.be.true
 177
 178   expect(data.import.videos.http.enabled).to.be.false
 179   expect(data.import.videos.torrent.enabled).to.be.false
 180   expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.true
 181
 182   expect(data.followers.instance.enabled).to.be.false
 183   expect(data.followers.instance.manualApproval).to.be.true
 184
 185   expect(data.followings.instance.autoFollowBack.enabled).to.be.true
 186   expect(data.followings.instance.autoFollowIndex.enabled).to.be.true
 187   expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('https://updated.example.com')
 188
 189   expect(data.broadcastMessage.enabled).to.be.true
 190   expect(data.broadcastMessage.level).to.equal('error')
 191   expect(data.broadcastMessage.message).to.equal('super bad message')
 192   expect(data.broadcastMessage.dismissable).to.be.true
 193 }
 194
 195 describe('Test config', function () {
 196   let server = null
 197
 198   before(async function () {
 199     this.timeout(30000)
 200
 201     server = await flushAndRunServer(1)
 202     await setAccessTokensToServers([ server ])
 203   })
 204
 205   it('Should have a correct config on a server with registration enabled', async function () {
 206     const res = await getConfig(server.url)
 207     const data: ServerConfig = res.body
 208
 209     expect(data.signup.allowed).to.be.true
 210   })
 211
 212   it('Should have a correct config on a server with registration enabled and a users limit', async function () {
 213     this.timeout(5000)
 214
 215     await Promise.all([
 216       registerUser(server.url, 'user1', 'super password'),
 217       registerUser(server.url, 'user2', 'super password'),
 218       registerUser(server.url, 'user3', 'super password')
 219     ])
 220
 221     const res = await getConfig(server.url)
 222     const data: ServerConfig = res.body
 223
 224     expect(data.signup.allowed).to.be.false
 225   })
 226
 227   it('Should have the correct video allowed extensions', async function () {
 228     const res = await getConfig(server.url)
 229     const data: ServerConfig = res.body
 230
 231     expect(data.video.file.extensions).to.have.lengthOf(3)
 232     expect(data.video.file.extensions).to.contain('.mp4')
 233     expect(data.video.file.extensions).to.contain('.webm')
 234     expect(data.video.file.extensions).to.contain('.ogv')
 235
 236     await uploadVideo(server.url, server.accessToken, { fixture: 'video_short.mkv' }, 400)
 237     await uploadVideo(server.url, server.accessToken, { fixture: 'sample.ogg' }, 400)
 238
 239     expect(data.contactForm.enabled).to.be.true
 240   })
 241
 242   it('Should get the customized configuration', async function () {
 243     const res = await getCustomConfig(server.url, server.accessToken)
 244     const data = res.body as CustomConfig
 245
 246     checkInitialConfig(server, data)
 247   })
 248
 249   it('Should update the customized configuration', async function () {
 250     const newCustomConfig: CustomConfig = {
 251       instance: {
 252         name: 'PeerTube updated',
 253         shortDescription: 'my short description',
 254         description: 'my super description',
 255         terms: 'my super terms',
 256         codeOfConduct: 'my super coc',
 257
 258         creationReason: 'my super creation reason',
 259         moderationInformation: 'my super moderation information',
 260         administrator: 'Kuja',
 261         maintenanceLifetime: 'forever',
 262         businessModel: 'my super business model',
 263         hardwareInformation: '2vCore 3GB RAM',
 264
 265         languages: [ 'en', 'es' ],
 266         categories: [ 1, 2 ],
 267
 268         defaultClientRoute: '/videos/recently-added',
 269         isNSFW: true,
 270         defaultNSFWPolicy: 'blur' as 'blur',
 271         customizations: {
 272           javascript: 'alert("coucou")',
 273           css: 'body { background-color: red; }'
 274         }
 275       },
 276       theme: {
 277         default: 'default'
 278       },
 279       services: {
 280         twitter: {
 281           username: '@Kuja',
 282           whitelisted: true
 283         }
 284       },
 285       cache: {
 286         previews: {
 287           size: 2
 288         },
 289         captions: {
 290           size: 3
 291         }
 292       },
 293       signup: {
 294         enabled: false,
 295         limit: 5,
 296         requiresEmailVerification: false
 297       },
 298       admin: {
 299         email: 'superadmin1@example.com'
 300       },
 301       contactForm: {
 302         enabled: false
 303       },
 304       user: {
 305         videoQuota: 5242881,
 306         videoQuotaDaily: 318742
 307       },
 308       transcoding: {
 309         enabled: true,
 310         allowAdditionalExtensions: true,
 311         allowAudioFiles: true,
 312         threads: 1,
 313         resolutions: {
 314           '0p': false,
 315           '240p': false,
 316           '360p': true,
 317           '480p': true,
 318           '720p': false,
 319           '1080p': false,
 320           '2160p': false
 321         },
 322         webtorrent: {
 323           enabled: true
 324         },
 325         hls: {
 326           enabled: false
 327         }
 328       },
 329       live: {
 330         enabled: true,
 331         allowReplay: false,
 332         maxDuration: 5000,
 333         transcoding: {
 334           enabled: true,
 335           threads: 4,
 336           resolutions: {
 337             '240p': true,
 338             '360p': true,
 339             '480p': true,
 340             '720p': true,
 341             '1080p': true,
 342             '2160p': true
 343           }
 344         }
 345       },
 346       import: {
 347         videos: {
 348           http: {
 349             enabled: false
 350           },
 351           torrent: {
 352             enabled: false
 353           }
 354         }
 355       },
 356       autoBlacklist: {
 357         videos: {
 358           ofUsers: {
 359             enabled: true
 360           }
 361         }
 362       },
 363       followers: {
 364         instance: {
 365           enabled: false,
 366           manualApproval: true
 367         }
 368       },
 369       followings: {
 370         instance: {
 371           autoFollowBack: {
 372             enabled: true
 373           },
 374           autoFollowIndex: {
 375             enabled: true,
 376             indexUrl: 'https://updated.example.com'
 377           }
 378         }
 379       },
 380       broadcastMessage: {
 381         enabled: true,
 382         level: 'error',
 383         message: 'super bad message',
 384         dismissable: true
 385       },
 386       search: {
 387         remoteUri: {
 388           anonymous: true,
 389           users: true
 390         },
 391         searchIndex: {
 392           enabled: true,
 393           url: 'https://search.joinpeertube.org',
 394           disableLocalSearch: true,
 395           isDefaultSearch: true
 396         }
 397       }
 398     }
 399     await updateCustomConfig(server.url, server.accessToken, newCustomConfig)
 400
 401     const res = await getCustomConfig(server.url, server.accessToken)
 402     const data = res.body
 403
 404     checkUpdatedConfig(data)
 405   })
 406
 407   it('Should have the correct updated video allowed extensions', async function () {
 408     this.timeout(10000)
 409
 410     const res = await getConfig(server.url)
 411     const data: ServerConfig = res.body
 412
 413     expect(data.video.file.extensions).to.have.length.above(4)
 414     expect(data.video.file.extensions).to.contain('.mp4')
 415     expect(data.video.file.extensions).to.contain('.webm')
 416     expect(data.video.file.extensions).to.contain('.ogv')
 417     expect(data.video.file.extensions).to.contain('.flv')
 418     expect(data.video.file.extensions).to.contain('.wmv')
 419     expect(data.video.file.extensions).to.contain('.mkv')
 420     expect(data.video.file.extensions).to.contain('.mp3')
 421     expect(data.video.file.extensions).to.contain('.ogg')
 422     expect(data.video.file.extensions).to.contain('.flac')
 423
 424     await uploadVideo(server.url, server.accessToken, { fixture: 'video_short.mkv' }, 200)
 425     await uploadVideo(server.url, server.accessToken, { fixture: 'sample.ogg' }, 200)
 426   })
 427
 428   it('Should have the configuration updated after a restart', async function () {
 429     this.timeout(10000)
 430
 431     killallServers([ server ])
 432
 433     await reRunServer(server)
 434
 435     const res = await getCustomConfig(server.url, server.accessToken)
 436     const data = res.body
 437
 438     checkUpdatedConfig(data)
 439   })
 440
 441   it('Should fetch the about information', async function () {
 442     const res = await getAbout(server.url)
 443     const data: About = res.body
 444
 445     expect(data.instance.name).to.equal('PeerTube updated')
 446     expect(data.instance.shortDescription).to.equal('my short description')
 447     expect(data.instance.description).to.equal('my super description')
 448     expect(data.instance.terms).to.equal('my super terms')
 449     expect(data.instance.codeOfConduct).to.equal('my super coc')
 450
 451     expect(data.instance.creationReason).to.equal('my super creation reason')
 452     expect(data.instance.moderationInformation).to.equal('my super moderation information')
 453     expect(data.instance.administrator).to.equal('Kuja')
 454     expect(data.instance.maintenanceLifetime).to.equal('forever')
 455     expect(data.instance.businessModel).to.equal('my super business model')
 456     expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
 457
 458     expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
 459     expect(data.instance.categories).to.deep.equal([ 1, 2 ])
 460   })
 461
 462   it('Should remove the custom configuration', async function () {
 463     this.timeout(10000)
 464
 465     await deleteCustomConfig(server.url, server.accessToken)
 466
 467     const res = await getCustomConfig(server.url, server.accessToken)
 468     const data = res.body
 469
 470     checkInitialConfig(server, data)
 471   })
 472
 473   after(async function () {
 474     await cleanupTests([ server ])
 475   })
 476 })