1 /* tslint:disable:no-unused-expression */
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'
9 buildAbsoluteFixturePath,
19 import validator from 'validator'
20 import { VideoDetails, VideoPrivacy } from '../../models/videos'
21 import { VIDEO_CATEGORIES, VIDEO_LANGUAGES, loadLanguages, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../server/initializers/constants'
22 import { dateIsValid, webtorrentAdd, buildServerDirectory } from '../miscs/miscs'
26 type VideoAttributes = {
32 commentsEnabled?: boolean
33 downloadEnabled?: boolean
34 waitTranscoding?: boolean
36 originallyPublishedAt?: string
39 privacy?: VideoPrivacy
41 thumbnailfile?: string
45 privacy?: VideoPrivacy
49 function getVideoCategories (url: string) {
50 const path = '/api/v1/videos/categories'
52 return makeGetRequest({
55 statusCodeExpected: 200
59 function getVideoLicences (url: string) {
60 const path = '/api/v1/videos/licences'
62 return makeGetRequest({
65 statusCodeExpected: 200
69 function getVideoLanguages (url: string) {
70 const path = '/api/v1/videos/languages'
72 return makeGetRequest({
75 statusCodeExpected: 200
79 function getVideoPrivacies (url: string) {
80 const path = '/api/v1/videos/privacies'
82 return makeGetRequest({
85 statusCodeExpected: 200
89 function getVideo (url: string, id: number | string, expectedStatus = 200) {
90 const path = '/api/v1/videos/' + id
94 .set('Accept', 'application/json')
95 .expect(expectedStatus)
98 function viewVideo (url: string, id: number | string, expectedStatus = 204, xForwardedFor?: string) {
99 const path = '/api/v1/videos/' + id + '/views'
101 const req = request(url)
103 .set('Accept', 'application/json')
106 req.set('X-Forwarded-For', xForwardedFor)
109 return req.expect(expectedStatus)
112 function getVideoWithToken (url: string, token: string, id: number | string, expectedStatus = 200) {
113 const path = '/api/v1/videos/' + id
117 .set('Authorization', 'Bearer ' + token)
118 .set('Accept', 'application/json')
119 .expect(expectedStatus)
122 function getVideoDescription (url: string, descriptionPath: string) {
124 .get(descriptionPath)
125 .set('Accept', 'application/json')
127 .expect('Content-Type', /json/)
130 function getVideosList (url: string) {
131 const path = '/api/v1/videos'
135 .query({ sort: 'name' })
136 .set('Accept', 'application/json')
138 .expect('Content-Type', /json/)
141 function getVideosListWithToken (url: string, token: string, query: { nsfw?: boolean } = {}) {
142 const path = '/api/v1/videos'
146 .set('Authorization', 'Bearer ' + token)
147 .query(immutableAssign(query, { sort: 'name' }))
148 .set('Accept', 'application/json')
150 .expect('Content-Type', /json/)
153 function getLocalVideos (url: string) {
154 const path = '/api/v1/videos'
158 .query({ sort: 'name', filter: 'local' })
159 .set('Accept', 'application/json')
161 .expect('Content-Type', /json/)
164 function getMyVideos (url: string, accessToken: string, start: number, count: number, sort?: string, search?: string) {
165 const path = '/api/v1/users/me/videos'
167 const req = request(url)
169 .query({ start: start })
170 .query({ count: count })
171 .query({ search: search })
173 if (sort) req.query({ sort })
175 return req.set('Accept', 'application/json')
176 .set('Authorization', 'Bearer ' + accessToken)
178 .expect('Content-Type', /json/)
181 function getAccountVideos (
188 query: { nsfw?: boolean } = {}
190 const path = '/api/v1/accounts/' + accountName + '/videos'
192 return makeGetRequest({
195 query: immutableAssign(query, {
201 statusCodeExpected: 200
205 function getVideoChannelVideos (
208 videoChannelName: string,
212 query: { nsfw?: boolean } = {}
214 const path = '/api/v1/video-channels/' + videoChannelName + '/videos'
216 return makeGetRequest({
219 query: immutableAssign(query, {
225 statusCodeExpected: 200
229 function getPlaylistVideos (
232 playlistId: number | string,
235 query: { nsfw?: boolean } = {}
237 const path = '/api/v1/video-playlists/' + playlistId + '/videos'
239 return makeGetRequest({
242 query: immutableAssign(query, {
247 statusCodeExpected: 200
251 function getVideosListPagination (url: string, start: number, count: number, sort?: string, skipCount?: boolean) {
252 const path = '/api/v1/videos'
254 const req = request(url)
256 .query({ start: start })
257 .query({ count: count })
259 if (sort) req.query({ sort })
260 if (skipCount) req.query({ skipCount })
262 return req.set('Accept', 'application/json')
264 .expect('Content-Type', /json/)
267 function getVideosListSort (url: string, sort: string) {
268 const path = '/api/v1/videos'
272 .query({ sort: sort })
273 .set('Accept', 'application/json')
275 .expect('Content-Type', /json/)
278 function getVideosWithFilters (url: string, query: { tagsAllOf: string[], categoryOneOf: number[] | number }) {
279 const path = '/api/v1/videos'
284 .set('Accept', 'application/json')
286 .expect('Content-Type', /json/)
289 function removeVideo (url: string, token: string, id: number | string, expectedStatus = 204) {
290 const path = '/api/v1/videos'
293 .delete(path + '/' + id)
294 .set('Accept', 'application/json')
295 .set('Authorization', 'Bearer ' + token)
296 .expect(expectedStatus)
299 async function checkVideoFilesWereRemoved (
301 serverNumber: number,
309 join('playlists', 'hls'),
310 join('redundancy', 'hls')
313 for (const directory of directories) {
314 const directoryPath = buildServerDirectory(serverNumber, directory)
316 const directoryExists = await pathExists(directoryPath)
317 if (directoryExists === false) continue
319 const files = await readdir(directoryPath)
320 for (const file of files) {
321 expect(file).to.not.contain(videoUUID)
326 async function uploadVideo (url: string, accessToken: string, videoAttributesArg: VideoAttributes, specialStatus = 200) {
327 const path = '/api/v1/videos/upload'
328 let defaultChannelId = '1'
331 const res = await getMyUserInformation(url, accessToken)
332 defaultChannelId = res.body.videoChannels[0].id
333 } catch (e) { /* empty */ }
335 // Override default attributes
336 const attributes = Object.assign({
337 name: 'my super video',
341 channelId: defaultChannelId,
343 waitTranscoding: false,
344 description: 'my super description',
345 support: 'my super support text',
347 privacy: VideoPrivacy.PUBLIC,
348 commentsEnabled: true,
349 downloadEnabled: true,
350 fixture: 'video_short.webm'
351 }, videoAttributesArg)
353 const req = request(url)
355 .set('Accept', 'application/json')
356 .set('Authorization', 'Bearer ' + accessToken)
357 .field('name', attributes.name)
358 .field('nsfw', JSON.stringify(attributes.nsfw))
359 .field('commentsEnabled', JSON.stringify(attributes.commentsEnabled))
360 .field('downloadEnabled', JSON.stringify(attributes.downloadEnabled))
361 .field('waitTranscoding', JSON.stringify(attributes.waitTranscoding))
362 .field('privacy', attributes.privacy.toString())
363 .field('channelId', attributes.channelId)
365 if (attributes.support !== undefined) {
366 req.field('support', attributes.support)
369 if (attributes.description !== undefined) {
370 req.field('description', attributes.description)
372 if (attributes.language !== undefined) {
373 req.field('language', attributes.language.toString())
375 if (attributes.category !== undefined) {
376 req.field('category', attributes.category.toString())
378 if (attributes.licence !== undefined) {
379 req.field('licence', attributes.licence.toString())
382 const tags = attributes.tags || []
383 for (let i = 0; i < tags.length; i++) {
384 req.field('tags[' + i + ']', attributes.tags[i])
387 if (attributes.thumbnailfile !== undefined) {
388 req.attach('thumbnailfile', buildAbsoluteFixturePath(attributes.thumbnailfile))
390 if (attributes.previewfile !== undefined) {
391 req.attach('previewfile', buildAbsoluteFixturePath(attributes.previewfile))
394 if (attributes.scheduleUpdate) {
395 req.field('scheduleUpdate[updateAt]', attributes.scheduleUpdate.updateAt)
397 if (attributes.scheduleUpdate.privacy) {
398 req.field('scheduleUpdate[privacy]', attributes.scheduleUpdate.privacy)
402 if (attributes.originallyPublishedAt !== undefined) {
403 req.field('originallyPublishedAt', attributes.originallyPublishedAt)
406 return req.attach('videofile', buildAbsoluteFixturePath(attributes.fixture))
407 .expect(specialStatus)
410 function updateVideo (url: string, accessToken: string, id: number | string, attributes: VideoAttributes, statusCodeExpected = 204) {
411 const path = '/api/v1/videos/' + id
414 if (attributes.name) body['name'] = attributes.name
415 if (attributes.category) body['category'] = attributes.category
416 if (attributes.licence) body['licence'] = attributes.licence
417 if (attributes.language) body['language'] = attributes.language
418 if (attributes.nsfw !== undefined) body['nsfw'] = JSON.stringify(attributes.nsfw)
419 if (attributes.commentsEnabled !== undefined) body['commentsEnabled'] = JSON.stringify(attributes.commentsEnabled)
420 if (attributes.downloadEnabled !== undefined) body['downloadEnabled'] = JSON.stringify(attributes.downloadEnabled)
421 if (attributes.originallyPublishedAt !== undefined) body['originallyPublishedAt'] = attributes.originallyPublishedAt
422 if (attributes.description) body['description'] = attributes.description
423 if (attributes.tags) body['tags'] = attributes.tags
424 if (attributes.privacy) body['privacy'] = attributes.privacy
425 if (attributes.channelId) body['channelId'] = attributes.channelId
426 if (attributes.scheduleUpdate) body['scheduleUpdate'] = attributes.scheduleUpdate
429 if (attributes.thumbnailfile || attributes.previewfile) {
430 const attaches: any = {}
431 if (attributes.thumbnailfile) attaches.thumbnailfile = attributes.thumbnailfile
432 if (attributes.previewfile) attaches.previewfile = attributes.previewfile
434 return makeUploadRequest({
445 return makePutBodyRequest({
454 function rateVideo (url: string, accessToken: string, id: number, rating: string, specialStatus = 204) {
455 const path = '/api/v1/videos/' + id + '/rate'
459 .set('Accept', 'application/json')
460 .set('Authorization', 'Bearer ' + accessToken)
462 .expect(specialStatus)
465 function parseTorrentVideo (server: ServerInfo, videoUUID: string, resolution: number) {
466 return new Promise<any>((res, rej) => {
467 const torrentName = videoUUID + '-' + resolution + '.torrent'
468 const torrentPath = join(root(), 'test' + server.serverNumber, 'torrents', torrentName)
469 readFile(torrentPath, (err, data) => {
470 if (err) return rej(err)
472 return res(parseTorrent(data))
477 async function completeVideoCheck (
486 commentsEnabled: boolean
487 downloadEnabled: boolean
491 originallyPublishedAt?: string,
513 thumbnailfile?: string
517 if (!attributes.likes) attributes.likes = 0
518 if (!attributes.dislikes) attributes.dislikes = 0
520 expect(video.name).to.equal(attributes.name)
521 expect(video.category.id).to.equal(attributes.category)
522 expect(video.category.label).to.equal(attributes.category !== null ? VIDEO_CATEGORIES[attributes.category] : 'Misc')
523 expect(video.licence.id).to.equal(attributes.licence)
524 expect(video.licence.label).to.equal(attributes.licence !== null ? VIDEO_LICENCES[attributes.licence] : 'Unknown')
525 expect(video.language.id).to.equal(attributes.language)
526 expect(video.language.label).to.equal(attributes.language !== null ? VIDEO_LANGUAGES[attributes.language] : 'Unknown')
527 expect(video.privacy.id).to.deep.equal(attributes.privacy)
528 expect(video.privacy.label).to.deep.equal(VIDEO_PRIVACIES[attributes.privacy])
529 expect(video.nsfw).to.equal(attributes.nsfw)
530 expect(video.description).to.equal(attributes.description)
531 expect(video.account.id).to.be.a('number')
532 expect(video.account.host).to.equal(attributes.account.host)
533 expect(video.account.name).to.equal(attributes.account.name)
534 expect(video.channel.displayName).to.equal(attributes.channel.displayName)
535 expect(video.channel.name).to.equal(attributes.channel.name)
536 expect(video.likes).to.equal(attributes.likes)
537 expect(video.dislikes).to.equal(attributes.dislikes)
538 expect(video.isLocal).to.equal(attributes.isLocal)
539 expect(video.duration).to.equal(attributes.duration)
540 expect(dateIsValid(video.createdAt)).to.be.true
541 expect(dateIsValid(video.publishedAt)).to.be.true
542 expect(dateIsValid(video.updatedAt)).to.be.true
544 if (attributes.publishedAt) {
545 expect(video.publishedAt).to.equal(attributes.publishedAt)
548 if (attributes.originallyPublishedAt) {
549 expect(video.originallyPublishedAt).to.equal(attributes.originallyPublishedAt)
551 expect(video.originallyPublishedAt).to.be.null
554 const res = await getVideo(url, video.uuid)
555 const videoDetails: VideoDetails = res.body
557 expect(videoDetails.files).to.have.lengthOf(attributes.files.length)
558 expect(videoDetails.tags).to.deep.equal(attributes.tags)
559 expect(videoDetails.account.name).to.equal(attributes.account.name)
560 expect(videoDetails.account.host).to.equal(attributes.account.host)
561 expect(video.channel.displayName).to.equal(attributes.channel.displayName)
562 expect(video.channel.name).to.equal(attributes.channel.name)
563 expect(videoDetails.channel.host).to.equal(attributes.account.host)
564 expect(videoDetails.channel.isLocal).to.equal(attributes.channel.isLocal)
565 expect(dateIsValid(videoDetails.channel.createdAt.toString())).to.be.true
566 expect(dateIsValid(videoDetails.channel.updatedAt.toString())).to.be.true
567 expect(videoDetails.commentsEnabled).to.equal(attributes.commentsEnabled)
568 expect(videoDetails.downloadEnabled).to.equal(attributes.downloadEnabled)
570 for (const attributeFile of attributes.files) {
571 const file = videoDetails.files.find(f => f.resolution.id === attributeFile.resolution)
572 expect(file).not.to.be.undefined
574 let extension = extname(attributes.fixture)
575 // Transcoding enabled: extension will always be .mp4
576 if (attributes.files.length > 1) extension = '.mp4'
578 expect(file.magnetUri).to.have.lengthOf.above(2)
579 expect(file.torrentUrl).to.equal(`http://${attributes.account.host}/static/torrents/${videoDetails.uuid}-${file.resolution.id}.torrent`)
580 expect(file.fileUrl).to.equal(`http://${attributes.account.host}/static/webseed/${videoDetails.uuid}-${file.resolution.id}${extension}`)
581 expect(file.resolution.id).to.equal(attributeFile.resolution)
582 expect(file.resolution.label).to.equal(attributeFile.resolution + 'p')
584 const minSize = attributeFile.size - ((10 * attributeFile.size) / 100)
585 const maxSize = attributeFile.size + ((10 * attributeFile.size) / 100)
587 'File size for resolution ' + file.resolution.label + ' outside confidence interval (' + minSize + '> size <' + maxSize + ')')
588 .to.be.above(minSize).and.below(maxSize)
591 await testImage(url, attributes.thumbnailfile || attributes.fixture, videoDetails.thumbnailPath)
594 if (attributes.previewfile) {
595 await testImage(url, attributes.previewfile, videoDetails.previewPath)
598 const torrent = await webtorrentAdd(file.magnetUri, true)
599 expect(torrent.files).to.be.an('array')
600 expect(torrent.files.length).to.equal(1)
601 expect(torrent.files[0].path).to.exist.and.to.not.equal('')
605 async function videoUUIDToId (url: string, id: number | string) {
606 if (validator.isUUID('' + id) === false) return id
608 const res = await getVideo(url, id)
612 async function uploadVideoAndGetId (options: { server: ServerInfo, videoName: string, nsfw?: boolean, token?: string }) {
613 const videoAttrs: any = { name: options.videoName }
614 if (options.nsfw) videoAttrs.nsfw = options.nsfw
616 const res = await uploadVideo(options.server.url, options.token || options.server.accessToken, videoAttrs)
618 return { id: res.body.video.id, uuid: res.body.video.uuid }
621 // ---------------------------------------------------------------------------
632 getVideoChannelVideos,
636 getVideosListPagination,
639 getVideosListWithToken,
641 getVideosWithFilters,
648 checkVideoFilesWereRemoved,