New tool build integration

cli/ballerina-cli/build.gradle

@@ -80,6 +80,7 @@ dependencies {
     testRuntimeOnly project(':project-api-test-artifact:log-creator-in-built-code-modifier')
     testRuntimeOnly project(':project-api-test-artifact:log-creator-in-built-code-generator')
     testRuntimeOnly project(':project-api-test-artifact:log-creator-in-built-code-analyzer')
+    testRuntimeOnly project(':project-api-test-artifact:sample-openapi-build-tool')
 
     compilerPluginJar project(':project-api-test-artifact:log-creator-pkg-provided-code-modifier')
     compilerPluginJar project(':project-api-test-artifact:log-creator-pkg-provided-code-generator')

cli/ballerina-cli/src/main/java/io/ballerina/cli/cmd/BuildCommand.java

@@ -24,6 +24,7 @@
 import io.ballerina.cli.task.CreateExecutableTask;
 import io.ballerina.cli.task.DumpBuildTimeTask;
 import io.ballerina.cli.task.ResolveMavenDependenciesTask;
+import io.ballerina.cli.task.RunBallerinaPreBuildToolsTask;
 import io.ballerina.cli.utils.BuildTime;
 import io.ballerina.cli.utils.FileUtils;
 import io.ballerina.projects.BuildOptions;
@@ -277,6 +278,7 @@ public void execute() {
         TaskExecutor taskExecutor = new TaskExecutor.TaskBuilder()
                 // clean the target directory(projects only)
                 .addTask(new CleanTargetDirTask(isPackageModified, buildOptions.enableCache()), isSingleFileBuild)
+                .addTask(new RunBallerinaPreBuildToolsTask(outStream))
                 // resolve maven dependencies in Ballerina.toml
                 .addTask(new ResolveMavenDependenciesTask(outStream))
                 // compile the modules

cli/ballerina-cli/src/main/java/io/ballerina/cli/cmd/CleanCommand.java

@@ -43,7 +43,7 @@
     private final PrintStream outStream;
     private final Path projectPath;
     private boolean exitWhenFinish;
-    
+
     @CommandLine.Option(names = {"--help", "-h"}, hidden = true)
     private boolean helpFlag;
 
@@ -62,9 +62,9 @@
         this.exitWhenFinish = true;
     }
 
-    public CleanCommand(Path projectPath, boolean exitWhenFinish, Path targetDir) {
+    public CleanCommand(Path projectPath, PrintStream printStream, boolean exitWhenFinish, Path targetDir) {
         this.projectPath = projectPath;
-        this.outStream =  System.out;
+        this.outStream =  printStream;
         this.exitWhenFinish = exitWhenFinish;
         this.targetDir = targetDir;
     }
@@ -93,18 +93,31 @@
             CommandUtil.printError(this.outStream,
                     "provided target directory '" + this.targetDir + "' does not exist.",
                     null, false);
-            CommandUtil.exitError(this.exitWhenFinish);
-            return;
-        }
-        if (!Files.isDirectory(this.targetDir)) {
+        } else if (!Files.isDirectory(this.targetDir)) {
             CommandUtil.printError(this.outStream,
                     "provided target path '" + this.targetDir + "' is not a directory.",
                     null, false);
+        } else {
+            ProjectUtils.deleteDirectory(this.targetDir);
+            this.outStream.println("Successfully deleted '" + this.targetDir + "'.");
+        }
+
+        //delete the generated directory
+        Path generatedDir;
+        try {
+            Project project = BuildProject.load(this.projectPath);
+            generatedDir = project.sourceRoot().resolve(ProjectConstants.GENERATED_MODULES_ROOT);
+        } catch (ProjectException e) {
+            CommandUtil.printError(this.outStream, e.getMessage(), null, false);
             CommandUtil.exitError(this.exitWhenFinish);
             return;
         }
-        ProjectUtils.deleteDirectory(this.targetDir);
-        this.outStream.println("Successfully deleted '" + this.targetDir + "'.");
+        if (Files.notExists(generatedDir)) {
+            this.outStream.println("Existing generated directory was not found");
+        } else {
+            ProjectUtils.deleteDirectory(generatedDir);
+            this.outStream.println("Successfully deleted '" + generatedDir + "'.");
+        }
     }
 
     @Override

cli/ballerina-cli/src/main/java/io/ballerina/cli/task/RunBallerinaPreBuildToolsTask.java

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2023, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ *
+ * WSO2 Inc. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package io.ballerina.cli.task;
+
+import io.ballerina.cli.tool.CodeGeneratorTool;
+import io.ballerina.cli.utils.FileUtils;
+import io.ballerina.projects.Project;
+import io.ballerina.projects.ProjectException;
+import io.ballerina.projects.ToolContext;
+import io.ballerina.toml.api.Toml;
+import io.ballerina.tools.diagnostics.Diagnostic;
+import io.ballerina.tools.diagnostics.DiagnosticSeverity;
+
+import java.io.IOException;
+import java.io.PrintStream;
+import java.util.Collection;
+import java.util.List;
+import java.util.ServiceLoader;
+
+import static io.ballerina.cli.launcher.LauncherUtils.createLauncherException;
+import static io.ballerina.projects.PackageManifest.Tool;
+
+/**
+ * Task for running tools integrated with the build.
+ *
+ * @since 2201.9.0
+ */
+public class RunBallerinaPreBuildToolsTask implements Task {
+
+    private final PrintStream outStream;
+
+    public RunBallerinaPreBuildToolsTask(PrintStream out) {
+        this.outStream = out;
+    }
+
+    @Override
+    public void execute(Project project) {
+        Collection<Diagnostic> toolDiagnostics = project.currentPackage().manifest().diagnostics().diagnostics();
+        boolean hasTomlErrors = project.currentPackage().manifest().diagnostics().hasErrors();
+        if (hasTomlErrors) {
+            toolDiagnostics.forEach(outStream::println);
+            throw createLauncherException("compilation contains errors");
+        }
+        List<Tool> tools = project.currentPackage().manifest().tools();
+        ServiceLoader<CodeGeneratorTool> buildRunners = ServiceLoader.load(CodeGeneratorTool.class);
+        for (Tool tool : tools) {
+            try {
+                String commandName = tool.getType();
+                CodeGeneratorTool targetTool = getTargetTool(commandName, buildRunners);
+                if (targetTool == null) {
+                    // TODO: Install tool if not found
+                    outStream.println("Command not found: " + commandName);
+                    return;
+                }
+                try {
+                    validateOptionsToml(tool.getOptionsToml(), commandName);
+                } catch (IOException e) {
+                    outStream.println("WARNING: Skipping the validation of tool options due to: " +
+                        e.getMessage());
+                }
+                ToolContext toolContext = ToolContext.from(tool, project.currentPackage());
+                targetTool.execute(toolContext);
+                toolContext.diagnostics().forEach(outStream::println);
+                for (Diagnostic d : toolContext.diagnostics()) {
+                    if (d.diagnosticInfo().severity().equals(DiagnosticSeverity.ERROR)) {
+                        throw new ProjectException("compilation contains errors");
+                    }
+                }
+            } catch (ProjectException e) {
+                throw createLauncherException(e.getMessage());
+            }
+        }
+    }
+
+    private CodeGeneratorTool getTargetTool(String commandName, ServiceLoader<CodeGeneratorTool> buildRunners) {
+        for (CodeGeneratorTool buildRunner : buildRunners) {
+            if (buildRunner.toolName().equals(commandName)) {
+                return buildRunner;
+            }
+        }
+        return null;
+    }
+
+    private void validateOptionsToml(Toml optionsToml, String toolName) throws IOException {
+        if (optionsToml == null) {
+            throw new IOException("No tool options found");
+        }
+        FileUtils.validateToml(optionsToml, toolName);
+        optionsToml.diagnostics().forEach(outStream::println);
+        for (Diagnostic d : optionsToml.diagnostics()) {
+            if (d.diagnosticInfo().severity().equals(DiagnosticSeverity.ERROR)) {
+                throw new ProjectException("compilation contains errors");
+            }
+        }
+    }
+}

cli/ballerina-cli/src/main/java/io/ballerina/cli/tool/CodeGeneratorTool.java

@@ -0,0 +1,24 @@
+package io.ballerina.cli.tool;
+
+import io.ballerina.projects.ToolContext;
+
+/**
+ * {@code CodeGeneratorTool} represents a Ballerina build tool.
+ *
+ * @since 2201.9.0
+ */
+public interface CodeGeneratorTool {
+    /**
+     * Execute the command.
+     *
+     * @param  toolContext the {@link ToolContext} of the build tool
+     */
+    void execute(ToolContext toolContext);
+
+    /**
+     * Retrieve the tool name.
+     *
+     * @return the name of the tool.
+     */
+    String toolName();
+}

cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/FileUtils.java

@@ -18,6 +18,16 @@
 
 package io.ballerina.cli.utils;
 
+import io.ballerina.toml.api.Toml;
+import io.ballerina.toml.validator.TomlValidator;
+import io.ballerina.toml.validator.schema.Schema;
+
+import java.io.BufferedReader;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.util.Optional;
 
@@ -88,4 +98,35 @@
             return Math.max(lastUnixPos, lastWindowsPos);
         }
     }
+
+    public static String readSchema(String toolName) throws IOException {
+        String schemaFilePath = toolName + "-options-schema.json";
+        InputStream inputStream = io.ballerina.projects.util.FileUtils.class.getClassLoader()
+                .getResourceAsStream(schemaFilePath);
+
+        if (inputStream == null) {
+            throw new FileNotFoundException("Schema file for tool options inputStream not found: " + schemaFilePath);
+        }
+        StringBuilder sb = new StringBuilder();
+        try (
+                InputStreamReader inputStreamReader = new InputStreamReader(inputStream, StandardCharsets.UTF_8);
+                BufferedReader br = new BufferedReader(inputStreamReader);
+        ) {
+            String content;
+            while ((content = br.readLine()) != null) {
+                if (sb.length() > 0) {
+                    sb.append('\n');
+                }
+                sb.append(content);
+            }
+        }
+
+        return sb.toString();
+    }
+
+    public static void validateToml(Toml optionsToml, String toolName) throws IOException {
+        Schema schema = Schema.from(FileUtils.readSchema(toolName));
+        TomlValidator tomlValidator = new TomlValidator(schema);
+        tomlValidator.validate(optionsToml);
+    }
 }

cli/ballerina-cli/src/main/java/module-info.java

@@ -4,6 +4,7 @@
     exports io.ballerina.cli.launcher;
     exports io.ballerina.cli.utils;
     exports io.ballerina.cli.cmd;
+    exports io.ballerina.cli.tool;
 
     requires io.ballerina.runtime;
     requires io.ballerina.lang;