]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - shared/extra-utils/server/servers.ts
Adapt CLI to new commands
[github/Chocobozzz/PeerTube.git] / shared / extra-utils / server / servers.ts
index b4bd55968b98e61cfa7eb862fcb7c0ae7e1e8204..4d95996800ce4010d73852e51420fc91a1f19e62 100644 (file)
@@ -1,31 +1,65 @@
 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
 
-import { ChildProcess, exec, fork } from 'child_process'
+import { ChildProcess, fork } from 'child_process'
+import { copy, ensureDir } from 'fs-extra'
 import { join } from 'path'
-import { root, wait } from '../miscs/miscs'
-import { copy, pathExists, readdir, readFile, remove } from 'fs-extra'
-import { expect } from 'chai'
-import { VideoChannel } from '../../models/videos'
+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, LoginCommand, 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
+  app?: ChildProcess
 
   url: string
-  host: string
-  hostname: string
-  port: number
+  host?: string
+  hostname?: string
+  port?: number
+
+  rtmpPort?: number
 
-  parallel: boolean
+  parallel?: boolean
   internalServerNumber: number
-  serverNumber: number
+  serverNumber?: number
 
-  client: {
-    id: string
-    secret: string
+  client?: {
+    id?: string
+    secret?: string
   }
 
-  user: {
+  user?: {
     username: string
     password: string
     email?: string
@@ -34,15 +68,21 @@ interface ServerInfo {
   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?: {
@@ -51,10 +91,42 @@ interface ServerInfo {
   }
 
   videos?: { id: number, uuid: string }[]
-}
 
-function parallelTests () {
-  return process.env.MOCHA_PARALLEL === 'true'
+  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
+  loginCommand?: LoginCommand
 }
 
 function flushAndRunMultipleServers (totalServers: number, configOverride?: Object) {
@@ -76,18 +148,6 @@ function flushAndRunMultipleServers (totalServers: number, configOverride?: Obje
   })
 }
 
-function flushTests (serverNumber?: number) {
-  return new Promise<void>((res, rej) => {
-    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 randomServer () {
   const low = 10
   const high = 10000
@@ -95,18 +155,32 @@ function randomServer () {
   return randomInt(low, high)
 }
 
-async function flushAndRunServer (serverNumber: number, configOverride?: Object, args = []) {
+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)
+  await ServersCommand.flushTests(internalServerNumber)
 
   const server: ServerInfo = {
     app: null,
     port,
     internalServerNumber,
+    rtmpPort,
     parallel,
     serverNumber,
     url: `http://localhost:${port}`,
@@ -122,13 +196,13 @@ async function flushAndRunServer (serverNumber: number, configOverride?: Object,
     }
   }
 
-  return runServer(server, configOverride, args)
+  return runServer(server, configOverride, args, options)
 }
 
-async function runServer (server: ServerInfo, configOverrideArg?: any, args = []) {
+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
+    'HTTP server listening': false
   }
   const key = 'Database peertube_test' + server.internalServerNumber + ' is ready'
   serverRunString[key] = false
@@ -178,6 +252,11 @@ async function runServer (server: ServerInfo, configOverrideArg?: any, args = []
       },
       admin: {
         email: `admin${server.internalServerNumber}@example.com`
+      },
+      live: {
+        rtmp: {
+          port: server.rtmpPort
+        }
       }
     })
   }
@@ -192,14 +271,15 @@ async function runServer (server: ServerInfo, configOverrideArg?: any, args = []
   env['NODE_APP_INSTANCE'] = server.internalServerNumber.toString()
   env['NODE_CONFIG'] = JSON.stringify(configOverride)
 
-  const options = {
+  const forkOptions = {
     silent: true,
     env,
-    detached: true
+    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
 
@@ -224,7 +304,11 @@ async function runServer (server: ServerInfo, configOverrideArg?: any, 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 {
@@ -232,11 +316,51 @@ async function runServer (server: ServerInfo, configOverrideArg?: any, args = []
         } 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)
+  server.loginCommand = new LoginCommand(server)
+}
+
 async function reRunServer (server: ServerInfo, configOverride?: any) {
   const newServer = await runServer(server, configOverride)
   server.app = newServer.app
@@ -244,76 +368,41 @@ async function reRunServer (server: ServerInfo, configOverride?: any) {
   return server
 }
 
-function checkTmpIsEmpty (server: ServerInfo) {
-  return checkDirectoryIsEmpty(server, 'tmp', [ 'plugins-global.css' ])
-}
-
-async function checkDirectoryIsEmpty (server: ServerInfo, directory: string, exceptions: string[] = []) {
-  const testDirectory = 'test' + server.internalServerNumber
-
-  const directoryPath = join(root(), testDirectory, directory)
-
-  const directoryExists = await pathExists(directoryPath)
-  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)
-}
-
-function killallServers (servers: ServerInfo[]) {
+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
   }
 }
 
-function cleanupTests (servers: ServerInfo[]) {
-  killallServers(servers)
+async function cleanupTests (servers: ServerInfo[]) {
+  await killallServers(servers)
 
-  const p: Promise<any>[] = []
-  for (const server of servers) {
-    if (server.parallel) {
-      p.push(flushTests(server.internalServerNumber))
-    }
+  if (isGithubCI()) {
+    await ensureDir('artifacts')
+  }
 
-    if (server.customConfigFile) {
-      p.push(remove(server.customConfigFile))
-    }
+  let p: Promise<any>[] = []
+  for (const server of servers) {
+    p = p.concat(server.serversCommand.cleanupTests())
   }
 
   return Promise.all(p)
 }
 
-async function waitUntilLog (server: ServerInfo, str: string, count = 1, strictCount = true) {
-  const logfile = join(root(), 'test' + server.internalServerNumber, '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)
-  }
-}
-
 // ---------------------------------------------------------------------------
 
 export {
-  checkDirectoryIsEmpty,
-  checkTmpIsEmpty,
   ServerInfo,
-  parallelTests,
   cleanupTests,
   flushAndRunMultipleServers,
-  flushTests,
   flushAndRunServer,
   killallServers,
   reRunServer,
-  waitUntilLog
+  assignCommands
 }