PeerTube/packages/tests/src/api/check-params/config.ts

434 lines
9.9 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
import merge from 'lodash-es/merge.js'
import { omit } from '@peertube/peertube-core-utils'
import { CustomConfig, HttpStatusCode } from '@peertube/peertube-models'
import {
cleanupTests,
2021-07-16 09:47:51 +02:00
createSingleServer,
makeDeleteRequest,
makeGetRequest,
makePutBodyRequest,
2021-07-16 09:47:51 +02:00
PeerTubeServer,
2021-07-13 11:05:15 +02:00
setAccessTokensToServers
} from '@peertube/peertube-server-commands'
describe('Test config API validators', function () {
const path = '/api/v1/config/custom'
2021-07-16 09:47:51 +02:00
let server: PeerTubeServer
let userAccessToken: string
2023-12-27 10:39:09 +01:00
const updateParams: CustomConfig = {
instance: {
name: 'PeerTube updated',
2018-03-15 14:31:08 +01:00
shortDescription: 'my short description',
description: 'my super description',
terms: 'my super terms',
2019-08-23 15:23:27 +02:00
codeOfConduct: 'my super coc',
2019-09-03 09:49:04 +02:00
creationReason: 'my super reason',
2019-08-23 15:23:27 +02:00
moderationInformation: 'my super moderation information',
administrator: 'Kuja',
maintenanceLifetime: 'forever',
businessModel: 'my super business model',
hardwareInformation: '2vCore 3GB RAM',
2019-08-23 15:23:27 +02:00
languages: [ 'en', 'es' ],
categories: [ 1, 2 ],
2019-02-20 15:36:43 +01:00
isNSFW: true,
defaultNSFWPolicy: 'blur',
defaultClientRoute: '/videos/recently-added',
customizations: {
javascript: 'alert("coucou")',
css: 'body { background-color: red; }'
}
},
2019-07-09 11:45:19 +02:00
theme: {
default: 'default'
},
services: {
twitter: {
username: '@MySuperUsername',
whitelisted: true
}
},
client: {
videos: {
miniature: {
preferAuthorDisplayName: false
}
},
menu: {
login: {
redirectOnSingleExternalAuth: false
}
}
},
cache: {
previews: {
size: 2
2018-07-12 19:02:00 +02:00
},
captions: {
size: 3
},
torrents: {
size: 4
2023-06-01 14:51:16 +02:00
},
storyboards: {
size: 5
}
},
signup: {
enabled: false,
limit: 5,
2023-01-19 09:28:29 +01:00
requiresApproval: false,
requiresEmailVerification: false,
minimumAge: 16
},
admin: {
email: 'superadmin1@example.com'
},
2019-01-09 15:14:29 +01:00
contactForm: {
enabled: false
},
user: {
history: {
videos: {
enabled: true
}
},
videoQuota: 5242881,
videoQuotaDaily: 318742,
defaultChannelName: 'Main $1 channel'
},
videoChannels: {
maxPerUser: 20
},
transcoding: {
enabled: true,
2023-04-21 15:00:01 +02:00
remoteRunners: {
enabled: true
},
2018-12-11 14:52:50 +01:00
allowAdditionalExtensions: true,
2019-05-16 16:55:34 +02:00
allowAudioFiles: true,
concurrency: 1,
threads: 1,
profile: 'vod_profile',
resolutions: {
'0p': false,
'144p': false,
'240p': false,
'360p': true,
'480p': true,
'720p': false,
2019-06-12 17:33:29 +02:00
'1080p': false,
'1440p': false,
2019-06-12 17:33:29 +02:00
'2160p': false
2019-01-29 08:37:25 +01:00
},
alwaysTranscodeOriginalResolution: false,
2023-07-11 09:52:14 +02:00
webVideos: {
enabled: true
},
2019-01-29 08:37:25 +01:00
hls: {
enabled: false
}
2018-08-03 11:10:31 +02:00
},
live: {
enabled: true,
2020-09-25 16:19:35 +02:00
allowReplay: false,
2022-03-04 13:40:02 +01:00
latencySetting: {
enabled: false
},
2020-12-15 09:23:28 +01:00
maxDuration: 30,
2020-10-28 15:24:40 +01:00
maxInstanceLives: -1,
maxUserLives: 50,
2020-09-25 16:19:35 +02:00
transcoding: {
enabled: true,
2023-04-21 15:00:01 +02:00
remoteRunners: {
enabled: true
},
threads: 4,
profile: 'live_profile',
resolutions: {
'144p': true,
'240p': true,
'360p': true,
'480p': true,
'720p': true,
'1080p': true,
'1440p': true,
'2160p': true
},
alwaysTranscodeOriginalResolution: false
}
},
2022-03-22 16:58:49 +01:00
videoStudio: {
enabled: true,
remoteRunners: {
enabled: true
}
2023-07-19 16:02:49 +02:00
},
videoFile: {
update: {
enabled: true
}
2022-02-11 10:51:33 +01:00
},
2018-08-03 11:10:31 +02:00
import: {
videos: {
concurrency: 1,
2018-08-03 11:10:31 +02:00
http: {
enabled: false
2018-08-07 10:07:53 +02:00
},
torrent: {
enabled: false
2018-08-03 11:10:31 +02:00
}
Channel sync (#5135) * Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-08-10 09:53:39 +02:00
},
videoChannelSynchronization: {
enabled: false,
maxPerUser: 10
2018-08-03 11:10:31 +02:00
}
},
2021-01-27 17:15:21 +01:00
trending: {
videos: {
algorithms: {
enabled: [ 'hot', 'most-viewed', 'most-liked' ],
2021-01-27 17:15:21 +01:00
default: 'most-viewed'
}
}
},
autoBlacklist: {
videos: {
ofUsers: {
enabled: false
}
}
2019-04-08 14:04:57 +02:00
},
followers: {
instance: {
enabled: false,
manualApproval: true
2019-04-08 14:04:57 +02:00
}
},
followings: {
instance: {
autoFollowBack: {
enabled: true
},
autoFollowIndex: {
enabled: true,
indexUrl: 'https://index.example.com'
}
}
2020-05-28 11:15:38 +02:00
},
broadcastMessage: {
enabled: true,
dismissable: true,
message: 'super message',
level: 'warning'
2020-05-29 16:16:24 +02:00
},
search: {
remoteUri: {
users: true,
anonymous: true
},
searchIndex: {
enabled: true,
url: 'https://search.joinpeertube.org',
disableLocalSearch: true,
isDefaultSearch: true
}
2023-12-27 10:39:09 +01:00
},
storyboards: {
enabled: false
}
}
// ---------------------------------------------------------------
before(async function () {
2018-01-18 18:10:45 +01:00
this.timeout(30000)
2021-07-16 09:47:51 +02:00
server = await createSingleServer(1)
await setAccessTokensToServers([ server ])
const user = {
username: 'user1',
password: 'password'
}
2021-07-16 09:04:35 +02:00
await server.users.create({ username: user.username, password: user.password })
userAccessToken = await server.login.getAccessToken(user)
})
describe('When getting the configuration', function () {
it('Should fail without token', async function () {
await makeGetRequest({
url: server.url,
path,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.UNAUTHORIZED_401
})
})
it('Should fail if the user is not an administrator', async function () {
await makeGetRequest({
url: server.url,
path,
token: userAccessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.FORBIDDEN_403
})
})
})
describe('When updating the configuration', function () {
it('Should fail without token', async function () {
await makePutBodyRequest({
url: server.url,
path,
fields: updateParams,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.UNAUTHORIZED_401
})
})
it('Should fail if the user is not an administrator', async function () {
await makePutBodyRequest({
url: server.url,
path,
fields: updateParams,
token: userAccessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.FORBIDDEN_403
})
})
it('Should fail if it misses a key', async function () {
2022-08-17 15:25:58 +02:00
const newUpdateParams = { ...updateParams, admin: omit(updateParams.admin, [ 'email' ]) }
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should fail with a bad default NSFW policy', async function () {
2021-07-13 09:43:59 +02:00
const newUpdateParams = {
...updateParams,
instance: {
defaultNSFWPolicy: 'hello'
}
2021-07-13 09:43:59 +02:00
}
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should fail if email disabled and signup requires email verification', async function () {
2019-04-24 15:10:37 +02:00
// opposite scenario - success when enable enabled - covered via tests/api/users/user-verification.ts
2021-07-13 09:43:59 +02:00
const newUpdateParams = {
...updateParams,
signup: {
enabled: true,
limit: 5,
2023-01-19 09:28:29 +01:00
requiresApproval: true,
requiresEmailVerification: true
}
2021-07-13 09:43:59 +02:00
}
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should fail with a disabled web videos & hls transcoding', async function () {
2021-07-13 09:43:59 +02:00
const newUpdateParams = {
...updateParams,
transcoding: {
hls: {
enabled: false
},
2023-07-11 09:52:14 +02:00
web_videos: {
enabled: false
}
}
2021-07-13 09:43:59 +02:00
}
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.BAD_REQUEST_400
})
})
Channel sync (#5135) * Add external channel URL for channel update / creation (#754) * Disallow synchronisation if user has no video quota (#754) * More constraints serverside (#754) * Disable sync if server configuration does not allow HTTP import (#754) * Working version synchronizing videos with a job (#754) TODO: refactoring, too much code duplication * More logs and try/catch (#754) * Fix eslint error (#754) * WIP: support synchronization time change (#754) * New frontend #754 * WIP: Create sync front (#754) * Enhance UI, sync creation form (#754) * Warning message when HTTP upload is disallowed * More consistent names (#754) * Binding Front with API (#754) * Add a /me API (#754) * Improve list UI (#754) * Implement creation and deletion routes (#754) * Lint (#754) * Lint again (#754) * WIP: UI for triggering import existing videos (#754) * Implement jobs for syncing and importing channels * Don't sync videos before sync creation + avoid concurrency issue (#754) * Cleanup (#754) * Cleanup: OpenAPI + API rework (#754) * Remove dead code (#754) * Eslint (#754) * Revert the mess with whitespaces in constants.ts (#754) * Some fixes after rebase (#754) * Several fixes after PR remarks (#754) * Front + API: Rename video-channels-sync to video-channel-syncs (#754) * Allow enabling channel sync through UI (#754) * getChannelInfo (#754) * Minor fixes: openapi + model + sql (#754) * Simplified API validators (#754) * Rename MChannelSync to MChannelSyncChannel (#754) * Add command for VideoChannelSync (#754) * Use synchronization.enabled config (#754) * Check parameters test + some fixes (#754) * Fix conflict mistake (#754) * Restrict access to video channel sync list API (#754) * Start adding unit test for synchronization (#754) * Continue testing (#754) * Tests finished + convertion of job to scheduler (#754) * Add lastSyncAt field (#754) * Fix externalRemoteUrl sort + creation date not well formatted (#754) * Small fix (#754) * Factorize addYoutubeDLImport and buildVideo (#754) * Check duplicates on channel not on users (#754) * factorize thumbnail generation (#754) * Fetch error should return status 400 (#754) * Separate video-channel-import and video-channel-sync-latest (#754) * Bump DB migration version after rebase (#754) * Prettier states in UI table (#754) * Add DefaultScope in VideoChannelSyncModel (#754) * Fix audit logs (#754) * Ensure user can upload when importing channel + minor fixes (#754) * Mark synchronization as failed on exception + typos (#754) * Change REST API for importing videos into channel (#754) * Add option for fully synchronize a chnanel (#754) * Return a whole sync object on creation to avoid tricks in Front (#754) * Various remarks (#754) * Single quotes by default (#754) * Rename synchronization to video_channel_synchronization * Add check.latest_videos_count and max_per_user options (#754) * Better channel rendering in list #754 * Allow sorting with channel name and state (#754) * Add missing tests for channel imports (#754) * Prefer using a parent job for channel sync * Styling * Client styling Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-08-10 09:53:39 +02:00
it('Should fail with a disabled http upload & enabled sync', async function () {
const newUpdateParams: CustomConfig = merge({}, updateParams, {
import: {
videos: {
http: { enabled: false }
},
videoChannelSynchronization: { enabled: true }
}
})
await makePutBodyRequest({
url: server.url,
path,
fields: newUpdateParams,
token: server.accessToken,
expectedStatus: HttpStatusCode.BAD_REQUEST_400
})
})
it('Should succeed with the correct parameters', async function () {
await makePutBodyRequest({
url: server.url,
path,
fields: updateParams,
token: server.accessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.OK_200
})
})
})
describe('When deleting the configuration', function () {
it('Should fail without token', async function () {
await makeDeleteRequest({
url: server.url,
path,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.UNAUTHORIZED_401
})
})
it('Should fail if the user is not an administrator', async function () {
await makeDeleteRequest({
url: server.url,
path,
token: userAccessToken,
2021-07-16 10:42:24 +02:00
expectedStatus: HttpStatusCode.FORBIDDEN_403
})
})
})
2019-04-24 15:10:37 +02:00
after(async function () {
await cleanupTests([ server ])
})
})