pipelines: open command (#3223)

## Changes
New `pipelines open` command to open commands in the browser. Copied
from cmd/bundle/open.go


## Tests
Acceptance tests copied from `acceptance/bundle/open/open`: test open
only on macos

Author: alyssa-db

acceptance/pipelines/install-pipelines-cli/output.txt

@@ -16,6 +16,7 @@ Available Commands:
   destroy     Destroy a pipelines project
   help        Help about any command
   init        Initialize a new pipelines project
+  open        Open a pipeline in the browser
   run         Run a pipeline
   version     Retrieve information about the current version of the Pipelines CLI
 
@@ -57,6 +58,7 @@ Available Commands:
   destroy     Destroy a pipelines project
   help        Help about any command
   init        Initialize a new pipelines project
+  open        Open a pipeline in the browser
   run         Run a pipeline
   version     Retrieve information about the current version of the Pipelines CLI
 

acceptance/pipelines/open/databricks.yml

@@ -0,0 +1,17 @@
+bundle:
+  name: caterpillar
+
+resources:
+  jobs:
+    foo:
+      name: foo
+      tasks:
+        - task_key: task
+          spark_python_task:
+            python_file: ./foo.py
+          environment_key: default
+
+      environments:
+        - environment_key: default
+          spec:
+            client: "2"

acceptance/pipelines/open/foo.py

@@ -0,0 +1 @@
+print(1)

acceptance/pipelines/open/open

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "I AM BROWSER"

acceptance/pipelines/open/out.test.toml

@@ -0,0 +1,9 @@
+Local = true
+Cloud = false
+
+[GOOS]
+  linux = false
+  windows = false
+
+[EnvMatrix]
+  DATABRICKS_CLI_DEPLOYMENT = ["terraform", "direct-exp"]

acceptance/pipelines/open/output.txt

@@ -0,0 +1,26 @@
+
+=== no run key specified
+>>> [PIPELINES] open
+Error: expected a KEY of the pipeline to open
+
+Exit code: 1
+
+=== not deployed yet
+>>> [PIPELINES] open foo
+Error: pipeline does not have a URL associated with it (has it been deployed?)
+
+Exit code: 1
+
+>>> [PIPELINES] deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/caterpillar/default/files...
+Deploying resources...
+Updating deployment state...
+Deployment complete!
+
+=== Modify PATH so that real open is not run
+=== open after deployment. This will fail to open browser and complain, that's ok, we only want the message
+>>> [PIPELINES] open foo
+Opening browser at [DATABRICKS_URL]/jobs/[NUMID]?o=[NUMID]
+Error: exec: "open": cannot run executable found relative to current directory
+
+Exit code (musterr): 1

acceptance/pipelines/open/script

@@ -0,0 +1,13 @@
+title "no run key specified"
+errcode trace $PIPELINES open
+
+title "not deployed yet"
+errcode trace $PIPELINES open foo
+
+errcode trace $PIPELINES deploy
+
+title "Modify PATH so that real open is not run"
+export PATH=.:$PATH
+
+title "open after deployment. This will fail to open browser and complain, that's ok, we only want the message"
+musterr trace $PIPELINES open foo

acceptance/pipelines/open/test.toml

@@ -0,0 +1,2 @@
+GOOS.windows = false
+GOOS.linux = false

cmd/bundle/open.go

@@ -1,3 +1,5 @@
+// Copied to cmd/pipelines/open.go and adapted for pipelines use.
+// Consider if changes made here should be made to the pipelines counterpart as well.
 package bundle
 
 import (

cmd/pipelines/open.go

@@ -0,0 +1,157 @@
+// Copied from cmd/bundle/open.go and adapted for pipelines use.
+// Consider if changes made here should be made to the bundle counterpart as well.
+package pipelines
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/databricks/cli/bundle"
+	"github.com/databricks/cli/bundle/config/mutator"
+	"github.com/databricks/cli/bundle/deploy/terraform"
+	"github.com/databricks/cli/bundle/phases"
+	"github.com/databricks/cli/bundle/resources"
+	"github.com/databricks/cli/bundle/statemgmt"
+	"github.com/databricks/cli/cmd/bundle/utils"
+	"github.com/databricks/cli/cmd/root"
+	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/logdiag"
+	"github.com/spf13/cobra"
+	"golang.org/x/exp/maps"
+
+	"github.com/pkg/browser"
+)
+
+func promptOpenArgument(ctx context.Context, b *bundle.Bundle) (string, error) {
+	// Compute map of "Human readable name of resource" -> "resource key".
+	inv := make(map[string]string)
+	for k, ref := range resources.Completions(b) {
+		title := fmt.Sprintf("%s: %s", ref.Description.SingularTitle, ref.Resource.GetName())
+		inv[title] = k
+	}
+
+	key, err := cmdio.Select(ctx, inv, "Pipeline to open")
+	if err != nil {
+		return "", err
+	}
+
+	return key, nil
+}
+
+func resolveOpenArgument(ctx context.Context, b *bundle.Bundle, args []string) (string, error) {
+	// If no arguments are specified, prompt the user to select the resource to open.
+	if len(args) == 0 && cmdio.IsPromptSupported(ctx) {
+		return promptOpenArgument(ctx, b)
+	}
+
+	if len(args) < 1 {
+		return "", errors.New("expected a KEY of the pipeline to open")
+	}
+
+	return args[0], nil
+}
+
+func openCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "open",
+		Short: "Open a pipeline in the browser",
+		Args:  root.MaximumNArgs(1),
+	}
+
+	var forcePull bool
+	cmd.Flags().BoolVar(&forcePull, "force-pull", false, "Skip local cache and load the state from the remote workspace")
+
+	cmd.RunE = func(cmd *cobra.Command, args []string) error {
+		ctx := logdiag.InitContext(cmd.Context())
+		cmd.SetContext(ctx)
+
+		b := utils.ConfigureBundleWithVariables(cmd)
+		if b == nil || logdiag.HasError(ctx) {
+			return root.ErrAlreadyPrinted
+		}
+
+		phases.Initialize(ctx, b)
+		if logdiag.HasError(ctx) {
+			return root.ErrAlreadyPrinted
+		}
+
+		arg, err := resolveOpenArgument(ctx, b, args)
+		if err != nil {
+			return err
+		}
+
+		cacheDir, err := terraform.Dir(ctx, b)
+		if err != nil {
+			return err
+		}
+		_, stateFileErr := os.Stat(filepath.Join(cacheDir, b.StateFilename()))
+		_, configFileErr := os.Stat(filepath.Join(cacheDir, terraform.TerraformConfigFileName))
+		noCache := errors.Is(stateFileErr, os.ErrNotExist) || errors.Is(configFileErr, os.ErrNotExist)
+
+		if forcePull || noCache {
+			bundle.ApplyContext(ctx, b, statemgmt.StatePull())
+			if logdiag.HasError(ctx) {
+				return root.ErrAlreadyPrinted
+			}
+
+			if !b.DirectDeployment {
+				bundle.ApplySeqContext(ctx, b,
+					terraform.Interpolate(),
+					terraform.Write(),
+				)
+			}
+
+			if logdiag.HasError(ctx) {
+				return root.ErrAlreadyPrinted
+			}
+		}
+
+		bundle.ApplySeqContext(ctx, b,
+			statemgmt.Load(),
+			mutator.InitializeURLs(),
+		)
+		if logdiag.HasError(ctx) {
+			return root.ErrAlreadyPrinted
+		}
+
+		// Locate resource to open.
+		ref, err := resources.Lookup(b, arg)
+		if err != nil {
+			return err
+		}
+
+		// Confirm that the resource has a URL.
+		url := ref.Resource.GetURL()
+		if url == "" {
+			return errors.New("pipeline does not have a URL associated with it (has it been deployed?)")
+		}
+
+		cmdio.LogString(ctx, "Opening browser at "+url)
+		return browser.OpenURL(url)
+	}
+
+	cmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		b := root.MustConfigureBundle(cmd)
+		if logdiag.HasError(cmd.Context()) {
+			return nil, cobra.ShellCompDirectiveError
+		}
+
+		// No completion in the context of a bundle.
+		// Source and destination paths are taken from bundle configuration.
+		if b == nil {
+			return nil, cobra.ShellCompDirectiveNoFileComp
+		}
+
+		if len(args) == 0 {
+			completions := resources.Completions(b)
+			return maps.Keys(completions), cobra.ShellCompDirectiveNoFileComp
+		} else {
+			return nil, cobra.ShellCompDirectiveNoFileComp
+		}
+	}
+
+	return cmd
+}