1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import { expect } from 'chai'
5 import { pathExists, readdir, remove } from 'fs-extra'
6 import { join } from 'path'
7 import { FIXTURE_URLS, testCaptionFile, testImage } from '@server/tests/shared'
8 import { areHttpImportTestsDisabled } from '@shared/core-utils'
9 import { HttpStatusCode, Video, VideoImportState, VideoPrivacy, VideoResolution, VideoState } from '@shared/models'
12 createMultipleServers,
16 setAccessTokensToServers,
17 setDefaultVideoChannel,
19 } from '@shared/server-commands'
21 async function checkVideosServer1 (server: PeerTubeServer, idHttp: string, idMagnet: string, idTorrent: string) {
22 const videoHttp = await server.videos.get({ id: idHttp })
24 expect(videoHttp.name).to.equal('small video - youtube')
25 // FIXME: youtube-dl seems broken
26 // expect(videoHttp.category.label).to.equal('News & Politics')
27 // expect(videoHttp.licence.label).to.equal('Attribution')
28 expect(videoHttp.language.label).to.equal('Unknown')
29 expect(videoHttp.nsfw).to.be.false
30 expect(videoHttp.description).to.equal('this is a super description')
31 expect(videoHttp.tags).to.deep.equal([ 'tag1', 'tag2' ])
32 expect(videoHttp.files).to.have.lengthOf(1)
34 const originallyPublishedAt = new Date(videoHttp.originallyPublishedAt)
35 expect(originallyPublishedAt.getDate()).to.equal(14)
36 expect(originallyPublishedAt.getMonth()).to.equal(0)
37 expect(originallyPublishedAt.getFullYear()).to.equal(2019)
39 const videoMagnet = await server.videos.get({ id: idMagnet })
40 const videoTorrent = await server.videos.get({ id: idTorrent })
42 for (const video of [ videoMagnet, videoTorrent ]) {
43 expect(video.category.label).to.equal('Misc')
44 expect(video.licence.label).to.equal('Unknown')
45 expect(video.language.label).to.equal('Unknown')
46 expect(video.nsfw).to.be.false
47 expect(video.description).to.equal('this is a super torrent description')
48 expect(video.tags).to.deep.equal([ 'tag_torrent1', 'tag_torrent2' ])
49 expect(video.files).to.have.lengthOf(1)
52 expect(videoTorrent.name).to.contain('你好 世界 720p.mp4')
53 expect(videoMagnet.name).to.contain('super peertube2 video')
55 const bodyCaptions = await server.captions.list({ videoId: idHttp })
56 expect(bodyCaptions.total).to.equal(2)
59 async function checkVideoServer2 (server: PeerTubeServer, id: number | string) {
60 const video = await server.videos.get({ id })
62 expect(video.name).to.equal('my super name')
63 expect(video.category.label).to.equal('Entertainment')
64 expect(video.licence.label).to.equal('Public Domain Dedication')
65 expect(video.language.label).to.equal('English')
66 expect(video.nsfw).to.be.false
67 expect(video.description).to.equal('my super description')
68 expect(video.tags).to.deep.equal([ 'supertag1', 'supertag2' ])
70 expect(video.files).to.have.lengthOf(1)
72 const bodyCaptions = await server.captions.list({ videoId: id })
73 expect(bodyCaptions.total).to.equal(2)
76 describe('Test video imports', function () {
78 if (areHttpImportTestsDisabled()) return
80 function runSuite (mode: 'youtube-dl' | 'yt-dlp') {
82 describe('Import ' + mode, function () {
83 let servers: PeerTubeServer[] = []
85 before(async function () {
89 servers = await createMultipleServers(2, {
94 url: mode === 'youtube-dl'
95 ? 'https://yt-dl.org/downloads/latest/youtube-dl'
96 : 'https://api.github.com/repos/yt-dlp/yt-dlp/releases',
105 await setAccessTokensToServers(servers)
106 await setDefaultVideoChannel(servers)
108 await doubleFollow(servers[0], servers[1])
111 it('Should import videos on server 1', async function () {
114 const baseAttributes = {
115 channelId: servers[0].store.channel.id,
116 privacy: VideoPrivacy.PUBLIC
120 const attributes = { ...baseAttributes, targetUrl: FIXTURE_URLS.youtube }
121 const { video } = await servers[0].imports.importVideo({ attributes })
122 expect(video.name).to.equal('small video - youtube')
125 expect(video.thumbnailPath).to.match(new RegExp(`^/static/thumbnails/.+.jpg$`))
126 expect(video.previewPath).to.match(new RegExp(`^/lazy-static/previews/.+.jpg$`))
128 const suffix = mode === 'yt-dlp'
132 await testImage(servers[0].url, 'video_import_thumbnail' + suffix, video.thumbnailPath)
133 await testImage(servers[0].url, 'video_import_preview' + suffix, video.previewPath)
136 const bodyCaptions = await servers[0].captions.list({ videoId: video.id })
137 const videoCaptions = bodyCaptions.data
138 expect(videoCaptions).to.have.lengthOf(2)
141 const enCaption = videoCaptions.find(caption => caption.language.id === 'en')
142 expect(enCaption).to.exist
143 expect(enCaption.language.label).to.equal('English')
144 expect(enCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-en.vtt$`))
146 const regex = `WEBVTT[ \n]+Kind: captions[ \n]+` +
147 `(Language: en[ \n]+)?` +
148 `00:00:01.600 --> 00:00:04.200( position:\\d+% line:\\d+%)?[ \n]+English \\(US\\)[ \n]+` +
149 `00:00:05.900 --> 00:00:07.999( position:\\d+% line:\\d+%)?[ \n]+This is a subtitle in American English[ \n]+` +
150 `00:00:10.000 --> 00:00:14.000( position:\\d+% line:\\d+%)?[ \n]+Adding subtitles is very easy to do`
151 await testCaptionFile(servers[0].url, enCaption.captionPath, new RegExp(regex))
155 const frCaption = videoCaptions.find(caption => caption.language.id === 'fr')
156 expect(frCaption).to.exist
157 expect(frCaption.language.label).to.equal('French')
158 expect(frCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-fr.vtt`))
160 const regex = `WEBVTT[ \n]+Kind: captions[ \n]+` +
161 `(Language: fr[ \n]+)?` +
162 `00:00:01.600 --> 00:00:04.200( position:\\d+% line:\\d+%)?[ \n]+Français \\(FR\\)[ \n]+` +
163 `00:00:05.900 --> 00:00:07.999( position:\\d+% line:\\d+%)?[ \n]+C'est un sous-titre français[ \n]+` +
164 `00:00:10.000 --> 00:00:14.000( position:\\d+% line:\\d+%)?[ \n]+Ajouter un sous-titre est vraiment facile`
166 await testCaptionFile(servers[0].url, frCaption.captionPath, new RegExp(regex))
173 magnetUri: FIXTURE_URLS.magnet,
174 description: 'this is a super torrent description',
175 tags: [ 'tag_torrent1', 'tag_torrent2' ]
177 const { video } = await servers[0].imports.importVideo({ attributes })
178 expect(video.name).to.equal('super peertube2 video')
184 torrentfile: 'video-720p.torrent' as any,
185 description: 'this is a super torrent description',
186 tags: [ 'tag_torrent1', 'tag_torrent2' ]
188 const { video } = await servers[0].imports.importVideo({ attributes })
189 expect(video.name).to.equal('你好 世界 720p.mp4')
193 it('Should list the videos to import in my videos on server 1', async function () {
194 const { total, data } = await servers[0].videos.listMyVideos({ sort: 'createdAt' })
196 expect(total).to.equal(3)
198 expect(data).to.have.lengthOf(3)
199 expect(data[0].name).to.equal('small video - youtube')
200 expect(data[1].name).to.equal('super peertube2 video')
201 expect(data[2].name).to.equal('你好 世界 720p.mp4')
204 it('Should list the videos to import in my imports on server 1', async function () {
205 const { total, data: videoImports } = await servers[0].imports.getMyVideoImports({ sort: '-createdAt' })
206 expect(total).to.equal(3)
208 expect(videoImports).to.have.lengthOf(3)
210 expect(videoImports[2].targetUrl).to.equal(FIXTURE_URLS.youtube)
211 expect(videoImports[2].magnetUri).to.be.null
212 expect(videoImports[2].torrentName).to.be.null
213 expect(videoImports[2].video.name).to.equal('small video - youtube')
215 expect(videoImports[1].targetUrl).to.be.null
216 expect(videoImports[1].magnetUri).to.equal(FIXTURE_URLS.magnet)
217 expect(videoImports[1].torrentName).to.be.null
218 expect(videoImports[1].video.name).to.equal('super peertube2 video')
220 expect(videoImports[0].targetUrl).to.be.null
221 expect(videoImports[0].magnetUri).to.be.null
222 expect(videoImports[0].torrentName).to.equal('video-720p.torrent')
223 expect(videoImports[0].video.name).to.equal('你好 世界 720p.mp4')
226 it('Should filter my imports on target URL', async function () {
227 const { total, data: videoImports } = await servers[0].imports.getMyVideoImports({ targetUrl: FIXTURE_URLS.youtube })
228 expect(total).to.equal(1)
229 expect(videoImports).to.have.lengthOf(1)
231 expect(videoImports[0].targetUrl).to.equal(FIXTURE_URLS.youtube)
234 it('Should have the video listed on the two instances', async function () {
235 this.timeout(120_000)
237 await waitJobs(servers)
239 for (const server of servers) {
240 const { total, data } = await server.videos.list()
241 expect(total).to.equal(3)
242 expect(data).to.have.lengthOf(3)
244 const [ videoHttp, videoMagnet, videoTorrent ] = data
245 await checkVideosServer1(server, videoHttp.uuid, videoMagnet.uuid, videoTorrent.uuid)
249 it('Should import a video on server 2 with some fields', async function () {
253 targetUrl: FIXTURE_URLS.youtube,
254 channelId: servers[1].store.channel.id,
255 privacy: VideoPrivacy.PUBLIC,
259 name: 'my super name',
260 description: 'my super description',
261 tags: [ 'supertag1', 'supertag2' ]
263 const { video } = await servers[1].imports.importVideo({ attributes })
264 expect(video.name).to.equal('my super name')
267 it('Should have the videos listed on the two instances', async function () {
268 this.timeout(120_000)
270 await waitJobs(servers)
272 for (const server of servers) {
273 const { total, data } = await server.videos.list()
274 expect(total).to.equal(4)
275 expect(data).to.have.lengthOf(4)
277 await checkVideoServer2(server, data[0].uuid)
279 const [ , videoHttp, videoMagnet, videoTorrent ] = data
280 await checkVideosServer1(server, videoHttp.uuid, videoMagnet.uuid, videoTorrent.uuid)
284 it('Should import a video that will be transcoded', async function () {
285 this.timeout(240_000)
288 name: 'transcoded video',
289 magnetUri: FIXTURE_URLS.magnet,
290 channelId: servers[1].store.channel.id,
291 privacy: VideoPrivacy.PUBLIC
293 const { video } = await servers[1].imports.importVideo({ attributes })
294 const videoUUID = video.uuid
296 await waitJobs(servers)
298 for (const server of servers) {
299 const video = await server.videos.get({ id: videoUUID })
301 expect(video.name).to.equal('transcoded video')
302 expect(video.files).to.have.lengthOf(4)
306 it('Should import no HDR version on a HDR video', async function () {
307 this.timeout(300_000)
318 '1080p': false, // the resulting resolution shouldn't be higher than this, and not vp9.2/av01
322 webtorrent: { enabled: true },
323 hls: { enabled: false }
336 await servers[0].config.updateCustomSubConfig({ newConfig: config })
340 targetUrl: FIXTURE_URLS.youtubeHDR,
341 channelId: servers[0].store.channel.id,
342 privacy: VideoPrivacy.PUBLIC
344 const { video: videoImported } = await servers[0].imports.importVideo({ attributes })
345 const videoUUID = videoImported.uuid
347 await waitJobs(servers)
350 const video = await servers[0].videos.get({ id: videoUUID })
351 expect(video.name).to.equal('hdr video')
352 const maxResolution = Math.max.apply(Math, video.files.map(function (o) { return o.resolution.id }))
353 expect(maxResolution, 'expected max resolution not met').to.equals(VideoResolution.H_240P)
356 it('Should import a peertube video', async function () {
357 this.timeout(120_000)
359 const toTest = [ FIXTURE_URLS.peertube_long ]
361 // TODO: include peertube_short when https://github.com/ytdl-org/youtube-dl/pull/29475 is merged
362 if (mode === 'yt-dlp') {
363 toTest.push(FIXTURE_URLS.peertube_short)
366 for (const targetUrl of toTest) {
367 await servers[0].config.disableTranscoding()
371 channelId: servers[0].store.channel.id,
372 privacy: VideoPrivacy.PUBLIC
374 const { video } = await servers[0].imports.importVideo({ attributes })
375 const videoUUID = video.uuid
377 await waitJobs(servers)
379 for (const server of servers) {
380 const video = await server.videos.get({ id: videoUUID })
382 expect(video.name).to.equal('E2E tests')
387 after(async function () {
388 await cleanupTests(servers)
393 runSuite('youtube-dl')
397 describe('Delete/cancel an import', function () {
398 let server: PeerTubeServer
400 let finishedImportId: number
401 let finishedVideo: Video
402 let pendingImportId: number
404 async function importVideo (name: string) {
405 const attributes = { name, channelId: server.store.channel.id, targetUrl: FIXTURE_URLS.goodVideo }
406 const res = await server.imports.importVideo({ attributes })
411 before(async function () {
412 this.timeout(120_000)
414 server = await createSingleServer(1)
416 await setAccessTokensToServers([ server ])
417 await setDefaultVideoChannel([ server ])
419 finishedImportId = await importVideo('finished')
420 await waitJobs([ server ])
422 await server.jobs.pauseJobQueue()
423 pendingImportId = await importVideo('pending')
425 const { data } = await server.imports.getMyVideoImports()
426 expect(data).to.have.lengthOf(2)
428 finishedVideo = data.find(i => i.id === finishedImportId).video
431 it('Should delete a video import', async function () {
432 await server.imports.delete({ importId: finishedImportId })
434 const { data } = await server.imports.getMyVideoImports()
435 expect(data).to.have.lengthOf(1)
436 expect(data[0].id).to.equal(pendingImportId)
437 expect(data[0].state.id).to.equal(VideoImportState.PENDING)
440 it('Should not have deleted the associated video', async function () {
441 const video = await server.videos.get({ id: finishedVideo.id, token: server.accessToken, expectedStatus: HttpStatusCode.OK_200 })
442 expect(video.name).to.equal('finished')
443 expect(video.state.id).to.equal(VideoState.PUBLISHED)
446 it('Should cancel a video import', async function () {
447 await server.imports.cancel({ importId: pendingImportId })
449 const { data } = await server.imports.getMyVideoImports()
450 expect(data).to.have.lengthOf(1)
451 expect(data[0].id).to.equal(pendingImportId)
452 expect(data[0].state.id).to.equal(VideoImportState.CANCELLED)
455 it('Should not have processed the cancelled video import', async function () {
458 await server.jobs.resumeJobQueue()
460 await waitJobs([ server ])
462 const { data } = await server.imports.getMyVideoImports()
463 expect(data).to.have.lengthOf(1)
464 expect(data[0].id).to.equal(pendingImportId)
465 expect(data[0].state.id).to.equal(VideoImportState.CANCELLED)
466 expect(data[0].video.state.id).to.equal(VideoState.TO_IMPORT)
469 it('Should delete the cancelled video import', async function () {
470 await server.imports.delete({ importId: pendingImportId })
471 const { data } = await server.imports.getMyVideoImports()
472 expect(data).to.have.lengthOf(0)
475 after(async function () {
476 await cleanupTests([ server ])
480 describe('Auto update', function () {
481 let server: PeerTubeServer
483 function quickPeerTubeImport () {
485 targetUrl: FIXTURE_URLS.peertube_long,
486 channelId: server.store.channel.id,
487 privacy: VideoPrivacy.PUBLIC
490 return server.imports.importVideo({ attributes })
493 async function testBinaryUpdate (releaseUrl: string, releaseName: string) {
494 await remove(join(server.servers.buildDirectory('bin'), releaseName))
501 youtube_dl_release: {
510 await quickPeerTubeImport()
512 const base = server.servers.buildDirectory('bin')
513 const content = await readdir(base)
514 const binaryPath = join(base, releaseName)
516 expect(await pathExists(binaryPath), `${binaryPath} does not exist in ${base} (${content.join(', ')})`).to.be.true
519 before(async function () {
523 server = await createSingleServer(1)
525 await setAccessTokensToServers([ server ])
526 await setDefaultVideoChannel([ server ])
529 it('Should update youtube-dl from github URL', async function () {
530 this.timeout(120_000)
532 await testBinaryUpdate('https://api.github.com/repos/ytdl-org/youtube-dl/releases', 'youtube-dl')
535 it('Should update youtube-dl from raw URL', async function () {
536 this.timeout(120_000)
538 await testBinaryUpdate('https://yt-dl.org/downloads/latest/youtube-dl', 'youtube-dl')
541 it('Should update youtube-dl from youtube-dl fork', async function () {
542 this.timeout(120_000)
544 await testBinaryUpdate('https://api.github.com/repos/yt-dlp/yt-dlp/releases', 'yt-dlp')
547 after(async function () {
548 await cleanupTests([ server ])