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 } = await servers[0].videos.upload({ attributes: { name: 'video' + i } })
  56       videosUUID.push(uuid)
  57     }
  58
  59     await waitJobs(servers)
  60   })
  61
  62   it('Should have two video files on each server', async function () {
  63     this.timeout(30000)
  64
  65     for (const server of servers) {
  66       const { data } = await server.videos.list()
  67       expect(data).to.have.lengthOf(videosUUID.length)
  68
  69       for (const video of data) {
  70         const videoDetail = await server.videos.get({ id: video.uuid })
  71         expect(videoDetail.files).to.have.lengthOf(1)
  72         expect(videoDetail.streamingPlaylists).to.have.lengthOf(0)
  73       }
  74     }
  75   })
  76
  77   it('Should run a transcoding job on video 2', async function () {
  78     this.timeout(60000)
  79
  80     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[1]}`)
  81     await waitJobs(servers)
  82
  83     for (const server of servers) {
  84       const { data } = await server.videos.list()
  85
  86       let infoHashes: { [id: number]: string }
  87
  88       for (const video of data) {
  89         const videoDetails = await server.videos.get({ id: video.uuid })
  90
  91         if (video.uuid === videosUUID[1]) {
  92           expect(videoDetails.files).to.have.lengthOf(4)
  93           expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
  94
  95           if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
  96
  97           if (!infoHashes) {
  98             infoHashes = {}
  99
 100             for (const file of videoDetails.files) {
 101               infoHashes[file.resolution.id.toString()] = file.magnetUri
 102             }
 103           } else {
 104             for (const resolution of Object.keys(infoHashes)) {
 105               const file = videoDetails.files.find(f => f.resolution.id.toString() === resolution)
 106               expect(file.magnetUri).to.equal(infoHashes[resolution])
 107             }
 108           }
 109         } else {
 110           expect(videoDetails.files).to.have.lengthOf(1)
 111           expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
 112         }
 113       }
 114     }
 115   })
 116
 117   it('Should run a transcoding job on video 1 with resolution', async function () {
 118     this.timeout(60000)
 119
 120     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[0]} -r 480`)
 121
 122     await waitJobs(servers)
 123
 124     for (const server of servers) {
 125       const { data } = await server.videos.list()
 126       expect(data).to.have.lengthOf(videosUUID.length)
 127
 128       const videoDetails = await server.videos.get({ id: videosUUID[0] })
 129
 130       expect(videoDetails.files).to.have.lengthOf(2)
 131       expect(videoDetails.files[0].resolution.id).to.equal(720)
 132       expect(videoDetails.files[1].resolution.id).to.equal(480)
 133
 134       expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
 135
 136       if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 137     }
 138   })
 139
 140   it('Should generate an HLS resolution', async function () {
 141     this.timeout(120000)
 142
 143     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[2]} --generate-hls -r 480`)
 144
 145     await waitJobs(servers)
 146
 147     for (const server of servers) {
 148       const videoDetails = await server.videos.get({ id: videosUUID[2] })
 149
 150       expect(videoDetails.files).to.have.lengthOf(1)
 151       if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 152
 153       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
 154
 155       const files = videoDetails.streamingPlaylists[0].files
 156       expect(files).to.have.lengthOf(1)
 157       expect(files[0].resolution.id).to.equal(480)
 158
 159       if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
 160     }
 161   })
 162
 163   it('Should not duplicate an HLS resolution', async function () {
 164     this.timeout(120000)
 165
 166     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[2]} --generate-hls -r 480`)
 167
 168     await waitJobs(servers)
 169
 170     for (const server of servers) {
 171       const videoDetails = await server.videos.get({ id: videosUUID[2] })
 172
 173       const files = videoDetails.streamingPlaylists[0].files
 174       expect(files).to.have.lengthOf(1)
 175       expect(files[0].resolution.id).to.equal(480)
 176
 177       if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
 178     }
 179   })
 180
 181   it('Should generate all HLS resolutions', async function () {
 182     this.timeout(120000)
 183
 184     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[3]} --generate-hls`)
 185
 186     await waitJobs(servers)
 187
 188     for (const server of servers) {
 189       const videoDetails = await server.videos.get({ id: videosUUID[3] })
 190
 191       expect(videoDetails.files).to.have.lengthOf(1)
 192       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
 193
 194       const files = videoDetails.streamingPlaylists[0].files
 195       expect(files).to.have.lengthOf(4)
 196
 197       if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
 198     }
 199   })
 200
 201   it('Should optimize the video file and generate HLS videos if enabled in config', async function () {
 202     this.timeout(120000)
 203
 204     await servers[0].config.enableTranscoding()
 205     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[4]}`)
 206
 207     await waitJobs(servers)
 208
 209     for (const server of servers) {
 210       const videoDetails = await server.videos.get({ id: videosUUID[4] })
 211
 212       expect(videoDetails.files).to.have.lengthOf(4)
 213       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
 214       expect(videoDetails.streamingPlaylists[0].files).to.have.lengthOf(4)
 215
 216       if (objectStorage) {
 217         await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 218         await checkFilesInObjectStorage(videoDetails.streamingPlaylists[0].files, 'playlist')
 219       }
 220     }
 221   })
 222
 223   after(async function () {
 224     await cleanupTests(servers)
 225   })
 226 }
 227
 228 describe('Test create transcoding jobs', function () {
 229
 230   describe('On filesystem', function () {
 231     runTests(false)
 232   })
 233
 234   describe('On object storage', function () {
 235     if (areObjectStorageTestsDisabled()) return
 236
 237     runTests(true)
 238   })
 239 })