feat: add nix flake for setting up dev env (#1641)

## Description:
This PR adds the a nix flake configuration to deterministically install
dev dependencies for Kurtosis.

## Is this change user facing?
NO - but changes contributor's experience. Readme page is updated.

.envrc

@@ -0,0 +1 @@
+use flake

.gitignore

@@ -120,3 +120,6 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# direnv files
+.direnv

README.md

@@ -121,7 +121,46 @@ This repository is structured as a monorepo, containing the following projects:
 - `docs`: Documentation that is published to [docs.kurtosis.com](docs)
 - `internal_testsuites`: End to end tests
 
-Dev Dependencies
+Dev Dependencies (Nix)
+----------------
+
+Install the [Nix package manager](https://nixos.org/download).
+```bash
+sh <(curl -L https://nixos.org/nix/install)
+```
+
+And enable some Nix flags (alternatively you can add `--extra-experimental-features 'nix-command flakes'` every time calling the `nix` command):
+```bash
+mkdir -p ~/.config/nix
+echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf
+```
+
+And to bring the environment up, just open a new shell terminal, go to the root folder of the repo and run:
+```bash
+nix  develop
+```
+
+This will download all dev deps and setup the environment accordingly.
+
+You can also use the [`direnv`](https://direnv.net/) to automatically load the environment when entering the main folder or using a plugin in your preferred IDE:
+- `vscode`: [mkhl.direnv](https://github.com/direnv/direnv-vscode)
+- `jet brains`: [Direnv integration](https://plugins.jetbrains.com/plugin/15285-direnv-integration)
+
+Direnv can also be easily installed with Nix (or [HomeBrew](https://formulae.brew.sh/formula/direnv) if you prefer):
+```bash
+nix-env -f '<nixpkgs>' -iA direnv
+```
+
+Now you just to add the direnv hook to your shell:
+```bash
+echo 'eval "$(direnv hook bash)"' >> ~/.bashrc
+# or for ZSH
+echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc
+```
+
+Now next time you open a new shell terminal and go to repo's folder you environment will update and load automatically.
+
+Dev Dependencies (Manual install)
 ----------------
 
 The commands below assume that the env variable BREW_PREFIX contains the brew prefix.

flake.nix

@@ -0,0 +1,104 @@
+{
+  description = "Kurtosis dev flake";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05";
+    unstable.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { nixpkgs, unstable, flake-utils, ... }:
+    let utils = flake-utils;
+    in utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+        unstable_pkgs = unstable.legacyPackages.${system};
+      in {
+        formatter = pkgs.nixpkgs-fmt;
+
+        devShell = pkgs.mkShell {
+          nativeBuildInputs = with pkgs;
+            let
+
+              renamed_grpc_tools = stdenv.mkDerivation {
+                name = "renamed-grpc-tools";
+                version = "0.1";
+                phases = [ "installPhase" ];
+                installPhase = ''
+                  mkdir -p $out/bin
+                  cp -r ${protobuf}/include/ $out/bin/
+                  cp "${grpc-tools}/bin/protoc" $out/bin/grpc_tools_node_protoc
+                  cp "${grpc-tools}/bin/grpc_node_plugin" $out/bin/grpc_tools_node_protoc_plugin
+                '';
+              };
+
+              ts_protoc = stdenv.mkDerivation rec {
+                name = "protoc-gen-ts-wksp";
+                src = fetchFromGitHub {
+                  owner = "thesayyn";
+                  repo = "protoc-gen-ts";
+                  rev = "0.8.7";
+                  hash = "sha256-PGprtSPMRTodt/SD6gpEr/n22jiNqB1/C6HJGlDndLg=";
+                };
+                buildInputs = [ git cacert nodejs bazel ];
+                buildPhase = ''
+                  export HOME=$(pwd)
+                  mkdir -p $out/bin
+                  npm ci
+                  bazel build package
+                '';
+                installPhase = ''
+                  cp bazel-bin/package/package/protoc-gen-ts.js $out/bin/protoc-gen-ts
+                '';
+              };
+
+            in [
+              goreleaser
+              go_1_19
+              gopls
+              golangci-lint
+              delve
+              enumer
+              nodejs_20
+              yarn
+              protobuf
+              protoc-gen-go
+              protoc-gen-go-grpc
+              protoc-gen-connect-go
+              protoc-gen-grpc-web
+              grpc-tools
+              rustc
+              cargo
+              rustfmt
+              rust-analyzer
+              clippy
+              libiconv
+              bash-completion
+              # local definition (see above)
+              renamed_grpc_tools
+              ts_protoc
+            ];
+
+          shellHook = ''
+            export CARGO_NET_GIT_FETCH_WITH_CLI=true
+            printf '\u001b[32m
+                                @@@@@@@@     
+                  @@@ @@     @@@   @@@      
+                @@@   @@    @@    @@        
+                @   @@    @@    @@          
+                  @@    @@    @@            
+                @@    @@    @@              
+                @   @@    @@    @@          
+                @       @@  @@    @@        
+                  @@   @@@    @@@    @@      
+                    @@@         @@@@@@@@     
+            \u001b[0m
+            Starting Kurtosis dev shell. Setup the alias to local compiled Kurtosis cli command "ktdev" by running:
+            \e[32m
+            source ./scripts/set_ktdev.sh
+            \e[0m
+            '
+          '';
+        };
+      });
+}

scripts/build.sh

@@ -5,9 +5,14 @@ set -euo pipefail   # Bash "strict mode"
 script_dirpath="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 root_dirpath="$(dirname "${script_dirpath}")"
 
-if ! bash "${script_dirpath}/versions_check.sh"; then
-  exit 1
+set +u
+# Check if it's running inside a nix shell env so there is no need to check versions
+if [ -z "${IN_NIX_SHELL}" ]; then
+    if ! bash "${script_dirpath}/versions_check.sh"; then
+    exit 1
+    fi
 fi
+set -u
 
 
 # ==================================================================================================

scripts/set_ktdev.sh

@@ -0,0 +1,6 @@
+# Add alias to compiled CLI
+alias ktdev="$(pwd)/cli/cli/scripts/launch-cli.sh" 
+
+# Setup bash completion
+source <(ktdev completion bash)
+complete -F __start_kurtosis ktdev