mirror of
https://github.com/Dokploy/dokploy.git
synced 2026-07-21 13:55:33 +02:00
1df6774ee8
- Replaced `forwardAuthProviderId` with `forwardAuthEnabled` in the domain schema to simplify the configuration of forward authentication. - Updated related tests to reflect this change, ensuring consistency across the application. - Introduced a new SQL migration to create the `forward_auth_settings` table for managing authentication domains and their configurations. This refactor enhances the clarity and maintainability of the forward authentication logic within the application.
547 lines
16 KiB
TypeScript
547 lines
16 KiB
TypeScript
import type { Domain } from "@dokploy/server";
|
|
import { createDomainLabels } from "@dokploy/server";
|
|
import { describe, expect, it } from "vitest";
|
|
|
|
describe("createDomainLabels", () => {
|
|
const appName = "test-app";
|
|
const baseDomain: Domain = {
|
|
host: "example.com",
|
|
port: 8080,
|
|
customEntrypoint: null,
|
|
https: false,
|
|
uniqueConfigKey: 1,
|
|
customCertResolver: null,
|
|
certificateType: "none",
|
|
applicationId: "",
|
|
composeId: "",
|
|
domainType: "compose",
|
|
serviceName: "test-app",
|
|
domainId: "",
|
|
path: "/",
|
|
createdAt: "",
|
|
previewDeploymentId: "",
|
|
internalPath: "/",
|
|
stripPath: false,
|
|
middlewares: null,
|
|
forwardAuthEnabled: false,
|
|
};
|
|
|
|
it("should create basic labels for web entrypoint", async () => {
|
|
const labels = await createDomainLabels(appName, baseDomain, "web");
|
|
expect(labels).toEqual([
|
|
"traefik.http.routers.test-app-1-web.rule=Host(`example.com`)",
|
|
"traefik.http.routers.test-app-1-web.entrypoints=web",
|
|
"traefik.http.services.test-app-1-web.loadbalancer.server.port=8080",
|
|
"traefik.http.routers.test-app-1-web.service=test-app-1-web",
|
|
]);
|
|
});
|
|
|
|
it("should create labels for websecure entrypoint", async () => {
|
|
const labels = await createDomainLabels(appName, baseDomain, "websecure");
|
|
expect(labels).toEqual([
|
|
"traefik.http.routers.test-app-1-websecure.rule=Host(`example.com`)",
|
|
"traefik.http.routers.test-app-1-websecure.entrypoints=websecure",
|
|
"traefik.http.services.test-app-1-websecure.loadbalancer.server.port=8080",
|
|
"traefik.http.routers.test-app-1-websecure.service=test-app-1-websecure",
|
|
]);
|
|
});
|
|
|
|
it("should add the path prefix if is different than / empty", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{
|
|
...baseDomain,
|
|
path: "/hello",
|
|
},
|
|
"websecure",
|
|
);
|
|
|
|
expect(labels).toEqual([
|
|
"traefik.http.routers.test-app-1-websecure.rule=Host(`example.com`) && PathPrefix(`/hello`)",
|
|
"traefik.http.routers.test-app-1-websecure.entrypoints=websecure",
|
|
"traefik.http.services.test-app-1-websecure.loadbalancer.server.port=8080",
|
|
"traefik.http.routers.test-app-1-websecure.service=test-app-1-websecure",
|
|
]);
|
|
});
|
|
|
|
it("should add redirect middleware for https on web entrypoint", async () => {
|
|
const httpsBaseDomain = { ...baseDomain, https: true };
|
|
const labels = await createDomainLabels(appName, httpsBaseDomain, "web");
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=redirect-to-https@file",
|
|
);
|
|
});
|
|
|
|
it("should add Let's Encrypt configuration for websecure with letsencrypt certificate", async () => {
|
|
const letsencryptDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
certificateType: "letsencrypt" as const,
|
|
};
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
letsencryptDomain,
|
|
"websecure",
|
|
);
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-websecure.tls.certresolver=letsencrypt",
|
|
);
|
|
});
|
|
|
|
it("should not add Let's Encrypt configuration for non-letsencrypt certificate", async () => {
|
|
const nonLetsencryptDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
certificateType: "none" as const,
|
|
};
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
nonLetsencryptDomain,
|
|
"websecure",
|
|
);
|
|
expect(labels).not.toContain(
|
|
"traefik.http.routers.test-app-1-websecure.tls.certresolver=letsencrypt",
|
|
);
|
|
});
|
|
|
|
it("should add tls=true for certificateType none on websecure entrypoint", async () => {
|
|
const noneDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
certificateType: "none" as const,
|
|
};
|
|
const labels = await createDomainLabels(appName, noneDomain, "websecure");
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-websecure.tls=true",
|
|
);
|
|
// no cert resolver should be set when relying on a default/custom cert
|
|
expect(labels).not.toContain(
|
|
"traefik.http.routers.test-app-1-websecure.tls.certresolver=letsencrypt",
|
|
);
|
|
});
|
|
|
|
it("should not add tls=true for certificateType none on web entrypoint", async () => {
|
|
const noneDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
certificateType: "none" as const,
|
|
};
|
|
const labels = await createDomainLabels(appName, noneDomain, "web");
|
|
expect(labels).not.toContain(
|
|
"traefik.http.routers.test-app-1-web.tls=true",
|
|
);
|
|
});
|
|
|
|
it("should add tls=true for certificateType none on a custom https entrypoint", async () => {
|
|
const noneDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
customEntrypoint: "websecure-custom",
|
|
certificateType: "none" as const,
|
|
};
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
noneDomain,
|
|
"websecure-custom",
|
|
);
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-websecure-custom.tls=true",
|
|
);
|
|
});
|
|
|
|
it("should handle different ports correctly", async () => {
|
|
const customPortDomain = { ...baseDomain, port: 3000 };
|
|
const labels = await createDomainLabels(appName, customPortDomain, "web");
|
|
expect(labels).toContain(
|
|
"traefik.http.services.test-app-1-web.loadbalancer.server.port=3000",
|
|
);
|
|
});
|
|
|
|
it("should add stripPath middleware when stripPath is enabled", async () => {
|
|
const stripPathDomain = {
|
|
...baseDomain,
|
|
path: "/api",
|
|
stripPath: true,
|
|
};
|
|
const labels = await createDomainLabels(appName, stripPathDomain, "web");
|
|
|
|
expect(labels).toContain(
|
|
"traefik.http.middlewares.stripprefix-test-app-1.stripprefix.prefixes=/api",
|
|
);
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=stripprefix-test-app-1",
|
|
);
|
|
});
|
|
|
|
it("should add internalPath middleware when internalPath is set", async () => {
|
|
const internalPathDomain = {
|
|
...baseDomain,
|
|
internalPath: "/hello",
|
|
};
|
|
const webLabels = await createDomainLabels(
|
|
appName,
|
|
internalPathDomain,
|
|
"web",
|
|
);
|
|
const websecureLabels = await createDomainLabels(
|
|
appName,
|
|
internalPathDomain,
|
|
"websecure",
|
|
);
|
|
|
|
// Middleware definition should only appear in web entrypoint
|
|
expect(webLabels).toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
expect(websecureLabels).not.toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
|
|
// Both routers should reference the middleware
|
|
expect(webLabels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=addprefix-test-app-1",
|
|
);
|
|
expect(websecureLabels).toContain(
|
|
"traefik.http.routers.test-app-1-websecure.middlewares=addprefix-test-app-1",
|
|
);
|
|
});
|
|
|
|
it("should combine HTTPS redirect with internalPath middleware in correct order", async () => {
|
|
const combinedDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
internalPath: "/hello",
|
|
};
|
|
const webLabels = await createDomainLabels(appName, combinedDomain, "web");
|
|
const websecureLabels = await createDomainLabels(
|
|
appName,
|
|
combinedDomain,
|
|
"websecure",
|
|
);
|
|
|
|
// Web entrypoint with HTTPS should only have redirect
|
|
expect(webLabels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=redirect-to-https@file",
|
|
);
|
|
|
|
// Websecure should have the addprefix middleware
|
|
expect(websecureLabels).toContain(
|
|
"traefik.http.routers.test-app-1-websecure.middlewares=addprefix-test-app-1",
|
|
);
|
|
|
|
// Middleware definition should only appear once (in web)
|
|
expect(webLabels).toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
expect(websecureLabels).not.toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
});
|
|
|
|
it("should combine all middlewares in correct order", async () => {
|
|
const fullDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
path: "/api",
|
|
stripPath: true,
|
|
internalPath: "/hello",
|
|
};
|
|
const webLabels = await createDomainLabels(appName, fullDomain, "web");
|
|
|
|
// Should have all middleware definitions (only in web)
|
|
expect(webLabels).toContain(
|
|
"traefik.http.middlewares.stripprefix-test-app-1.stripprefix.prefixes=/api",
|
|
);
|
|
expect(webLabels).toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
|
|
// Web router with HTTPS should only have redirect
|
|
expect(webLabels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=redirect-to-https@file",
|
|
);
|
|
});
|
|
|
|
it("should not add middleware definitions for websecure entrypoint", async () => {
|
|
const internalPathDomain = {
|
|
...baseDomain,
|
|
path: "/api",
|
|
stripPath: true,
|
|
internalPath: "/hello",
|
|
};
|
|
const websecureLabels = await createDomainLabels(
|
|
appName,
|
|
internalPathDomain,
|
|
"websecure",
|
|
);
|
|
|
|
// Should not contain any middleware definitions
|
|
expect(websecureLabels).not.toContain(
|
|
"traefik.http.middlewares.stripprefix-test-app-1.stripprefix.prefixes=/api",
|
|
);
|
|
expect(websecureLabels).not.toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
|
|
// But should reference the middlewares
|
|
expect(websecureLabels).toContain(
|
|
"traefik.http.routers.test-app-1-websecure.middlewares=stripprefix-test-app-1,addprefix-test-app-1",
|
|
);
|
|
});
|
|
|
|
it("should add single custom middleware to router", async () => {
|
|
const customMiddlewareDomain = {
|
|
...baseDomain,
|
|
middlewares: ["auth@file"],
|
|
};
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
customMiddlewareDomain,
|
|
"web",
|
|
);
|
|
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=auth@file",
|
|
);
|
|
});
|
|
|
|
it("should add multiple custom middlewares to router", async () => {
|
|
const customMiddlewareDomain = {
|
|
...baseDomain,
|
|
middlewares: ["auth@file", "rate-limit@file"],
|
|
};
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
customMiddlewareDomain,
|
|
"web",
|
|
);
|
|
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=auth@file,rate-limit@file",
|
|
);
|
|
});
|
|
|
|
it("should only have redirect on web router when HTTPS is enabled with custom middlewares", async () => {
|
|
const combinedDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
middlewares: ["auth@file"],
|
|
};
|
|
const labels = await createDomainLabels(appName, combinedDomain, "web");
|
|
|
|
// Web router with HTTPS should only redirect, custom middlewares go on websecure
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=redirect-to-https@file",
|
|
);
|
|
expect(labels).not.toContain("auth@file");
|
|
});
|
|
|
|
it("should combine custom middlewares with stripPath middleware (no HTTPS)", async () => {
|
|
const combinedDomain = {
|
|
...baseDomain,
|
|
path: "/api",
|
|
stripPath: true,
|
|
middlewares: ["auth@file"],
|
|
};
|
|
const labels = await createDomainLabels(appName, combinedDomain, "web");
|
|
|
|
// stripprefix should come before custom middleware
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=stripprefix-test-app-1,auth@file",
|
|
);
|
|
});
|
|
|
|
it("should only have redirect on web router even with all built-in middlewares and custom middlewares", async () => {
|
|
const fullDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
path: "/api",
|
|
stripPath: true,
|
|
internalPath: "/hello",
|
|
middlewares: ["auth@file", "rate-limit@file"],
|
|
};
|
|
const webLabels = await createDomainLabels(appName, fullDomain, "web");
|
|
|
|
// Web router with HTTPS should only redirect
|
|
expect(webLabels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=redirect-to-https@file",
|
|
);
|
|
// Middleware definitions should still be present (Traefik needs them registered)
|
|
expect(webLabels).toContain(
|
|
"traefik.http.middlewares.stripprefix-test-app-1.stripprefix.prefixes=/api",
|
|
);
|
|
expect(webLabels).toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
// But they should NOT be attached to the router
|
|
expect(webLabels).not.toContain("stripprefix-test-app-1,");
|
|
expect(webLabels).not.toContain("auth@file");
|
|
expect(webLabels).not.toContain("rate-limit@file");
|
|
});
|
|
|
|
it("should include custom middlewares on websecure entrypoint", async () => {
|
|
const customMiddlewareDomain = {
|
|
...baseDomain,
|
|
https: true,
|
|
middlewares: ["auth@file"],
|
|
};
|
|
const websecureLabels = await createDomainLabels(
|
|
appName,
|
|
customMiddlewareDomain,
|
|
"websecure",
|
|
);
|
|
|
|
// Websecure should have custom middleware but not redirect-to-https
|
|
expect(websecureLabels).toContain(
|
|
"traefik.http.routers.test-app-1-websecure.middlewares=auth@file",
|
|
);
|
|
expect(websecureLabels).not.toContain("redirect-to-https");
|
|
});
|
|
|
|
it("should NOT include custom middlewares on web router when HTTPS is enabled (only redirect)", async () => {
|
|
const domain = {
|
|
...baseDomain,
|
|
https: true,
|
|
middlewares: ["rate-limit@file", "auth@file"],
|
|
};
|
|
const webLabels = await createDomainLabels(appName, domain, "web");
|
|
|
|
// Web router with HTTPS should ONLY have redirect, not custom middlewares
|
|
expect(webLabels).toContain(
|
|
"traefik.http.routers.test-app-1-web.middlewares=redirect-to-https@file",
|
|
);
|
|
expect(webLabels).not.toContain("rate-limit@file");
|
|
expect(webLabels).not.toContain("auth@file");
|
|
});
|
|
|
|
it("should create basic labels for custom entrypoint", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{ ...baseDomain, customEntrypoint: "custom" },
|
|
"custom",
|
|
);
|
|
expect(labels).toEqual([
|
|
"traefik.http.routers.test-app-1-custom.rule=Host(`example.com`)",
|
|
"traefik.http.routers.test-app-1-custom.entrypoints=custom",
|
|
"traefik.http.services.test-app-1-custom.loadbalancer.server.port=8080",
|
|
"traefik.http.routers.test-app-1-custom.service=test-app-1-custom",
|
|
]);
|
|
});
|
|
|
|
it("should create https labels for custom entrypoint", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{
|
|
...baseDomain,
|
|
https: true,
|
|
customEntrypoint: "custom",
|
|
certificateType: "letsencrypt",
|
|
},
|
|
"custom",
|
|
);
|
|
expect(labels).toEqual([
|
|
"traefik.http.routers.test-app-1-custom.rule=Host(`example.com`)",
|
|
"traefik.http.routers.test-app-1-custom.entrypoints=custom",
|
|
"traefik.http.services.test-app-1-custom.loadbalancer.server.port=8080",
|
|
"traefik.http.routers.test-app-1-custom.service=test-app-1-custom",
|
|
"traefik.http.routers.test-app-1-custom.tls.certresolver=letsencrypt",
|
|
]);
|
|
});
|
|
|
|
it("should add stripPath middleware for custom entrypoint", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{
|
|
...baseDomain,
|
|
customEntrypoint: "custom",
|
|
path: "/api",
|
|
stripPath: true,
|
|
},
|
|
"custom",
|
|
);
|
|
|
|
expect(labels).toContain(
|
|
"traefik.http.middlewares.stripprefix-test-app-1.stripprefix.prefixes=/api",
|
|
);
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-custom.middlewares=stripprefix-test-app-1",
|
|
);
|
|
});
|
|
|
|
it("should add internalPath middleware for custom entrypoint", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{
|
|
...baseDomain,
|
|
customEntrypoint: "custom",
|
|
internalPath: "/hello",
|
|
},
|
|
"custom",
|
|
);
|
|
|
|
expect(labels).toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-custom.middlewares=addprefix-test-app-1",
|
|
);
|
|
});
|
|
|
|
it("should add path prefix in rule for custom entrypoint", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{
|
|
...baseDomain,
|
|
customEntrypoint: "custom",
|
|
path: "/api",
|
|
},
|
|
"custom",
|
|
);
|
|
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-custom.rule=Host(`example.com`) && PathPrefix(`/api`)",
|
|
);
|
|
});
|
|
|
|
it("should combine all middlewares for custom entrypoint", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{
|
|
...baseDomain,
|
|
customEntrypoint: "custom",
|
|
path: "/api",
|
|
stripPath: true,
|
|
internalPath: "/hello",
|
|
},
|
|
"custom",
|
|
);
|
|
|
|
expect(labels).toContain(
|
|
"traefik.http.middlewares.stripprefix-test-app-1.stripprefix.prefixes=/api",
|
|
);
|
|
expect(labels).toContain(
|
|
"traefik.http.middlewares.addprefix-test-app-1.addprefix.prefix=/hello",
|
|
);
|
|
expect(labels).toContain(
|
|
"traefik.http.routers.test-app-1-custom.middlewares=stripprefix-test-app-1,addprefix-test-app-1",
|
|
);
|
|
});
|
|
|
|
it("should not add redirect-to-https for custom entrypoint even with https", async () => {
|
|
const labels = await createDomainLabels(
|
|
appName,
|
|
{
|
|
...baseDomain,
|
|
customEntrypoint: "custom",
|
|
https: true,
|
|
certificateType: "letsencrypt",
|
|
},
|
|
"custom",
|
|
);
|
|
|
|
const middlewareLabel = labels.find((l) => l.includes(".middlewares="));
|
|
// Should not contain redirect-to-https since there's only one router
|
|
expect(middlewareLabel).toBeUndefined();
|
|
});
|
|
});
|