(choria-io#1990) Add context to provtarget.Configure() and clarify pl…

…ugin design

Signed-off-by: R.I.Pienaar <[email protected]>

choria/framework.go

@@ -233,8 +233,8 @@ func (fw *Framework) SupportsProvisioning() bool {
 }
 
 // ConfigureProvisioning adjusts the active configuration to match the provisioning profile
-func (fw *Framework) ConfigureProvisioning() {
-	provtarget.Configure(fw.Config, fw.Logger("provtarget"))
+func (fw *Framework) ConfigureProvisioning(ctx context.Context) {
+	provtarget.Configure(ctx, fw.Config, fw.Logger("provtarget"))
 
 	if !fw.ProvisionMode() {
 		return

cmd/buildinfo.go

@@ -49,7 +49,7 @@ func (b *buildinfoCommand) Configure() (err error) {
 func (b *buildinfoCommand) Run(wg *sync.WaitGroup) (err error) {
 	defer wg.Done()
 
-	c.ConfigureProvisioning()
+	c.ConfigureProvisioning(ctx)
 
 	fmt.Println("Choria build settings:")
 	fmt.Println()

cmd/server_run.go

@@ -58,7 +58,7 @@ func (r *serverRunCommand) Configure() error {
 			return fmt.Errorf("could not parse configuration: %s", err)
 		}
 
-		provtarget.Configure(cfg, log.WithField("component", "provtarget"))
+		provtarget.Configure(ctx, cfg, log.WithField("component", "provtarget"))
 
 		if r.shouldProvision(cfg) {
 			if cfg.Choria.ServerTokenSeedFile != "" {
@@ -95,7 +95,7 @@ func (r *serverRunCommand) Configure() error {
 			return fmt.Errorf("could not create default server configuration")
 		}
 
-		provtarget.Configure(cfg, log.WithField("component", "provtarget"))
+		provtarget.Configure(ctx, cfg, log.WithField("component", "provtarget"))
 
 		// if a config file didn't exist and prov is disabled we cant start
 		if !r.shouldProvision(cfg) {
@@ -227,7 +227,7 @@ func (r *serverRunCommand) prepareInstance() (i *server.Instance, err error) {
 		log.Warn("Running with TLS Verification disabled, not compatible with production use.")
 	}
 
-	c.ConfigureProvisioning()
+	c.ConfigureProvisioning(ctx)
 
 	instance, err := server.NewInstance(c)
 	if err != nil {

cmd/tool_provisioner.go

@@ -66,7 +66,7 @@ func (p *tProvisionerCommand) Configure() error {
 func (p *tProvisionerCommand) Run(wg *sync.WaitGroup) (err error) {
 	defer wg.Done()
 
-	c.ConfigureProvisioning()
+	c.ConfigureProvisioning(ctx)
 
 	if !c.ProvisionMode() {
 		return fmt.Errorf("not a server compiled for auto provisioning or the provisioning target is not functional")

inter/choria.go

@@ -58,7 +58,7 @@ type Framework interface {
 	Certname() string
 	ClientTLSConfig() (*tls.Config, error)
 	Colorize(c string, format string, a ...any) string
-	ConfigureProvisioning()
+	ConfigureProvisioning(ctx context.Context)
 	DDLResolvers() ([]DDLResolver, error)
 	DisableTLSVerify() bool
 	Enroll(ctx context.Context, wait time.Duration, cb func(digest string, try int)) error

providers/provtarget/builddefaults/default.go

@@ -42,7 +42,7 @@ func (b *Resolver) Name() string {
 }
 
 // Configure overrides build settings using the contents of the JWT
-func (b *Resolver) Configure(cfg *config.Config, log *logrus.Entry) {
+func (b *Resolver) Configure(ctx context.Context, cfg *config.Config, log *logrus.Entry) {
 	jwtf := b.bi.ProvisionJWTFile()
 	if jwtf == "" {
 		return

providers/provtarget/builddefaults/default_test.go

@@ -17,7 +17,7 @@ import (
 
 func TestDefault(t *testing.T) {
 	RegisterFailHandler(Fail)
-	RunSpecs(t, "Provtarget/Default")
+	RunSpecs(t, "Providers/Provtarget/Default")
 }
 
 var _ = Describe("Default", func() {

providers/provtarget/provtarget.go

@@ -25,8 +25,16 @@ type TargetResolver interface {
 	Targets(context.Context, *logrus.Entry) []string
 
 	// Configure will be called during server configuration and can be used to configure the target or adjust build settings or configuration
-	// this will always be called even when not in provisioning mode, one can use this to programatically set a provisioner token for example
-	Configure(*config.Config, *logrus.Entry)
+	// this will always be called even when not in provisioning mode, one can use this to programmatically set a provisioner token for example
+	//
+	// The intention of this function is that all the settings needed by provisioning (all the things in build) should be set during configure
+	// stage.  Later when Targets() are called the intention is that either the configured targets are returned verbatim or if for example the
+	// plugin queries something like SRV records those queries are done there.
+	//
+	// Today Configure() is expected to set the JWT file using bi.SetProvisionJWTFile() and that the file should exist before probisioning will
+	// happen, this will be revisited in future. See the shouldProvision() function in server_run.go for current logic that would trigger a
+	// server into provisioning.
+	Configure(context.Context, *config.Config, *logrus.Entry)
 }
 
 var mu = &sync.Mutex{}
@@ -43,15 +51,15 @@ func RegisterTargetResolver(r TargetResolver) error {
 }
 
 // Configure allows the resolver to adjust configuration
-func Configure(cfg *config.Config, log *logrus.Entry) {
+func Configure(ctx context.Context, cfg *config.Config, log *logrus.Entry) {
 	mu.Lock()
 	defer mu.Unlock()
 
 	if resolver == nil {
 		return
 	}
 
-	resolver.Configure(cfg, log)
+	resolver.Configure(ctx, cfg, log)
 }
 
 // Targets is a list of brokers to connect to

providers/provtarget/provtarget_test.go

@@ -19,7 +19,7 @@ import (
 
 func TestServer(t *testing.T) {
 	RegisterFailHandler(Fail)
-	RunSpecs(t, "Provtarget")
+	RunSpecs(t, "Providers/Provtarget")
 }
 
 var _ = Describe("Provision", func() {