fix(apps): align missing app name errors

Reuse the shared missing-name validation for logs and render each command's documented positional argument name.

Author: simonfaltum

cmd/apps/bundle_helpers.go

@@ -42,18 +42,22 @@ func makeArgsOptionalWithBundle(cmd *cobra.Command, usage string) {
 func missingAppNameError(cmd *cobra.Command) error {
 	hint := inferAppNameHint()
 	commandPath := "databricks apps <command>"
+	argName := "APP_NAME"
 	if cmd != nil {
 		if p := cmd.CommandPath(); p != "" {
 			commandPath = p
 		}
+		if name := positionalArgName(cmd.Use); name != "" {
+			argName = name
+		}
 	}
-	msg := fmt.Sprintf(`missing required argument: APP_NAME
+	msg := fmt.Sprintf(`missing required argument: %s
 
-Usage: %s APP_NAME
+Usage: %s %s
 
-APP_NAME is the name of the Databricks app to operate on.
+%s is the name of the Databricks app to operate on.
 Alternatively, run this command from a project directory containing
-databricks.yml to auto-detect the app name.`, commandPath)
+databricks.yml to auto-detect the app name.`, argName, commandPath, argName, argName)
 
 	if hint != "" {
 		msg += fmt.Sprintf("\n\nDid you mean?\n  %s %s", commandPath, hint)
@@ -62,6 +66,15 @@ databricks.yml to auto-detect the app name.`, commandPath)
 	return errors.New(msg)
 }
 
+func positionalArgName(use string) string {
+	start := strings.Index(use, "[")
+	end := strings.Index(use, "]")
+	if start < 0 || end <= start {
+		return ""
+	}
+	return use[start+1 : end]
+}
+
 // inferAppNameHint tries to suggest an app name from the local environment.
 // Only returns a hint if the current directory looks like a Databricks app
 // (contains app.yml or app.yaml), using the directory name as the suggestion.

cmd/apps/bundle_helpers_test.go

@@ -178,17 +178,27 @@ func TestMissingAppNameError(t *testing.T) {
 		writeErr := os.WriteFile(filepath.Join(dir, "app.yml"), []byte("command: [\"python\"]"), 0o644)
 		assert.NoError(t, writeErr)
 
-		for _, verb := range []string{"deploy", "start", "stop", "delete"} {
-			t.Run(verb, func(t *testing.T) {
+		for _, tc := range []struct {
+			verb string
+			use  string
+			arg  string
+		}{
+			{"deploy", "deploy [APP_NAME]", "APP_NAME"},
+			{"start", "start [NAME]", "NAME"},
+			{"stop", "stop [NAME]", "NAME"},
+			{"delete", "delete [NAME]", "NAME"},
+		} {
+			t.Run(tc.verb, func(t *testing.T) {
 				root := &cobra.Command{Use: "databricks"}
 				apps := &cobra.Command{Use: "apps"}
-				sub := &cobra.Command{Use: verb}
+				sub := &cobra.Command{Use: tc.use}
 				root.AddCommand(apps)
 				apps.AddCommand(sub)
 
 				err := missingAppNameError(sub)
-				assert.Contains(t, err.Error(), "Usage: databricks apps "+verb+" APP_NAME")
-				assert.Contains(t, err.Error(), "databricks apps "+verb+" "+filepath.Base(dir))
+				assert.Contains(t, err.Error(), "missing required argument: "+tc.arg)
+				assert.Contains(t, err.Error(), "Usage: databricks apps "+tc.verb+" "+tc.arg)
+				assert.Contains(t, err.Error(), "databricks apps "+tc.verb+" "+filepath.Base(dir))
 			})
 		}
 	})
@@ -215,6 +225,17 @@ func TestMakeArgsOptionalWithBundle(t *testing.T) {
 		makeArgsOptionalWithBundle(cmd, "test [NAME]")
 		assert.NotNil(t, cmd.Args)
 	})
+
+	t.Run("returns missing app name error when no bundle config exists", func(t *testing.T) {
+		t.Chdir(t.TempDir())
+
+		cmd := &cobra.Command{}
+		makeArgsOptionalWithBundle(cmd, "test [NAME]")
+
+		err := cmd.Args(cmd, nil)
+		assert.Error(t, err)
+		assert.Contains(t, err.Error(), "missing required argument: NAME")
+	})
 }
 
 func TestGetAppNameFromArgs(t *testing.T) {

cmd/apps/logs.go

@@ -46,7 +46,6 @@ func newLogsCommand() *cobra.Command {
 	)
 
 	cmd := &cobra.Command{
-		Use:   "logs [NAME]",
 		Short: "Show Databricks app logs",
 		Long: `Show Databricks app logs.
 
@@ -78,15 +77,6 @@ Examples:
 
   # Mirror streamed logs to a local file while following for up to 5 minutes
   databricks apps logs my-app --follow --timeout 5m --output-file /tmp/my-app.log`,
-		Args: func(cmd *cobra.Command, args []string) error {
-			if len(args) > 1 {
-				return fmt.Errorf("accepts at most 1 arg(s), received %d", len(args))
-			}
-			if !hasBundleConfig() && len(args) != 1 {
-				return fmt.Errorf("accepts 1 arg(s), received %d", len(args))
-			}
-			return nil
-		},
 		PreRunE: root.MustWorkspaceClient,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			appName, fromBundle, err := getAppNameFromArgs(cmd, args)
@@ -207,6 +197,7 @@ Examples:
 			})
 		},
 	}
+	makeArgsOptionalWithBundle(cmd, "logs [NAME]")
 
 	streamGroup := cmdgroup.NewFlagGroup("Streaming")
 	streamGroup.FlagSet().IntVar(&tailLines, "tail-lines", defaultTailLines, "Number of recent log lines to show before streaming. Set to 0 to show everything.")

cmd/apps/logs_test.go

@@ -64,6 +64,17 @@ func TestBuildLogsURLRejectsUnknownScheme(t *testing.T) {
 	require.Error(t, err)
 }
 
+func TestLogsMissingNameError(t *testing.T) {
+	t.Chdir(t.TempDir())
+
+	cmd := newLogsCommand()
+	err := cmd.Args(cmd, nil)
+
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "missing required argument: NAME")
+	assert.Contains(t, err.Error(), "Usage: logs NAME")
+}
+
 func TestNormalizeOrigin(t *testing.T) {
 	assert.Equal(t, "https://example.com", normalizeOrigin("https://example.com/foo"))
 	assert.Equal(t, "http://example.com", normalizeOrigin("ws://example.com/foo"))