Getting running on macOS

Author: edeandrea

benchmarks/README.md

@@ -18,11 +18,14 @@ The main entrypoint is the `run-benchmarks.sh` script. This script has many opti
 
 > [!TIP]
 > This automation currently supports Linux and macOS hosts. Running on Windows Subsystem for Linux (WSL) has not been tested. Running on Windows directly is not supported.
+> 
+> ALSO - it only supports `bash` shell on both local & remote hosts.
 
 The script also has 3 dependencies that need to be resolved before it can be run:
 - [git](https://github.com/git-guides/install-git)
 - [jbang](https://www.jbang.dev/download)
 - [jq](https://stedolan.github.io/jq)
+- bash shell
 
 ## Usage
 

benchmarks/helpers/async-profiler.yml

@@ -5,8 +5,12 @@ scripts:
       then:
         - regex: linux
           then:
-            - sh: sudo sh -c "echo 1 > /proc/sys/kernel/perf_event_paranoid"
-            - sh: sudo sh -c "echo 0 > /proc/sys/kernel/kptr_restrict"
+            - script: sudo
+              with:
+                command: sh -c "echo 1 > /proc/sys/kernel/perf_event_paranoid"
+            - script: sudo
+              with:
+                command: sh -c "echo 0 > /proc/sys/kernel/kptr_restrict"
 
   # downloads the latest async-profiler release to ${{BASE_DIR}}/${{ASYNC_PROFILER}}
   download-unpack-async-profiler:

benchmarks/helpers/os.yml

@@ -20,6 +20,17 @@ scripts:
     - sh: uname -v
     - set-state: RUN.env.host.VERSION_LEVEL
 
+  sudo-linux:
+    - sh: sudo ${{command}}
+
+  sudo-macos:
+    - sh: ${{command}}
+
+  sudo:
+    - script: sudo-${{os}}
+      with:
+        command: ${{command}}
+
   check-and-install-package:
     - sh: which ${{command}}
     - regex: ".*no ${{command}} in.*"
@@ -29,7 +40,9 @@ scripts:
             package: ${{package}}
 
   install-package-linux:
-    - sh: sudo dnf install -y ${{package}}
+    - script: sudo
+      with:
+        command: dnf install -y ${{package}}
     - regex: "Error: Unable to find a match: ${{package}}"
       then:
         - abort: "Unable to install package: ${{package}}"
@@ -47,12 +60,15 @@ scripts:
     - script: install-package-${{os}}
 
   sync-drop-fs-cache-linux:
-    - sh: sync && sudo sh -c "echo 3 > /proc/sys/vm/drop_caches"
+    - script: sudo
+      with:
+        command: sh -c "echo 3 > /proc/sys/vm/drop_caches"
 
   sync-drop-fs-cache-macos:
-    - sh: sync && sudo purge
+    - sh: sudo purge
 
   sync-drop-fs-cache:
+    - sh: sync
     - read-state: ${{DROP_OS_FILESYSTEM_CACHES:false}}
       then:
         - regex: true

benchmarks/helpers/requirements.yml

@@ -10,7 +10,9 @@ scripts:
     - script: ensure-jbang
 
   ensure-gh-cli-linux:
-    - sh: sudo dnf config-manager addrepo --from-repofile=https://cli.github.com/packages/rpm/gh-cli.repo
+    - script: sudo
+      with:
+        command: dnf config-manager addrepo --from-repofile=https://cli.github.com/packages/rpm/gh-cli.repo
     - script: check-and-install-package
       with:
         command: gh

benchmarks/helpers/sdkman.yml

@@ -19,13 +19,15 @@ scripts:
           "Would you like to upgrade now? (Y/n): ": "Y"
     - regex: ".*command not found"
       then:
+        - log: Installing SDKMAN
         - sh: curl -s "https://get.sdkman.io" | bash
           then:
             - regex: "Enjoy"
               else:
                 - abort: failed to install SDKMAN
         - sh: source "$HOME/.sdkman/bin/sdkman-init.sh"
       else:
+        - log: Updating SDKMAN
         - sh: sdk flush
         - sh: sdk selfupdate force
           then:

benchmarks/helpers/jsFunctions.yml benchmarks/helpers/state-array.ymlbenchmarks/helpers/jsFunctions.yml renamed to benchmarks/helpers/state-array.yml

@@ -1,6 +1,7 @@
-name: jsFunctions
+name: state-array functions
 scripts:
   state-array-push:
+    - log: Pushing ${{value}} to ${{array}}
     - set-state:
         key: ${{array}}
         value: ${{=[...${{${{array}}¬[]}}, ${{value}}]}}

benchmarks/helpers/timestamps.yml

@@ -1,11 +1,11 @@
 name: timestamps helper scripts
 scripts:
   start-timestamp:
-    - sh: date --utc +%FT%TZ
+    - sh: date -u +%FT%TZ
       then:
         - set-state: RUN.output.timing.start
 
   stop-timestamp:
-    - sh: date --utc +%FT%TZ
+    - sh: date -u +%FT%TZ
       then:
         - set-state: RUN.output.timing.stop

benchmarks/main.yml

@@ -91,21 +91,27 @@ states:
   TARGET_URL: http://localhost:8080/fruits
   QUARKUS-PLATFORM-ARTIFACT-ID: quarkus-bom
   PROJ_REPO_NAME: spring-quarkus-perf-comparison
-  BASE_DIR: "$(echo ${HOME})"
+  BASE_DIR: "~${{env.USER}}"
   METRICS_DIR: /tmp
   ASYNC_PROFILER: async-profiler
   ASYNC_PROFILER_DIR: ${{BASE_DIR}}/${{ASYNC_PROFILER}}
 
 scripts:
   cleanup-env:
-    - sh: sudo rm -Rf ${{REPO_DIR}}
+    - script: sudo
+      with:
+        command: rm -Rf ${{REPO_DIR}}/${{PROJ_REPO_NAME}}
 
   config-env:
-    - sh: sudo rm -Rf ${{REPO_DIR}}/logs
+    - script: sudo
+      with:
+        command: rm -Rf ${{REPO_DIR}}/logs
     - sh: mkdir -p ${{REPO_DIR}}/logs
 
   clone-repo:
-    - sh: sudo rm -Rf ${{REPO_DIR}}
+    - script: sudo
+      with:
+        command: rm -Rf ${{REPO_DIR}}
     - sh: mkdir -p ${{REPO_DIR}}/logs
     - sh: cd ${{REPO_DIR}}
     - log: Cloning project repo ${{config.repo.branch}}@${{config.repo.url}}
@@ -379,7 +385,9 @@ scripts:
 
   download-metrics:
     - sh: mkdir -p ${{METRICS_DIR}}
-    - sh: sudo rm -Rf ${{METRICS_DIR}}/metrics.json
+    - script: sudo
+      with:
+        command: rm -Rf ${{METRICS_DIR}}/metrics.json
     - set-state: RUN.output.config ${{RUN.config}}
     - set-state: RUN.output.env ${{RUN.env}}
     - sh: echo '${{RUN.output}}' > ${{METRICS_DIR}}/metrics.json

benchmarks/run-benchmarks.sh

@@ -115,6 +115,7 @@ run_benchmarks() {
 
   if [[ "$HOST" == "LOCAL" ]]; then
     local target="LOCAL"
+    USER=$(whoami)
   else
     local target="${USER}@${HOST}"
   fi
@@ -139,7 +140,9 @@ run_benchmarks() {
     -S config.profiler.events=cpu \
     -S config.repo.branch=${SCM_REPO_BRANCH} \
     -S config.repo.url=${SCM_REPO_URL} \
+    -S env.USER=${USER} \
     -S env.TARGET=${target} \
+    -S BASE_DIR=${HOME} \
     -S ITERATIONS=${ITERATIONS} \
     -S PROJ_REPO_NAME="$(basename ${SCM_REPO_URL} .git)" \
     -S RUNTIMES="$(make_json_array ${RUNTIMES})" \