retriever.go

package config

import (
	"fmt"

	"github.com/redis/go-redis/v9"
	"golang.org/x/exp/slices"
)

// RetrieverConf contains all the field to configure a retriever
type RetrieverConf struct {
	Kind           RetrieverKind `mapstructure:"kind" koanf:"kind"`
	RepositorySlug string        `mapstructure:"repositorySlug" koanf:"repositoryslug"`
	Branch         string        `mapstructure:"branch" koanf:"branch"`
	Path           string        `mapstructure:"path" koanf:"path"`
	// Deprecated: Please use AuthToken instead
	GithubToken  string              `mapstructure:"githubToken" koanf:"githubtoken"`
	URL          string              `mapstructure:"url" koanf:"url"`
	Timeout      int64               `mapstructure:"timeout" koanf:"timeout"`
	HTTPMethod   string              `mapstructure:"method" koanf:"method"`
	HTTPBody     string              `mapstructure:"body" koanf:"body"`
	HTTPHeaders  map[string][]string `mapstructure:"headers" koanf:"headers"`
	Bucket       string              `mapstructure:"bucket" koanf:"bucket"`
	Object       string              `mapstructure:"object" koanf:"object"`
	Item         string              `mapstructure:"item" koanf:"item"`
	Namespace    string              `mapstructure:"namespace" koanf:"namespace"`
	ConfigMap    string              `mapstructure:"configmap" koanf:"configmap"`
	Key          string              `mapstructure:"key" koanf:"key"`
	BaseURL      string              `mapstructure:"baseUrl" koanf:"baseurl"`
	AuthToken    string              `mapstructure:"token" koanf:"token"`
	URI          string              `mapstructure:"uri" koanf:"uri"`
	Database     string              `mapstructure:"database" koanf:"database"`
	Collection   string              `mapstructure:"collection" koanf:"collection"`
	Type         string              `mapstructure:"type" koanf:"type"`
	Table        string              `mapstructure:"table" koanf:"table"`
	Column       string              `mapstructure:"column" koanf:"column"`
	RedisOptions *redis.Options      `mapstructure:"redisOptions" koanf:"redisOptions"`
	RedisPrefix  string              `mapstructure:"redisPrefix" koanf:"redisPrefix"`
	AccountName  string              `mapstructure:"accountName" koanf:"accountname"`
	AccountKey   string              `mapstructure:"accountKey" koanf:"accountkey"`
	Container    string              `mapstructure:"container" koanf:"container"`
}

// IsValid validate the configuration of the retriever
// nolint:gocognit
func (c *RetrieverConf) IsValid() error {
	if err := c.Kind.IsValid(); err != nil {
		return err
	}
	if c.Kind == GitHubRetriever || c.Kind == GitlabRetriever || c.Kind == BitbucketRetriever {
		return c.validateGitRetriever()
	}
	if c.Kind == S3Retriever && c.Item == "" {
		return fmt.Errorf("invalid retriever: no \"item\" property found for kind \"%s\"", c.Kind)
	}
	if c.Kind == HTTPRetriever && c.URL == "" {
		return fmt.Errorf("invalid retriever: no \"url\" property found for kind \"%s\"", c.Kind)
	}
	if c.Kind == GoogleStorageRetriever && c.Object == "" {
		return fmt.Errorf("invalid retriever: no \"object\" property found for kind \"%s\"", c.Kind)
	}
	if c.Kind == FileRetriever && c.Path == "" {
		return fmt.Errorf("invalid retriever: no \"path\" property found for kind \"%s\"", c.Kind)
	}
	if (c.Kind == S3Retriever || c.Kind == GoogleStorageRetriever) && c.Bucket == "" {
		return fmt.Errorf("invalid retriever: no \"bucket\" property found for kind \"%s\"", c.Kind)
	}
	if c.Kind == KubernetesRetriever {
		return c.validateKubernetesRetriever()
	}
	if c.Kind == MongoDBRetriever {
		return c.validateMongoDBRetriever()
	}
	if c.Kind == PostgreSQLRetriever {
		return c.validatePostgreSQLRetriever()
	}
	if c.Kind == RedisRetriever {
		return c.validateRedisRetriever()
	}
	if c.Kind == AzBlobStorageRetriever {
		return c.validateAzBlobStorageRetriever()
	}
	return nil
}

func (c *RetrieverConf) validateGitRetriever() error {
	if c.RepositorySlug == "" {
		return fmt.Errorf("invalid retriever: no \"repositorySlug\" property found for kind \"%s\"", c.Kind)
	}
	if c.Path == "" {
		return fmt.Errorf("invalid retriever: no \"path\" property found for kind \"%s\"", c.Kind)
	}
	return nil
}

func (c *RetrieverConf) validateKubernetesRetriever() error {
	if c.ConfigMap == "" {
		return fmt.Errorf("invalid retriever: no \"configmap\" property found for kind \"%s\"", c.Kind)
	}
	if c.Namespace == "" {
		return fmt.Errorf("invalid retriever: no \"namespace\" property found for kind \"%s\"", c.Kind)
	}
	if c.Key == "" {
		return fmt.Errorf("invalid retriever: no \"key\" property found for kind \"%s\"", c.Kind)
	}
	return nil
}

func (c *RetrieverConf) validateMongoDBRetriever() error {
	if c.Collection == "" {
		return fmt.Errorf("invalid retriever: no \"collection\" property found for kind \"%s\"", c.Kind)
	}
	if c.Database == "" {
		return fmt.Errorf("invalid retriever: no \"database\" property found for kind \"%s\"", c.Kind)
	}
	if c.URI == "" {
		return fmt.Errorf("invalid retriever: no \"uri\" property found for kind \"%s\"", c.Kind)
	}
	return nil
}

func (c *RetrieverConf) validatePostgreSQLRetriever() error {
	validTypes := []string{"json", "relational"}
	if c.Type == "json" && c.Column == "" {
		return fmt.Errorf("invalid retriever: no \"column\" property found for kind \"%s\"", c.Kind)
	}
	if c.Type == "json" && c.Table == "" {
		return fmt.Errorf("invalid retriever: no \"table\" property found for kind \"%s\"", c.Kind)
	}
	if c.URI == "" {
		return fmt.Errorf("invalid retriever: no \"uri\" property found for kind \"%s\"", c.Kind)
	}
	if c.Type == "" || !slices.Contains(validTypes, c.Type) {
		return fmt.Errorf("invalid retriever: no \"type\" property or not a valid type in kind \"%s\"", c.Kind)
	}

	return nil
}

func (c *RetrieverConf) validateRedisRetriever() error {
	if c.RedisOptions == nil {
		return fmt.Errorf("invalid retriever: no \"redisOptions\" property found for kind \"%s\"", c.Kind)
	}
	return nil
}

func (c *RetrieverConf) validateAzBlobStorageRetriever() error {
	if c.AccountName == "" {
		return fmt.Errorf("invalid retriever: no \"accountName\" property found for kind \"%s\"", c.Kind)
	}
	if c.Container == "" {
		return fmt.Errorf("invalid retriever: no \"container\" property found for kind \"%s\"", c.Kind)
	}
	if c.Object == "" {
		return fmt.Errorf("invalid retriever: no \"object\" property found for kind \"%s\"", c.Kind)
	}
	return nil
}

// RetrieverKind is an enum containing all accepted Retriever kind
type RetrieverKind string

const (
	HTTPRetriever          RetrieverKind = "http"
	GitHubRetriever        RetrieverKind = "github"
	GitlabRetriever        RetrieverKind = "gitlab"
	S3Retriever            RetrieverKind = "s3"
	FileRetriever          RetrieverKind = "file"
	GoogleStorageRetriever RetrieverKind = "googleStorage"
	KubernetesRetriever    RetrieverKind = "configmap"
	MongoDBRetriever       RetrieverKind = "mongodb"
	PostgreSQLRetriever    RetrieverKind = "postgresql"
	RedisRetriever         RetrieverKind = "redis"
	BitbucketRetriever     RetrieverKind = "bitbucket"
	AzBlobStorageRetriever RetrieverKind = "azureBlobStorage"
)

// IsValid is checking if the value is part of the enum
func (r RetrieverKind) IsValid() error {
	switch r {
	case HTTPRetriever, GitHubRetriever, GitlabRetriever, S3Retriever, RedisRetriever,
		FileRetriever, GoogleStorageRetriever, KubernetesRetriever, MongoDBRetriever,
		PostgreSQLRetriever, BitbucketRetriever, AzBlobStorageRetriever:
		return nil
	}
	return fmt.Errorf("invalid retriever: kind \"%s\" is not supported", r)
}