1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
3 import { expect } from 'chai'
4 import { ChildProcess, exec, fork } from 'child_process'
5 import { copy, ensureDir, pathExists, readdir, readFile, remove } from 'fs-extra'
6 import { join } from 'path'
7 import { randomInt } from '../../core-utils/miscs/miscs'
8 import { VideoChannel } from '../../models/videos'
9 import { buildServerDirectory, getFileSize, isGithubCI, root, wait } from '../miscs/miscs'
10 import { makeGetRequest } from '../requests/requests'
12 interface ServerInfo {
23 internalServerNumber: number
37 customConfigFile?: string
40 videoChannel?: VideoChannel
57 videos?: { id: number, uuid: string }[]
60 function parallelTests () {
61 return process.env.MOCHA_PARALLEL === 'true'
64 function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
68 return new Promise<ServerInfo[]>(res => {
69 function anotherServerDone (serverNumber, app) {
70 apps[serverNumber - 1] = app
72 if (i === totalServers) {
77 for (let j = 1; j <= totalServers; j++) {
78 flushAndRunServer(j, configOverride).then(app => anotherServerDone(j, app))
83 function flushTests (serverNumber?: number) {
84 return new Promise<void>((res, rej) => {
85 const suffix = serverNumber ? ` -- ${serverNumber}` : ''
87 return exec('npm run clean:server:test' + suffix, (err, _stdout, stderr) => {
88 if (err || stderr) return rej(err || new Error(stderr))
95 function randomServer () {
99 return randomInt(low, high)
102 function randomRTMP () {
106 return randomInt(low, high)
109 type RunServerOptions = {
114 async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = [], options: RunServerOptions = {}) {
115 const parallel = parallelTests()
117 const internalServerNumber = parallel ? randomServer() : serverNumber
118 const rtmpPort = parallel ? randomRTMP() : 1936
119 const port = 9000 + internalServerNumber
121 await flushTests(internalServerNumber)
123 const server: ServerInfo = {
126 internalServerNumber,
130 url: `http://localhost:${port}`,
131 host: `localhost:${port}`,
132 hostname: 'localhost',
143 return runServer(server, configOverride, args, options)
146 async function runServer (server: ServerInfo, configOverrideArg?: any, args = [], options: RunServerOptions = {}) {
147 // These actions are async so we need to be sure that they have both been done
148 const serverRunString = {
149 'HTTP server listening': false
151 const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
152 serverRunString[key] = false
155 client_id: 'Client id: (.+)',
156 client_secret: 'Client secret: (.+)',
157 user_username: 'Username: (.+)',
158 user_password: 'User password: (.+)'
161 if (server.internalServerNumber !== server.serverNumber) {
162 const basePath = join(root(), 'config')
164 const tmpConfigFile = join(basePath, `test-${server.internalServerNumber}.yaml`)
165 await copy(join(basePath, `test-${server.serverNumber}.yaml`), tmpConfigFile)
167 server.customConfigFile = tmpConfigFile
170 const configOverride: any = {}
172 if (server.parallel) {
173 Object.assign(configOverride, {
181 suffix: '_test' + server.internalServerNumber
184 tmp: `test${server.internalServerNumber}/tmp/`,
185 avatars: `test${server.internalServerNumber}/avatars/`,
186 videos: `test${server.internalServerNumber}/videos/`,
187 streaming_playlists: `test${server.internalServerNumber}/streaming-playlists/`,
188 redundancy: `test${server.internalServerNumber}/redundancy/`,
189 logs: `test${server.internalServerNumber}/logs/`,
190 previews: `test${server.internalServerNumber}/previews/`,
191 thumbnails: `test${server.internalServerNumber}/thumbnails/`,
192 torrents: `test${server.internalServerNumber}/torrents/`,
193 captions: `test${server.internalServerNumber}/captions/`,
194 cache: `test${server.internalServerNumber}/cache/`,
195 plugins: `test${server.internalServerNumber}/plugins/`
198 email: `admin${server.internalServerNumber}@example.com`
202 port: server.rtmpPort
208 if (configOverrideArg !== undefined) {
209 Object.assign(configOverride, configOverrideArg)
212 // Share the environment
213 const env = Object.create(process.env)
214 env['NODE_ENV'] = 'test'
215 env['NODE_APP_INSTANCE'] = server.internalServerNumber.toString()
216 env['NODE_CONFIG'] = JSON.stringify(configOverride)
218 const forkOptions = {
222 execArgv: options.execArgv || []
225 return new Promise<ServerInfo>(res => {
226 server.app = fork(join(root(), 'dist', 'server.js'), args, forkOptions)
227 server.app.stdout.on('data', function onStdout (data) {
228 let dontContinue = false
230 // Capture things if we want to
231 for (const key of Object.keys(regexps)) {
232 const regexp = regexps[key]
233 const matches = data.toString().match(regexp)
234 if (matches !== null) {
235 if (key === 'client_id') server.client.id = matches[1]
236 else if (key === 'client_secret') server.client.secret = matches[1]
237 else if (key === 'user_username') server.user.username = matches[1]
238 else if (key === 'user_password') server.user.password = matches[1]
242 // Check if all required sentences are here
243 for (const key of Object.keys(serverRunString)) {
244 if (data.toString().indexOf(key) !== -1) serverRunString[key] = true
245 if (serverRunString[key] === false) dontContinue = true
248 // If no, there is maybe one thing not already initialized (client/user credentials generation...)
249 if (dontContinue === true) return
251 if (options.hideLogs === false) {
252 console.log(data.toString())
254 server.app.stdout.removeListener('data', onStdout)
257 process.on('exit', () => {
259 process.kill(server.app.pid)
260 } catch { /* empty */ }
268 async function reRunServer (server: ServerInfo, configOverride?: any) {
269 const newServer = await runServer(server, configOverride)
270 server.app = newServer.app
275 async function checkTmpIsEmpty (server: ServerInfo) {
276 await checkDirectoryIsEmpty(server, 'tmp', [ 'plugins-global.css', 'hls' ])
278 if (await pathExists(join('test' + server.internalServerNumber, 'tmp', 'hls'))) {
279 await checkDirectoryIsEmpty(server, 'tmp/hls')
283 async function checkDirectoryIsEmpty (server: ServerInfo, directory: string, exceptions: string[] = []) {
284 const testDirectory = 'test' + server.internalServerNumber
286 const directoryPath = join(root(), testDirectory, directory)
288 const directoryExists = await pathExists(directoryPath)
289 expect(directoryExists).to.be.true
291 const files = await readdir(directoryPath)
292 const filtered = files.filter(f => exceptions.includes(f) === false)
294 expect(filtered).to.have.lengthOf(0)
297 function killallServers (servers: ServerInfo[]) {
298 for (const server of servers) {
299 if (!server.app) continue
301 process.kill(-server.app.pid)
306 async function cleanupTests (servers: ServerInfo[]) {
307 killallServers(servers)
310 await ensureDir('artifacts')
313 const p: Promise<any>[] = []
314 for (const server of servers) {
316 const origin = await buildServerDirectory(server, 'logs/peertube.log')
317 const destname = `peertube-${server.internalServerNumber}.log`
318 console.log('Saving logs %s.', destname)
320 await copy(origin, join('artifacts', destname))
323 if (server.parallel) {
324 p.push(flushTests(server.internalServerNumber))
327 if (server.customConfigFile) {
328 p.push(remove(server.customConfigFile))
332 return Promise.all(p)
335 async function waitUntilLog (server: ServerInfo, str: string, count = 1, strictCount = true) {
336 const logfile = buildServerDirectory(server, 'logs/peertube.log')
339 const buf = await readFile(logfile)
341 const matches = buf.toString().match(new RegExp(str, 'g'))
342 if (matches && matches.length === count) return
343 if (matches && strictCount === false && matches.length >= count) return
349 async function getServerFileSize (server: ServerInfo, subPath: string) {
350 const path = buildServerDirectory(server, subPath)
352 return getFileSize(path)
355 function makePingRequest (server: ServerInfo) {
356 return makeGetRequest({
358 path: '/api/v1/ping',
359 statusCodeExpected: 200
363 // ---------------------------------------------------------------------------
366 checkDirectoryIsEmpty,
372 flushAndRunMultipleServers,