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 { deleteCustomConfig, getAbout, killallServers, reRunServer } from '../../utils'
   8 import {
   9   flushTests,
  10   getConfig,
  11   getCustomConfig,
  12   registerUser,
  13   runServer,
  14   setAccessTokensToServers,
  15   updateCustomConfig
  16 } from '../../utils/index'
  17
  18 const expect = chai.expect
  19
  20 function checkInitialConfig (data: CustomConfig) {
  21   expect(data.instance.name).to.equal('PeerTube')
  22   expect(data.instance.shortDescription).to.equal(
  23     'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser ' +
  24     'with WebTorrent and Angular.'
  25   )
  26   expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
  27   expect(data.instance.terms).to.equal('No terms for now.')
  28   expect(data.instance.defaultClientRoute).to.equal('/videos/trending')
  29   expect(data.instance.defaultNSFWPolicy).to.equal('display')
  30   expect(data.instance.customizations.css).to.be.empty
  31   expect(data.instance.customizations.javascript).to.be.empty
  32   expect(data.services.twitter.username).to.equal('@Chocobozzz')
  33   expect(data.services.twitter.whitelisted).to.be.false
  34   expect(data.cache.previews.size).to.equal(1)
  35   expect(data.cache.captions.size).to.equal(1)
  36   expect(data.signup.enabled).to.be.true
  37   expect(data.signup.limit).to.equal(4)
  38   expect(data.admin.email).to.equal('admin1@example.com')
  39   expect(data.user.videoQuota).to.equal(5242880)
  40   expect(data.transcoding.enabled).to.be.false
  41   expect(data.transcoding.threads).to.equal(2)
  42   expect(data.transcoding.resolutions['240p']).to.be.true
  43   expect(data.transcoding.resolutions['360p']).to.be.true
  44   expect(data.transcoding.resolutions['480p']).to.be.true
  45   expect(data.transcoding.resolutions['720p']).to.be.true
  46   expect(data.transcoding.resolutions['1080p']).to.be.true
  47 }
  48
  49 function checkUpdatedConfig (data: CustomConfig) {
  50   expect(data.instance.name).to.equal('PeerTube updated')
  51   expect(data.instance.shortDescription).to.equal('my short description')
  52   expect(data.instance.description).to.equal('my super description')
  53   expect(data.instance.terms).to.equal('my super terms')
  54   expect(data.instance.defaultClientRoute).to.equal('/videos/recently-added')
  55   expect(data.instance.defaultNSFWPolicy).to.equal('blur')
  56   expect(data.instance.customizations.javascript).to.equal('alert("coucou")')
  57   expect(data.instance.customizations.css).to.equal('body { background-color: red; }')
  58   expect(data.services.twitter.username).to.equal('@Kuja')
  59   expect(data.services.twitter.whitelisted).to.be.true
  60   expect(data.cache.previews.size).to.equal(2)
  61   expect(data.cache.captions.size).to.equal(3)
  62   expect(data.signup.enabled).to.be.false
  63   expect(data.signup.limit).to.equal(5)
  64   expect(data.admin.email).to.equal('superadmin1@example.com')
  65   expect(data.user.videoQuota).to.equal(5242881)
  66   expect(data.transcoding.enabled).to.be.true
  67   expect(data.transcoding.threads).to.equal(1)
  68   expect(data.transcoding.resolutions['240p']).to.be.false
  69   expect(data.transcoding.resolutions['360p']).to.be.true
  70   expect(data.transcoding.resolutions['480p']).to.be.true
  71   expect(data.transcoding.resolutions['720p']).to.be.false
  72   expect(data.transcoding.resolutions['1080p']).to.be.false
  73 }
  74
  75 describe('Test config', function () {
  76   let server = null
  77
  78   before(async function () {
  79     this.timeout(30000)
  80
  81     await flushTests()
  82     server = await runServer(1)
  83     await setAccessTokensToServers([ server ])
  84   })
  85
  86   it('Should have a correct config on a server with registration enabled', async function () {
  87     const res = await getConfig(server.url)
  88     const data = res.body
  89
  90     expect(data.signup.allowed).to.be.true
  91   })
  92
  93   it('Should have a correct config on a server with registration enabled and a users limit', async function () {
  94     this.timeout(5000)
  95
  96     await Promise.all([
  97       registerUser(server.url, 'user1', 'super password'),
  98       registerUser(server.url, 'user2', 'super password'),
  99       registerUser(server.url, 'user3', 'super password')
 100     ])
 101
 102     const res = await getConfig(server.url)
 103     const data = res.body
 104
 105     expect(data.signup.allowed).to.be.false
 106   })
 107
 108   it('Should get the customized configuration', async function () {
 109     const res = await getCustomConfig(server.url, server.accessToken)
 110     const data = res.body as CustomConfig
 111
 112     checkInitialConfig(data)
 113   })
 114
 115   it('Should update the customized configuration', async function () {
 116     const newCustomConfig: CustomConfig = {
 117       instance: {
 118         name: 'PeerTube updated',
 119         shortDescription: 'my short description',
 120         description: 'my super description',
 121         terms: 'my super terms',
 122         defaultClientRoute: '/videos/recently-added',
 123         defaultNSFWPolicy: 'blur' as 'blur',
 124         customizations: {
 125           javascript: 'alert("coucou")',
 126           css: 'body { background-color: red; }'
 127         }
 128       },
 129       services: {
 130         twitter: {
 131           username: '@Kuja',
 132           whitelisted: true
 133         }
 134       },
 135       cache: {
 136         previews: {
 137           size: 2
 138         },
 139         captions: {
 140           size: 3
 141         }
 142       },
 143       signup: {
 144         enabled: false,
 145         limit: 5
 146       },
 147       admin: {
 148         email: 'superadmin1@example.com'
 149       },
 150       user: {
 151         videoQuota: 5242881
 152       },
 153       transcoding: {
 154         enabled: true,
 155         threads: 1,
 156         resolutions: {
 157           '240p': false,
 158           '360p': true,
 159           '480p': true,
 160           '720p': false,
 161           '1080p': false
 162         }
 163       }
 164     }
 165     await updateCustomConfig(server.url, server.accessToken, newCustomConfig)
 166
 167     const res = await getCustomConfig(server.url, server.accessToken)
 168     const data = res.body
 169
 170     checkUpdatedConfig(data)
 171   })
 172
 173   it('Should have the configuration updated after a restart', async function () {
 174     this.timeout(10000)
 175
 176     killallServers([ server ])
 177
 178     await reRunServer(server)
 179
 180     const res = await getCustomConfig(server.url, server.accessToken)
 181     const data = res.body
 182
 183     checkUpdatedConfig(data)
 184   })
 185
 186   it('Should fetch the about information', async function () {
 187     const res = await getAbout(server.url)
 188     const data: About = res.body
 189
 190     expect(data.instance.name).to.equal('PeerTube updated')
 191     expect(data.instance.shortDescription).to.equal('my short description')
 192     expect(data.instance.description).to.equal('my super description')
 193     expect(data.instance.terms).to.equal('my super terms')
 194   })
 195
 196   it('Should remove the custom configuration', async function () {
 197     this.timeout(10000)
 198
 199     await deleteCustomConfig(server.url, server.accessToken)
 200
 201     const res = await getCustomConfig(server.url, server.accessToken)
 202     const data = res.body
 203
 204     checkInitialConfig(data)
 205   })
 206
 207   after(async function () {
 208     killallServers([ server ])
 209   })
 210 })