✅ Add OpenAI Integration Tests to GitHub Actions Workflow

Author: gilday

.github/workflows/checks.yml

@@ -68,6 +68,8 @@ jobs:
 
       - name: Run Check task
         uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
+        env:
+          CODEMODDER_OPENAI_API_KEY: ${{ secrets.CODEMODDER_OPENAI_API_KEY }}
         with:
           arguments: check --stacktrace
           cache-read-only: ${{ github.ref != 'refs/heads/main' }}

.github/workflows/release.yml

@@ -36,6 +36,8 @@ jobs:
           java-version: '17'
 
       - uses: gradle/gradle-build-action@v2
+        env:
+          CODEMODDER_OPENAI_API_KEY: ${{ secrets.CODEMODDER_OPENAI_API_KEY }}
         with:
           cache-read-only: ${{ github.ref != 'refs/heads/main' }}
           arguments: --console=plain --quiet --no-configuration-cache -Pversion=${{ inputs.version }} build distZip publishNebulaPublicationToSonatypeRepository closeAndReleaseSonatypeStagingRepository

framework/codemodder-testutils-llm/src/main/java/io/codemodder/testutils/llm/CodemodderOpenAIKeys.java

@@ -12,9 +12,17 @@ private CodemodderOpenAIKeys() {}
   /**
    * Return true if and only if we have a non-empty {@code CODEMODDER_OPENAI_API_KEY} environment
    * variable.
+   *
+   * @throws IllegalStateException when running in a CI/CD environment and the key is not available.
+   *     This is backstop to ensure that all expected tests run in CI/CD.
    */
   public static boolean isAvailable() {
     String key = System.getenv("CODEMODDER_OPENAI_API_KEY");
-    return key != null && !key.isBlank();
+    final var available = key != null && !key.isBlank();
+    if (System.getenv("CI") != null && !available) {
+      throw new IllegalStateException(
+          "The CODEMODDER_OPENAI_API_KEY environment variable must be set in the CI/CD environment.");
+    }
+    return available;
   }
 }