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