PeerTube/shared/extra-utils/server/servers.ts

381 lines
9.9 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
2018-12-11 09:16:41 +01:00
2020-11-06 16:43:43 +01:00
import { expect } from 'chai'
2017-09-04 21:21:47 +02:00
import { ChildProcess, exec, fork } from 'child_process'
2020-12-10 11:24:17 +01:00
import { copy, ensureDir, pathExists, readdir, readFile, remove } from 'fs-extra'
2020-11-06 16:43:43 +01:00
import { join } from 'path'
2019-04-24 15:10:37 +02:00
import { randomInt } from '../../core-utils/miscs/miscs'
2021-02-16 08:50:40 +01:00
import { VideoChannel } from '../../models/videos'
2020-12-10 11:24:17 +01:00
import { buildServerDirectory, getFileSize, isGithubCI, root, wait } from '../miscs/miscs'
2021-01-13 09:38:19 +01:00
import { makeGetRequest } from '../requests/requests'
2017-09-04 21:21:47 +02:00
interface ServerInfo {
2020-01-31 16:56:52 +01:00
app: ChildProcess
2020-11-02 15:43:44 +01:00
2017-09-04 21:21:47 +02:00
url: string
host: string
2020-11-02 15:43:44 +01:00
hostname: string
2019-04-24 11:54:23 +02:00
port: number
2020-11-02 15:43:44 +01:00
2020-11-06 16:43:43 +01:00
rtmpPort: number
2019-04-24 11:54:23 +02:00
parallel: boolean
internalServerNumber: number
2017-09-07 15:27:35 +02:00
serverNumber: number
2017-09-04 21:21:47 +02:00
client: {
2020-01-31 16:56:52 +01:00
id: string
2017-09-04 21:21:47 +02:00
secret: string
}
user: {
2020-01-31 16:56:52 +01:00
username: string
password: string
2017-09-04 21:21:47 +02:00
email?: string
}
2019-04-24 15:10:37 +02:00
customConfigFile?: string
2017-09-04 21:21:47 +02:00
accessToken?: string
refreshToken?: string
2019-03-05 10:58:44 +01:00
videoChannel?: VideoChannel
2017-09-04 21:21:47 +02:00
video?: {
id: number
uuid: string
2020-07-08 15:51:46 +02:00
name?: string
url?: string
2020-07-08 15:51:46 +02:00
account?: {
2018-03-12 11:06:15 +01:00
name: string
}
2017-09-04 21:21:47 +02:00
}
remoteVideo?: {
id: number
uuid: string
}
2019-03-05 10:58:44 +01:00
videos?: { id: number, uuid: string }[]
2017-09-04 21:21:47 +02:00
}
2019-04-24 15:10:37 +02:00
function parallelTests () {
return process.env.MOCHA_PARALLEL === 'true'
}
2018-09-14 09:57:21 +02:00
function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
2020-01-31 16:56:52 +01:00
const apps = []
2017-09-04 21:21:47 +02:00
let i = 0
return new Promise<ServerInfo[]>(res => {
function anotherServerDone (serverNumber, app) {
apps[serverNumber - 1] = app
i++
if (i === totalServers) {
return res(apps)
}
}
2019-04-24 10:53:40 +02:00
for (let j = 1; j <= totalServers; j++) {
flushAndRunServer(j, configOverride).then(app => anotherServerDone(j, app))
}
2017-09-04 21:21:47 +02:00
})
}
2019-04-24 10:53:40 +02:00
function flushTests (serverNumber?: number) {
2017-09-04 21:21:47 +02:00
return new Promise<void>((res, rej) => {
2019-04-24 10:53:40 +02:00
const suffix = serverNumber ? ` -- ${serverNumber}` : ''
2019-07-29 11:59:29 +02:00
return exec('npm run clean:server:test' + suffix, (err, _stdout, stderr) => {
if (err || stderr) return rej(err || new Error(stderr))
2017-09-04 21:21:47 +02:00
return res()
})
})
}
2019-04-24 11:54:23 +02:00
function randomServer () {
const low = 10
const high = 10000
2019-04-24 15:10:37 +02:00
return randomInt(low, high)
2019-04-24 11:54:23 +02:00
}
2020-11-06 16:43:43 +01:00
function randomRTMP () {
const low = 1900
const high = 2100
return randomInt(low, high)
}
2020-11-30 14:47:54 +01:00
type RunServerOptions = {
hideLogs?: boolean
execArgv?: string[]
}
async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = [], options: RunServerOptions = {}) {
2019-04-24 15:10:37 +02:00
const parallel = parallelTests()
2019-04-24 11:54:23 +02:00
const internalServerNumber = parallel ? randomServer() : serverNumber
2020-11-17 16:14:11 +01:00
const rtmpPort = parallel ? randomRTMP() : 1936
2019-04-24 11:54:23 +02:00
const port = 9000 + internalServerNumber
2019-04-24 15:10:37 +02:00
await flushTests(internalServerNumber)
2019-04-24 12:02:04 +02:00
2017-09-04 21:21:47 +02:00
const server: ServerInfo = {
app: null,
2019-04-24 11:54:23 +02:00
port,
internalServerNumber,
2020-11-06 16:43:43 +01:00
rtmpPort,
2019-04-24 11:54:23 +02:00
parallel,
2019-04-24 15:10:37 +02:00
serverNumber,
2019-04-24 11:54:23 +02:00
url: `http://localhost:${port}`,
host: `localhost:${port}`,
2020-11-02 15:43:44 +01:00
hostname: 'localhost',
2017-09-04 21:21:47 +02:00
client: {
id: null,
secret: null
},
user: {
username: null,
password: null
}
}
2020-11-30 14:47:54 +01:00
return runServer(server, configOverride, args, options)
2019-04-24 14:00:30 +02:00
}
2020-11-30 14:47:54 +01:00
async function runServer (server: ServerInfo, configOverrideArg?: any, args = [], options: RunServerOptions = {}) {
2017-09-04 21:21:47 +02:00
// These actions are async so we need to be sure that they have both been done
const serverRunString = {
2021-01-11 10:33:29 +01:00
'HTTP server listening': false
2017-09-04 21:21:47 +02:00
}
2019-04-24 14:00:30 +02:00
const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
2017-09-04 21:21:47 +02:00
serverRunString[key] = false
const regexps = {
client_id: 'Client id: (.+)',
client_secret: 'Client secret: (.+)',
user_username: 'Username: (.+)',
user_password: 'User password: (.+)'
}
2019-04-24 15:10:37 +02:00
if (server.internalServerNumber !== server.serverNumber) {
const basePath = join(root(), 'config')
const tmpConfigFile = join(basePath, `test-${server.internalServerNumber}.yaml`)
await copy(join(basePath, `test-${server.serverNumber}.yaml`), tmpConfigFile)
server.customConfigFile = tmpConfigFile
}
2017-09-07 15:27:35 +02:00
2019-04-24 15:10:37 +02:00
const configOverride: any = {}
2019-04-24 11:54:23 +02:00
2019-04-24 14:00:30 +02:00
if (server.parallel) {
2019-04-24 15:10:37 +02:00
Object.assign(configOverride, {
2019-04-24 11:54:23 +02:00
listen: {
2019-04-24 14:00:30 +02:00
port: server.port
2019-04-24 11:54:23 +02:00
},
webserver: {
2019-04-24 14:00:30 +02:00
port: server.port
2019-04-24 11:54:23 +02:00
},
database: {
2019-04-24 14:00:30 +02:00
suffix: '_test' + server.internalServerNumber
2019-04-24 11:54:23 +02:00
},
storage: {
2019-04-24 14:00:30 +02:00
tmp: `test${server.internalServerNumber}/tmp/`,
avatars: `test${server.internalServerNumber}/avatars/`,
videos: `test${server.internalServerNumber}/videos/`,
streaming_playlists: `test${server.internalServerNumber}/streaming-playlists/`,
redundancy: `test${server.internalServerNumber}/redundancy/`,
logs: `test${server.internalServerNumber}/logs/`,
previews: `test${server.internalServerNumber}/previews/`,
thumbnails: `test${server.internalServerNumber}/thumbnails/`,
torrents: `test${server.internalServerNumber}/torrents/`,
captions: `test${server.internalServerNumber}/captions/`,
2019-07-19 17:30:41 +02:00
cache: `test${server.internalServerNumber}/cache/`,
plugins: `test${server.internalServerNumber}/plugins/`
2019-04-24 11:54:23 +02:00
},
admin: {
2019-04-24 14:00:30 +02:00
email: `admin${server.internalServerNumber}@example.com`
2020-11-06 16:43:43 +01:00
},
live: {
rtmp: {
port: server.rtmpPort
}
2019-04-24 11:54:23 +02:00
}
2019-04-24 15:10:37 +02:00
})
2019-04-24 11:54:23 +02:00
}
if (configOverrideArg !== undefined) {
Object.assign(configOverride, configOverrideArg)
2017-09-07 15:27:35 +02:00
}
2019-04-24 15:10:37 +02:00
// Share the environment
const env = Object.create(process.env)
env['NODE_ENV'] = 'test'
env['NODE_APP_INSTANCE'] = server.internalServerNumber.toString()
2019-04-24 11:54:23 +02:00
env['NODE_CONFIG'] = JSON.stringify(configOverride)
2020-11-30 14:47:54 +01:00
const forkOptions = {
2017-09-04 21:21:47 +02:00
silent: true,
2019-04-24 15:10:37 +02:00
env,
2020-11-30 14:47:54 +01:00
detached: true,
execArgv: options.execArgv || []
2017-09-04 21:21:47 +02:00
}
return new Promise<ServerInfo>(res => {
2020-11-30 14:47:54 +01:00
server.app = fork(join(root(), 'dist', 'server.js'), args, forkOptions)
2019-04-24 12:02:04 +02:00
server.app.stdout.on('data', function onStdout (data) {
let dontContinue = false
// Capture things if we want to
for (const key of Object.keys(regexps)) {
2020-01-31 16:56:52 +01:00
const regexp = regexps[key]
2019-04-24 12:02:04 +02:00
const matches = data.toString().match(regexp)
if (matches !== null) {
2020-01-31 16:56:52 +01:00
if (key === 'client_id') server.client.id = matches[1]
else if (key === 'client_secret') server.client.secret = matches[1]
else if (key === 'user_username') server.user.username = matches[1]
else if (key === 'user_password') server.user.password = matches[1]
2019-04-24 12:02:04 +02:00
}
}
// Check if all required sentences are here
for (const key of Object.keys(serverRunString)) {
2020-01-31 16:56:52 +01:00
if (data.toString().indexOf(key) !== -1) serverRunString[key] = true
if (serverRunString[key] === false) dontContinue = true
2019-04-24 12:02:04 +02:00
}
// If no, there is maybe one thing not already initialized (client/user credentials generation...)
if (dontContinue === true) return
2020-11-30 14:47:54 +01:00
if (options.hideLogs === false) {
2020-11-24 14:08:23 +01:00
console.log(data.toString())
} else {
server.app.stdout.removeListener('data', onStdout)
}
2019-04-24 12:02:04 +02:00
process.on('exit', () => {
try {
process.kill(server.app.pid)
} catch { /* empty */ }
2019-01-17 11:23:40 +01:00
})
2019-04-24 12:02:04 +02:00
res(server)
})
2017-09-04 21:21:47 +02:00
})
}
async function reRunServer (server: ServerInfo, configOverride?: any) {
2019-04-24 14:00:30 +02:00
const newServer = await runServer(server, configOverride)
2018-01-11 11:40:18 +01:00
server.app = newServer.app
return server
}
2021-02-02 13:45:58 +01:00
async function checkTmpIsEmpty (server: ServerInfo) {
await checkDirectoryIsEmpty(server, 'tmp', [ 'plugins-global.css', 'hls' ])
if (await pathExists(join('test' + server.internalServerNumber, 'tmp', 'hls'))) {
await checkDirectoryIsEmpty(server, 'tmp/hls')
}
2019-01-29 08:37:25 +01:00
}
async function checkDirectoryIsEmpty (server: ServerInfo, directory: string, exceptions: string[] = []) {
2019-04-26 08:50:52 +02:00
const testDirectory = 'test' + server.internalServerNumber
2018-12-11 09:16:41 +01:00
2019-01-29 08:37:25 +01:00
const directoryPath = join(root(), testDirectory, directory)
2018-12-11 09:16:41 +01:00
const directoryExists = await pathExists(directoryPath)
2018-12-11 09:16:41 +01:00
expect(directoryExists).to.be.true
const files = await readdir(directoryPath)
const filtered = files.filter(f => exceptions.includes(f) === false)
expect(filtered).to.have.lengthOf(0)
2018-12-11 09:16:41 +01:00
}
2017-09-04 21:21:47 +02:00
function killallServers (servers: ServerInfo[]) {
for (const server of servers) {
2019-04-24 15:10:37 +02:00
if (!server.app) continue
2017-09-04 21:21:47 +02:00
process.kill(-server.app.pid)
2019-04-24 15:10:37 +02:00
server.app = null
2017-09-04 21:21:47 +02:00
}
}
2020-12-10 11:24:17 +01:00
async function cleanupTests (servers: ServerInfo[]) {
2019-04-24 11:54:23 +02:00
killallServers(servers)
2020-12-10 11:24:17 +01:00
if (isGithubCI()) {
await ensureDir('artifacts')
}
2019-04-24 11:54:23 +02:00
const p: Promise<any>[] = []
for (const server of servers) {
2020-12-10 11:24:17 +01:00
if (isGithubCI()) {
const origin = await buildServerDirectory(server, 'logs/peertube.log')
const destname = `peertube-${server.internalServerNumber}.log`
console.log('Saving logs %s.', destname)
await copy(origin, join('artifacts', destname))
}
2019-04-24 11:54:23 +02:00
if (server.parallel) {
p.push(flushTests(server.internalServerNumber))
}
2019-04-24 15:10:37 +02:00
if (server.customConfigFile) {
p.push(remove(server.customConfigFile))
}
2019-04-24 11:54:23 +02:00
}
return Promise.all(p)
}
2020-04-09 11:00:30 +02:00
async function waitUntilLog (server: ServerInfo, str: string, count = 1, strictCount = true) {
2020-11-24 15:22:56 +01:00
const logfile = buildServerDirectory(server, 'logs/peertube.log')
2018-10-02 09:04:19 +02:00
while (true) {
const buf = await readFile(logfile)
const matches = buf.toString().match(new RegExp(str, 'g'))
if (matches && matches.length === count) return
2020-04-09 11:00:30 +02:00
if (matches && strictCount === false && matches.length >= count) return
2018-10-02 09:04:19 +02:00
await wait(1000)
}
}
async function getServerFileSize (server: ServerInfo, subPath: string) {
2020-11-24 15:22:56 +01:00
const path = buildServerDirectory(server, subPath)
return getFileSize(path)
}
2021-01-13 09:38:19 +01:00
function makePingRequest (server: ServerInfo) {
return makeGetRequest({
url: server.url,
path: '/api/v1/ping',
statusCodeExpected: 200
})
}
2017-09-04 21:21:47 +02:00
// ---------------------------------------------------------------------------
export {
2019-01-29 08:37:25 +01:00
checkDirectoryIsEmpty,
2018-12-11 09:16:41 +01:00
checkTmpIsEmpty,
getServerFileSize,
2017-09-04 21:21:47 +02:00
ServerInfo,
2019-04-24 15:10:37 +02:00
parallelTests,
2019-04-24 11:54:23 +02:00
cleanupTests,
2017-09-04 21:21:47 +02:00
flushAndRunMultipleServers,
flushTests,
2021-01-13 09:38:19 +01:00
makePingRequest,
2019-04-24 10:53:40 +02:00
flushAndRunServer,
2018-01-11 11:40:18 +01:00
killallServers,
2018-10-02 09:04:19 +02:00
reRunServer,
waitUntilLog
2017-09-04 21:21:47 +02:00
}