configurator/internal/generator/generator.go

package generator

import (
	"bytes"
	"fmt"
	"maps"
	"os"
	"path/filepath"
	"plugin"

	configurator "github.com/OpenCHAMI/configurator/internal"
	"github.com/OpenCHAMI/configurator/internal/util"
	"github.com/nikolalohinski/gonja/v2"
	"github.com/nikolalohinski/gonja/v2/exec"
	"github.com/sirupsen/logrus"
)

type Mappings = map[string]any
type Files = map[string][]byte
type Generator interface {
	GetName() string
	Generate(config *configurator.Config, opts ...util.Option) (Files, error)
}

type Params struct {
	Args        []string
	PluginPaths []string
	Target      string
	Verbose     bool
}

func LoadPlugin(path string) (Generator, error) {
	p, err := plugin.Open(path)
	if err != nil {
		return nil, fmt.Errorf("failed to load plugin: %v", err)
	}

	// load the "Generator" symbol from plugin
	symbol, err := p.Lookup("Generator")
	if err != nil {
		return nil, fmt.Errorf("failed to look up symbol at path '%s': %v", path, err)
	}

	// assert that the plugin loaded has a valid generator
	gen, ok := symbol.(Generator)
	if !ok {
		return nil, fmt.Errorf("failed to load the correct symbol type at path '%s'", path)
	}
	return gen, nil
}

func LoadPlugins(dirpath string, opts ...util.Option) (map[string]Generator, error) {
	// check if verbose option is supplied
	var (
		gens   = make(map[string]Generator)
		params = util.GetParams(opts...)
	)

	items, _ := os.ReadDir(dirpath)
	for _, item := range items {
		if item.IsDir() {
			subitems, _ := os.ReadDir(item.Name())
			for _, subitem := range subitems {
				if !subitem.IsDir() {
					gen, err := LoadPlugin(subitem.Name())
					if err != nil {
						fmt.Printf("failed to load generator in directory '%s': %v\n", item.Name(), err)
						continue
					}
					if verbose, ok := params["verbose"].(bool); ok {
						if verbose {
							fmt.Printf("-- found plugin '%s'\n", item.Name())
						}
					}
					gens[gen.GetName()] = gen
				}
			}
		} else {
			gen, err := LoadPlugin(dirpath + item.Name())
			if err != nil {
				fmt.Printf("failed to load generator: %v\n", err)
				continue
			}
			if verbose, ok := params["verbose"].(bool); ok {
				if verbose {
					fmt.Printf("-- found plugin '%s'\n", dirpath+item.Name())
				}
			}
			gens[gen.GetName()] = gen
		}
	}

	return gens, nil
}

func WithTarget(target string) util.Option {
	return func(p util.Params) {
		if p != nil {
			p["target"] = target
		}
	}
}

func WithType(_type string) util.Option {
	return func(p util.Params) {
		if p != nil {
			p["type"] = _type
		}
	}
}

func WithClient(client configurator.SmdClient) util.Option {
	return func(p util.Params) {
		p["client"] = client
	}
}

func WithOption(key string, value any) util.Option {
	return func(p util.Params) {
		p[key] = value
	}
}

// Helper function to get client in generator plugins.
func GetClient(params util.Params) *configurator.SmdClient {
	return util.Get[configurator.SmdClient](params, "client")
}

func GetTarget(config *configurator.Config, key string) configurator.Target {
	return config.Targets[key]
}

func GetParams(opts ...util.Option) util.Params {
	params := util.Params{}
	for _, opt := range opts {
		opt(params)
	}
	return params
}

func ApplyTemplates(mappings map[string]any, paths ...string) (Files, error) {
	var (
		data    = exec.NewContext(mappings)
		outputs = Files{}
	)

	for _, path := range paths {
		// load jinja template from file
		t, err := gonja.FromFile(path)
		if err != nil {
			return nil, fmt.Errorf("failed to read template from file: %v", err)
		}

		// execute/render jinja template
		b := bytes.Buffer{}
		if err = t.Execute(&b, data); err != nil {
			return nil, fmt.Errorf("failed to execute: %v", err)
		}
		outputs[path] = b.Bytes()
	}

	return outputs, nil
}

func LoadFiles(paths ...string) (Files, error) {
	var outputs = Files{}
	for _, path := range paths {
		expandedPaths, err := filepath.Glob(path)
		if err != nil {
			return nil, fmt.Errorf("failed to expand path: %v", err)
		}
		for _, expandedPath := range expandedPaths {
			b, err := os.ReadFile(expandedPath)
			if err != nil {
				return nil, fmt.Errorf("failed to read file: %v", err)
			}

			outputs[path] = b
		}
	}

	return outputs, nil
}

func Generate(config *configurator.Config, params Params) (Files, error) {
	// load generator plugins to generate configs or to print
	var (
		generators = make(map[string]Generator)
		client     = configurator.NewSmdClient(
			configurator.WithHost(config.SmdClient.Host),
			configurator.WithPort(config.SmdClient.Port),
			configurator.WithAccessToken(config.AccessToken),
			configurator.WithSecureTLS(config.CertPath),
		)
	)

	// load all plugins from params
	for _, path := range params.PluginPaths {
		if params.Verbose {
			fmt.Printf("loading plugins from '%s'\n", path)
		}
		gens, err := LoadPlugins(path)
		if err != nil {
			fmt.Printf("failed to load plugins: %v\n", err)
			err = nil
			continue
		}

		// add loaded generator plugins to set
		maps.Copy(generators, gens)
	}

	// show available targets then exit
	if len(params.Args) == 0 && params.Target == "" {
		for g := range generators {
			fmt.Printf("-- found generator plugin \"%s\"\n", g)
		}
		return nil, nil
	}

	if params.Target == "" {
		logrus.Errorf("no target supplied (--target name)")
	} else {
		// run the generator plugin from target passed
		gen := generators[params.Target]
		if gen == nil {
			return nil, fmt.Errorf("invalid generator target (%s)", params.Target)
		}
		return gen.Generate(
			config,
			WithTarget(gen.GetName()),
			WithClient(client),
		)
	}
	return nil, fmt.Errorf("an unknown error has occurred")
}