Merge pull request #251 from OpsLevel/kr/tag-key-validation

add tag key validation

.changes/unreleased/Feature-20230922-082512.yaml

@@ -0,0 +1,3 @@
+kind: Feature
+body: Add tag key name validation to `CreateTag` `AssignTag` and `UpdateTag` methods
+time: 2023-09-22T08:25:12.029174-05:00

tags.go

@@ -1,12 +1,22 @@
 package opslevel
 
+import (
+	"fmt"
+	"regexp"
+)
+
 type TagOwner string
 
 const (
 	TagOwnerService    TagOwner = "Service"
 	TagOwnerRepository TagOwner = "Repository"
 )
 
+var (
+	TagKeyRegex    = regexp.MustCompile(`\A[a-z][0-9a-z_\.\/\\-]*\z`)
+	TagKeyErrorMsg = "tag key name '%s' must start with a letter and be only lowercase alphanumerics, underscores, hyphens, periods, and slashes"
+)
+
 type Tag struct {
 	Id    ID     `json:"id"`
 	Key   string `json:"key"`
@@ -49,6 +59,15 @@ type TagDeleteInput struct {
 	Id ID `json:"id"`
 }
 
+//#region Helpers
+
+func ValidateTagKey(key string) error {
+	if !TagKeyRegex.MatchString(key) {
+		return fmt.Errorf(TagKeyErrorMsg, key)
+	}
+	return nil
+}
+
 //#region Assign
 
 // Deprecated: Use AssignTagsFor instead
@@ -76,6 +95,9 @@ func (client *Client) AssignTags(identifier string, tags map[string]string) ([]T
 		Tags: []TagInput{},
 	}
 	for key, value := range tags {
+		if err := ValidateTagKey(key); err != nil {
+			return nil, err
+		}
 		input.Tags = append(input.Tags, TagInput{
 			Key:   key,
 			Value: value,
@@ -110,6 +132,9 @@ func (client *Client) AssignTag(input TagAssignInput) ([]Tag, error) {
 func (client *Client) CreateTags(identifier string, tags map[string]string) ([]Tag, error) {
 	var output []Tag
 	for key, value := range tags {
+		if err := ValidateTagKey(key); err != nil {
+			return nil, err
+		}
 		input := TagCreateInput{
 			Key:   key,
 			Value: value,
@@ -141,6 +166,9 @@ func (client *Client) CreateTag(input TagCreateInput) (*Tag, error) {
 			Errors []OpsLevelErrors
 		} `graphql:"tagCreate(input: $input)"`
 	}
+	if err := ValidateTagKey(input.Key); err != nil {
+		return nil, err
+	}
 	v := PayloadVariables{
 		"input": input,
 	}
@@ -187,6 +215,9 @@ func (client *Client) UpdateTag(input TagUpdateInput) (*Tag, error) {
 			Errors []OpsLevelErrors
 		} `graphql:"tagUpdate(input: $input)"`
 	}
+	if err := ValidateTagKey(input.Key); err != nil {
+		return nil, err
+	}
 	v := PayloadVariables{
 		"input": input,
 	}