feat: implement variable set (#1344)

Author: liu-hm19

api/openapispec/docs.go

@@ -27,6 +27,7 @@ const (
 	ResourcePageSizeLarge   = 1000
 	CommonPageDefault       = 1
 	CommonPageSizeDefault   = 10
+	CommonMaxResultLimit    = 10000
 	SortByCreateTimestamp   = "createTimestamp"
 	SortByModifiedTimestamp = "modifiedTimestamp"
 	SortByName              = "name"

api/openapispec/swagger.json

@@ -0,0 +1,9 @@
+package constant
+
+import "errors"
+
+var (
+	ErrInvalidVariableName = errors.New("variable name can only have alphanumeric characters and underscores with [a-zA-Z0-9_]")
+	ErrInvalidVariableType = errors.New("invalid variable type, only PlainText and CipherText supported")
+	ErrEmptyVariableSet    = errors.New("variable set should not be empty")
+)

api/openapispec/swagger.yaml

@@ -0,0 +1,8 @@
+package constant
+
+import "errors"
+
+var (
+	ErrInvalidVariableSetName = errors.New("variable set name can only have alphanumeric characters and underscores with [a-zA-Z0-9_]")
+	ErrEmptyVariableSetLabels = errors.New("variable set labels should not be empty")
+)

pkg/domain/constant/global.go

@@ -6,6 +6,7 @@ type Pagination struct {
 }
 
 type SortOptions struct {
-	Field     string
-	Ascending bool
+	Field      string
+	Ascending  bool
+	Descending bool
 }

pkg/domain/constant/variable.go

@@ -0,0 +1,59 @@
+package entity
+
+import "errors"
+
+type VariableType string
+
+const (
+	PlainTextType  VariableType = "PlainText"
+	CipherTextType VariableType = "CipherText"
+)
+
+// Variable represents a specific configuration code variable,
+// which usually includes the global configuration for Terraform providers like
+// api host, access key and secret key.
+type Variable struct {
+	// Name is the name of the variable.
+	Name string `yaml:"name,omitempty" json:"name,omitempty"`
+	// Value is the value of the variable.
+	Value string `yaml:"value,omitempty" json:"value,omitempty"`
+	// Type is the text type of the variable.
+	Type VariableType `yaml:"type,omitempty" json:"type,omitempty"`
+	// VariableSet is the variable set to which the variable belongs.
+	VariableSet string `yaml:"variableSet,omitempty" json:"variableSet,omitempty"`
+}
+
+// VariableFilter represents the filter conditions to list variables.
+type VariableFilter struct {
+	Name        string
+	VariableSet string
+	Pagination  *Pagination
+	FetchAll    bool
+}
+
+// VariableListResult represents the result of listing variables.
+type VariableListResult struct {
+	Variables []*Variable
+	Total     int
+}
+
+// Validate checks if the variable is valid.
+func (v *Variable) Validate() error {
+	if v == nil {
+		return errors.New("variable is nil")
+	}
+
+	if v.Name == "" {
+		return errors.New("empty variable name")
+	}
+
+	if v.Type != PlainTextType && v.Type != CipherTextType {
+		return errors.New("invalid variable type")
+	}
+
+	if v.VariableSet == "" {
+		return errors.New("empty variable set name")
+	}
+
+	return nil
+}

pkg/domain/constant/variable_set.go

@@ -0,0 +1,41 @@
+package entity
+
+import "errors"
+
+// VariableSet represents a set of the global configuration variables.
+type VariableSet struct {
+	// Name is the name of the variable set.
+	Name string `yaml:"name,omitempty" json:"name,omitempty"`
+	// Labels clarifies the scope of the variable set.
+	Labels map[string]string `yaml:"labels,omitempty" json:"labels,omitempty"`
+}
+
+// VariableSetFilter represents the filter conditions to list variable sets.
+type VariableSetFilter struct {
+	Name       string
+	Pagination *Pagination
+	FetchAll   bool
+}
+
+// VariableSetListResult represents the result of listing variable sets.
+type VariableSetListResult struct {
+	VariableSets []*VariableSet
+	Total        int
+}
+
+// Validate checks if the variable set is valid.
+func (vs *VariableSet) Validate() error {
+	if vs == nil {
+		return errors.New("variable set is nil")
+	}
+
+	if vs.Name == "" {
+		return errors.New("empty variable set name")
+	}
+
+	if len(vs.Labels) == 0 {
+		return errors.New("empty variable set labels")
+	}
+
+	return nil
+}

pkg/domain/entity/types.go

@@ -152,3 +152,33 @@ type RunRepository interface {
 	// List retrieves all existing run.
 	List(ctx context.Context, filter *entity.RunFilter, sortOptions *entity.SortOptions) (*entity.RunListResult, error)
 }
+
+// VariableSetRepository is an interface that defines the repository operations
+// for variable sets. It follows the principles of domain-driven design (DDD).
+type VariableSetRepository interface {
+	// Create creates a new variable set.
+	Create(ctx context.Context, vs *entity.VariableSet) error
+	// Delete deletes a variable set by its name.
+	Delete(ctx context.Context, name string) error
+	// Update updates an existing variable set.
+	Update(ctx context.Context, vs *entity.VariableSet) error
+	// Get retrieves a variable set by its name.
+	Get(ctx context.Context, name string) (*entity.VariableSet, error)
+	// List retrieves existing variable sets with filter and sort options.
+	List(ctx context.Context, filter *entity.VariableSetFilter, sortOptions *entity.SortOptions) (*entity.VariableSetListResult, error)
+}
+
+// VariableRepository is an interface that defines the repository operations
+// for variables. It follows the principles of domain-driven design (DDD).
+type VariableRepository interface {
+	// Create creates a new variable.
+	Create(ctx context.Context, v *entity.Variable) error
+	// Delete deletes a variable by its name and the variable set it belongs to.
+	Delete(ctx context.Context, name, variableSet string) error
+	// Update updates an existing variable.
+	Update(ctx context.Context, v *entity.Variable) error
+	// Get retrieves a variable by its name and the variable set it belogs to.
+	Get(ctx context.Context, name, variableSet string) (*entity.Variable, error)
+	// List retrieves existing variable with filter and sort options.
+	List(ctx context.Context, filter *entity.VariableFilter, sortOptions *entity.SortOptions) (*entity.VariableListResult, error)
+}