feat: add --description flag to astro deploy command (#1713)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.gitignore

@@ -15,6 +15,7 @@ cover.out
 coverage-2.txt
 coverage.txt
 dist/
+hello-astro/
 meta/
 packages.txt
 requirements.txt

cmd/software/deploy.go

@@ -25,6 +25,7 @@ var (
 	DeployAirflowImage = deploy.Airflow
 	DagsOnlyDeploy     = deploy.DagsOnlyDeploy
 	isDagOnlyDeploy    bool
+	description        string
 )
 
 var deployExample = `
@@ -56,6 +57,7 @@ func NewDeployCmd() *cobra.Command {
 	cmd.Flags().BoolVarP(&saveDeployConfig, "save", "s", false, "Save deployment in config for future deploys")
 	cmd.Flags().BoolVarP(&ignoreCacheDeploy, "no-cache", "", false, "Do not use cache when building container image")
 	cmd.Flags().StringVar(&workspaceID, "workspace-id", "", "workspace assigned to deployment")
+	cmd.Flags().StringVar(&description, "description", "", "Reason for the deploy update")
 
 	if !context.IsCloudContext() && houston.VerifyVersionMatch(houstonVersion, houston.VersionRestrictions{GTE: "0.34.0"}) {
 		cmd.Flags().BoolVarP(&isDagOnlyDeploy, "dags", "d", false, "Push only DAGs to your Deployment")
@@ -101,16 +103,22 @@ func deployAirflow(cmd *cobra.Command, args []string) error {
 			return deploy.ErrBYORegistryDomainNotSet
 		}
 	}
+
+	if description == "" {
+		description = utils.GetDefaultDeployDescription(isDagOnlyDeploy)
+	}
+
 	if isDagOnlyDeploy {
-		return DagsOnlyDeploy(houstonClient, appConfig, ws, deploymentID, config.WorkingPath, nil, true)
+		return DagsOnlyDeploy(houstonClient, appConfig, ws, deploymentID, config.WorkingPath, nil, true, description)
 	}
+
 	// Since we prompt the user to enter the deploymentID in come cases for DeployAirflowImage, reusing the same  deploymentID for DagsOnlyDeploy
-	deploymentID, err = DeployAirflowImage(houstonClient, config.WorkingPath, deploymentID, ws, byoRegistryDomain, ignoreCacheDeploy, byoRegistryEnabled, forcePrompt)
+	deploymentID, err = DeployAirflowImage(houstonClient, config.WorkingPath, deploymentID, ws, byoRegistryDomain, ignoreCacheDeploy, byoRegistryEnabled, forcePrompt, description)
 	if err != nil {
 		return err
 	}
 
-	err = DagsOnlyDeploy(houstonClient, appConfig, ws, deploymentID, config.WorkingPath, nil, true)
+	err = DagsOnlyDeploy(houstonClient, appConfig, ws, deploymentID, config.WorkingPath, nil, true, description)
 	// Don't throw the error if dag-deploy itself is disabled
 	if errors.Is(err, deploy.ErrDagOnlyDeployDisabledInConfig) || errors.Is(err, deploy.ErrDagOnlyDeployNotEnabledForDeployment) {
 		return nil

cmd/software/deploy_test.go

@@ -1,6 +1,8 @@
 package software
 
 import (
+	"fmt"
+
 	"github.com/astronomer/astro-cli/houston"
 	testUtil "github.com/astronomer/astro-cli/pkg/testing"
 	"github.com/astronomer/astro-cli/software/deploy"
@@ -25,11 +27,14 @@ func (s *Suite) TestDeploy() {
 	EnsureProjectDir = func(cmd *cobra.Command, args []string) error {
 		return nil
 	}
-	DeployAirflowImage = func(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool) (string, error) {
+	DeployAirflowImage = func(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool, description string) (string, error) {
+		if description == "" {
+			return deploymentID, fmt.Errorf("description should not be empty")
+		}
 		return deploymentID, nil
 	}
 
-	DagsOnlyDeploy = func(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool) error {
+	DagsOnlyDeploy = func(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool, description string) error {
 		return nil
 	}
 
@@ -42,23 +47,40 @@ func (s *Suite) TestDeploy() {
 	err = execDeployCmd([]string{"test-deployment-id", "--save"}...)
 	s.NoError(err)
 
+	// Test when description is provided using the flag --description
+	err = execDeployCmd([]string{"test-deployment-id", "--description", "Initial deployment", "--force"}...)
+	s.NoError(err)
+
+	// Test when the default description is used
+	DeployAirflowImage = func(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool, description string) (string, error) {
+		expectedDesc := "Deployed via <astro deploy>"
+		if description != expectedDesc {
+			return deploymentID, fmt.Errorf("expected description to be '%s', but got '%s'", expectedDesc, description)
+		}
+		return deploymentID, nil
+	}
+
+	err = execDeployCmd([]string{"test-deployment-id", "--force"}...)
+	s.NoError(err)
+
+	// Restore DagsOnlyDeploy to default behavior
 	DagsOnlyDeploy = deploy.DagsOnlyDeploy
 
 	s.Run("error should be returned for astro deploy, if DeployAirflowImage throws error", func() {
-		DeployAirflowImage = func(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool) (string, error) {
+		DeployAirflowImage = func(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool, description string) (string, error) {
 			return deploymentID, deploy.ErrNoWorkspaceID
 		}
 
 		err := execDeployCmd([]string{"-f"}...)
 		s.ErrorIs(err, deploy.ErrNoWorkspaceID)
 
-		DeployAirflowImage = func(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool) (string, error) {
+		DeployAirflowImage = func(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool, description string) (string, error) {
 			return deploymentID, nil
 		}
 	})
 
 	s.Run("error should be returned for astro deploy, if dags deploy throws error and the feature is enabled", func() {
-		DagsOnlyDeploy = func(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool) error {
+		DagsOnlyDeploy = func(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool, description string) error {
 			return deploy.ErrNoWorkspaceID
 		}
 		err := execDeployCmd([]string{"-f"}...)
@@ -83,7 +105,7 @@ func (s *Suite) TestDeploy() {
 				BYORegistryEnabled: true,
 			},
 		}
-		DagsOnlyDeploy = func(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool) error {
+		DagsOnlyDeploy = func(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool, description string) error {
 			return deploy.ErrNoWorkspaceID
 		}
 		err := execDeployCmd([]string{"-f"}...)

cmd/utils/utils.go

@@ -19,3 +19,11 @@ func EnsureProjectDir(cmd *cobra.Command, args []string) error {
 
 	return nil
 }
+
+func GetDefaultDeployDescription(isDagOnlyDeploy bool) string {
+	if isDagOnlyDeploy {
+		return "Deployed via <astro deploy --dags>"
+	}
+
+	return "Deployed via <astro deploy>"
+}

cmd/utils/utils_test.go

@@ -36,3 +36,13 @@ func TestEnsureProjectDir(t *testing.T) {
 	err = EnsureProjectDir(&cobra.Command{}, []string{})
 	assert.NoError(t, err)
 }
+
+func TestGetDefaultDeployDescription(t *testing.T) {
+	// Test case where --dags flag is not set
+	description := GetDefaultDeployDescription(false)
+	assert.Equal(t, "Deployed via <astro deploy>", description)
+
+	// Test case where --dags flag is set
+	descriptionWithDags := GetDefaultDeployDescription(true)
+	assert.Equal(t, "Deployed via <astro deploy --dags>", descriptionWithDags)
+}

houston/deployment.go

@@ -53,7 +53,7 @@ var (
 					workspaceUuid: $workspaceId
 					releaseName: $releaseName
 					executor: $executor
-						airflowVersion: $airflowVersion
+					airflowVersion: $airflowVersion
 					namespace: $namespace
 					config: $config
 					cloudRole: $cloudRole
@@ -96,7 +96,7 @@ var (
 					workspaceUuid: $workspaceId
 					releaseName: $releaseName
 					executor: $executor
-						airflowVersion: $airflowVersion
+					airflowVersion: $airflowVersion
 					namespace: $namespace
 					config: $config
 					cloudRole: $cloudRole

software/deploy/deploy.go

@@ -68,7 +68,7 @@ var tab = printutil.Table{
 	Header:         []string{"#", "LABEL", "DEPLOYMENT NAME", "WORKSPACE", "DEPLOYMENT ID"},
 }
 
-func Airflow(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool) (string, error) {
+func Airflow(houstonClient houston.ClientInterface, path, deploymentID, wsID, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled, prompt bool, description string) (string, error) {
 	deploymentID, deployments, err := getDeploymentIDForCurrentCommand(houstonClient, wsID, deploymentID, prompt)
 	if err != nil {
 		return deploymentID, err
@@ -98,7 +98,7 @@ func Airflow(houstonClient houston.ClientInterface, path, deploymentID, wsID, by
 	fmt.Printf(houstonDeploymentPrompt, releaseName)
 
 	// Build the image to deploy
-	err = buildPushDockerImage(houstonClient, &c, deploymentInfo, releaseName, path, nextTag, cloudDomain, byoRegistryDomain, ignoreCacheDeploy, byoRegistryEnabled)
+	err = buildPushDockerImage(houstonClient, &c, deploymentInfo, releaseName, path, nextTag, cloudDomain, byoRegistryDomain, ignoreCacheDeploy, byoRegistryEnabled, description)
 	if err != nil {
 		return deploymentID, err
 	}
@@ -120,7 +120,7 @@ func deploymentExists(deploymentID string, deployments []houston.Deployment) boo
 	return false
 }
 
-func buildPushDockerImage(houstonClient houston.ClientInterface, c *config.Context, deploymentInfo *houston.Deployment, name, path, nextTag, cloudDomain, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled bool) error {
+func buildPushDockerImage(houstonClient houston.ClientInterface, c *config.Context, deploymentInfo *houston.Deployment, name, path, nextTag, cloudDomain, byoRegistryDomain string, ignoreCacheDeploy, byoRegistryEnabled bool, description string) error {
 	// Build our image
 	fmt.Println(imageBuildingPrompt)
 
@@ -170,6 +170,10 @@ func buildPushDockerImage(houstonClient houston.ClientInterface, c *config.Conte
 
 	imageHandler := imageHandlerInit(imageName)
 
+	if description != "" {
+		deployLabels = append(deployLabels, "io.astronomer.deploy.revision.description="+description)
+	}
+
 	buildConfig := types.ImageBuildConfig{
 		Path:            config.WorkingPath,
 		NoCache:         ignoreCacheDeploy,
@@ -331,12 +335,12 @@ func validateIfDagDeployURLCanBeConstructed(deploymentInfo *houston.Deployment)
 	return nil
 }
 
-func getDagDeployURL(deploymentInfo *houston.Deployment) string {
+func getDagDeployURL(deploymentInfo *houston.Deployment, description string) string {
 	c, _ := config.GetCurrentContext()
-	return fmt.Sprintf("https://deployments.%s/%s/dags/upload", c.Domain, deploymentInfo.ReleaseName)
+	return fmt.Sprintf("https://deployments.%s/%s/dags/upload?description=%s", c.Domain, deploymentInfo.ReleaseName, description)
 }
 
-func DagsOnlyDeploy(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool) error {
+func DagsOnlyDeploy(houstonClient houston.ClientInterface, appConfig *houston.AppConfig, wsID, deploymentID, dagsParentPath string, dagDeployURL *string, cleanUpFiles bool, description string) error {
 	// Throw error if the feature is disabled at Houston level
 	if !isDagOnlyDeploymentEnabled(appConfig) {
 		return ErrDagOnlyDeployDisabledInConfig
@@ -368,7 +372,7 @@ func DagsOnlyDeploy(houstonClient houston.ClientInterface, appConfig *houston.Ap
 		if err != nil {
 			return err
 		}
-		uploadURL = getDagDeployURL(deploymentInfo)
+		uploadURL = getDagDeployURL(deploymentInfo, description)
 	} else {
 		uploadURL = *dagDeployURL
 	}