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