Skip to content

Commit

Permalink
Create nixosModules, templates, and toolchains attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
eureka-cpu committed Jul 19, 2024
1 parent ee6da51 commit f0544a5
Show file tree
Hide file tree
Showing 14 changed files with 635 additions and 18 deletions.
95 changes: 80 additions & 15 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@

flake-utils.url = "github:numtide/flake-utils";

# TODO: enable checks
# advisory-db = {
# url = "github:rustsec/advisory-db";
# flake = false;
# };

versatus = {
url = "github:versatus/versatus";
flake = false;
Expand All @@ -44,7 +38,22 @@
inherit (pkgs) lib;

# Language toolchains
rustToolchain = pkgs.callPackage ./toolchains/rust-toolchain.nix { inherit fenix versatus; };
#
# Given the path to a `rust-toolchain.toml`, produces the derivation
# for that toolchain for linux and darwin systems.
# Useful for rust projects that declare a `rust-toolchain.toml`.
mkRustToolchainFromTOML = toml_path: hash:
import ./toolchains/rust-toolchain.nix {
inherit
lib
pkgs
fenix
system
toml_path
hash;
};
rustToolchain = mkRustToolchainFromTOML (versatus + "/rust-toolchain.toml")
"sha256-SXRtAuO4IqNOQq+nLbrsDFbVk+3aVA8NNpSZsKlVH/8=";
haskellToolchain = pkgs.callPackage ./toolchains/haskell-toolchain.nix pkgs;

# Overrides the default crane rust-toolchain with fenix.
Expand Down Expand Up @@ -156,9 +165,9 @@
lasrGuestVM = nixpkgs.lib.nixosSystem {
system = null;
modules = [
./deployments/lasr_node/common.nix
./deployments/lasr_node/nightly/nightly-options.nix
./deployments/debug-vm.nix
./nixos/modules/deployments/lasr_node/common.nix
./nixos/modules/deployments/lasr_node/nightly/nightly-options.nix
self.nixosModules.deployments.debugVm
({
# macOS specific stuff
virtualisation.host.pkgs = hostPkgs;
Expand Down Expand Up @@ -285,6 +294,15 @@
# default = versaNodeBin;
# };

# Handles building project specific toolchains.
toolchains = {
# Given the path to a `rust-toolchain.toml`, produces the derivation
# for that toolchain for linux and darwin systems.
# Useful for rust projects that declare a `rust-toolchain.toml`.
inherit mkRustToolchainFromTOML;
};


devShells = rec {
default = nix-dev;
# Developer environments for Versatus repos
Expand Down Expand Up @@ -328,29 +346,76 @@
};
}) // {
overlays = {
lasr_overlay = import ./deployments/lasr_node/lasr-overlay.nix;
lasr_overlay = import ./nixos/modules/deployments/lasr_node/lasr-overlay.nix;
rust = final: prev: {
# This contains a lot of policy decisions which rust toolchain is used
craneLib = (self.inputs.crane.mkLib prev).overrideToolchain final.rustToolchain.fenix-pkgs;
rustToolchain = prev.callPackage ./toolchains/rust-toolchain.nix {
inherit (self.inputs) fenix versatus;
inherit (self.inputs) fenix; toml_path = (self.inputs.versatus + "/rust-toolchain.toml");
hash = "sha256-SXRtAuO4IqNOQq+nLbrsDFbVk+3aVA8NNpSZsKlVH/8=";
};

# This wouldn't be necessary if the lasr overlay was defined in the lasr repo
lasrSrc = self.inputs.lasr;
};
};

nixosModules = {
deployments = {
debugVm = ./nixos/modules/deployments/debug-vm.nix;
digitalOcean = {
digitalOceanImage = ./nixos/modules/deployments/digital-ocean/digital-ocean-image.nix;
configuration = ./nixos/modules/deployments/digital-ocean/configuration.nix;
};
};
};

templates = {
rust-package = {
path = ./templates/rust-package.nix;
description = ''
Initializes a nix flake that includes the boilerplate code for building
and developing Versatus' rust-based single-package projects. A workspace
template is also available: `rust-workspace`.
`nix flake init -t github:versatus/versatus.nix#rust-package`
'';
};
rust-workspace = {
path = ./templates/rust-workspace.nix;
description = ''
Initializes a nix flake that includes the boilerplate code for building
and developing Versatus' rust-based workspace projects. A single-package
template is available: `rust-package`, as well as a workspace template
with extra workspace testing tools: `rust-workspace-hakari`.
`nix flake init -t github:versatus/versatus.nix#rust-workspace`
'';
};
rust-workspace-hakari = {
path = ./templates/rust-workspace-hakari.nix;
description = ''
Initializes a nix flake that includes the boilerplate code for building
and developing Versatus' rust-based workspace projects. A single-package
template is also available: `rust-package`. This template includes the
cargo-hakari workspace tooling, a version of this template without hakari
is also available: `rust-workspace`.
`nix flake init -t github:versatus/versatus.nix#rust-workspace-hakari`
'';
};
};

nixosConfigurations.lasr_nightly =
let
system = flake-utils.lib.system.x86_64-linux;
in
nixpkgs.lib.nixosSystem {
inherit system;
modules = [
./deployments/lasr_node/common.nix
./deployments/lasr_node/nightly/nightly-options.nix
./deployments/digital-ocean/digital-ocean-image.nix
./nixos/modules/deployments/lasr_node/common.nix
./nixos/modules/deployments/lasr_node/nightly/nightly-options.nix
self.nixosModules.deployments.digitalOcean.digitalOceanImage
({
nixpkgs.overlays = [
self.overlays.rust
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
161 changes: 161 additions & 0 deletions templates/rust-package.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
{
description = "Versatus rust-based project template.";

inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

crane = {
url = "github:ipetkov/crane";
inputs.nixpkgs.follows = "nixpkgs";
};

fenix = {
url = "github:nix-community/fenix";
inputs.nixpkgs.follows = "nixpkgs";
inputs.rust-analyzer-src.follows = "";
};

flake-utils.url = "github:numtide/flake-utils";

advisory-db = {
url = "github:rustsec/advisory-db";
flake = false;
};

versatus-nix = {
url = "github:versatus/versatus.nix";
inputs.nixpkgs.follows = "nixpkgs";
inputs.fenix.follows = "fenix";
inputs.flake-utils.follows = "flake-utils";
};
};

outputs = { self, nixpkgs, crane, fenix, flake-utils, advisory-db, versatus-nix, ... }:
flake-utils.lib.eachDefaultSystem (system:
let
pkgs = nixpkgs.legacyPackages.${system};
inherit (pkgs) lib;

toolchains = versatus-nix.toolchains.${system};
rustToolchain = toolchains.mkRustToolchainFromTOML
./rust-toolchain.toml
lib.fakeSha256; # Run `nix flake check` and replace with the expected hash.

# Overrides the default crane rust-toolchain with fenix.
craneLib = (crane.mkLib pkgs).overrideToolchain rustToolchain.fenix-pkgs;
src = craneLib.cleanCargoSource ./.;

# Common arguments can be set here to avoid repeating them later
commonArgs = {
inherit src;
strictDeps = true;

# Inputs that must be available at the time of the build
nativeBuildInputs = [
# pkgs.pkg-config # necessary for linking OpenSSL
# pkgs.clang
];

buildInputs = [
# Add additional build inputs here
# pkgs.openssl.dev
] ++ [
# You probably want this.
rustToolchain.darwin-pkgs
] ++ lib.optionals pkgs.stdenv.isDarwin [
# Additional darwin specific inputs can be set here
];

# Additional environment variables can be set directly
# LIBCLANG_PATH = "${pkgs.libclang.lib}/lib";
# MY_CUSTOM_VAR = "some value";
};

# Build *just* the cargo dependencies, so we can reuse
# all of that work (e.g. via cachix) when running in CI
cargoArtifacts = craneLib.buildDepsOnly commonArgs;

# Build the actual crate itself, reusing the dependency
# artifacts from above.
my-crate = craneLib.buildPackage (commonArgs // {
inherit cargoArtifacts;
doCheck = false; # Use cargo-nexttest below.
# Extra command line arguments to pass to cargo.
# cargoExtraArgs = "--locked --bin your_binary_name";
});
in
{
checks = {
# Build the crate as part of `nix flake check` for convenience
inherit my-crate;

# Run clippy (and deny all warnings) on the crate source,
# again, reusing the dependency artifacts from above.
#
# Note that this is done as a separate derivation so that
# we can block the CI if there are issues here, but not
# prevent downstream consumers from building our crate by itself.
my-crate-clippy = craneLib.cargoClippy (commonArgs // {
inherit cargoArtifacts;
cargoClippyExtraArgs = "--all-targets -- --deny warnings";
});

my-crate-doc = craneLib.cargoDoc (commonArgs // {
inherit cargoArtifacts;
});

# Check formatting
my-crate-fmt = craneLib.cargoFmt {
inherit src;
};

# Audit dependencies
my-crate-audit = craneLib.cargoAudit {
inherit src advisory-db;
};

# Audit licenses
my-crate-deny = craneLib.cargoDeny {
inherit src;
};

# Run tests with cargo-nextest
# Consider setting `doCheck = false` on `my-crate` if you do not want
# the tests to run twice
my-crate-nextest = craneLib.cargoNextest (commonArgs // {
inherit cargoArtifacts;
partitions = 1;
partitionType = "count";
});
};

packages = {
default = my-crate;
} // lib.optionalAttrs (!pkgs.stdenv.isDarwin) {
my-crate-llvm-coverage = craneLib.cargoLlvmCov (commonArgs // {
inherit cargoArtifacts;
});
};

apps.default = flake-utils.lib.mkApp {
drv = my-crate;
};

devShells.default = craneLib.devShell {
# Inherit inputs from checks.
checks = self.checks.${system};

# Additional dev-shell environment variables can be set directly
# MY_CUSTOM_DEVELOPMENT_VAR = "something else";

# Extra inputs can be added here; cargo and rustc are provided by default.
packages = with pkgs; [
# ripgrep
nil # nix lsp
nixpkgs-fmt # nix formatter
];
};

formatter = pkgs.nixpkgs-fmt;
});
}
Loading

0 comments on commit f0544a5

Please sign in to comment.