shared/utils/server/servers.ts

   1 import { ChildProcess, exec, fork } from 'child_process'
   2 import { join } from 'path'
   3 import { root, wait } from '../miscs/miscs'
   4 import { readFile } from 'fs-extra'
   5
   6 interface ServerInfo {
   7   app: ChildProcess,
   8   url: string
   9   host: string
  10   serverNumber: number
  11
  12   client: {
  13     id: string,
  14     secret: string
  15   }
  16
  17   user: {
  18     username: string,
  19     password: string,
  20     email?: string
  21   }
  22
  23   accessToken?: string
  24
  25   video?: {
  26     id: number
  27     uuid: string
  28     name: string
  29     account: {
  30       name: string
  31     }
  32   }
  33
  34   remoteVideo?: {
  35     id: number
  36     uuid: string
  37   }
  38 }
  39
  40 function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
  41   let apps = []
  42   let i = 0
  43
  44   return new Promise<ServerInfo[]>(res => {
  45     function anotherServerDone (serverNumber, app) {
  46       apps[serverNumber - 1] = app
  47       i++
  48       if (i === totalServers) {
  49         return res(apps)
  50       }
  51     }
  52
  53     flushTests()
  54       .then(() => {
  55         for (let j = 1; j <= totalServers; j++) {
  56           runServer(j, configOverride).then(app => anotherServerDone(j, app))
  57         }
  58       })
  59   })
  60 }
  61
  62 function flushTests () {
  63   return new Promise<void>((res, rej) => {
  64     return exec('npm run clean:server:test', err => {
  65       if (err) return rej(err)
  66
  67       return res()
  68     })
  69   })
  70 }
  71
  72 function runServer (serverNumber: number, configOverride?: Object, args = []) {
  73   const server: ServerInfo = {
  74     app: null,
  75     serverNumber: serverNumber,
  76     url: `http://localhost:${9000 + serverNumber}`,
  77     host: `localhost:${9000 + serverNumber}`,
  78     client: {
  79       id: null,
  80       secret: null
  81     },
  82     user: {
  83       username: null,
  84       password: null
  85     }
  86   }
  87
  88   // These actions are async so we need to be sure that they have both been done
  89   const serverRunString = {
  90     'Server listening': false
  91   }
  92   const key = 'Database peertube_test' + serverNumber + ' is ready'
  93   serverRunString[key] = false
  94
  95   const regexps = {
  96     client_id: 'Client id: (.+)',
  97     client_secret: 'Client secret: (.+)',
  98     user_username: 'Username: (.+)',
  99     user_password: 'User password: (.+)'
 100   }
 101
 102   // Share the environment
 103   const env = Object.create(process.env)
 104   env['NODE_ENV'] = 'test'
 105   env['NODE_APP_INSTANCE'] = serverNumber.toString()
 106
 107   if (configOverride !== undefined) {
 108     env['NODE_CONFIG'] = JSON.stringify(configOverride)
 109   }
 110
 111   const options = {
 112     silent: true,
 113     env: env,
 114     detached: true
 115   }
 116
 117   return new Promise<ServerInfo>(res => {
 118     server.app = fork(join(root(), 'dist', 'server.js'), args, options)
 119     server.app.stdout.on('data', function onStdout (data) {
 120       let dontContinue = false
 121
 122       // Capture things if we want to
 123       for (const key of Object.keys(regexps)) {
 124         const regexp = regexps[key]
 125         const matches = data.toString().match(regexp)
 126         if (matches !== null) {
 127           if (key === 'client_id') server.client.id = matches[1]
 128           else if (key === 'client_secret') server.client.secret = matches[1]
 129           else if (key === 'user_username') server.user.username = matches[1]
 130           else if (key === 'user_password') server.user.password = matches[1]
 131         }
 132       }
 133
 134       // Check if all required sentences are here
 135       for (const key of Object.keys(serverRunString)) {
 136         if (data.toString().indexOf(key) !== -1) serverRunString[key] = true
 137         if (serverRunString[key] === false) dontContinue = true
 138       }
 139
 140       // If no, there is maybe one thing not already initialized (client/user credentials generation...)
 141       if (dontContinue === true) return
 142
 143       server.app.stdout.removeListener('data', onStdout)
 144       res(server)
 145     })
 146   })
 147 }
 148
 149 async function reRunServer (server: ServerInfo, configOverride?: any) {
 150   const newServer = await runServer(server.serverNumber, configOverride)
 151   server.app = newServer.app
 152
 153   return server
 154 }
 155
 156 function killallServers (servers: ServerInfo[]) {
 157   for (const server of servers) {
 158     process.kill(-server.app.pid)
 159   }
 160 }
 161
 162 async function waitUntilLog (server: ServerInfo, str: string, count = 1) {
 163   const logfile = join(root(), 'test' + server.serverNumber, 'logs/peertube.log')
 164
 165   while (true) {
 166     const buf = await readFile(logfile)
 167
 168     const matches = buf.toString().match(new RegExp(str, 'g'))
 169     if (matches && matches.length === count) return
 170
 171     await wait(1000)
 172   }
 173 }
 174
 175 // ---------------------------------------------------------------------------
 176
 177 export {
 178   ServerInfo,
 179   flushAndRunMultipleServers,
 180   flushTests,
 181   runServer,
 182   killallServers,
 183   reRunServer,
 184   waitUntilLog
 185 }