Merge pull request #145 from schemacrawler/host-files

Rework how SchemaCrawler tools execute

Author: sualeh

.github/workflows/docker-image-early-release.yml

@@ -19,7 +19,7 @@ jobs:
       github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
     permissions:
-      id-token: write  # Required for OIDC authentication
+      id-token: write # Required for OIDC authentication
       contents: write # Required to create a new tag
     steps:
 
@@ -72,7 +72,22 @@ jobs:
         echo "The Early Access Release Docker Image build will pick it up from the target directory"
 
 
-# CREATE GITHUB RELEASE AND ADD ASSETS
+# CREATE GITHUB RELEASE
+    - id: create-release
+      name: Create GitHub early access release
+      uses: softprops/action-gh-release@v2
+      with:
+        target_commitish: ${{ github.sha }}
+        tag_name: early-access-release
+        token: ${{ secrets.GITHUB_TOKEN }}
+        name: early-access-release
+        draft: false
+        prerelease: true
+        body: |
+          SchemaCrawler AI early access release at last commit ${{ github.sha }}
+        generate_release_notes: true
+
+# MOVE GITHUB TAG
     - id: install-gitsign
       name: Install gitsign for commit signing
       # See https://github.com/chainguard-dev/actions/blob/main/setup-gitsign/action.yml
@@ -96,19 +111,6 @@ jobs:
         git tag -a early-access-release -m "SchemaCrawler AI Early Access Release"
         git push --follow-tags origin early-access-release
         git show early-access-release
-    - id: create-release
-      name: Create GitHub early access release
-      uses: softprops/action-gh-release@v2
-      with:
-        target_commitish: ${{ github.sha }}
-        tag_name: early-access-release
-        token: ${{ secrets.GITHUB_TOKEN }}
-        name: early-access-release
-        draft: false
-        prerelease: true
-        body: |
-          SchemaCrawler AI early access release at last commit ${{ github.sha }}
-        generate_release_notes: true
 
 # BUILD AND PUBLISH DOCKER IMAGE
     - id: setup-qemu

.github/workflows/release.yml

@@ -14,6 +14,9 @@ jobs:
   build:
     name: Create Release
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write # Required for OIDC authentication
+      contents: write # Required to create a new tag
     steps:
 
 # VALIDATE TAGS
@@ -60,3 +63,28 @@ jobs:
         body: |
           SchemaCrawler AI ${{ github.event.release.tag_name }} release at last commit ${{ github.sha }}
         generate_release_notes: true
+
+# MOVE GITHUB TAG
+    - id: install-gitsign
+      name: Install gitsign for commit signing
+      # See https://github.com/chainguard-dev/actions/blob/main/setup-gitsign/action.yml
+      uses: chainguard-dev/actions/setup-gitsign@3e8a2a226fad9e1ecbf2d359b8a7697554a4ac6d
+    - id: move-tag
+      name: Move docker-mcp-registry tag
+      env:
+        GITSIGN_CONNECTOR_ID: "https://github.com/login/oauth"
+        GITSIGN_TOKEN_PROVIDER: "github-actions"
+      shell: bash
+      run: |
+        # Move docker-mcp-registry tag
+        # Set up user
+        git config user.name "Sualeh Fatehi"
+        git config user.email "sualeh@hotmail.com"
+        # Confirm gitsign is installed
+        gitsign --version
+        # Move tag
+        git tag -d docker-mcp-registry || true
+        git push --delete origin docker-mcp-registry || true
+        git tag -a docker-mcp-registry -m "SchemaCrawler AI Early Access Release"
+        git push --follow-tags origin docker-mcp-registry
+        git show docker-mcp-registry

Dockerfile

@@ -10,7 +10,7 @@
 ARG FROM_IMAGE=schemacrawler/schemacrawler:v17.1.6
 
 # BUILDER stage - Build SchemaCrawler AI
-FROM maven:3.9-eclipse-temurin-25 AS builder
+FROM maven:3.9-eclipse-temurin-21 AS builder
 
 # Copy source code
 COPY . .

schemacrawler-ai-core/pom.xml

@@ -43,7 +43,7 @@
     <dependency>
       <groupId>us.fatehi</groupId>
       <artifactId>schemacrawler</artifactId>
-    </dependency>
+    </dependency> 
     <dependency>
       <groupId>us.fatehi</groupId>
       <artifactId>schemacrawler-scripting</artifactId>

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeRoutinesFunctionParameters.java

@@ -8,14 +8,12 @@
 
 package schemacrawler.tools.ai.functions;
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import java.util.ArrayList;
 import java.util.Collection;
 import schemacrawler.tools.ai.model.AdditionalRoutineDetails;
 import schemacrawler.tools.ai.tools.FunctionParameters;
-import schemacrawler.tools.ai.tools.FunctionReturnType;
 import schemacrawler.tools.ai.tools.base.ParameterUtility;
 import tools.jackson.databind.PropertyNamingStrategies;
 import tools.jackson.databind.annotation.JsonNaming;
@@ -74,10 +72,4 @@ public AdditionalRoutineDetails toAdditionalRoutineDetails() {
   public String toString() {
     return ParameterUtility.parametersToString(this);
   }
-
-  @JsonIgnore
-  @Override
-  public final FunctionReturnType getFunctionReturnType() {
-    return FunctionReturnType.JSON;
-  }
 }

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DescribeTablesFunctionParameters.java

@@ -8,14 +8,12 @@
 
 package schemacrawler.tools.ai.functions;
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import java.util.ArrayList;
 import java.util.Collection;
 import schemacrawler.tools.ai.model.AdditionalTableDetails;
 import schemacrawler.tools.ai.tools.FunctionParameters;
-import schemacrawler.tools.ai.tools.FunctionReturnType;
 import schemacrawler.tools.ai.tools.base.ParameterUtility;
 import tools.jackson.databind.PropertyNamingStrategies;
 import tools.jackson.databind.annotation.JsonNaming;
@@ -81,10 +79,4 @@ public AdditionalTableDetails toAdditionalTableDetails() {
   public String toString() {
     return ParameterUtility.parametersToString(this);
   }
-
-  @JsonIgnore
-  @Override
-  public final FunctionReturnType getFunctionReturnType() {
-    return FunctionReturnType.JSON;
-  }
 }

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DiagramFunctionExecutor.java

@@ -8,10 +8,14 @@
 
 package schemacrawler.tools.ai.functions;
 
+import java.nio.file.Path;
 import schemacrawler.inclusionrule.InclusionRule;
 import schemacrawler.tools.ai.functions.DiagramFunctionParameters.DiagramType;
+import schemacrawler.tools.ai.tools.FunctionReturn;
 import schemacrawler.tools.ai.tools.base.AbstractExecutableFunctionExecutor;
+import schemacrawler.tools.ai.tools.base.ExecutionParameters;
 import schemacrawler.tools.options.Config;
+import schemacrawler.tools.options.ConfigUtility;
 import us.fatehi.utility.property.PropertyName;
 
 public final class DiagramFunctionExecutor
@@ -22,18 +26,17 @@ protected DiagramFunctionExecutor(final PropertyName functionName) {
   }
 
   @Override
-  protected String getCommand() {
-    return "script";
+  public FunctionReturn call() {
+    final Config additionalConfig = createAdditionalConfig();
+    final InclusionRule grepTablesInclusionRule = makeInclusionRule(commandOptions.tableName());
+    final ExecutionParameters executionParameters =
+        new ExecutionParameters("script", additionalConfig, grepTablesInclusionRule, "text");
+    final Path outputFilePath = execute(executionParameters);
+    return returnText(outputFilePath);
   }
 
-  @Override
-  protected InclusionRule grepTablesInclusionRule() {
-    return makeInclusionRule(commandOptions.tableName());
-  }
-
-  @Override
-  protected Config createAdditionalConfig() {
-    final Config additionalConfig = super.createAdditionalConfig();
+  private Config createAdditionalConfig() {
+    final Config additionalConfig = ConfigUtility.newConfig();
 
     final DiagramType diagramType = commandOptions.diagramType();
     additionalConfig.put("script-language", "python");

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/DiagramFunctionParameters.java

@@ -8,11 +8,9 @@
 
 package schemacrawler.tools.ai.functions;
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import schemacrawler.tools.ai.tools.FunctionParameters;
-import schemacrawler.tools.ai.tools.FunctionReturnType;
 import schemacrawler.tools.ai.tools.base.ParameterUtility;
 import tools.jackson.databind.PropertyNamingStrategies;
 import tools.jackson.databind.annotation.JsonNaming;
@@ -48,7 +46,7 @@ public enum DiagramType {
     private final String script;
     private final String onlineEditorUrl;
 
-    private DiagramType(final String script, final String url) {
+    DiagramType(final String script, final String url) {
       this.script = script;
       onlineEditorUrl = url;
     }
@@ -75,10 +73,4 @@ public String script() {
   public String toString() {
     return ParameterUtility.parametersToString(this);
   }
-
-  @JsonIgnore
-  @Override
-  public final FunctionReturnType getFunctionReturnType() {
-    return FunctionReturnType.TEXT;
-  }
 }

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/LintFunctionExecutor.java

@@ -8,8 +8,12 @@
 
 package schemacrawler.tools.ai.functions;
 
+import java.nio.file.Path;
 import schemacrawler.inclusionrule.InclusionRule;
+import schemacrawler.tools.ai.tools.FunctionReturn;
 import schemacrawler.tools.ai.tools.base.AbstractExecutableFunctionExecutor;
+import schemacrawler.tools.ai.tools.base.ExecutionParameters;
+import schemacrawler.tools.command.lint.options.LintReportOutputFormat;
 import us.fatehi.utility.property.PropertyName;
 
 public final class LintFunctionExecutor
@@ -20,12 +24,12 @@ protected LintFunctionExecutor(final PropertyName functionName) {
   }
 
   @Override
-  protected String getCommand() {
-    return "lint";
-  }
-
-  @Override
-  protected InclusionRule grepTablesInclusionRule() {
-    return makeInclusionRule(commandOptions.tableName());
+  public FunctionReturn call() {
+    final String outputFormat = LintReportOutputFormat.json.name();
+    final InclusionRule grepTablesInclusionRule = makeInclusionRule(commandOptions.tableName());
+    final ExecutionParameters executionParameters =
+        new ExecutionParameters("lint", grepTablesInclusionRule, outputFormat);
+    final Path outputFilePath = execute(executionParameters);
+    return returnJson(outputFilePath);
   }
 }

schemacrawler-ai-core/src/main/java/schemacrawler/tools/ai/functions/LintFunctionParameters.java

@@ -8,11 +8,9 @@
 
 package schemacrawler.tools.ai.functions;
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 import schemacrawler.tools.ai.tools.FunctionParameters;
-import schemacrawler.tools.ai.tools.FunctionReturnType;
 import schemacrawler.tools.ai.tools.base.ParameterUtility;
 import tools.jackson.databind.PropertyNamingStrategies;
 import tools.jackson.databind.annotation.JsonNaming;
@@ -41,10 +39,4 @@ table name (including the schema).
   public String toString() {
     return ParameterUtility.parametersToString(this);
   }
-
-  @JsonIgnore
-  @Override
-  public FunctionReturnType getFunctionReturnType() {
-    return FunctionReturnType.JSON;
-  }
 }