alioth/nixpkgs
3
0
Fork 0
forked from mirrors/nixpkgs
Code Releases Activity

stdenv-generic: add meta attribute checking

Browse source 
This is turned off by default but I think we should fix all packages to
respect it and then turn it on by default
This commit is contained in:
Dan Peebles 2017-04-28 18:01:52 -04:00
parent ce6eb0cbbe
commit 32ae4bfc20
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
pkgs/stdenv/generic/default.nix
View file

@ -18,6 +18,8 @@ let lib = import ../../../lib; in lib.makeOverridable (
let let
shouldCheckMeta = config.checkMeta or false;
allowUnfree = config.allowUnfree or false || builtins.getEnv "NIXPKGS_ALLOW_UNFREE" == "1"; allowUnfree = config.allowUnfree or false || builtins.getEnv "NIXPKGS_ALLOW_UNFREE" == "1";
whitelist = config.whitelistedLicenses or []; whitelist = config.whitelistedLicenses or [];
@ -151,6 +153,7 @@ let
broken = remediate_whitelist "Broken"; broken = remediate_whitelist "Broken";
blacklisted = x: ""; blacklisted = x: "";
insecure = remediate_insecure; insecure = remediate_insecure;
unknown-meta = x: "";
}; };
remediate_whitelist = allow_attr: attrs: remediate_whitelist = allow_attr: attrs:
'' ''
@ -202,6 +205,32 @@ let
'' + ((builtins.getAttr reason remediation) attrs)); '' + ((builtins.getAttr reason remediation) attrs));
metaTypes = with lib.types; {
# These keys are documented
description = str;
longDescription = str;
branch = str;
homepage = str;
downloadPage = str;
license = either (listOf lib.types.attrs) lib.types.attrs;
maintainers = listOf str;
priority = int;
platforms = listOf str;
hydraPlatforms = listOf str;
broken = bool;
# Weirder stuff that doesn't appear in the documentation?
version = str;
updateWalker = bool;
executables = listOf str;
};
checkMetaAttr = k: v:
if metaTypes?${k} then
if metaTypes.${k}.check v then null else "key '${k}' has a value of an invalid type; expected ${metaTypes.${k}.description}"
else "key '${k}' is unrecognized; expected one of: \n\t [${lib.concatMapStringsSep ", " (x: "'${x}'") (lib.attrNames metaTypes)}]";
checkMeta = meta: if shouldCheckMeta then lib.remove null (lib.mapAttrsToList checkMetaAttr meta) else [];
# Check if a derivation is valid, that is whether it passes checks for # Check if a derivation is valid, that is whether it passes checks for
# e.g brokenness or license. # e.g brokenness or license.
# #
@ -219,6 +248,8 @@ let
{ valid = false; reason = "broken"; errormsg = "is not supported on ‘${result.system}’"; } { valid = false; reason = "broken"; errormsg = "is not supported on ‘${result.system}’"; }
else if !(hasAllowedInsecure attrs) then else if !(hasAllowedInsecure attrs) then
{ valid = false; reason = "insecure"; errormsg = "is marked as insecure"; } { valid = false; reason = "insecure"; errormsg = "is marked as insecure"; }
else let res = checkMeta (attrs.meta or {}); in if res != [] then
{ valid = false; reason = "unknown-meta"; errormsg = "has an invalid meta attrset:${lib.concatMapStrings (x: "\n\t - " + x) res}"; }
else { valid = true; }; else { valid = true; };
outputs' = outputs' =