server/tests/api/check-params/search.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4 import {
   5   checkBadCountPagination,
   6   checkBadSortPagination,
   7   checkBadStartPagination,
   8   cleanupTests,
   9   createSingleServer,
  10   makeGetRequest,
  11   PeerTubeServer,
  12   setAccessTokensToServers
  13 } from '@shared/extra-utils'
  14 import { HttpStatusCode } from '@shared/models'
  15
  16 function updateSearchIndex (server: PeerTubeServer, enabled: boolean, disableLocalSearch = false) {
  17   return server.config.updateCustomSubConfig({
  18     newConfig: {
  19       search: {
  20         searchIndex: {
  21           enabled,
  22           disableLocalSearch
  23         }
  24       }
  25     }
  26   })
  27 }
  28
  29 describe('Test videos API validator', function () {
  30   let server: PeerTubeServer
  31
  32   // ---------------------------------------------------------------
  33
  34   before(async function () {
  35     this.timeout(30000)
  36
  37     server = await createSingleServer(1)
  38     await setAccessTokensToServers([ server ])
  39   })
  40
  41   describe('When searching videos', function () {
  42     const path = '/api/v1/search/videos/'
  43
  44     const query = {
  45       search: 'coucou'
  46     }
  47
  48     it('Should fail with a bad start pagination', async function () {
  49       await checkBadStartPagination(server.url, path, null, query)
  50     })
  51
  52     it('Should fail with a bad count pagination', async function () {
  53       await checkBadCountPagination(server.url, path, null, query)
  54     })
  55
  56     it('Should fail with an incorrect sort', async function () {
  57       await checkBadSortPagination(server.url, path, null, query)
  58     })
  59
  60     it('Should succeed with the correct parameters', async function () {
  61       await makeGetRequest({ url: server.url, path, query, expectedStatus: HttpStatusCode.OK_200 })
  62     })
  63
  64     it('Should fail with an invalid category', async function () {
  65       const customQuery1 = { ...query, categoryOneOf: [ 'aa', 'b' ] }
  66       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
  67
  68       const customQuery2 = { ...query, categoryOneOf: 'a' }
  69       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
  70     })
  71
  72     it('Should succeed with a valid category', async function () {
  73       const customQuery1 = { ...query, categoryOneOf: [ 1, 7 ] }
  74       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })
  75
  76       const customQuery2 = { ...query, categoryOneOf: 1 }
  77       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })
  78     })
  79
  80     it('Should fail with an invalid licence', async function () {
  81       const customQuery1 = { ...query, licenceOneOf: [ 'aa', 'b' ] }
  82       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
  83
  84       const customQuery2 = { ...query, licenceOneOf: 'a' }
  85       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
  86     })
  87
  88     it('Should succeed with a valid licence', async function () {
  89       const customQuery1 = { ...query, licenceOneOf: [ 1, 2 ] }
  90       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })
  91
  92       const customQuery2 = { ...query, licenceOneOf: 1 }
  93       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })
  94     })
  95
  96     it('Should succeed with a valid language', async function () {
  97       const customQuery1 = { ...query, languageOneOf: [ 'fr', 'en' ] }
  98       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })
  99
 100       const customQuery2 = { ...query, languageOneOf: 'fr' }
 101       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })
 102     })
 103
 104     it('Should succeed with valid tags', async function () {
 105       const customQuery1 = { ...query, tagsOneOf: [ 'tag1', 'tag2' ] }
 106       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })
 107
 108       const customQuery2 = { ...query, tagsOneOf: 'tag1' }
 109       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })
 110
 111       const customQuery3 = { ...query, tagsAllOf: [ 'tag1', 'tag2' ] }
 112       await makeGetRequest({ url: server.url, path, query: customQuery3, expectedStatus: HttpStatusCode.OK_200 })
 113
 114       const customQuery4 = { ...query, tagsAllOf: 'tag1' }
 115       await makeGetRequest({ url: server.url, path, query: customQuery4, expectedStatus: HttpStatusCode.OK_200 })
 116     })
 117
 118     it('Should fail with invalid durations', async function () {
 119       const customQuery1 = { ...query, durationMin: 'hello' }
 120       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 121
 122       const customQuery2 = { ...query, durationMax: 'hello' }
 123       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 124     })
 125
 126     it('Should fail with invalid dates', async function () {
 127       const customQuery1 = { ...query, startDate: 'hello' }
 128       await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 129
 130       const customQuery2 = { ...query, endDate: 'hello' }
 131       await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 132
 133       const customQuery3 = { ...query, originallyPublishedStartDate: 'hello' }
 134       await makeGetRequest({ url: server.url, path, query: customQuery3, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 135
 136       const customQuery4 = { ...query, originallyPublishedEndDate: 'hello' }
 137       await makeGetRequest({ url: server.url, path, query: customQuery4, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 138     })
 139
 140     it('Should fail with an invalid host', async function () {
 141       const customQuery = { ...query, host: '6565' }
 142       await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 143     })
 144
 145     it('Should succeed with a host', async function () {
 146       const customQuery = { ...query, host: 'example.com' }
 147       await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
 148     })
 149   })
 150
 151   describe('When searching video playlists', function () {
 152     const path = '/api/v1/search/video-playlists/'
 153
 154     const query = {
 155       search: 'coucou',
 156       host: 'example.com'
 157     }
 158
 159     it('Should fail with a bad start pagination', async function () {
 160       await checkBadStartPagination(server.url, path, null, query)
 161     })
 162
 163     it('Should fail with a bad count pagination', async function () {
 164       await checkBadCountPagination(server.url, path, null, query)
 165     })
 166
 167     it('Should fail with an incorrect sort', async function () {
 168       await checkBadSortPagination(server.url, path, null, query)
 169     })
 170
 171     it('Should fail with an invalid host', async function () {
 172       await makeGetRequest({ url: server.url, path, query: { ...query, host: '6565' }, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 173     })
 174
 175     it('Should succeed with the correct parameters', async function () {
 176       await makeGetRequest({ url: server.url, path, query, expectedStatus: HttpStatusCode.OK_200 })
 177     })
 178   })
 179
 180   describe('When searching video channels', function () {
 181     const path = '/api/v1/search/video-channels/'
 182
 183     const query = {
 184       search: 'coucou',
 185       host: 'example.com'
 186     }
 187
 188     it('Should fail with a bad start pagination', async function () {
 189       await checkBadStartPagination(server.url, path, null, query)
 190     })
 191
 192     it('Should fail with a bad count pagination', async function () {
 193       await checkBadCountPagination(server.url, path, null, query)
 194     })
 195
 196     it('Should fail with an incorrect sort', async function () {
 197       await checkBadSortPagination(server.url, path, null, query)
 198     })
 199
 200     it('Should fail with an invalid host', async function () {
 201       await makeGetRequest({ url: server.url, path, query: { ...query, host: '6565' }, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 202     })
 203
 204     it('Should succeed with the correct parameters', async function () {
 205       await makeGetRequest({ url: server.url, path, query, expectedStatus: HttpStatusCode.OK_200 })
 206     })
 207   })
 208
 209   describe('Search target', function () {
 210
 211     it('Should fail/succeed depending on the search target', async function () {
 212       this.timeout(10000)
 213
 214       const query = { search: 'coucou' }
 215       const paths = [
 216         '/api/v1/search/video-playlists/',
 217         '/api/v1/search/video-channels/',
 218         '/api/v1/search/videos/'
 219       ]
 220
 221       for (const path of paths) {
 222         {
 223           const customQuery = { ...query, searchTarget: 'hello' }
 224           await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 225         }
 226
 227         {
 228           const customQuery = { ...query, searchTarget: undefined }
 229           await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
 230         }
 231
 232         {
 233           const customQuery = { ...query, searchTarget: 'local' }
 234           await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
 235         }
 236
 237         {
 238           const customQuery = { ...query, searchTarget: 'search-index' }
 239           await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 240         }
 241
 242         await updateSearchIndex(server, true, true)
 243
 244         {
 245           const customQuery = { ...query, searchTarget: 'local' }
 246           await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
 247         }
 248
 249         {
 250           const customQuery = { ...query, searchTarget: 'search-index' }
 251           await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
 252         }
 253
 254         await updateSearchIndex(server, true, false)
 255
 256         {
 257           const customQuery = { ...query, searchTarget: 'local' }
 258           await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
 259         }
 260
 261         await updateSearchIndex(server, false, false)
 262       }
 263     })
 264   })
 265
 266   after(async function () {
 267     await cleanupTests([ server ])
 268   })
 269 })