Add Blueprint level validation for slurm_cluster_name variable (#5010)

Author: saara-tyagi27

pkg/config/config.go

@@ -617,6 +617,7 @@ func (err InputValueError) Error() string {
 
 var matchLabelNameExp *regexp.Regexp = regexp.MustCompile(`^[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}$`)
 var matchLabelValueExp *regexp.Regexp = regexp.MustCompile(`^[\p{Ll}\p{Lo}\p{N}_-]{0,63}$`)
+var matchSlurmClusterNameExp *regexp.Regexp = regexp.MustCompile(`^[a-z](?:[a-z0-9]{0,9})$`)
 
 // isValidLabelName checks if a string is a valid name for a GCP label.
 // For more information on valid label names, see the docs at:
@@ -696,6 +697,42 @@ func (bp *Blueprint) checkBlueprintName() error {
 	return nil
 }
 
+func validateSlurmClusterName(bp Blueprint) error {
+	path := Root.Vars.Dot("slurm_cluster_name")
+
+	if !bp.Vars.Has("slurm_cluster_name") {
+		return nil // Optional: slurm_cluster_name is not always required
+	}
+
+	v, err := bp.Eval(GlobalRef("slurm_cluster_name").AsValue())
+	if err != nil {
+		return BpError{path, err}
+	}
+	if v.Type() != cty.String || v.IsNull() || !v.IsKnown() {
+		return BpError{path, InputValueError{
+			inputKey: "slurm_cluster_name",
+			cause:    errMsgValueNotString,
+		}}
+	}
+
+	s := v.AsString()
+	if len(s) == 0 {
+		return BpError{path, InputValueError{
+			inputKey: "slurm_cluster_name",
+			cause:    errMsgValueEmptyString,
+		}}
+	}
+
+	// Check that slurm_cluster_name matches the required regex
+	if !matchSlurmClusterNameExp.MatchString(s) {
+		return BpError{path, InputValueError{
+			inputKey: "slurm_cluster_name",
+			cause:    errMsgSlurmClusterNameReqs,
+		}}
+	}
+	return nil
+}
+
 // checkToolkitModulesUrlAndVersion returns an error if either
 // toolkit_modules_url or toolkit_modules_version is
 // exclsuively supplied (i.e., one is present, but the other is missing).

pkg/config/config_test.go

@@ -845,3 +845,81 @@ func (s *zeroSuite) TestEvalVars(c *C) {
 		}
 	}
 }
+
+func (s *zeroSuite) TestValidateSlurmClusterName(c *C) {
+	var e InputValueError
+
+	h := func(val cty.Value) error {
+		vars := NewDict(map[string]cty.Value{"slurm_cluster_name": val})
+		return validateSlurmClusterName(Blueprint{Vars: vars})
+	}
+
+	// Valid slurm_cluster_name examples
+	c.Check(h(cty.StringVal("a")), IsNil)          // single lowercase letter
+	c.Check(h(cty.StringVal("abc123")), IsNil)     // letters and numbers
+	c.Check(h(cty.StringVal("slurm1")), IsNil)     // typical name
+	c.Check(h(cty.StringVal("a123456789")), IsNil) // max length (10 chars)
+
+	{ // Is slurm_cluster_name an empty string?
+		err := h(cty.StringVal(""))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*empty string.*")
+	}
+
+	{ // Is slurm_cluster_name not a string?
+		err := h(cty.NumberIntVal(100))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*not.*string.*")
+	}
+
+	{ // Is slurm_cluster_name longer than 10 characters?
+		err := h(cty.StringVal("slurm12345678"))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*between 1 and 10 characters.*")
+	}
+
+	{ // Does slurm_cluster_name contain uppercase letters?
+		err := h(cty.StringVal("Slurm"))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*lowercase letter.*")
+	}
+
+	{ // Does slurm_cluster_name start with a number?
+		err := h(cty.StringVal("1slurm"))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*start with a lowercase letter.*")
+	}
+
+	{ // Does slurm_cluster_name contain special characters (dash)?
+		err := h(cty.StringVal("slurm-gke"))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*lowercase letters and numbers.*")
+	}
+
+	{ // Does slurm_cluster_name contain special characters (underscore)?
+		err := h(cty.StringVal("slurm_gke"))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*lowercase letters and numbers.*")
+	}
+
+	{ // Does slurm_cluster_name contain special characters (period)?
+		err := h(cty.StringVal("slurm.gke"))
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*lowercase letters and numbers.*")
+	}
+
+	{ // Is slurm_cluster_name not set?  (should pass - it's optional)
+		err := validateSlurmClusterName(Blueprint{})
+		c.Check(err, IsNil)
+	}
+
+	{ // Expression (should pass if it evaluates correctly)
+		c.Check(h(MustParseExpression(`"slurm${1}"`).AsValue()), IsNil)
+	}
+
+	{ // Expression that results in invalid value
+		err := h(MustParseExpression(`"Slurm${1}"`).AsValue())
+		c.Check(errors.As(err, &e), Equals, true)
+		c.Check(err, ErrorMatches, ".*lowercase letter.*")
+	}
+}

pkg/config/errors.go

@@ -163,7 +163,8 @@ var UnexpectedRefFormat = errors.New("Expected reference formats: $(vars.var_nam
 const (
 	errMsgIntergroupOrder = string("references to outputs from other groups must be to earlier groups")
 
-	errMsgValueNotString   = string("value was not of type string")
-	errMsgValueEmptyString = string("value is an empty string")
-	errMsgLabelValueReqs   = string("value can only contain lowercase letters, numeric characters, underscores and dashes, and must be between 0 and 63 characters long")
+	errMsgValueNotString       = string("value was not of type string")
+	errMsgValueEmptyString     = string("value is an empty string")
+	errMsgLabelValueReqs       = string("value can only contain lowercase letters, numeric characters, underscores and dashes, and must be between 0 and 63 characters long")
+	errMsgSlurmClusterNameReqs = string("must start with a lowercase letter, contain only lowercase letters and numbers, and be between 1 and 10 characters long")
 )

pkg/config/validate.go

@@ -89,7 +89,8 @@ func validateVars(bp Blueprint) error {
 
 	errs := (&Errors{}).
 		Add(validateDeploymentName(bp)).
-		Add(validateGlobalLabels(bp))
+		Add(validateGlobalLabels(bp)).
+		Add(validateSlurmClusterName(bp))
 	// Check for any nil values
 	// Iterator over non evaluated variables, it's Ok if evaluated value is null
 	for key, val := range bp.Vars.Items() {