Introduce plugins command

6 files changed, 268 insertions, 306 deletions

diff --git a/shared/extra-utils/index.ts b/shared/extra-utils/index.ts
index 652779eea..cf6418249 100644
--- a/shared/extra-utils/index.ts
+++ b/shared/extra-utils/index.ts
@@ -15,7 +15,6 @@ export * from './requests/requests'
 
 export * from './server/clients'
 export * from './server/config'
-export * from './server/plugins'
 export * from './server/servers'
 
 export * from './users/accounts'
diff --git a/shared/extra-utils/server/index.ts b/shared/extra-utils/server/index.ts
index b5b6b2116..e602fec7e 100644
--- a/shared/extra-utils/server/index.ts
+++ b/shared/extra-utils/server/index.ts
@@ -4,3 +4,5 @@ export * from './follows-command'
 export * from './follows'
 export * from './jobs'
 export * from './jobs-command'
+export * from './plugins-command'
+export * from './plugins'
diff --git a/shared/extra-utils/server/plugins-command.ts b/shared/extra-utils/server/plugins-command.ts
new file mode 100644
index 000000000..f06e58a22
--- /dev/null
+++ b/shared/extra-utils/server/plugins-command.ts
@@ -0,0 +1,245 @@
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
+
+import { readJSON, writeJSON } from 'fs-extra'
+import { join } from 'path'
+import { root } from '@server/helpers/core-utils'
+import { HttpStatusCode } from '@shared/core-utils'
+import {
+  PeerTubePlugin,
+  PeerTubePluginIndex,
+  PeertubePluginIndexList,
+  PluginPackageJson,
+  PluginTranslation,
+  PluginType,
+  PublicServerSetting,
+  RegisteredServerSettings,
+  ResultList
+} from '@shared/models'
+import { buildServerDirectory } from '../miscs'
+import { AbstractCommand, OverrideCommandOptions } from '../shared'
+
+export class PluginsCommand extends AbstractCommand {
+
+  static getPluginTestPath (suffix = '') {
+    return join(root(), 'server', 'tests', 'fixtures', 'peertube-plugin-test' + suffix)
+  }
+
+  list (options: OverrideCommandOptions & {
+    start?: number
+    count?: number
+    sort?: string
+    pluginType?: PluginType
+    uninstalled?: boolean
+  }) {
+    const { start, count, sort, pluginType, uninstalled } = options
+    const path = '/api/v1/plugins'
+
+    return this.getRequestBody<ResultList<PeerTubePlugin>>({
+      ...options,
+
+      path,
+      query: {
+        start,
+        count,
+        sort,
+        pluginType,
+        uninstalled
+      },
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  listAvailable (options: OverrideCommandOptions & {
+    start?: number
+    count?: number
+    sort?: string
+    pluginType?: PluginType
+    currentPeerTubeEngine?: string
+    search?: string
+    expectedStatus?: HttpStatusCode
+  }) {
+    const { start, count, sort, pluginType, search, currentPeerTubeEngine } = options
+    const path = '/api/v1/plugins/available'
+
+    const query: PeertubePluginIndexList = {
+      start,
+      count,
+      sort,
+      pluginType,
+      currentPeerTubeEngine,
+      search
+    }
+
+    return this.getRequestBody<ResultList<PeerTubePluginIndex>>({
+      ...options,
+
+      path,
+      query,
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  get (options: OverrideCommandOptions & {
+    npmName: string
+  }) {
+    const path = '/api/v1/plugins/' + options.npmName
+
+    return this.getRequestBody<PeerTubePlugin>({
+      ...options,
+
+      path,
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  updateSettings (options: OverrideCommandOptions & {
+    npmName: string
+    settings: any
+  }) {
+    const { npmName, settings } = options
+    const path = '/api/v1/plugins/' + npmName + '/settings'
+
+    return this.putBodyRequest({
+      ...options,
+
+      path,
+      fields: { settings },
+      defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
+    })
+  }
+
+  getRegisteredSettings (options: OverrideCommandOptions & {
+    npmName: string
+  }) {
+    const path = '/api/v1/plugins/' + options.npmName + '/registered-settings'
+
+    return this.getRequestBody<RegisteredServerSettings>({
+      ...options,
+
+      path,
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  getPublicSettings (options: OverrideCommandOptions & {
+    npmName: string
+  }) {
+    const { npmName } = options
+    const path = '/api/v1/plugins/' + npmName + '/public-settings'
+
+    return this.getRequestBody<PublicServerSetting>({
+      ...options,
+
+      path,
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  getTranslations (options: OverrideCommandOptions & {
+    locale: string
+  }) {
+    const { locale } = options
+    const path = '/plugins/translations/' + locale + '.json'
+
+    return this.getRequestBody<PluginTranslation>({
+      ...options,
+
+      path,
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  install (options: OverrideCommandOptions & {
+    path?: string
+    npmName?: string
+  }) {
+    const { npmName, path } = options
+    const apiPath = '/api/v1/plugins/install'
+
+    return this.postBodyRequest({
+      ...options,
+
+      path: apiPath,
+      fields: { npmName, path },
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  update (options: OverrideCommandOptions & {
+    path?: string
+    npmName?: string
+  }) {
+    const { npmName, path } = options
+    const apiPath = '/api/v1/plugins/update'
+
+    return this.postBodyRequest({
+      ...options,
+
+      path: apiPath,
+      fields: { npmName, path },
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  uninstall (options: OverrideCommandOptions & {
+    npmName: string
+  }) {
+    const { npmName } = options
+    const apiPath = '/api/v1/plugins/uninstall'
+
+    return this.postBodyRequest({
+      ...options,
+
+      path: apiPath,
+      fields: { npmName },
+      defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
+    })
+  }
+
+  getCSS (options: OverrideCommandOptions = {}) {
+    const path = '/plugins/global.css'
+
+    return this.getRequestText({
+      ...options,
+
+      path,
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+
+  getExternalAuth (options: OverrideCommandOptions & {
+    npmName: string
+    npmVersion: string
+    authName: string
+    query?: any
+  }) {
+    const { npmName, npmVersion, authName, query } = options
+
+    const path = '/plugins/' + npmName + '/' + npmVersion + '/auth/' + authName
+
+    return this.getRequest({
+      ...options,
+
+      path,
+      query,
+      defaultExpectedStatus: HttpStatusCode.OK_200,
+      redirects: 0
+    })
+  }
+
+  updatePackageJSON (npmName: string, json: any) {
+    const path = this.getPackageJSONPath(npmName)
+
+    return writeJSON(path, json)
+  }
+
+  getPackageJSON (npmName: string): Promise<PluginPackageJson> {
+    const path = this.getPackageJSONPath(npmName)
+
+    return readJSON(path)
+  }
+
+  private getPackageJSONPath (npmName: string) {
+    return buildServerDirectory(this.server, join('plugins', 'node_modules', npmName, 'package.json'))
+  }
+}
diff --git a/shared/extra-utils/server/plugins.ts b/shared/extra-utils/server/plugins.ts
index d53e5b382..1084ea4f4 100644
--- a/shared/extra-utils/server/plugins.ts
+++ b/shared/extra-utils/server/plugins.ts
@@ -1,307 +1,18 @@
 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
 
 import { expect } from 'chai'
-import { readJSON, writeJSON } from 'fs-extra'
-import { join } from 'path'
-import { RegisteredServerSettings } from '@shared/models'
-import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
-import { PeertubePluginIndexList } from '../../models/plugins/plugin-index/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'
-
-function listPlugins (parameters: {
-  url: string
-  accessToken: string
-  start?: number
-  count?: number
-  sort?: string
-  pluginType?: PluginType
-  uninstalled?: boolean
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, accessToken, start, count, sort, pluginType, uninstalled, expectedStatus = HttpStatusCode.OK_200 } = parameters
-  const path = '/api/v1/plugins'
-
-  return makeGetRequest({
-    url,
-    path,
-    token: accessToken,
-    query: {
-      start,
-      count,
-      sort,
-      pluginType,
-      uninstalled
-    },
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function listAvailablePlugins (parameters: {
-  url: string
-  accessToken: string
-  start?: number
-  count?: number
-  sort?: string
-  pluginType?: PluginType
-  currentPeerTubeEngine?: string
-  search?: string
-  expectedStatus?: HttpStatusCode
-}) {
-  const {
-    url,
-    accessToken,
-    start,
-    count,
-    sort,
-    pluginType,
-    search,
-    currentPeerTubeEngine,
-    expectedStatus = HttpStatusCode.OK_200
-  } = parameters
-  const path = '/api/v1/plugins/available'
-
-  const query: PeertubePluginIndexList = {
-    start,
-    count,
-    sort,
-    pluginType,
-    currentPeerTubeEngine,
-    search
-  }
-
-  return makeGetRequest({
-    url,
-    path,
-    token: accessToken,
-    query,
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function getPlugin (parameters: {
-  url: string
-  accessToken: string
-  npmName: string
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, accessToken, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
-  const path = '/api/v1/plugins/' + npmName
-
-  return makeGetRequest({
-    url,
-    path,
-    token: accessToken,
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function updatePluginSettings (parameters: {
-  url: string
-  accessToken: string
-  npmName: string
-  settings: any
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, accessToken, npmName, settings, expectedStatus = HttpStatusCode.NO_CONTENT_204 } = parameters
-  const path = '/api/v1/plugins/' + npmName + '/settings'
-
-  return makePutBodyRequest({
-    url,
-    path,
-    token: accessToken,
-    fields: { settings },
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function getPluginRegisteredSettings (parameters: {
-  url: string
-  accessToken: string
-  npmName: string
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, accessToken, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
-  const path = '/api/v1/plugins/' + npmName + '/registered-settings'
-
-  return makeGetRequest({
-    url,
-    path,
-    token: accessToken,
-    statusCodeExpected: expectedStatus
-  })
-}
+import { ServerInfo } from '../server/servers'
 
 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
+  const body = await server.pluginsCommand.getRegisteredSettings({ npmName: 'peertube-plugin-hello-world' })
 
+  const registeredSettings = body.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?: HttpStatusCode
-}) {
-  const { url, npmName, expectedStatus = HttpStatusCode.OK_200 } = parameters
-  const path = '/api/v1/plugins/' + npmName + '/public-settings'
-
-  return makeGetRequest({
-    url,
-    path,
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function getPluginTranslations (parameters: {
-  url: string
-  locale: string
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, locale, expectedStatus = HttpStatusCode.OK_200 } = parameters
-  const path = '/plugins/translations/' + locale + '.json'
-
-  return makeGetRequest({
-    url,
-    path,
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function installPlugin (parameters: {
-  url: string
-  accessToken: string
-  path?: string
-  npmName?: string
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, accessToken, npmName, path, expectedStatus = HttpStatusCode.OK_200 } = parameters
-  const apiPath = '/api/v1/plugins/install'
-
-  return makePostBodyRequest({
-    url,
-    path: apiPath,
-    token: accessToken,
-    fields: { npmName, path },
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function updatePlugin (parameters: {
-  url: string
-  accessToken: string
-  path?: string
-  npmName?: string
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, accessToken, npmName, path, expectedStatus = HttpStatusCode.OK_200 } = parameters
-  const apiPath = '/api/v1/plugins/update'
-
-  return makePostBodyRequest({
-    url,
-    path: apiPath,
-    token: accessToken,
-    fields: { npmName, path },
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function uninstallPlugin (parameters: {
-  url: string
-  accessToken: string
-  npmName: string
-  expectedStatus?: HttpStatusCode
-}) {
-  const { url, accessToken, npmName, expectedStatus = HttpStatusCode.NO_CONTENT_204 } = parameters
-  const apiPath = '/api/v1/plugins/uninstall'
-
-  return makePostBodyRequest({
-    url,
-    path: apiPath,
-    token: accessToken,
-    fields: { npmName },
-    statusCodeExpected: expectedStatus
-  })
-}
-
-function getPluginsCSS (url: string) {
-  const path = '/plugins/global.css'
-
-  return makeGetRequest({
-    url,
-    path,
-    statusCodeExpected: HttpStatusCode.OK_200
-  })
-}
-
-function getPackageJSONPath (server: ServerInfo, npmName: string) {
-  return buildServerDirectory(server, join('plugins', 'node_modules', npmName, 'package.json'))
-}
-
-function updatePluginPackageJSON (server: ServerInfo, npmName: string, json: any) {
-  const path = getPackageJSONPath(server, npmName)
-
-  return writeJSON(path, json)
-}
-
-function getPluginPackageJSON (server: ServerInfo, npmName: string) {
-  const path = getPackageJSONPath(server, npmName)
-
-  return readJSON(path)
-}
-
-function getPluginTestPath (suffix = '') {
-  return join(root(), 'server', 'tests', 'fixtures', 'peertube-plugin-test' + suffix)
-}
-
-function getExternalAuth (options: {
-  url: string
-  npmName: string
-  npmVersion: string
-  authName: string
-  query?: any
-  statusCodeExpected?: HttpStatusCode
-}) {
-  const { url, npmName, npmVersion, authName, statusCodeExpected, query } = options
-
-  const path = '/plugins/' + npmName + '/' + npmVersion + '/auth/' + authName
-
-  return makeGetRequest({
-    url,
-    path,
-    query,
-    statusCodeExpected: statusCodeExpected || HttpStatusCode.OK_200,
-    redirects: 0
-  })
-}
-
 export {
-  listPlugins,
-  listAvailablePlugins,
-  installPlugin,
-  getPluginTranslations,
-  getPluginsCSS,
-  updatePlugin,
-  getPlugin,
-  uninstallPlugin,
-  testHelloWorldRegisteredSettings,
-  updatePluginSettings,
-  getPluginRegisteredSettings,
-  getPackageJSONPath,
-  updatePluginPackageJSON,
-  getPluginPackageJSON,
-  getPluginTestPath,
-  getPublicSettings,
-  getExternalAuth
+  testHelloWorldRegisteredSettings
 }
diff --git a/shared/extra-utils/server/servers.ts b/shared/extra-utils/server/servers.ts
index 5511ce0b0..79d6b7b1a 100644
--- a/shared/extra-utils/server/servers.ts
+++ b/shared/extra-utils/server/servers.ts
@@ -20,6 +20,7 @@ import { ContactFormCommand } from './contact-form-command'
 import { DebugCommand } from './debug-command'
 import { FollowsCommand } from './follows-command'
 import { JobsCommand } from './jobs-command'
+import { PluginsCommand } from './plugins-command'
 
 interface ServerInfo {
   app: ChildProcess
@@ -85,6 +86,7 @@ interface ServerInfo {
   debugCommand?: DebugCommand
   followsCommand?: FollowsCommand
   jobsCommand?: JobsCommand
+  pluginsCommand?: PluginsCommand
 }
 
 function parallelTests () {
@@ -302,6 +304,7 @@ async function runServer (server: ServerInfo, configOverrideArg?: any, args = []
       server.debugCommand = new DebugCommand(server)
       server.followsCommand = new FollowsCommand(server)
       server.jobsCommand = new JobsCommand(server)
+      server.pluginsCommand = new PluginsCommand(server)
 
       res(server)
     })
diff --git a/shared/extra-utils/shared/abstract-command.ts b/shared/extra-utils/shared/abstract-command.ts
index 3815fab0e..dd4598a91 100644
--- a/shared/extra-utils/shared/abstract-command.ts
+++ b/shared/extra-utils/shared/abstract-command.ts
@@ -16,6 +16,7 @@ interface GetCommandOptions extends CommonCommandOptions {
   query?: { [ id: string ]: any }
   contentType?: string
   accept?: string
+  redirects?: number
 }
 
 abstract class AbstractCommand {
@@ -44,6 +45,19 @@ abstract class AbstractCommand {
     return unwrapText(this.getRequest(options))
   }
 
+  protected getRequest (options: GetCommandOptions) {
+    const { redirects, query, contentType, accept } = options
+
+    return makeGetRequest({
+      ...this.buildCommonRequestOptions(options),
+
+      redirects,
+      query,
+      contentType,
+      accept
+    })
+  }
+
   protected deleteRequest (options: CommonCommandOptions) {
     return makeDeleteRequest(this.buildCommonRequestOptions(options))
   }
@@ -85,18 +99,6 @@ abstract class AbstractCommand {
       statusCodeExpected: expectedStatus ?? this.expectedStatus ?? defaultExpectedStatus
     }
   }
-
-  private getRequest (options: GetCommandOptions) {
-    const { query, contentType, accept } = options
-
-    return makeGetRequest({
-      ...this.buildCommonRequestOptions(options),
-
-      query,
-      contentType,
-      accept
-    })
-  }
 }
 
 export {