server/tests/api/server/logs.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 {
   6   cleanupTests,
   7   createSingleServer,
   8   killallServers,
   9   LogsCommand,
  10   PeerTubeServer,
  11   setAccessTokensToServers,
  12   waitJobs
  13 } from '@shared/extra-utils'
  14
  15 const expect = chai.expect
  16
  17 describe('Test logs', function () {
  18   let server: PeerTubeServer
  19   let logsCommand: LogsCommand
  20
  21   before(async function () {
  22     this.timeout(30000)
  23
  24     server = await createSingleServer(1)
  25     await setAccessTokensToServers([ server ])
  26
  27     logsCommand = server.logs
  28   })
  29
  30   describe('With the standard log file', function () {
  31
  32     it('Should get logs with a start date', async function () {
  33       this.timeout(20000)
  34
  35       await server.videos.upload({ attributes: { name: 'video 1' } })
  36       await waitJobs([ server ])
  37
  38       const now = new Date()
  39
  40       await server.videos.upload({ attributes: { name: 'video 2' } })
  41       await waitJobs([ server ])
  42
  43       const body = await logsCommand.getLogs({ startDate: now })
  44       const logsString = JSON.stringify(body)
  45
  46       expect(logsString.includes('video 1')).to.be.false
  47       expect(logsString.includes('video 2')).to.be.true
  48     })
  49
  50     it('Should get logs with an end date', async function () {
  51       this.timeout(30000)
  52
  53       await server.videos.upload({ attributes: { name: 'video 3' } })
  54       await waitJobs([ server ])
  55
  56       const now1 = new Date()
  57
  58       await server.videos.upload({ attributes: { name: 'video 4' } })
  59       await waitJobs([ server ])
  60
  61       const now2 = new Date()
  62
  63       await server.videos.upload({ attributes: { name: 'video 5' } })
  64       await waitJobs([ server ])
  65
  66       const body = await logsCommand.getLogs({ startDate: now1, endDate: now2 })
  67       const logsString = JSON.stringify(body)
  68
  69       expect(logsString.includes('video 3')).to.be.false
  70       expect(logsString.includes('video 4')).to.be.true
  71       expect(logsString.includes('video 5')).to.be.false
  72     })
  73
  74     it('Should get filter by level', async function () {
  75       this.timeout(20000)
  76
  77       const now = new Date()
  78
  79       await server.videos.upload({ attributes: { name: 'video 6' } })
  80       await waitJobs([ server ])
  81
  82       {
  83         const body = await logsCommand.getLogs({ startDate: now, level: 'info' })
  84         const logsString = JSON.stringify(body)
  85
  86         expect(logsString.includes('video 6')).to.be.true
  87       }
  88
  89       {
  90         const body = await logsCommand.getLogs({ startDate: now, level: 'warn' })
  91         const logsString = JSON.stringify(body)
  92
  93         expect(logsString.includes('video 6')).to.be.false
  94       }
  95     })
  96
  97     it('Should log ping requests', async function () {
  98       this.timeout(10000)
  99
 100       const now = new Date()
 101
 102       await server.servers.ping()
 103
 104       const body = await logsCommand.getLogs({ startDate: now, level: 'info' })
 105       const logsString = JSON.stringify(body)
 106
 107       expect(logsString.includes('/api/v1/ping')).to.be.true
 108     })
 109
 110     it('Should not log ping requests', async function () {
 111       this.timeout(30000)
 112
 113       await killallServers([ server ])
 114
 115       await server.run({ log: { log_ping_requests: false } })
 116
 117       const now = new Date()
 118
 119       await server.servers.ping()
 120
 121       const body = await logsCommand.getLogs({ startDate: now, level: 'info' })
 122       const logsString = JSON.stringify(body)
 123
 124       expect(logsString.includes('/api/v1/ping')).to.be.false
 125     })
 126   })
 127
 128   describe('With the audit log', function () {
 129     it('Should get logs with a start date', async function () {
 130       this.timeout(20000)
 131
 132       await server.videos.upload({ attributes: { name: 'video 7' } })
 133       await waitJobs([ server ])
 134
 135       const now = new Date()
 136
 137       await server.videos.upload({ attributes: { name: 'video 8' } })
 138       await waitJobs([ server ])
 139
 140       const body = await logsCommand.getAuditLogs({ startDate: now })
 141       const logsString = JSON.stringify(body)
 142
 143       expect(logsString.includes('video 7')).to.be.false
 144       expect(logsString.includes('video 8')).to.be.true
 145
 146       expect(body).to.have.lengthOf(1)
 147
 148       const item = body[0]
 149
 150       const message = JSON.parse(item.message)
 151       expect(message.domain).to.equal('videos')
 152       expect(message.action).to.equal('create')
 153     })
 154
 155     it('Should get logs with an end date', async function () {
 156       this.timeout(30000)
 157
 158       await server.videos.upload({ attributes: { name: 'video 9' } })
 159       await waitJobs([ server ])
 160
 161       const now1 = new Date()
 162
 163       await server.videos.upload({ attributes: { name: 'video 10' } })
 164       await waitJobs([ server ])
 165
 166       const now2 = new Date()
 167
 168       await server.videos.upload({ attributes: { name: 'video 11' } })
 169       await waitJobs([ server ])
 170
 171       const body = await logsCommand.getAuditLogs({ startDate: now1, endDate: now2 })
 172       const logsString = JSON.stringify(body)
 173
 174       expect(logsString.includes('video 9')).to.be.false
 175       expect(logsString.includes('video 10')).to.be.true
 176       expect(logsString.includes('video 11')).to.be.false
 177     })
 178   })
 179
 180   after(async function () {
 181     await cleanupTests([ server ])
 182   })
 183 })