Skip to content

Allow hooks to run without initial .azure directory #6277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JeffreyCA merged 3 commits into from
Nov 24, 2025
Merged

Allow hooks to run without initial .azure directory #6277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ec81f6
Allow hooks to init environment
JeffreyCA Nov 22, 2025
b874b38
Apply suggestion from @weikanglim
JeffreyCA Nov 24, 2025
7db6839
Remove redundant nil checks
JeffreyCA Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 34 additions & 63 deletions cli/azd/cmd/middleware/hooks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,102 +14,82 @@ import (
"github.com/azure/azure-dev/cli/azd/pkg/ext"
"github.com/azure/azure-dev/cli/azd/pkg/input"
"github.com/azure/azure-dev/cli/azd/pkg/ioc"
"github.com/azure/azure-dev/cli/azd/pkg/lazy"
"github.com/azure/azure-dev/cli/azd/pkg/output/ux"
"github.com/azure/azure-dev/cli/azd/pkg/project"
)

type HooksMiddleware struct {
lazyEnvManager *lazy.Lazy[environment.Manager]
lazyEnv *lazy.Lazy[*environment.Environment]
lazyProjectConfig *lazy.Lazy[*project.ProjectConfig]
importManager *project.ImportManager
commandRunner exec.CommandRunner
console input.Console
options *Options
serviceLocator ioc.ServiceLocator
envManager environment.Manager
env *environment.Environment
projectConfig *project.ProjectConfig
importManager *project.ImportManager
commandRunner exec.CommandRunner
console input.Console
options *Options
serviceLocator ioc.ServiceLocator
}

// Creates a new instance of the Hooks middleware
func NewHooksMiddleware(
lazyEnvManager *lazy.Lazy[environment.Manager],
lazyEnv *lazy.Lazy[*environment.Environment],
lazyProjectConfig *lazy.Lazy[*project.ProjectConfig],
envManager environment.Manager,
env *environment.Environment,
projectConfig *project.ProjectConfig,
importManager *project.ImportManager,
commandRunner exec.CommandRunner,
console input.Console,
options *Options,
serviceLocator ioc.ServiceLocator,
) Middleware {
return &HooksMiddleware{
lazyEnvManager: lazyEnvManager,
lazyEnv: lazyEnv,
lazyProjectConfig: lazyProjectConfig,
importManager: importManager,
commandRunner: commandRunner,
console: console,
options: options,
serviceLocator: serviceLocator,
envManager: envManager,
env: env,
projectConfig: projectConfig,
importManager: importManager,
commandRunner: commandRunner,
console: console,
options: options,
serviceLocator: serviceLocator,
}
}

// Runs the Hooks middleware
func (m *HooksMiddleware) Run(ctx context.Context, next NextFn) (*actions.ActionResult, error) {
env, err := m.lazyEnv.GetValue()
if err != nil {
log.Println("azd environment is not available, skipping all hook registrations.")
return next(ctx)
}

projectConfig, err := m.lazyProjectConfig.GetValue()
if err != nil || projectConfig == nil {
log.Println("azd project is not available, skipping all hook registrations.")
return next(ctx)
}

// Validate hooks and display any warnings
if !m.options.IsChildAction(ctx) {
if err := m.validateHooks(ctx, projectConfig); err != nil {
if err := m.validateHooks(ctx, m.projectConfig); err != nil {
return nil, fmt.Errorf("failed validating hooks, %w", err)
}
}

if err := m.registerServiceHooks(ctx, env, projectConfig); err != nil {
if err := m.registerServiceHooks(ctx); err != nil {
return nil, fmt.Errorf("failed registering service hooks, %w", err)
}

return m.registerCommandHooks(ctx, env, projectConfig, next)
return m.registerCommandHooks(ctx, next)
}

// Register command level hooks for the executing cobra command & action
// Invokes the middleware next function
func (m *HooksMiddleware) registerCommandHooks(
ctx context.Context,
env *environment.Environment,
projectConfig *project.ProjectConfig,
next NextFn,
) (*actions.ActionResult, error) {
if len(projectConfig.Hooks) == 0 {
if len(m.projectConfig.Hooks) == 0 {
log.Println(
"azd project is not available or does not contain any command hooks, skipping command hook registrations.",
"azd project does not contain any command hooks, skipping command hook registrations.",
)
return next(ctx)
}

envManager, err := m.lazyEnvManager.GetValue()
if err != nil {
return nil, fmt.Errorf("failed getting environment manager, %w", err)
}

hooksManager := ext.NewHooksManager(projectConfig.Path, m.commandRunner)
hooksManager := ext.NewHooksManager(m.projectConfig.Path, m.commandRunner)
hooksRunner := ext.NewHooksRunner(
hooksManager,
m.commandRunner,
envManager,
m.envManager,
m.console,
projectConfig.Path,
projectConfig.Hooks,
env,
m.projectConfig.Path,
m.projectConfig.Hooks,
m.env,
m.serviceLocator,
)

Expand All @@ -118,7 +98,7 @@ func (m *HooksMiddleware) registerCommandHooks(
commandNames := []string{m.options.CommandPath}
commandNames = append(commandNames, m.options.Aliases...)

err = hooksRunner.Invoke(ctx, commandNames, func() error {
err := hooksRunner.Invoke(ctx, commandNames, func() error {
result, err := next(ctx)
if err != nil {
return err
Expand All @@ -137,17 +117,8 @@ func (m *HooksMiddleware) registerCommandHooks(

// Registers event handlers for all services within the project configuration
// Runs hooks for each matching event handler
func (m *HooksMiddleware) registerServiceHooks(
ctx context.Context,
env *environment.Environment,
projectConfig *project.ProjectConfig,
) error {
envManager, err := m.lazyEnvManager.GetValue()
if err != nil {
return fmt.Errorf("failed getting environment manager, %w", err)
}

stableServices, err := m.importManager.ServiceStable(ctx, projectConfig)
func (m *HooksMiddleware) registerServiceHooks(ctx context.Context) error {
stableServices, err := m.importManager.ServiceStable(ctx, m.projectConfig)
if err != nil {
return fmt.Errorf("failed getting services: %w", err)
}
Expand All @@ -164,11 +135,11 @@ func (m *HooksMiddleware) registerServiceHooks(
serviceHooksRunner := ext.NewHooksRunner(
serviceHooksManager,
m.commandRunner,
envManager,
m.envManager,
m.console,
service.Path(),
service.Hooks,
env,
m.env,
m.serviceLocator,
)

Expand Down
19 changes: 3 additions & 16 deletions cli/azd/cmd/middleware/hooks_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import (
"github.com/azure/azure-dev/cli/azd/pkg/environment/azdcontext"
"github.com/azure/azure-dev/cli/azd/pkg/exec"
"github.com/azure/azure-dev/cli/azd/pkg/ext"
"github.com/azure/azure-dev/cli/azd/pkg/lazy"
"github.com/azure/azure-dev/cli/azd/pkg/project"
"github.com/azure/azure-dev/cli/azd/test/mocks"
"github.com/azure/azure-dev/cli/azd/test/mocks/mockenv"
Expand Down Expand Up @@ -344,22 +343,10 @@ func runMiddleware(
envManager.On("Save", mock.Anything, mock.Anything).Return(nil)
envManager.On("Reload", mock.Anything, mock.Anything).Return(nil)

lazyEnvManager := lazy.NewLazy(func() (environment.Manager, error) {
return envManager, nil
})

lazyEnv := lazy.NewLazy(func() (*environment.Environment, error) {
return env, nil
})

lazyProjectConfig := lazy.NewLazy(func() (*project.ProjectConfig, error) {
return projectConfig, nil
})

middleware := NewHooksMiddleware(
lazyEnvManager,
lazyEnv,
lazyProjectConfig,
envManager,
env,
projectConfig,
project.NewImportManager(nil),
mockContext.CommandRunner,
mockContext.Console,
Expand Down
Loading