server/tests/cli/peertube.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4 import { expect } from 'chai'
   5 import { areHttpImportTestsDisabled, buildAbsoluteFixturePath } from '@shared/core-utils'
   6 import {
   7   cleanupTests,
   8   CLICommand,
   9   createSingleServer,
  10   doubleFollow,
  11   PeerTubeServer,
  12   setAccessTokensToServers,
  13   waitJobs
  14 } from '@shared/server-commands'
  15 import { FIXTURE_URLS, testHelloWorldRegisteredSettings } from '../shared'
  16
  17 describe('Test CLI wrapper', function () {
  18   let server: PeerTubeServer
  19   let userAccessToken: string
  20
  21   let cliCommand: CLICommand
  22
  23   const cmd = 'node ./dist/server/tools/peertube.js'
  24
  25   before(async function () {
  26     this.timeout(30000)
  27
  28     server = await createSingleServer(1)
  29     await setAccessTokensToServers([ server ])
  30
  31     await server.users.create({ username: 'user_1', password: 'super_password' })
  32
  33     userAccessToken = await server.login.getAccessToken({ username: 'user_1', password: 'super_password' })
  34
  35     {
  36       const attributes = { name: 'user_channel', displayName: 'User channel', support: 'super support text' }
  37       await server.channels.create({ token: userAccessToken, attributes })
  38     }
  39
  40     cliCommand = server.cli
  41   })
  42
  43   describe('Authentication and instance selection', function () {
  44
  45     it('Should get an access token', async function () {
  46       const stdout = await cliCommand.execWithEnv(`${cmd} token --url ${server.url} --username user_1 --password super_password`)
  47       const token = stdout.trim()
  48
  49       const body = await server.users.getMyInfo({ token })
  50       expect(body.username).to.equal('user_1')
  51     })
  52
  53     it('Should display no selected instance', async function () {
  54       this.timeout(60000)
  55
  56       const stdout = await cliCommand.execWithEnv(`${cmd} --help`)
  57       expect(stdout).to.contain('no instance selected')
  58     })
  59
  60     it('Should add a user', async function () {
  61       this.timeout(60000)
  62
  63       await cliCommand.execWithEnv(`${cmd} auth add -u ${server.url} -U user_1 -p super_password`)
  64     })
  65
  66     it('Should not fail to add a user if there is a slash at the end of the instance URL', async function () {
  67       this.timeout(60000)
  68
  69       let fullServerURL = server.url + '/'
  70
  71       await cliCommand.execWithEnv(`${cmd} auth add -u ${fullServerURL} -U user_1 -p super_password`)
  72
  73       fullServerURL = server.url + '/asdfasdf'
  74       await cliCommand.execWithEnv(`${cmd} auth add -u ${fullServerURL} -U user_1 -p super_password`)
  75     })
  76
  77     it('Should default to this user', async function () {
  78       this.timeout(60000)
  79
  80       const stdout = await cliCommand.execWithEnv(`${cmd} --help`)
  81       expect(stdout).to.contain(`instance ${server.url} selected`)
  82     })
  83
  84     it('Should remember the user', async function () {
  85       this.timeout(60000)
  86
  87       const stdout = await cliCommand.execWithEnv(`${cmd} auth list`)
  88       expect(stdout).to.contain(server.url)
  89     })
  90   })
  91
  92   describe('Video upload/import', function () {
  93
  94     it('Should upload a video', async function () {
  95       this.timeout(60000)
  96
  97       const fixture = buildAbsoluteFixturePath('60fps_720p_small.mp4')
  98       const params = `-f ${fixture} --video-name 'test upload' --channel-name user_channel --support 'support_text'`
  99
 100       await cliCommand.execWithEnv(`${cmd} upload ${params}`)
 101     })
 102
 103     it('Should have the video uploaded', async function () {
 104       const { total, data } = await server.videos.list()
 105       expect(total).to.equal(1)
 106
 107       const video = await server.videos.get({ id: data[0].uuid })
 108       expect(video.name).to.equal('test upload')
 109       expect(video.support).to.equal('support_text')
 110       expect(video.channel.name).to.equal('user_channel')
 111     })
 112
 113     it('Should import a video', async function () {
 114       if (areHttpImportTestsDisabled()) return
 115
 116       this.timeout(60000)
 117
 118       const params = `--target-url ${FIXTURE_URLS.youtube} --channel-name user_channel`
 119       await cliCommand.execWithEnv(`${cmd} import ${params}`)
 120     })
 121
 122     it('Should have imported the video', async function () {
 123       if (areHttpImportTestsDisabled()) return
 124
 125       this.timeout(60000)
 126
 127       await waitJobs([ server ])
 128
 129       const { total, data } = await server.videos.list()
 130       expect(total).to.equal(2)
 131
 132       const video = data.find(v => v.name === 'small video - youtube')
 133       expect(video).to.not.be.undefined
 134
 135       const videoDetails = await server.videos.get({ id: video.id })
 136       expect(videoDetails.channel.name).to.equal('user_channel')
 137       expect(videoDetails.support).to.equal('super support text')
 138       expect(videoDetails.nsfw).to.be.false
 139     })
 140
 141     it('Should not import again the same video', async function () {
 142       if (areHttpImportTestsDisabled()) return
 143
 144       this.timeout(60000)
 145
 146       const params = `--target-url ${FIXTURE_URLS.youtube} --channel-name user_channel`
 147       await cliCommand.execWithEnv(`${cmd} import ${params}`)
 148
 149       await waitJobs([ server ])
 150
 151       const { total, data } = await server.videos.list()
 152       expect(total).to.equal(2)
 153
 154       const videos = data.filter(v => v.name === 'small video - youtube')
 155       expect(videos).to.have.lengthOf(1)
 156
 157       // So we can reimport it
 158       await server.videos.remove({ token: userAccessToken, id: videos[0].id })
 159     })
 160
 161     it('Should import and override some imported attributes', async function () {
 162       if (areHttpImportTestsDisabled()) return
 163
 164       this.timeout(60000)
 165
 166       const params = `--target-url ${FIXTURE_URLS.youtube} ` +
 167                      `--channel-name user_channel --video-name toto --nsfw --support support`
 168       await cliCommand.execWithEnv(`${cmd} import ${params}`)
 169
 170       await waitJobs([ server ])
 171
 172       {
 173         const { total, data } = await server.videos.list()
 174         expect(total).to.equal(2)
 175
 176         const video = data.find(v => v.name === 'toto')
 177         expect(video).to.not.be.undefined
 178
 179         const videoDetails = await server.videos.get({ id: video.id })
 180         expect(videoDetails.channel.name).to.equal('user_channel')
 181         expect(videoDetails.support).to.equal('support')
 182         expect(videoDetails.nsfw).to.be.true
 183         expect(videoDetails.commentsEnabled).to.be.true
 184       }
 185     })
 186   })
 187
 188   describe('Admin auth', function () {
 189
 190     it('Should remove the auth user', async function () {
 191       await cliCommand.execWithEnv(`${cmd} auth del ${server.url}`)
 192
 193       const stdout = await cliCommand.execWithEnv(`${cmd} --help`)
 194       expect(stdout).to.contain('no instance selected')
 195     })
 196
 197     it('Should add the admin user', async function () {
 198       await cliCommand.execWithEnv(`${cmd} auth add -u ${server.url} -U root -p test${server.internalServerNumber}`)
 199     })
 200   })
 201
 202   describe('Manage plugins', function () {
 203
 204     it('Should install a plugin', async function () {
 205       this.timeout(60000)
 206
 207       await cliCommand.execWithEnv(`${cmd} plugins install --npm-name peertube-plugin-hello-world`)
 208     })
 209
 210     it('Should have registered settings', async function () {
 211       await testHelloWorldRegisteredSettings(server)
 212     })
 213
 214     it('Should list installed plugins', async function () {
 215       const res = await cliCommand.execWithEnv(`${cmd} plugins list`)
 216
 217       expect(res).to.contain('peertube-plugin-hello-world')
 218     })
 219
 220     it('Should uninstall the plugin', async function () {
 221       const res = await cliCommand.execWithEnv(`${cmd} plugins uninstall --npm-name peertube-plugin-hello-world`)
 222
 223       expect(res).to.not.contain('peertube-plugin-hello-world')
 224     })
 225
 226     it('Should install a plugin in requested version', async function () {
 227       this.timeout(60000)
 228
 229       await cliCommand.execWithEnv(`${cmd} plugins install --npm-name peertube-plugin-hello-world --plugin-version 0.0.17`)
 230     })
 231
 232     it('Should list installed plugins, in correct version', async function () {
 233       const res = await cliCommand.execWithEnv(`${cmd} plugins list`)
 234
 235       expect(res).to.contain('peertube-plugin-hello-world')
 236       expect(res).to.contain('0.0.17')
 237     })
 238
 239     it('Should uninstall the plugin again', async function () {
 240       const res = await cliCommand.execWithEnv(`${cmd} plugins uninstall --npm-name peertube-plugin-hello-world`)
 241
 242       expect(res).to.not.contain('peertube-plugin-hello-world')
 243     })
 244   })
 245
 246   describe('Manage video redundancies', function () {
 247     let anotherServer: PeerTubeServer
 248     let video1Server2: number
 249     let servers: PeerTubeServer[]
 250
 251     before(async function () {
 252       this.timeout(120000)
 253
 254       anotherServer = await createSingleServer(2)
 255       await setAccessTokensToServers([ anotherServer ])
 256
 257       await doubleFollow(server, anotherServer)
 258
 259       servers = [ server, anotherServer ]
 260       await waitJobs(servers)
 261
 262       const { uuid } = await anotherServer.videos.quickUpload({ name: 'super video' })
 263       await waitJobs(servers)
 264
 265       video1Server2 = await server.videos.getId({ uuid })
 266     })
 267
 268     it('Should add a redundancy', async function () {
 269       this.timeout(60000)
 270
 271       const params = `add --video ${video1Server2}`
 272       await cliCommand.execWithEnv(`${cmd} redundancy ${params}`)
 273
 274       await waitJobs(servers)
 275     })
 276
 277     it('Should list redundancies', async function () {
 278       this.timeout(60000)
 279
 280       {
 281         const params = 'list-my-redundancies'
 282         const stdout = await cliCommand.execWithEnv(`${cmd} redundancy ${params}`)
 283
 284         expect(stdout).to.contain('super video')
 285         expect(stdout).to.contain(`localhost:${server.port}`)
 286       }
 287     })
 288
 289     it('Should remove a redundancy', async function () {
 290       this.timeout(60000)
 291
 292       const params = `remove --video ${video1Server2}`
 293       await cliCommand.execWithEnv(`${cmd} redundancy ${params}`)
 294
 295       await waitJobs(servers)
 296
 297       {
 298         const params = 'list-my-redundancies'
 299         const stdout = await cliCommand.execWithEnv(`${cmd} redundancy ${params}`)
 300
 301         expect(stdout).to.not.contain('super video')
 302       }
 303     })
 304
 305     after(async function () {
 306       this.timeout(10000)
 307
 308       await cleanupTests([ anotherServer ])
 309     })
 310   })
 311
 312   after(async function () {
 313     this.timeout(10000)
 314
 315     await cleanupTests([ server ])
 316   })
 317 })