buildDubPackage: split into hooks and into importDubLock (#344744)

This commit is contained in:
Philip Taron
2025-08-29 06:14:36 -07:00
committed by GitHub
9 changed files with 207 additions and 125 deletions
@@ -1,148 +1,71 @@
{
lib,
stdenv,
fetchurl,
fetchgit,
linkFarm,
dub,
importDubLock,
dubSetupHook,
dubBuildHook,
dubCheckHook,
ldc,
removeReferencesTo,
}:
# See https://nixos.org/manual/nixpkgs/unstable#dlang for more detailed usage information
lib.extendMkDerivation {
constructDrv = stdenv.mkDerivation;
{
# A lockfile generated by `dub-to-nix` from the source of the package.
# Can be either a path to the file, or an attrset already parsed with `lib.importJSON`.
dubLock,
# The build type to pass to `dub build` as a value for the `--build=` flag.
dubBuildType ? "release",
# The flags to pass to `dub build` and `dub test`.
dubFlags ? [ ],
# The flags to pass to `dub build`.
dubBuildFlags ? [ ],
# The flags to pass to `dub test`.
dubTestFlags ? [ ],
# The D compiler to be used by `dub`.
compiler ? ldc,
...
}@args:
excludeDrvArgNames = [
"dubLock"
"compiler"
];
let
makeDubDep =
extendDrvArgs =
finalAttrs:
{
pname,
version,
sha256,
}:
# A lockfile generated by `dub-to-nix` from the source of the package.
# Can be either a path to the file, or an attrset already parsed with `lib.importJSON`.
dubLock,
compiler ? ldc,
...
}@args:
{
inherit pname version;
src = fetchurl {
name = "dub-${pname}-${version}.zip";
url = "mirror://dub/${pname}/${version}.zip";
inherit sha256;
dubDeps = importDubLock {
inherit (finalAttrs) pname version;
lock = dubLock;
};
};
makeGitDep =
{
pname,
version,
repository,
sha256,
}:
{
inherit pname version;
src = fetchgit {
url = repository;
rev = version;
inherit sha256;
};
};
strictDeps = args.strictDeps or true;
lockJson = if lib.isPath dubLock then lib.importJSON dubLock else dubLock;
depsRaw = lib.mapAttrsToList (pname: args: { inherit pname; } // args) lockJson.dependencies;
nativeBuildInputs = args.nativeBuildInputs or [ ] ++ [
dubSetupHook
(dubBuildHook.override { inherit dub; })
compiler
removeReferencesTo
];
dubDeps = map makeDubDep (lib.filter (args: !(args ? repository)) depsRaw);
gitDeps = map makeGitDep (lib.filter (args: args ? repository) depsRaw);
# a directory with multiple single element registries
# one big directory with all .zip files leads to version parsing errors
# when the name of a package is a prefix of the name of another package
dubRegistryBase = linkFarm "dub-registry-base" (
map (dep: {
name = "${dep.pname}/${dep.pname}-${dep.version}.zip";
path = dep.src;
}) dubDeps
);
combinedFlags = "--skip-registry=all --compiler=${lib.getExe compiler} ${toString dubFlags}";
combinedBuildFlags = "${combinedFlags} --build=${dubBuildType} ${toString dubBuildFlags}";
combinedTestFlags = "${combinedFlags} ${toString dubTestFlags}";
in
stdenv.mkDerivation (
builtins.removeAttrs args [ "dubLock" ]
// {
strictDeps = args.strictDeps or true;
nativeBuildInputs = args.nativeBuildInputs or [ ] ++ [
dub
compiler
removeReferencesTo
];
configurePhase =
args.configurePhase or ''
configurePhase = ''
runHook preConfigure
export DUB_HOME="$NIX_BUILD_TOP/.dub"
mkdir -p "$DUB_HOME"
# register dub dependencies
${lib.concatMapStringsSep "\n" (dep: ''
dub fetch ${dep.pname}@${dep.version} --cache=user --skip-registry=standard --registry=file://${dubRegistryBase}/${dep.pname}
'') dubDeps}
# register git dependencies
${lib.concatMapStringsSep "\n" (dep: ''
mkdir -p "$DUB_HOME/packages/${dep.pname}/${dep.version}"
cp -r --no-preserve=all ${dep.src} "$DUB_HOME/packages/${dep.pname}/${dep.version}/${dep.pname}"
'') gitDeps}
dubFlags+=("--compiler=${lib.getExe compiler}")
runHook postConfigure
'';
buildPhase =
args.buildPhase or ''
runHook preBuild
doCheck = args.doCheck or false;
dub build ${combinedBuildFlags}
nativeCheckInputs = [
(dubCheckHook.override { inherit dub; })
];
runHook postBuild
preFixup = ''
${args.preFixup or ""}
find "$out" -type f -exec remove-references-to -t ${compiler} '{}' +
'';
doCheck = args.doCheck or false;
disallowedReferences = args.disallowedReferences or [ compiler ];
checkPhase =
args.checkPhase or ''
runHook preCheck
dub test ${combinedTestFlags}
runHook postCheck
'';
preFixup = ''
${args.preFixup or ""}
find "$out" -type f -exec remove-references-to -t ${compiler} '{}' +
'';
disallowedReferences = [ compiler ];
meta = {
platforms = dub.meta.platforms;
}
// args.meta or { };
}
)
meta = {
platforms = dub.meta.platforms;
}
// args.meta or { };
};
}
@@ -0,0 +1,26 @@
{ callPackage }:
{
dubSetupHook = callPackage (
{ makeSetupHook }:
makeSetupHook {
name = "dub-setup-hook";
} ./dub-setup-hook.sh
) { };
dubBuildHook = callPackage (
{ makeSetupHook, dub }:
makeSetupHook {
name = "dub-build-hook";
propagatedBuildInputs = [ dub ];
} ./dub-build-hook.sh
) { };
dubCheckHook = callPackage (
{ makeSetupHook, dub }:
makeSetupHook {
name = "dub-check-hook";
propagatedBuildInputs = [ dub ];
} ./dub-check-hook.sh
) { };
}
@@ -0,0 +1,13 @@
dubBuildHook() {
runHook preBuild
echo "Executing dubBuildHook"
dub build --skip-registry=all --build="${dubBuildType-"release"}" "${dubBuildFlags[@]}" "${dubFlags[@]}"
echo "Finished dubBuildHook"
runHook postBuild
}
if [[ -z "${dontDubBuild-}" && -z "${buildPhase-}" ]]; then
buildPhase=dubBuildHook
fi
@@ -0,0 +1,13 @@
dubCheckHook() {
runHook preCheck
echo "Executing dubCheckHook"
dub test --skip-registry=all "${dubTestFlags[@]}" "${dubFlags[@]}"
echo "Finished dubCheckHook"
runHook postCheck
}
if [[ -z "${dontDubCheck-}" && -z "${checkPhase-}" ]]; then
checkPhase=dubCheckHook
fi
@@ -0,0 +1,19 @@
dubSetupHook() {
echo "Executing dubSetupHook"
if [ -z "${dubDeps-}" ]; then
echo "Error: 'dubDeps' must be set when using dubSetupHook."
exit 1
fi
export DUB_HOME="$NIX_BUILD_TOP"/.dub
echo "Configuring \$DUB_HOME ($DUB_HOME)"
cp -Tr "$dubDeps"/.dub "$NIX_BUILD_TOP"/.dub
chmod -R +w "$DUB_HOME"
echo "Finished dubSetupHook"
}
if [ -z "${dontDubSetup-}" ]; then
postPatchHooks+=(dubSetupHook)
fi
@@ -0,0 +1,81 @@
{
lib,
runCommand,
linkFarm,
fetchurl,
fetchgit,
dub,
}:
{
pname,
version,
lock,
}:
let
makeDubDep =
{
pname,
version,
sha256,
}:
{
inherit pname version;
src = fetchurl {
name = "dub-${pname}-${version}.zip";
url = "mirror://dub/${pname}/${version}.zip";
inherit sha256;
};
};
makeGitDep =
{
pname,
version,
repository,
sha256,
}:
{
inherit pname version;
src = fetchgit {
url = repository;
rev = version;
inherit sha256;
};
};
lockJson = if lib.isPath lock then lib.importJSON lock else lock;
depsRaw = lib.mapAttrsToList (pname: args: { inherit pname; } // args) lockJson.dependencies;
dubDeps = map makeDubDep (lib.filter (args: !(args ? repository)) depsRaw);
gitDeps = map makeGitDep (lib.filter (args: args ? repository) depsRaw);
# a directory with multiple single element registries
# one big directory with all .zip files leads to version parsing errors
# when the name of a package is a prefix of the name of another package
dubRegistryBase = linkFarm "dub-registry-base" (
map (dep: {
name = "${dep.pname}/${dep.pname}-${dep.version}.zip";
path = dep.src;
}) dubDeps
);
in
runCommand "${pname}-${version}-dub-deps"
{
nativeBuildInputs = [ dub ];
}
''
export DUB_HOME="$out/.dub"
mkdir -p "$DUB_HOME"
# register dub dependencies
${lib.concatMapStringsSep "\n" (dep: ''
dub fetch ${dep.pname}@${dep.version} --cache=user --skip-registry=standard --registry=file://${dubRegistryBase}/${dep.pname}
'') dubDeps}
# register git dependencies
${lib.concatMapStringsSep "\n" (dep: ''
mkdir -p "$DUB_HOME/packages/${dep.pname}/${dep.version}"
cp -r --no-preserve=all ${dep.src} "$DUB_HOME/packages/${dep.pname}/${dep.version}/${dep.pname}"
'') gitDeps}
''
+4 -1
View File
@@ -1,5 +1,8 @@
{ callPackage }:
{
buildDubPackage = callPackage ./builddubpackage { };
dub-to-nix = callPackage ./dub-to-nix { };
importDubLock = callPackage ./builddubpackage/import-dub-lock.nix { };
buildDubPackage = callPackage ./builddubpackage { };
}
// import ./builddubpackage/hooks { inherit callPackage; }
View File
+5 -1
View File
@@ -2721,8 +2721,12 @@ with pkgs;
dsview = libsForQt5.callPackage ../applications/science/electronics/dsview { };
inherit (import ../build-support/dlang/dub-support.nix { inherit callPackage; })
buildDubPackage
dub-to-nix
importDubLock
buildDubPackage
dubSetupHook
dubBuildHook
dubCheckHook
;
dvtm = callPackage ../tools/misc/dvtm {