PeerTube/server/tests/plugins/action-hooks.ts

238 lines
7.0 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
2019-07-19 10:37:35 +02:00
import { ServerHookName, VideoPlaylistPrivacy, VideoPrivacy } from '@shared/models'
2019-07-19 17:30:41 +02:00
import {
2021-07-13 14:23:01 +02:00
cleanupTests,
2021-07-16 09:47:51 +02:00
createMultipleServers,
2021-07-13 14:23:01 +02:00
killallServers,
2021-07-16 09:47:51 +02:00
PeerTubeServer,
2021-07-07 10:33:49 +02:00
PluginsCommand,
2019-07-19 17:30:41 +02:00
setAccessTokensToServers,
2021-07-15 10:02:54 +02:00
setDefaultVideoChannel
} from '@shared/server-commands'
2019-07-19 10:37:35 +02:00
2019-07-19 14:36:04 +02:00
describe('Test plugin action hooks', function () {
2021-07-16 09:47:51 +02:00
let servers: PeerTubeServer[]
2019-07-19 17:30:41 +02:00
let videoUUID: string
let threadId: number
2022-08-03 11:33:43 +02:00
function checkHook (hook: ServerHookName, strictCount = true) {
return servers[0].servers.waitUntilLog('Run hook ' + hook, 1, strictCount)
2019-07-19 17:30:41 +02:00
}
2019-07-19 10:37:35 +02:00
before(async function () {
2022-11-03 08:31:27 +01:00
this.timeout(120000)
2019-07-19 10:37:35 +02:00
2021-07-16 09:47:51 +02:00
servers = await createMultipleServers(2)
2019-07-19 17:30:41 +02:00
await setAccessTokensToServers(servers)
2020-11-06 13:59:50 +01:00
await setDefaultVideoChannel(servers)
2019-07-19 17:30:41 +02:00
2021-07-16 09:04:35 +02:00
await servers[0].plugins.install({ path: PluginsCommand.getPluginTestPath() })
2019-07-19 17:30:41 +02:00
2021-07-09 15:37:43 +02:00
await killallServers([ servers[0] ])
2019-07-19 17:30:41 +02:00
2021-07-16 09:47:51 +02:00
await servers[0].run({
2020-11-06 13:59:50 +01:00
live: {
enabled: true
}
})
2019-07-19 10:37:35 +02:00
})
2019-12-06 15:59:12 +01:00
describe('Application hooks', function () {
it('Should run action:application.listening', async function () {
await checkHook('action:application.listening')
})
2019-07-19 17:30:41 +02:00
})
2019-12-06 15:59:12 +01:00
describe('Videos hooks', function () {
2019-12-06 15:59:12 +01:00
it('Should run action:api.video.uploaded', async function () {
2021-07-16 09:04:35 +02:00
const { uuid } = await servers[0].videos.upload({ attributes: { name: 'video' } })
2021-07-15 10:02:54 +02:00
videoUUID = uuid
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
await checkHook('action:api.video.uploaded')
})
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
it('Should run action:api.video.updated', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].videos.update({ id: videoUUID, attributes: { name: 'video updated' } })
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
await checkHook('action:api.video.updated')
})
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
it('Should run action:api.video.viewed', async function () {
await servers[0].views.simulateView({ id: videoUUID })
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
await checkHook('action:api.video.viewed')
})
2022-08-03 11:17:57 +02:00
it('Should run action:api.video.deleted', async function () {
await servers[0].videos.remove({ id: videoUUID })
await checkHook('action:api.video.deleted')
})
after(async function () {
const { uuid } = await servers[0].videos.quickUpload({ name: 'video' })
videoUUID = uuid
})
})
describe('Video channel hooks', function () {
const channelName = 'my_super_channel'
it('Should run action:api.video-channel.created', async function () {
await servers[0].channels.create({ attributes: { name: channelName } })
await checkHook('action:api.video-channel.created')
})
it('Should run action:api.video-channel.updated', async function () {
await servers[0].channels.update({ channelName, attributes: { displayName: 'my display name' } })
await checkHook('action:api.video-channel.updated')
})
it('Should run action:api.video-channel.deleted', async function () {
await servers[0].channels.delete({ channelName })
await checkHook('action:api.video-channel.deleted')
})
2019-07-19 17:30:41 +02:00
})
2020-11-06 13:59:50 +01:00
describe('Live hooks', function () {
it('Should run action:api.live-video.created', async function () {
const attributes = {
name: 'live',
privacy: VideoPrivacy.PUBLIC,
2021-07-16 09:04:35 +02:00
channelId: servers[0].store.channel.id
2020-11-06 13:59:50 +01:00
}
2021-07-16 09:04:35 +02:00
await servers[0].live.create({ fields: attributes })
2020-11-06 13:59:50 +01:00
await checkHook('action:api.live-video.created')
})
})
2019-12-06 15:59:12 +01:00
describe('Comments hooks', function () {
it('Should run action:api.video-thread.created', async function () {
2021-07-16 09:04:35 +02:00
const created = await servers[0].comments.createThread({ videoId: videoUUID, text: 'thread' })
2021-07-09 14:15:11 +02:00
threadId = created.id
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
await checkHook('action:api.video-thread.created')
})
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
it('Should run action:api.video-comment-reply.created', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].comments.addReply({ videoId: videoUUID, toCommentId: threadId, text: 'reply' })
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
await checkHook('action:api.video-comment-reply.created')
})
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
it('Should run action:api.video-comment.deleted', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].comments.delete({ videoId: videoUUID, commentId: threadId })
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
await checkHook('action:api.video-comment.deleted')
})
2019-07-19 17:30:41 +02:00
})
describe('Captions hooks', function () {
it('Should run action:api.video-caption.created', async function () {
await servers[0].captions.add({ videoId: videoUUID, language: 'en', fixture: 'subtitle-good.srt' })
await checkHook('action:api.video-caption.created')
})
it('Should run action:api.video-caption.deleted', async function () {
await servers[0].captions.delete({ videoId: videoUUID, language: 'en' })
await checkHook('action:api.video-caption.deleted')
})
})
2019-12-06 15:59:12 +01:00
describe('Users hooks', function () {
let userId: number
it('Should run action:api.user.registered', async function () {
2023-01-19 09:28:29 +01:00
await servers[0].registrations.register({ username: 'registered_user' })
2019-07-19 17:30:41 +02:00
2019-12-06 15:59:12 +01:00
await checkHook('action:api.user.registered')
})
it('Should run action:api.user.created', async function () {
2021-07-16 09:04:35 +02:00
const user = await servers[0].users.create({ username: 'created_user' })
2021-07-13 14:23:01 +02:00
userId = user.id
2019-12-06 15:59:12 +01:00
await checkHook('action:api.user.created')
})
it('Should run action:api.user.oauth2-got-token', async function () {
2021-07-16 14:27:30 +02:00
await servers[0].login.login({ user: { username: 'created_user' } })
2019-12-06 15:59:12 +01:00
await checkHook('action:api.user.oauth2-got-token')
})
it('Should run action:api.user.blocked', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].users.banUser({ userId })
2019-12-06 15:59:12 +01:00
await checkHook('action:api.user.blocked')
})
it('Should run action:api.user.unblocked', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].users.unbanUser({ userId })
2019-12-06 15:59:12 +01:00
await checkHook('action:api.user.unblocked')
})
it('Should run action:api.user.updated', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].users.update({ userId, videoQuota: 50 })
2019-12-06 15:59:12 +01:00
await checkHook('action:api.user.updated')
})
it('Should run action:api.user.deleted', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].users.remove({ userId })
2019-12-06 15:59:12 +01:00
await checkHook('action:api.user.deleted')
})
2019-07-19 10:37:35 +02:00
})
describe('Playlist hooks', function () {
let playlistId: number
let videoId: number
before(async function () {
{
2021-07-16 09:04:35 +02:00
const { id } = await servers[0].playlists.create({
2021-07-08 15:54:39 +02:00
attributes: {
displayName: 'My playlist',
privacy: VideoPlaylistPrivacy.PRIVATE
}
})
2021-07-08 15:54:39 +02:00
playlistId = id
}
{
2021-07-16 09:04:35 +02:00
const { id } = await servers[0].videos.upload({ attributes: { name: 'my super name' } })
2021-07-15 10:02:54 +02:00
videoId = id
}
})
it('Should run action:api.video-playlist-element.created', async function () {
2021-07-16 09:04:35 +02:00
await servers[0].playlists.addElement({ playlistId, attributes: { videoId } })
await checkHook('action:api.video-playlist-element.created')
})
})
2022-08-03 11:33:43 +02:00
describe('Notification hook', function () {
it('Should run action:notifier.notification.created', async function () {
await checkHook('action:notifier.notification.created', false)
})
})
2019-07-19 10:37:35 +02:00
after(async function () {
2019-07-19 17:30:41 +02:00
await cleanupTests(servers)
2019-07-19 10:37:35 +02:00
})
})