From 38dbafcf63cf780f50e8c1b073839dce2a7becf7 Mon Sep 17 00:00:00 2001
From: Chocobozzz <me@florianbigard.com>
Date: Tue, 13 Aug 2024 14:16:00 +0200
Subject: [PATCH] Support youtube-dl executables
Also disable youtube tests in CI due to youtube blocking
---
.github/workflows/test.yml | 2 +
config/default.yaml | 10 +-
config/production.yaml.example | 10 +-
packages/node-utils/src/env.ts | 8 +
packages/tests/src/api/server/proxy.ts | 2 +-
.../src/api/videos/channel-import-videos.ts | 7 +-
.../src/api/videos/video-channel-syncs.ts | 7 +-
.../tests/src/api/videos/video-chapters.ts | 6 +-
.../tests/src/api/videos/video-imports.ts | 276 ++++++++++--------
packages/tests/src/shared/fixture-urls.ts | 4 +-
.../core/helpers/youtube-dl/youtube-dl-cli.ts | 15 +-
support/doc/development/tests.md | 8 +-
12 files changed, 221 insertions(+), 134 deletions(-)
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 10f5c194a..2cb60e2b9 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -46,6 +46,8 @@ jobs:
PGHOST: localhost
NODE_PENDING_JOB_WAIT: 250
ENABLE_OBJECT_STORAGE_TESTS: true
+ # Github runner IPs are blocked by youtube
+ DISABLE_HTTP_YOUTUBE_IMPORT_TESTS: true
ENABLE_FFMPEG_THUMBNAIL_PIXEL_COMPARISON_TESTS: true
OBJECT_STORAGE_SCALEWAY_KEY_ID: ${{ secrets.OBJECT_STORAGE_SCALEWAY_KEY_ID }}
OBJECT_STORAGE_SCALEWAY_ACCESS_KEY: ${{ secrets.OBJECT_STORAGE_SCALEWAY_ACCESS_KEY }}
diff --git a/config/default.yaml b/config/default.yaml
index 5fcb03613..acc17ee84 100644
--- a/config/default.yaml
+++ b/config/default.yaml
@@ -788,16 +788,24 @@ import:
youtube_dl_release:
# Direct download URL to youtube-dl binary
# Github releases API is also supported
- # Examples:
+ #
+ # Platform-independent examples:
# * https://api.github.com/repos/ytdl-org/youtube-dl/releases
# * https://api.github.com/repos/yt-dlp/yt-dlp/releases
# * https://yt-dl.org/downloads/latest/youtube-dl
+ #
+ # You can also use a youtube-dl standalone binary (requires python_path: null)
+ # GNU/Linux binaries with support for impersonating browser requests (required by some platforms such as Vimeo) examples:
+ # * https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux (x64)
+ # * https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_armv7l (ARMv7)
+ # * https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_armv7l (ARMv8/AArch64/ARM64)
url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
# Release binary name: 'yt-dlp' or 'youtube-dl'
name: 'yt-dlp'
# Path to the python binary to execute for youtube-dl or yt-dlp
+ # Set to null if you use a youtube-dl executable
python_path: '/usr/bin/python3'
# IPv6 is very strongly rate-limited on most sites supported by youtube-dl
diff --git a/config/production.yaml.example b/config/production.yaml.example
index 0b186ab65..736f26cda 100644
--- a/config/production.yaml.example
+++ b/config/production.yaml.example
@@ -798,16 +798,24 @@ import:
youtube_dl_release:
# Direct download URL to youtube-dl binary
# Github releases API is also supported
- # Examples:
+ #
+ # Platform-independent examples:
# * https://api.github.com/repos/ytdl-org/youtube-dl/releases
# * https://api.github.com/repos/yt-dlp/yt-dlp/releases
# * https://yt-dl.org/downloads/latest/youtube-dl
+ #
+ # You can also use a youtube-dl standalone binary (requires python_path: null)
+ # GNU/Linux binaries with support for impersonating browser requests (required by some platforms such as Vimeo) examples:
+ # * https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux (x64)
+ # * https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_armv7l (ARMv7)
+ # * https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux_armv7l (ARMv8/AArch64/ARM64)
url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
# Release binary name: 'yt-dlp' or 'youtube-dl'
name: 'yt-dlp'
# Path to the python binary to execute for youtube-dl or yt-dlp
+ # Set to null if you use a youtube-dl executable
python_path: '/usr/bin/python3'
# IPv6 is very strongly rate-limited on most sites supported by youtube-dl
diff --git a/packages/node-utils/src/env.ts b/packages/node-utils/src/env.ts
index 1c6a956b9..dfbb50833 100644
--- a/packages/node-utils/src/env.ts
+++ b/packages/node-utils/src/env.ts
@@ -14,6 +14,14 @@ export function areHttpImportTestsDisabled () {
return disabled
}
+export function areYoutubeImportTestsDisabled () {
+ const disabled = process.env.DISABLE_HTTP_YOUTUBE_IMPORT_TESTS === 'true'
+
+ if (disabled) console.log('DISABLE_HTTP_YOUTUBE_IMPORT_TESTS env set to "true" so youtube import tests are disabled')
+
+ return disabled
+}
+
export function areMockObjectStorageTestsDisabled () {
const disabled = process.env.ENABLE_OBJECT_STORAGE_TESTS !== 'true'
diff --git a/packages/tests/src/api/server/proxy.ts b/packages/tests/src/api/server/proxy.ts
index 8e1b50e76..6c9d5db69 100644
--- a/packages/tests/src/api/server/proxy.ts
+++ b/packages/tests/src/api/server/proxy.ts
@@ -90,7 +90,7 @@ describe('Test proxy', function () {
name: 'video import',
channelId: servers[0].store.channel.id,
privacy: VideoPrivacy.PUBLIC,
- targetUrl: FIXTURE_URLS.peertube_long
+ targetUrl: FIXTURE_URLS.peertubeLong
},
expectedStatus
})
diff --git a/packages/tests/src/api/videos/channel-import-videos.ts b/packages/tests/src/api/videos/channel-import-videos.ts
index 8827f0782..d89ce3448 100644
--- a/packages/tests/src/api/videos/channel-import-videos.ts
+++ b/packages/tests/src/api/videos/channel-import-videos.ts
@@ -1,8 +1,6 @@
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
-import { expect } from 'chai'
-import { FIXTURE_URLS } from '@tests/shared/fixture-urls.js'
-import { areHttpImportTestsDisabled } from '@peertube/peertube-node-utils'
+import { areHttpImportTestsDisabled, areYoutubeImportTestsDisabled } from '@peertube/peertube-node-utils'
import {
createSingleServer,
getServerImportConfig,
@@ -11,9 +9,12 @@ import {
setDefaultVideoChannel,
waitJobs
} from '@peertube/peertube-server-commands'
+import { FIXTURE_URLS } from '@tests/shared/fixture-urls.js'
+import { expect } from 'chai'
describe('Test videos import in a channel', function () {
if (areHttpImportTestsDisabled()) return
+ if (areYoutubeImportTestsDisabled()) return
function runSuite (mode: 'youtube-dl' | 'yt-dlp') {
diff --git a/packages/tests/src/api/videos/video-channel-syncs.ts b/packages/tests/src/api/videos/video-channel-syncs.ts
index 098d33c02..b3cd82eae 100644
--- a/packages/tests/src/api/videos/video-channel-syncs.ts
+++ b/packages/tests/src/api/videos/video-channel-syncs.ts
@@ -1,8 +1,7 @@
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
-import { expect } from 'chai'
-import { areHttpImportTestsDisabled } from '@peertube/peertube-node-utils'
import { VideoChannelSyncState, VideoInclude, VideoPrivacy } from '@peertube/peertube-models'
+import { areHttpImportTestsDisabled, areYoutubeImportTestsDisabled } from '@peertube/peertube-node-utils'
import {
cleanupTests,
createMultipleServers,
@@ -14,11 +13,13 @@ import {
setDefaultVideoChannel,
waitJobs
} from '@peertube/peertube-server-commands'
-import { SQLCommand } from '@tests/shared/sql-command.js'
import { FIXTURE_URLS } from '@tests/shared/fixture-urls.js'
+import { SQLCommand } from '@tests/shared/sql-command.js'
+import { expect } from 'chai'
describe('Test channel synchronizations', function () {
if (areHttpImportTestsDisabled()) return
+ if (areYoutubeImportTestsDisabled()) return
function runSuite (mode: 'youtube-dl' | 'yt-dlp') {
diff --git a/packages/tests/src/api/videos/video-chapters.ts b/packages/tests/src/api/videos/video-chapters.ts
index 5be0e33d6..848f30b85 100644
--- a/packages/tests/src/api/videos/video-chapters.ts
+++ b/packages/tests/src/api/videos/video-chapters.ts
@@ -1,7 +1,7 @@
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import { VideoChapter, VideoCreateResult, VideoPrivacy } from '@peertube/peertube-models'
-import { areHttpImportTestsDisabled } from '@peertube/peertube-node-utils'
+import { areHttpImportTestsDisabled, areYoutubeImportTestsDisabled } from '@peertube/peertube-node-utils'
import {
cleanupTests,
createMultipleServers,
@@ -229,6 +229,8 @@ describe('Test video chapters', function () {
if (areHttpImportTestsDisabled()) return
it('Should detect chapters from youtube URL import', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(120000)
const attributes = {
@@ -266,6 +268,8 @@ describe('Test video chapters', function () {
})
it('Should have overriden description priority from youtube URL import', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(120000)
const attributes = {
diff --git a/packages/tests/src/api/videos/video-imports.ts b/packages/tests/src/api/videos/video-imports.ts
index e25095edd..1e3d89942 100644
--- a/packages/tests/src/api/videos/video-imports.ts
+++ b/packages/tests/src/api/videos/video-imports.ts
@@ -1,7 +1,7 @@
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import { CustomConfig, HttpStatusCode, Video, VideoImportState, VideoPrivacy, VideoResolution, VideoState } from '@peertube/peertube-models'
-import { areHttpImportTestsDisabled } from '@peertube/peertube-node-utils'
+import { areHttpImportTestsDisabled, areYoutubeImportTestsDisabled } from '@peertube/peertube-node-utils'
import {
PeerTubeServer,
cleanupTests, createMultipleServers,
@@ -21,22 +21,27 @@ import { pathExists, remove } from 'fs-extra/esm'
import { readdir } from 'fs/promises'
import { join } from 'path'
-async function checkVideosServer1 (server: PeerTubeServer, idHttp: string, idMagnet: string, idTorrent: string) {
- const videoHttp = await server.videos.get({ id: idHttp })
+async function checkVideosServer1 (server: PeerTubeServer, idHttp: string | undefined, idMagnet: string, idTorrent: string) {
+ if (idHttp) {
+ const videoHttp = await server.videos.get({ id: idHttp })
- expect(videoHttp.name).to.equal('small video - youtube')
- expect(videoHttp.category.label).to.equal('News & Politics')
- expect(videoHttp.licence.label).to.equal('Attribution')
- expect(videoHttp.language.label).to.equal('Unknown')
- expect(videoHttp.nsfw).to.be.false
- expect(videoHttp.description).to.equal('this is a super description')
- expect(videoHttp.tags).to.deep.equal([ 'tag1', 'tag2' ])
- expect(videoHttp.files).to.have.lengthOf(1)
+ expect(videoHttp.name).to.equal('small video - youtube')
+ expect(videoHttp.category.label).to.equal('News & Politics')
+ expect(videoHttp.licence.label).to.equal('Attribution')
+ expect(videoHttp.language.label).to.equal('Unknown')
+ expect(videoHttp.nsfw).to.be.false
+ expect(videoHttp.description).to.equal('this is a super description')
+ expect(videoHttp.tags).to.deep.equal([ 'tag1', 'tag2' ])
+ expect(videoHttp.files).to.have.lengthOf(1)
- const originallyPublishedAt = new Date(videoHttp.originallyPublishedAt)
- expect(originallyPublishedAt.getDate()).to.equal(14)
- expect(originallyPublishedAt.getMonth()).to.equal(0)
- expect(originallyPublishedAt.getFullYear()).to.equal(2019)
+ const originallyPublishedAt = new Date(videoHttp.originallyPublishedAt)
+ expect(originallyPublishedAt.getDate()).to.equal(14)
+ expect(originallyPublishedAt.getMonth()).to.equal(0)
+ expect(originallyPublishedAt.getFullYear()).to.equal(2019)
+
+ const bodyCaptions = await server.captions.list({ videoId: idHttp })
+ expect(bodyCaptions.total).to.equal(2)
+ }
const videoMagnet = await server.videos.get({ id: idMagnet })
const videoTorrent = await server.videos.get({ id: idTorrent })
@@ -53,9 +58,6 @@ async function checkVideosServer1 (server: PeerTubeServer, idHttp: string, idMag
expect(videoTorrent.name).to.contain('你好 世界 720p.mp4')
expect(videoMagnet.name).to.contain('super peertube2 video')
-
- const bodyCaptions = await server.captions.list({ videoId: idHttp })
- expect(bodyCaptions.total).to.equal(2)
}
async function checkVideoServer2 (server: PeerTubeServer, id: number | string) {
@@ -107,122 +109,142 @@ describe('Test video imports', function () {
await doubleFollow(servers[0], servers[1])
})
- it('Should import videos on server 1', async function () {
+ it('Should import a youtube-dl video on server 1', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(60_000)
- const baseAttributes = {
- channelId: servers[0].store.channel.id,
- privacy: VideoPrivacy.PUBLIC
+ const attributes = { privacy: VideoPrivacy.PUBLIC, targetUrl: FIXTURE_URLS.youtube }
+ const { video } = await servers[0].videoImports.importVideo({ attributes })
+ expect(video.name).to.equal('small video - youtube')
+
+ {
+ expect(video.thumbnailPath).to.match(new RegExp(`^/lazy-static/thumbnails/.+.jpg$`))
+ expect(video.previewPath).to.match(new RegExp(`^/lazy-static/previews/.+.jpg$`))
+
+ const suffix = mode === 'yt-dlp'
+ ? '_yt_dlp'
+ : ''
+
+ await testImageGeneratedByFFmpeg(servers[0].url, 'video_import_thumbnail' + suffix, video.thumbnailPath)
+ await testImageGeneratedByFFmpeg(servers[0].url, 'video_import_preview' + suffix, video.previewPath)
+ }
+
+ const bodyCaptions = await servers[0].captions.list({ videoId: video.id })
+ const videoCaptions = bodyCaptions.data
+ expect(videoCaptions).to.have.lengthOf(2)
+
+ {
+ const enCaption = videoCaptions.find(caption => caption.language.id === 'en')
+ expect(enCaption).to.exist
+ expect(enCaption.language.label).to.equal('English')
+ expect(enCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-en.vtt$`))
+
+ const regex = `WEBVTT[ \n]+Kind: captions[ \n]+` +
+ `(Language: en[ \n]+)?` +
+ `00:00:01.600 --> 00:00:04.200( position:\\d+% line:\\d+%)?[ \n]+English \\(US\\)[ \n]+` +
+ `00:00:05.900 --> 00:00:07.999( position:\\d+% line:\\d+%)?[ \n]+This is a subtitle in American English[ \n]+` +
+ `00:00:10.000 --> 00:00:14.000( position:\\d+% line:\\d+%)?[ \n]+Adding subtitles is very easy to do`
+ await testCaptionFile(servers[0].url, enCaption.captionPath, new RegExp(regex))
}
{
- const attributes = { ...baseAttributes, targetUrl: FIXTURE_URLS.youtube }
- const { video } = await servers[0].videoImports.importVideo({ attributes })
- expect(video.name).to.equal('small video - youtube')
+ const frCaption = videoCaptions.find(caption => caption.language.id === 'fr')
+ expect(frCaption).to.exist
+ expect(frCaption.language.label).to.equal('French')
+ expect(frCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-fr.vtt`))
- {
- expect(video.thumbnailPath).to.match(new RegExp(`^/lazy-static/thumbnails/.+.jpg$`))
- expect(video.previewPath).to.match(new RegExp(`^/lazy-static/previews/.+.jpg$`))
+ const regex = `WEBVTT[ \n]+Kind: captions[ \n]+` +
+ `(Language: fr[ \n]+)?` +
+ `00:00:01.600 --> 00:00:04.200( position:\\d+% line:\\d+%)?[ \n]+Français \\(FR\\)[ \n]+` +
+ `00:00:05.900 --> 00:00:07.999( position:\\d+% line:\\d+%)?[ \n]+C'est un sous-titre français[ \n]+` +
+ `00:00:10.000 --> 00:00:14.000( position:\\d+% line:\\d+%)?[ \n]+Ajouter un sous-titre est vraiment facile`
- const suffix = mode === 'yt-dlp'
- ? '_yt_dlp'
- : ''
-
- await testImageGeneratedByFFmpeg(servers[0].url, 'video_import_thumbnail' + suffix, video.thumbnailPath)
- await testImageGeneratedByFFmpeg(servers[0].url, 'video_import_preview' + suffix, video.previewPath)
- }
-
- const bodyCaptions = await servers[0].captions.list({ videoId: video.id })
- const videoCaptions = bodyCaptions.data
- expect(videoCaptions).to.have.lengthOf(2)
-
- {
- const enCaption = videoCaptions.find(caption => caption.language.id === 'en')
- expect(enCaption).to.exist
- expect(enCaption.language.label).to.equal('English')
- expect(enCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-en.vtt$`))
-
- const regex = `WEBVTT[ \n]+Kind: captions[ \n]+` +
- `(Language: en[ \n]+)?` +
- `00:00:01.600 --> 00:00:04.200( position:\\d+% line:\\d+%)?[ \n]+English \\(US\\)[ \n]+` +
- `00:00:05.900 --> 00:00:07.999( position:\\d+% line:\\d+%)?[ \n]+This is a subtitle in American English[ \n]+` +
- `00:00:10.000 --> 00:00:14.000( position:\\d+% line:\\d+%)?[ \n]+Adding subtitles is very easy to do`
- await testCaptionFile(servers[0].url, enCaption.captionPath, new RegExp(regex))
- }
-
- {
- const frCaption = videoCaptions.find(caption => caption.language.id === 'fr')
- expect(frCaption).to.exist
- expect(frCaption.language.label).to.equal('French')
- expect(frCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-fr.vtt`))
-
- const regex = `WEBVTT[ \n]+Kind: captions[ \n]+` +
- `(Language: fr[ \n]+)?` +
- `00:00:01.600 --> 00:00:04.200( position:\\d+% line:\\d+%)?[ \n]+Français \\(FR\\)[ \n]+` +
- `00:00:05.900 --> 00:00:07.999( position:\\d+% line:\\d+%)?[ \n]+C'est un sous-titre français[ \n]+` +
- `00:00:10.000 --> 00:00:14.000( position:\\d+% line:\\d+%)?[ \n]+Ajouter un sous-titre est vraiment facile`
-
- await testCaptionFile(servers[0].url, frCaption.captionPath, new RegExp(regex))
- }
+ await testCaptionFile(servers[0].url, frCaption.captionPath, new RegExp(regex))
}
+ })
- {
- const attributes = {
- ...baseAttributes,
- magnetUri: FIXTURE_URLS.magnet,
- description: 'this is a super torrent description',
- tags: [ 'tag_torrent1', 'tag_torrent2' ]
- }
- const { video } = await servers[0].videoImports.importVideo({ attributes })
- expect(video.name).to.equal('super peertube2 video')
- }
+ it('Should import a magnet video on server 1', async function () {
+ this.timeout(60_000)
- {
- const attributes = {
- ...baseAttributes,
- torrentfile: 'video-720p.torrent' as any,
- description: 'this is a super torrent description',
- tags: [ 'tag_torrent1', 'tag_torrent2' ]
- }
- const { video } = await servers[0].videoImports.importVideo({ attributes })
- expect(video.name).to.equal('你好 世界 720p.mp4')
+ const attributes = {
+ privacy: VideoPrivacy.PUBLIC,
+ magnetUri: FIXTURE_URLS.magnet,
+ description: 'this is a super torrent description',
+ tags: [ 'tag_torrent1', 'tag_torrent2' ]
}
+ const { video } = await servers[0].videoImports.importVideo({ attributes })
+ expect(video.name).to.equal('super peertube2 video')
+ })
+
+ it('Should import a torrent video on server 1', async function () {
+ const attributes = {
+ privacy: VideoPrivacy.PUBLIC,
+ torrentfile: 'video-720p.torrent' as any,
+ description: 'this is a super torrent description',
+ tags: [ 'tag_torrent1', 'tag_torrent2' ]
+ }
+ const { video } = await servers[0].videoImports.importVideo({ attributes })
+ expect(video.name).to.equal('你好 世界 720p.mp4')
})
it('Should list the videos to import in my videos on server 1', async function () {
const { total, data } = await servers[0].videos.listMyVideos({ sort: 'createdAt' })
- expect(total).to.equal(3)
+ const expected = [ 'super peertube2 video', '你好 世界 720p.mp4' ]
- expect(data).to.have.lengthOf(3)
- expect(data[0].name).to.equal('small video - youtube')
- expect(data[1].name).to.equal('super peertube2 video')
- expect(data[2].name).to.equal('你好 世界 720p.mp4')
+ if (!areYoutubeImportTestsDisabled()) {
+ expected.unshift('small video - youtube')
+ }
+
+ expect(total).to.equal(expected.length)
+ expect(data).to.have.lengthOf(expected.length)
+ expect(data.map(d => d.name)).to.have.deep.equal(expected)
})
it('Should list the videos to import in my imports on server 1', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
const { total, data: videoImports } = await servers[0].videoImports.getMyVideoImports({ sort: '-createdAt' })
- expect(total).to.equal(3)
- expect(videoImports).to.have.lengthOf(3)
+ const totalExpected = areYoutubeImportTestsDisabled()
+ ? 2
+ : 3
- expect(videoImports[2].targetUrl).to.equal(FIXTURE_URLS.youtube)
- expect(videoImports[2].magnetUri).to.be.null
- expect(videoImports[2].torrentName).to.be.null
- expect(videoImports[2].video.name).to.equal('small video - youtube')
+ expect(total).to.equal(totalExpected)
+ expect(videoImports).to.have.lengthOf(totalExpected)
- expect(videoImports[1].targetUrl).to.be.null
- expect(videoImports[1].magnetUri).to.equal(FIXTURE_URLS.magnet)
- expect(videoImports[1].torrentName).to.be.null
- expect(videoImports[1].video.name).to.equal('super peertube2 video')
+ if (!areYoutubeImportTestsDisabled()) {
+ const videoImport = videoImports.pop()
- expect(videoImports[0].targetUrl).to.be.null
- expect(videoImports[0].magnetUri).to.be.null
- expect(videoImports[0].torrentName).to.equal('video-720p.torrent')
- expect(videoImports[0].video.name).to.equal('你好 世界 720p.mp4')
+ expect(videoImport.targetUrl).to.equal(FIXTURE_URLS.youtube)
+ expect(videoImport.magnetUri).to.be.null
+ expect(videoImport.torrentName).to.be.null
+ expect(videoImport.video.name).to.equal('small video - youtube')
+ }
+
+ {
+ const videoImport = videoImports.pop()
+
+ expect(videoImport.targetUrl).to.be.null
+ expect(videoImport.magnetUri).to.equal(FIXTURE_URLS.magnet)
+ expect(videoImport.torrentName).to.be.null
+ expect(videoImport.video.name).to.equal('super peertube2 video')
+ }
+
+ {
+ const videoImport = videoImports.pop()
+
+ expect(videoImport.magnetUri).to.be.null
+ expect(videoImport.targetUrl).to.be.null
+ expect(videoImport.torrentName).to.equal('video-720p.torrent')
+ expect(videoImport.video.name).to.equal('你好 世界 720p.mp4')
+ }
})
it('Should filter my imports on target URL', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
const { total, data: videoImports } = await servers[0].videoImports.getMyVideoImports({ targetUrl: FIXTURE_URLS.youtube })
expect(total).to.equal(1)
expect(videoImports).to.have.lengthOf(1)
@@ -255,17 +277,26 @@ describe('Test video imports', function () {
await waitJobs(servers)
+ const totalExpected = areYoutubeImportTestsDisabled()
+ ? 2
+ : 3
+
for (const server of servers) {
const { total, data } = await server.videos.list()
- expect(total).to.equal(3)
- expect(data).to.have.lengthOf(3)
+ expect(total).to.equal(totalExpected)
+ expect(data).to.have.lengthOf(totalExpected)
- const [ videoHttp, videoMagnet, videoTorrent ] = data
- await checkVideosServer1(server, videoHttp.uuid, videoMagnet.uuid, videoTorrent.uuid)
+ const [ videoHttp, videoMagnet, videoTorrent ] = areYoutubeImportTestsDisabled()
+ ? [ undefined, ...data ]
+ : data
+
+ await checkVideosServer1(server, videoHttp?.uuid, videoMagnet.uuid, videoTorrent.uuid)
}
})
it('Should import a video on server 2 with some fields', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(60_000)
const { video } = await servers[1].videoImports.importVideo({
@@ -286,6 +317,8 @@ describe('Test video imports', function () {
})
it('Should have the videos listed on the two instances', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(120_000)
await waitJobs(servers)
@@ -325,6 +358,8 @@ describe('Test video imports', function () {
})
it('Should import no HDR version on a HDR video', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(300_000)
const config: DeepPartial<CustomConfig> = {
@@ -366,6 +401,8 @@ describe('Test video imports', function () {
})
it('Should not import resolution higher than enabled transcoding resolution', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(300_000)
const config: DeepPartial<CustomConfig> = {
@@ -406,6 +443,8 @@ describe('Test video imports', function () {
})
it('Should import resolution higher than enabled transcoding resolution', async function () {
+ if (areYoutubeImportTestsDisabled()) return
+
this.timeout(300_000)
const config: DeepPartial<CustomConfig> = {
@@ -438,11 +477,11 @@ describe('Test video imports', function () {
it('Should import a peertube video', async function () {
this.timeout(120_000)
- const toTest = [ FIXTURE_URLS.peertube_long ]
+ const toTest = [ FIXTURE_URLS.peertubeLong ]
// TODO: include peertube_short when https://github.com/ytdl-org/youtube-dl/pull/29475 is merged
if (mode === 'yt-dlp') {
- toTest.push(FIXTURE_URLS.peertube_short)
+ toTest.push(FIXTURE_URLS.peertubeShort)
}
for (const targetUrl of toTest) {
@@ -575,7 +614,7 @@ describe('Test video imports', function () {
function quickPeerTubeImport () {
const attributes = {
- targetUrl: FIXTURE_URLS.peertube_long,
+ targetUrl: FIXTURE_URLS.peertubeLong,
channelId: server.store.channel.id,
privacy: VideoPrivacy.PUBLIC
}
@@ -583,7 +622,7 @@ describe('Test video imports', function () {
return server.videoImports.importVideo({ attributes })
}
- async function testBinaryUpdate (releaseUrl: string, releaseName: string) {
+ async function testBinaryUpdate (releaseUrl: string, releaseName: string, pythonPath = '/usr/bin/python3') {
await remove(join(server.servers.buildDirectory('bin'), releaseName))
await server.kill()
@@ -593,7 +632,8 @@ describe('Test video imports', function () {
http: {
youtube_dl_release: {
url: releaseUrl,
- name: releaseName
+ name: releaseName,
+ python_path: pythonPath
}
}
}
@@ -638,6 +678,12 @@ describe('Test video imports', function () {
await testBinaryUpdate('https://api.github.com/repos/yt-dlp/yt-dlp/releases', 'yt-dlp')
})
+ it('Should update and import youtube-dl linux executable', async function () {
+ this.timeout(120_000)
+
+ await testBinaryUpdate('https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_linux', 'yt-dlp', null)
+ })
+
after(async function () {
await cleanupTests([ server ])
})
diff --git a/packages/tests/src/shared/fixture-urls.ts b/packages/tests/src/shared/fixture-urls.ts
index daade2d83..3b26f6eef 100644
--- a/packages/tests/src/shared/fixture-urls.ts
+++ b/packages/tests/src/shared/fixture-urls.ts
@@ -1,6 +1,6 @@
export const FIXTURE_URLS = {
- peertube_long: 'https://peertube2.cpy.re/videos/watch/122d093a-1ede-43bd-bd34-59d2931ffc5e',
- peertube_short: 'https://peertube2.cpy.re/w/3fbif9S3WmtTP8gGsC5HBd',
+ peertubeLong: 'https://peertube2.cpy.re/videos/watch/122d093a-1ede-43bd-bd34-59d2931ffc5e',
+ peertubeShort: 'https://peertube2.cpy.re/w/3fbif9S3WmtTP8gGsC5HBd',
youtube: 'https://www.youtube.com/watch?v=msX3jv1XdvM',
youtubeChapters: 'https://www.youtube.com/watch?v=TL9P-Er7ils',
diff --git a/server/core/helpers/youtube-dl/youtube-dl-cli.ts b/server/core/helpers/youtube-dl/youtube-dl-cli.ts
index c07c7c011..6e465600d 100644
--- a/server/core/helpers/youtube-dl/youtube-dl-cli.ts
+++ b/server/core/helpers/youtube-dl/youtube-dl-cli.ts
@@ -3,7 +3,7 @@ import { VideoResolution, VideoResolutionType } from '@peertube/peertube-models'
import { CONFIG } from '@server/initializers/config.js'
import { execa, Options as ExecaNodeOptions } from 'execa'
import { ensureDir, pathExists } from 'fs-extra/esm'
-import { writeFile } from 'fs/promises'
+import { chmod, writeFile } from 'fs/promises'
import { OptionsOfBufferResponseBody } from 'got'
import { dirname, join } from 'path'
import { logger, loggerTagsFactory } from '../logger.js'
@@ -34,7 +34,7 @@ export class YoutubeDLCLI {
logger.info('Updating youtubeDL binary from %s.', url, lTags())
const gotOptions: OptionsOfBufferResponseBody = {
- context: { bodyKBLimit: 20_000 },
+ context: { bodyKBLimit: 100_000 },
responseType: 'buffer' as 'buffer'
}
@@ -65,6 +65,10 @@ export class YoutubeDLCLI {
await writeFile(youtubeDLBinaryPath, gotResult.body)
+ if (!CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE.PYTHON_PATH) {
+ await chmod(youtubeDLBinaryPath, '744')
+ }
+
logger.info('youtube-dl updated %s.', youtubeDLBinaryPath, lTags())
} catch (err) {
logger.error('Cannot update youtube-dl from %s.', url, { err, ...lTags() })
@@ -215,8 +219,11 @@ export class YoutubeDLCLI {
completeArgs = this.wrapWithIPOptions(completeArgs)
completeArgs = this.wrapWithFFmpegOptions(completeArgs)
- const { PYTHON_PATH } = CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE
- const subProcess = execa(PYTHON_PATH, [ youtubeDLBinaryPath, ...completeArgs, url ], processOptions)
+ const subProcessBinary = CONFIG.IMPORT.VIDEOS.HTTP.YOUTUBE_DL_RELEASE.PYTHON_PATH || youtubeDLBinaryPath
+ const subProcessArgs = [ ...completeArgs, url ]
+ if (subProcessBinary !== youtubeDLBinaryPath) subProcessArgs.unshift(youtubeDLBinaryPath)
+
+ const subProcess = execa(subProcessBinary, subProcessArgs, processOptions)
if (timeout) {
setTimeout(() => subProcess.kill(), timeout)
diff --git a/support/doc/development/tests.md b/support/doc/development/tests.md
index f3acbb01d..2419b31ba 100644
--- a/support/doc/development/tests.md
+++ b/support/doc/development/tests.md
@@ -68,15 +68,17 @@ npm run mocha -- --exit --bail packages/tests/src/api/videos/single-server.ts
### Configuration
+Some env variables can be defined to disable/enable some tests:
Some env variables can be defined to disable/enable some tests:
* `DISABLE_HTTP_IMPORT_TESTS=true`: disable import tests (because of youtube that could rate limit your IP)
+ * `DISABLE_HTTP_YOUTUBE_IMPORT_TESTS=true`: disable youtube import tests (because youtube blocks CI server IP)
* `ENABLE_OBJECT_STORAGE_TESTS=true`: enable object storage tests (needs `chocobozzz/s3-ninja` container first)
* `AKISMET_KEY`: specify an Akismet key to test akismet external PeerTube plugin
- * `OBJECT_STORAGE_SCALEWAY_KEY_ID` and `OBJECT_STORAGE_SCALEWAY_ACCESS_KEY`: specify Scaleway API keys to test object storage ACL (not supported by our `chocobozzz/s3-ninja` container)
* `ENABLE_FFMPEG_THUMBNAIL_PIXEL_COMPARISON_TESTS=true`: enable pixel comparison on images generated by ffmpeg. Disabled by default because a custom ffmpeg version may fails the tests
- * `YOUTUBE_DL_DOWNLOAD_BEARER_TOKEN`: Bearer token to download youtube-dl binary
- * `YOUTUBE_DL_PROXY`: Custom proxy URL for youtube-dl HTTP video import
+ * `OBJECT_STORAGE_SCALEWAY_KEY_ID` and `OBJECT_STORAGE_SCALEWAY_ACCESS_KEY`: specify Scaleway API keys to test object storage ACL (not supported by our `chocobozzz/s3-ninja` container)
+ * `YOUTUBE_DL_DOWNLOAD_BEARER_TOKEN`: bearer token to download youtube-dl binary
+ * `YOUTUBE_DL_PROXY`: custom proxy URL for youtube-dl HTTP video import
### Debug server logs