aboutsummaryrefslogtreecommitdiffhomepage
path: root/shared/extra-utils/server/server.ts
diff options
context:
space:
mode:
Diffstat (limited to 'shared/extra-utils/server/server.ts')
-rw-r--r--shared/extra-utils/server/server.ts389
1 files changed, 0 insertions, 389 deletions
diff --git a/shared/extra-utils/server/server.ts b/shared/extra-utils/server/server.ts
deleted file mode 100644
index 31224ebe9..000000000
--- a/shared/extra-utils/server/server.ts
+++ /dev/null
@@ -1,389 +0,0 @@
1import { ChildProcess, fork } from 'child_process'
2import { copy } from 'fs-extra'
3import { join } from 'path'
4import { root } from '@server/helpers/core-utils'
5import { randomInt } from '@shared/core-utils'
6import { Video, VideoChannel, VideoCreateResult, VideoDetails } from '../../models/videos'
7import { BulkCommand } from '../bulk'
8import { CLICommand } from '../cli'
9import { CustomPagesCommand } from '../custom-pages'
10import { FeedCommand } from '../feeds'
11import { LogsCommand } from '../logs'
12import { parallelTests, SQLCommand } from '../miscs'
13import { AbusesCommand } from '../moderation'
14import { OverviewsCommand } from '../overviews'
15import { SearchCommand } from '../search'
16import { SocketIOCommand } from '../socket'
17import { AccountsCommand, BlocklistCommand, LoginCommand, NotificationsCommand, SubscriptionsCommand, UsersCommand } from '../users'
18import {
19 BlacklistCommand,
20 CaptionsCommand,
21 ChangeOwnershipCommand,
22 ChannelsCommand,
23 HistoryCommand,
24 ImportsCommand,
25 LiveCommand,
26 PlaylistsCommand,
27 ServicesCommand,
28 StreamingPlaylistsCommand,
29 VideosCommand
30} from '../videos'
31import { CommentsCommand } from '../videos/comments-command'
32import { ConfigCommand } from './config-command'
33import { ContactFormCommand } from './contact-form-command'
34import { DebugCommand } from './debug-command'
35import { FollowsCommand } from './follows-command'
36import { JobsCommand } from './jobs-command'
37import { PluginsCommand } from './plugins-command'
38import { RedundancyCommand } from './redundancy-command'
39import { ServersCommand } from './servers-command'
40import { StatsCommand } from './stats-command'
41import { ObjectStorageCommand } from './object-storage-command'
42
43export type RunServerOptions = {
44 hideLogs?: boolean
45 nodeArgs?: string[]
46 peertubeArgs?: string[]
47 env?: { [ id: string ]: string }
48}
49
50export class PeerTubeServer {
51 app?: ChildProcess
52
53 url: string
54 host?: string
55 hostname?: string
56 port?: number
57
58 rtmpPort?: number
59 rtmpsPort?: number
60
61 parallel?: boolean
62 internalServerNumber: number
63
64 serverNumber?: number
65 customConfigFile?: string
66
67 store?: {
68 client?: {
69 id?: string
70 secret?: string
71 }
72
73 user?: {
74 username: string
75 password: string
76 email?: string
77 }
78
79 channel?: VideoChannel
80
81 video?: Video
82 videoCreated?: VideoCreateResult
83 videoDetails?: VideoDetails
84
85 videos?: { id: number, uuid: string }[]
86 }
87
88 accessToken?: string
89 refreshToken?: string
90
91 bulk?: BulkCommand
92 cli?: CLICommand
93 customPage?: CustomPagesCommand
94 feed?: FeedCommand
95 logs?: LogsCommand
96 abuses?: AbusesCommand
97 overviews?: OverviewsCommand
98 search?: SearchCommand
99 contactForm?: ContactFormCommand
100 debug?: DebugCommand
101 follows?: FollowsCommand
102 jobs?: JobsCommand
103 plugins?: PluginsCommand
104 redundancy?: RedundancyCommand
105 stats?: StatsCommand
106 config?: ConfigCommand
107 socketIO?: SocketIOCommand
108 accounts?: AccountsCommand
109 blocklist?: BlocklistCommand
110 subscriptions?: SubscriptionsCommand
111 live?: LiveCommand
112 services?: ServicesCommand
113 blacklist?: BlacklistCommand
114 captions?: CaptionsCommand
115 changeOwnership?: ChangeOwnershipCommand
116 playlists?: PlaylistsCommand
117 history?: HistoryCommand
118 imports?: ImportsCommand
119 streamingPlaylists?: StreamingPlaylistsCommand
120 channels?: ChannelsCommand
121 comments?: CommentsCommand
122 sql?: SQLCommand
123 notifications?: NotificationsCommand
124 servers?: ServersCommand
125 login?: LoginCommand
126 users?: UsersCommand
127 objectStorage?: ObjectStorageCommand
128 videos?: VideosCommand
129
130 constructor (options: { serverNumber: number } | { url: string }) {
131 if ((options as any).url) {
132 this.setUrl((options as any).url)
133 } else {
134 this.setServerNumber((options as any).serverNumber)
135 }
136
137 this.store = {
138 client: {
139 id: null,
140 secret: null
141 },
142 user: {
143 username: null,
144 password: null
145 }
146 }
147
148 this.assignCommands()
149 }
150
151 setServerNumber (serverNumber: number) {
152 this.serverNumber = serverNumber
153
154 this.parallel = parallelTests()
155
156 this.internalServerNumber = this.parallel ? this.randomServer() : this.serverNumber
157 this.rtmpPort = this.parallel ? this.randomRTMP() : 1936
158 this.rtmpsPort = this.parallel ? this.randomRTMP() : 1937
159 this.port = 9000 + this.internalServerNumber
160
161 this.url = `http://localhost:${this.port}`
162 this.host = `localhost:${this.port}`
163 this.hostname = 'localhost'
164 }
165
166 setUrl (url: string) {
167 const parsed = new URL(url)
168
169 this.url = url
170 this.host = parsed.host
171 this.hostname = parsed.hostname
172 this.port = parseInt(parsed.port)
173 }
174
175 async flushAndRun (configOverride?: Object, options: RunServerOptions = {}) {
176 await ServersCommand.flushTests(this.internalServerNumber)
177
178 return this.run(configOverride, options)
179 }
180
181 async run (configOverrideArg?: any, options: RunServerOptions = {}) {
182 // These actions are async so we need to be sure that they have both been done
183 const serverRunString = {
184 'HTTP server listening': false
185 }
186 const key = 'Database peertube_test' + this.internalServerNumber + ' is ready'
187 serverRunString[key] = false
188
189 const regexps = {
190 client_id: 'Client id: (.+)',
191 client_secret: 'Client secret: (.+)',
192 user_username: 'Username: (.+)',
193 user_password: 'User password: (.+)'
194 }
195
196 await this.assignCustomConfigFile()
197
198 const configOverride = this.buildConfigOverride()
199
200 if (configOverrideArg !== undefined) {
201 Object.assign(configOverride, configOverrideArg)
202 }
203
204 // Share the environment
205 const env = Object.create(process.env)
206 env['NODE_ENV'] = 'test'
207 env['NODE_APP_INSTANCE'] = this.internalServerNumber.toString()
208 env['NODE_CONFIG'] = JSON.stringify(configOverride)
209
210 if (options.env) {
211 Object.assign(env, options.env)
212 }
213
214 const forkOptions = {
215 silent: true,
216 env,
217 detached: true,
218 execArgv: options.nodeArgs || []
219 }
220
221 return new Promise<void>((res, rej) => {
222 const self = this
223
224 this.app = fork(join(root(), 'dist', 'server.js'), options.peertubeArgs || [], forkOptions)
225
226 const onPeerTubeExit = () => rej(new Error('Process exited'))
227 const onParentExit = () => {
228 if (!this.app || !this.app.pid) return
229
230 try {
231 process.kill(self.app.pid)
232 } catch { /* empty */ }
233 }
234
235 this.app.on('exit', onPeerTubeExit)
236 process.on('exit', onParentExit)
237
238 this.app.stdout.on('data', function onStdout (data) {
239 let dontContinue = false
240
241 // Capture things if we want to
242 for (const key of Object.keys(regexps)) {
243 const regexp = regexps[key]
244 const matches = data.toString().match(regexp)
245 if (matches !== null) {
246 if (key === 'client_id') self.store.client.id = matches[1]
247 else if (key === 'client_secret') self.store.client.secret = matches[1]
248 else if (key === 'user_username') self.store.user.username = matches[1]
249 else if (key === 'user_password') self.store.user.password = matches[1]
250 }
251 }
252
253 // Check if all required sentences are here
254 for (const key of Object.keys(serverRunString)) {
255 if (data.toString().indexOf(key) !== -1) serverRunString[key] = true
256 if (serverRunString[key] === false) dontContinue = true
257 }
258
259 // If no, there is maybe one thing not already initialized (client/user credentials generation...)
260 if (dontContinue === true) return
261
262 if (options.hideLogs === false) {
263 console.log(data.toString())
264 } else {
265 process.removeListener('exit', onParentExit)
266 self.app.stdout.removeListener('data', onStdout)
267 self.app.removeListener('exit', onPeerTubeExit)
268 }
269
270 res()
271 })
272 })
273 }
274
275 async kill () {
276 if (!this.app) return
277
278 await this.sql.cleanup()
279
280 process.kill(-this.app.pid)
281
282 this.app = null
283 }
284
285 private randomServer () {
286 const low = 10
287 const high = 10000
288
289 return randomInt(low, high)
290 }
291
292 private randomRTMP () {
293 const low = 1900
294 const high = 2100
295
296 return randomInt(low, high)
297 }
298
299 private async assignCustomConfigFile () {
300 if (this.internalServerNumber === this.serverNumber) return
301
302 const basePath = join(root(), 'config')
303
304 const tmpConfigFile = join(basePath, `test-${this.internalServerNumber}.yaml`)
305 await copy(join(basePath, `test-${this.serverNumber}.yaml`), tmpConfigFile)
306
307 this.customConfigFile = tmpConfigFile
308 }
309
310 private buildConfigOverride () {
311 if (!this.parallel) return {}
312
313 return {
314 listen: {
315 port: this.port
316 },
317 webserver: {
318 port: this.port
319 },
320 database: {
321 suffix: '_test' + this.internalServerNumber
322 },
323 storage: {
324 tmp: `test${this.internalServerNumber}/tmp/`,
325 bin: `test${this.internalServerNumber}/bin/`,
326 avatars: `test${this.internalServerNumber}/avatars/`,
327 videos: `test${this.internalServerNumber}/videos/`,
328 streaming_playlists: `test${this.internalServerNumber}/streaming-playlists/`,
329 redundancy: `test${this.internalServerNumber}/redundancy/`,
330 logs: `test${this.internalServerNumber}/logs/`,
331 previews: `test${this.internalServerNumber}/previews/`,
332 thumbnails: `test${this.internalServerNumber}/thumbnails/`,
333 torrents: `test${this.internalServerNumber}/torrents/`,
334 captions: `test${this.internalServerNumber}/captions/`,
335 cache: `test${this.internalServerNumber}/cache/`,
336 plugins: `test${this.internalServerNumber}/plugins/`
337 },
338 admin: {
339 email: `admin${this.internalServerNumber}@example.com`
340 },
341 live: {
342 rtmp: {
343 port: this.rtmpPort
344 }
345 }
346 }
347 }
348
349 private assignCommands () {
350 this.bulk = new BulkCommand(this)
351 this.cli = new CLICommand(this)
352 this.customPage = new CustomPagesCommand(this)
353 this.feed = new FeedCommand(this)
354 this.logs = new LogsCommand(this)
355 this.abuses = new AbusesCommand(this)
356 this.overviews = new OverviewsCommand(this)
357 this.search = new SearchCommand(this)
358 this.contactForm = new ContactFormCommand(this)
359 this.debug = new DebugCommand(this)
360 this.follows = new FollowsCommand(this)
361 this.jobs = new JobsCommand(this)
362 this.plugins = new PluginsCommand(this)
363 this.redundancy = new RedundancyCommand(this)
364 this.stats = new StatsCommand(this)
365 this.config = new ConfigCommand(this)
366 this.socketIO = new SocketIOCommand(this)
367 this.accounts = new AccountsCommand(this)
368 this.blocklist = new BlocklistCommand(this)
369 this.subscriptions = new SubscriptionsCommand(this)
370 this.live = new LiveCommand(this)
371 this.services = new ServicesCommand(this)
372 this.blacklist = new BlacklistCommand(this)
373 this.captions = new CaptionsCommand(this)
374 this.changeOwnership = new ChangeOwnershipCommand(this)
375 this.playlists = new PlaylistsCommand(this)
376 this.history = new HistoryCommand(this)
377 this.imports = new ImportsCommand(this)
378 this.streamingPlaylists = new StreamingPlaylistsCommand(this)
379 this.channels = new ChannelsCommand(this)
380 this.comments = new CommentsCommand(this)
381 this.sql = new SQLCommand(this)
382 this.notifications = new NotificationsCommand(this)
383 this.servers = new ServersCommand(this)
384 this.login = new LoginCommand(this)
385 this.users = new UsersCommand(this)
386 this.videos = new VideosCommand(this)
387 this.objectStorage = new ObjectStorageCommand(this)
388 }
389}