1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
3 import * as request from 'supertest'
4 import { buildAbsoluteFixturePath, root } from '../miscs/miscs'
5 import { isAbsolute, join } from 'path'
6 import { URL } from 'url'
7 import { decode } from 'querystring'
8 import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
10 function get4KFileUrl () {
11 return 'https://download.cpy.re/peertube/4k_file.txt'
14 function makeRawRequest (url: string, statusCodeExpected?: HttpStatusCode, range?: string) {
15 const { host, protocol, pathname } = new URL(url)
17 return makeGetRequest({ url: `${protocol}//${host}`, path: pathname, statusCodeExpected, range })
20 function makeGetRequest (options: {
25 statusCodeExpected?: HttpStatusCode
31 if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
32 if (options.contentType === undefined) options.contentType = 'application/json'
34 const req = request(options.url).get(options.path)
36 if (options.contentType) req.set('Accept', options.contentType)
37 if (options.token) req.set('Authorization', 'Bearer ' + options.token)
38 if (options.query) req.query(options.query)
39 if (options.range) req.set('Range', options.range)
40 if (options.accept) req.set('Accept', options.accept)
41 if (options.redirects) req.redirects(options.redirects)
43 return req.expect(options.statusCodeExpected)
46 function makeDeleteRequest (options: {
50 statusCodeExpected?: HttpStatusCode
52 if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
54 const req = request(options.url)
56 .set('Accept', 'application/json')
58 if (options.token) req.set('Authorization', 'Bearer ' + options.token)
60 return req.expect(options.statusCodeExpected)
63 function makeUploadRequest (options: {
65 method?: 'POST' | 'PUT'
68 fields: { [ fieldName: string ]: any }
69 attaches?: { [ attachName: string ]: any | any[] }
70 statusCodeExpected?: HttpStatusCode
72 if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
75 if (options.method === 'PUT') {
76 req = request(options.url).put(options.path)
78 req = request(options.url).post(options.path)
81 req.set('Accept', 'application/json')
83 if (options.token) req.set('Authorization', 'Bearer ' + options.token)
85 Object.keys(options.fields).forEach(field => {
86 const value = options.fields[field]
88 if (value === undefined) return
90 if (Array.isArray(value)) {
91 for (let i = 0; i < value.length; i++) {
92 req.field(field + '[' + i + ']', value[i])
95 req.field(field, value)
99 Object.keys(options.attaches || {}).forEach(attach => {
100 const value = options.attaches[attach]
101 if (Array.isArray(value)) {
102 req.attach(attach, buildAbsoluteFixturePath(value[0]), value[1])
104 req.attach(attach, buildAbsoluteFixturePath(value))
108 return req.expect(options.statusCodeExpected)
111 function makePostBodyRequest (options: {
115 fields?: { [ fieldName: string ]: any }
116 statusCodeExpected?: HttpStatusCode
118 if (!options.fields) options.fields = {}
119 if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
121 const req = request(options.url)
123 .set('Accept', 'application/json')
125 if (options.token) req.set('Authorization', 'Bearer ' + options.token)
127 return req.send(options.fields)
128 .expect(options.statusCodeExpected)
131 function makePutBodyRequest (options: {
135 fields: { [ fieldName: string ]: any }
136 statusCodeExpected?: HttpStatusCode
138 if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
140 const req = request(options.url)
142 .set('Accept', 'application/json')
144 if (options.token) req.set('Authorization', 'Bearer ' + options.token)
146 return req.send(options.fields)
147 .expect(options.statusCodeExpected)
150 function makeHTMLRequest (url: string, path: string) {
153 .set('Accept', 'text/html')
154 .expect(HttpStatusCode.OK_200)
157 function updateImageRequest (options: {
165 if (isAbsolute(options.fixture)) {
166 filePath = options.fixture
168 filePath = join(root(), 'server', 'tests', 'fixtures', options.fixture)
171 return makeUploadRequest({
174 token: options.accessToken,
176 attaches: { [options.fieldname]: filePath },
177 statusCodeExpected: HttpStatusCode.OK_200
181 function decodeQueryString (path: string) {
182 return decode(path.split('?')[1])
185 function unwrapBody <T> (test: request.Test): Promise<T> {
186 return test.then(res => res.body)
189 function unwrapText (test: request.Test): Promise<string> {
190 return test.then(res => res.text)
193 // ---------------------------------------------------------------------------