From 49a5c037fad66d1323b24aedd2239009e561f55b Mon Sep 17 00:00:00 2001 From: Marco Ippolito Date: Fri, 10 Mar 2023 22:17:06 +0100 Subject: [PATCH] tools: automate cares update PR-URL: https://github.com/nodejs/node/pull/46993 Refs: https://github.com/nodejs/security-wg/issues/828 Reviewed-By: Yagiz Nizipli Reviewed-By: Antoine du Hamel Reviewed-By: Rafael Gonzaga Reviewed-By: Benjamin Gruenbaum --- .github/workflows/tools.yml | 8 +++ doc/contributing/maintaining-c-ares.md | 16 ++---- tools/dep_updaters/update-c-ares.sh | 71 ++++++++++++++++++++++++++ tools/update-cares.sh | 56 -------------------- 4 files changed, 83 insertions(+), 68 deletions(-) create mode 100755 tools/dep_updaters/update-c-ares.sh delete mode 100755 tools/update-cares.sh diff --git a/.github/workflows/tools.yml b/.github/workflows/tools.yml index 84193a6b32181c..8d4e5ae028253c 100644 --- a/.github/workflows/tools.yml +++ b/.github/workflows/tools.yml @@ -163,6 +163,14 @@ jobs: echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV ./tools/update-llhttp.sh "$NEW_VERSION" fi + - id: c-ares + subsystem: deps + label: dependencies + run: | + ./tools/dep_updaters/update-c-ares.sh > temp-output + cat temp-output + tail -n1 temp-output | grep "NEW_VERSION=" >> "$GITHUB_ENV" || true + rm temp-output steps: - uses: actions/checkout@v3 with: diff --git a/doc/contributing/maintaining-c-ares.md b/doc/contributing/maintaining-c-ares.md index 64f29674c4e8a6..d4b48dbfdb5bdb 100644 --- a/doc/contributing/maintaining-c-ares.md +++ b/doc/contributing/maintaining-c-ares.md @@ -13,19 +13,11 @@ Updates to the c-ares dependency involve the following steps: ## Running the update script -The `tools/update-cares.sh` script automates the update of the c-ares source -files, preserving the existing files added by Node.js. +The `tools/dep_updaters/update-c-ares.sh` script automates the update of +the c-ares source files, preserving the existing files added by Node.js. -In the following examples, `x.y.z` should match the c-ares version to update to. - -```console -./tools/update-cares.sh x.y.z -``` - -e.g. - -```console -./tools/update-cares.sh 1.18.1 +```bash +./tools/dep_updaters/update-c-ares.sh ``` ## Check that Node.js still builds and tests diff --git a/tools/dep_updaters/update-c-ares.sh b/tools/dep_updaters/update-c-ares.sh new file mode 100755 index 00000000000000..79d964e61f08a5 --- /dev/null +++ b/tools/dep_updaters/update-c-ares.sh @@ -0,0 +1,71 @@ +#!/bin/sh +set -e +# Shell script to update c-ares in the source tree to a specific version + +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_VERSION="$("$NODE" --input-type=module <<'EOF' +const res = await fetch('https://api.github.com/repos/c-ares/c-ares/releases/latest'); +if (!res.ok) throw new Error(`FetchError: ${res.status} ${res.statusText}`, { cause: res }); +const { tag_name } = await res.json(); +console.log(tag_name.replace('cares-', '').replaceAll('_', '.')); +EOF +)" + +CURRENT_VERSION=$(grep "#define ARES_VERSION_STR" ./deps/cares/include/ares_version.h | sed -n "s/^.*VERSION_STR \"\(.*\)\"/\1/p") + +echo "Comparing $NEW_VERSION with $CURRENT_VERSION" + +if [ "$NEW_VERSION" = "$CURRENT_VERSION" ]; then + echo "Skipped because c-ares is on the latest version." + exit 0 +fi + +echo "Making temporary workspace" + +WORKSPACE=$(mktemp -d 2> /dev/null || mktemp -d -t 'tmp') + +cleanup () { + EXIT_CODE=$? + [ -d "$WORKSPACE" ] && rm -rf "$WORKSPACE" + exit $EXIT_CODE +} + +trap cleanup INT TERM EXIT + +ARES_REF="cares-$(echo "$NEW_VERSION" | tr . _)" +ARES_TARBALL="c-ares-$NEW_VERSION.tar.gz" + +cd "$WORKSPACE" + +echo "Fetching c-ares source archive" +curl -sL "https://github.com/c-ares/c-ares/releases/download/$ARES_REF/$ARES_TARBALL" | tar xz +mv "c-ares-$NEW_VERSION" cares + +echo "Removing tests" +rm -rf "$WORKSPACE/cares/test" + +echo "Copying existing .gitignore, config and gyp files" +cp -R "$DEPS_DIR/cares/config" "$WORKSPACE/cares" +cp "$DEPS_DIR/cares/.gitignore" "$WORKSPACE/cares" +cp "$DEPS_DIR/cares/cares.gyp" "$WORKSPACE/cares" + +echo "Replacing existing c-ares" +rm -rf "$DEPS_DIR/cares" +mv "$WORKSPACE/cares" "$DEPS_DIR/" + +echo "All done!" +echo "" +echo "Please git add c-ares, commit the new version:" +echo "" +echo "$ git add -A deps/cares" +echo "$ git commit -m \"deps: update c-ares 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" diff --git a/tools/update-cares.sh b/tools/update-cares.sh deleted file mode 100755 index f20347d88274fe..00000000000000 --- a/tools/update-cares.sh +++ /dev/null @@ -1,56 +0,0 @@ -#!/bin/sh -set -e -# Shell script to update c-ares in the source tree to a specific version - -BASE_DIR=$(cd "$(dirname "$0")/.." && pwd) -DEPS_DIR="$BASE_DIR/deps" -ARES_VERSION=$1 - -if [ "$#" -le 0 ]; then - echo "Error: please provide an c-ares version to update to" - echo " e.g. $0 1.18.1" - exit 1 -fi - -echo "Making temporary workspace" - -WORKSPACE=$(mktemp -d 2> /dev/null || mktemp -d -t 'tmp') - -cleanup () { - EXIT_CODE=$? - [ -d "$WORKSPACE" ] && rm -rf "$WORKSPACE" - exit $EXIT_CODE -} - -trap cleanup INT TERM EXIT - -ARES_REF="cares-$(echo "$ARES_VERSION" | tr . _)" -ARES_TARBALL="c-ares-$ARES_VERSION.tar.gz" - -cd "$WORKSPACE" - -echo "Fetching c-ares source archive" -curl -sL -o "$ARES_TARBALL" "https://github.com/c-ares/c-ares/releases/download/$ARES_REF/$ARES_TARBALL" -gzip -dc "$ARES_TARBALL" | tar xf - -rm "$ARES_TARBALL" -mv "c-ares-$ARES_VERSION" cares - -echo "Removing tests" -rm -rf "$WORKSPACE/cares/test" - -echo "Copying existing .gitignore, config and gyp files" -cp -R "$DEPS_DIR/cares/config" "$WORKSPACE/cares" -cp "$DEPS_DIR/cares/.gitignore" "$WORKSPACE/cares" -cp "$DEPS_DIR/cares/cares.gyp" "$WORKSPACE/cares" - -echo "Replacing existing c-ares" -rm -rf "$DEPS_DIR/cares" -mv "$WORKSPACE/cares" "$DEPS_DIR/" - -echo "All done!" -echo "" -echo "Please git add c-ares, commit the new version:" -echo "" -echo "$ git add -A deps/cares" -echo "$ git commit -m \"deps: update c-ares to $ARES_VERSION\"" -echo ""