WIP: nixos/caddy: validate config on build by default #380894
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
6.topic: nixos
6543
force-pushed
the
caddy_validate-config-on-build
branch
from
7e2bddf to
e9425cc
Compare
6543
force-pushed
the
caddy_validate-config-on-build
branch
from
e9425cc to
07dfc55
Compare
github-actions
bot
added
10.rebuild-darwin: 0
ambroisie
reviewed
Feb 10, 2025
Comment on lines
+74
to
+94
| validateCaddyConfig = | ||
| adapter: configFile: | ||
| builtins.fromJSON ( | ||
| builtins.readFile ( | ||
| pkgs.runCommand "caddy-validate" | ||
| { | ||
| nativeBuildInputs = [ cfg.package ]; | ||
| } | ||
| '' | ||
| if caddy validate --adapter ${toString adapter} --config ${configFile}; then | ||
| echo "true" > $out | ||
| else | ||
| echo "false" > $out | ||
| fi | ||
| '' | ||
| ) | ||
| ); | ||
|
|
||
| configValidationResult = validateCaddyConfig ( | ||
| if cfg.adapter != null then cfg.adapter else "caddyfile" | ||
| ) cfg.configFile; |
There was a problem hiding this comment.
Import From Derivation (IFD) is actively discouraged. I'd encourage you to implement this similar to services.nginx (through the use of pkgs.writes.writeNginxConfig) which writes the configuration file as part of the derivation, but fails to build if it is incorrent.
ambroisie
reviewed
Feb 10, 2025
| @@ -378,6 +400,16 @@ in | |||
| [here](https://caddyserver.com/docs/caddyfile/concepts#environment-variables) | |||
| ''; | |||
| }; | |||
|
|
|||
| enforceConfigValidation = mkOption { | |||
There was a problem hiding this comment.
Nit: for consistency with Nginx, I'd name this option validateConfigFile.
6543
changed the title
6543
commented
Feb 10, 2025
| webserver.wait_for_unit("caddy") | ||
|
|
||
| with subtest("invalid config fails build when validation is enforced"): | ||
| webserver.fail( |
There was a problem hiding this comment.
todo: the build is expect to fail ... so i need to check against that differently ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds
enforceConfigValidationoption (default: true) to validate Caddyconfigurations during system build. This catches configuration errors early
in the deployment pipeline, improving reliability and security of Caddy
deployments.
Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 👍 reaction to pull requests you find important.