modularize abstract video list header and implement video hotness recommendation...

[github/Chocobozzz/PeerTube.git] / shared / extra-utils / server / plugins.ts

diff --git a/shared/extra-utils/server/plugins.ts b/shared/extra-utils/server/plugins.ts
index b6b5e395826f648ec74016c80ba29a8a1aae380e..864954ee78f011a2256d2055e1a6d830f8850553 100644 (file)
--- a/shared/extra-utils/server/plugins.ts
+++ b/shared/extra-utils/server/plugins.ts
@@ -1,10 +1,15 @@
-import { makeGetRequest, makePostBodyRequest, makePutBodyRequest } from '../requests/requests'
-import { PluginType } from '../../models/plugins/plugin.type'
-import { PeertubePluginIndexList } from '../../models/plugins/peertube-plugin-index-list.model'
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
+
+import { expect } from 'chai'
 import { readJSON, writeJSON } from 'fs-extra'
-import { ServerInfo } from './servers'
-import { root } from '../miscs/miscs'
 import { join } from 'path'
+import { RegisteredServerSettings } from '@shared/models'
+import { PeertubePluginIndexList } from '../../models/plugins/peertube-plugin-index-list.model'
+import { PluginType } from '../../models/plugins/plugin.type'
+import { buildServerDirectory, root } from '../miscs/miscs'
+import { makeGetRequest, makePostBodyRequest, makePutBodyRequest } from '../requests/requests'
+import { ServerInfo } from './servers'
+import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
 
 function listPlugins (parameters: {
   url: string
@@ -14,9 +19,9 @@ function listPlugins (parameters: {
   sort?: string
   pluginType?: PluginType
   uninstalled?: boolean
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, start, count, sort, pluginType, uninstalled, expectedStatus = 200 } = parameters
+  const { url, accessToken, start, count, sort, pluginType, uninstalled, expectedStatus = HttpStatusCode.OK_200 } = parameters
   const path = '/api/v1/plugins'
 
   return makeGetRequest({
@@ -43,9 +48,19 @@ function listAvailablePlugins (parameters: {
   pluginType?: PluginType
   currentPeerTubeEngine?: string
   search?: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, start, count, sort, pluginType, search, currentPeerTubeEngine, expectedStatus = 200 } = parameters
+  const {
+    url,
+    accessToken,
+    start,
+    count,
+    sort,
+    pluginType,
+    search,
+    currentPeerTubeEngine,
+    expectedStatus = HttpStatusCode.OK_200
+  } = parameters
   const path = '/api/v1/plugins/available'
 
   const query: PeertubePluginIndexList = {
@@ -70,9 +85,9 @@ function getPlugin (parameters: {
   url: string
   accessToken: string
   npmName: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, npmName, expectedStatus = 200 } = parameters
+  const { url, accessToken, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
   const path = '/api/v1/plugins/' + npmName
 
   return makeGetRequest({
@@ -88,9 +103,9 @@ function updatePluginSettings (parameters: {
   accessToken: string
   npmName: string
   settings: any
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, npmName, settings, expectedStatus = 204 } = parameters
+  const { url, accessToken, npmName, settings, expectedStatus = HttpStatusCode.NO_CONTENT_204 } = parameters
   const path = '/api/v1/plugins/' + npmName + '/settings'
 
   return makePutBodyRequest({
@@ -106,9 +121,9 @@ function getPluginRegisteredSettings (parameters: {
   url: string
   accessToken: string
   npmName: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, npmName, expectedStatus = 200 } = parameters
+  const { url, accessToken, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
   const path = '/api/v1/plugins/' + npmName + '/registered-settings'
 
   return makeGetRequest({
@@ -119,12 +134,27 @@ function getPluginRegisteredSettings (parameters: {
   })
 }
 
+async function testHelloWorldRegisteredSettings (server: ServerInfo) {
+  const res = await getPluginRegisteredSettings({
+    url: server.url,
+    accessToken: server.accessToken,
+    npmName: 'peertube-plugin-hello-world'
+  })
+
+  const registeredSettings = (res.body as RegisteredServerSettings).registeredSettings
+
+  expect(registeredSettings).to.have.length.at.least(1)
+
+  const adminNameSettings = registeredSettings.find(s => s.name === 'admin-name')
+  expect(adminNameSettings).to.not.be.undefined
+}
+
 function getPublicSettings (parameters: {
   url: string
   npmName: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, npmName, expectedStatus = 200 } = parameters
+  const { url, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
   const path = '/api/v1/plugins/' + npmName + '/public-settings'
 
   return makeGetRequest({
@@ -137,9 +167,9 @@ function getPublicSettings (parameters: {
 function getPluginTranslations (parameters: {
   url: string
   locale: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, locale, expectedStatus = 200 } = parameters
+  const { url, locale, expectedStatus = HttpStatusCode.OK_200 } = parameters
   const path = '/plugins/translations/' + locale + '.json'
 
   return makeGetRequest({
@@ -154,9 +184,9 @@ function installPlugin (parameters: {
   accessToken: string
   path?: string
   npmName?: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, npmName, path, expectedStatus = 200 } = parameters
+  const { url, accessToken, npmName, path, expectedStatus = HttpStatusCode.OK_200 } = parameters
   const apiPath = '/api/v1/plugins/install'
 
   return makePostBodyRequest({
@@ -173,9 +203,9 @@ function updatePlugin (parameters: {
   accessToken: string
   path?: string
   npmName?: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, npmName, path, expectedStatus = 200 } = parameters
+  const { url, accessToken, npmName, path, expectedStatus = HttpStatusCode.OK_200 } = parameters
   const apiPath = '/api/v1/plugins/update'
 
   return makePostBodyRequest({
@@ -191,9 +221,9 @@ function uninstallPlugin (parameters: {
   url: string
   accessToken: string
   npmName: string
-  expectedStatus?: number
+  expectedStatus?: HttpStatusCode
 }) {
-  const { url, accessToken, npmName, expectedStatus = 204 } = parameters
+  const { url, accessToken, npmName, expectedStatus = HttpStatusCode.NO_CONTENT_204 } = parameters
   const apiPath = '/api/v1/plugins/uninstall'
 
   return makePostBodyRequest({
@@ -211,12 +241,12 @@ function getPluginsCSS (url: string) {
   return makeGetRequest({
     url,
     path,
-    statusCodeExpected: 200
+    statusCodeExpected: HttpStatusCode.OK_200
   })
 }
 
 function getPackageJSONPath (server: ServerInfo, npmName: string) {
-  return join(root(), 'test' + server.internalServerNumber, 'plugins', 'node_modules', npmName, 'package.json')
+  return buildServerDirectory(server, join('plugins', 'node_modules', npmName, 'package.json'))
 }
 
 function updatePluginPackageJSON (server: ServerInfo, npmName: string, json: any) {
@@ -241,7 +271,7 @@ function getExternalAuth (options: {
   npmVersion: string
   authName: string
   query?: any
-  statusCodeExpected?: number
+  statusCodeExpected?: HttpStatusCode
 }) {
   const { url, npmName, npmVersion, authName, statusCodeExpected, query } = options
 
@@ -251,7 +281,7 @@ function getExternalAuth (options: {
     url,
     path,
     query,
-    statusCodeExpected: statusCodeExpected || 200,
+    statusCodeExpected: statusCodeExpected || HttpStatusCode.OK_200,
     redirects: 0
   })
 }
@@ -265,6 +295,7 @@ export {
   updatePlugin,
   getPlugin,
   uninstallPlugin,
+  testHelloWorldRegisteredSettings,
   updatePluginSettings,
   getPluginRegisteredSettings,
   getPackageJSONPath,