1 /* tslint:disable:no-unused-expression */
3 import { expect } from 'chai'
4 import { existsSync, readFile } from 'fs'
5 import * as parseTorrent from 'parse-torrent'
6 import { extname, join } from 'path'
7 import * as request from 'supertest'
9 buildAbsoluteFixturePath,
18 import { VideoDetails, VideoPrivacy } from '../../../../shared/models/videos'
19 import { readdirPromise } from '../../../helpers/core-utils'
20 import { VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../initializers'
21 import { dateIsValid, webtorrentAdd } from '../index'
23 type VideoAttributes = {
29 commentsEnabled?: boolean
30 waitTranscoding?: boolean
34 privacy?: VideoPrivacy
36 thumbnailfile?: string
40 privacy?: VideoPrivacy
44 function getVideoCategories (url: string) {
45 const path = '/api/v1/videos/categories'
47 return makeGetRequest({
50 statusCodeExpected: 200
54 function getVideoLicences (url: string) {
55 const path = '/api/v1/videos/licences'
57 return makeGetRequest({
60 statusCodeExpected: 200
64 function getVideoLanguages (url: string) {
65 const path = '/api/v1/videos/languages'
67 return makeGetRequest({
70 statusCodeExpected: 200
74 function getVideoPrivacies (url: string) {
75 const path = '/api/v1/videos/privacies'
77 return makeGetRequest({
80 statusCodeExpected: 200
84 function getVideo (url: string, id: number | string, expectedStatus = 200) {
85 const path = '/api/v1/videos/' + id
89 .set('Accept', 'application/json')
90 .expect(expectedStatus)
93 function viewVideo (url: string, id: number | string, expectedStatus = 204, xForwardedFor?: string) {
94 const path = '/api/v1/videos/' + id + '/views'
96 const req = request(url)
98 .set('Accept', 'application/json')
101 req.set('X-Forwarded-For', xForwardedFor)
104 return req.expect(expectedStatus)
107 function getVideoWithToken (url: string, token: string, id: number | string, expectedStatus = 200) {
108 const path = '/api/v1/videos/' + id
112 .set('Authorization', 'Bearer ' + token)
113 .set('Accept', 'application/json')
114 .expect(expectedStatus)
117 function getVideoDescription (url: string, descriptionPath: string) {
119 .get(descriptionPath)
120 .set('Accept', 'application/json')
122 .expect('Content-Type', /json/)
125 function getVideosList (url: string) {
126 const path = '/api/v1/videos'
130 .query({ sort: 'name' })
131 .set('Accept', 'application/json')
133 .expect('Content-Type', /json/)
136 function getVideosListWithToken (url: string, token: string) {
137 const path = '/api/v1/videos'
141 .set('Authorization', 'Bearer ' + token)
142 .query({ sort: 'name' })
143 .set('Accept', 'application/json')
145 .expect('Content-Type', /json/)
148 function getLocalVideos (url: string) {
149 const path = '/api/v1/videos'
153 .query({ sort: 'name', filter: 'local' })
154 .set('Accept', 'application/json')
156 .expect('Content-Type', /json/)
159 function getMyVideos (url: string, accessToken: string, start: number, count: number, sort?: string) {
160 const path = '/api/v1/users/me/videos'
162 const req = request(url)
164 .query({ start: start })
165 .query({ count: count })
167 if (sort) req.query({ sort })
169 return req.set('Accept', 'application/json')
170 .set('Authorization', 'Bearer ' + accessToken)
172 .expect('Content-Type', /json/)
175 function getAccountVideos (url: string, accessToken: string, accountName: string, start: number, count: number, sort?: string) {
176 const path = '/api/v1/accounts/' + accountName + '/videos'
178 return makeGetRequest({
187 statusCodeExpected: 200
191 function getVideoChannelVideos (
194 videoChannelId: number | string,
199 const path = '/api/v1/video-channels/' + videoChannelId + '/videos'
201 return makeGetRequest({
210 statusCodeExpected: 200
214 function getVideosListPagination (url: string, start: number, count: number, sort?: string) {
215 const path = '/api/v1/videos'
217 const req = request(url)
219 .query({ start: start })
220 .query({ count: count })
222 if (sort) req.query({ sort })
224 return req.set('Accept', 'application/json')
226 .expect('Content-Type', /json/)
229 function getVideosListSort (url: string, sort: string) {
230 const path = '/api/v1/videos'
234 .query({ sort: sort })
235 .set('Accept', 'application/json')
237 .expect('Content-Type', /json/)
240 function removeVideo (url: string, token: string, id: number | string, expectedStatus = 204) {
241 const path = '/api/v1/videos'
244 .delete(path + '/' + id)
245 .set('Accept', 'application/json')
246 .set('Authorization', 'Bearer ' + token)
247 .expect(expectedStatus)
250 function searchVideo (url: string, search: string) {
251 const path = '/api/v1/videos'
252 const req = request(url)
253 .get(path + '/search')
255 .set('Accept', 'application/json')
257 return req.expect(200)
258 .expect('Content-Type', /json/)
261 function searchVideoWithToken (url: string, search: string, token: string) {
262 const path = '/api/v1/videos'
263 const req = request(url)
264 .get(path + '/search')
265 .set('Authorization', 'Bearer ' + token)
267 .set('Accept', 'application/json')
269 return req.expect(200)
270 .expect('Content-Type', /json/)
273 function searchVideoWithPagination (url: string, search: string, start: number, count: number, sort?: string) {
274 const path = '/api/v1/videos'
276 const req = request(url)
277 .get(path + '/search')
282 if (sort) req.query({ sort })
284 return req.set('Accept', 'application/json')
286 .expect('Content-Type', /json/)
289 function searchVideoWithSort (url: string, search: string, sort: string) {
290 const path = '/api/v1/videos'
293 .get(path + '/search')
296 .set('Accept', 'application/json')
298 .expect('Content-Type', /json/)
301 async function checkVideoFilesWereRemoved (videoUUID: string, serverNumber: number) {
302 const testDirectory = 'test' + serverNumber
304 for (const directory of [ 'videos', 'thumbnails', 'torrents', 'previews', 'captions' ]) {
305 const directoryPath = join(root(), testDirectory, directory)
307 const directoryExists = existsSync(directoryPath)
308 expect(directoryExists).to.be.true
310 const files = await readdirPromise(directoryPath)
311 for (const file of files) {
312 expect(file).to.not.contain(videoUUID)
317 async function uploadVideo (url: string, accessToken: string, videoAttributesArg: VideoAttributes, specialStatus = 200) {
318 const path = '/api/v1/videos/upload'
319 let defaultChannelId = '1'
322 const res = await getMyUserInformation(url, accessToken)
323 defaultChannelId = res.body.videoChannels[0].id
324 } catch (e) { /* empty */ }
326 // Override default attributes
327 const attributes = Object.assign({
328 name: 'my super video',
332 channelId: defaultChannelId,
334 waitTranscoding: false,
335 description: 'my super description',
336 support: 'my super support text',
338 privacy: VideoPrivacy.PUBLIC,
339 commentsEnabled: true,
340 fixture: 'video_short.webm'
341 }, videoAttributesArg)
343 const req = request(url)
345 .set('Accept', 'application/json')
346 .set('Authorization', 'Bearer ' + accessToken)
347 .field('name', attributes.name)
348 .field('nsfw', JSON.stringify(attributes.nsfw))
349 .field('commentsEnabled', JSON.stringify(attributes.commentsEnabled))
350 .field('waitTranscoding', JSON.stringify(attributes.waitTranscoding))
351 .field('privacy', attributes.privacy.toString())
352 .field('channelId', attributes.channelId)
354 if (attributes.description !== undefined) {
355 req.field('description', attributes.description)
357 if (attributes.language !== undefined) {
358 req.field('language', attributes.language.toString())
360 if (attributes.category !== undefined) {
361 req.field('category', attributes.category.toString())
363 if (attributes.licence !== undefined) {
364 req.field('licence', attributes.licence.toString())
367 for (let i = 0; i < attributes.tags.length; i++) {
368 req.field('tags[' + i + ']', attributes.tags[i])
371 if (attributes.thumbnailfile !== undefined) {
372 req.attach('thumbnailfile', buildAbsoluteFixturePath(attributes.thumbnailfile))
374 if (attributes.previewfile !== undefined) {
375 req.attach('previewfile', buildAbsoluteFixturePath(attributes.previewfile))
378 if (attributes.scheduleUpdate) {
379 req.field('scheduleUpdate[updateAt]', attributes.scheduleUpdate.updateAt)
381 if (attributes.scheduleUpdate.privacy) {
382 req.field('scheduleUpdate[privacy]', attributes.scheduleUpdate.privacy)
386 return req.attach('videofile', buildAbsoluteFixturePath(attributes.fixture))
387 .expect(specialStatus)
390 function updateVideo (url: string, accessToken: string, id: number | string, attributes: VideoAttributes, statusCodeExpected = 204) {
391 const path = '/api/v1/videos/' + id
394 if (attributes.name) body['name'] = attributes.name
395 if (attributes.category) body['category'] = attributes.category
396 if (attributes.licence) body['licence'] = attributes.licence
397 if (attributes.language) body['language'] = attributes.language
398 if (attributes.nsfw !== undefined) body['nsfw'] = JSON.stringify(attributes.nsfw)
399 if (attributes.commentsEnabled !== undefined) body['commentsEnabled'] = JSON.stringify(attributes.commentsEnabled)
400 if (attributes.description) body['description'] = attributes.description
401 if (attributes.tags) body['tags'] = attributes.tags
402 if (attributes.privacy) body['privacy'] = attributes.privacy
403 if (attributes.channelId) body['channelId'] = attributes.channelId
404 if (attributes.scheduleUpdate) body['scheduleUpdate'] = attributes.scheduleUpdate
407 if (attributes.thumbnailfile || attributes.previewfile) {
408 const attaches: any = {}
409 if (attributes.thumbnailfile) attaches.thumbnailfile = attributes.thumbnailfile
410 if (attributes.previewfile) attaches.previewfile = attributes.previewfile
412 return makeUploadRequest({
423 return makePutBodyRequest({
432 function rateVideo (url: string, accessToken: string, id: number, rating: string, specialStatus = 204) {
433 const path = '/api/v1/videos/' + id + '/rate'
437 .set('Accept', 'application/json')
438 .set('Authorization', 'Bearer ' + accessToken)
440 .expect(specialStatus)
443 function parseTorrentVideo (server: ServerInfo, videoUUID: string, resolution: number) {
444 return new Promise<any>((res, rej) => {
445 const torrentName = videoUUID + '-' + resolution + '.torrent'
446 const torrentPath = join(__dirname, '..', '..', '..', '..', 'test' + server.serverNumber, 'torrents', torrentName)
447 readFile(torrentPath, (err, data) => {
448 if (err) return rej(err)
450 return res(parseTorrent(data))
455 async function completeVideoCheck (
464 commentsEnabled: boolean
488 thumbnailfile?: string
492 if (!attributes.likes) attributes.likes = 0
493 if (!attributes.dislikes) attributes.dislikes = 0
495 expect(video.name).to.equal(attributes.name)
496 expect(video.category.id).to.equal(attributes.category)
497 expect(video.category.label).to.equal(attributes.category !== null ? VIDEO_CATEGORIES[attributes.category] : 'Misc')
498 expect(video.licence.id).to.equal(attributes.licence)
499 expect(video.licence.label).to.equal(attributes.licence !== null ? VIDEO_LICENCES[attributes.licence] : 'Unknown')
500 expect(video.language.id).to.equal(attributes.language)
501 expect(video.language.label).to.equal(attributes.language !== null ? VIDEO_LANGUAGES[attributes.language] : 'Unknown')
502 expect(video.privacy.id).to.deep.equal(attributes.privacy)
503 expect(video.privacy.label).to.deep.equal(VIDEO_PRIVACIES[attributes.privacy])
504 expect(video.nsfw).to.equal(attributes.nsfw)
505 expect(video.description).to.equal(attributes.description)
506 expect(video.account.id).to.be.a('number')
507 expect(video.account.uuid).to.be.a('string')
508 expect(video.account.host).to.equal(attributes.account.host)
509 expect(video.account.name).to.equal(attributes.account.name)
510 expect(video.channel.displayName).to.equal(attributes.channel.name)
511 expect(video.channel.name).to.have.lengthOf(36)
512 expect(video.likes).to.equal(attributes.likes)
513 expect(video.dislikes).to.equal(attributes.dislikes)
514 expect(video.isLocal).to.equal(attributes.isLocal)
515 expect(video.duration).to.equal(attributes.duration)
516 expect(dateIsValid(video.createdAt)).to.be.true
517 expect(dateIsValid(video.publishedAt)).to.be.true
518 expect(dateIsValid(video.updatedAt)).to.be.true
520 if (attributes.publishedAt) {
521 expect(video.publishedAt).to.equal(attributes.publishedAt)
524 const res = await getVideo(url, video.uuid)
525 const videoDetails: VideoDetails = res.body
527 expect(videoDetails.files).to.have.lengthOf(attributes.files.length)
528 expect(videoDetails.tags).to.deep.equal(attributes.tags)
529 expect(videoDetails.account.name).to.equal(attributes.account.name)
530 expect(videoDetails.account.host).to.equal(attributes.account.host)
531 expect(videoDetails.channel.displayName).to.equal(attributes.channel.name)
532 expect(videoDetails.channel.name).to.have.lengthOf(36)
533 expect(videoDetails.channel.host).to.equal(attributes.account.host)
534 expect(videoDetails.channel.isLocal).to.equal(attributes.channel.isLocal)
535 expect(dateIsValid(videoDetails.channel.createdAt.toString())).to.be.true
536 expect(dateIsValid(videoDetails.channel.updatedAt.toString())).to.be.true
537 expect(videoDetails.commentsEnabled).to.equal(attributes.commentsEnabled)
539 for (const attributeFile of attributes.files) {
540 const file = videoDetails.files.find(f => f.resolution.id === attributeFile.resolution)
541 expect(file).not.to.be.undefined
543 let extension = extname(attributes.fixture)
544 // Transcoding enabled on server 2, extension will always be .mp4
545 if (attributes.account.host === 'localhost:9002') extension = '.mp4'
547 const magnetUri = file.magnetUri
548 expect(file.magnetUri).to.have.lengthOf.above(2)
549 expect(file.torrentUrl).to.equal(`http://${attributes.account.host}/static/torrents/${videoDetails.uuid}-${file.resolution.id}.torrent`)
550 expect(file.fileUrl).to.equal(`http://${attributes.account.host}/static/webseed/${videoDetails.uuid}-${file.resolution.id}${extension}`)
551 expect(file.resolution.id).to.equal(attributeFile.resolution)
552 expect(file.resolution.label).to.equal(attributeFile.resolution + 'p')
554 const minSize = attributeFile.size - ((10 * attributeFile.size) / 100)
555 const maxSize = attributeFile.size + ((10 * attributeFile.size) / 100)
556 expect(file.size).to.be.above(minSize).and.below(maxSize)
559 await testImage(url, attributes.thumbnailfile || attributes.fixture, videoDetails.thumbnailPath)
562 if (attributes.previewfile) {
563 await testImage(url, attributes.previewfile, videoDetails.previewPath)
566 const torrent = await webtorrentAdd(magnetUri, true)
567 expect(torrent.files).to.be.an('array')
568 expect(torrent.files.length).to.equal(1)
569 expect(torrent.files[0].path).to.exist.and.to.not.equal('')
573 // ---------------------------------------------------------------------------
583 getVideoChannelVideos,
584 searchVideoWithToken,
588 getVideosListPagination,
592 searchVideoWithPagination,
594 getVideosListWithToken,
602 checkVideoFilesWereRemoved