server/tests/api/videos/video-hls.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 { join } from 'path'
   6 import { HttpStatusCode } from '../../../../shared/core-utils/miscs/http-error-codes'
   7 import {
   8   checkDirectoryIsEmpty,
   9   checkResolutionsInMasterPlaylist,
  10   checkSegmentHash,
  11   checkTmpIsEmpty,
  12   cleanupTests,
  13   doubleFollow,
  14   flushAndRunMultipleServers,
  15   getPlaylist,
  16   getVideo,
  17   makeRawRequest,
  18   removeVideo,
  19   ServerInfo,
  20   setAccessTokensToServers,
  21   updateVideo,
  22   uploadVideo,
  23   waitJobs,
  24   webtorrentAdd
  25 } from '../../../../shared/extra-utils'
  26 import { VideoDetails } from '../../../../shared/models/videos'
  27 import { VideoStreamingPlaylistType } from '../../../../shared/models/videos/video-streaming-playlist.type'
  28 import { DEFAULT_AUDIO_RESOLUTION } from '../../../initializers/constants'
  29
  30 const expect = chai.expect
  31
  32 async function checkHlsPlaylist (servers: ServerInfo[], videoUUID: string, hlsOnly: boolean, resolutions = [ 240, 360, 480, 720 ]) {
  33   for (const server of servers) {
  34     const resVideoDetails = await getVideo(server.url, videoUUID)
  35     const videoDetails: VideoDetails = resVideoDetails.body
  36     const baseUrl = `http://${videoDetails.account.host}`
  37
  38     expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
  39
  40     const hlsPlaylist = videoDetails.streamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
  41     expect(hlsPlaylist).to.not.be.undefined
  42
  43     const hlsFiles = hlsPlaylist.files
  44     expect(hlsFiles).to.have.lengthOf(resolutions.length)
  45
  46     if (hlsOnly) expect(videoDetails.files).to.have.lengthOf(0)
  47     else expect(videoDetails.files).to.have.lengthOf(resolutions.length)
  48
  49     for (const resolution of resolutions) {
  50       const file = hlsFiles.find(f => f.resolution.id === resolution)
  51       expect(file).to.not.be.undefined
  52
  53       expect(file.magnetUri).to.have.lengthOf.above(2)
  54       expect(file.torrentUrl).to.equal(`http://${server.host}/lazy-static/torrents/${videoDetails.uuid}-${file.resolution.id}-hls.torrent`)
  55       expect(file.fileUrl).to.equal(
  56         `${baseUrl}/static/streaming-playlists/hls/${videoDetails.uuid}/${videoDetails.uuid}-${file.resolution.id}-fragmented.mp4`
  57       )
  58       expect(file.resolution.label).to.equal(resolution + 'p')
  59
  60       await makeRawRequest(file.torrentUrl, HttpStatusCode.OK_200)
  61       await makeRawRequest(file.fileUrl, HttpStatusCode.OK_200)
  62
  63       const torrent = await webtorrentAdd(file.magnetUri, true)
  64       expect(torrent.files).to.be.an('array')
  65       expect(torrent.files.length).to.equal(1)
  66       expect(torrent.files[0].path).to.exist.and.to.not.equal('')
  67     }
  68
  69     {
  70       await checkResolutionsInMasterPlaylist(hlsPlaylist.playlistUrl, resolutions)
  71
  72       const res = await getPlaylist(hlsPlaylist.playlistUrl)
  73       const masterPlaylist = res.text
  74
  75       for (const resolution of resolutions) {
  76         expect(masterPlaylist).to.contain(`${resolution}.m3u8`)
  77         expect(masterPlaylist).to.contain(`${resolution}.m3u8`)
  78       }
  79     }
  80
  81     {
  82       for (const resolution of resolutions) {
  83         const res = await getPlaylist(`${baseUrl}/static/streaming-playlists/hls/${videoUUID}/${resolution}.m3u8`)
  84
  85         const subPlaylist = res.text
  86         expect(subPlaylist).to.contain(`${videoUUID}-${resolution}-fragmented.mp4`)
  87       }
  88     }
  89
  90     {
  91       const baseUrlAndPath = baseUrl + '/static/streaming-playlists/hls'
  92
  93       for (const resolution of resolutions) {
  94         await checkSegmentHash(baseUrlAndPath, baseUrlAndPath, videoUUID, resolution, hlsPlaylist)
  95       }
  96     }
  97   }
  98 }
  99
 100 describe('Test HLS videos', function () {
 101   let servers: ServerInfo[] = []
 102   let videoUUID = ''
 103   let videoAudioUUID = ''
 104
 105   function runTestSuite (hlsOnly: boolean) {
 106     it('Should upload a video and transcode it to HLS', async function () {
 107       this.timeout(120000)
 108
 109       const res = await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'video 1', fixture: 'video_short.webm' })
 110       videoUUID = res.body.video.uuid
 111
 112       await waitJobs(servers)
 113
 114       await checkHlsPlaylist(servers, videoUUID, hlsOnly)
 115     })
 116
 117     it('Should upload an audio file and transcode it to HLS', async function () {
 118       this.timeout(120000)
 119
 120       const res = await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'video audio', fixture: 'sample.ogg' })
 121       videoAudioUUID = res.body.video.uuid
 122
 123       await waitJobs(servers)
 124
 125       await checkHlsPlaylist(servers, videoAudioUUID, hlsOnly, [ DEFAULT_AUDIO_RESOLUTION, 360, 240 ])
 126     })
 127
 128     it('Should update the video', async function () {
 129       this.timeout(10000)
 130
 131       await updateVideo(servers[0].url, servers[0].accessToken, videoUUID, { name: 'video 1 updated' })
 132
 133       await waitJobs(servers)
 134
 135       await checkHlsPlaylist(servers, videoUUID, hlsOnly)
 136     })
 137
 138     it('Should delete videos', async function () {
 139       this.timeout(10000)
 140
 141       await removeVideo(servers[0].url, servers[0].accessToken, videoUUID)
 142       await removeVideo(servers[0].url, servers[0].accessToken, videoAudioUUID)
 143
 144       await waitJobs(servers)
 145
 146       for (const server of servers) {
 147         await getVideo(server.url, videoUUID, HttpStatusCode.NOT_FOUND_404)
 148         await getVideo(server.url, videoAudioUUID, HttpStatusCode.NOT_FOUND_404)
 149       }
 150     })
 151
 152     it('Should have the playlists/segment deleted from the disk', async function () {
 153       for (const server of servers) {
 154         await checkDirectoryIsEmpty(server, 'videos')
 155         await checkDirectoryIsEmpty(server, join('streaming-playlists', 'hls'))
 156       }
 157     })
 158
 159     it('Should have an empty tmp directory', async function () {
 160       for (const server of servers) {
 161         await checkTmpIsEmpty(server)
 162       }
 163     })
 164   }
 165
 166   before(async function () {
 167     this.timeout(120000)
 168
 169     const configOverride = {
 170       transcoding: {
 171         enabled: true,
 172         allow_audio_files: true,
 173         hls: {
 174           enabled: true
 175         }
 176       }
 177     }
 178     servers = await flushAndRunMultipleServers(2, configOverride)
 179
 180     // Get the access tokens
 181     await setAccessTokensToServers(servers)
 182
 183     // Server 1 and server 2 follow each other
 184     await doubleFollow(servers[0], servers[1])
 185   })
 186
 187   describe('With WebTorrent & HLS enabled', function () {
 188     runTestSuite(false)
 189   })
 190
 191   describe('With only HLS enabled', function () {
 192
 193     before(async function () {
 194       await servers[0].configCommand.updateCustomSubConfig({
 195         newConfig: {
 196           transcoding: {
 197             enabled: true,
 198             allowAudioFiles: true,
 199             resolutions: {
 200               '240p': true,
 201               '360p': true,
 202               '480p': true,
 203               '720p': true,
 204               '1080p': true,
 205               '1440p': true,
 206               '2160p': true
 207             },
 208             hls: {
 209               enabled: true
 210             },
 211             webtorrent: {
 212               enabled: false
 213             }
 214           }
 215         }
 216       })
 217     })
 218
 219     runTestSuite(true)
 220   })
 221
 222   after(async function () {
 223     await cleanupTests(servers)
 224   })
 225 })