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