From dc01c95b6b3e41e56b4c10e5b7dc3dec8db5f4d9 Mon Sep 17 00:00:00 2001
From: Nathaniel Cook <nvcook42@gmail.com>
Date: Tue, 6 Feb 2024 08:45:03 -0700
Subject: [PATCH] chore: fix false positive in checking generated servers
 (#260)

---
 .github/workflows/rust-build-and-test.yml |  2 ++
 Makefile                                  |  4 ++--
 ci-scripts/check_api_server.sh            | 19 ---------------
 ci-scripts/check_generated_server.sh      | 29 +++++++++++++++++++++++
 ci-scripts/check_kubo_rpc_server.sh       | 19 ---------------
 ci-scripts/gen_api_server.sh              |  2 ++
 6 files changed, 35 insertions(+), 40 deletions(-)
 delete mode 100755 ci-scripts/check_api_server.sh
 create mode 100755 ci-scripts/check_generated_server.sh
 delete mode 100755 ci-scripts/check_kubo_rpc_server.sh

diff --git a/.github/workflows/rust-build-and-test.yml b/.github/workflows/rust-build-and-test.yml
index 236923c8e..194145d48 100644
--- a/.github/workflows/rust-build-and-test.yml
+++ b/.github/workflows/rust-build-and-test.yml
@@ -35,6 +35,8 @@ jobs:
         # Cache only the cargo registry
         cache-targets: false
     - uses: mozilla-actions/sccache-action@v0.0.3
+    - name: git file permission config
+      run: git config --global --add safe.directory '*'
     - name: Check fmt
       run: make check-fmt
     - name: Check clippy
diff --git a/Makefile b/Makefile
index 5ee66a244..ac5bb3b14 100644
--- a/Makefile
+++ b/Makefile
@@ -42,7 +42,7 @@ gen-api-server: api/ceramic.yaml
 # Checks api-server crate is up-to-date
 .PHONY: check-api-server
 check-api-server:
-	./ci-scripts/check_api_server.sh
+	./ci-scripts/check_generated_server.sh api-server ./ci-scripts/gen_api_server.sh
 
 # Generates kubo-rpc-server crate from ceramic.yaml OpenAPI spec
 .PHONY: gen-kubo-rpc-server
@@ -52,7 +52,7 @@ gen-kubo-rpc-server:
 # Checks kubo-rpc-server crate is up-to-date
 .PHONY: check-kubo-rpc-server
 check-kubo-rpc-server:
-	./ci-scripts/check_kubo_rpc_server.sh
+	./ci-scripts/check_generated_server.sh kubo-rpc-server ./ci-scripts/gen_kubo_rpc_server.sh
 
 .PHONY: release
 release:
diff --git a/ci-scripts/check_api_server.sh b/ci-scripts/check_api_server.sh
deleted file mode 100755
index 9b787ee45..000000000
--- a/ci-scripts/check_api_server.sh
+++ /dev/null
@@ -1,19 +0,0 @@
-#!/usr/bin/env bash
-# Script to generate api-server crate from OpenAPI definition.
-
-DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-cd $DIR/..
-
-# First generate
-$DIR/gen_api_server.sh > /dev/null
-
-# Check if anything changed, the README contains a generation date, ignore that file.
-changes=$(git status --porcelain api-server | grep -v README.md)
-if [[ -n "$changes" ]]
-then
-    echo "Found api-server changes:"
-    echo "$changes"
-    exit 1
-fi
-echo "Generated api-server is up-to-date"
-exit 0
diff --git a/ci-scripts/check_generated_server.sh b/ci-scripts/check_generated_server.sh
new file mode 100755
index 000000000..9a007db56
--- /dev/null
+++ b/ci-scripts/check_generated_server.sh
@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+# Script to check a generated server has not changed
+
+server_dir=$1
+server_gen_cmd=$2
+
+DIR=$(dirname $0)
+cd "$DIR/.."
+
+# First generate
+$server_gen_cmd > /dev/null
+
+# Check if anything changed, the README contains a generation date, ignore that file.
+status=$(git status --porcelain $server_dir)
+if [ $? -ne 0 ]
+then
+    echo "Failed to get git status"
+    exit 1
+fi
+
+changes=$(echo "$status" | grep -v README.md)
+if [[ -n "$changes" ]]
+then
+    echo "Found ${server_dir} changes:"
+    echo "$changes"
+    exit 1
+fi
+echo "Generated ${server_dir} is up-to-date"
+exit 0
diff --git a/ci-scripts/check_kubo_rpc_server.sh b/ci-scripts/check_kubo_rpc_server.sh
deleted file mode 100755
index 99d40e0f9..000000000
--- a/ci-scripts/check_kubo_rpc_server.sh
+++ /dev/null
@@ -1,19 +0,0 @@
-#!/usr/bin/env bash
-# Script to generate kubo-rpc-server crate from OpenAPI definition.
-
-DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-cd $DIR/..
-
-# First generate
-$DIR/gen_kubo_rpc_server.sh > /dev/null
-
-# Check if anything changed, the README contains a generation date, ignore that file.
-changes=$(git status --porcelain kubo-rpc-server | grep -v README.md)
-if [[ -n "$changes" ]]
-then
-    echo "Found kubo-rpc-server changes:"
-    echo "$changes"
-    exit 1
-fi
-echo "Generated kubo-rpc-server is up-to-date"
-exit 0
diff --git a/ci-scripts/gen_api_server.sh b/ci-scripts/gen_api_server.sh
index 13e3eba0b..241517c7e 100755
--- a/ci-scripts/gen_api_server.sh
+++ b/ci-scripts/gen_api_server.sh
@@ -3,6 +3,8 @@
 # Script to generate api-server crate from OpenAPI definition.
 # Requires augeas/augtool to be installed
 
+set -e
+
 DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 cd $DIR/..