From 4782ef461998e486c9e32b32875782399862192f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= <tniessen@tnie.de>
Date: Sat, 8 Apr 2023 11:12:47 +0000
Subject: [PATCH] tools: add update script for googletest

GoogleTest follows the Abseil Live at Head philosophy, and rarely
creates tags or GitHub releases, so instead, follow Google's
recommendation and update to the upstream HEAD every once in a while.

The tricky bit is properly updating googletest.gyp, and this script
might fail doing so in the future.

Refs: https://github.com/nodejs/security-wg/issues/828
---
 .github/workflows/tools.yml             |  8 +++
 tools/dep_updaters/update-googletest.sh | 95 +++++++++++++++++++++++++
 2 files changed, 103 insertions(+)
 create mode 100755 tools/dep_updaters/update-googletest.sh

diff --git a/.github/workflows/tools.yml b/.github/workflows/tools.yml
index 7be4065ba9a87f..be41cfef034619 100644
--- a/.github/workflows/tools.yml
+++ b/.github/workflows/tools.yml
@@ -172,6 +172,14 @@ jobs:
             label: crypto, notable-change
             run: |
               node ./tools/dep_updaters/update-root-certs.mjs -v -f "$GITHUB_ENV"
+          - id: googletest
+            subsystem: deps
+            label: dependencies, test
+            run: |
+              ./tools/dep_updaters/update-googletest.sh > temp-output
+              cat temp-output
+              tail -n1 temp-output | grep "NEW_VERSION=" >> "$GITHUB_ENV" || true
+              rm temp-output
     steps:
       - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c  # v3.3.0
         with:
diff --git a/tools/dep_updaters/update-googletest.sh b/tools/dep_updaters/update-googletest.sh
new file mode 100755
index 00000000000000..5f847594b09bfe
--- /dev/null
+++ b/tools/dep_updaters/update-googletest.sh
@@ -0,0 +1,95 @@
+#!/bin/sh
+set -e
+# Shell script to update GoogleTest in the source tree to the most recent version.
+# GoogleTest follows the Abseil Live at Head philosophy and rarely creates tags
+# or GitHub releases, so instead, we use the latest commit on the main branch.
+
+BASE_DIR=$(cd "$(dirname "$0")/../.." && pwd)
+DEPS_DIR="$BASE_DIR/deps"
+
+[ -z "$NODE" ] && NODE="$BASE_DIR/out/Release/node"
+[ -x "$NODE" ] || NODE=$(command -v node)
+
+NEW_UPSTREAM_SHA1=$(git ls-remote "https://github.com/google/googletest.git" HEAD | awk '{print $1}')
+NEW_VERSION=$(echo $NEW_UPSTREAM_SHA1 | head -c 7)
+
+echo "Comparing $NEW_VERSION with current revision"
+
+git remote add googletest-upstream https://github.com/google/googletest.git
+git fetch googletest-upstream $NEW_UPSTREAM_SHA1
+git remote remove googletest-upstream
+
+DIFF_TREE=$(
+  git diff HEAD:deps/googletest/LICENSE $NEW_UPSTREAM_SHA1:LICENSE
+  git diff-tree HEAD:deps/googletest/include $NEW_UPSTREAM_SHA1:googletest/include
+  git diff-tree HEAD:deps/googletest/src $NEW_UPSTREAM_SHA1:googletest/src
+)
+
+if [ -z "$DIFF_TREE" ]; then
+  echo "Skipped because googletest is on the latest version."
+  exit 0
+fi
+
+# This is a rather arbitrary restriction. This script is assumed to run on
+# Sunday, shortly after midnight UTC. This check thus prevents pulling in the
+# most recent commits if any changes were made on Friday or Saturday (UTC).
+# Because of Google's own "Live at Head" philosophy, new bugs that are likely to
+# affect Node.js tend to be fixed quickly, so we don't want to pull in a commit
+# that was just pushed, and instead rather wait for the next week's update. If
+# no commits have been pushed in the last two days, we assume that the most
+# recent commit is stable enough to be pulled in.
+LAST_CHANGE_DATE=$(git log -1 --format=%ct $NEW_UPSTREAM_SHA1 -- LICENSE googletest/include googletest/src)
+if [ "$LAST_CHANGE_DATE" -gt $(date -d 'now - 2 days' '+%s') ]; then
+  echo "Skipped because the latest version is too recent."
+  exit 0
+fi
+
+echo "Creating temporary work tree"
+
+WORKSPACE=$(mktemp -d 2> /dev/null || mktemp -d -t 'tmp')
+WORKTREE="$WORKSPACE/googletest"
+
+cleanup () {
+  EXIT_CODE=$?
+  [ -d "$WORKTREE" ] && git worktree remove -f "$WORKTREE"
+  [ -d "$WORKSPACE" ] && rm -rf "$WORKSPACE"
+  exit $EXIT_CODE
+}
+
+trap cleanup INT TERM EXIT
+
+git worktree add "$WORKTREE" "$NEW_UPSTREAM_SHA1"
+
+echo "Copying LICENSE, include and src to deps/googletest"
+for p in LICENSE googletest/include googletest/src ; do
+  rm -rf "$DEPS_DIR/googletest/$(basename "$p")"
+  cp -R "$WORKTREE/$p" "$DEPS_DIR/googletest/$(basename "$p")"
+done
+
+echo "Updating googletest.gyp"
+
+NEW_GYP=$(
+  sed "/'googletest_sources': \[/q" "$DEPS_DIR/googletest/googletest.gyp"
+  for f in $( (cd deps/googletest/ && find include src -type f \( -iname '*.h' -o -iname '*.cc' \) ) | LANG=C LC_ALL=C sort --stable ); do
+    if [ "$(basename "$f")" != "gtest_main.cc" ] &&
+       [ "$(basename "$f")" != "gtest-all.cc" ] &&
+       [ "$(basename "$f")" != "gtest_prod.h" ] ; then
+      echo "      '$f',"
+    fi
+  done
+  sed -ne '/\]/,$ p' "$DEPS_DIR/googletest/googletest.gyp"
+)
+
+echo "$NEW_GYP" >"$DEPS_DIR/googletest/googletest.gyp"
+
+echo "All done!"
+echo ""
+echo "Please git stage googletest, commit the new version:"
+echo ""
+echo "$ git stage -A deps/googletest"
+echo "$ git commit -m \"deps: update googletest to $NEW_VERSION\""
+echo ""
+
+# The last line of the script should always print the new version,
+# as we need to add it to $GITHUB_ENV variable.
+echo "NEW_VERSION=$NEW_VERSION"