1 /* tslint:disable:no-unused-expression */
3 import { ChildProcess, exec, fork } from 'child_process'
4 import { join } from 'path'
5 import { root, wait } from '../miscs/miscs'
6 import { copy, pathExists, readdir, readFile, remove } from 'fs-extra'
7 import { existsSync } from 'fs'
8 import { expect } from 'chai'
9 import { VideoChannel } from '../../models/videos'
10 import { randomInt } from '../../core-utils/miscs/miscs'
12 interface ServerInfo {
19 internalServerNumber: number
33 customConfigFile?: string
36 videoChannel?: VideoChannel
52 videos?: { id: number, uuid: string }[]
55 function parallelTests () {
56 return process.env.MOCHA_PARALLEL === 'true'
59 function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
63 return new Promise<ServerInfo[]>(res => {
64 function anotherServerDone (serverNumber, app) {
65 apps[serverNumber - 1] = app
67 if (i === totalServers) {
72 for (let j = 1; j <= totalServers; j++) {
73 flushAndRunServer(j, configOverride).then(app => anotherServerDone(j, app))
78 function flushTests (serverNumber?: number) {
79 return new Promise<void>((res, rej) => {
80 const suffix = serverNumber ? ` -- ${serverNumber}` : ''
82 return exec('npm run clean:server:test' + suffix, (err, _stdout, stderr) => {
83 if (err || stderr) return rej(err || new Error(stderr))
90 function randomServer () {
94 return randomInt(low, high)
97 async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = []) {
98 const parallel = parallelTests()
100 const internalServerNumber = parallel ? randomServer() : serverNumber
101 const port = 9000 + internalServerNumber
103 await flushTests(internalServerNumber)
105 const server: ServerInfo = {
108 internalServerNumber,
111 url: `http://localhost:${port}`,
112 host: `localhost:${port}`,
123 return runServer(server, configOverride, args)
126 async function runServer (server: ServerInfo, configOverrideArg?: any, args = []) {
127 // These actions are async so we need to be sure that they have both been done
128 const serverRunString = {
129 'Server listening': false
131 const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
132 serverRunString[key] = false
135 client_id: 'Client id: (.+)',
136 client_secret: 'Client secret: (.+)',
137 user_username: 'Username: (.+)',
138 user_password: 'User password: (.+)'
141 if (server.internalServerNumber !== server.serverNumber) {
142 const basePath = join(root(), 'config')
144 const tmpConfigFile = join(basePath, `test-${server.internalServerNumber}.yaml`)
145 await copy(join(basePath, `test-${server.serverNumber}.yaml`), tmpConfigFile)
147 server.customConfigFile = tmpConfigFile
150 const configOverride: any = {}
152 if (server.parallel) {
153 Object.assign(configOverride, {
161 suffix: '_test' + server.internalServerNumber
164 tmp: `test${server.internalServerNumber}/tmp/`,
165 avatars: `test${server.internalServerNumber}/avatars/`,
166 videos: `test${server.internalServerNumber}/videos/`,
167 streaming_playlists: `test${server.internalServerNumber}/streaming-playlists/`,
168 redundancy: `test${server.internalServerNumber}/redundancy/`,
169 logs: `test${server.internalServerNumber}/logs/`,
170 previews: `test${server.internalServerNumber}/previews/`,
171 thumbnails: `test${server.internalServerNumber}/thumbnails/`,
172 torrents: `test${server.internalServerNumber}/torrents/`,
173 captions: `test${server.internalServerNumber}/captions/`,
174 cache: `test${server.internalServerNumber}/cache/`,
175 plugins: `test${server.internalServerNumber}/plugins/`
178 email: `admin${server.internalServerNumber}@example.com`
183 if (configOverrideArg !== undefined) {
184 Object.assign(configOverride, configOverrideArg)
187 // Share the environment
188 const env = Object.create(process.env)
189 env['NODE_ENV'] = 'test'
190 env['NODE_APP_INSTANCE'] = server.internalServerNumber.toString()
191 env['NODE_CONFIG'] = JSON.stringify(configOverride)
199 return new Promise<ServerInfo>(res => {
200 server.app = fork(join(root(), 'dist', 'server.js'), args, options)
201 server.app.stdout.on('data', function onStdout (data) {
202 let dontContinue = false
204 // Capture things if we want to
205 for (const key of Object.keys(regexps)) {
206 const regexp = regexps[ key ]
207 const matches = data.toString().match(regexp)
208 if (matches !== null) {
209 if (key === 'client_id') server.client.id = matches[ 1 ]
210 else if (key === 'client_secret') server.client.secret = matches[ 1 ]
211 else if (key === 'user_username') server.user.username = matches[ 1 ]
212 else if (key === 'user_password') server.user.password = matches[ 1 ]
216 // Check if all required sentences are here
217 for (const key of Object.keys(serverRunString)) {
218 if (data.toString().indexOf(key) !== -1) serverRunString[ key ] = true
219 if (serverRunString[ key ] === false) dontContinue = true
222 // If no, there is maybe one thing not already initialized (client/user credentials generation...)
223 if (dontContinue === true) return
225 server.app.stdout.removeListener('data', onStdout)
227 process.on('exit', () => {
229 process.kill(server.app.pid)
230 } catch { /* empty */ }
238 async function reRunServer (server: ServerInfo, configOverride?: any) {
239 const newServer = await runServer(server, configOverride)
240 server.app = newServer.app
245 function checkTmpIsEmpty (server: ServerInfo) {
246 return checkDirectoryIsEmpty(server, 'tmp', [ 'plugins-global.css' ])
249 async function checkDirectoryIsEmpty (server: ServerInfo, directory: string, exceptions: string[] = []) {
250 const testDirectory = 'test' + server.internalServerNumber
252 const directoryPath = join(root(), testDirectory, directory)
254 const directoryExists = await pathExists(directoryPath)
255 expect(directoryExists).to.be.true
257 const files = await readdir(directoryPath)
258 const filtered = files.filter(f => exceptions.includes(f) === false)
260 expect(filtered).to.have.lengthOf(0)
263 function killallServers (servers: ServerInfo[]) {
264 for (const server of servers) {
265 if (!server.app) continue
267 process.kill(-server.app.pid)
272 function cleanupTests (servers: ServerInfo[]) {
273 killallServers(servers)
275 const p: Promise<any>[] = []
276 for (const server of servers) {
277 if (server.parallel) {
278 p.push(flushTests(server.internalServerNumber))
281 if (server.customConfigFile) {
282 p.push(remove(server.customConfigFile))
286 return Promise.all(p)
289 async function waitUntilLog (server: ServerInfo, str: string, count = 1) {
290 const logfile = join(root(), 'test' + server.internalServerNumber, 'logs/peertube.log')
293 const buf = await readFile(logfile)
295 const matches = buf.toString().match(new RegExp(str, 'g'))
296 if (matches && matches.length === count) return
302 // ---------------------------------------------------------------------------
305 checkDirectoryIsEmpty,
310 flushAndRunMultipleServers,