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.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
  82
  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
  97
  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
 101
 102   expect(data.followers.instance.enabled).to.be.true
 103   expect(data.followers.instance.manualApproval).to.be.false
 104
 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('')
 108
 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
 113 }
 114
 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')
 119
 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')
 128
 129   expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
 130   expect(data.instance.categories).to.deep.equal([ 1, 2 ])
 131
 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; }')
 137
 138   expect(data.services.twitter.username).to.equal('@Kuja')
 139   expect(data.services.twitter.whitelisted).to.be.true
 140
 141   expect(data.cache.previews.size).to.equal(2)
 142   expect(data.cache.captions.size).to.equal(3)
 143
 144   expect(data.signup.enabled).to.be.false
 145   expect(data.signup.limit).to.equal(5)
 146   expect(data.signup.requiresEmailVerification).to.be.false
 147
 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')
 151   }
 152
 153   expect(data.contactForm.enabled).to.be.false
 154
 155   expect(data.user.videoQuota).to.equal(5242881)
 156   expect(data.user.videoQuotaDaily).to.equal(318742)
 157
 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
 170
 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
 184
 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
 188
 189   expect(data.followers.instance.enabled).to.be.false
 190   expect(data.followers.instance.manualApproval).to.be.true
 191
 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')
 195
 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
 200 }
 201
 202 describe('Test config', function () {
 203   let server = null
 204
 205   before(async function () {
 206     this.timeout(30000)
 207
 208     server = await flushAndRunServer(1)
 209     await setAccessTokensToServers([ server ])
 210   })
 211
 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
 215
 216     expect(data.signup.allowed).to.be.true
 217   })
 218
 219   it('Should have a correct config on a server with registration enabled and a users limit', async function () {
 220     this.timeout(5000)
 221
 222     await Promise.all([
 223       registerUser(server.url, 'user1', 'super password'),
 224       registerUser(server.url, 'user2', 'super password'),
 225       registerUser(server.url, 'user3', 'super password')
 226     ])
 227
 228     const res = await getConfig(server.url)
 229     const data: ServerConfig = res.body
 230
 231     expect(data.signup.allowed).to.be.false
 232   })
 233
 234   it('Should have the correct video allowed extensions', async function () {
 235     const res = await getConfig(server.url)
 236     const data: ServerConfig = res.body
 237
 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')
 242
 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)
 245
 246     expect(data.contactForm.enabled).to.be.true
 247   })
 248
 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
 252
 253     checkInitialConfig(server, data)
 254   })
 255
 256   it('Should update the customized configuration', async function () {
 257     const newCustomConfig: CustomConfig = {
 258       instance: {
 259         name: 'PeerTube updated',
 260         shortDescription: 'my short description',
 261         description: 'my super description',
 262         terms: 'my super terms',
 263         codeOfConduct: 'my super coc',
 264
 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',
 271
 272         languages: [ 'en', 'es' ],
 273         categories: [ 1, 2 ],
 274
 275         isNSFW: true,
 276         defaultNSFWPolicy: 'blur' as 'blur',
 277
 278         defaultClientRoute: '/videos/recently-added',
 279
 280         customizations: {
 281           javascript: 'alert("coucou")',
 282           css: 'body { background-color: red; }'
 283         }
 284       },
 285       theme: {
 286         default: 'default'
 287       },
 288       services: {
 289         twitter: {
 290           username: '@Kuja',
 291           whitelisted: true
 292         }
 293       },
 294       cache: {
 295         previews: {
 296           size: 2
 297         },
 298         captions: {
 299           size: 3
 300         }
 301       },
 302       signup: {
 303         enabled: false,
 304         limit: 5,
 305         requiresEmailVerification: false
 306       },
 307       admin: {
 308         email: 'superadmin1@example.com'
 309       },
 310       contactForm: {
 311         enabled: false
 312       },
 313       user: {
 314         videoQuota: 5242881,
 315         videoQuotaDaily: 318742
 316       },
 317       transcoding: {
 318         enabled: true,
 319         allowAdditionalExtensions: true,
 320         allowAudioFiles: true,
 321         threads: 1,
 322         resolutions: {
 323           '0p': false,
 324           '240p': false,
 325           '360p': true,
 326           '480p': true,
 327           '720p': false,
 328           '1080p': false,
 329           '1440p': false,
 330           '2160p': false
 331         },
 332         webtorrent: {
 333           enabled: true
 334         },
 335         hls: {
 336           enabled: false
 337         }
 338       },
 339       live: {
 340         enabled: true,
 341         allowReplay: true,
 342         maxDuration: 5000,
 343         maxInstanceLives: -1,
 344         maxUserLives: 10,
 345         transcoding: {
 346           enabled: true,
 347           threads: 4,
 348           resolutions: {
 349             '240p': true,
 350             '360p': true,
 351             '480p': true,
 352             '720p': true,
 353             '1080p': true,
 354             '1440p': true,
 355             '2160p': true
 356           }
 357         }
 358       },
 359       import: {
 360         videos: {
 361           http: {
 362             enabled: false
 363           },
 364           torrent: {
 365             enabled: false
 366           }
 367         }
 368       },
 369       trending: {
 370         videos: {
 371           algorithms: {
 372             enabled: [ 'hot', 'most-viewed', 'most-liked' ],
 373             default: 'hot'
 374           }
 375         }
 376       },
 377       autoBlacklist: {
 378         videos: {
 379           ofUsers: {
 380             enabled: true
 381           }
 382         }
 383       },
 384       followers: {
 385         instance: {
 386           enabled: false,
 387           manualApproval: true
 388         }
 389       },
 390       followings: {
 391         instance: {
 392           autoFollowBack: {
 393             enabled: true
 394           },
 395           autoFollowIndex: {
 396             enabled: true,
 397             indexUrl: 'https://updated.example.com'
 398           }
 399         }
 400       },
 401       broadcastMessage: {
 402         enabled: true,
 403         level: 'error',
 404         message: 'super bad message',
 405         dismissable: true
 406       },
 407       search: {
 408         remoteUri: {
 409           anonymous: true,
 410           users: true
 411         },
 412         searchIndex: {
 413           enabled: true,
 414           url: 'https://search.joinpeertube.org',
 415           disableLocalSearch: true,
 416           isDefaultSearch: true
 417         }
 418       }
 419     }
 420     await updateCustomConfig(server.url, server.accessToken, newCustomConfig)
 421
 422     const res = await getCustomConfig(server.url, server.accessToken)
 423     const data = res.body
 424
 425     checkUpdatedConfig(data)
 426   })
 427
 428   it('Should have the correct updated video allowed extensions', async function () {
 429     this.timeout(10000)
 430
 431     const res = await getConfig(server.url)
 432     const data: ServerConfig = res.body
 433
 434     expect(data.video.file.extensions).to.have.length.above(4)
 435     expect(data.video.file.extensions).to.contain('.mp4')
 436     expect(data.video.file.extensions).to.contain('.webm')
 437     expect(data.video.file.extensions).to.contain('.ogv')
 438     expect(data.video.file.extensions).to.contain('.flv')
 439     expect(data.video.file.extensions).to.contain('.wmv')
 440     expect(data.video.file.extensions).to.contain('.mkv')
 441     expect(data.video.file.extensions).to.contain('.mp3')
 442     expect(data.video.file.extensions).to.contain('.ogg')
 443     expect(data.video.file.extensions).to.contain('.flac')
 444
 445     await uploadVideo(server.url, server.accessToken, { fixture: 'video_short.mkv' }, HttpStatusCode.OK_200)
 446     await uploadVideo(server.url, server.accessToken, { fixture: 'sample.ogg' }, HttpStatusCode.OK_200)
 447   })
 448
 449   it('Should have the configuration updated after a restart', async function () {
 450     this.timeout(10000)
 451
 452     killallServers([ server ])
 453
 454     await reRunServer(server)
 455
 456     const res = await getCustomConfig(server.url, server.accessToken)
 457     const data = res.body
 458
 459     checkUpdatedConfig(data)
 460   })
 461
 462   it('Should fetch the about information', async function () {
 463     const res = await getAbout(server.url)
 464     const data: About = res.body
 465
 466     expect(data.instance.name).to.equal('PeerTube updated')
 467     expect(data.instance.shortDescription).to.equal('my short description')
 468     expect(data.instance.description).to.equal('my super description')
 469     expect(data.instance.terms).to.equal('my super terms')
 470     expect(data.instance.codeOfConduct).to.equal('my super coc')
 471
 472     expect(data.instance.creationReason).to.equal('my super creation reason')
 473     expect(data.instance.moderationInformation).to.equal('my super moderation information')
 474     expect(data.instance.administrator).to.equal('Kuja')
 475     expect(data.instance.maintenanceLifetime).to.equal('forever')
 476     expect(data.instance.businessModel).to.equal('my super business model')
 477     expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
 478
 479     expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
 480     expect(data.instance.categories).to.deep.equal([ 1, 2 ])
 481   })
 482
 483   it('Should remove the custom configuration', async function () {
 484     this.timeout(10000)
 485
 486     await deleteCustomConfig(server.url, server.accessToken)
 487
 488     const res = await getCustomConfig(server.url, server.accessToken)
 489     const data = res.body
 490
 491     checkInitialConfig(server, data)
 492   })
 493
 494   after(async function () {
 495     await cleanupTests([ server ])
 496   })
 497 })