Skip to content

Commit

Permalink
Enable Bazel on darwin
Browse files Browse the repository at this point in the history
  • Loading branch information
SchahinRohani committed Sep 26, 2024
1 parent ca84219 commit 401f013
Show file tree
Hide file tree
Showing 8 changed files with 147 additions and 26 deletions.
3 changes: 3 additions & 0 deletions .bazelrc
Original file line number Diff line number Diff line change
Expand Up @@ -81,5 +81,8 @@ build --extra_toolchains=@rust_toolchains//:all
# Generated by the LRE flake module.
try-import %workspace%/lre.bazelrc

# Generated by the darwin flake module.
try-import %workspace%/darwin.bazelrc

# Allow user-side customization.
try-import %workspace%/user.bazelrc
2 changes: 1 addition & 1 deletion .github/workflows/nix.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
strategy:
fail-fast: false
matrix:
os: [ubuntu-22.04]
os: [ubuntu-22.04, macos-13, macos-14]
name: Bazel Dev / ${{ matrix.os }}
runs-on: ${{ matrix.os }}
timeout-minutes: 45
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ trivy-results.sarif
Pulumi.dev.yaml
lre.bazelrc
rust-project.json
darwin.bazelrc
55 changes: 33 additions & 22 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
imports = [
inputs.git-hooks.flakeModule
./local-remote-execution/flake-module.nix
./tools/darwin/flake-module.nix
];
perSystem = {
config,
Expand Down Expand Up @@ -69,6 +70,7 @@
stable-rust-native = pkgs.rust-bin.stable.${stable-rust-version};

maybeDarwinDeps = pkgs.lib.optionals pkgs.stdenv.isDarwin [
pkgs.darwin.apple_sdk.frameworks.CoreFoundation
pkgs.darwin.apple_sdk.frameworks.Security
pkgs.libiconv
];
Expand Down Expand Up @@ -474,31 +476,40 @@
pkgs.deno
];

shellHook = ''
# Generate the .pre-commit-config.yaml symlink when entering the
# development shell.
${config.pre-commit.installationScript}
# Generate lre.bazelrc which configures LRE toolchains when running
# in the nix environment.
${config.local-remote-execution.installationScript}
# The Bazel and Cargo builds in nix require a Clang toolchain.
# TODO(aaronmondal): The Bazel build currently uses the
# irreproducible host C++ toolchain. Provide
# this toolchain via nix for bitwise identical
# binaries across machines.
export CC=clang
export PULUMI_K8S_AWAIT_ALL=true
export PLAYWRIGHT_BROWSERS_PATH=${pkgs.playwright-driver.browsers}
export PLAYWRIGHT_NODEJS_PATH=${pkgs.nodePackages_latest.nodejs}
export PATH=$HOME/.deno/bin:$PATH
deno types > web/platform/utils/deno.d.ts
'';
shellHook =
''
# Generate the .pre-commit-config.yaml symlink when entering the
# development shell.
${config.pre-commit.installationScript}
# Generate lre.bazelrc which configures LRE toolchains when running
# in the nix environment.
${config.local-remote-execution.installationScript}
# The Bazel and Cargo builds in nix require a Clang toolchain.
# TODO(aaronmondal): The Bazel build currently uses the
# irreproducible host C++ toolchain. Provide
# this toolchain via nix for bitwise identical
# binaries across machines.
export CC=clang
export PULUMI_K8S_AWAIT_ALL=true
export PLAYWRIGHT_BROWSERS_PATH=${pkgs.playwright-driver.browsers}
export PLAYWRIGHT_NODEJS_PATH=${pkgs.nodePackages_latest.nodejs}
export PATH=$HOME/.deno/bin:$PATH
deno types > web/platform/utils/deno.d.ts
''
+ (pkgs.lib.optionalString pkgs.stdenv.isDarwin ''
# On Darwin generate darwin.bazelrc which configures
# darwin libs & frameworks when running in the nix environment.
${config.darwin.installationScript}
'');
};
};
}
// {
flakeModule = ./local-remote-execution/flake-module.nix;
flakeModule = {
default = ./local-remote-execution/flake-module.nix;
darwin = ./tools/darwin/flake-module.nix;
};
};
}
5 changes: 5 additions & 0 deletions local-remote-execution/examples/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
load("@rules_cc//cc:defs.bzl", "cc_binary")

# This example matches the config of the lre config
cc_binary(
name = "hello_lre",
srcs = ["hello.cpp"],
copts = ["--verbose"],
target_compatible_with = [
"@platforms//os:linux",
"@platforms//cpu:x86_64",
],
)
44 changes: 44 additions & 0 deletions tools/darwin/flake-module.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
lib,
flake-parts-lib,
...
}: {
options = {
perSystem = flake-parts-lib.mkPerSystemOption (
{
config,
options,
pkgs,
...
}: let
cfg = config.darwin;
in {
options = {
darwin = {
pkgs = lib.mkOption {
type = lib.types.uniq (lib.types.lazyAttrsOf (lib.types.raw or lib.types.unspecified));
description = "Nixpkgs to use.";
default = pkgs;
defaultText = lib.literalMD "`pkgs` (module argument)";
};
settings = lib.mkOption {
type = lib.types.submoduleWith {
modules = [./modules/darwin.nix];
specialArgs = {inherit (cfg) pkgs;};
};
default = {};
description = "Configuration for Bazel on Darwin.";
};
installationScript = lib.mkOption {
type = lib.types.str;
description = "Create darwin.bazelrc.";
default = cfg.settings.installationScript;
defaultText = lib.literalMD "bazelrc content";
readOnly = true;
};
};
};
}
);
};
}
59 changes: 59 additions & 0 deletions tools/darwin/modules/darwin.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
config,
lib,
pkgs,
...
}: let
# Conditionally set the bazelrc only if the target system is Darwin (macOS)
bazelrc =
if pkgs.stdenv.isDarwin
then
pkgs.writeText "darwin.bazelrc" ''
# These flags are dynamically generated by the Darwin flake module.
#
# Add `try-import %%workspace%%/darwin.bazelrc` to your .bazelrc to
# include these flags when running Bazel in a nix environment.
# These are the libs and frameworks used by darwin.
build --@rules_rust//:extra_rustc_flags=-L${pkgs.libiconv}/lib,-Lframework=${pkgs.darwin.Security}/Library/Frameworks,-Lframework=${pkgs.darwin.CF}/Library/Frameworks
build --@rules_rust//:extra_exec_rustc_flags=-L${pkgs.libiconv}/lib,-Lframework=${pkgs.darwin.Security}/Library/Frameworks,-Lframework=${pkgs.darwin.CF}/Library/Frameworks
''
else "";
in {
options = {
installationScript = lib.mkOption {
type = lib.types.str;
description = "A bash snippet which creates a darwin.bazelrc file in the
repository.";
};
};
config = {
installationScript = ''
if ! type -t git >/dev/null; then
# In pure shells
echo 1>&2 "WARNING: Darwin: git command not found; skipping installation."
elif ! ${pkgs.git}/bin/git rev-parse --git-dir &> /dev/null; then
echo 1>&2 "WARNING: Darwin: .git not found; skipping installation."
else
GIT_WC=`${pkgs.git}/bin/git rev-parse --show-toplevel`
# These update procedures compare before they write, to avoid
# filesystem churn. This improves performance with watch tools like
# lorri and prevents installation loops by lorri.
if ! readlink "''${GIT_WC}/darwin.bazelrc" >/dev/null \
|| [[ $(readlink "''${GIT_WC}/darwin.bazelrc") != ${bazelrc} ]]; then
echo 1>&2 "Darwin: updating $PWD repository"
[ -L darwin.bazelrc ] && unlink darwin.bazelrc
if [ -e "''${GIT_WC}/darwin.bazelrc" ]; then
echo 1>&2 "Darwin: WARNING: Refusing to install because of pre-existing darwin.bazelrc"
echo 1>&2 " Remove the darwin.bazelrc file and add darwin.bazelrc to .gitignore."
else
ln -fs ${bazelrc} "''${GIT_WC}/darwin.bazelrc"
fi
fi
fi
'';
};
}
4 changes: 1 addition & 3 deletions web/platform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,4 @@ bun preview

## 🐛 Known issues

- `bun run docs.build` doesn't work on MacOS with the nix version of Bazel.
As a workaround install Bun and Bazel on your host and build the docs outside the flake.
- `bun dev` doesn't reload the changes in the starlight.conf.ts
- `bun dev` doesn't hot reload the changes in the starlight.conf.ts

0 comments on commit 401f013

Please sign in to comment.