mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-28 22:24:00 -05:00
fix(config): use correct keys in media config
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares
David Mehren
parent
af0b34efa1
commit
f63013970f
2 changed files with 373 additions and 4 deletions
369
src/config/media.config.spec.ts
Normal file
369
src/config/media.config.spec.ts
Normal file
|
|
@ -0,0 +1,369 @@
|
||||||
|
/*
|
||||||
|
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
*/
|
||||||
|
import mockedEnv from 'mocked-env';
|
||||||
|
|
||||||
|
import { BackendType } from '../media/backends/backend-type.enum';
|
||||||
|
import mediaConfig from './media.config';
|
||||||
|
|
||||||
|
describe('mediaConfig', () => {
|
||||||
|
// Filesystem
|
||||||
|
const uploadPath = 'uploads';
|
||||||
|
// S3
|
||||||
|
const accessKeyId = 'accessKeyId';
|
||||||
|
const secretAccessKey = 'secretAccessKey';
|
||||||
|
const bucket = 'bucket';
|
||||||
|
const endPoint = 'endPoint';
|
||||||
|
// Azure
|
||||||
|
const azureConnectionString = 'connectionString';
|
||||||
|
const container = 'container';
|
||||||
|
// Imgur
|
||||||
|
const clientID = 'clientID';
|
||||||
|
// Webdav
|
||||||
|
const webdavConnectionString = 'https://example.com/webdav';
|
||||||
|
const uploadDir = 'uploadDir';
|
||||||
|
const publicUrl = 'https://example.com/images';
|
||||||
|
|
||||||
|
describe('correctly parses config', () => {
|
||||||
|
it('for backend filesystem', () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.FILESYSTEM,
|
||||||
|
HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH: uploadPath,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const config = mediaConfig();
|
||||||
|
expect(config.backend.use).toEqual(BackendType.FILESYSTEM);
|
||||||
|
expect(config.backend.filesystem.uploadPath).toEqual(uploadPath);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('for backend s3', () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.S3,
|
||||||
|
HD_MEDIA_BACKEND_S3_ACCESS_KEY: accessKeyId,
|
||||||
|
HD_MEDIA_BACKEND_S3_SECRET_KEY: secretAccessKey,
|
||||||
|
HD_MEDIA_BACKEND_S3_BUCKET: bucket,
|
||||||
|
HD_MEDIA_BACKEND_S3_ENDPOINT: endPoint,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const config = mediaConfig();
|
||||||
|
expect(config.backend.use).toEqual(BackendType.S3);
|
||||||
|
expect(config.backend.s3.accessKeyId).toEqual(accessKeyId);
|
||||||
|
expect(config.backend.s3.secretAccessKey).toEqual(secretAccessKey);
|
||||||
|
expect(config.backend.s3.bucket).toEqual(bucket);
|
||||||
|
expect(config.backend.s3.endPoint).toEqual(endPoint);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('for backend azure', () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.AZURE,
|
||||||
|
HD_MEDIA_BACKEND_AZURE_CONNECTION_STRING: azureConnectionString,
|
||||||
|
HD_MEDIA_BACKEND_AZURE_CONTAINER: container,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const config = mediaConfig();
|
||||||
|
expect(config.backend.use).toEqual(BackendType.AZURE);
|
||||||
|
expect(config.backend.azure.connectionString).toEqual(
|
||||||
|
azureConnectionString,
|
||||||
|
);
|
||||||
|
expect(config.backend.azure.container).toEqual(container);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('for backend imgur', () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.IMGUR,
|
||||||
|
HD_MEDIA_BACKEND_IMGUR_CLIENT_ID: clientID,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const config = mediaConfig();
|
||||||
|
expect(config.backend.use).toEqual(BackendType.IMGUR);
|
||||||
|
expect(config.backend.imgur.clientID).toEqual(clientID);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('for backend webdav', () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.WEBDAV,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING: webdavConnectionString,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_UPLOAD_DIR: uploadDir,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL: publicUrl,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const config = mediaConfig();
|
||||||
|
expect(config.backend.use).toEqual(BackendType.WEBDAV);
|
||||||
|
expect(config.backend.webdav.connectionString).toEqual(
|
||||||
|
webdavConnectionString,
|
||||||
|
);
|
||||||
|
expect(config.backend.webdav.uploadDir).toEqual(uploadDir);
|
||||||
|
expect(config.backend.webdav.publicUrl).toEqual(publicUrl);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('throws error', () => {
|
||||||
|
describe('for backend filesystem', () => {
|
||||||
|
it('when HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.FILESYSTEM,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('for backend s3', () => {
|
||||||
|
it('when HD_MEDIA_BACKEND_S3_ACCESS_KEY is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.S3,
|
||||||
|
HD_MEDIA_BACKEND_S3_SECRET_KEY: secretAccessKey,
|
||||||
|
HD_MEDIA_BACKEND_S3_BUCKET: bucket,
|
||||||
|
HD_MEDIA_BACKEND_S3_ENDPOINT: endPoint,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_S3_ACCESS_KEY" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
it('when HD_MEDIA_BACKEND_S3_SECRET_KEY is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.S3,
|
||||||
|
HD_MEDIA_BACKEND_S3_ACCESS_KEY: accessKeyId,
|
||||||
|
HD_MEDIA_BACKEND_S3_BUCKET: bucket,
|
||||||
|
HD_MEDIA_BACKEND_S3_ENDPOINT: endPoint,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_S3_SECRET_KEY" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
it('when HD_MEDIA_BACKEND_S3_BUCKET is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.S3,
|
||||||
|
HD_MEDIA_BACKEND_S3_ACCESS_KEY: accessKeyId,
|
||||||
|
HD_MEDIA_BACKEND_S3_SECRET_KEY: secretAccessKey,
|
||||||
|
HD_MEDIA_BACKEND_S3_ENDPOINT: endPoint,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_S3_BUCKET" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
it('when HD_MEDIA_BACKEND_S3_ENDPOINT is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.S3,
|
||||||
|
HD_MEDIA_BACKEND_S3_ACCESS_KEY: accessKeyId,
|
||||||
|
HD_MEDIA_BACKEND_S3_SECRET_KEY: secretAccessKey,
|
||||||
|
HD_MEDIA_BACKEND_S3_BUCKET: bucket,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_S3_ENDPOINT" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('for backend azure', () => {
|
||||||
|
it('when HD_MEDIA_BACKEND_AZURE_CONNECTION_STRING is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.AZURE,
|
||||||
|
HD_MEDIA_BACKEND_AZURE_CONTAINER: container,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_AZURE_CONNECTION_STRING" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
it('when HD_MEDIA_BACKEND_AZURE_CONTAINER is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.AZURE,
|
||||||
|
HD_MEDIA_BACKEND_AZURE_CONNECTION_STRING: azureConnectionString,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_AZURE_CONTAINER" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('for backend imgur', () => {
|
||||||
|
it('when HD_MEDIA_BACKEND_IMGUR_CLIENT_ID is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.IMGUR,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_IMGUR_CLIENT_ID" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe('for backend webdav', () => {
|
||||||
|
it('when HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.WEBDAV,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_UPLOAD_DIR: uploadDir,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL: publicUrl,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
it('when HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING is not set to an url', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.WEBDAV,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING: 'not-an-url',
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_UPLOAD_DIR: uploadDir,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL: publicUrl,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING" must be a valid uri',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
it('when HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL is not set', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.WEBDAV,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING: webdavConnectionString,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_UPLOAD_DIR: uploadDir,
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL" is required',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
it('when HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL is not set to an url', async () => {
|
||||||
|
const restore = mockedEnv(
|
||||||
|
{
|
||||||
|
/* eslint-disable @typescript-eslint/naming-convention */
|
||||||
|
HD_MEDIA_BACKEND: BackendType.WEBDAV,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_CONNECTION_STRING: webdavConnectionString,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_UPLOAD_DIR: uploadDir,
|
||||||
|
HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL: 'not-an-url',
|
||||||
|
/* eslint-enable @typescript-eslint/naming-convention */
|
||||||
|
},
|
||||||
|
{
|
||||||
|
clear: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
expect(() => mediaConfig()).toThrow(
|
||||||
|
'"HD_MEDIA_BACKEND_WEBDAV_PUBLIC_URL" must be a valid uri',
|
||||||
|
);
|
||||||
|
restore();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -53,8 +53,8 @@ const mediaSchema = Joi.object({
|
||||||
s3: Joi.when('use', {
|
s3: Joi.when('use', {
|
||||||
is: Joi.valid(BackendType.S3),
|
is: Joi.valid(BackendType.S3),
|
||||||
then: Joi.object({
|
then: Joi.object({
|
||||||
accessKey: Joi.string().label('HD_MEDIA_BACKEND_S3_ACCESS_KEY'),
|
accessKeyId: Joi.string().label('HD_MEDIA_BACKEND_S3_ACCESS_KEY'),
|
||||||
secretKey: Joi.string().label('HD_MEDIA_BACKEND_S3_SECRET_KEY'),
|
secretAccessKey: Joi.string().label('HD_MEDIA_BACKEND_S3_SECRET_KEY'),
|
||||||
bucket: Joi.string().label('HD_MEDIA_BACKEND_S3_BUCKET'),
|
bucket: Joi.string().label('HD_MEDIA_BACKEND_S3_BUCKET'),
|
||||||
endPoint: Joi.string().label('HD_MEDIA_BACKEND_S3_ENDPOINT'),
|
endPoint: Joi.string().label('HD_MEDIA_BACKEND_S3_ENDPOINT'),
|
||||||
}),
|
}),
|
||||||
|
|
@ -104,8 +104,8 @@ export default registerAs('mediaConfig', () => {
|
||||||
uploadPath: process.env.HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH,
|
uploadPath: process.env.HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH,
|
||||||
},
|
},
|
||||||
s3: {
|
s3: {
|
||||||
accessKey: process.env.HD_MEDIA_BACKEND_S3_ACCESS_KEY,
|
accessKeyId: process.env.HD_MEDIA_BACKEND_S3_ACCESS_KEY,
|
||||||
secretKey: process.env.HD_MEDIA_BACKEND_S3_SECRET_KEY,
|
secretAccessKey: process.env.HD_MEDIA_BACKEND_S3_SECRET_KEY,
|
||||||
bucket: process.env.HD_MEDIA_BACKEND_S3_BUCKET,
|
bucket: process.env.HD_MEDIA_BACKEND_S3_BUCKET,
|
||||||
endPoint: process.env.HD_MEDIA_BACKEND_S3_ENDPOINT,
|
endPoint: process.env.HD_MEDIA_BACKEND_S3_ENDPOINT,
|
||||||
},
|
},
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue