]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - shared/extra-utils/server/servers.ts
Use -1 for max live duration unlimited
[github/Chocobozzz/PeerTube.git] / shared / extra-utils / server / servers.ts
index 5288d253a5b639f8f0d0f9361da7d88a785ab535..fe4ed3e485691d5523655845e3101cfed4a65fcc 100644 (file)
@@ -1,38 +1,49 @@
-/* tslint:disable:no-unused-expression */
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
 
+import { expect } from 'chai'
 import { ChildProcess, exec, fork } from 'child_process'
+import { copy, ensureDir, pathExists, readdir, readFile, remove } from 'fs-extra'
 import { join } from 'path'
-import { root, wait } from '../miscs/miscs'
-import { readdir, readFile } from 'fs-extra'
-import { existsSync } from 'fs'
-import { expect } from 'chai'
+import { randomInt } from '../../core-utils/miscs/miscs'
 import { VideoChannel } from '../../models/videos'
+import { buildServerDirectory, getFileSize, isGithubCI, root, wait } from '../miscs/miscs'
 
 interface ServerInfo {
-  app: ChildProcess,
+  app: ChildProcess
+
   url: string
   host: string
+  hostname: string
+  port: number
+
+  rtmpPort: number
+
+  parallel: boolean
+  internalServerNumber: number
   serverNumber: number
 
   client: {
-    id: string,
+    id: string
     secret: string
   }
 
   user: {
-    username: string,
-    password: string,
+    username: string
+    password: string
     email?: string
   }
 
+  customConfigFile?: string
+
   accessToken?: string
   videoChannel?: VideoChannel
 
   video?: {
     id: number
     uuid: string
-    name: string
-    account: {
+    name?: string
+    url?: string
+    account?: {
       name: string
     }
   }
@@ -45,8 +56,12 @@ interface ServerInfo {
   videos?: { id: number, uuid: string }[]
 }
 
+function parallelTests () {
+  return process.env.MOCHA_PARALLEL === 'true'
+}
+
 function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
-  let apps = []
+  const apps = []
   let i = 0
 
   return new Promise<ServerInfo[]>(res => {
@@ -58,31 +73,62 @@ function flushAndRunMultipleServers (totalServers: number, configOverride?: Obje
       }
     }
 
-    flushTests()
-      .then(() => {
-        for (let j = 1; j <= totalServers; j++) {
-          runServer(j, configOverride).then(app => anotherServerDone(j, app))
-        }
-      })
+    for (let j = 1; j <= totalServers; j++) {
+      flushAndRunServer(j, configOverride).then(app => anotherServerDone(j, app))
+    }
   })
 }
 
-function flushTests () {
+function flushTests (serverNumber?: number) {
   return new Promise<void>((res, rej) => {
-    return exec('npm run clean:server:test', err => {
-      if (err) return rej(err)
+    const suffix = serverNumber ? ` -- ${serverNumber}` : ''
+
+    return exec('npm run clean:server:test' + suffix, (err, _stdout, stderr) => {
+      if (err || stderr) return rej(err || new Error(stderr))
 
       return res()
     })
   })
 }
 
-function runServer (serverNumber: number, configOverride?: Object, args = []) {
+function randomServer () {
+  const low = 10
+  const high = 10000
+
+  return randomInt(low, high)
+}
+
+function randomRTMP () {
+  const low = 1900
+  const high = 2100
+
+  return randomInt(low, high)
+}
+
+type RunServerOptions = {
+  hideLogs?: boolean
+  execArgv?: string[]
+}
+
+async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = [], options: RunServerOptions = {}) {
+  const parallel = parallelTests()
+
+  const internalServerNumber = parallel ? randomServer() : serverNumber
+  const rtmpPort = parallel ? randomRTMP() : 1936
+  const port = 9000 + internalServerNumber
+
+  await flushTests(internalServerNumber)
+
   const server: ServerInfo = {
     app: null,
-    serverNumber: serverNumber,
-    url: `http://localhost:${9000 + serverNumber}`,
-    host: `localhost:${9000 + serverNumber}`,
+    port,
+    internalServerNumber,
+    rtmpPort,
+    parallel,
+    serverNumber,
+    url: `http://localhost:${port}`,
+    host: `localhost:${port}`,
+    hostname: 'localhost',
     client: {
       id: null,
       secret: null
@@ -93,11 +139,15 @@ function runServer (serverNumber: number, configOverride?: Object, args = []) {
     }
   }
 
+  return runServer(server, configOverride, args, options)
+}
+
+async function runServer (server: ServerInfo, configOverrideArg?: any, args = [], options: RunServerOptions = {}) {
   // These actions are async so we need to be sure that they have both been done
   const serverRunString = {
     'Server listening': false
   }
-  const key = 'Database peertube_test' + serverNumber + ' is ready'
+  const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
   serverRunString[key] = false
 
   const regexps = {
@@ -107,23 +157,72 @@ function runServer (serverNumber: number, configOverride?: Object, args = []) {
     user_password: 'User password: (.+)'
   }
 
+  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
+  }
+
+  const configOverride: any = {}
+
+  if (server.parallel) {
+    Object.assign(configOverride, {
+      listen: {
+        port: server.port
+      },
+      webserver: {
+        port: server.port
+      },
+      database: {
+        suffix: '_test' + server.internalServerNumber
+      },
+      storage: {
+        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/`,
+        cache: `test${server.internalServerNumber}/cache/`,
+        plugins: `test${server.internalServerNumber}/plugins/`
+      },
+      admin: {
+        email: `admin${server.internalServerNumber}@example.com`
+      },
+      live: {
+        rtmp: {
+          port: server.rtmpPort
+        }
+      }
+    })
+  }
+
+  if (configOverrideArg !== undefined) {
+    Object.assign(configOverride, configOverrideArg)
+  }
+
   // Share the environment
   const env = Object.create(process.env)
   env['NODE_ENV'] = 'test'
-  env['NODE_APP_INSTANCE'] = serverNumber.toString()
-
-  if (configOverride !== undefined) {
-    env['NODE_CONFIG'] = JSON.stringify(configOverride)
-  }
+  env['NODE_APP_INSTANCE'] = server.internalServerNumber.toString()
+  env['NODE_CONFIG'] = JSON.stringify(configOverride)
 
-  const options = {
+  const forkOptions = {
     silent: true,
-    env: env,
-    detached: true
+    env,
+    detached: true,
+    execArgv: options.execArgv || []
   }
 
   return new Promise<ServerInfo>(res => {
-    server.app = fork(join(root(), 'dist', 'server.js'), args, options)
+    server.app = fork(join(root(), 'dist', 'server.js'), args, forkOptions)
     server.app.stdout.on('data', function onStdout (data) {
       let dontContinue = false
 
@@ -148,7 +247,11 @@ function runServer (serverNumber: number, configOverride?: Object, args = []) {
       // If no, there is maybe one thing not already initialized (client/user credentials generation...)
       if (dontContinue === true) return
 
-      server.app.stdout.removeListener('data', onStdout)
+      if (options.hideLogs === false) {
+        console.log(data.toString())
+      } else {
+        server.app.stdout.removeListener('data', onStdout)
+      }
 
       process.on('exit', () => {
         try {
@@ -158,61 +261,104 @@ function runServer (serverNumber: number, configOverride?: Object, args = []) {
 
       res(server)
     })
-
   })
 }
 
 async function reRunServer (server: ServerInfo, configOverride?: any) {
-  const newServer = await runServer(server.serverNumber, configOverride)
+  const newServer = await runServer(server, configOverride)
   server.app = newServer.app
 
   return server
 }
 
-async function checkTmpIsEmpty (server: ServerInfo) {
-  return checkDirectoryIsEmpty(server, 'tmp')
+function checkTmpIsEmpty (server: ServerInfo) {
+  return checkDirectoryIsEmpty(server, 'tmp', [ 'plugins-global.css' ])
 }
 
-async function checkDirectoryIsEmpty (server: ServerInfo, directory: string) {
-  const testDirectory = 'test' + server.serverNumber
+async function checkDirectoryIsEmpty (server: ServerInfo, directory: string, exceptions: string[] = []) {
+  const testDirectory = 'test' + server.internalServerNumber
 
   const directoryPath = join(root(), testDirectory, directory)
 
-  const directoryExists = existsSync(directoryPath)
+  const directoryExists = await pathExists(directoryPath)
   expect(directoryExists).to.be.true
 
   const files = await readdir(directoryPath)
-  expect(files).to.have.lengthOf(0)
+  const filtered = files.filter(f => exceptions.includes(f) === false)
+
+  expect(filtered).to.have.lengthOf(0)
 }
 
 function killallServers (servers: ServerInfo[]) {
   for (const server of servers) {
+    if (!server.app) continue
+
     process.kill(-server.app.pid)
+    server.app = null
   }
 }
 
-async function waitUntilLog (server: ServerInfo, str: string, count = 1) {
-  const logfile = join(root(), 'test' + server.serverNumber, 'logs/peertube.log')
+async function cleanupTests (servers: ServerInfo[]) {
+  killallServers(servers)
+
+  if (isGithubCI()) {
+    await ensureDir('artifacts')
+  }
+
+  const p: Promise<any>[] = []
+  for (const server of servers) {
+    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))
+    }
+
+    if (server.parallel) {
+      p.push(flushTests(server.internalServerNumber))
+    }
+
+    if (server.customConfigFile) {
+      p.push(remove(server.customConfigFile))
+    }
+  }
+
+  return Promise.all(p)
+}
+
+async function waitUntilLog (server: ServerInfo, str: string, count = 1, strictCount = true) {
+  const logfile = buildServerDirectory(server, 'logs/peertube.log')
 
   while (true) {
     const buf = await readFile(logfile)
 
     const matches = buf.toString().match(new RegExp(str, 'g'))
     if (matches && matches.length === count) return
+    if (matches && strictCount === false && matches.length >= count) return
 
     await wait(1000)
   }
 }
 
+async function getServerFileSize (server: ServerInfo, subPath: string) {
+  const path = buildServerDirectory(server, subPath)
+
+  return getFileSize(path)
+}
+
 // ---------------------------------------------------------------------------
 
 export {
   checkDirectoryIsEmpty,
   checkTmpIsEmpty,
+  getServerFileSize,
   ServerInfo,
+  parallelTests,
+  cleanupTests,
   flushAndRunMultipleServers,
   flushTests,
-  runServer,
+  flushAndRunServer,
   killallServers,
   reRunServer,
   waitUntilLog