70 lines
1.8 KiB
Go
70 lines
1.8 KiB
Go
package validation
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel"
|
|
"go.opentelemetry.io/otel/trace"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/tracing"
|
|
"github.com/grafana/grafana/pkg/plugins"
|
|
"github.com/grafana/grafana/pkg/plugins/config"
|
|
"github.com/grafana/grafana/pkg/plugins/log"
|
|
"github.com/grafana/grafana/pkg/semconv"
|
|
)
|
|
|
|
// Validator is responsible for the Validation stage of the plugin loader pipeline.
|
|
type Validator interface {
|
|
Validate(ctx context.Context, ps *plugins.Plugin) error
|
|
}
|
|
|
|
// ValidateFunc is the function used for the Validate step of the Validation stage.
|
|
type ValidateFunc func(ctx context.Context, p *plugins.Plugin) error
|
|
|
|
type Validate struct {
|
|
cfg *config.PluginManagementCfg
|
|
validateSteps []ValidateFunc
|
|
log log.Logger
|
|
tracer trace.Tracer
|
|
}
|
|
|
|
type Opts struct {
|
|
ValidateFuncs []ValidateFunc
|
|
}
|
|
|
|
// New returns a new Validation stage.
|
|
func New(cfg *config.PluginManagementCfg, opts Opts) *Validate {
|
|
if opts.ValidateFuncs == nil {
|
|
opts.ValidateFuncs = DefaultValidateFuncs(cfg)
|
|
}
|
|
|
|
return &Validate{
|
|
cfg: cfg,
|
|
validateSteps: opts.ValidateFuncs,
|
|
log: log.New("plugins.validation"),
|
|
tracer: otel.Tracer("github.com/grafana/grafana/pkg/plugins/manager/pipeline/validation"),
|
|
}
|
|
}
|
|
|
|
// Validate will execute the Validate steps of the Validation stage.
|
|
func (v *Validate) Validate(ctx context.Context, ps *plugins.Plugin) error {
|
|
ctx, span := v.tracer.Start(ctx, "validation.Validate", trace.WithAttributes(
|
|
semconv.GrafanaPluginId(ps.ID),
|
|
))
|
|
defer span.End()
|
|
|
|
if len(v.validateSteps) == 0 {
|
|
return nil
|
|
}
|
|
|
|
for _, validate := range v.validateSteps {
|
|
err := validate(ctx, ps)
|
|
if err != nil {
|
|
v.log.Error("Plugin validation failed", "pluginId", ps.ID, "error", err)
|
|
return tracing.Error(span, err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|