Centralize test URLs

[github/Chocobozzz/PeerTube.git] / shared / extra-utils / requests / requests.ts

diff --git a/shared/extra-utils/requests/requests.ts b/shared/extra-utils/requests/requests.ts
index eb59ca600f8f7e1f8f282fccd17d4da0ec410d46..60c9b938bda63c446c2bd3d51919d51d7c81a238 100644 (file)
--- a/shared/extra-utils/requests/requests.ts
+++ b/shared/extra-utils/requests/requests.ts
@@ -1,15 +1,11 @@
 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
 
-import * as request from 'supertest'
-import { buildAbsoluteFixturePath, root } from '../miscs/miscs'
 import { isAbsolute, join } from 'path'
-import { URL } from 'url'
 import { decode } from 'querystring'
-import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
-
-function get4KFileUrl () {
-  return 'https://download.cpy.re/peertube/4k_file.txt'
-}
+import * as request from 'supertest'
+import { URL } from 'url'
+import { HttpStatusCode } from '@shared/core-utils'
+import { buildAbsoluteFixturePath, root } from '../miscs/tests'
 
 function makeRawRequest (url: string, statusCodeExpected?: HttpStatusCode, range?: string) {
   const { host, protocol, pathname } = new URL(url)
@@ -27,6 +23,7 @@ function makeGetRequest (options: {
   range?: string
   redirects?: number
   accept?: string
+  host?: string
 }) {
   if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
   if (options.contentType === undefined) options.contentType = 'application/json'
@@ -38,6 +35,7 @@ function makeGetRequest (options: {
   if (options.query) req.query(options.query)
   if (options.range) req.set('Range', options.range)
   if (options.accept) req.set('Accept', options.accept)
+  if (options.host) req.set('Host', options.host)
   if (options.redirects) req.redirects(options.redirects)
 
   return req.expect(options.statusCodeExpected)
@@ -65,11 +63,17 @@ function makeUploadRequest (options: {
   method?: 'POST' | 'PUT'
   path: string
   token?: string
+
   fields: { [ fieldName: string ]: any }
   attaches?: { [ attachName: string ]: any | any[] }
+
+  headers?: { [ name: string ]: string }
+
   statusCodeExpected?: HttpStatusCode
 }) {
-  if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
+  if (options.statusCodeExpected === undefined) {
+    options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
+  }
 
   let req: request.Test
   if (options.method === 'PUT') {
@@ -82,6 +86,10 @@ function makeUploadRequest (options: {
 
   if (options.token) req.set('Authorization', 'Bearer ' + options.token)
 
+  Object.keys(options.headers || {}).forEach(name => {
+    req.set(name, options.headers[name])
+  })
+
   Object.keys(options.fields).forEach(field => {
     const value = options.fields[field]
 
@@ -105,7 +113,11 @@ function makeUploadRequest (options: {
     }
   })
 
-  return req.expect(options.statusCodeExpected)
+  if (options.statusCodeExpected) {
+    req.expect(options.statusCodeExpected)
+  }
+
+  return req
 }
 
 function makePostBodyRequest (options: {
@@ -113,6 +125,9 @@ function makePostBodyRequest (options: {
   path: string
   token?: string
   fields?: { [ fieldName: string ]: any }
+  headers?: { [ name: string ]: string }
+  type?: string
+  xForwardedFor?: string
   statusCodeExpected?: HttpStatusCode
 }) {
   if (!options.fields) options.fields = {}
@@ -123,6 +138,12 @@ function makePostBodyRequest (options: {
                 .set('Accept', 'application/json')
 
   if (options.token) req.set('Authorization', 'Bearer ' + options.token)
+  if (options.xForwardedFor) req.set('X-Forwarded-For', options.xForwardedFor)
+  if (options.type) req.type(options.type)
+
+  Object.keys(options.headers || {}).forEach(name => {
+    req.set(name, options.headers[name])
+  })
 
   return req.send(options.fields)
             .expect(options.statusCodeExpected)
@@ -154,6 +175,15 @@ function makeHTMLRequest (url: string, path: string) {
     .expect(HttpStatusCode.OK_200)
 }
 
+function makeActivityPubGetRequest (url: string, path: string, expectedStatus = HttpStatusCode.OK_200) {
+  return makeGetRequest({
+    url,
+    path,
+    statusCodeExpected: expectedStatus,
+    accept: 'application/activity+json,text/html;q=0.9,\\*/\\*;q=0.8'
+  })
+}
+
 function updateImageRequest (options: {
   url: string
   path: string
@@ -182,14 +212,17 @@ function decodeQueryString (path: string) {
   return decode(path.split('?')[1])
 }
 
-function unwrap <T> (test: request.Test): Promise<T> {
+function unwrapBody <T> (test: request.Test): Promise<T> {
   return test.then(res => res.body)
 }
 
+function unwrapText (test: request.Test): Promise<string> {
+  return test.then(res => res.text)
+}
+
 // ---------------------------------------------------------------------------
 
 export {
-  get4KFileUrl,
   makeHTMLRequest,
   makeGetRequest,
   decodeQueryString,
@@ -198,6 +231,8 @@ export {
   makePutBodyRequest,
   makeDeleteRequest,
   makeRawRequest,
-  unwrap,
+  makeActivityPubGetRequest,
+  unwrapBody,
+  unwrapText,
   updateImageRequest
 }