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
41 videoChannel?: VideoChannel
61 videos?: { id: number, uuid: string }[]
64 function parallelTests () {
65 return process.env.MOCHA_PARALLEL === 'true'
68 function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
72 return new Promise<ServerInfo[]>(res => {
73 function anotherServerDone (serverNumber, app) {
74 apps[serverNumber - 1] = app
76 if (i === totalServers) {
81 for (let j = 1; j <= totalServers; j++) {
82 flushAndRunServer(j, configOverride).then(app => anotherServerDone(j, app))
87 function flushTests (serverNumber?: number) {
88 return new Promise<void>((res, rej) => {
89 const suffix = serverNumber ? ` -- ${serverNumber}` : ''
91 return exec('npm run clean:server:test' + suffix, (err, _stdout, stderr) => {
92 if (err || stderr) return rej(err || new Error(stderr))
99 function randomServer () {
103 return randomInt(low, high)
106 function randomRTMP () {
110 return randomInt(low, high)
113 type RunServerOptions = {
118 async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = [], options: RunServerOptions = {}) {
119 const parallel = parallelTests()
121 const internalServerNumber = parallel ? randomServer() : serverNumber
122 const rtmpPort = parallel ? randomRTMP() : 1936
123 const port = 9000 + internalServerNumber
125 await flushTests(internalServerNumber)
127 const server: ServerInfo = {
130 internalServerNumber,
134 url: `http://localhost:${port}`,
135 host: `localhost:${port}`,
136 hostname: 'localhost',
147 return runServer(server, configOverride, args, options)
150 async function runServer (server: ServerInfo, configOverrideArg?: any, args = [], options: RunServerOptions = {}) {
151 // These actions are async so we need to be sure that they have both been done
152 const serverRunString = {
153 'HTTP server listening': false
155 const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
156 serverRunString[key] = false
159 client_id: 'Client id: (.+)',
160 client_secret: 'Client secret: (.+)',
161 user_username: 'Username: (.+)',
162 user_password: 'User password: (.+)'
165 if (server.internalServerNumber !== server.serverNumber) {
166 const basePath = join(root(), 'config')
168 const tmpConfigFile = join(basePath, `test-${server.internalServerNumber}.yaml`)
169 await copy(join(basePath, `test-${server.serverNumber}.yaml`), tmpConfigFile)
171 server.customConfigFile = tmpConfigFile
174 const configOverride: any = {}
176 if (server.parallel) {
177 Object.assign(configOverride, {
185 suffix: '_test' + server.internalServerNumber
188 tmp: `test${server.internalServerNumber}/tmp/`,
189 avatars: `test${server.internalServerNumber}/avatars/`,
190 videos: `test${server.internalServerNumber}/videos/`,
191 streaming_playlists: `test${server.internalServerNumber}/streaming-playlists/`,
192 redundancy: `test${server.internalServerNumber}/redundancy/`,
193 logs: `test${server.internalServerNumber}/logs/`,
194 previews: `test${server.internalServerNumber}/previews/`,
195 thumbnails: `test${server.internalServerNumber}/thumbnails/`,
196 torrents: `test${server.internalServerNumber}/torrents/`,
197 captions: `test${server.internalServerNumber}/captions/`,
198 cache: `test${server.internalServerNumber}/cache/`,
199 plugins: `test${server.internalServerNumber}/plugins/`
202 email: `admin${server.internalServerNumber}@example.com`
206 port: server.rtmpPort
212 if (configOverrideArg !== undefined) {
213 Object.assign(configOverride, configOverrideArg)
216 // Share the environment
217 const env = Object.create(process.env)
218 env['NODE_ENV'] = 'test'
219 env['NODE_APP_INSTANCE'] = server.internalServerNumber.toString()
220 env['NODE_CONFIG'] = JSON.stringify(configOverride)
222 const forkOptions = {
226 execArgv: options.execArgv || []
229 return new Promise<ServerInfo>(res => {
230 server.app = fork(join(root(), 'dist', 'server.js'), args, forkOptions)
231 server.app.stdout.on('data', function onStdout (data) {
232 let dontContinue = false
234 // Capture things if we want to
235 for (const key of Object.keys(regexps)) {
236 const regexp = regexps[key]
237 const matches = data.toString().match(regexp)
238 if (matches !== null) {
239 if (key === 'client_id') server.client.id = matches[1]
240 else if (key === 'client_secret') server.client.secret = matches[1]
241 else if (key === 'user_username') server.user.username = matches[1]
242 else if (key === 'user_password') server.user.password = matches[1]
246 // Check if all required sentences are here
247 for (const key of Object.keys(serverRunString)) {
248 if (data.toString().indexOf(key) !== -1) serverRunString[key] = true
249 if (serverRunString[key] === false) dontContinue = true
252 // If no, there is maybe one thing not already initialized (client/user credentials generation...)
253 if (dontContinue === true) return
255 if (options.hideLogs === false) {
256 console.log(data.toString())
258 server.app.stdout.removeListener('data', onStdout)
261 process.on('exit', () => {
263 process.kill(server.app.pid)
264 } catch { /* empty */ }
272 async function reRunServer (server: ServerInfo, configOverride?: any) {
273 const newServer = await runServer(server, configOverride)
274 server.app = newServer.app
279 async function checkTmpIsEmpty (server: ServerInfo) {
280 await checkDirectoryIsEmpty(server, 'tmp', [ 'plugins-global.css', 'hls', 'resumable-uploads' ])
282 if (await pathExists(join('test' + server.internalServerNumber, 'tmp', 'hls'))) {
283 await checkDirectoryIsEmpty(server, 'tmp/hls')
287 async function checkDirectoryIsEmpty (server: ServerInfo, directory: string, exceptions: string[] = []) {
288 const testDirectory = 'test' + server.internalServerNumber
290 const directoryPath = join(root(), testDirectory, directory)
292 const directoryExists = await pathExists(directoryPath)
293 expect(directoryExists).to.be.true
295 const files = await readdir(directoryPath)
296 const filtered = files.filter(f => exceptions.includes(f) === false)
298 expect(filtered).to.have.lengthOf(0)
301 function killallServers (servers: ServerInfo[]) {
302 for (const server of servers) {
303 if (!server.app) continue
305 process.kill(-server.app.pid)
310 async function cleanupTests (servers: ServerInfo[]) {
311 killallServers(servers)
314 await ensureDir('artifacts')
317 const p: Promise<any>[] = []
318 for (const server of servers) {
320 const origin = await buildServerDirectory(server, 'logs/peertube.log')
321 const destname = `peertube-${server.internalServerNumber}.log`
322 console.log('Saving logs %s.', destname)
324 await copy(origin, join('artifacts', destname))
327 if (server.parallel) {
328 p.push(flushTests(server.internalServerNumber))
331 if (server.customConfigFile) {
332 p.push(remove(server.customConfigFile))
336 return Promise.all(p)
339 async function waitUntilLog (server: ServerInfo, str: string, count = 1, strictCount = true) {
340 const logfile = buildServerDirectory(server, 'logs/peertube.log')
343 const buf = await readFile(logfile)
345 const matches = buf.toString().match(new RegExp(str, 'g'))
346 if (matches && matches.length === count) return
347 if (matches && strictCount === false && matches.length >= count) return
353 async function getServerFileSize (server: ServerInfo, subPath: string) {
354 const path = buildServerDirectory(server, subPath)
356 return getFileSize(path)
359 function makePingRequest (server: ServerInfo) {
360 return makeGetRequest({
362 path: '/api/v1/ping',
363 statusCodeExpected: 200
367 // ---------------------------------------------------------------------------
370 checkDirectoryIsEmpty,
376 flushAndRunMultipleServers,