Merge pull request #1521 from virtualcell/openapi-spec-CI-test

Openapi spec ci test

Author: Ezequiel-Valencia

.github/workflows/ci_cd.yml

@@ -174,6 +174,7 @@ jobs:
           java -version
           if [ "${{ matrix.test-group }}" == "Quarkus" ]; then
             mvn --batch-mode clean install dependency:copy-dependencies -DskipTests=true
+            ./tools/validate-openapi-spec.sh
             cd vcell-rest
             mvn test
           else

docker/swarm/README_zeke_stack_on_linux.md

@@ -40,8 +40,6 @@ Build and Generate Clients
 
 ``` bash 
     pushd ../../
-    mvn clean install dependency:copy-dependencies -DskipTests=true
-    cp ./vcell-rest/target/generated/openapi.yaml ./tools/openapi.yaml
-    ./tools/generate.sh
+    ./tools/compile-and-build-clients.sh
     popd
  ```

tools/compile-and-build-clients.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Get the directory where the script is located
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+# Get the current working directory
+CURRENT_DIR="$(pwd)"
+
+if [[ "$CURRENT_DIR" == "$SCRIPT_DIR" ]]; then
+  pushd ../
+fi
+
+mvn clean install dependency:copy-dependencies -DskipTests=true
+
+# Check the result of the compile command
+if [[ $? -ne 0 ]]; then
+  exit 1
+fi
+
+cp ./vcell-rest/target/generated/openapi.yaml ./tools/openapi.yaml
+./tools/generate.sh
+
+if [[ "$CURRENT_DIR" == "$SCRIPT_DIR" ]]; then
+  popd || exit
+fi
+

tools/validate-openapi-spec.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+RED='\033[0;31m'
+NC='\033[0m' # No Color
+GREEN='\033[0;32m'
+
+
+# Get the directory where the script is located
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+
+# Get the current working directory
+CURRENT_DIR="$(pwd)"
+
+if [[ "$CURRENT_DIR" == "$SCRIPT_DIR" ]]; then
+  pushd ../
+fi
+
+FILE="./tools/openapi.yaml"
+
+echo "This test should only be done after the entire codebase has been compiled."
+
+if [[ -z "$FILE" ]]; then
+  echo "Error: OpenAPI file does not exist in tools directory."
+  exit 1
+fi
+
+cp ./vcell-rest/target/generated/openapi.yaml "$FILE"
+
+# Check if the file has changes compared to HEAD
+if ! git diff --quiet -- "$FILE"; then
+  echo ""
+  echo -e "${RED}Error: The OpenAPI specification file has changed!"
+  echo -e "This can mean some endpoint was created and did not generate clients, or "
+  echo -e "an object internal to VCell has changed which the server uses as a DTO.${NC}"
+  exit 1
+fi
+
+echo -e "${GREEN}Success: OpenAPI spec is up to date.${NC}"
+
+if [[ "$CURRENT_DIR" == "$SCRIPT_DIR" ]]; then
+  popd || exit
+fi

vcell-rest/pom.xml

@@ -163,10 +163,6 @@
         </exclusion>
       </exclusions>
     </dependency>
-    <dependency>
-      <groupId>org.jboss.logmanager</groupId>
-      <artifactId>log4j2-jboss-logmanager</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.jboss.logmanager</groupId>
       <artifactId>log4j-jboss-logmanager</artifactId>