Support azd hooks out of azure.yaml, Part I of merging azd operation to hooks (#4244)

* service hooks

* As part of merging azd operation and hooks, this PR allows users to define hooks outside of azure.yaml as individual files with the name azd.hooks.[yaml | yml].

The file can be placed in the /infra folder for project level hooks or inside service's folder for service level hooks.

This will allow generators like Aspire to include hooks as part of the infrastructure code (w/o touching azure.yaml).  Then, when running azd infra synth, the hooks are part of the infrastructure and users can delete the infra folder to go back to full Aspire in-memory generation w/o touching azure.yaml.

After this PR, I am planning to move the azd operations to become a valid built-in hook and delete the alpha feature for azd operations and the entire feature in favor of just using the hooks strategy

Author: vhvb1989

cli/azd/pkg/project/project.go

@@ -77,6 +77,10 @@ func Parse(ctx context.Context, yamlContent string) (*ProjectConfig, error) {
 		projectConfig.Infra.Path = "infra"
 	}
 
+	if projectConfig.Infra.Module == "" {
+		projectConfig.Infra.Module = DefaultModule
+	}
+
 	if strings.Contains(projectConfig.Infra.Path, "\\") && !strings.Contains(projectConfig.Infra.Path, "/") {
 		projectConfig.Infra.Path = strings.ReplaceAll(projectConfig.Infra.Path, "\\", "/")
 	}
@@ -154,6 +158,31 @@ func Load(ctx context.Context, projectFilePath string) (*ProjectConfig, error) {
 		return nil, fmt.Errorf("parsing project file: %w", err)
 	}
 
+	projectConfig.Path = filepath.Dir(projectFilePath)
+
+	// complement the project config with hooks defined in the infra path using the syntax `<moduleName>.hooks.yaml`
+	// for example `main.hooks.yaml`
+	hooksDefinedAtInfraPath, err := hooksFromInfraModule(
+		filepath.Join(projectConfig.Path, projectConfig.Infra.Path),
+		projectConfig.Infra.Module)
+	if err != nil {
+		return nil, fmt.Errorf("failed getting hooks from infra path, %w", err)
+	}
+	// Merge the hooks defined at the infra path with the hooks defined in the project configuration
+	if len(hooksDefinedAtInfraPath) > 0 && projectConfig.Hooks == nil {
+		projectConfig.Hooks = make(map[string][]*ext.HookConfig)
+	}
+	for hookName, externalHookList := range hooksDefinedAtInfraPath {
+		if hookListFromAzureYaml, hookExists := projectConfig.Hooks[hookName]; hookExists {
+			mergedHooks := make([]*ext.HookConfig, 0, len(hookListFromAzureYaml)+len(externalHookList))
+			mergedHooks = append(mergedHooks, hookListFromAzureYaml...)
+			mergedHooks = append(mergedHooks, externalHookList...)
+			projectConfig.Hooks[hookName] = mergedHooks
+			continue
+		}
+		projectConfig.Hooks[hookName] = externalHookList
+	}
+
 	if projectConfig.Metadata != nil && projectConfig.Metadata.Template != "" {
 		template := strings.Split(projectConfig.Metadata.Template, "@")
 		if len(template) == 1 { // no version specifier, just the template ID
@@ -187,7 +216,6 @@ func Load(ctx context.Context, projectFilePath string) (*ProjectConfig, error) {
 		tracing.SetUsageAttributes(fields.ProjectServiceHostsKey.StringSlice(hosts))
 	}
 
-	projectConfig.Path = filepath.Dir(projectFilePath)
 	return projectConfig, nil
 }
 
@@ -271,7 +299,28 @@ func Save(ctx context.Context, projectConfig *ProjectConfig, projectFilePath str
 		return fmt.Errorf("saving project file: %w", err)
 	}
 
-	projectConfig.Path = projectFilePath
+	projectConfig.Path = filepath.Dir(projectFilePath)
 
 	return nil
 }
+
+// hooksFromInfraModule check if there is file named azd.hooks.yaml in the service path
+// and return the hooks configuration.
+func hooksFromInfraModule(infraPath, moduleName string) (HooksConfig, error) {
+	hooksPath := filepath.Join(infraPath, moduleName+".hooks.yaml")
+	if _, err := os.Stat(hooksPath); os.IsNotExist(err) {
+		return nil, nil
+	}
+	hooksFile, err := os.ReadFile(hooksPath)
+	if err != nil {
+		return nil, fmt.Errorf("failed reading hooks from '%s', %w", hooksPath, err)
+	}
+
+	// open hooksPath into a byte array and unmarshal it into a map[string]*ext.HookConfig
+	hooks := make(HooksConfig)
+	if err := yaml.Unmarshal(hooksFile, &hooks); err != nil {
+		return nil, fmt.Errorf("failed unmarshalling hooks from '%s', %w", hooksPath, err)
+	}
+
+	return hooks, nil
+}

cli/azd/pkg/project/project_test.go

@@ -5,6 +5,7 @@ package project
 
 import (
 	"context"
+	"os"
 	"path/filepath"
 	"testing"
 
@@ -13,7 +14,9 @@ import (
 	"github.com/azure/azure-dev/cli/azd/pkg/azapi"
 	"github.com/azure/azure-dev/cli/azd/pkg/azure"
 	"github.com/azure/azure-dev/cli/azd/pkg/environment"
+	"github.com/azure/azure-dev/cli/azd/pkg/ext"
 	"github.com/azure/azure-dev/cli/azd/pkg/infra"
+	"github.com/azure/azure-dev/cli/azd/pkg/osutil"
 	"github.com/azure/azure-dev/cli/azd/test/mocks"
 	"github.com/azure/azure-dev/cli/azd/test/mocks/mockarmresources"
 	"github.com/azure/azure-dev/cli/azd/test/mocks/mockazcli"
@@ -342,3 +345,132 @@ services:
 	assert.Equal(t, filepath.FromSlash("src/api"), projectConfig.Services["api"].RelativePath)
 	assert.Equal(t, filepath.FromSlash("bin/api"), projectConfig.Services["api"].OutputPath)
 }
+
+func Test_HooksFromFolderPath(t *testing.T) {
+	t.Run("ProjectInfraHooks", func(t *testing.T) {
+		prj := &ProjectConfig{
+			Name:     "minimal",
+			Services: map[string]*ServiceConfig{},
+		}
+		contents, err := yaml.Marshal(prj)
+		require.NoError(t, err)
+
+		tempDir := t.TempDir()
+
+		azureYamlPath := filepath.Join(tempDir, "azure.yaml")
+		err = os.WriteFile(azureYamlPath, contents, osutil.PermissionDirectory)
+		require.NoError(t, err)
+
+		infraPath := filepath.Join(tempDir, "infra")
+		err = os.Mkdir(infraPath, osutil.PermissionDirectory)
+		require.NoError(t, err)
+
+		hooksPath := filepath.Join(infraPath, "main.hooks.yaml")
+		hooksContent := []byte(`
+prebuild:
+  shell: sh
+  run: ./pre-build.sh
+postbuild:
+  shell: pwsh
+  run: ./post-build.ps1
+`)
+
+		err = os.WriteFile(hooksPath, hooksContent, osutil.PermissionDirectory)
+		require.NoError(t, err)
+
+		expectedHooks := HooksConfig{
+			"prebuild": {{
+				Name:            "",
+				Shell:           ext.ShellTypeBash,
+				Run:             "./pre-build.sh",
+				ContinueOnError: false,
+				Interactive:     false,
+				Windows:         nil,
+				Posix:           nil,
+			}},
+			"postbuild": {{
+				Name:            "",
+				Shell:           ext.ShellTypePowershell,
+				Run:             "./post-build.ps1",
+				ContinueOnError: false,
+				Interactive:     false,
+				Windows:         nil,
+				Posix:           nil,
+			},
+			}}
+
+		project, err := Load(context.Background(), azureYamlPath)
+		require.NoError(t, err)
+		require.Equal(t, expectedHooks, project.Hooks)
+	})
+
+	t.Run("DoubleDefintionHooks", func(t *testing.T) {
+		prj := &ProjectConfig{
+			Name:     "minimal",
+			Services: map[string]*ServiceConfig{},
+			Hooks: HooksConfig{
+				"prebuild": {{
+					Shell: ext.ShellTypeBash,
+					Run:   "./pre-build.sh",
+				}},
+			},
+		}
+		contents, err := yaml.Marshal(prj)
+		require.NoError(t, err)
+
+		tempDir := t.TempDir()
+
+		azureYamlPath := filepath.Join(tempDir, "azure.yaml")
+		err = os.WriteFile(azureYamlPath, contents, osutil.PermissionDirectory)
+		require.NoError(t, err)
+
+		infraPath := filepath.Join(tempDir, "infra")
+		err = os.Mkdir(infraPath, osutil.PermissionDirectory)
+		require.NoError(t, err)
+
+		hooksPath := filepath.Join(infraPath, "main.hooks.yaml")
+		hooksContent := []byte(`
+prebuild:
+  shell: sh
+  run: ./pre-build-external.sh
+postbuild:
+  shell: pwsh
+  run: ./post-build.ps1
+`)
+
+		err = os.WriteFile(hooksPath, hooksContent, osutil.PermissionDirectory)
+		require.NoError(t, err)
+
+		project, err := Load(context.Background(), azureYamlPath)
+		require.NoError(t, err)
+		expectedHooks := HooksConfig{
+			"prebuild": {{
+				Name:            "",
+				Shell:           ext.ShellTypeBash,
+				Run:             "./pre-build.sh",
+				ContinueOnError: false,
+				Interactive:     false,
+				Windows:         nil,
+				Posix:           nil,
+			}, {
+				Name:            "",
+				Shell:           ext.ShellTypeBash,
+				Run:             "./pre-build-external.sh",
+				ContinueOnError: false,
+				Interactive:     false,
+				Windows:         nil,
+				Posix:           nil,
+			}},
+			"postbuild": {{
+				Name:            "",
+				Shell:           ext.ShellTypePowershell,
+				Run:             "./post-build.ps1",
+				ContinueOnError: false,
+				Interactive:     false,
+				Windows:         nil,
+				Posix:           nil,
+			}},
+		}
+		require.Equal(t, expectedHooks, project.Hooks)
+	})
+}