1 /* tslint:disable:no-unused-expression */
3 import { expect } from 'chai'
4 import { readFile } from 'fs'
5 import * as parseTorrent from 'parse-torrent'
6 import { extname, isAbsolute, join } from 'path'
7 import * as request from 'supertest'
8 import { getMyUserInformation, makeGetRequest, readFilePromise, ServerInfo } from '../'
9 import { VideoPrivacy } from '../../../../shared/models/videos'
10 import { VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../initializers'
11 import { dateIsValid, webtorrentAdd } from '../index'
13 type VideoAttributes = {
19 commentsEnabled?: boolean
23 privacy?: VideoPrivacy
27 function getVideoCategories (url: string) {
28 const path = '/api/v1/videos/categories'
30 return makeGetRequest({
33 statusCodeExpected: 200
37 function getVideoLicences (url: string) {
38 const path = '/api/v1/videos/licences'
40 return makeGetRequest({
43 statusCodeExpected: 200
47 function getVideoLanguages (url: string) {
48 const path = '/api/v1/videos/languages'
50 return makeGetRequest({
53 statusCodeExpected: 200
57 function getVideoPrivacies (url: string) {
58 const path = '/api/v1/videos/privacies'
60 return makeGetRequest({
63 statusCodeExpected: 200
67 function getVideo (url: string, id: number | string, expectedStatus = 200) {
68 const path = '/api/v1/videos/' + id
72 .set('Accept', 'application/json')
73 .expect(expectedStatus)
76 function viewVideo (url: string, id: number | string, expectedStatus = 204) {
77 const path = '/api/v1/videos/' + id + '/views'
81 .set('Accept', 'application/json')
82 .expect(expectedStatus)
85 function getVideoWithToken (url: string, token: string, id: number | string, expectedStatus = 200) {
86 const path = '/api/v1/videos/' + id
90 .set('Authorization', 'Bearer ' + token)
91 .set('Accept', 'application/json')
92 .expect(expectedStatus)
95 function getVideoDescription (url: string, descriptionPath: string) {
98 .set('Accept', 'application/json')
100 .expect('Content-Type', /json/)
103 function getVideosList (url: string) {
104 const path = '/api/v1/videos'
108 .query({ sort: 'name' })
109 .set('Accept', 'application/json')
111 .expect('Content-Type', /json/)
114 function getMyVideos (url: string, accessToken: string, start: number, count: number, sort?: string) {
115 const path = '/api/v1/users/me/videos'
117 const req = request(url)
119 .query({ start: start })
120 .query({ count: count })
122 if (sort) req.query({ sort })
124 return req.set('Accept', 'application/json')
125 .set('Authorization', 'Bearer ' + accessToken)
127 .expect('Content-Type', /json/)
130 function getVideosListPagination (url: string, start: number, count: number, sort?: string) {
131 const path = '/api/v1/videos'
133 const req = request(url)
135 .query({ start: start })
136 .query({ count: count })
138 if (sort) req.query({ sort })
140 return req.set('Accept', 'application/json')
142 .expect('Content-Type', /json/)
145 function getVideosListSort (url: string, sort: string) {
146 const path = '/api/v1/videos'
150 .query({ sort: sort })
151 .set('Accept', 'application/json')
153 .expect('Content-Type', /json/)
156 function removeVideo (url: string, token: string, id: number | string, expectedStatus = 204) {
157 const path = '/api/v1/videos'
160 .delete(path + '/' + id)
161 .set('Accept', 'application/json')
162 .set('Authorization', 'Bearer ' + token)
163 .expect(expectedStatus)
166 function searchVideo (url: string, search: string) {
167 const path = '/api/v1/videos'
168 const req = request(url)
169 .get(path + '/search')
171 .set('Accept', 'application/json')
173 return req.expect(200)
174 .expect('Content-Type', /json/)
177 function searchVideoWithPagination (url: string, search: string, start: number, count: number, sort?: string) {
178 const path = '/api/v1/videos'
180 const req = request(url)
181 .get(path + '/search')
186 if (sort) req.query({ sort })
188 return req.set('Accept', 'application/json')
190 .expect('Content-Type', /json/)
193 function searchVideoWithSort (url: string, search: string, sort: string) {
194 const path = '/api/v1/videos'
197 .get(path + '/search')
200 .set('Accept', 'application/json')
202 .expect('Content-Type', /json/)
205 async function testVideoImage (url: string, imageName: string, imagePath: string, extension = '.jpg') {
206 // Don't test images if the node env is not set
207 // Because we need a special ffmpeg version for this test
208 if (process.env['NODE_TEST_IMAGE']) {
209 const res = await request(url)
213 const data = await readFilePromise(join(__dirname, '..', '..', 'api', 'fixtures', imageName + extension))
215 return data.equals(res.body)
217 console.log('Do not test images. Enable it by setting NODE_TEST_IMAGE env variable.')
222 async function uploadVideo (url: string, accessToken: string, videoAttributesArg: VideoAttributes, specialStatus = 200) {
223 const path = '/api/v1/videos/upload'
224 let defaultChannelId = '1'
227 const res = await getMyUserInformation(url, accessToken)
228 defaultChannelId = res.body.videoChannels[0].id
229 } catch (e) { /* empty */ }
231 // Default attributes
233 name: 'my super video',
237 channelId: defaultChannelId,
239 description: 'my super description',
241 privacy: VideoPrivacy.PUBLIC,
242 commentsEnabled: true,
243 fixture: 'video_short.webm'
245 attributes = Object.assign(attributes, videoAttributesArg)
247 const req = request(url)
249 .set('Accept', 'application/json')
250 .set('Authorization', 'Bearer ' + accessToken)
251 .field('name', attributes.name)
252 .field('category', attributes.category.toString())
253 .field('licence', attributes.licence.toString())
254 .field('nsfw', JSON.stringify(attributes.nsfw))
255 .field('commentsEnabled', JSON.stringify(attributes.commentsEnabled))
256 .field('description', attributes.description)
257 .field('privacy', attributes.privacy.toString())
258 .field('channelId', attributes.channelId)
260 if (attributes.language !== undefined) {
261 req.field('language', attributes.language.toString())
264 for (let i = 0; i < attributes.tags.length; i++) {
265 req.field('tags[' + i + ']', attributes.tags[i])
269 if (isAbsolute(attributes.fixture)) {
270 filePath = attributes.fixture
272 filePath = join(__dirname, '..', '..', 'api', 'fixtures', attributes.fixture)
275 return req.attach('videofile', filePath)
276 .expect(specialStatus)
279 function updateVideo (url: string, accessToken: string, id: number | string, attributes: VideoAttributes, specialStatus = 204) {
280 const path = '/api/v1/videos/' + id
283 if (attributes.name) body['name'] = attributes.name
284 if (attributes.category) body['category'] = attributes.category
285 if (attributes.licence) body['licence'] = attributes.licence
286 if (attributes.language) body['language'] = attributes.language
287 if (attributes.nsfw !== undefined) body['nsfw'] = JSON.stringify(attributes.nsfw)
288 if (attributes.commentsEnabled !== undefined) body['commentsEnabled'] = JSON.stringify(attributes.commentsEnabled)
289 if (attributes.description) body['description'] = attributes.description
290 if (attributes.tags) body['tags'] = attributes.tags
291 if (attributes.privacy) body['privacy'] = attributes.privacy
296 .set('Accept', 'application/json')
297 .set('Authorization', 'Bearer ' + accessToken)
298 .expect(specialStatus)
301 function rateVideo (url: string, accessToken: string, id: number, rating: string, specialStatus = 204) {
302 const path = '/api/v1/videos/' + id + '/rate'
306 .set('Accept', 'application/json')
307 .set('Authorization', 'Bearer ' + accessToken)
309 .expect(specialStatus)
312 function parseTorrentVideo (server: ServerInfo, videoUUID: string, resolution: number) {
313 return new Promise<any>((res, rej) => {
314 const torrentName = videoUUID + '-' + resolution + '.torrent'
315 const torrentPath = join(__dirname, '..', '..', '..', '..', 'test' + server.serverNumber, 'torrents', torrentName)
316 readFile(torrentPath, (err, data) => {
317 if (err) return rej(err)
319 return res(parseTorrent(data))
324 async function completeVideoCheck (
333 commentsEnabled: boolean
355 if (!attributes.likes) attributes.likes = 0
356 if (!attributes.dislikes) attributes.dislikes = 0
358 expect(video.name).to.equal(attributes.name)
359 expect(video.category).to.equal(attributes.category)
360 expect(video.categoryLabel).to.equal(VIDEO_CATEGORIES[attributes.category] || 'Misc')
361 expect(video.licence).to.equal(attributes.licence)
362 expect(video.licenceLabel).to.equal(VIDEO_LICENCES[attributes.licence] || 'Unknown')
363 expect(video.language).to.equal(attributes.language)
364 expect(video.languageLabel).to.equal(VIDEO_LANGUAGES[attributes.language] || 'Unknown')
365 expect(video.nsfw).to.equal(attributes.nsfw)
366 expect(video.description).to.equal(attributes.description)
367 expect(video.serverHost).to.equal(attributes.host)
368 expect(video.accountName).to.equal(attributes.account)
369 expect(video.likes).to.equal(attributes.likes)
370 expect(video.dislikes).to.equal(attributes.dislikes)
371 expect(video.isLocal).to.equal(attributes.isLocal)
372 expect(video.duration).to.equal(attributes.duration)
373 expect(dateIsValid(video.createdAt)).to.be.true
374 expect(dateIsValid(video.updatedAt)).to.be.true
376 const res = await getVideo(url, video.id)
377 const videoDetails = res.body
379 expect(videoDetails.files).to.have.lengthOf(attributes.files.length)
380 expect(videoDetails.tags).to.deep.equal(attributes.tags)
381 expect(videoDetails.privacy).to.deep.equal(attributes.privacy)
382 expect(videoDetails.privacyLabel).to.deep.equal(VIDEO_PRIVACIES[attributes.privacy])
383 expect(videoDetails.account.name).to.equal(attributes.account)
384 expect(videoDetails.commentsEnabled).to.equal(attributes.commentsEnabled)
386 expect(videoDetails.channel.name).to.equal(attributes.channel.name)
387 expect(videoDetails.channel.isLocal).to.equal(attributes.channel.isLocal)
388 expect(dateIsValid(videoDetails.channel.createdAt)).to.be.true
389 expect(dateIsValid(videoDetails.channel.updatedAt)).to.be.true
391 for (const attributeFile of attributes.files) {
392 const file = videoDetails.files.find(f => f.resolution === attributeFile.resolution)
393 expect(file).not.to.be.undefined
395 let extension = extname(attributes.fixture)
396 // Transcoding enabled on server 2, extension will always be .mp4
397 if (attributes.host === 'localhost:9002') extension = '.mp4'
399 const magnetUri = file.magnetUri
400 expect(file.magnetUri).to.have.lengthOf.above(2)
401 expect(file.torrentUrl).to.equal(`http://${attributes.host}/static/torrents/${videoDetails.uuid}-${file.resolution}.torrent`)
402 expect(file.fileUrl).to.equal(`http://${attributes.host}/static/webseed/${videoDetails.uuid}-${file.resolution}${extension}`)
403 expect(file.resolution).to.equal(attributeFile.resolution)
404 expect(file.resolutionLabel).to.equal(attributeFile.resolution + 'p')
406 const minSize = attributeFile.size - ((10 * attributeFile.size) / 100)
407 const maxSize = attributeFile.size + ((10 * attributeFile.size) / 100)
408 expect(file.size).to.be.above(minSize).and.below(maxSize)
410 const test = await testVideoImage(url, attributes.fixture, videoDetails.thumbnailPath)
411 expect(test).to.equal(true)
413 const torrent = await webtorrentAdd(magnetUri, true)
414 expect(torrent.files).to.be.an('array')
415 expect(torrent.files.length).to.equal(1)
416 expect(torrent.files[0].path).to.exist.and.to.not.equal('')
420 // ---------------------------------------------------------------------------
432 getVideosListPagination,
436 searchVideoWithPagination,