scripts: refactor for reliability

This is a small refactor/rewrite pass to scripts/create_container.sh and
scripts/bin/bazel.

First of all, it moves the IntelliJ aspect overriding logic from parsing
command line flags in scripts/bin/bazel to replace the path that the
aspect is loaded from to crafting the build container in a way that the
aspect is already located where it's expected.

This allows us to vastly simplify the scripts/bin/bazel wrapper, and
most notably fixes an issue where it wasn't able to handle Bazel flags
that contained spaces and were wrapped in ""/'' delimited strings.
Instead of adding more and more flag replacing logic in this script, we
got rid of that logic entirely, and now the only thing that the wrapper
script does is set the output root and run Bazel within the container.

At the same time, we also fix discovering newer IntelliJ versions. On my
machine, it was still discovering my 2019 installation and using an old
version of the aspect.

We also generally dust off the scripts/create_container.sh script by
ensuring all variables are always used within double quotes (the
previous implementation could've accidentally removed some directory from
the host if the user homedir contained spaces) and moving all of the
logic into a function that uses local variables.

Tested on my local workstation, IntelliJ sync works.

Change-Id: I63ae042ffe0fc7f384b98768ed66b7426b3f5df4
Reviewed-on: https://review.monogon.dev/c/monogon/+/63
Reviewed-by: Leopold Schabel <leo@nexantic.com>
2 files changed
tree: 3fb068803b9141172a154df14760a66199cd088c
  1. build/
  2. intellij/
  3. metropolis/
  4. scripts/
  5. third_party/
  6. .bazelignore
  7. .bazelproject
  8. .bazelrc
  9. .gitignore
  10. BUILD
  11. LICENSE
  12. nogo_config.json
  13. README.md
  14. WORKSPACE
README.md

Monogon Monorepo

This is the main repository containing the source code for the Monogon Project.

⚠️ This is pre-release software that happens to be publicly available. Nothing to see here, please move along.

Environment

Our build environment requires a working Podman binary (your distribution should have one).

Usage

Spinning up: scripts/create_container.sh

Spinning down: scripts/destroy_container.sh

Running commands: scripts/run_in_container.sh <...>

Using bazel using a wrapper script: scripts/bin/bazel <...> (add to your local $PATH for convenience)

IntelliJ

This repository is compatible with the IntelliJ Bazel plugin, which enables full autocompletion for external dependencies and generated code. All commands run inside the container, and necessary paths are mapped into the container.

The following steps are necessary:

  • Install Google's Bazel plugin in IntelliJ. On IntelliJ 2020.3 or later, you need to install a beta release of the plugin.

  • Add the absolute path to your ~/.cache/bazel-monogon folder to your idea64.vmoptions (Help → Edit Custom VM Options) and restart IntelliJ:

    -Dbazel.bep.path=/home/leopold/.cache/bazel-monogon

  • Set "Bazel Binary Location" in Other Settings → Bazel Settings to the absolute path of scripts/bin/bazel. This is a wrapper that will execute Bazel inside the container.

  • Use File → Import Bazel project... to create a new project from .bazelproject.

After running the first sync, everything should now resolve in the IDE, including generated code.

It's strongly recommend to use our project presets for file watchers and other IDE features. Run this command and re-open the project in order to install them:

bazel run intellij/localconfig $(pwd)

Metropolis

Run a single node cluster

Launch the node:

scripts/bin/bazel run //:launch

Run a kubectl command:

scripts/bin/bazel run //metropolis/cli/dbg -- kubectl describe

Run tests:

scripts/bin/bazel test //...