mirror of
https://github.com/tale/headplane.git
synced 2026-08-18 00:57:54 +00:00
Implement path loading
Got the build working Maybe actually fix builds Copy drizzle as well
This commit is contained in:
Erik Parawell
committed by
Aarnav Tale
Aarnav Tale
parent
7691f74d43
commit
5cfd9e411b
@@ -0,0 +1,353 @@
|
||||
import fs from 'node:fs';
|
||||
import os from 'node:os';
|
||||
import path from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import yaml from 'js-yaml';
|
||||
import { afterAll, beforeAll, beforeEach, describe, expect, it } from 'vitest';
|
||||
import { overlayFS } from './setupOverlayFs.js';
|
||||
|
||||
// Get the directory name in ESM
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = path.dirname(__filename);
|
||||
|
||||
// Helper to create a temp file with given content, return its path
|
||||
function writeTempFile(baseName, content) {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'headplane-test-'));
|
||||
const filePath = path.join(dir, baseName);
|
||||
fs.writeFileSync(filePath, content);
|
||||
return filePath;
|
||||
}
|
||||
|
||||
// Helper to create a temporary YAML config file with minimal required structure
|
||||
function writeTempYamlConfig(customConfig = {}) {
|
||||
const defaultConfig = {
|
||||
debug: false,
|
||||
server: {
|
||||
host: '127.0.0.1',
|
||||
port: 8080,
|
||||
cookie_secret: '12345678901234567890123456789012',
|
||||
cookie_secure: false,
|
||||
agent: {
|
||||
authkey: 'testagentauthkey',
|
||||
ttl: 180000,
|
||||
cache_path: '/tmp/agent_cache.json',
|
||||
},
|
||||
},
|
||||
headscale: { url: 'http://localhost:8081', config_strict: false },
|
||||
};
|
||||
|
||||
function deepMerge(target, source) {
|
||||
let output = { ...target };
|
||||
if (isObject(target) && isObject(source)) {
|
||||
output = { ...target, ...source };
|
||||
for (const key of Object.keys(source)) {
|
||||
if (isObject(source[key]) && key in target && isObject(target[key])) {
|
||||
output[key] = deepMerge(target[key], source[key]);
|
||||
} else {
|
||||
output[key] = source[key];
|
||||
}
|
||||
}
|
||||
for (const sectionName of ['oidc', 'server', 'headscale']) {
|
||||
if (output[sectionName] && source[sectionName]) {
|
||||
const sectionSource = source[sectionName];
|
||||
const sectionDefault = target[sectionName] || {};
|
||||
const sectionOutput = output[sectionName];
|
||||
|
||||
for (const baseKey of ['cookie_secret', 'client_secret', 'api_key']) {
|
||||
const valueKey = baseKey;
|
||||
const pathKey = `${baseKey}_path`;
|
||||
const sourceHasValue = Object.hasOwn(sectionSource, valueKey);
|
||||
const sourceHasPath = Object.hasOwn(sectionSource, pathKey);
|
||||
const defaultHasValue = Object.hasOwn(sectionDefault, valueKey);
|
||||
const defaultHasPath = Object.hasOwn(sectionDefault, pathKey);
|
||||
|
||||
if (sourceHasPath && !sourceHasValue && defaultHasValue) {
|
||||
delete sectionOutput[valueKey];
|
||||
} else if (sourceHasValue && !sourceHasPath && defaultHasPath) {
|
||||
delete sectionOutput[pathKey];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
function isObject(item) {
|
||||
return item && typeof item === 'object' && !Array.isArray(item);
|
||||
}
|
||||
|
||||
const merged = deepMerge(defaultConfig, customConfig);
|
||||
const yamlContent =
|
||||
typeof customConfig === 'string' ? customConfig : yaml.dump(merged);
|
||||
return writeTempFile('config.yaml', yamlContent);
|
||||
}
|
||||
|
||||
// Store original process.env to restore after tests
|
||||
const originalEnv = { ...process.env };
|
||||
|
||||
describe('Configuration Loading', () => {
|
||||
let loadConfig;
|
||||
let ConfigError;
|
||||
|
||||
beforeAll(async () => {
|
||||
const module = await import('../app/server/config/loader.js');
|
||||
loadConfig = module.loadConfig;
|
||||
ConfigError = module.ConfigError;
|
||||
});
|
||||
|
||||
beforeEach(() => {
|
||||
// biome-ignore lint/performance/noDelete: needed for test cleanup
|
||||
delete process.env.HEADPLANE_OIDC__CLIENT_SECRET_PATH;
|
||||
// biome-ignore lint/performance/noDelete: needed for test cleanup
|
||||
delete process.env.HEADPLANE_SERVER__COOKIE_SECRET_PATH;
|
||||
// biome-ignore lint/performance/noDelete: needed for test cleanup
|
||||
delete process.env.HEADPLANE_HEADSCALE__API_KEY_PATH;
|
||||
// biome-ignore lint/performance/noDelete: needed for test cleanup
|
||||
delete process.env.TEST_SECRET_DIR;
|
||||
|
||||
// Clear overlayfs
|
||||
overlayFS.clear();
|
||||
|
||||
// Create default files that the config expects
|
||||
overlayFS.createFile(
|
||||
'/var/lib/headplane/agent_cache.json',
|
||||
JSON.stringify({}),
|
||||
);
|
||||
overlayFS.createFile(
|
||||
'/var/lib/headplane/users.json',
|
||||
`[{"u":"acb3294f89a16b554e06b80d5266a3c8b09a883e1fa78ac459a550bf52a32564","c":65535}]`,
|
||||
);
|
||||
overlayFS.createFile('/tmp/agent_cache.json', JSON.stringify({}));
|
||||
|
||||
// Create test files that some tests expect to exist
|
||||
overlayFS.createFile('irrelevant', 'irrelevant-content');
|
||||
overlayFS.createFile('placeholder', 'placeholder-content');
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
Object.assign(process.env, originalEnv);
|
||||
overlayFS.clear();
|
||||
});
|
||||
|
||||
describe('OIDC Configuration', () => {
|
||||
const minimalOidcFields = {
|
||||
token_endpoint_auth_method: 'client_secret_basic',
|
||||
disable_api_key_login: false,
|
||||
headscale_api_key: 'dummyKey',
|
||||
};
|
||||
|
||||
it('should load client_secret from file specified in client_secret_path', async () => {
|
||||
const secretValue = 'yaml-file-oidc-secret';
|
||||
const secretPath = writeTempFile('oidc_secret.txt', secretValue);
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
client_secret_path: secretPath,
|
||||
...minimalOidcFields,
|
||||
},
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: false, path: tempConfigPath });
|
||||
expect(config.oidc.client_secret).toBe(secretValue);
|
||||
});
|
||||
|
||||
it('should override YAML client_secret_path with environment variable', async () => {
|
||||
const envValue = 'env-file-oidc-secret';
|
||||
const envPath = writeTempFile('env_oidc_secret.txt', envValue);
|
||||
process.env.HEADPLANE_OIDC__CLIENT_SECRET_PATH = envPath;
|
||||
// Instead of 'irrelevant', use a temp file that exists
|
||||
const irrelevantPath = writeTempFile(
|
||||
'irrelevant.txt',
|
||||
'irrelevant-content',
|
||||
);
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
client_secret_path: irrelevantPath,
|
||||
...minimalOidcFields,
|
||||
},
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: true, path: tempConfigPath });
|
||||
expect(config.oidc.client_secret).toBe(envValue);
|
||||
});
|
||||
|
||||
it('should handle environment variable interpolation in client_secret_path', async () => {
|
||||
const value = 'interpolated-secret';
|
||||
const dir = fs.mkdtempSync(
|
||||
path.join(os.tmpdir(), 'headplane-secret-dir-'),
|
||||
);
|
||||
const file = path.join(dir, 'secret.txt');
|
||||
fs.writeFileSync(file, value);
|
||||
process.env.TEST_SECRET_DIR = dir;
|
||||
process.env.HEADPLANE_OIDC__CLIENT_SECRET_PATH =
|
||||
'${TEST_SECRET_DIR}/secret.txt';
|
||||
// Instead of 'placeholder', use a temp file that exists
|
||||
const placeholderPath = writeTempFile(
|
||||
'placeholder.txt',
|
||||
'placeholder-content',
|
||||
);
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
client_secret_path: placeholderPath,
|
||||
...minimalOidcFields,
|
||||
},
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: true, path: tempConfigPath });
|
||||
expect(config.oidc.client_secret).toBe(value);
|
||||
});
|
||||
|
||||
it('should reject when client_secret_path points to non-existent file', async () => {
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
client_secret_path: '/no/such/file',
|
||||
...minimalOidcFields,
|
||||
},
|
||||
});
|
||||
await expect(
|
||||
loadConfig({ loadEnv: false, path: tempConfigPath }),
|
||||
).rejects.toThrow(ConfigError);
|
||||
});
|
||||
|
||||
it('should reject when client_secret_path has unresolvable env var interpolation', async () => {
|
||||
process.env.HEADPLANE_OIDC__CLIENT_SECRET_PATH =
|
||||
'${MISSING_DIR}/secret.txt';
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
client_secret_path: 'placeholder',
|
||||
...minimalOidcFields,
|
||||
},
|
||||
});
|
||||
await expect(
|
||||
loadConfig({ loadEnv: true, path: tempConfigPath }),
|
||||
).rejects.toThrow(/Environment variable "MISSING_DIR" not found/);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Server Configuration', () => {
|
||||
it('should load cookie_secret directly from YAML', async () => {
|
||||
const valid = 'abcdefghijklmnopqrstuvwxyz123456';
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
server: { cookie_secret: valid },
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: false, path: tempConfigPath });
|
||||
expect(config.server.cookie_secret).toBe(valid);
|
||||
});
|
||||
|
||||
it('should load cookie_secret from file', async () => {
|
||||
const secret = 'a'.repeat(32);
|
||||
const secretPath = writeTempFile('cookie_secret.txt', secret);
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
server: { cookie_secret_path: secretPath },
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: false, path: tempConfigPath });
|
||||
expect(config.server.cookie_secret).toBe(secret);
|
||||
});
|
||||
|
||||
it('should reject when both cookie_secret and cookie_secret_path are in YAML', async () => {
|
||||
const secretPath = writeTempFile('conflict.txt', 'x'.repeat(32));
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
server: {
|
||||
cookie_secret: '1'.repeat(32),
|
||||
cookie_secret_path: secretPath,
|
||||
},
|
||||
});
|
||||
await expect(
|
||||
loadConfig({ loadEnv: false, path: tempConfigPath }),
|
||||
).rejects.toThrow(
|
||||
/Only one of \"cookie_secret\" or \"cookie_secret_path\" may be set/,
|
||||
);
|
||||
});
|
||||
|
||||
it('should reject when neither cookie_secret nor cookie_secret_path is provided', async () => {
|
||||
const yaml = `debug: false
|
||||
server:
|
||||
host: \"127.0.0.1\"
|
||||
port: 8080
|
||||
cookie_secure: false
|
||||
agent:
|
||||
authkey: \"key\"
|
||||
ttl: 180000
|
||||
cache_path: \"/tmp/cache.json\"
|
||||
headscale:
|
||||
url: \"http://localhost\"
|
||||
config_strict: false
|
||||
`;
|
||||
const tempConfigPath = writeTempYamlConfig(yaml);
|
||||
await expect(
|
||||
loadConfig({ loadEnv: false, path: tempConfigPath }),
|
||||
).rejects.toThrow(
|
||||
/Either \"cookie_secret\" or \"cookie_secret_path\" must be provided for cookie_secret/,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Headscale Configuration', () => {
|
||||
it('should load headscale_api_key directly from YAML', async () => {
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
headscale_api_key: 'hs-yaml-key',
|
||||
token_endpoint_auth_method: 'client_secret_basic',
|
||||
disable_api_key_login: false,
|
||||
},
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: false, path: tempConfigPath });
|
||||
expect(config.oidc.headscale_api_key).toBe('hs-yaml-key');
|
||||
});
|
||||
|
||||
it('should load headscale_api_key from file', async () => {
|
||||
const val = 'hs-file-key';
|
||||
const p = writeTempFile('hs_api_key.txt', val);
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
headscale_api_key_path: p,
|
||||
token_endpoint_auth_method: 'client_secret_basic',
|
||||
disable_api_key_login: false,
|
||||
},
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: false, path: tempConfigPath });
|
||||
expect(config.oidc.headscale_api_key).toBe(val);
|
||||
});
|
||||
|
||||
it('should reject when both headscale_api_key and headscale_api_key_path are in YAML', async () => {
|
||||
const p = writeTempFile('conflict.txt', 'irrelevant');
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
oidc: {
|
||||
issuer: 'https://example.com/oidc',
|
||||
client_id: 'test',
|
||||
headscale_api_key: 'key',
|
||||
headscale_api_key_path: p,
|
||||
token_endpoint_auth_method: 'client_secret_basic',
|
||||
disable_api_key_login: false,
|
||||
},
|
||||
});
|
||||
await expect(
|
||||
loadConfig({ loadEnv: false, path: tempConfigPath }),
|
||||
).rejects.toThrow(
|
||||
/Only one of \"headscale_api_key\" or \"headscale_api_key_path\" may be set/,
|
||||
);
|
||||
});
|
||||
|
||||
it('should keep config_path string and interpolate env vars', async () => {
|
||||
process.env.MY_HS_CONFIG_SUBDIR = 'hs-test';
|
||||
const cfgVal = '/etc/headscale-${MY_HS_CONFIG_SUBDIR}/config.yaml';
|
||||
const exp = '/etc/headscale-hs-test/config.yaml';
|
||||
const tempConfigPath = writeTempYamlConfig({
|
||||
headscale: { config_path: cfgVal },
|
||||
});
|
||||
const config = await loadConfig({ loadEnv: true, path: tempConfigPath });
|
||||
expect(config.headscale.config_path).toBe(exp);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,86 @@
|
||||
import fs from 'node:fs';
|
||||
import fsPromises from 'node:fs/promises';
|
||||
|
||||
// Simple overlayfs implementation for tests
|
||||
class OverlayFS {
|
||||
constructor() {
|
||||
this.overlays = new Map();
|
||||
}
|
||||
|
||||
// Create a virtual file at the given path
|
||||
createFile(filePath, content) {
|
||||
this.overlays.set(filePath, content);
|
||||
}
|
||||
|
||||
// Check if a file exists in our overlay
|
||||
exists(filePath) {
|
||||
return this.overlays.has(filePath);
|
||||
}
|
||||
|
||||
// Read a file from our overlay
|
||||
readFile(filePath) {
|
||||
if (this.overlays.has(filePath)) {
|
||||
return this.overlays.get(filePath);
|
||||
}
|
||||
throw new Error(`File not found: ${filePath}`);
|
||||
}
|
||||
|
||||
// Clean up all overlays
|
||||
clear() {
|
||||
this.overlays.clear();
|
||||
}
|
||||
}
|
||||
|
||||
// Global overlayfs instance
|
||||
export const overlayFS = new OverlayFS();
|
||||
|
||||
// Monkey patch fs.readFileSync to use our overlay
|
||||
const originalReadFileSync = fs.readFileSync;
|
||||
fs.readFileSync = function (filePath, options) {
|
||||
if (overlayFS.exists(filePath)) {
|
||||
const content = overlayFS.readFile(filePath);
|
||||
if (options?.encoding) {
|
||||
return content;
|
||||
}
|
||||
return Buffer.from(content);
|
||||
}
|
||||
return originalReadFileSync.call(this, filePath, options);
|
||||
};
|
||||
|
||||
// Monkey patch fs.promises.readFile (async) to use our overlay
|
||||
const originalAsyncReadFile = fsPromises.readFile;
|
||||
fsPromises.readFile = function (filePath, options) {
|
||||
if (overlayFS.exists(filePath)) {
|
||||
const content = overlayFS.readFile(filePath);
|
||||
if (options?.encoding) {
|
||||
return Promise.resolve(content);
|
||||
}
|
||||
return Promise.resolve(Buffer.from(content));
|
||||
}
|
||||
return originalAsyncReadFile.call(this, filePath, options);
|
||||
};
|
||||
|
||||
// Monkey patch fs.access to handle overlayfs directories
|
||||
const originalAccess = fs.access;
|
||||
fs.access = function (filePath, mode, callback) {
|
||||
// Handle directories that should exist in our overlay
|
||||
if (filePath === '/var/lib/headplane/' || filePath === '/var/lib/headplane') {
|
||||
if (callback) {
|
||||
callback(null);
|
||||
} else {
|
||||
return Promise.resolve();
|
||||
}
|
||||
return;
|
||||
}
|
||||
return originalAccess.call(this, filePath, mode, callback);
|
||||
};
|
||||
|
||||
// Monkey patch fs.promises.access to handle overlayfs directories
|
||||
const originalAsyncAccess = fsPromises.access;
|
||||
fsPromises.access = function (filePath, mode) {
|
||||
// Handle directories that should exist in our overlay
|
||||
if (filePath === '/var/lib/headplane/' || filePath === '/var/lib/headplane') {
|
||||
return Promise.resolve();
|
||||
}
|
||||
return originalAsyncAccess.call(this, filePath, mode);
|
||||
};
|
||||
Reference in New Issue
Block a user