lego/cmd/internal/hook/manager.go

package hook

import (
	"context"
	"fmt"
	"time"

	"github.com/go-acme/lego/v5/certificate"
	"github.com/go-acme/lego/v5/cmd/internal/storage"
	"github.com/go-acme/lego/v5/log"
)

// Action represents a hook action.
type Action struct {
	Cmd     string
	Timeout time.Duration
}

// Manager manages hooks.
type Manager struct {
	certsStorage *storage.CertificatesStorage

	metadata map[string]string

	pre    *Action
	deploy *Action
	post   *Action
}

// NewManager creates a new hook Manager.
func NewManager(certsStorage *storage.CertificatesStorage, options ...Option) *Manager {
	m := &Manager{
		certsStorage: certsStorage,
		metadata:     make(map[string]string),
	}

	for _, option := range options {
		option(m)
	}

	return m
}

// Pre runs the pre-hook if defined.
func (h *Manager) Pre(ctx context.Context, certID string, domains []string) error {
	if h.pre == nil || h.pre.Cmd == "" {
		return nil
	}

	addCertificateMetadata(h.metadata, certID, domains)

	err := Launch(ctx, h.pre.Cmd, h.pre.Timeout, h.metadata)
	if err != nil {
		log.Error("Pre hook.", log.ErrorAttr(err))

		return fmt.Errorf("pre hook: %w", err)
	}

	return nil
}

// Deploy runs the deploy-hook if defined.
func (h *Manager) Deploy(ctx context.Context, certRes *certificate.Resource, options *storage.SaveOptions) error {
	if h.deploy == nil || h.deploy.Cmd == "" {
		return nil
	}

	addCertificateMetadata(h.metadata, certRes.ID, certRes.Domains)
	addCertificatePathsMetadata(h.metadata, certRes, h.certsStorage, options)

	err := Launch(ctx, h.deploy.Cmd, h.deploy.Timeout, h.metadata)
	if err != nil {
		log.Error("Deploy hook.", log.ErrorAttr(err))

		return fmt.Errorf("deploy hook: %w", err)
	}

	return nil
}

// Post runs the post-hook if defined.
// This must be called inside a defer statement to ensure the hook is always run.
func (h *Manager) Post(ctx context.Context) error {
	if h.post == nil || h.post.Cmd == "" {
		return nil
	}

	err := Launch(ctx, h.post.Cmd, h.post.Timeout, h.metadata)
	if err != nil {
		log.Error("Post hook.", log.ErrorAttr(err))

		return fmt.Errorf("post hook: %w", err)
	}

	return nil
}