server/tests/shared/checks.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
   2
   3 import { expect } from 'chai'
   4 import { pathExists, readFile } from 'fs-extra'
   5 import { join } from 'path'
   6 import { root } from '@shared/core-utils'
   7 import { HttpStatusCode } from '@shared/models'
   8 import { makeGetRequest, PeerTubeServer } from '@shared/server-commands'
   9
  10 // Default interval -> 5 minutes
  11 function dateIsValid (dateString: string, interval = 300000) {
  12   const dateToCheck = new Date(dateString)
  13   const now = new Date()
  14
  15   return Math.abs(now.getTime() - dateToCheck.getTime()) <= interval
  16 }
  17
  18 function expectStartWith (str: string, start: string) {
  19   expect(str.startsWith(start), `${str} does not start with ${start}`).to.be.true
  20 }
  21
  22 async function expectLogDoesNotContain (server: PeerTubeServer, str: string) {
  23   const content = await server.servers.getLogContent()
  24
  25   expect(content.toString()).to.not.contain(str)
  26 }
  27
  28 async function testImage (url: string, imageName: string, imagePath: string, extension = '.jpg') {
  29   const res = await makeGetRequest({
  30     url,
  31     path: imagePath,
  32     expectedStatus: HttpStatusCode.OK_200
  33   })
  34
  35   const body = res.body
  36
  37   const data = await readFile(join(root(), 'server', 'tests', 'fixtures', imageName + extension))
  38   const minLength = body.length - ((30 * body.length) / 100)
  39   const maxLength = body.length + ((30 * body.length) / 100)
  40
  41   expect(data.length).to.be.above(minLength, 'the generated image is way smaller than the recorded fixture')
  42   expect(data.length).to.be.below(maxLength, 'the generated image is way larger than the recorded fixture')
  43 }
  44
  45 async function testFileExistsOrNot (server: PeerTubeServer, directory: string, filePath: string, exist: boolean) {
  46   const base = server.servers.buildDirectory(directory)
  47
  48   expect(await pathExists(join(base, filePath))).to.equal(exist)
  49 }
  50
  51 function checkBadStartPagination (url: string, path: string, token?: string, query = {}) {
  52   return makeGetRequest({
  53     url,
  54     path,
  55     token,
  56     query: { ...query, start: 'hello' },
  57     expectedStatus: HttpStatusCode.BAD_REQUEST_400
  58   })
  59 }
  60
  61 async function checkBadCountPagination (url: string, path: string, token?: string, query = {}) {
  62   await makeGetRequest({
  63     url,
  64     path,
  65     token,
  66     query: { ...query, count: 'hello' },
  67     expectedStatus: HttpStatusCode.BAD_REQUEST_400
  68   })
  69
  70   await makeGetRequest({
  71     url,
  72     path,
  73     token,
  74     query: { ...query, count: 2000 },
  75     expectedStatus: HttpStatusCode.BAD_REQUEST_400
  76   })
  77 }
  78
  79 function checkBadSortPagination (url: string, path: string, token?: string, query = {}) {
  80   return makeGetRequest({
  81     url,
  82     path,
  83     token,
  84     query: { ...query, sort: 'hello' },
  85     expectedStatus: HttpStatusCode.BAD_REQUEST_400
  86   })
  87 }
  88
  89 export {
  90   dateIsValid,
  91   testImage,
  92   expectLogDoesNotContain,
  93   testFileExistsOrNot,
  94   expectStartWith,
  95   checkBadStartPagination,
  96   checkBadCountPagination,
  97   checkBadSortPagination
  98 }