server/tests/cli/create-transcoding-job.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4 import * as chai from 'chai'
   5 import { HttpStatusCode, VideoFile } from '@shared/models'
   6 import {
   7   areObjectStorageTestsDisabled,
   8   cleanupTests,
   9   createMultipleServers,
  10   doubleFollow,
  11   expectStartWith,
  12   makeRawRequest,
  13   ObjectStorageCommand,
  14   PeerTubeServer,
  15   setAccessTokensToServers,
  16   waitJobs
  17 } from '../../../shared/extra-utils'
  18
  19 const expect = chai.expect
  20
  21 async function checkFilesInObjectStorage (files: VideoFile[], type: 'webtorrent' | 'playlist') {
  22   for (const file of files) {
  23     const shouldStartWith = type === 'webtorrent'
  24       ? ObjectStorageCommand.getWebTorrentBaseUrl()
  25       : ObjectStorageCommand.getPlaylistBaseUrl()
  26
  27     expectStartWith(file.fileUrl, shouldStartWith)
  28
  29     await makeRawRequest(file.fileUrl, HttpStatusCode.OK_200)
  30   }
  31 }
  32
  33 function runTests (objectStorage: boolean) {
  34   let servers: PeerTubeServer[] = []
  35   const videosUUID: string[] = []
  36
  37   before(async function () {
  38     this.timeout(60000)
  39
  40     const config = objectStorage
  41       ? ObjectStorageCommand.getDefaultConfig()
  42       : {}
  43
  44     // Run server 2 to have transcoding enabled
  45     servers = await createMultipleServers(2, config)
  46     await setAccessTokensToServers(servers)
  47
  48     await servers[0].config.disableTranscoding()
  49
  50     await doubleFollow(servers[0], servers[1])
  51
  52     if (objectStorage) await ObjectStorageCommand.prepareDefaultBuckets()
  53
  54     for (let i = 1; i <= 5; i++) {
  55       const { uuid, shortUUID } = await servers[0].videos.upload({ attributes: { name: 'video' + i } })
  56
  57       if (i > 2) {
  58         videosUUID.push(uuid)
  59       } else {
  60         videosUUID.push(shortUUID)
  61       }
  62     }
  63
  64     await waitJobs(servers)
  65   })
  66
  67   it('Should have two video files on each server', async function () {
  68     this.timeout(30000)
  69
  70     for (const server of servers) {
  71       const { data } = await server.videos.list()
  72       expect(data).to.have.lengthOf(videosUUID.length)
  73
  74       for (const video of data) {
  75         const videoDetail = await server.videos.get({ id: video.uuid })
  76         expect(videoDetail.files).to.have.lengthOf(1)
  77         expect(videoDetail.streamingPlaylists).to.have.lengthOf(0)
  78       }
  79     }
  80   })
  81
  82   it('Should run a transcoding job on video 2', async function () {
  83     this.timeout(60000)
  84
  85     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[1]}`)
  86     await waitJobs(servers)
  87
  88     for (const server of servers) {
  89       const { data } = await server.videos.list()
  90
  91       let infoHashes: { [id: number]: string }
  92
  93       for (const video of data) {
  94         const videoDetails = await server.videos.get({ id: video.uuid })
  95
  96         if (video.shortUUID === videosUUID[1] || video.uuid === videosUUID[1]) {
  97           expect(videoDetails.files).to.have.lengthOf(4)
  98           expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
  99
 100           if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 101
 102           if (!infoHashes) {
 103             infoHashes = {}
 104
 105             for (const file of videoDetails.files) {
 106               infoHashes[file.resolution.id.toString()] = file.magnetUri
 107             }
 108           } else {
 109             for (const resolution of Object.keys(infoHashes)) {
 110               const file = videoDetails.files.find(f => f.resolution.id.toString() === resolution)
 111               expect(file.magnetUri).to.equal(infoHashes[resolution])
 112             }
 113           }
 114         } else {
 115           expect(videoDetails.files).to.have.lengthOf(1)
 116           expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
 117         }
 118       }
 119     }
 120   })
 121
 122   it('Should run a transcoding job on video 1 with resolution', async function () {
 123     this.timeout(60000)
 124
 125     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[0]} -r 480`)
 126
 127     await waitJobs(servers)
 128
 129     for (const server of servers) {
 130       const { data } = await server.videos.list()
 131       expect(data).to.have.lengthOf(videosUUID.length)
 132
 133       const videoDetails = await server.videos.get({ id: videosUUID[0] })
 134
 135       expect(videoDetails.files).to.have.lengthOf(2)
 136       expect(videoDetails.files[0].resolution.id).to.equal(720)
 137       expect(videoDetails.files[1].resolution.id).to.equal(480)
 138
 139       expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
 140
 141       if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 142     }
 143   })
 144
 145   it('Should generate an HLS resolution', async function () {
 146     this.timeout(120000)
 147
 148     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[2]} --generate-hls -r 480`)
 149
 150     await waitJobs(servers)
 151
 152     for (const server of servers) {
 153       const videoDetails = await server.videos.get({ id: videosUUID[2] })
 154
 155       expect(videoDetails.files).to.have.lengthOf(1)
 156       if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 157
 158       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
 159
 160       const files = videoDetails.streamingPlaylists[0].files
 161       expect(files).to.have.lengthOf(1)
 162       expect(files[0].resolution.id).to.equal(480)
 163
 164       if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
 165     }
 166   })
 167
 168   it('Should not duplicate an HLS resolution', async function () {
 169     this.timeout(120000)
 170
 171     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[2]} --generate-hls -r 480`)
 172
 173     await waitJobs(servers)
 174
 175     for (const server of servers) {
 176       const videoDetails = await server.videos.get({ id: videosUUID[2] })
 177
 178       const files = videoDetails.streamingPlaylists[0].files
 179       expect(files).to.have.lengthOf(1)
 180       expect(files[0].resolution.id).to.equal(480)
 181
 182       if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
 183     }
 184   })
 185
 186   it('Should generate all HLS resolutions', async function () {
 187     this.timeout(120000)
 188
 189     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[3]} --generate-hls`)
 190
 191     await waitJobs(servers)
 192
 193     for (const server of servers) {
 194       const videoDetails = await server.videos.get({ id: videosUUID[3] })
 195
 196       expect(videoDetails.files).to.have.lengthOf(1)
 197       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
 198
 199       const files = videoDetails.streamingPlaylists[0].files
 200       expect(files).to.have.lengthOf(4)
 201
 202       if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
 203     }
 204   })
 205
 206   it('Should optimize the video file and generate HLS videos if enabled in config', async function () {
 207     this.timeout(120000)
 208
 209     await servers[0].config.enableTranscoding()
 210     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[4]}`)
 211
 212     await waitJobs(servers)
 213
 214     for (const server of servers) {
 215       const videoDetails = await server.videos.get({ id: videosUUID[4] })
 216
 217       expect(videoDetails.files).to.have.lengthOf(4)
 218       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
 219       expect(videoDetails.streamingPlaylists[0].files).to.have.lengthOf(4)
 220
 221       if (objectStorage) {
 222         await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 223         await checkFilesInObjectStorage(videoDetails.streamingPlaylists[0].files, 'playlist')
 224       }
 225     }
 226   })
 227
 228   after(async function () {
 229     await cleanupTests(servers)
 230   })
 231 }
 232
 233 describe('Test create transcoding jobs', function () {
 234
 235   describe('On filesystem', function () {
 236     runTests(false)
 237   })
 238
 239   describe('On object storage', function () {
 240     if (areObjectStorageTestsDisabled()) return
 241
 242     runTests(true)
 243   })
 244 })