Crate specific overrides (eg. building OpenSSL without errors out of the box)

README.md

@@ -267,6 +267,7 @@ Note that you shouldn't call `overrideAttrs` on a derivation built by Naersk
 | `postInstall` | Optional hook to run after the compilation is done; inside this script, `$out/bin` contains compiled Rust binaries. Useful if your application needs e.g. custom environment variables, in which case you can simply run `wrapProgram $out/bin/your-app-name` in here. Default: `false` |
 | `usePureFromTOML` | Whether to use the `fromTOML` built-in or not. When set to `false` the python package `remarshal` is used instead (in a derivation) and the JSON output is read with `builtins.fromJSON`. This is a workaround for old versions of Nix. May be used safely from Nix 2.3 onwards where all bugs in `builtins.fromTOML` seem to have been fixed. Default: `true` |
 | `mode` | What to do when building the derivation. Either `build`, `check`, `test`, `fmt` or `clippy`. <br/> When set to something other than `build`, no binaries are generated. Default: `"build"` |
+| `autoCrateSpecificOverrides` | Whether to automatically apply crate-specific overrides, mainly additional `buildInputs` for dependencies. <br /> For example, if you use the `openssl` crate, `pkgs.pkg-config` and `pkgs.openssl` are automatically added as buildInputs. Default: `true` |
 
 
 ### Note on `overrideAttrs`
@@ -397,16 +398,3 @@ naersk.buildPackage {
 ```
 
 ([context](https://github.com/nix-community/naersk/pull/288))
-
-### Using OpenSSL
-
-If your application uses OpenSSL (making the build process fail), try:
-
-```nix
-naersk.buildPackage {
-  # ...
-
-  nativeBuildInputs = with pkgs; [ pkg-config ];
-  buildInputs = with pkgs; [ openssl ];
-}
-```

README.tpl.md

@@ -359,16 +359,3 @@ naersk.buildPackage {
 ```
 
 ([context](https://github.com/nix-community/naersk/pull/288))
-
-### Using OpenSSL
-
-If your application uses OpenSSL (making the build process fail), try:
-
-```nix
-naersk.buildPackage {
-  # ...
-
-  nativeBuildInputs = with pkgs; [ pkg-config ];
-  buildInputs = with pkgs; [ openssl ];
-}
-```

build.nix

@@ -68,6 +68,10 @@
 , fetchurl
 , lndir
 , userAttrs
+  #| Some additional buildInputs/overrides individual crates require
+, crateSpecificOverrides
+, autoCrateSpecificOverrides
+, pkgs
 }:
 
 let
@@ -130,14 +134,16 @@ let
       jq
       rsync
     ] ++ nativeBuildInputs
-      ++ lib.optionals (mode == "clippy") [clippy];
+      ++ lib.optionals (mode == "clippy") [clippy]
+      ++ neededCrateSpecificOverrides.nativeBuildInputs;
 
     buildInputs = lib.optionals stdenv.isDarwin [
       darwin.Security
       darwin.apple_sdk.frameworks.CoreServices
       darwin.cf-private
       darwin.libiconv
-    ] ++ buildInputs;
+    ] ++ buildInputs
+      ++ neededCrateSpecificOverrides.buildInputs;
 
     inherit builtDependencies;
 
@@ -374,6 +380,33 @@ let
     };
   };
 
+  # Crate-specific overrides needed for this build.
+  # They are merged from all the overrides of `cratesIoDependencies` defined in the `crate_specific.nix` file
+  #
+  # This can contain fields: `buildInputs`, `nativeBuildInputs`
+  # When changing them (eg. adding support for new ones/removing some), also update the comment in the `crate_specific.nix` file
+  neededCrateSpecificOverrides =
+    let
+      overridesList = builtins.map
+        ( crateInfo:
+          if builtins.hasAttr crateInfo.name crateSpecificOverrides then
+            crateSpecificOverrides.${crateInfo.name} { inherit crateInfo; }
+          else {}
+        )
+        cratesIoDependencies;
+      emptyOverrides = { buildInputs = []; nativeBuildInputs = []; };
+    in if autoCrateSpecificOverrides then
+      builtins.foldl'
+        (acc: elem:
+          {
+            buildInputs =       acc.buildInputs       ++ elem.buildInputs or [];
+            nativeBuildInputs = acc.nativeBuildInputs ++ elem.nativeBuildInputs or [];
+          }
+        )
+        emptyOverrides
+        overridesList
+      else emptyOverrides;
+
   # Crates.io dependencies required to compile user's crate.
   #
   # As an output, for each dependency, this derivation produces a subdirectory

config.nix

@@ -1,4 +1,4 @@
-{ lib, libb, builtinz, arg }:
+{ lib, libb, builtinz, arg, pkgs }:
 let
   allowFun = attrs0: attrName: default:
     if builtins.hasAttr attrName attrs0 then
@@ -200,6 +200,12 @@ let
     # What to do when building the derivation. Either `build`, `check`, `test`, `fmt` or `clippy`. <br/>
     # When set to something other than `build`, no binaries are generated.
     mode = attrs0.mode or "build";
+
+    # Whether to automatically apply crate-specific overrides, mainly additional
+    # `buildInputs` for dependencies. <br />
+    # For example, if you use the `openssl` crate, `pkgs.pkg-config` and
+    # `pkgs.openssl` are automatically added as buildInputs.
+    autoCrateSpecificOverrides = attrs0.autoCrateSpecificOverrides or true;
   };
 
   argIsAttrs =
@@ -302,6 +308,7 @@ let
       cargoDocOptions
       copyDocsToSeparateOutput
       removeReferencesToSrcFromDocs
+      autoCrateSpecificOverrides
 
       postInstall
       ;
@@ -311,6 +318,8 @@ let
     # Example:
     #   [ { name = "wabt", version = "2.0.6", sha256 = "..." } ]
     cratesIoDependencies = libb.mkVersions buildPlanConfig.cargolock;
+
+    crateSpecificOverrides = import ./crate_specific.nix { inherit pkgs; };
   };
 
   # config used when planning the builds

crate_specific.nix

@@ -0,0 +1,16 @@
+# This file contains crate-specific build inputs.
+#
+# Each of them is an attribute with name of the crate and value being a function.
+# This function gets as arguments:
+#  - `crateInfo` with information about the crate, such as sha256 or version
+#
+# Currently supported fields to return are: `buildInputs`, `nativeBuildInputs`
+
+{ pkgs }:
+
+{
+    openssl-sys = { ... }: {
+        nativeBuildInputs = with pkgs; [ pkg-config ];
+        buildInputs = with pkgs; [ openssl ];
+    };
+}

default.nix

@@ -13,6 +13,7 @@
 , writeText
 , zstd
 , clippy
+, pkgs
 }@defaultBuildAttrs:
 
 let
@@ -22,7 +23,7 @@ let
     { inherit lib writeText remarshal runCommandLocal formats; };
 
   mkConfig = arg:
-    import ./config.nix { inherit lib arg libb builtinz; };
+    import ./config.nix { inherit lib arg libb builtinz pkgs; };
 
   buildPackage = arg:
     let

test/fast/default.nix

@@ -11,6 +11,7 @@ args: {
   git-dep-dup = import ./git-dep-dup args;
   git-single-repository-with-multiple-crates = import ./git-single-repository-with-multiple-crates args;
   git-symlink = import ./git-symlink args;
+  openssl = import ./openssl args;
   post-install-hook = import ./post-install-hook args;
   readme = import ./readme args;
   simple-dep = import ./simple-dep args;

test/fast/openssl/default.nix

@@ -0,0 +1,33 @@
+# OpenSSL needs `pkg-config` and `openssl` buildInputs. This tests whether we correctly supply them automatically.
+
+{ naersk, pkgs, ... }:
+
+let
+  # Whether the nixpkgs is version 23 or newer, because in older nixpkgs, rustc is too old to build openssl.
+  buildIt = with pkgs.lib;
+    (strings.toInt ((builtins.elemAt (splitString "." trivial.version) 0)) >= 23);
+in
+
+if buildIt then
+  naersk.buildPackage {
+    src = ./fixtures;
+    doCheck = true;
+  }
+else
+  builtins.trace ''
+      Not building OpenSSL test, because Rust from nixpkgs under major version 23 cannot build OpenSSL
+      Current nixpkgs version: ${pkgs.lib.trivial.version}
+    ''
+
+    pkgs.stdenv.mkDerivation {
+      name = "not-building-openssl-test";
+
+      dontUnpack = true;
+
+      buildPhase = ''
+        echo Not building OpenSSL test, because Rust from nixpkgs under major version 23 cannot build OpenSSL
+        echo Current nixpkgs version: ${pkgs.lib.trivial.version}
+      '';
+
+      installPhase = "mkdir $out";
+    }

test/fast/openssl/fixtures/Cargo.toml

@@ -0,0 +1,11 @@
+# Tests that default-run doesn't break the dependency build, see
+# https://github.com/nmattia/naersk/issues/123
+
+[package]
+name = "openssl-test"
+version = "0.1.0"
+authors = ["FireFragment <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+openssl = "0.10.64"

test/fast/openssl/fixtures/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}