aboutsummaryrefslogblamecommitdiffhomepage
path: root/server/tests/api/check-params/search.ts
blob: 789ea7754f975088b66a482205ed05733e19a03a (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                                                              

              
        


                          
               
                     
                 
                 
                          
                            
                                               
 
                                                                                                   
                                              





                            




       
                                                   
                            





                                                                    
                                        
                                              


                                                 

                                         















                                                                     
                                                                        
                                                                                                   


                                                                  
                                                                     
                                                                                                                          
 
                                                           
                                                                                                                          


                                                                  
                                                                
                                                                                                                 
 
                                                         
                                                                                                                 


                                                                 
                                                                    
                                                                                                                          
 
                                                          
                                                                                                                          


                                                                 
                                                               
                                                                                                                 
 
                                                        
                                                                                                                 


                                                                  
                                                                      
                                                                                                                 
 
                                                            
                                                                                                                 


                                                            
                                                                      
                                                                                                                 
 
                                                          
                                                                                                                 
 
                                                                      
                                                                                                                 
 
                                                          
                                                                                                                 


                                                                
                                                             
                                                                                                                          
 
                                                             
                                                                                                                          


                                                            
                                                           
                                                                                                                          
 
                                                         
                                                                                                                          
 
                                                                              
                                                                                                                          
 
                                                                            
                                                                                                                          
      









                                                                                                                         









                                                                                                                         

    



                                                          

                         













                                                                     



                                                                                                                                        




                                                                                                                         
                                                                        
                                                                                                   


      



                                                         

                         













                                                                     




                                                                                                                                        
                                                                                                   


      






                                                                                
                                          





                                         
                                                                 
                                                                                                                             


         
                                                                   
                                                                                                                    


         
                                                                 
                                                                                                                    


         
                                                                        
                                                                                                                             




                                                   
                                                                 
                                                                                                                             


         
                                                                        
                                                                                                                    




                                                    
                                                                 
                                                                                                                    






                                                     

                                  

    
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */

import 'mocha'
import {
  checkBadCountPagination,
  checkBadSortPagination,
  checkBadStartPagination,
  cleanupTests,
  createSingleServer,
  makeGetRequest,
  PeerTubeServer,
  setAccessTokensToServers
} from '@shared/extra-utils'
import { HttpStatusCode } from '@shared/models'

function updateSearchIndex (server: PeerTubeServer, enabled: boolean, disableLocalSearch = false) {
  return server.config.updateCustomSubConfig({
    newConfig: {
      search: {
        searchIndex: {
          enabled,
          disableLocalSearch
        }
      }
    }
  })
}

describe('Test videos API validator', function () {
  let server: PeerTubeServer

  // ---------------------------------------------------------------

  before(async function () {
    this.timeout(30000)

    server = await createSingleServer(1)
    await setAccessTokensToServers([ server ])
  })

  describe('When searching videos', function () {
    const path = '/api/v1/search/videos/'

    const query = {
      search: 'coucou'
    }

    it('Should fail with a bad start pagination', async function () {
      await checkBadStartPagination(server.url, path, null, query)
    })

    it('Should fail with a bad count pagination', async function () {
      await checkBadCountPagination(server.url, path, null, query)
    })

    it('Should fail with an incorrect sort', async function () {
      await checkBadSortPagination(server.url, path, null, query)
    })

    it('Should succeed with the correct parameters', async function () {
      await makeGetRequest({ url: server.url, path, query, expectedStatus: HttpStatusCode.OK_200 })
    })

    it('Should fail with an invalid category', async function () {
      const customQuery1 = { ...query, categoryOneOf: [ 'aa', 'b' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })

      const customQuery2 = { ...query, categoryOneOf: 'a' }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with a valid category', async function () {
      const customQuery1 = { ...query, categoryOneOf: [ 1, 7 ] }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })

      const customQuery2 = { ...query, categoryOneOf: 1 }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })
    })

    it('Should fail with an invalid licence', async function () {
      const customQuery1 = { ...query, licenceOneOf: [ 'aa', 'b' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })

      const customQuery2 = { ...query, licenceOneOf: 'a' }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with a valid licence', async function () {
      const customQuery1 = { ...query, licenceOneOf: [ 1, 2 ] }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })

      const customQuery2 = { ...query, licenceOneOf: 1 }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })
    })

    it('Should succeed with a valid language', async function () {
      const customQuery1 = { ...query, languageOneOf: [ 'fr', 'en' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })

      const customQuery2 = { ...query, languageOneOf: 'fr' }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })
    })

    it('Should succeed with valid tags', async function () {
      const customQuery1 = { ...query, tagsOneOf: [ 'tag1', 'tag2' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.OK_200 })

      const customQuery2 = { ...query, tagsOneOf: 'tag1' }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.OK_200 })

      const customQuery3 = { ...query, tagsAllOf: [ 'tag1', 'tag2' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery3, expectedStatus: HttpStatusCode.OK_200 })

      const customQuery4 = { ...query, tagsAllOf: 'tag1' }
      await makeGetRequest({ url: server.url, path, query: customQuery4, expectedStatus: HttpStatusCode.OK_200 })
    })

    it('Should fail with invalid durations', async function () {
      const customQuery1 = { ...query, durationMin: 'hello' }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })

      const customQuery2 = { ...query, durationMax: 'hello' }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should fail with invalid dates', async function () {
      const customQuery1 = { ...query, startDate: 'hello' }
      await makeGetRequest({ url: server.url, path, query: customQuery1, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })

      const customQuery2 = { ...query, endDate: 'hello' }
      await makeGetRequest({ url: server.url, path, query: customQuery2, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })

      const customQuery3 = { ...query, originallyPublishedStartDate: 'hello' }
      await makeGetRequest({ url: server.url, path, query: customQuery3, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })

      const customQuery4 = { ...query, originallyPublishedEndDate: 'hello' }
      await makeGetRequest({ url: server.url, path, query: customQuery4, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should fail with an invalid host', async function () {
      const customQuery = { ...query, host: '6565' }
      await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with a host', async function () {
      const customQuery = { ...query, host: 'example.com' }
      await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
    })

    it('Should fail with invalid uuids', async function () {
      const customQuery = { ...query, uuids: [ '6565', 'dfd70b83-639f-4980-94af-304a56ab4b35' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with valid uuids', async function () {
      const customQuery = { ...query, uuids: [ 'dfd70b83-639f-4980-94af-304a56ab4b35' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
    })
  })

  describe('When searching video playlists', function () {
    const path = '/api/v1/search/video-playlists/'

    const query = {
      search: 'coucou',
      host: 'example.com'
    }

    it('Should fail with a bad start pagination', async function () {
      await checkBadStartPagination(server.url, path, null, query)
    })

    it('Should fail with a bad count pagination', async function () {
      await checkBadCountPagination(server.url, path, null, query)
    })

    it('Should fail with an incorrect sort', async function () {
      await checkBadSortPagination(server.url, path, null, query)
    })

    it('Should fail with an invalid host', async function () {
      await makeGetRequest({ url: server.url, path, query: { ...query, host: '6565' }, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should fail with invalid uuids', async function () {
      const customQuery = { ...query, uuids: [ '6565', 'dfd70b83-639f-4980-94af-304a56ab4b35' ] }
      await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with the correct parameters', async function () {
      await makeGetRequest({ url: server.url, path, query, expectedStatus: HttpStatusCode.OK_200 })
    })
  })

  describe('When searching video channels', function () {
    const path = '/api/v1/search/video-channels/'

    const query = {
      search: 'coucou',
      host: 'example.com'
    }

    it('Should fail with a bad start pagination', async function () {
      await checkBadStartPagination(server.url, path, null, query)
    })

    it('Should fail with a bad count pagination', async function () {
      await checkBadCountPagination(server.url, path, null, query)
    })

    it('Should fail with an incorrect sort', async function () {
      await checkBadSortPagination(server.url, path, null, query)
    })

    it('Should fail with an invalid host', async function () {
      await makeGetRequest({ url: server.url, path, query: { ...query, host: '6565' }, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
    })

    it('Should succeed with the correct parameters', async function () {
      await makeGetRequest({ url: server.url, path, query, expectedStatus: HttpStatusCode.OK_200 })
    })
  })

  describe('Search target', function () {

    it('Should fail/succeed depending on the search target', async function () {
      this.timeout(10000)

      const query = { search: 'coucou' }
      const paths = [
        '/api/v1/search/video-playlists/',
        '/api/v1/search/video-channels/',
        '/api/v1/search/videos/'
      ]

      for (const path of paths) {
        {
          const customQuery = { ...query, searchTarget: 'hello' }
          await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
        }

        {
          const customQuery = { ...query, searchTarget: undefined }
          await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
        }

        {
          const customQuery = { ...query, searchTarget: 'local' }
          await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
        }

        {
          const customQuery = { ...query, searchTarget: 'search-index' }
          await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
        }

        await updateSearchIndex(server, true, true)

        {
          const customQuery = { ...query, searchTarget: 'local' }
          await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
        }

        {
          const customQuery = { ...query, searchTarget: 'search-index' }
          await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
        }

        await updateSearchIndex(server, true, false)

        {
          const customQuery = { ...query, searchTarget: 'local' }
          await makeGetRequest({ url: server.url, path, query: customQuery, expectedStatus: HttpStatusCode.OK_200 })
        }

        await updateSearchIndex(server, false, false)
      }
    })
  })

  after(async function () {
    await cleanupTests([ server ])
  })
})