]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/tests/plugins/filter-hooks.ts
Introduce playlist command
[github/Chocobozzz/PeerTube.git] / server / tests / plugins / filter-hooks.ts
index 9939b8e6e8544ffcba3316e7afd277417a10ed0b..203642d8debf45e468865b2f7b212814dd3928c4 100644 (file)
@@ -2,33 +2,44 @@
 
 import 'mocha'
 import * as chai from 'chai'
-import { ServerConfig } from '@shared/models'
+import { HttpStatusCode } from '@shared/core-utils'
 import {
   addVideoCommentReply,
   addVideoCommentThread,
-  createLive,
+  cleanupTests,
   doubleFollow,
-  getConfig,
-  getPluginTestPath,
+  flushAndRunMultipleServers,
+  getAccountVideos,
+  getMyVideos,
   getVideo,
+  getVideoChannelVideos,
   getVideoCommentThreads,
   getVideosList,
   getVideosListPagination,
   getVideoThreadComments,
   getVideoWithToken,
-  installPlugin,
+  makeRawRequest,
+  PluginsCommand,
   registerUser,
+  ServerInfo,
   setAccessTokensToServers,
   setDefaultVideoChannel,
-  updateCustomSubConfig,
   updateVideo,
   uploadVideo,
-  waitJobs
-} from '../../../shared/extra-utils'
-import { cleanupTests, flushAndRunMultipleServers, ServerInfo } from '../../../shared/extra-utils/server/servers'
-import { getGoodVideoUrl, getMyVideoImports, importVideo } from '../../../shared/extra-utils/videos/video-imports'
-import { VideoDetails, VideoImport, VideoImportState, VideoPrivacy } from '../../../shared/models/videos'
-import { VideoCommentThreadTree } from '../../../shared/models/videos/video-comment.model'
+  uploadVideoAndGetId,
+  waitJobs,
+  waitUntilLog
+} from '@shared/extra-utils'
+import { getGoodVideoUrl, getMyVideoImports, importVideo } from '@shared/extra-utils/videos/video-imports'
+import {
+  VideoCommentThreadTree,
+  VideoDetails,
+  VideoImport,
+  VideoImportState,
+  VideoPlaylist,
+  VideoPlaylistPrivacy,
+  VideoPrivacy
+} from '@shared/models'
 
 const expect = chai.expect
 
@@ -38,24 +49,15 @@ describe('Test plugin filter hooks', function () {
   let threadId: number
 
   before(async function () {
-    this.timeout(30000)
+    this.timeout(60000)
 
     servers = await flushAndRunMultipleServers(2)
     await setAccessTokensToServers(servers)
     await setDefaultVideoChannel(servers)
     await doubleFollow(servers[0], servers[1])
 
-    await installPlugin({
-      url: servers[0].url,
-      accessToken: servers[0].accessToken,
-      path: getPluginTestPath()
-    })
-
-    await installPlugin({
-      url: servers[0].url,
-      accessToken: servers[0].accessToken,
-      path: getPluginTestPath('-two')
-    })
+    await servers[0].pluginsCommand.install({ path: PluginsCommand.getPluginTestPath() })
+    await servers[0].pluginsCommand.install({ path: PluginsCommand.getPluginTestPath('-filter-translations') })
 
     for (let i = 0; i < 10; i++) {
       await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'default video ' + i })
@@ -64,13 +66,15 @@ describe('Test plugin filter hooks', function () {
     const res = await getVideosList(servers[0].url)
     videoUUID = res.body.data[0].uuid
 
-    await updateCustomSubConfig(servers[0].url, servers[0].accessToken, {
-      live: { enabled: true },
-      signup: { enabled: true },
-      import: {
-        videos: {
-          http: { enabled: true },
-          torrent: { enabled: true }
+    await servers[0].configCommand.updateCustomSubConfig({
+      newConfig: {
+        live: { enabled: true },
+        signup: { enabled: true },
+        import: {
+          videos: {
+            http: { enabled: true },
+            torrent: { enabled: true }
+          }
         }
       }
     })
@@ -90,6 +94,48 @@ describe('Test plugin filter hooks', function () {
     expect(res.body.total).to.equal(11)
   })
 
+  it('Should run filter:api.accounts.videos.list.params', async function () {
+    const res = await getAccountVideos(servers[0].url, servers[0].accessToken, 'root', 0, 2)
+
+    // 1 plugin do +1 to the count parameter
+    expect(res.body.data).to.have.lengthOf(3)
+  })
+
+  it('Should run filter:api.accounts.videos.list.result', async function () {
+    const res = await getAccountVideos(servers[0].url, servers[0].accessToken, 'root', 0, 2)
+
+    // Plugin do +2 to the total result
+    expect(res.body.total).to.equal(12)
+  })
+
+  it('Should run filter:api.video-channels.videos.list.params', async function () {
+    const res = await getVideoChannelVideos(servers[0].url, servers[0].accessToken, 'root_channel', 0, 2)
+
+    // 1 plugin do +3 to the count parameter
+    expect(res.body.data).to.have.lengthOf(5)
+  })
+
+  it('Should run filter:api.video-channels.videos.list.result', async function () {
+    const res = await getVideoChannelVideos(servers[0].url, servers[0].accessToken, 'root_channel', 0, 2)
+
+    // Plugin do +3 to the total result
+    expect(res.body.total).to.equal(13)
+  })
+
+  it('Should run filter:api.user.me.videos.list.params', async function () {
+    const res = await getMyVideos(servers[0].url, servers[0].accessToken, 0, 2)
+
+    // 1 plugin do +4 to the count parameter
+    expect(res.body.data).to.have.lengthOf(6)
+  })
+
+  it('Should run filter:api.user.me.videos.list.result', async function () {
+    const res = await getMyVideos(servers[0].url, servers[0].accessToken, 0, 2)
+
+    // Plugin do +4 to the total result
+    expect(res.body.total).to.equal(14)
+  })
+
   it('Should run filter:api.video.get.result', async function () {
     const res = await getVideo(servers[0].url, videoUUID)
 
@@ -97,7 +143,7 @@ describe('Test plugin filter hooks', function () {
   })
 
   it('Should run filter:api.video.upload.accept.result', async function () {
-    await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'video with bad word' }, 403)
+    await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'video with bad word' }, HttpStatusCode.FORBIDDEN_403)
   })
 
   it('Should run filter:api.live-video.create.accept.result', async function () {
@@ -107,7 +153,7 @@ describe('Test plugin filter hooks', function () {
       channelId: servers[0].videoChannel.id
     }
 
-    await createLive(servers[0].url, servers[0].accessToken, attributes, 403)
+    await servers[0].liveCommand.create({ fields: attributes, expectedStatus: HttpStatusCode.FORBIDDEN_403 })
   })
 
   it('Should run filter:api.video.pre-import-url.accept.result', async function () {
@@ -117,7 +163,7 @@ describe('Test plugin filter hooks', function () {
       channelId: servers[0].videoChannel.id,
       targetUrl: getGoodVideoUrl() + 'bad'
     }
-    await importVideo(servers[0].url, servers[0].accessToken, baseAttributes, 403)
+    await importVideo(servers[0].url, servers[0].accessToken, baseAttributes, HttpStatusCode.FORBIDDEN_403)
   })
 
   it('Should run filter:api.video.pre-import-torrent.accept.result', async function () {
@@ -127,7 +173,7 @@ describe('Test plugin filter hooks', function () {
       channelId: servers[0].videoChannel.id,
       torrentfile: 'video-720p.torrent' as any
     }
-    await importVideo(servers[0].url, servers[0].accessToken, baseAttributes, 403)
+    await importVideo(servers[0].url, servers[0].accessToken, baseAttributes, HttpStatusCode.FORBIDDEN_403)
   })
 
   it('Should run filter:api.video.post-import-url.accept.result', async function () {
@@ -189,15 +235,22 @@ describe('Test plugin filter hooks', function () {
   })
 
   it('Should run filter:api.video-thread.create.accept.result', async function () {
-    await addVideoCommentThread(servers[0].url, servers[0].accessToken, videoUUID, 'comment with bad word', 403)
+    await addVideoCommentThread(servers[0].url, servers[0].accessToken, videoUUID, 'comment with bad word', HttpStatusCode.FORBIDDEN_403)
   })
 
   it('Should run filter:api.video-comment-reply.create.accept.result', async function () {
     const res = await addVideoCommentThread(servers[0].url, servers[0].accessToken, videoUUID, 'thread')
     threadId = res.body.comment.id
 
-    await addVideoCommentReply(servers[0].url, servers[0].accessToken, videoUUID, threadId, 'comment with bad word', 403)
-    await addVideoCommentReply(servers[0].url, servers[0].accessToken, videoUUID, threadId, 'comment with good word', 200)
+    await addVideoCommentReply(
+      servers[0].url,
+      servers[0].accessToken,
+      videoUUID,
+      threadId,
+      'comment with bad word',
+      HttpStatusCode.FORBIDDEN_403
+    )
+    await addVideoCommentReply(servers[0].url, servers[0].accessToken, videoUUID, threadId, 'comment with good word', HttpStatusCode.OK_200)
   })
 
   it('Should run filter:api.video-threads.list.params', async function () {
@@ -260,7 +313,7 @@ describe('Test plugin filter hooks', function () {
     })
 
     it('Should blacklist on remote upload', async function () {
-      this.timeout(45000)
+      this.timeout(120000)
 
       const res = await uploadVideo(servers[1].url, servers[1].accessToken, { name: 'remote please blacklist me' })
       await waitJobs(servers)
@@ -269,7 +322,7 @@ describe('Test plugin filter hooks', function () {
     })
 
     it('Should blacklist on remote update', async function () {
-      this.timeout(45000)
+      this.timeout(120000)
 
       const res = await uploadVideo(servers[1].url, servers[1].accessToken, { name: 'video' })
       await waitJobs(servers)
@@ -287,8 +340,8 @@ describe('Test plugin filter hooks', function () {
   describe('Should run filter:api.user.signup.allowed.result', function () {
 
     it('Should run on config endpoint', async function () {
-      const res = await getConfig(servers[0].url)
-      expect((res.body as ServerConfig).signup.allowed).to.be.true
+      const body = await servers[0].configCommand.getConfig()
+      expect(body.signup.allowed).to.be.true
     })
 
     it('Should allow a signup', async function () {
@@ -296,12 +349,210 @@ describe('Test plugin filter hooks', function () {
     })
 
     it('Should not allow a signup', async function () {
-      const res = await registerUser(servers[0].url, 'jma', 'password', 403)
+      const res = await registerUser(servers[0].url, 'jma', 'password', HttpStatusCode.FORBIDDEN_403)
 
       expect(res.body.error).to.equal('No jma')
     })
   })
 
+  describe('Download hooks', function () {
+    const downloadVideos: VideoDetails[] = []
+
+    before(async function () {
+      this.timeout(120000)
+
+      await servers[0].configCommand.updateCustomSubConfig({
+        newConfig: {
+          transcoding: {
+            webtorrent: {
+              enabled: true
+            },
+            hls: {
+              enabled: true
+            }
+          }
+        }
+      })
+
+      const uuids: string[] = []
+
+      for (const name of [ 'bad torrent', 'bad file', 'bad playlist file' ]) {
+        const uuid = (await uploadVideoAndGetId({ server: servers[0], videoName: name })).uuid
+        uuids.push(uuid)
+      }
+
+      await waitJobs(servers)
+
+      for (const uuid of uuids) {
+        const res = await getVideo(servers[0].url, uuid)
+        downloadVideos.push(res.body)
+      }
+    })
+
+    it('Should run filter:api.download.torrent.allowed.result', async function () {
+      const res = await makeRawRequest(downloadVideos[0].files[0].torrentDownloadUrl, 403)
+      expect(res.body.error).to.equal('Liu Bei')
+
+      await makeRawRequest(downloadVideos[1].files[0].torrentDownloadUrl, 200)
+      await makeRawRequest(downloadVideos[2].files[0].torrentDownloadUrl, 200)
+    })
+
+    it('Should run filter:api.download.video.allowed.result', async function () {
+      {
+        const res = await makeRawRequest(downloadVideos[1].files[0].fileDownloadUrl, 403)
+        expect(res.body.error).to.equal('Cao Cao')
+
+        await makeRawRequest(downloadVideos[0].files[0].fileDownloadUrl, 200)
+        await makeRawRequest(downloadVideos[2].files[0].fileDownloadUrl, 200)
+      }
+
+      {
+        const res = await makeRawRequest(downloadVideos[2].streamingPlaylists[0].files[0].fileDownloadUrl, 403)
+        expect(res.body.error).to.equal('Sun Jian')
+
+        await makeRawRequest(downloadVideos[2].files[0].fileDownloadUrl, 200)
+
+        await makeRawRequest(downloadVideos[0].streamingPlaylists[0].files[0].fileDownloadUrl, 200)
+        await makeRawRequest(downloadVideos[1].streamingPlaylists[0].files[0].fileDownloadUrl, 200)
+      }
+    })
+  })
+
+  describe('Embed filters', function () {
+    const embedVideos: VideoDetails[] = []
+    const embedPlaylists: VideoPlaylist[] = []
+
+    before(async function () {
+      this.timeout(60000)
+
+      await servers[0].configCommand.updateCustomSubConfig({
+        newConfig: {
+          transcoding: {
+            enabled: false
+          }
+        }
+      })
+
+      for (const name of [ 'bad embed', 'good embed' ]) {
+        {
+          const uuid = (await uploadVideoAndGetId({ server: servers[0], videoName: name })).uuid
+          const res = await getVideo(servers[0].url, uuid)
+          embedVideos.push(res.body)
+        }
+
+        {
+          const attributes = { displayName: name, videoChannelId: servers[0].videoChannel.id, privacy: VideoPlaylistPrivacy.PUBLIC }
+          const { id } = await servers[0].playlistsCommand.create({ attributes })
+
+          const playlist = await servers[0].playlistsCommand.get({ playlistId: id })
+          embedPlaylists.push(playlist)
+        }
+      }
+    })
+
+    it('Should run filter:html.embed.video.allowed.result', async function () {
+      const res = await makeRawRequest(servers[0].url + embedVideos[0].embedPath, 200)
+      expect(res.text).to.equal('Lu Bu')
+    })
+
+    it('Should run filter:html.embed.video-playlist.allowed.result', async function () {
+      const res = await makeRawRequest(servers[0].url + embedPlaylists[0].embedPath, 200)
+      expect(res.text).to.equal('Diao Chan')
+    })
+  })
+
+  describe('Search filters', function () {
+
+    before(async function () {
+      await servers[0].configCommand.updateCustomSubConfig({
+        newConfig: {
+          search: {
+            searchIndex: {
+              enabled: true,
+              isDefaultSearch: false,
+              disableLocalSearch: false
+            }
+          }
+        }
+      })
+    })
+
+    it('Should run filter:api.search.videos.local.list.{params,result}', async function () {
+      await servers[0].searchCommand.advancedVideoSearch({
+        search: {
+          search: 'Sun Quan'
+        }
+      })
+
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.videos.local.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.videos.local.list.result', 1)
+    })
+
+    it('Should run filter:api.search.videos.index.list.{params,result}', async function () {
+      await servers[0].searchCommand.advancedVideoSearch({
+        search: {
+          search: 'Sun Quan',
+          searchTarget: 'search-index'
+        }
+      })
+
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.videos.local.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.videos.local.list.result', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.videos.index.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.videos.index.list.result', 1)
+    })
+
+    it('Should run filter:api.search.video-channels.local.list.{params,result}', async function () {
+      await servers[0].searchCommand.advancedChannelSearch({
+        search: {
+          search: 'Sun Ce'
+        }
+      })
+
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-channels.local.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-channels.local.list.result', 1)
+    })
+
+    it('Should run filter:api.search.video-channels.index.list.{params,result}', async function () {
+      await servers[0].searchCommand.advancedChannelSearch({
+        search: {
+          search: 'Sun Ce',
+          searchTarget: 'search-index'
+        }
+      })
+
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-channels.local.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-channels.local.list.result', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-channels.index.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-channels.index.list.result', 1)
+    })
+
+    it('Should run filter:api.search.video-playlists.local.list.{params,result}', async function () {
+      await servers[0].searchCommand.advancedPlaylistSearch({
+        search: {
+          search: 'Sun Jian'
+        }
+      })
+
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-playlists.local.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-playlists.local.list.result', 1)
+    })
+
+    it('Should run filter:api.search.video-playlists.index.list.{params,result}', async function () {
+      await servers[0].searchCommand.advancedPlaylistSearch({
+        search: {
+          search: 'Sun Jian',
+          searchTarget: 'search-index'
+        }
+      })
+
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-playlists.local.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-playlists.local.list.result', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-playlists.index.list.params', 1)
+      await waitUntilLog(servers[0], 'Run hook filter:api.search.video-playlists.index.list.result', 1)
+    })
+  })
+
   after(async function () {
     await cleanupTests(servers)
   })