PeerTube/server/tests/plugins/plugin-helpers.ts

389 lines
11 KiB
TypeScript
Raw Normal View History

2020-04-09 11:00:30 +02:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
2021-07-07 10:33:49 +02:00
import { expect } from 'chai'
2021-12-16 16:49:43 +01:00
import { pathExists } from 'fs-extra'
import { HttpStatusCode, ThumbnailType } from '@shared/models'
import {
2021-07-07 10:33:49 +02:00
cleanupTests,
2021-07-16 09:47:51 +02:00
createMultipleServers,
2021-07-16 14:27:30 +02:00
doubleFollow,
2021-07-07 10:33:49 +02:00
makeGetRequest,
2020-05-07 14:58:24 +02:00
makePostBodyRequest,
2021-12-16 16:49:43 +01:00
makeRawRequest,
2021-07-16 09:47:51 +02:00
PeerTubeServer,
2021-07-16 14:27:30 +02:00
PluginsCommand,
setAccessTokensToServers,
2021-07-13 09:43:59 +02:00
waitJobs
} from '@shared/server-commands'
import { checkVideoFilesWereRemoved } from '../shared'
2020-05-07 14:58:24 +02:00
2021-07-16 09:47:51 +02:00
function postCommand (server: PeerTubeServer, command: string, bodyArg?: object) {
2020-05-07 14:58:24 +02:00
const body = { command }
if (bodyArg) Object.assign(body, bodyArg)
return makePostBodyRequest({
url: server.url,
path: '/plugins/test-four/router/commander',
fields: body,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.NO_CONTENT_204
2020-05-07 14:58:24 +02:00
})
}
2020-04-09 11:00:30 +02:00
describe('Test plugin helpers', function () {
2021-07-16 09:47:51 +02:00
let servers: PeerTubeServer[]
2020-04-09 11:00:30 +02:00
before(async function () {
2020-05-07 14:58:24 +02:00
this.timeout(60000)
2021-07-16 09:47:51 +02:00
servers = await createMultipleServers(2)
2020-05-07 14:58:24 +02:00
await setAccessTokensToServers(servers)
2020-04-09 11:00:30 +02:00
2020-05-07 14:58:24 +02:00
await doubleFollow(servers[0], servers[1])
2020-04-09 11:00:30 +02:00
2021-07-16 09:04:35 +02:00
await servers[0].plugins.install({ path: PluginsCommand.getPluginTestPath('-four') })
2020-04-09 11:00:30 +02:00
})
2020-05-07 14:58:24 +02:00
describe('Logger', function () {
it('Should have logged things', async function () {
2022-12-09 11:14:47 +01:00
await servers[0].servers.waitUntilLog(servers[0].host + ' peertube-plugin-test-four', 1, false)
2021-07-16 09:04:35 +02:00
await servers[0].servers.waitUntilLog('Hello world from plugin four', 1)
2020-05-07 14:58:24 +02:00
})
2020-04-09 11:00:30 +02:00
})
2020-05-07 14:58:24 +02:00
describe('Database', function () {
it('Should have made a query', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].servers.waitUntilLog(`root email is admin${servers[0].internalServerNumber}@example.com`)
2020-05-07 14:58:24 +02:00
})
})
describe('Config', function () {
it('Should have the correct webserver url', async function () {
2022-12-09 11:14:47 +01:00
await servers[0].servers.waitUntilLog(`server url is ${servers[0].url}`)
2020-05-07 14:58:24 +02:00
})
2021-04-09 14:51:28 +02:00
it('Should have the correct listening config', async function () {
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/server-listening-config',
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.config).to.exist
expect(res.body.config.hostname).to.equal('::')
expect(res.body.config.port).to.equal(servers[0].port)
})
2021-04-09 14:51:28 +02:00
it('Should have the correct config', async function () {
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/server-config',
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.OK_200
2021-04-09 14:51:28 +02:00
})
expect(res.body.serverConfig).to.exist
expect(res.body.serverConfig.instance.name).to.equal('PeerTube')
})
2020-05-07 14:58:24 +02:00
})
describe('Server', function () {
it('Should get the server actor', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].servers.waitUntilLog('server actor name is peertube')
2020-05-07 14:58:24 +02:00
})
})
describe('Socket', function () {
it('Should sendNotification without any exceptions', async () => {
const user = await servers[0].users.create({ username: 'notis_redding', password: 'secret1234?' })
await makePostBodyRequest({
url: servers[0].url,
path: '/plugins/test-four/router/send-notification',
fields: {
userId: user.id
},
expectedStatus: HttpStatusCode.CREATED_201
})
})
it('Should sendVideoLiveNewState without any exceptions', async () => {
const res = await servers[0].videos.quickUpload({ name: 'video server 1' })
await makePostBodyRequest({
url: servers[0].url,
path: '/plugins/test-four/router/send-video-live-new-state/' + res.uuid,
expectedStatus: HttpStatusCode.CREATED_201
})
await servers[0].videos.remove({ id: res.uuid })
})
})
2021-04-09 14:51:28 +02:00
describe('Plugin', function () {
it('Should get the base static route', async function () {
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/static-route',
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.OK_200
2021-04-09 14:51:28 +02:00
})
expect(res.body.staticRoute).to.equal('/plugins/test-four/0.0.1/static/')
})
it('Should get the base static route', async function () {
const baseRouter = '/plugins/test-four/0.0.1/router/'
const res = await makeGetRequest({
url: servers[0].url,
path: baseRouter + 'router-route',
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.routerRoute).to.equal(baseRouter)
})
})
describe('User', function () {
2022-08-02 15:29:00 +02:00
let rootId: number
it('Should not get a user if not authenticated', async function () {
2021-04-22 15:16:35 +02:00
await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/user',
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.NOT_FOUND_404
})
})
it('Should get a user if authenticated', async function () {
const res = await makeGetRequest({
url: servers[0].url,
token: servers[0].accessToken,
path: '/plugins/test-four/router/user',
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.username).to.equal('root')
expect(res.body.displayName).to.equal('root')
expect(res.body.isAdmin).to.be.true
expect(res.body.isModerator).to.be.false
expect(res.body.isUser).to.be.false
2022-08-02 15:29:00 +02:00
rootId = res.body.id
})
it('Should load a user by id', async function () {
{
const res = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/user/' + rootId,
expectedStatus: HttpStatusCode.OK_200
})
expect(res.body.username).to.equal('root')
}
{
await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/user/42',
expectedStatus: HttpStatusCode.NOT_FOUND_404
})
}
})
2021-04-09 14:51:28 +02:00
})
2020-05-07 14:58:24 +02:00
describe('Moderation', function () {
let videoUUIDServer1: string
before(async function () {
this.timeout(60000)
2020-05-07 14:58:24 +02:00
{
2021-07-16 10:42:24 +02:00
const res = await servers[0].videos.quickUpload({ name: 'video server 1' })
2020-05-07 14:58:24 +02:00
videoUUIDServer1 = res.uuid
}
{
2021-07-16 10:42:24 +02:00
await servers[1].videos.quickUpload({ name: 'video server 2' })
2020-05-07 14:58:24 +02:00
}
await waitJobs(servers)
2021-07-16 09:04:35 +02:00
const { data } = await servers[0].videos.list()
2020-05-07 14:58:24 +02:00
2021-07-15 10:02:54 +02:00
expect(data).to.have.lengthOf(2)
2020-05-07 14:58:24 +02:00
})
it('Should mute server 2', async function () {
this.timeout(10000)
2022-12-09 11:14:47 +01:00
await postCommand(servers[0], 'blockServer', { hostToBlock: servers[1].host })
2020-05-07 14:58:24 +02:00
2021-07-16 09:04:35 +02:00
const { data } = await servers[0].videos.list()
2020-05-07 14:58:24 +02:00
2021-07-15 10:02:54 +02:00
expect(data).to.have.lengthOf(1)
expect(data[0].name).to.equal('video server 1')
2020-05-07 14:58:24 +02:00
})
it('Should unmute server 2', async function () {
2022-12-09 11:14:47 +01:00
await postCommand(servers[0], 'unblockServer', { hostToUnblock: servers[1].host })
2020-05-07 14:58:24 +02:00
2021-07-16 09:04:35 +02:00
const { data } = await servers[0].videos.list()
2020-05-07 14:58:24 +02:00
2021-07-15 10:02:54 +02:00
expect(data).to.have.lengthOf(2)
2020-05-07 14:58:24 +02:00
})
it('Should mute account of server 2', async function () {
2022-12-09 11:14:47 +01:00
await postCommand(servers[0], 'blockAccount', { handleToBlock: `root@${servers[1].host}` })
2020-05-07 14:58:24 +02:00
2021-07-16 09:04:35 +02:00
const { data } = await servers[0].videos.list()
2020-05-07 14:58:24 +02:00
2021-07-15 10:02:54 +02:00
expect(data).to.have.lengthOf(1)
expect(data[0].name).to.equal('video server 1')
2020-05-07 14:58:24 +02:00
})
it('Should unmute account of server 2', async function () {
2022-12-09 11:14:47 +01:00
await postCommand(servers[0], 'unblockAccount', { handleToUnblock: `root@${servers[1].host}` })
2020-05-07 14:58:24 +02:00
2021-07-16 09:04:35 +02:00
const { data } = await servers[0].videos.list()
2020-05-07 14:58:24 +02:00
2021-07-15 10:02:54 +02:00
expect(data).to.have.lengthOf(2)
2020-05-07 14:58:24 +02:00
})
it('Should blacklist video', async function () {
this.timeout(10000)
await postCommand(servers[0], 'blacklist', { videoUUID: videoUUIDServer1, unfederate: true })
await waitJobs(servers)
for (const server of servers) {
2021-07-16 09:04:35 +02:00
const { data } = await server.videos.list()
2020-05-07 14:58:24 +02:00
2021-07-15 10:02:54 +02:00
expect(data).to.have.lengthOf(1)
expect(data[0].name).to.equal('video server 2')
2020-05-07 14:58:24 +02:00
}
})
it('Should unblacklist video', async function () {
this.timeout(10000)
await postCommand(servers[0], 'unblacklist', { videoUUID: videoUUIDServer1 })
await waitJobs(servers)
for (const server of servers) {
2021-07-16 09:04:35 +02:00
const { data } = await server.videos.list()
2020-05-07 14:58:24 +02:00
2021-07-15 10:02:54 +02:00
expect(data).to.have.lengthOf(2)
2020-05-07 14:58:24 +02:00
}
})
2020-04-09 11:00:30 +02:00
})
2020-05-07 14:58:24 +02:00
describe('Videos', function () {
let videoUUID: string
2021-12-16 17:00:46 +01:00
let videoPath: string
2020-05-07 14:58:24 +02:00
before(async () => {
2021-12-16 16:49:43 +01:00
this.timeout(240000)
await servers[0].config.enableTranscoding()
2021-07-16 10:42:24 +02:00
const res = await servers[0].videos.quickUpload({ name: 'video1' })
2020-05-07 14:58:24 +02:00
videoUUID = res.uuid
2021-12-16 16:49:43 +01:00
await waitJobs(servers)
})
it('Should get video files', async function () {
const { body } = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/video-files/' + videoUUID,
expectedStatus: HttpStatusCode.OK_200
})
// Video files check
{
expect(body.webtorrent.videoFiles).to.be.an('array')
expect(body.hls.videoFiles).to.be.an('array')
for (const resolution of [ 144, 240, 360, 480, 720 ]) {
for (const files of [ body.webtorrent.videoFiles, body.hls.videoFiles ]) {
const file = files.find(f => f.resolution === resolution)
expect(file).to.exist
expect(file.size).to.be.a('number')
expect(file.fps).to.equal(25)
expect(await pathExists(file.path)).to.be.true
await makeRawRequest({ url: file.url, expectedStatus: HttpStatusCode.OK_200 })
2021-12-16 16:49:43 +01:00
}
}
2021-12-16 17:00:46 +01:00
videoPath = body.webtorrent.videoFiles[0].path
2021-12-16 16:49:43 +01:00
}
// Thumbnails check
{
expect(body.thumbnails).to.be.an('array')
const miniature = body.thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
expect(miniature).to.exist
expect(await pathExists(miniature.path)).to.be.true
await makeRawRequest({ url: miniature.url, expectedStatus: HttpStatusCode.OK_200 })
2021-12-16 16:49:43 +01:00
const preview = body.thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
expect(preview).to.exist
expect(await pathExists(preview.path)).to.be.true
await makeRawRequest({ url: preview.url, expectedStatus: HttpStatusCode.OK_200 })
2021-12-16 16:49:43 +01:00
}
2020-05-07 14:58:24 +02:00
})
2021-12-16 17:00:46 +01:00
it('Should probe a file', async function () {
const { body } = await makeGetRequest({
url: servers[0].url,
path: '/plugins/test-four/router/ffprobe',
query: {
path: videoPath
},
expectedStatus: HttpStatusCode.OK_200
})
expect(body.streams).to.be.an('array')
expect(body.streams).to.have.lengthOf(2)
})
2020-05-07 14:58:24 +02:00
it('Should remove a video after a view', async function () {
2020-12-11 10:36:05 +01:00
this.timeout(40000)
2020-05-07 14:58:24 +02:00
// Should not throw -> video exists
2021-07-22 14:28:03 +02:00
const video = await servers[0].videos.get({ id: videoUUID })
2020-05-07 14:58:24 +02:00
// Should delete the video
await servers[0].views.simulateView({ id: videoUUID })
2021-07-16 09:04:35 +02:00
await servers[0].servers.waitUntilLog('Video deleted by plugin four.')
2020-05-07 14:58:24 +02:00
try {
// Should throw because the video should have been deleted
2021-07-16 09:04:35 +02:00
await servers[0].videos.get({ id: videoUUID })
2020-05-07 14:58:24 +02:00
throw new Error('Video exists')
} catch (err) {
if (err.message.includes('exists')) throw err
}
2021-07-22 14:28:03 +02:00
await checkVideoFilesWereRemoved({ server: servers[0], video })
2020-05-07 14:58:24 +02:00
})
it('Should have fetched the video by URL', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].servers.waitUntilLog(`video from DB uuid is ${videoUUID}`)
2020-05-07 14:58:24 +02:00
})
})
2020-04-09 11:00:30 +02:00
after(async function () {
2020-05-07 14:58:24 +02:00
await cleanupTests(servers)
2020-04-09 11:00:30 +02:00
})
})