Use hermit (#2648)

cashapp · Jan 9, 2023 · 39e01cb · 39e01cb
1 parent d07ef50
commit 39e01cb
Show file tree

Hide file tree

Showing 57 changed files with 111 additions and 376 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -22,7 +22,7 @@ jobs:
       - run:
           name: "Compile"
           command: |
-            ./gradlew testClasses --parallel --build-cache
+            bin/gradle testClasses --parallel --build-cache
       - save_cache:
           paths:
             - ~/.gradle/caches
@@ -74,9 +74,9 @@ jobs:
           name: "Build and test"
           command: |
             if [ "$CIRCLE_NODE_INDEX" -eq 1 ]; then
-              ./gradlew testShardHibernate -i --scan
+              bin/gradle testShardHibernate -i --scan
             else
-              ./gradlew testShardNonHibernate -i --scan --parallel
+              bin/gradle testShardNonHibernate -i --scan --parallel
             fi
       - run:
           name: Collect test results

diff --git a/.github/workflows/Publish-Website.yml b/.github/workflows/Publish-Website.yml
@@ -22,14 +22,8 @@ jobs:
         with:
           python-version: 3.8
 
-      - name: Configure JDK
-        uses: actions/setup-java@v3
-        with:
-          distribution: 'adopt'
-          java-version: 11.0.11+9
-
       - name: Generate API docs
-        run: ./gradlew dokkaGfm
+        run: bin/gradle dokkaGfm
 
       - name: Prep mkdocs
         run: .github/workflows/prepare_mkdocs.sh

diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
@@ -13,15 +13,6 @@ jobs:
       - name: Checkout the repo
         uses: actions/checkout@v3
 
-      - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
-
-      - name: Configure JDK
-        uses: actions/setup-java@v3
-        with:
-          distribution: 'adopt'
-          java-version: 11.0.3
-
       - name: install misk-web
         run: |
           mkdir ~/.npm-global
@@ -40,4 +31,4 @@ jobs:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
           ORG_GRADLE_PROJECT_signingKey: ${{ secrets.ARTIFACT_SIGNING_PRIVATE_KEY }}
-        run: ./gradlew publishAllPublicationsToMavenCentralRepository
+        run: bin/gradle publishAllPublicationsToMavenCentralRepository
diff --git a/.github/workflows/Test.yml b/.github/workflows/Test.yml
@@ -53,22 +53,13 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         cmd:
-          - ./gradlew testShardHibernate -i --scan
-          - ./gradlew testShardNonHibernate -i --scan --parallel
+          - bin/gradle testShardHibernate -i --scan
+          - bin/gradle testShardNonHibernate -i --scan --parallel
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Validate Gradle Wrapper
-        uses: gradle/wrapper-validation-action@v1
-
-      - name: Configure JDK
-        uses: actions/setup-java@v3
-        with:
-          distribution: 'adopt'
-          java-version: 11.0.3
-
       - name: Test
         run: ${{ matrix.cmd }}
 

diff --git a/.github/workflows/gradle-wrapper-validation.yml b/.github/workflows/gradle-wrapper-validation.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,10 +11,12 @@ Before your code can be accepted into the project you must also sign the
 
 ## Building Misk locally
 
+Install and activate hermit: https://cashapp.github.io/hermit/
+
 Use gradle to run all Kotlin tests locally:
 
 ```shell
-./gradlew build
+gradle build
 ```
 
 misk-hibernate tests expect a mysql server running on `localhost:3306` with no password set on

diff --git a/RELEASING-MANUAL.md b/RELEASING-MANUAL.md
@@ -86,7 +86,7 @@ Cutting a Release
       "s/\"com.squareup.misk:\([^\:]*\):[^\"]*\"/\"com.squareup.misk:\1:$RELEASE_VERSION\"/g" \
       `find . -name "README.md"`
     miskweb ci-build -e
-    ./gradlew clean uploadArchives
+    gradle clean uploadArchives
     ```
 
 5. Visit [Sonatype Nexus][sonatype_nexus] to promote (close then release) the artifact. Or drop it if there is a problem!

diff --git a/bin/.gradle-7.6.pkg b/bin/.gradle-7.6.pkg
@@ -0,0 +1 @@
+hermit
diff --git a/bin/.node-16.13.0.pkg b/bin/.node-16.13.0.pkg
@@ -0,0 +1 @@
+hermit
diff --git a/bin/.openjdk@11.pkg b/bin/.openjdk@11.pkg
@@ -0,0 +1 @@
+hermit
diff --git a/bin/README.hermit.md b/bin/README.hermit.md
@@ -0,0 +1,7 @@
+# Hermit environment
+
+This is a [Hermit](https://github.com/cashapp/hermit) bin directory.
+
+The symlinks in this directory are managed by Hermit and will automatically
+download and install Hermit itself as well as packages. These packages are
+local to this environment.
diff --git a/bin/activate-hermit b/bin/activate-hermit
@@ -0,0 +1,21 @@
+#!/bin/bash
+# This file must be used with "source bin/activate-hermit" from bash or zsh.
+# You cannot run it directly
+#
+# THIS FILE IS GENERATED; DO NOT MODIFY
+
+if [ "${BASH_SOURCE-}" = "$0" ]; then
+  echo "You must source this script: \$ source $0" >&2
+  exit 33
+fi
+
+BIN_DIR="$(dirname "${BASH_SOURCE[0]:-${(%):-%x}}")"
+if "${BIN_DIR}/hermit" noop > /dev/null; then
+  eval "$("${BIN_DIR}/hermit" activate "${BIN_DIR}/..")"
+
+  if [ -n "${BASH-}" ] || [ -n "${ZSH_VERSION-}" ]; then
+      hash -r 2>/dev/null
+    fi
+
+    echo "Hermit environment $("${HERMIT_ENV}"/bin/hermit env HERMIT_ENV) activated"
+fi
diff --git a/bin/corepack b/bin/corepack
@@ -0,0 +1 @@
+.node-16.13.0.pkg
diff --git a/bin/gradle b/bin/gradle
@@ -0,0 +1 @@
+.gradle-7.6.pkg
diff --git a/bin/hermit b/bin/hermit
@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -eo pipefail
+
+export HERMIT_USER_HOME=~
+
+if [ -z "${HERMIT_STATE_DIR}" ]; then
+  case "$(uname -s)" in
+  Darwin)
+    export HERMIT_STATE_DIR="${HERMIT_USER_HOME}/Library/Caches/hermit"
+    ;;
+  Linux)
+    export HERMIT_STATE_DIR="${XDG_CACHE_HOME:-${HERMIT_USER_HOME}/.cache}/hermit"
+    ;;
+  esac
+fi
+
+export HERMIT_DIST_URL="${HERMIT_DIST_URL:-https://github.com/cashapp/hermit/releases/download/stable}"
+HERMIT_CHANNEL="$(basename "${HERMIT_DIST_URL}")"
+export HERMIT_CHANNEL
+export HERMIT_EXE=${HERMIT_EXE:-${HERMIT_STATE_DIR}/pkg/hermit@${HERMIT_CHANNEL}/hermit}
+
+if [ ! -x "${HERMIT_EXE}" ]; then
+  echo "Bootstrapping ${HERMIT_EXE} from ${HERMIT_DIST_URL}" 1>&2
+  curl -fsSL "${HERMIT_DIST_URL}/install.sh" | /bin/bash 1>&2
+fi
+
+exec "${HERMIT_EXE}" --level=fatal exec "$0" -- "$@"
diff --git a/bin/hermit.hcl b/bin/hermit.hcl
diff --git a/bin/jar b/bin/jar
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jarsigner b/bin/jarsigner
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/java b/bin/java
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/javac b/bin/javac
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/javadoc b/bin/javadoc
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/javap b/bin/javap
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jcmd b/bin/jcmd
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jconsole b/bin/jconsole
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jdb b/bin/jdb
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jdeprscan b/bin/jdeprscan
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jdeps b/bin/jdeps
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jfr b/bin/jfr
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jhsdb b/bin/jhsdb
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jimage b/bin/jimage
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jinfo b/bin/jinfo
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jjs b/bin/jjs
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jlink b/bin/jlink
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jmap b/bin/jmap
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jmod b/bin/jmod
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jps b/bin/jps
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jrunscript b/bin/jrunscript
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jshell b/bin/jshell
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jstack b/bin/jstack
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jstat b/bin/jstat
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/jstatd b/bin/jstatd
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/keytool b/bin/keytool
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/node b/bin/node
@@ -0,0 +1 @@
+.node-16.13.0.pkg
diff --git a/bin/npm b/bin/npm
@@ -0,0 +1 @@
+.node-16.13.0.pkg
diff --git a/bin/npx b/bin/npx
@@ -0,0 +1 @@
+.node-16.13.0.pkg
diff --git a/bin/pack200 b/bin/pack200
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/rmic b/bin/rmic
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/rmid b/bin/rmid
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/rmiregistry b/bin/rmiregistry
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/serialver b/bin/serialver
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/bin/unpack200 b/bin/unpack200
@@ -0,0 +1 @@
+.openjdk@11.pkg
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -10,10 +10,12 @@ contains a Misk web app with the requisite dependencies.
 
 ## Start the service
 
+Install and activate hermit: https://cashapp.github.io/hermit/
+
 Run `ExemplarService#main`, or use gradle to run:
 
 ```bash
-./gradlew run
+gradle run
 ```
 
 ## Set up bindings

diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties