Add allowLink option into the spec

Author: marc-gr

code/go/internal/specschema/folder_item_spec.go

@@ -81,6 +81,11 @@ func (s *ItemSpec) DevelopmentFolder() bool {
 	return s.itemSpec.DevelopmentFolder
 }
 
+// AllowLink returns true if the item allows links.
+func (s *ItemSpec) AllowLink() bool {
+	return s.itemSpec.AllowLink
+}
+
 // ForbiddenPatterns returns the list of forbidden patterns for the name of this item.
 func (s *ItemSpec) ForbiddenPatterns() []string {
 	return s.itemSpec.ForbiddenPatterns
@@ -135,6 +140,7 @@ type folderItemSpec struct {
 	AdditionalContents bool              `json:"additionalContents" yaml:"additionalContents"`
 	Contents           []*folderItemSpec `json:"contents" yaml:"contents"`
 	DevelopmentFolder  bool              `json:"developmentFolder" yaml:"developmentFolder"`
+	AllowLink          bool              `json:"allowLink" yaml:"allowLink"`
 
 	// As it is required to be inline both in yaml and json, this struct must be public embedded field
 	SpecLimits `yaml:",inline"`

code/go/internal/spectypes/item.go

@@ -57,6 +57,9 @@ type ItemSpec interface {
 	// DevelopmentFolder returns true if the item is inside a development folder.
 	DevelopmentFolder() bool
 
+	// AllowLink returns true if the item allows links.
+	AllowLink() bool
+
 	// ForbiddenPatterns returns the list of forbidden patterns for the name of this item.
 	ForbiddenPatterns() []string
 

code/go/internal/validator/folder_item_spec.go

@@ -16,13 +16,15 @@ import (
 func matchingFileExists(spec spectypes.ItemSpec, files []fs.DirEntry) (bool, error) {
 	if spec.Name() != "" {
 		for _, file := range files {
-			if file.Name() == spec.Name() {
+			_, fileName := checkLink(file.Name())
+			if fileName == spec.Name() {
 				return spec.IsDir() == file.IsDir(), nil
 			}
 		}
 	} else if spec.Pattern() != "" {
 		for _, file := range files {
-			isMatch, err := regexp.MatchString(spec.Pattern(), file.Name())
+			_, fileName := checkLink(file.Name())
+			isMatch, err := regexp.MatchString(spec.Pattern(), fileName)
 			if err != nil {
 				return false, fmt.Errorf("invalid folder item spec pattern: %w", err)
 			}

code/go/internal/validator/folder_spec.go

@@ -190,6 +190,7 @@ func (v *validator) Validate() specerrors.ValidationErrors {
 }
 
 func (v *validator) findItemSpec(folderItemName string) (spectypes.ItemSpec, error) {
+	isLink, folderItemName := checkLink(folderItemName)
 	for _, itemSpec := range v.spec.Contents() {
 		if itemSpec.Name() != "" && itemSpec.Name() == folderItemName {
 			return itemSpec, nil
@@ -213,6 +214,9 @@ func (v *validator) findItemSpec(folderItemName string) (spectypes.ItemSpec, err
 				}
 
 				if !isForbidden {
+					if isLink && !itemSpec.AllowLink() {
+						return nil, fmt.Errorf("item [%s] is a link but is not allowed", folderItemName)
+					}
 					return itemSpec, nil
 				}
 			}
@@ -222,3 +226,13 @@ func (v *validator) findItemSpec(folderItemName string) (spectypes.ItemSpec, err
 	// No item spec found
 	return nil, nil
 }
+
+// checkLink checks if an item is a link and returns the item name without the
+// ".link" suffix if it is a link.
+func checkLink(itemName string) (bool, string) {
+	const linkExtension = ".link"
+	if strings.HasSuffix(itemName, linkExtension) {
+		return true, strings.TrimSuffix(itemName, linkExtension)
+	}
+	return false, itemName
+}

code/go/internal/validator/semantic/validate_anyof_required_contents.go

@@ -214,7 +214,6 @@ func (s Spec) rules(pkgType string, rootSpec spectypes.ItemSpec) validationRules
 		{fn: semantic.ValidateDimensionsPresent, types: []string{"integration"}, since: semver.MustParse("3.0.1")},
 		{fn: semantic.ValidateCapabilitiesRequired, since: semver.MustParse("2.10.0")}, // capabilities definition was added in spec version 2.10.0
 		{fn: semantic.ValidateRequiredVarGroups},
-		{fn: semantic.ValidateAnyOfRequiredContents},
 	}
 
 	var validationRules validationRules

code/go/internal/validator/spec.go

@@ -30,7 +30,8 @@ func NewLinksFS(workDir string, inner fs.FS) *LinksFS {
 
 // Open opens a file in the filesystem.
 func (lfs *LinksFS) Open(name string) (fs.File, error) {
-	if filepath.Ext(name) != LinkExtension {
+	const linkExtension = ".link"
+	if filepath.Ext(name) != linkExtension {
 		return lfs.inner.Open(name)
 	}
 	pathName := filepath.Join(lfs.workDir, name)

code/go/pkg/linkedfiles/fs.go

@@ -16,9 +16,6 @@ import (
 	"strings"
 )
 
-// LinkExtension is the file extension for linked files.
-const LinkExtension = ".link"
-
 // A Link represents a linked file.
 // It contains the path to the link file, the checksum of the linked file,
 // the path to the target file, and the checksum of the included file contents.

code/go/pkg/linkedfiles/linkedfiles.go

@@ -814,41 +814,6 @@ func TestValidateForbiddenDataStreamName(t *testing.T) {
 	}
 }
 
-func TestValidateAnyOfContents(t *testing.T) {
-	tests := map[string][]string{
-		"missing_required_files": {
-			"item [.keep] is not allowed in folder [../../../../test/packages/missing_required_files/agent/input]",
-			"item [.keep] is not allowed in folder [../../../../test/packages/missing_required_files/data_stream/foo/agent/stream]",
-			"item [.keep] is not allowed in folder [../../../../test/packages/missing_required_files/data_stream/foo/elasticsearch/ingest_pipeline]",
-			"item [.keep] is not allowed in folder [../../../../test/packages/missing_required_files/data_stream/foo/fields]",
-			`path "agent/input": no file matching any of the patterns [*.yml.hbs *.yml.hbs.link] found in agent/input`,
-			`data stream "foo": no file matching any of the patterns [*.yml.hbs *.yml.hbs.link] found in data_stream/foo/agent/stream`,
-			`data stream "foo": no file matching any of the patterns [*.yml *.yml.link] found in data_stream/foo/fields`,
-			`path "elasticsearch/ingest_pipeline": no file matching any of the patterns [*.yml *.json *.yml.link *.json.link] found in elasticsearch/ingest_pipeline`,
-			`data stream "foo": no file matching any of the patterns [*.yml *.json *.yml.link *.json.link] found in data_stream/foo/elasticsearch/ingest_pipeline`,
-		},
-	}
-
-	for pkgName, expectedErrorMessages := range tests {
-		t.Run(pkgName, func(t *testing.T) {
-			err := ValidateFromPath(path.Join("..", "..", "..", "..", "test", "packages", pkgName))
-			if len(expectedErrorMessages) == 0 {
-				assert.NoError(t, err)
-				return
-			}
-			assert.Error(t, err)
-
-			errs, ok := err.(specerrors.ValidationErrors)
-			require.True(t, ok)
-			assert.Len(t, errs, len(expectedErrorMessages))
-
-			for _, foundError := range errs {
-				require.Contains(t, expectedErrorMessages, foundError.Error())
-			}
-		})
-	}
-}
-
 func requireErrorMessage(t *testing.T, pkgName string, invalidItemsPerFolder map[string][]string, expectedErrorMessage string) {
 	pkgRootPath := filepath.Join("..", "..", "..", "..", "test", "packages", pkgName)
 

code/go/pkg/validator/validator_test.go

@@ -11,8 +11,5 @@ spec:
       type: file
       sizeLimit: 2MB
       pattern: '^.+\.yml\.hbs$'
-      required: false
-    - description: Link to a config template file for inputs defined in the policy_templates section of the top level manifest
-      type: file
-      pattern: '^.+\.yml\.hbs\.link$'
-      required: false
+      required: true
+      allowLink: true