aboutsummaryrefslogtreecommitdiffhomepage
path: root/shared/extra-utils/server/servers.ts
blob: f5dc0326fff65430471367df3b01ebff27b1debd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */

import { ChildProcess, fork } from 'child_process'
import { copy, ensureDir } from 'fs-extra'
import { join } from 'path'
import { root } from '@server/helpers/core-utils'
import { randomInt } from '../../core-utils/miscs/miscs'
import { VideoChannel } from '../../models/videos'
import { BulkCommand } from '../bulk'
import { CLICommand } from '../cli'
import { CustomPagesCommand } from '../custom-pages'
import { FeedCommand } from '../feeds'
import { LogsCommand } from '../logs'
import { isGithubCI, parallelTests, SQLCommand } from '../miscs'
import { AbusesCommand } from '../moderation'
import { OverviewsCommand } from '../overviews'
import { SearchCommand } from '../search'
import { SocketIOCommand } from '../socket'
import { AccountsCommand, BlocklistCommand, NotificationsCommand, SubscriptionsCommand } from '../users'
import {
  BlacklistCommand,
  CaptionsCommand,
  ChangeOwnershipCommand,
  ChannelsCommand,
  HistoryCommand,
  ImportsCommand,
  LiveCommand,
  PlaylistsCommand,
  ServicesCommand,
  StreamingPlaylistsCommand
} from '../videos'
import { CommentsCommand } from '../videos/comments-command'
import { ConfigCommand } from './config-command'
import { ContactFormCommand } from './contact-form-command'
import { DebugCommand } from './debug-command'
import { FollowsCommand } from './follows-command'
import { JobsCommand } from './jobs-command'
import { PluginsCommand } from './plugins-command'
import { RedundancyCommand } from './redundancy-command'
import { ServersCommand } from './servers-command'
import { StatsCommand } from './stats-command'

interface ServerInfo {
  app?: ChildProcess

  url: string
  host?: string
  hostname?: string
  port?: number

  rtmpPort?: number

  parallel?: boolean
  internalServerNumber: number
  serverNumber?: number

  client?: {
    id?: string
    secret?: string
  }

  user?: {
    username: string
    password: string
    email?: string
  }

  customConfigFile?: string

  accessToken?: string
  refreshToken?: string
  videoChannel?: VideoChannel

  video?: {
    id: number
    uuid: string
    shortUUID: string
    name?: string
    url?: string

    account?: {
      name: string
    }

    embedPath?: string
  }

  remoteVideo?: {
    id: number
    uuid: string
  }

  videos?: { id: number, uuid: string }[]

  bulkCommand?: BulkCommand
  cliCommand?: CLICommand
  customPageCommand?: CustomPagesCommand
  feedCommand?: FeedCommand
  logsCommand?: LogsCommand
  abusesCommand?: AbusesCommand
  overviewsCommand?: OverviewsCommand
  searchCommand?: SearchCommand
  contactFormCommand?: ContactFormCommand
  debugCommand?: DebugCommand
  followsCommand?: FollowsCommand
  jobsCommand?: JobsCommand
  pluginsCommand?: PluginsCommand
  redundancyCommand?: RedundancyCommand
  statsCommand?: StatsCommand
  configCommand?: ConfigCommand
  socketIOCommand?: SocketIOCommand
  accountsCommand?: AccountsCommand
  blocklistCommand?: BlocklistCommand
  subscriptionsCommand?: SubscriptionsCommand
  liveCommand?: LiveCommand
  servicesCommand?: ServicesCommand
  blacklistCommand?: BlacklistCommand
  captionsCommand?: CaptionsCommand
  changeOwnershipCommand?: ChangeOwnershipCommand
  playlistsCommand?: PlaylistsCommand
  historyCommand?: HistoryCommand
  importsCommand?: ImportsCommand
  streamingPlaylistsCommand?: StreamingPlaylistsCommand
  channelsCommand?: ChannelsCommand
  commentsCommand?: CommentsCommand
  sqlCommand?: SQLCommand
  notificationsCommand?: NotificationsCommand
  serversCommand?: ServersCommand
}

function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
  const apps = []
  let i = 0

  return new Promise<ServerInfo[]>(res => {
    function anotherServerDone (serverNumber, app) {
      apps[serverNumber - 1] = app
      i++
      if (i === totalServers) {
        return res(apps)
      }
    }

    for (let j = 1; j <= totalServers; j++) {
      flushAndRunServer(j, configOverride).then(app => anotherServerDone(j, app))
    }
  })
}

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 ServersCommand.flushTests(internalServerNumber)

  const server: ServerInfo = {
    app: null,
    port,
    internalServerNumber,
    rtmpPort,
    parallel,
    serverNumber,
    url: `http://localhost:${port}`,
    host: `localhost:${port}`,
    hostname: 'localhost',
    client: {
      id: null,
      secret: null
    },
    user: {
      username: null,
      password: null
    }
  }

  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 = {
    'HTTP server listening': false
  }
  const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
  serverRunString[key] = false

  const regexps = {
    client_id: 'Client id: (.+)',
    client_secret: 'Client secret: (.+)',
    user_username: 'Username: (.+)',
    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'] = server.internalServerNumber.toString()
  env['NODE_CONFIG'] = JSON.stringify(configOverride)

  const forkOptions = {
    silent: true,
    env,
    detached: true,
    execArgv: options.execArgv || []
  }

  return new Promise<ServerInfo>(res => {
    server.app = fork(join(root(), 'dist', 'server.js'), args, forkOptions)
    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

      if (options.hideLogs === false) {
        console.log(data.toString())
      } else {
        server.app.stdout.removeListener('data', onStdout)
      }

      process.on('exit', () => {
        try {
          process.kill(server.app.pid)
        } catch { /* empty */ }
      })

      assignCommands(server)

      res(server)
    })
  })
}

function assignCommands (server: ServerInfo) {
  server.bulkCommand = new BulkCommand(server)
  server.cliCommand = new CLICommand(server)
  server.customPageCommand = new CustomPagesCommand(server)
  server.feedCommand = new FeedCommand(server)
  server.logsCommand = new LogsCommand(server)
  server.abusesCommand = new AbusesCommand(server)
  server.overviewsCommand = new OverviewsCommand(server)
  server.searchCommand = new SearchCommand(server)
  server.contactFormCommand = new ContactFormCommand(server)
  server.debugCommand = new DebugCommand(server)
  server.followsCommand = new FollowsCommand(server)
  server.jobsCommand = new JobsCommand(server)
  server.pluginsCommand = new PluginsCommand(server)
  server.redundancyCommand = new RedundancyCommand(server)
  server.statsCommand = new StatsCommand(server)
  server.configCommand = new ConfigCommand(server)
  server.socketIOCommand = new SocketIOCommand(server)
  server.accountsCommand = new AccountsCommand(server)
  server.blocklistCommand = new BlocklistCommand(server)
  server.subscriptionsCommand = new SubscriptionsCommand(server)
  server.liveCommand = new LiveCommand(server)
  server.servicesCommand = new ServicesCommand(server)
  server.blacklistCommand = new BlacklistCommand(server)
  server.captionsCommand = new CaptionsCommand(server)
  server.changeOwnershipCommand = new ChangeOwnershipCommand(server)
  server.playlistsCommand = new PlaylistsCommand(server)
  server.historyCommand = new HistoryCommand(server)
  server.importsCommand = new ImportsCommand(server)
  server.streamingPlaylistsCommand = new StreamingPlaylistsCommand(server)
  server.channelsCommand = new ChannelsCommand(server)
  server.commentsCommand = new CommentsCommand(server)
  server.sqlCommand = new SQLCommand(server)
  server.notificationsCommand = new NotificationsCommand(server)
  server.serversCommand = new ServersCommand(server)
}

async function reRunServer (server: ServerInfo, configOverride?: any) {
  const newServer = await runServer(server, configOverride)
  server.app = newServer.app

  return server
}

async function killallServers (servers: ServerInfo[]) {
  for (const server of servers) {
    if (!server.app) continue

    await server.sqlCommand.cleanup()

    process.kill(-server.app.pid)

    server.app = null
  }
}

async function cleanupTests (servers: ServerInfo[]) {
  await killallServers(servers)

  if (isGithubCI()) {
    await ensureDir('artifacts')
  }

  let p: Promise<any>[] = []
  for (const server of servers) {
    p = p.concat(server.serversCommand.cleanupTests())
  }

  return Promise.all(p)
}

// ---------------------------------------------------------------------------

export {
  ServerInfo,
  cleanupTests,
  flushAndRunMultipleServers,
  flushAndRunServer,
  killallServers,
  reRunServer,
  assignCommands
}