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   createMultipleServers,
  13   doubleFollow,
  14   makeRawRequest,
  15   PeerTubeServer,
  16   setAccessTokensToServers,
  17   waitJobs,
  18   webtorrentAdd
  19 } from '@shared/extra-utils'
  20 import { HttpStatusCode, VideoStreamingPlaylistType } from '@shared/models'
  21 import { DEFAULT_AUDIO_RESOLUTION } from '../../../initializers/constants'
  22
  23 const expect = chai.expect
  24
  25 async function checkHlsPlaylist (servers: PeerTubeServer[], videoUUID: string, hlsOnly: boolean, resolutions = [ 240, 360, 480, 720 ]) {
  26   for (const server of servers) {
  27     const videoDetails = await server.videos.get({ id: videoUUID })
  28     const baseUrl = `http://${videoDetails.account.host}`
  29
  30     expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
  31
  32     const hlsPlaylist = videoDetails.streamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
  33     expect(hlsPlaylist).to.not.be.undefined
  34
  35     const hlsFiles = hlsPlaylist.files
  36     expect(hlsFiles).to.have.lengthOf(resolutions.length)
  37
  38     if (hlsOnly) expect(videoDetails.files).to.have.lengthOf(0)
  39     else expect(videoDetails.files).to.have.lengthOf(resolutions.length)
  40
  41     for (const resolution of resolutions) {
  42       const file = hlsFiles.find(f => f.resolution.id === resolution)
  43       expect(file).to.not.be.undefined
  44
  45       expect(file.magnetUri).to.have.lengthOf.above(2)
  46       expect(file.torrentUrl).to.equal(`http://${server.host}/lazy-static/torrents/${videoDetails.uuid}-${file.resolution.id}-hls.torrent`)
  47       expect(file.fileUrl).to.equal(
  48         `${baseUrl}/static/streaming-playlists/hls/${videoDetails.uuid}/${videoDetails.uuid}-${file.resolution.id}-fragmented.mp4`
  49       )
  50       expect(file.resolution.label).to.equal(resolution + 'p')
  51
  52       await makeRawRequest(file.torrentUrl, HttpStatusCode.OK_200)
  53       await makeRawRequest(file.fileUrl, HttpStatusCode.OK_200)
  54
  55       const torrent = await webtorrentAdd(file.magnetUri, true)
  56       expect(torrent.files).to.be.an('array')
  57       expect(torrent.files.length).to.equal(1)
  58       expect(torrent.files[0].path).to.exist.and.to.not.equal('')
  59     }
  60
  61     {
  62       await checkResolutionsInMasterPlaylist({ server, playlistUrl: hlsPlaylist.playlistUrl, resolutions })
  63
  64       const masterPlaylist = await server.streamingPlaylists.get({ url: hlsPlaylist.playlistUrl })
  65
  66       for (const resolution of resolutions) {
  67         expect(masterPlaylist).to.contain(`${resolution}.m3u8`)
  68         expect(masterPlaylist).to.contain(`${resolution}.m3u8`)
  69       }
  70     }
  71
  72     {
  73       for (const resolution of resolutions) {
  74         const subPlaylist = await server.streamingPlaylists.get({
  75           url: `${baseUrl}/static/streaming-playlists/hls/${videoUUID}/${resolution}.m3u8`
  76         })
  77
  78         expect(subPlaylist).to.contain(`${videoUUID}-${resolution}-fragmented.mp4`)
  79       }
  80     }
  81
  82     {
  83       const baseUrlAndPath = baseUrl + '/static/streaming-playlists/hls'
  84
  85       for (const resolution of resolutions) {
  86         await checkSegmentHash({
  87           server,
  88           baseUrlPlaylist: baseUrlAndPath,
  89           baseUrlSegment: baseUrlAndPath,
  90           videoUUID,
  91           resolution,
  92           hlsPlaylist
  93         })
  94       }
  95     }
  96   }
  97 }
  98
  99 describe('Test HLS videos', function () {
 100   let servers: PeerTubeServer[] = []
 101   let videoUUID = ''
 102   let videoAudioUUID = ''
 103
 104   function runTestSuite (hlsOnly: boolean) {
 105
 106     it('Should upload a video and transcode it to HLS', async function () {
 107       this.timeout(120000)
 108
 109       const { uuid } = await servers[0].videos.upload({ attributes: { name: 'video 1', fixture: 'video_short.webm' } })
 110       videoUUID = 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 { uuid } = await servers[0].videos.upload({ attributes: { name: 'video audio', fixture: 'sample.ogg' } })
 121       videoAudioUUID = 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 servers[0].videos.update({ id: videoUUID, attributes: { 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 servers[0].videos.remove({ id: videoUUID })
 142       await servers[0].videos.remove({ id: videoAudioUUID })
 143
 144       await waitJobs(servers)
 145
 146       for (const server of servers) {
 147         await server.videos.get({ id: videoUUID, expectedStatus: HttpStatusCode.NOT_FOUND_404 })
 148         await server.videos.get({ id: videoAudioUUID, expectedStatus: 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 createMultipleServers(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].config.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 })