Add name, target and mode to deployment metadata (#4180)

## Changes
Adding new fields to the metadata to use for Workspace deployments

## Why
We need these fields to run Job->YAML sync 

## Tests
Added unit test and updated job acceptance test
 
<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->

Author: ilyakuz-db

acceptance/bundle/resources/jobs/check-metadata/databricks.yml.tmpl

@@ -1,6 +1,10 @@
 bundle:
   name: deploy-jobs-check-metadata-$UNIQUE_NAME
 
+targets:
+  default:
+    mode: development
+
 workspace:
   root_path: ~/.bundle/$UNIQUE_NAME
 

acceptance/bundle/resources/jobs/check-metadata/output.txt

@@ -23,12 +23,12 @@ Deployment complete!
 
 === Assert job 1 is created
 {
-  "name": "test-job-metadata-1-[UNIQUE_NAME]"
+  "name": "[dev [USERNAME]] test-job-metadata-1-[UNIQUE_NAME]"
 }
 
 === Assert job 2 is created
 {
-  "name": "test-job-metadata-2-[UNIQUE_NAME]"
+  "name": "[dev [USERNAME]] test-job-metadata-2-[UNIQUE_NAME]"
 }
 
 === Read metadata object from the workspace
@@ -39,6 +39,9 @@ Deployment complete!
   "version": 1,
   "config": {
     "bundle": {
+      "name": "deploy-jobs-check-metadata-[UNIQUE_NAME]",
+      "target": "default",
+      "mode": "development",
       "git": {
         "bundle_root_path": "."
       }
@@ -71,6 +74,16 @@ Deployment complete!
 >>> cat metadata.json
           "id": "[JOB_2_ID]",
 
+=== Check that metadata contains bundle name, target, and mode
+>>> cat metadata.json
+"deploy-jobs-check-metadata-[UNIQUE_NAME]"
+
+>>> cat metadata.json
+"default"
+
+>>> cat metadata.json
+"development"
+
 >>> [CLI] bundle destroy --auto-approve
 The following resources will be deleted:
   delete resources.jobs.bar

acceptance/bundle/resources/jobs/check-metadata/script

@@ -31,3 +31,8 @@ trace cat metadata.json
 title "Check that metadata contains created job ids"
 trace cat metadata.json | grep "${JOB_1_ID}"
 trace cat metadata.json | grep "${JOB_2_ID}"
+
+title "Check that metadata contains bundle name, target, and mode"
+trace cat metadata.json | jq '.config.bundle.name'
+trace cat metadata.json | jq '.config.bundle.target'
+trace cat metadata.json | jq '.config.bundle.mode'

acceptance/bundle/user_agent/simple/out.requests.deploy.direct.json

@@ -193,6 +193,8 @@
     "version": 1,
     "config": {
       "bundle": {
+        "name": "test-bundle",
+        "target": "default",
         "git": {
           "bundle_root_path": "."
         }

acceptance/bundle/user_agent/simple/out.requests.deploy.terraform.json

@@ -193,6 +193,8 @@
     "version": 1,
     "config": {
       "bundle": {
+        "name": "test-bundle",
+        "target": "default",
         "git": {
           "bundle_root_path": "."
         }

bundle/deploy/metadata/compute.go

@@ -36,6 +36,11 @@ func (m *compute) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics
 		BundleRootPath: b.Config.Bundle.Git.BundleRootPath,
 	}
 
+	// Set bundle name, target, and mode
+	b.Metadata.Config.Bundle.Name = b.Config.Bundle.Name
+	b.Metadata.Config.Bundle.Target = b.Config.Bundle.Target
+	b.Metadata.Config.Bundle.Mode = string(b.Config.Bundle.Mode)
+
 	// Set job config paths in metadata
 	jobsMetadata := make(map[string]*metadata.Resource)
 	for name, job := range b.Config.Resources.Jobs {

bundle/deploy/metadata/compute_test.go

@@ -29,6 +29,7 @@ func TestComputeMetadataMutator(t *testing.T) {
 			Bundle: config.Bundle{
 				Name:   "my-bundle",
 				Target: "development",
+				Mode:   config.Development,
 				Git: config.Git{
 					Branch:         "my-branch",
 					OriginURL:      "www.host.com",
@@ -81,6 +82,9 @@ func TestComputeMetadataMutator(t *testing.T) {
 				FilePath: "/Users/[email protected]/files",
 			},
 			Bundle: metadata.Bundle{
+				Name:   "my-bundle",
+				Target: "development",
+				Mode:   "development",
 				Git: config.Git{
 					Branch:         "my-branch",
 					OriginURL:      "www.host.com",

bundle/metadata/metadata.go

@@ -7,7 +7,10 @@ import (
 const Version = 1
 
 type Bundle struct {
-	Git config.Git `json:"git,omitempty"`
+	Name   string     `json:"name,omitempty"`
+	Target string     `json:"target,omitempty"`
+	Mode   string     `json:"mode,omitempty"`
+	Git    config.Git `json:"git,omitempty"`
 }
 
 type Workspace struct {