]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - shared/extra-utils/server/servers.ts
Merge branch 'release/v1.3.0' into develop
[github/Chocobozzz/PeerTube.git] / shared / extra-utils / server / servers.ts
index b0cb869f4893ba5561d341017bb72a73948395b6..4c7d6862ae8d1bbc1694463acba812062a4e5043 100644 (file)
@@ -3,15 +3,20 @@
 import { ChildProcess, exec, fork } from 'child_process'
 import { join } from 'path'
 import { root, wait } from '../miscs/miscs'
-import { readdir, readFile } from 'fs-extra'
+import { copy, readdir, readFile, remove } from 'fs-extra'
 import { existsSync } from 'fs'
 import { expect } from 'chai'
 import { VideoChannel } from '../../models/videos'
+import { randomInt } from '../../core-utils/miscs/miscs'
 
 interface ServerInfo {
   app: ChildProcess,
   url: string
   host: string
+
+  port: number
+  parallel: boolean
+  internalServerNumber: number
   serverNumber: number
 
   client: {
@@ -25,6 +30,8 @@ interface ServerInfo {
     email?: string
   }
 
+  customConfigFile?: string
+
   accessToken?: string
   videoChannel?: VideoChannel
 
@@ -45,6 +52,10 @@ interface ServerInfo {
   videos?: { id: number, uuid: string }[]
 }
 
+function parallelTests () {
+  return process.env.MOCHA_PARALLEL === 'true'
+}
+
 function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
   let apps = []
   let i = 0
@@ -76,12 +87,29 @@ function flushTests (serverNumber?: number) {
   })
 }
 
-function flushAndRunServer (serverNumber: number, configOverride?: Object, args = []) {
+function randomServer () {
+  const low = 10
+  const high = 10000
+
+  return randomInt(low, high)
+}
+
+async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = []) {
+  const parallel = parallelTests()
+
+  const internalServerNumber = parallel ? randomServer() : serverNumber
+  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,
+    parallel,
+    serverNumber,
+    url: `http://localhost:${port}`,
+    host: `localhost:${port}`,
     client: {
       id: null,
       secret: null
@@ -92,11 +120,15 @@ function flushAndRunServer (serverNumber: number, configOverride?: Object, args
     }
   }
 
+  return runServer(server, configOverride, args)
+}
+
+async function runServer (server: ServerInfo, configOverrideArg?: any, args = []) {
   // 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 = {
@@ -106,67 +138,104 @@ function flushAndRunServer (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/`
+      },
+      admin: {
+        email: `admin${server.internalServerNumber}@example.com`
+      }
+    })
+  }
+
+  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 = {
     silent: true,
-    env: env,
+    env,
     detached: true
   }
 
   return new Promise<ServerInfo>(res => {
-    flushTests(serverNumber)
-      .then(() => {
-
-        server.app = fork(join(root(), 'dist', 'server.js'), args, options)
-        server.app.stdout.on('data', function onStdout (data) {
-          let dontContinue = false
-
-          // Capture things if we want to
-          for (const key of Object.keys(regexps)) {
-            const regexp = regexps[ key ]
-            const matches = data.toString().match(regexp)
-            if (matches !== null) {
-              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 ]
-            }
-          }
-
-          // Check if all required sentences are here
-          for (const key of Object.keys(serverRunString)) {
-            if (data.toString().indexOf(key) !== -1) serverRunString[ key ] = true
-            if (serverRunString[ key ] === false) dontContinue = true
-          }
-
-          // If no, there is maybe one thing not already initialized (client/user credentials generation...)
-          if (dontContinue === true) return
-
-          server.app.stdout.removeListener('data', onStdout)
-
-          process.on('exit', () => {
-            try {
-              process.kill(server.app.pid)
-            } catch { /* empty */
-            }
-          })
-
-          res(server)
-        })
+    server.app = fork(join(root(), 'dist', 'server.js'), args, options)
+    server.app.stdout.on('data', function onStdout (data) {
+      let dontContinue = false
+
+      // Capture things if we want to
+      for (const key of Object.keys(regexps)) {
+        const regexp = regexps[ key ]
+        const matches = data.toString().match(regexp)
+        if (matches !== null) {
+          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 ]
+        }
+      }
+
+      // Check if all required sentences are here
+      for (const key of Object.keys(serverRunString)) {
+        if (data.toString().indexOf(key) !== -1) serverRunString[ key ] = true
+        if (serverRunString[ key ] === false) dontContinue = true
+      }
+
+      // If no, there is maybe one thing not already initialized (client/user credentials generation...)
+      if (dontContinue === true) return
+
+      server.app.stdout.removeListener('data', onStdout)
+
+      process.on('exit', () => {
+        try {
+          process.kill(server.app.pid)
+        } catch { /* empty */ }
       })
+
+      res(server)
+    })
   })
 }
 
 async function reRunServer (server: ServerInfo, configOverride?: any) {
-  const newServer = await flushAndRunServer(server.serverNumber, configOverride)
+  const newServer = await runServer(server, configOverride)
   server.app = newServer.app
 
   return server
@@ -177,7 +246,7 @@ async function checkTmpIsEmpty (server: ServerInfo) {
 }
 
 async function checkDirectoryIsEmpty (server: ServerInfo, directory: string) {
-  const testDirectory = 'test' + server.serverNumber
+  const testDirectory = 'test' + server.internalServerNumber
 
   const directoryPath = join(root(), testDirectory, directory)
 
@@ -190,12 +259,32 @@ async function checkDirectoryIsEmpty (server: ServerInfo, directory: string) {
 
 function killallServers (servers: ServerInfo[]) {
   for (const server of servers) {
+    if (!server.app) continue
+
     process.kill(-server.app.pid)
+    server.app = null
+  }
+}
+
+function cleanupTests (servers: ServerInfo[]) {
+  killallServers(servers)
+
+  const p: Promise<any>[] = []
+  for (const server of servers) {
+    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) {
-  const logfile = join(root(), 'test' + server.serverNumber, 'logs/peertube.log')
+  const logfile = join(root(), 'test' + server.internalServerNumber, 'logs/peertube.log')
 
   while (true) {
     const buf = await readFile(logfile)
@@ -213,6 +302,8 @@ export {
   checkDirectoryIsEmpty,
   checkTmpIsEmpty,
   ServerInfo,
+  parallelTests,
+  cleanupTests,
   flushAndRunMultipleServers,
   flushTests,
   flushAndRunServer,