server/tests/cli/prune-storage.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4 import * as chai from 'chai'
   5 import { createFile, readdir } from 'fs-extra'
   6 import { join } from 'path'
   7 import { buildUUID, wait } from '@shared/core-utils'
   8 import { HttpStatusCode, VideoPlaylistPrivacy } from '@shared/models'
   9 import {
  10   cleanupTests,
  11   CLICommand,
  12   createMultipleServers,
  13   doubleFollow,
  14   killallServers,
  15   makeGetRequest,
  16   PeerTubeServer,
  17   setAccessTokensToServers,
  18   setDefaultVideoChannel,
  19   waitJobs
  20 } from '@shared/server-commands'
  21
  22 const expect = chai.expect
  23
  24 async function countFiles (server: PeerTubeServer, directory: string) {
  25   const files = await readdir(server.servers.buildDirectory(directory))
  26
  27   return files.length
  28 }
  29
  30 async function assertNotExists (server: PeerTubeServer, directory: string, substring: string) {
  31   const files = await readdir(server.servers.buildDirectory(directory))
  32
  33   for (const f of files) {
  34     expect(f).to.not.contain(substring)
  35   }
  36 }
  37
  38 async function assertCountAreOkay (servers: PeerTubeServer[]) {
  39   for (const server of servers) {
  40     const videosCount = await countFiles(server, 'videos')
  41     expect(videosCount).to.equal(8)
  42
  43     const torrentsCount = await countFiles(server, 'torrents')
  44     expect(torrentsCount).to.equal(16)
  45
  46     const previewsCount = await countFiles(server, 'previews')
  47     expect(previewsCount).to.equal(2)
  48
  49     const thumbnailsCount = await countFiles(server, 'thumbnails')
  50     expect(thumbnailsCount).to.equal(6)
  51
  52     const avatarsCount = await countFiles(server, 'avatars')
  53     expect(avatarsCount).to.equal(2)
  54
  55     const hlsRootCount = await countFiles(server, 'streaming-playlists/hls')
  56     expect(hlsRootCount).to.equal(2)
  57   }
  58 }
  59
  60 describe('Test prune storage scripts', function () {
  61   let servers: PeerTubeServer[]
  62   const badNames: { [directory: string]: string[] } = {}
  63
  64   before(async function () {
  65     this.timeout(120000)
  66
  67     servers = await createMultipleServers(2, { transcoding: { enabled: true } })
  68     await setAccessTokensToServers(servers)
  69     await setDefaultVideoChannel(servers)
  70
  71     for (const server of servers) {
  72       await server.videos.upload({ attributes: { name: 'video 1' } })
  73       await server.videos.upload({ attributes: { name: 'video 2' } })
  74
  75       await server.users.updateMyAvatar({ fixture: 'avatar.png' })
  76
  77       await server.playlists.create({
  78         attributes: {
  79           displayName: 'playlist',
  80           privacy: VideoPlaylistPrivacy.PUBLIC,
  81           videoChannelId: server.store.channel.id,
  82           thumbnailfile: 'thumbnail.jpg'
  83         }
  84       })
  85     }
  86
  87     await doubleFollow(servers[0], servers[1])
  88
  89     // Lazy load the remote avatar
  90     {
  91       const account = await servers[0].accounts.get({ accountName: 'root@localhost:' + servers[1].port })
  92       await makeGetRequest({
  93         url: servers[0].url,
  94         path: account.avatar.path,
  95         expectedStatus: HttpStatusCode.OK_200
  96       })
  97     }
  98
  99     {
 100       const account = await servers[1].accounts.get({ accountName: 'root@localhost:' + servers[0].port })
 101       await makeGetRequest({
 102         url: servers[1].url,
 103         path: account.avatar.path,
 104         expectedStatus: HttpStatusCode.OK_200
 105       })
 106     }
 107
 108     await wait(1000)
 109
 110     await waitJobs(servers)
 111     await killallServers(servers)
 112
 113     await wait(1000)
 114   })
 115
 116   it('Should have the files on the disk', async function () {
 117     await assertCountAreOkay(servers)
 118   })
 119
 120   it('Should create some dirty files', async function () {
 121     for (let i = 0; i < 2; i++) {
 122       {
 123         const base = servers[0].servers.buildDirectory('videos')
 124
 125         const n1 = buildUUID() + '.mp4'
 126         const n2 = buildUUID() + '.webm'
 127
 128         await createFile(join(base, n1))
 129         await createFile(join(base, n2))
 130
 131         badNames['videos'] = [ n1, n2 ]
 132       }
 133
 134       {
 135         const base = servers[0].servers.buildDirectory('torrents')
 136
 137         const n1 = buildUUID() + '-240.torrent'
 138         const n2 = buildUUID() + '-480.torrent'
 139
 140         await createFile(join(base, n1))
 141         await createFile(join(base, n2))
 142
 143         badNames['torrents'] = [ n1, n2 ]
 144       }
 145
 146       {
 147         const base = servers[0].servers.buildDirectory('thumbnails')
 148
 149         const n1 = buildUUID() + '.jpg'
 150         const n2 = buildUUID() + '.jpg'
 151
 152         await createFile(join(base, n1))
 153         await createFile(join(base, n2))
 154
 155         badNames['thumbnails'] = [ n1, n2 ]
 156       }
 157
 158       {
 159         const base = servers[0].servers.buildDirectory('previews')
 160
 161         const n1 = buildUUID() + '.jpg'
 162         const n2 = buildUUID() + '.jpg'
 163
 164         await createFile(join(base, n1))
 165         await createFile(join(base, n2))
 166
 167         badNames['previews'] = [ n1, n2 ]
 168       }
 169
 170       {
 171         const base = servers[0].servers.buildDirectory('avatars')
 172
 173         const n1 = buildUUID() + '.png'
 174         const n2 = buildUUID() + '.jpg'
 175
 176         await createFile(join(base, n1))
 177         await createFile(join(base, n2))
 178
 179         badNames['avatars'] = [ n1, n2 ]
 180       }
 181
 182       {
 183         const directory = join('streaming-playlists', 'hls')
 184         const base = servers[0].servers.buildDirectory(directory)
 185
 186         const n1 = buildUUID()
 187         await createFile(join(base, n1))
 188         badNames[directory] = [ n1 ]
 189       }
 190     }
 191   })
 192
 193   it('Should run prune storage', async function () {
 194     this.timeout(30000)
 195
 196     const env = servers[0].cli.getEnv()
 197     await CLICommand.exec(`echo y | ${env} npm run prune-storage`)
 198   })
 199
 200   it('Should have removed files', async function () {
 201     await assertCountAreOkay(servers)
 202
 203     for (const directory of Object.keys(badNames)) {
 204       for (const name of badNames[directory]) {
 205         await assertNotExists(servers[0], directory, name)
 206       }
 207     }
 208   })
 209
 210   after(async function () {
 211     await cleanupTests(servers)
 212   })
 213 })