chore: Add shell.nix for all operators (#323)

* github-linguist: excluded from stats, hidden in diffs
See: https://github.com/github-linguist/linguist/blob/master/docs/overrides.md#summary

* commit files required in nix development environments (eg: nix-shell)

* allow other nix files to inherit cargo, sources, packages

* add shell.nix template

* ci(misspell): ignore generated Cargo.nix

* replace operator specific imports with BINDGEN_EXTRA_CLANG_ARGS

* reorder nix shell packages

* take `makr regenerate-nix` from stackabletech/stackable-cockpit@d885d3c

* regenerate-nix on template run

* use meta attribute set instead of jinja2 template variables

Author: NickLarsenNZ

playbook/update_repo.yaml

@@ -94,6 +94,11 @@
         argv: [make, regenerate-charts]
         chdir: "{{ work_dir }}/{{ operator.name }}"
 
+    - name: "Operator [{{ operator.name }}] regenerate crate2nix"
+      command:
+        argv: [make, regenerate-nix]
+        chdir: "{{ work_dir }}/{{ operator.name }}"
+
     - name: "Operator [{{ operator.name }}] re-render README"
       command:
         argv: [make, render-readme]

template/.gitattributes

@@ -0,0 +1,3 @@
+nix/** linguist-generated
+Cargo.nix linguist-generated
+crate-hashes.json linguist-generated

template/.github/workflows/pr_reviewdog.yaml

@@ -75,6 +75,9 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           locale: "US"
+          # Ignore spellchecking generated files
+          exclude: |
+            ./Cargo.nix
 
   languagetool:
     runs-on: ubuntu-latest

template/.gitignore.j2

@@ -9,9 +9,7 @@ target/
 
 *.tgz
 
-Cargo.nix
-crate-hashes.json
 result
 image.tar
 
-tilt_options.json
+tilt_options.json

template/Makefile.j2

@@ -132,7 +132,10 @@ clean: chart-clean
 
 regenerate-charts: chart-clean compile-chart
 
-build: regenerate-charts helm-package docker-build
+regenerate-nix:
+	nix run -f . regenerateNixLockfiles
+
+build: regenerate-charts regenerate-nix helm-package docker-build
 
 publish: build docker-publish helm-publish
 

template/Tiltfile

@@ -10,7 +10,7 @@ operator_name = meta['operator']['name']
 
 custom_build(
     registry + '/' + operator_name,
-    'nix shell -f . crate2nix -c crate2nix generate && nix-build . -A docker --argstr dockerName "${EXPECTED_REGISTRY}/' + operator_name + '" && ./result/load-image | docker load',
+    'make regenerate-nix && nix-build . -A docker --argstr dockerName "${EXPECTED_REGISTRY}/' + operator_name + '" && ./result/load-image | docker load',
     deps=['rust', 'Cargo.toml', 'Cargo.lock', 'default.nix', "nix", 'build.rs', 'vendor'],
     ignore=['*.~undo-tree~'],
     # ignore=['result*', 'Cargo.nix', 'target', *.yaml],

template/default.nix

@@ -40,6 +40,7 @@
 , dockerTag ? null
 }:
 rec {
+  inherit cargo sources pkgs meta;
   build = cargo.allWorkspaceMembers;
   entrypoint = build+"/bin/stackable-${meta.operator.name}";
   crds = pkgs.runCommand "${meta.operator.name}-crds.yaml" {}
@@ -95,4 +96,11 @@ rec {
   # need to use vendored crate2nix because of https://github.com/kolloch/crate2nix/issues/264
   crate2nix = import sources.crate2nix {};
   tilt = pkgs.tilt;
+
+  regenerateNixLockfiles = pkgs.writeScriptBin "regenerate-nix-lockfiles"
+  ''
+    set -euo pipefail
+    echo Running crate2nix
+    ${crate2nix}/bin/crate2nix generate
+  ''; 
 }

template/shell.nix

@@ -0,0 +1,44 @@
+let
+  self = import ./. {};
+  inherit (self) sources pkgs meta;
+
+  beku = pkgs.callPackage (sources."beku.py" + "/beku.nix") {};
+  cargoDependencySetOfCrate = crate: [ crate ] ++ pkgs.lib.concatMap cargoDependencySetOfCrate (crate.dependencies ++ crate.buildDependencies);
+  cargoDependencySet = pkgs.lib.unique (pkgs.lib.flatten (pkgs.lib.mapAttrsToList (crateName: crate: cargoDependencySetOfCrate crate.build) self.cargo.workspaceMembers));
+in pkgs.mkShell rec {
+  name = meta.operator.name;
+
+  packages = with pkgs; [
+    ## cargo et-al
+    rustup # this breaks pkg-config if it is in the nativeBuildInputs
+
+    ## Extra dependencies for use in a pure env (nix-shell --pure)
+    ## These are mosuly useful for maintainers of this shell.nix
+    ## to ensure all the dependencies are caught.
+    # cacert
+    # vim nvim nano
+  ];
+
+  # derivation runtime dependencies
+  buildInputs = pkgs.lib.concatMap (crate: crate.buildInputs) cargoDependencySet;
+  
+  # build time dependencies
+  nativeBuildInputs = pkgs.lib.concatMap (crate: crate.nativeBuildInputs) cargoDependencySet ++ (with pkgs; [
+    beku
+    docker
+    gettext # for the proper envsubst
+    git
+    jq
+    kind
+    kubectl
+    kubernetes-helm
+    kuttl
+    nix # this is implied, but needed in the pure env
+    # tilt already defined in default.nix
+    which
+    yq-go
+  ]);
+
+  LIBCLANG_PATH = "${pkgs.libclang.lib}/lib";
+  BINDGEN_EXTRA_CLANG_ARGS = "-I${pkgs.glibc.dev}/include -I${pkgs.clang}/resource-root/include";
+}