1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
3 import { expect } from 'chai'
4 import { pathExists, readdir, readFile } from 'fs-extra'
5 import * as parseTorrent from 'parse-torrent'
6 import { extname, join } from 'path'
7 import * as request from 'supertest'
8 import { v4 as uuidv4 } from 'uuid'
9 import validator from 'validator'
10 import { loadLanguages, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../server/initializers/constants'
11 import { VideoDetails, VideoPrivacy } from '../../models/videos'
13 buildAbsoluteFixturePath,
20 } from '../miscs/miscs'
21 import { makeGetRequest, makePutBodyRequest, makeUploadRequest } from '../requests/requests'
22 import { waitJobs } from '../server/jobs'
23 import { ServerInfo } from '../server/servers'
24 import { getMyUserInformation } from '../users/users'
28 type VideoAttributes = {
34 commentsEnabled?: boolean
35 downloadEnabled?: boolean
36 waitTranscoding?: boolean
38 originallyPublishedAt?: string
41 privacy?: VideoPrivacy
43 thumbnailfile?: string
47 privacy?: VideoPrivacy
51 function getVideoCategories (url: string) {
52 const path = '/api/v1/videos/categories'
54 return makeGetRequest({
57 statusCodeExpected: 200
61 function getVideoLicences (url: string) {
62 const path = '/api/v1/videos/licences'
64 return makeGetRequest({
67 statusCodeExpected: 200
71 function getVideoLanguages (url: string) {
72 const path = '/api/v1/videos/languages'
74 return makeGetRequest({
77 statusCodeExpected: 200
81 function getVideoPrivacies (url: string) {
82 const path = '/api/v1/videos/privacies'
84 return makeGetRequest({
87 statusCodeExpected: 200
91 function getVideo (url: string, id: number | string, expectedStatus = 200) {
92 const path = '/api/v1/videos/' + id
96 .set('Accept', 'application/json')
97 .expect(expectedStatus)
100 async function getVideoIdFromUUID (url: string, uuid: string) {
101 const res = await getVideo(url, uuid)
106 function getVideoFileMetadataUrl (url: string) {
109 .set('Accept', 'application/json')
111 .expect('Content-Type', /json/)
114 function viewVideo (url: string, id: number | string, expectedStatus = 204, xForwardedFor?: string) {
115 const path = '/api/v1/videos/' + id + '/views'
117 const req = request(url)
119 .set('Accept', 'application/json')
122 req.set('X-Forwarded-For', xForwardedFor)
125 return req.expect(expectedStatus)
128 function getVideoWithToken (url: string, token: string, id: number | string, expectedStatus = 200) {
129 const path = '/api/v1/videos/' + id
133 .set('Authorization', 'Bearer ' + token)
134 .set('Accept', 'application/json')
135 .expect(expectedStatus)
138 function getVideoDescription (url: string, descriptionPath: string) {
140 .get(descriptionPath)
141 .set('Accept', 'application/json')
143 .expect('Content-Type', /json/)
146 function getVideosList (url: string) {
147 const path = '/api/v1/videos'
151 .query({ sort: 'name' })
152 .set('Accept', 'application/json')
154 .expect('Content-Type', /json/)
157 function getVideosListWithToken (url: string, token: string, query: { nsfw?: boolean } = {}) {
158 const path = '/api/v1/videos'
162 .set('Authorization', 'Bearer ' + token)
163 .query(immutableAssign(query, { sort: 'name' }))
164 .set('Accept', 'application/json')
166 .expect('Content-Type', /json/)
169 function getLocalVideos (url: string) {
170 const path = '/api/v1/videos'
174 .query({ sort: 'name', filter: 'local' })
175 .set('Accept', 'application/json')
177 .expect('Content-Type', /json/)
180 function getMyVideos (url: string, accessToken: string, start: number, count: number, sort?: string, search?: string) {
181 const path = '/api/v1/users/me/videos'
183 const req = request(url)
185 .query({ start: start })
186 .query({ count: count })
187 .query({ search: search })
189 if (sort) req.query({ sort })
191 return req.set('Accept', 'application/json')
192 .set('Authorization', 'Bearer ' + accessToken)
194 .expect('Content-Type', /json/)
197 function getAccountVideos (
204 query: { nsfw?: boolean } = {}
206 const path = '/api/v1/accounts/' + accountName + '/videos'
208 return makeGetRequest({
211 query: immutableAssign(query, {
217 statusCodeExpected: 200
221 function getVideoChannelVideos (
224 videoChannelName: string,
228 query: { nsfw?: boolean } = {}
230 const path = '/api/v1/video-channels/' + videoChannelName + '/videos'
232 return makeGetRequest({
235 query: immutableAssign(query, {
241 statusCodeExpected: 200
245 function getPlaylistVideos (
248 playlistId: number | string,
251 query: { nsfw?: boolean } = {}
253 const path = '/api/v1/video-playlists/' + playlistId + '/videos'
255 return makeGetRequest({
258 query: immutableAssign(query, {
263 statusCodeExpected: 200
267 function getVideosListPagination (url: string, start: number, count: number, sort?: string, skipCount?: boolean) {
268 const path = '/api/v1/videos'
270 const req = request(url)
272 .query({ start: start })
273 .query({ count: count })
275 if (sort) req.query({ sort })
276 if (skipCount) req.query({ skipCount })
278 return req.set('Accept', 'application/json')
280 .expect('Content-Type', /json/)
283 function getVideosListSort (url: string, sort: string) {
284 const path = '/api/v1/videos'
288 .query({ sort: sort })
289 .set('Accept', 'application/json')
291 .expect('Content-Type', /json/)
294 function getVideosWithFilters (url: string, query: { tagsAllOf: string[], categoryOneOf: number[] | number }) {
295 const path = '/api/v1/videos'
300 .set('Accept', 'application/json')
302 .expect('Content-Type', /json/)
305 function removeVideo (url: string, token: string, id: number | string, expectedStatus = 204) {
306 const path = '/api/v1/videos'
309 .delete(path + '/' + id)
310 .set('Accept', 'application/json')
311 .set('Authorization', 'Bearer ' + token)
312 .expect(expectedStatus)
315 async function checkVideoFilesWereRemoved (
317 serverNumber: number,
325 join('playlists', 'hls'),
326 join('redundancy', 'hls')
329 for (const directory of directories) {
330 const directoryPath = buildServerDirectory(serverNumber, directory)
332 const directoryExists = await pathExists(directoryPath)
333 if (directoryExists === false) continue
335 const files = await readdir(directoryPath)
336 for (const file of files) {
337 expect(file).to.not.contain(videoUUID)
342 async function uploadVideo (url: string, accessToken: string, videoAttributesArg: VideoAttributes, specialStatus = 200) {
343 const path = '/api/v1/videos/upload'
344 let defaultChannelId = '1'
347 const res = await getMyUserInformation(url, accessToken)
348 defaultChannelId = res.body.videoChannels[0].id
349 } catch (e) { /* empty */ }
351 // Override default attributes
352 const attributes = Object.assign({
353 name: 'my super video',
357 channelId: defaultChannelId,
359 waitTranscoding: false,
360 description: 'my super description',
361 support: 'my super support text',
363 privacy: VideoPrivacy.PUBLIC,
364 commentsEnabled: true,
365 downloadEnabled: true,
366 fixture: 'video_short.webm'
367 }, videoAttributesArg)
369 const req = request(url)
371 .set('Accept', 'application/json')
372 .set('Authorization', 'Bearer ' + accessToken)
373 .field('name', attributes.name)
374 .field('nsfw', JSON.stringify(attributes.nsfw))
375 .field('commentsEnabled', JSON.stringify(attributes.commentsEnabled))
376 .field('downloadEnabled', JSON.stringify(attributes.downloadEnabled))
377 .field('waitTranscoding', JSON.stringify(attributes.waitTranscoding))
378 .field('privacy', attributes.privacy.toString())
379 .field('channelId', attributes.channelId)
381 if (attributes.support !== undefined) {
382 req.field('support', attributes.support)
385 if (attributes.description !== undefined) {
386 req.field('description', attributes.description)
388 if (attributes.language !== undefined) {
389 req.field('language', attributes.language.toString())
391 if (attributes.category !== undefined) {
392 req.field('category', attributes.category.toString())
394 if (attributes.licence !== undefined) {
395 req.field('licence', attributes.licence.toString())
398 const tags = attributes.tags || []
399 for (let i = 0; i < tags.length; i++) {
400 req.field('tags[' + i + ']', attributes.tags[i])
403 if (attributes.thumbnailfile !== undefined) {
404 req.attach('thumbnailfile', buildAbsoluteFixturePath(attributes.thumbnailfile))
406 if (attributes.previewfile !== undefined) {
407 req.attach('previewfile', buildAbsoluteFixturePath(attributes.previewfile))
410 if (attributes.scheduleUpdate) {
411 req.field('scheduleUpdate[updateAt]', attributes.scheduleUpdate.updateAt)
413 if (attributes.scheduleUpdate.privacy) {
414 req.field('scheduleUpdate[privacy]', attributes.scheduleUpdate.privacy)
418 if (attributes.originallyPublishedAt !== undefined) {
419 req.field('originallyPublishedAt', attributes.originallyPublishedAt)
422 return req.attach('videofile', buildAbsoluteFixturePath(attributes.fixture))
423 .expect(specialStatus)
426 function updateVideo (url: string, accessToken: string, id: number | string, attributes: VideoAttributes, statusCodeExpected = 204) {
427 const path = '/api/v1/videos/' + id
430 if (attributes.name) body['name'] = attributes.name
431 if (attributes.category) body['category'] = attributes.category
432 if (attributes.licence) body['licence'] = attributes.licence
433 if (attributes.language) body['language'] = attributes.language
434 if (attributes.nsfw !== undefined) body['nsfw'] = JSON.stringify(attributes.nsfw)
435 if (attributes.commentsEnabled !== undefined) body['commentsEnabled'] = JSON.stringify(attributes.commentsEnabled)
436 if (attributes.downloadEnabled !== undefined) body['downloadEnabled'] = JSON.stringify(attributes.downloadEnabled)
437 if (attributes.originallyPublishedAt !== undefined) body['originallyPublishedAt'] = attributes.originallyPublishedAt
438 if (attributes.description) body['description'] = attributes.description
439 if (attributes.tags) body['tags'] = attributes.tags
440 if (attributes.privacy) body['privacy'] = attributes.privacy
441 if (attributes.channelId) body['channelId'] = attributes.channelId
442 if (attributes.scheduleUpdate) body['scheduleUpdate'] = attributes.scheduleUpdate
445 if (attributes.thumbnailfile || attributes.previewfile) {
446 const attaches: any = {}
447 if (attributes.thumbnailfile) attaches.thumbnailfile = attributes.thumbnailfile
448 if (attributes.previewfile) attaches.previewfile = attributes.previewfile
450 return makeUploadRequest({
461 return makePutBodyRequest({
470 function rateVideo (url: string, accessToken: string, id: number, rating: string, specialStatus = 204) {
471 const path = '/api/v1/videos/' + id + '/rate'
475 .set('Accept', 'application/json')
476 .set('Authorization', 'Bearer ' + accessToken)
478 .expect(specialStatus)
481 function parseTorrentVideo (server: ServerInfo, videoUUID: string, resolution: number) {
482 return new Promise<any>((res, rej) => {
483 const torrentName = videoUUID + '-' + resolution + '.torrent'
484 const torrentPath = join(root(), 'test' + server.internalServerNumber, 'torrents', torrentName)
485 readFile(torrentPath, (err, data) => {
486 if (err) return rej(err)
488 return res(parseTorrent(data))
493 async function completeVideoCheck (
502 commentsEnabled: boolean
503 downloadEnabled: boolean
507 originallyPublishedAt?: string
529 thumbnailfile?: string
533 if (!attributes.likes) attributes.likes = 0
534 if (!attributes.dislikes) attributes.dislikes = 0
536 expect(video.name).to.equal(attributes.name)
537 expect(video.category.id).to.equal(attributes.category)
538 expect(video.category.label).to.equal(attributes.category !== null ? VIDEO_CATEGORIES[attributes.category] : 'Misc')
539 expect(video.licence.id).to.equal(attributes.licence)
540 expect(video.licence.label).to.equal(attributes.licence !== null ? VIDEO_LICENCES[attributes.licence] : 'Unknown')
541 expect(video.language.id).to.equal(attributes.language)
542 expect(video.language.label).to.equal(attributes.language !== null ? VIDEO_LANGUAGES[attributes.language] : 'Unknown')
543 expect(video.privacy.id).to.deep.equal(attributes.privacy)
544 expect(video.privacy.label).to.deep.equal(VIDEO_PRIVACIES[attributes.privacy])
545 expect(video.nsfw).to.equal(attributes.nsfw)
546 expect(video.description).to.equal(attributes.description)
547 expect(video.account.id).to.be.a('number')
548 expect(video.account.host).to.equal(attributes.account.host)
549 expect(video.account.name).to.equal(attributes.account.name)
550 expect(video.channel.displayName).to.equal(attributes.channel.displayName)
551 expect(video.channel.name).to.equal(attributes.channel.name)
552 expect(video.likes).to.equal(attributes.likes)
553 expect(video.dislikes).to.equal(attributes.dislikes)
554 expect(video.isLocal).to.equal(attributes.isLocal)
555 expect(video.duration).to.equal(attributes.duration)
556 expect(dateIsValid(video.createdAt)).to.be.true
557 expect(dateIsValid(video.publishedAt)).to.be.true
558 expect(dateIsValid(video.updatedAt)).to.be.true
560 if (attributes.publishedAt) {
561 expect(video.publishedAt).to.equal(attributes.publishedAt)
564 if (attributes.originallyPublishedAt) {
565 expect(video.originallyPublishedAt).to.equal(attributes.originallyPublishedAt)
567 expect(video.originallyPublishedAt).to.be.null
570 const res = await getVideo(url, video.uuid)
571 const videoDetails: VideoDetails = res.body
573 expect(videoDetails.files).to.have.lengthOf(attributes.files.length)
574 expect(videoDetails.tags).to.deep.equal(attributes.tags)
575 expect(videoDetails.account.name).to.equal(attributes.account.name)
576 expect(videoDetails.account.host).to.equal(attributes.account.host)
577 expect(video.channel.displayName).to.equal(attributes.channel.displayName)
578 expect(video.channel.name).to.equal(attributes.channel.name)
579 expect(videoDetails.channel.host).to.equal(attributes.account.host)
580 expect(videoDetails.channel.isLocal).to.equal(attributes.channel.isLocal)
581 expect(dateIsValid(videoDetails.channel.createdAt.toString())).to.be.true
582 expect(dateIsValid(videoDetails.channel.updatedAt.toString())).to.be.true
583 expect(videoDetails.commentsEnabled).to.equal(attributes.commentsEnabled)
584 expect(videoDetails.downloadEnabled).to.equal(attributes.downloadEnabled)
586 for (const attributeFile of attributes.files) {
587 const file = videoDetails.files.find(f => f.resolution.id === attributeFile.resolution)
588 expect(file).not.to.be.undefined
590 let extension = extname(attributes.fixture)
591 // Transcoding enabled: extension will always be .mp4
592 if (attributes.files.length > 1) extension = '.mp4'
594 expect(file.magnetUri).to.have.lengthOf.above(2)
595 expect(file.torrentUrl).to.equal(`http://${attributes.account.host}/static/torrents/${videoDetails.uuid}-${file.resolution.id}.torrent`)
596 expect(file.fileUrl).to.equal(`http://${attributes.account.host}/static/webseed/${videoDetails.uuid}-${file.resolution.id}${extension}`)
597 expect(file.resolution.id).to.equal(attributeFile.resolution)
598 expect(file.resolution.label).to.equal(attributeFile.resolution + 'p')
600 const minSize = attributeFile.size - ((10 * attributeFile.size) / 100)
601 const maxSize = attributeFile.size + ((10 * attributeFile.size) / 100)
604 'File size for resolution ' + file.resolution.label + ' outside confidence interval (' + minSize + '> size <' + maxSize + ')'
605 ).to.be.above(minSize).and.below(maxSize)
607 const torrent = await webtorrentAdd(file.magnetUri, true)
608 expect(torrent.files).to.be.an('array')
609 expect(torrent.files.length).to.equal(1)
610 expect(torrent.files[0].path).to.exist.and.to.not.equal('')
613 await testImage(url, attributes.thumbnailfile || attributes.fixture, videoDetails.thumbnailPath)
615 if (attributes.previewfile) {
616 await testImage(url, attributes.previewfile, videoDetails.previewPath)
620 async function videoUUIDToId (url: string, id: number | string) {
621 if (validator.isUUID('' + id) === false) return id
623 const res = await getVideo(url, id)
627 async function uploadVideoAndGetId (options: {
631 privacy?: VideoPrivacy
634 const videoAttrs: any = { name: options.videoName }
635 if (options.nsfw) videoAttrs.nsfw = options.nsfw
636 if (options.privacy) videoAttrs.privacy = options.privacy
638 const res = await uploadVideo(options.server.url, options.token || options.server.accessToken, videoAttrs)
640 return { id: res.body.video.id, uuid: res.body.video.uuid }
643 async function getLocalIdByUUID (url: string, uuid: string) {
644 const res = await getVideo(url, uuid)
649 // serverNumber starts from 1
650 async function uploadRandomVideoOnServers (servers: ServerInfo[], serverNumber: number, additionalParams: any = {}) {
651 const server = servers.find(s => s.serverNumber === serverNumber)
652 const res = await uploadRandomVideo(server, false, additionalParams)
654 await waitJobs(servers)
659 async function uploadRandomVideo (server: ServerInfo, wait = true, additionalParams: any = {}) {
660 const prefixName = additionalParams.prefixName || ''
661 const name = prefixName + uuidv4()
663 const data = Object.assign({ name }, additionalParams)
664 const res = await uploadVideo(server.url, server.accessToken, data)
666 if (wait) await waitJobs([ server ])
668 return { uuid: res.body.video.uuid, name }
671 // ---------------------------------------------------------------------------
683 getVideoChannelVideos,
685 getVideoFileMetadataUrl,
688 getVideosListPagination,
691 getVideosListWithToken,
693 getVideosWithFilters,
694 uploadRandomVideoOnServers,
701 checkVideoFilesWereRemoved,