server/tests/api/server/config.ts

   1 /* tslint:disable:no-unused-expression */
   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   deleteCustomConfig,
   9   getAbout,
  10   killallServers,
  11   reRunServer,
  12   flushTests,
  13   getConfig,
  14   getCustomConfig,
  15   registerUser,
  16   runServer,
  17   setAccessTokensToServers,
  18   updateCustomConfig
  19 } from '../../../../shared/utils'
  20 import { ServerConfig } from '../../../../shared/models'
  21
  22 const expect = chai.expect
  23
  24 function checkInitialConfig (data: CustomConfig) {
  25   expect(data.instance.name).to.equal('PeerTube')
  26   expect(data.instance.shortDescription).to.equal(
  27     'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser ' +
  28     'with WebTorrent and Angular.'
  29   )
  30   expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
  31   expect(data.instance.terms).to.equal('No terms for now.')
  32   expect(data.instance.defaultClientRoute).to.equal('/videos/trending')
  33   expect(data.instance.isNSFW).to.be.false
  34   expect(data.instance.defaultNSFWPolicy).to.equal('display')
  35   expect(data.instance.customizations.css).to.be.empty
  36   expect(data.instance.customizations.javascript).to.be.empty
  37
  38   expect(data.services.twitter.username).to.equal('@Chocobozzz')
  39   expect(data.services.twitter.whitelisted).to.be.false
  40
  41   expect(data.cache.previews.size).to.equal(1)
  42   expect(data.cache.captions.size).to.equal(1)
  43
  44   expect(data.signup.enabled).to.be.true
  45   expect(data.signup.limit).to.equal(4)
  46   expect(data.signup.requiresEmailVerification).to.be.false
  47
  48   expect(data.admin.email).to.equal('admin1@example.com')
  49   expect(data.contactForm.enabled).to.be.true
  50
  51   expect(data.user.videoQuota).to.equal(5242880)
  52   expect(data.user.videoQuotaDaily).to.equal(-1)
  53   expect(data.transcoding.enabled).to.be.false
  54   expect(data.transcoding.allowAdditionalExtensions).to.be.false
  55   expect(data.transcoding.threads).to.equal(2)
  56   expect(data.transcoding.resolutions['240p']).to.be.true
  57   expect(data.transcoding.resolutions['360p']).to.be.true
  58   expect(data.transcoding.resolutions['480p']).to.be.true
  59   expect(data.transcoding.resolutions['720p']).to.be.true
  60   expect(data.transcoding.resolutions['1080p']).to.be.true
  61   expect(data.transcoding.hls.enabled).to.be.true
  62
  63   expect(data.import.videos.http.enabled).to.be.true
  64   expect(data.import.videos.torrent.enabled).to.be.true
  65 }
  66
  67 function checkUpdatedConfig (data: CustomConfig) {
  68   expect(data.instance.name).to.equal('PeerTube updated')
  69   expect(data.instance.shortDescription).to.equal('my short description')
  70   expect(data.instance.description).to.equal('my super description')
  71   expect(data.instance.terms).to.equal('my super terms')
  72   expect(data.instance.defaultClientRoute).to.equal('/videos/recently-added')
  73   expect(data.instance.isNSFW).to.be.true
  74   expect(data.instance.defaultNSFWPolicy).to.equal('blur')
  75   expect(data.instance.customizations.javascript).to.equal('alert("coucou")')
  76   expect(data.instance.customizations.css).to.equal('body { background-color: red; }')
  77
  78   expect(data.services.twitter.username).to.equal('@Kuja')
  79   expect(data.services.twitter.whitelisted).to.be.true
  80
  81   expect(data.cache.previews.size).to.equal(2)
  82   expect(data.cache.captions.size).to.equal(3)
  83
  84   expect(data.signup.enabled).to.be.false
  85   expect(data.signup.limit).to.equal(5)
  86   expect(data.signup.requiresEmailVerification).to.be.false
  87
  88   expect(data.admin.email).to.equal('superadmin1@example.com')
  89   expect(data.contactForm.enabled).to.be.false
  90
  91   expect(data.user.videoQuota).to.equal(5242881)
  92   expect(data.user.videoQuotaDaily).to.equal(318742)
  93
  94   expect(data.transcoding.enabled).to.be.true
  95   expect(data.transcoding.threads).to.equal(1)
  96   expect(data.transcoding.allowAdditionalExtensions).to.be.true
  97   expect(data.transcoding.resolutions['240p']).to.be.false
  98   expect(data.transcoding.resolutions['360p']).to.be.true
  99   expect(data.transcoding.resolutions['480p']).to.be.true
 100   expect(data.transcoding.resolutions['720p']).to.be.false
 101   expect(data.transcoding.resolutions['1080p']).to.be.false
 102   expect(data.transcoding.hls.enabled).to.be.false
 103
 104   expect(data.import.videos.http.enabled).to.be.false
 105   expect(data.import.videos.torrent.enabled).to.be.false
 106 }
 107
 108 describe('Test config', function () {
 109   let server = null
 110
 111   before(async function () {
 112     this.timeout(30000)
 113
 114     await flushTests()
 115     server = await runServer(1)
 116     await setAccessTokensToServers([ server ])
 117   })
 118
 119   it('Should have a correct config on a server with registration enabled', async function () {
 120     const res = await getConfig(server.url)
 121     const data: ServerConfig = res.body
 122
 123     expect(data.signup.allowed).to.be.true
 124   })
 125
 126   it('Should have a correct config on a server with registration enabled and a users limit', async function () {
 127     this.timeout(5000)
 128
 129     await Promise.all([
 130       registerUser(server.url, 'user1', 'super password'),
 131       registerUser(server.url, 'user2', 'super password'),
 132       registerUser(server.url, 'user3', 'super password')
 133     ])
 134
 135     const res = await getConfig(server.url)
 136     const data: ServerConfig = res.body
 137
 138     expect(data.signup.allowed).to.be.false
 139   })
 140
 141   it('Should have the correct video allowed extensions', async function () {
 142     const res = await getConfig(server.url)
 143     const data: ServerConfig = res.body
 144
 145     expect(data.video.file.extensions).to.have.lengthOf(3)
 146     expect(data.video.file.extensions).to.contain('.mp4')
 147     expect(data.video.file.extensions).to.contain('.webm')
 148     expect(data.video.file.extensions).to.contain('.ogv')
 149
 150     expect(data.contactForm.enabled).to.be.true
 151   })
 152
 153   it('Should get the customized configuration', async function () {
 154     const res = await getCustomConfig(server.url, server.accessToken)
 155     const data = res.body as CustomConfig
 156
 157     checkInitialConfig(data)
 158   })
 159
 160   it('Should update the customized configuration', async function () {
 161     const newCustomConfig: CustomConfig = {
 162       instance: {
 163         name: 'PeerTube updated',
 164         shortDescription: 'my short description',
 165         description: 'my super description',
 166         terms: 'my super terms',
 167         defaultClientRoute: '/videos/recently-added',
 168         isNSFW: true,
 169         defaultNSFWPolicy: 'blur' as 'blur',
 170         customizations: {
 171           javascript: 'alert("coucou")',
 172           css: 'body { background-color: red; }'
 173         }
 174       },
 175       services: {
 176         twitter: {
 177           username: '@Kuja',
 178           whitelisted: true
 179         }
 180       },
 181       cache: {
 182         previews: {
 183           size: 2
 184         },
 185         captions: {
 186           size: 3
 187         }
 188       },
 189       signup: {
 190         enabled: false,
 191         limit: 5,
 192         requiresEmailVerification: false
 193       },
 194       admin: {
 195         email: 'superadmin1@example.com'
 196       },
 197       contactForm: {
 198         enabled: false
 199       },
 200       user: {
 201         videoQuota: 5242881,
 202         videoQuotaDaily: 318742
 203       },
 204       transcoding: {
 205         enabled: true,
 206         allowAdditionalExtensions: true,
 207         threads: 1,
 208         resolutions: {
 209           '240p': false,
 210           '360p': true,
 211           '480p': true,
 212           '720p': false,
 213           '1080p': false
 214         },
 215         hls: {
 216           enabled: false
 217         }
 218       },
 219       import: {
 220         videos: {
 221           http: {
 222             enabled: false
 223           },
 224           torrent: {
 225             enabled: false
 226           }
 227         }
 228       }
 229     }
 230     await updateCustomConfig(server.url, server.accessToken, newCustomConfig)
 231
 232     const res = await getCustomConfig(server.url, server.accessToken)
 233     const data = res.body
 234
 235     checkUpdatedConfig(data)
 236   })
 237
 238   it('Should have the correct updated video allowed extensions', async function () {
 239     const res = await getConfig(server.url)
 240     const data: ServerConfig = res.body
 241
 242     expect(data.video.file.extensions).to.have.length.above(3)
 243     expect(data.video.file.extensions).to.contain('.mp4')
 244     expect(data.video.file.extensions).to.contain('.webm')
 245     expect(data.video.file.extensions).to.contain('.ogv')
 246     expect(data.video.file.extensions).to.contain('.flv')
 247     expect(data.video.file.extensions).to.contain('.mkv')
 248   })
 249
 250   it('Should have the configuration updated after a restart', async function () {
 251     this.timeout(10000)
 252
 253     killallServers([ server ])
 254
 255     await reRunServer(server)
 256
 257     const res = await getCustomConfig(server.url, server.accessToken)
 258     const data = res.body
 259
 260     checkUpdatedConfig(data)
 261   })
 262
 263   it('Should fetch the about information', async function () {
 264     const res = await getAbout(server.url)
 265     const data: About = res.body
 266
 267     expect(data.instance.name).to.equal('PeerTube updated')
 268     expect(data.instance.shortDescription).to.equal('my short description')
 269     expect(data.instance.description).to.equal('my super description')
 270     expect(data.instance.terms).to.equal('my super terms')
 271   })
 272
 273   it('Should remove the custom configuration', async function () {
 274     this.timeout(10000)
 275
 276     await deleteCustomConfig(server.url, server.accessToken)
 277
 278     const res = await getCustomConfig(server.url, server.accessToken)
 279     const data = res.body
 280
 281     checkInitialConfig(data)
 282   })
 283
 284   after(async function () {
 285     killallServers([ server ])
 286   })
 287 })