1 /* tslint:disable:no-unused-expression */
3 import { expect } from 'chai'
4 import { existsSync, 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,
20 import { VideoDetails, VideoPrivacy } from '../../models/videos'
21 import { VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../server/initializers/constants'
22 import { dateIsValid, webtorrentAdd } from '../miscs/miscs'
24 type VideoAttributes = {
30 commentsEnabled?: boolean
31 waitTranscoding?: boolean
35 privacy?: VideoPrivacy
37 thumbnailfile?: string
41 privacy?: VideoPrivacy
45 function getVideoCategories (url: string) {
46 const path = '/api/v1/videos/categories'
48 return makeGetRequest({
51 statusCodeExpected: 200
55 function getVideoLicences (url: string) {
56 const path = '/api/v1/videos/licences'
58 return makeGetRequest({
61 statusCodeExpected: 200
65 function getVideoLanguages (url: string) {
66 const path = '/api/v1/videos/languages'
68 return makeGetRequest({
71 statusCodeExpected: 200
75 function getVideoPrivacies (url: string) {
76 const path = '/api/v1/videos/privacies'
78 return makeGetRequest({
81 statusCodeExpected: 200
85 function getVideo (url: string, id: number | string, expectedStatus = 200) {
86 const path = '/api/v1/videos/' + id
90 .set('Accept', 'application/json')
91 .expect(expectedStatus)
94 function viewVideo (url: string, id: number | string, expectedStatus = 204, xForwardedFor?: string) {
95 const path = '/api/v1/videos/' + id + '/views'
97 const req = request(url)
99 .set('Accept', 'application/json')
102 req.set('X-Forwarded-For', xForwardedFor)
105 return req.expect(expectedStatus)
108 function getVideoWithToken (url: string, token: string, id: number | string, expectedStatus = 200) {
109 const path = '/api/v1/videos/' + id
113 .set('Authorization', 'Bearer ' + token)
114 .set('Accept', 'application/json')
115 .expect(expectedStatus)
118 function getVideoDescription (url: string, descriptionPath: string) {
120 .get(descriptionPath)
121 .set('Accept', 'application/json')
123 .expect('Content-Type', /json/)
126 function getVideosList (url: string) {
127 const path = '/api/v1/videos'
131 .query({ sort: 'name' })
132 .set('Accept', 'application/json')
134 .expect('Content-Type', /json/)
137 function getVideosListWithToken (url: string, token: string, query: { nsfw?: boolean } = {}) {
138 const path = '/api/v1/videos'
142 .set('Authorization', 'Bearer ' + token)
143 .query(immutableAssign(query, { sort: 'name' }))
144 .set('Accept', 'application/json')
146 .expect('Content-Type', /json/)
149 function getLocalVideos (url: string) {
150 const path = '/api/v1/videos'
154 .query({ sort: 'name', filter: 'local' })
155 .set('Accept', 'application/json')
157 .expect('Content-Type', /json/)
160 function getMyVideos (url: string, accessToken: string, start: number, count: number, sort?: string) {
161 const path = '/api/v1/users/me/videos'
163 const req = request(url)
165 .query({ start: start })
166 .query({ count: count })
168 if (sort) req.query({ sort })
170 return req.set('Accept', 'application/json')
171 .set('Authorization', 'Bearer ' + accessToken)
173 .expect('Content-Type', /json/)
176 function getAccountVideos (
183 query: { nsfw?: boolean } = {}
185 const path = '/api/v1/accounts/' + accountName + '/videos'
187 return makeGetRequest({
190 query: immutableAssign(query, {
196 statusCodeExpected: 200
200 function getVideoChannelVideos (
203 videoChannelName: string,
207 query: { nsfw?: boolean } = {}
209 const path = '/api/v1/video-channels/' + videoChannelName + '/videos'
211 return makeGetRequest({
214 query: immutableAssign(query, {
220 statusCodeExpected: 200
224 function getVideosListPagination (url: string, start: number, count: number, sort?: string) {
225 const path = '/api/v1/videos'
227 const req = request(url)
229 .query({ start: start })
230 .query({ count: count })
232 if (sort) req.query({ sort })
234 return req.set('Accept', 'application/json')
236 .expect('Content-Type', /json/)
239 function getVideosListSort (url: string, sort: string) {
240 const path = '/api/v1/videos'
244 .query({ sort: sort })
245 .set('Accept', 'application/json')
247 .expect('Content-Type', /json/)
250 function getVideosWithFilters (url: string, query: { tagsAllOf: string[], categoryOneOf: number[] | number }) {
251 const path = '/api/v1/videos'
256 .set('Accept', 'application/json')
258 .expect('Content-Type', /json/)
261 function removeVideo (url: string, token: string, id: number | string, expectedStatus = 204) {
262 const path = '/api/v1/videos'
265 .delete(path + '/' + id)
266 .set('Accept', 'application/json')
267 .set('Authorization', 'Bearer ' + token)
268 .expect(expectedStatus)
271 async function checkVideoFilesWereRemoved (
273 serverNumber: number,
281 join('playlists', 'hls'),
282 join('redundancy', 'hls')
285 const testDirectory = 'test' + serverNumber
287 for (const directory of directories) {
288 const directoryPath = join(root(), testDirectory, directory)
290 const directoryExists = existsSync(directoryPath)
291 if (!directoryExists) continue
293 const files = await readdir(directoryPath)
294 for (const file of files) {
295 expect(file).to.not.contain(videoUUID)
300 async function uploadVideo (url: string, accessToken: string, videoAttributesArg: VideoAttributes, specialStatus = 200) {
301 const path = '/api/v1/videos/upload'
302 let defaultChannelId = '1'
305 const res = await getMyUserInformation(url, accessToken)
306 defaultChannelId = res.body.videoChannels[0].id
307 } catch (e) { /* empty */ }
309 // Override default attributes
310 const attributes = Object.assign({
311 name: 'my super video',
315 channelId: defaultChannelId,
317 waitTranscoding: false,
318 description: 'my super description',
319 support: 'my super support text',
321 privacy: VideoPrivacy.PUBLIC,
322 commentsEnabled: true,
323 fixture: 'video_short.webm'
324 }, videoAttributesArg)
326 const req = request(url)
328 .set('Accept', 'application/json')
329 .set('Authorization', 'Bearer ' + accessToken)
330 .field('name', attributes.name)
331 .field('nsfw', JSON.stringify(attributes.nsfw))
332 .field('commentsEnabled', JSON.stringify(attributes.commentsEnabled))
333 .field('waitTranscoding', JSON.stringify(attributes.waitTranscoding))
334 .field('privacy', attributes.privacy.toString())
335 .field('channelId', attributes.channelId)
337 if (attributes.description !== undefined) {
338 req.field('description', attributes.description)
340 if (attributes.language !== undefined) {
341 req.field('language', attributes.language.toString())
343 if (attributes.category !== undefined) {
344 req.field('category', attributes.category.toString())
346 if (attributes.licence !== undefined) {
347 req.field('licence', attributes.licence.toString())
350 for (let i = 0; i < attributes.tags.length; i++) {
351 req.field('tags[' + i + ']', attributes.tags[i])
354 if (attributes.thumbnailfile !== undefined) {
355 req.attach('thumbnailfile', buildAbsoluteFixturePath(attributes.thumbnailfile))
357 if (attributes.previewfile !== undefined) {
358 req.attach('previewfile', buildAbsoluteFixturePath(attributes.previewfile))
361 if (attributes.scheduleUpdate) {
362 req.field('scheduleUpdate[updateAt]', attributes.scheduleUpdate.updateAt)
364 if (attributes.scheduleUpdate.privacy) {
365 req.field('scheduleUpdate[privacy]', attributes.scheduleUpdate.privacy)
369 return req.attach('videofile', buildAbsoluteFixturePath(attributes.fixture))
370 .expect(specialStatus)
373 function updateVideo (url: string, accessToken: string, id: number | string, attributes: VideoAttributes, statusCodeExpected = 204) {
374 const path = '/api/v1/videos/' + id
377 if (attributes.name) body['name'] = attributes.name
378 if (attributes.category) body['category'] = attributes.category
379 if (attributes.licence) body['licence'] = attributes.licence
380 if (attributes.language) body['language'] = attributes.language
381 if (attributes.nsfw !== undefined) body['nsfw'] = JSON.stringify(attributes.nsfw)
382 if (attributes.commentsEnabled !== undefined) body['commentsEnabled'] = JSON.stringify(attributes.commentsEnabled)
383 if (attributes.description) body['description'] = attributes.description
384 if (attributes.tags) body['tags'] = attributes.tags
385 if (attributes.privacy) body['privacy'] = attributes.privacy
386 if (attributes.channelId) body['channelId'] = attributes.channelId
387 if (attributes.scheduleUpdate) body['scheduleUpdate'] = attributes.scheduleUpdate
390 if (attributes.thumbnailfile || attributes.previewfile) {
391 const attaches: any = {}
392 if (attributes.thumbnailfile) attaches.thumbnailfile = attributes.thumbnailfile
393 if (attributes.previewfile) attaches.previewfile = attributes.previewfile
395 return makeUploadRequest({
406 return makePutBodyRequest({
415 function rateVideo (url: string, accessToken: string, id: number, rating: string, specialStatus = 204) {
416 const path = '/api/v1/videos/' + id + '/rate'
420 .set('Accept', 'application/json')
421 .set('Authorization', 'Bearer ' + accessToken)
423 .expect(specialStatus)
426 function parseTorrentVideo (server: ServerInfo, videoUUID: string, resolution: number) {
427 return new Promise<any>((res, rej) => {
428 const torrentName = videoUUID + '-' + resolution + '.torrent'
429 const torrentPath = join(root(), 'test' + server.serverNumber, 'torrents', torrentName)
430 readFile(torrentPath, (err, data) => {
431 if (err) return rej(err)
433 return res(parseTorrent(data))
438 async function completeVideoCheck (
447 commentsEnabled: boolean
472 thumbnailfile?: string
476 if (!attributes.likes) attributes.likes = 0
477 if (!attributes.dislikes) attributes.dislikes = 0
479 expect(video.name).to.equal(attributes.name)
480 expect(video.category.id).to.equal(attributes.category)
481 expect(video.category.label).to.equal(attributes.category !== null ? VIDEO_CATEGORIES[attributes.category] : 'Misc')
482 expect(video.licence.id).to.equal(attributes.licence)
483 expect(video.licence.label).to.equal(attributes.licence !== null ? VIDEO_LICENCES[attributes.licence] : 'Unknown')
484 expect(video.language.id).to.equal(attributes.language)
485 expect(video.language.label).to.equal(attributes.language !== null ? VIDEO_LANGUAGES[attributes.language] : 'Unknown')
486 expect(video.privacy.id).to.deep.equal(attributes.privacy)
487 expect(video.privacy.label).to.deep.equal(VIDEO_PRIVACIES[attributes.privacy])
488 expect(video.nsfw).to.equal(attributes.nsfw)
489 expect(video.description).to.equal(attributes.description)
490 expect(video.account.id).to.be.a('number')
491 expect(video.account.uuid).to.be.a('string')
492 expect(video.account.host).to.equal(attributes.account.host)
493 expect(video.account.name).to.equal(attributes.account.name)
494 expect(video.channel.displayName).to.equal(attributes.channel.displayName)
495 expect(video.channel.name).to.equal(attributes.channel.name)
496 expect(video.likes).to.equal(attributes.likes)
497 expect(video.dislikes).to.equal(attributes.dislikes)
498 expect(video.isLocal).to.equal(attributes.isLocal)
499 expect(video.duration).to.equal(attributes.duration)
500 expect(dateIsValid(video.createdAt)).to.be.true
501 expect(dateIsValid(video.publishedAt)).to.be.true
502 expect(dateIsValid(video.updatedAt)).to.be.true
504 if (attributes.publishedAt) {
505 expect(video.publishedAt).to.equal(attributes.publishedAt)
508 const res = await getVideo(url, video.uuid)
509 const videoDetails: VideoDetails = res.body
511 expect(videoDetails.files).to.have.lengthOf(attributes.files.length)
512 expect(videoDetails.tags).to.deep.equal(attributes.tags)
513 expect(videoDetails.account.name).to.equal(attributes.account.name)
514 expect(videoDetails.account.host).to.equal(attributes.account.host)
515 expect(video.channel.displayName).to.equal(attributes.channel.displayName)
516 expect(video.channel.name).to.equal(attributes.channel.name)
517 expect(videoDetails.channel.host).to.equal(attributes.account.host)
518 expect(videoDetails.channel.isLocal).to.equal(attributes.channel.isLocal)
519 expect(dateIsValid(videoDetails.channel.createdAt.toString())).to.be.true
520 expect(dateIsValid(videoDetails.channel.updatedAt.toString())).to.be.true
521 expect(videoDetails.commentsEnabled).to.equal(attributes.commentsEnabled)
523 for (const attributeFile of attributes.files) {
524 const file = videoDetails.files.find(f => f.resolution.id === attributeFile.resolution)
525 expect(file).not.to.be.undefined
527 let extension = extname(attributes.fixture)
528 // Transcoding enabled on server 2, extension will always be .mp4
529 if (attributes.account.host === 'localhost:9002') extension = '.mp4'
531 const magnetUri = file.magnetUri
532 expect(file.magnetUri).to.have.lengthOf.above(2)
533 expect(file.torrentUrl).to.equal(`http://${attributes.account.host}/static/torrents/${videoDetails.uuid}-${file.resolution.id}.torrent`)
534 expect(file.fileUrl).to.equal(`http://${attributes.account.host}/static/webseed/${videoDetails.uuid}-${file.resolution.id}${extension}`)
535 expect(file.resolution.id).to.equal(attributeFile.resolution)
536 expect(file.resolution.label).to.equal(attributeFile.resolution + 'p')
538 const minSize = attributeFile.size - ((10 * attributeFile.size) / 100)
539 const maxSize = attributeFile.size + ((10 * attributeFile.size) / 100)
541 'File size for resolution ' + file.resolution.label + ' outside confidence interval (' + minSize + '> size <' + maxSize + ')')
542 .to.be.above(minSize).and.below(maxSize)
545 await testImage(url, attributes.thumbnailfile || attributes.fixture, videoDetails.thumbnailPath)
548 if (attributes.previewfile) {
549 await testImage(url, attributes.previewfile, videoDetails.previewPath)
552 const torrent = await webtorrentAdd(magnetUri, true)
553 expect(torrent.files).to.be.an('array')
554 expect(torrent.files.length).to.equal(1)
555 expect(torrent.files[0].path).to.exist.and.to.not.equal('')
559 // ---------------------------------------------------------------------------
569 getVideoChannelVideos,
573 getVideosListPagination,
576 getVideosListWithToken,
578 getVideosWithFilters,
585 checkVideoFilesWereRemoved