Add validate runs for pipelines (#1436)

## Changes
Validate action is available as a separate button on the pipeline item
in the resource explorer:


<img width="748" alt="Screenshot 2024-11-01 at 10 02 27"
src="https://github.com/user-attachments/assets/5dd2a147-f074-4443-9018-b101e53439c6">

Haven't found a super suitable icon for this action (in the workspace we
don't use any icons for the validate action). Currently using the
"beaker" icon that's generally used in tests, and reached out to the
designers for help.

## Tests
Yes

Author: ilia-db

packages/databricks-vscode/package.json

@@ -224,6 +224,13 @@
                 "enablement": "databricks.context.activated && databricks.context.bundle.isTargetSet && databricks.context.bundle.deploymentState == idle",
                 "category": "Databricks"
             },
+            {
+                "command": "databricks.bundle.deployAndValidate",
+                "icon": "$(beaker)",
+                "title": "Deploy the bundle and validate the pipeline",
+                "enablement": "databricks.context.activated && databricks.context.bundle.isTargetSet && databricks.context.bundle.deploymentState == idle",
+                "category": "Databricks"
+            },
             {
                 "command": "databricks.bundle.cancelRun",
                 "title": "Cancel run",
@@ -544,6 +551,11 @@
                     "when": "view == dabsResourceExplorerView && viewItem =~ /^databricks.bundle.*.runnable.*$/ && databricks.context.bundle.deploymentState == idle",
                     "group": "inline@0"
                 },
+                {
+                    "command": "databricks.bundle.deployAndValidate",
+                    "when": "view == dabsResourceExplorerView && viewItem =~ /^databricks.bundle.resource=pipelines.runnable.*$/ && databricks.context.bundle.deploymentState == idle",
+                    "group": "inline@0"
+                },
                 {
                     "command": "databricks.bundle.cancelRun",
                     "when": "view == dabsResourceExplorerView && viewItem =~ /^databricks.bundle.*.cancellable.*$/ && databricks.context.bundle.deploymentState == idle",
@@ -645,6 +657,10 @@
                     "command": "databricks.bundle.deployAndRun",
                     "when": "false"
                 },
+                {
+                    "command": "databricks.bundle.deployAndValidate",
+                    "when": "false"
+                },
                 {
                     "command": "databricks.bundle.cancelRun",
                     "when": "false"

packages/databricks-vscode/src/bundle/models/BundleRemoteStateModel.ts

@@ -122,7 +122,10 @@ export class BundleRemoteStateModel extends BaseModelWithStateCache<BundleRemote
         );
     }
 
-    public async getRunCommand(resourceKey: string) {
+    public async getRunCommand(
+        resourceKey: string,
+        additionalArgs: string[] = []
+    ) {
         if (this.target === undefined) {
             throw new Error("Target is undefined");
         }
@@ -135,7 +138,8 @@ export class BundleRemoteStateModel extends BaseModelWithStateCache<BundleRemote
             this.authProvider,
             resourceKey,
             this.workspaceFolder,
-            this.workspaceConfigs.databrickscfgLocation
+            this.workspaceConfigs.databrickscfgLocation,
+            additionalArgs
         );
     }
 

packages/databricks-vscode/src/bundle/run/BundleRunStatusManager.ts

@@ -60,7 +60,8 @@ export class BundleRunStatusManager implements Disposable {
 
     async run(
         resourceKey: string,
-        resourceType: ResourceKey<BundleRemoteState>
+        resourceType: ResourceKey<BundleRemoteState>,
+        additionalArgs: string[] = []
     ) {
         const target = this.configModel.target;
         const authProvider = this.configModel.authProvider;
@@ -99,7 +100,8 @@ export class BundleRunStatusManager implements Disposable {
         try {
             const result = await this.bundleRunTerminalManager.run(
                 resourceKey,
-                (data) => remoteRunStatus.parseId(data)
+                (data) => remoteRunStatus.parseId(data),
+                additionalArgs
             );
             if (result.cancelled) {
                 await remoteRunStatus.cancel();

packages/databricks-vscode/src/bundle/run/BundleRunTerminalManager.ts

@@ -25,7 +25,8 @@ export class BundleRunTerminalManager implements Disposable {
 
     async run(
         resourceKey: string,
-        onDidUpdate?: (data: string) => void
+        onDidUpdate?: (data: string) => void,
+        additionalArgs: string[] = []
     ): Promise<{cancelled: boolean; exitCode?: number | null}> {
         const target = this.bundleRemoteStateModel.target;
         if (target === undefined) {
@@ -72,8 +73,10 @@ export class BundleRunTerminalManager implements Disposable {
                     onCancellationEvent.dispose();
                 }, this.disposables);
 
-            const cmd =
-                await this.bundleRemoteStateModel.getRunCommand(resourceKey);
+            const cmd = await this.bundleRemoteStateModel.getRunCommand(
+                resourceKey,
+                additionalArgs
+            );
 
             // spawn a new process with the latest command, in the same terminal.
             terminal.pty.spawn(cmd);

packages/databricks-vscode/src/cli/CliWrapper.ts

@@ -690,7 +690,8 @@ export class CliWrapper {
         authProvider: AuthProvider,
         resourceKey: string,
         workspaceFolder: Uri,
-        configfilePath?: string
+        configfilePath?: string,
+        additionalArgs: string[] = []
     ): Promise<{
         cmd: string;
         args: string[];
@@ -711,7 +712,14 @@ export class CliWrapper {
 
         return {
             cmd: this.cliPath,
-            args: ["bundle", "run", "--target", target, resourceKey],
+            args: [
+                "bundle",
+                "run",
+                "--target",
+                target,
+                resourceKey,
+                ...additionalArgs,
+            ],
             options: {
                 cwd: workspaceFolder.fsPath,
                 env,

packages/databricks-vscode/src/extension.ts

@@ -680,6 +680,11 @@ export async function activate(
             bundleCommands.deployAndRun,
             bundleCommands
         ),
+        telemetry.registerCommand(
+            "databricks.bundle.deployAndValidate",
+            bundleCommands.deployAndValidate,
+            bundleCommands
+        ),
         telemetry.registerCommand(
             "databricks.bundle.cancelRun",
             bundleCommands.cancelRun,

packages/databricks-vscode/src/telemetry/constants.ts

@@ -30,6 +30,7 @@ export type ManualLoginSource =
     | "command"
     | "api";
 export type BundleRunResourceType = "pipelines" | "jobs";
+export type BundleRunType = "run" | "validate" | "partial-refresh";
 
 /** Documentation about all of the properties and metrics of the event. */
 type EventDescription<T> = {[K in keyof T]?: {comment?: string}};
@@ -129,6 +130,7 @@ export class EventTypes {
             success: boolean;
             cancelled?: boolean;
             resourceType?: BundleRunResourceType;
+            runType?: BundleRunType;
         } & DurationMeasurement
     > = {
         comment: "Execute a bundle resource",

packages/databricks-vscode/src/test/e2e/deploy_and_run_job.e2e.ts

@@ -1,89 +1,25 @@
 import assert from "node:assert";
 import {
     dismissNotifications,
-    getUniqueResourceName,
     getViewSection,
+    waitForDeployment,
     waitForLogin,
     waitForTreeItems,
 } from "./utils/commonUtils.ts";
 import {CustomTreeSection, Workbench} from "wdio-vscode-service";
+import {createProjectWithJob} from "./utils/dabsFixtures.ts";
 import {
-    getBasicBundleConfig,
-    getSimpleJobsResource,
-    writeRootBundleConfig,
-} from "./utils/dabsFixtures.ts";
-import path from "node:path";
-import fs from "fs/promises";
-import {BundleSchema} from "../../bundle/types.ts";
-import {getJobViewItem} from "./utils/dabsExplorerUtils.ts";
-import {fileURLToPath} from "url";
-
-/* eslint-disable @typescript-eslint/naming-convention */
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-/* eslint-enable @typescript-eslint/naming-convention */
+    getResourceViewItem,
+    waitForRunStatus,
+} from "./utils/dabsExplorerUtils.ts";
 
 describe("Deploy and run job", async function () {
     let workbench: Workbench;
     let resourceExplorerView: CustomTreeSection;
-    let vscodeWorkspaceRoot: string;
     let jobName: string;
-    let clusterId: string;
 
     this.timeout(3 * 60 * 1000);
 
-    async function createProjectWithJob() {
-        /**
-         * process.env.WORKSPACE_PATH (cwd)
-         *  ├── databricks.yml
-         *  └── src
-         *    └── notebook.ipynb
-         */
-
-        const projectName = getUniqueResourceName("deploy_and_run_job");
-        const notebookTaskName = getUniqueResourceName("notebook_task");
-        /* eslint-disable @typescript-eslint/naming-convention */
-        const jobDef = getSimpleJobsResource({
-            tasks: [
-                {
-                    task_key: notebookTaskName,
-                    notebook_task: {
-                        notebook_path: "src/notebook.ipynb",
-                    },
-                    existing_cluster_id: clusterId,
-                },
-            ],
-        });
-        jobName = jobDef.name!;
-
-        const schemaDef: BundleSchema = getBasicBundleConfig({
-            bundle: {
-                name: projectName,
-                deployment: {},
-            },
-            targets: {
-                dev_test: {
-                    resources: {
-                        jobs: {
-                            vscode_integration_test: jobDef,
-                        },
-                    },
-                },
-            },
-        });
-        /* eslint-enable @typescript-eslint/naming-convention */
-
-        await writeRootBundleConfig(schemaDef, vscodeWorkspaceRoot);
-
-        await fs.mkdir(path.join(vscodeWorkspaceRoot, "src"), {
-            recursive: true,
-        });
-        await fs.copyFile(
-            path.join(__dirname, "resources", "spark_select_1.ipynb"),
-            path.join(vscodeWorkspaceRoot, "src", "notebook.ipynb")
-        );
-    }
-
     before(async function () {
         assert(
             process.env.TEST_DEFAULT_CLUSTER_ID,
@@ -98,10 +34,11 @@ describe("Deploy and run job", async function () {
             "DATABRICKS_HOST env var doesn't exist"
         );
 
-        clusterId = process.env.TEST_DEFAULT_CLUSTER_ID;
         workbench = await browser.getWorkbench();
-        vscodeWorkspaceRoot = process.env.WORKSPACE_PATH;
-        await createProjectWithJob();
+        jobName = await createProjectWithJob(
+            process.env.WORKSPACE_PATH,
+            process.env.TEST_DEFAULT_CLUSTER_ID
+        );
         await dismissNotifications();
     });
 
@@ -127,7 +64,11 @@ describe("Deploy and run job", async function () {
         await outputView.selectChannel("Databricks Bundle Logs");
         await outputView.clearText();
 
-        const jobItem = await getJobViewItem(resourceExplorerView, jobName);
+        const jobItem = await getResourceViewItem(
+            resourceExplorerView,
+            "Workflows",
+            jobName
+        );
         assert(jobItem, `Job ${jobName} not found in resource explorer`);
 
         const deployAndRunButton = await jobItem.getActionButton(
@@ -136,72 +77,13 @@ describe("Deploy and run job", async function () {
         assert(deployAndRunButton, "Deploy and run button not found");
         await deployAndRunButton.elem.click();
 
-        console.log("Waiting for deployment to finish");
-        // Wait for the deployment to finish
-        await browser.waitUntil(
-            async () => {
-                try {
-                    await browser.executeWorkbench(async (vscode) => {
-                        await vscode.commands.executeCommand(
-                            "workbench.panel.output.focus"
-                        );
-                    });
-                    const outputView = await workbench
-                        .getBottomBar()
-                        .openOutputView();
-
-                    if (
-                        (await outputView.getCurrentChannel()) !==
-                        "Databricks Bundle Logs"
-                    ) {
-                        await outputView.selectChannel(
-                            "Databricks Bundle Logs"
-                        );
-                    }
-
-                    const logs = (await outputView.getText()).join("");
-                    console.log(logs);
-                    return (
-                        logs.includes("Bundle deployed successfully") &&
-                        logs.includes("Bundle configuration refreshed")
-                    );
-                } catch (e) {
-                    return false;
-                }
-            },
-            {
-                timeout: 60_000,
-                interval: 1_000,
-                timeoutMsg:
-                    "Can't find 'Bundle deployed successfully' message in output channel",
-            }
-        );
-
-        console.log("Waiting for run to finish");
-        // Wait for status to reach success
-        await browser.waitUntil(
-            async () => {
-                const jobItem = await getJobViewItem(
-                    resourceExplorerView,
-                    jobName
-                );
-                if (jobItem === undefined) {
-                    return false;
-                }
-
-                const runStatusItem = await jobItem.findChildItem("Run Status");
-                if (runStatusItem === undefined) {
-                    return false;
-                }
+        await waitForDeployment();
 
-                return (await runStatusItem.getDescription()) === "Success";
-            },
-            {
-                timeout: 120_000,
-                interval: 2_000,
-                timeoutMsg:
-                    "The run status didn't reach success within 120 seconds",
-            }
+        await waitForRunStatus(
+            resourceExplorerView,
+            "Workflows",
+            jobName,
+            "Success"
         );
     });
 });