Wire elastic-package to package-spec validation modes

cmd/lint.go

@@ -95,7 +95,7 @@ func validateSourceCommandAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return fmt.Errorf("locating package root failed: %w", err)
 	}
-	errs, skipped := validation.ValidateAndFilterFromPath(packageRoot)
+	errs, skipped := validation.ValidateSourceFromPath(packageRoot)
 	if skipped != nil {
 		logger.Infof("Skipped errors: %v", skipped)
 	}

internal/builder/packages.go

@@ -272,7 +272,7 @@ func BuildPackage(options BuildOptions) (string, error) {
 	}
 
 	logger.Debugf("Validating built package (path: %s)", buildPackageRoot)
-	errs, skipped := validation.ValidateAndFilterFromPath(buildPackageRoot)
+	errs, skipped := validation.ValidateBuiltFromPath(buildPackageRoot)
 	if skipped != nil {
 		logger.Infof("Skipped errors: %v", skipped)
 	}
@@ -300,7 +300,7 @@ func buildZippedPackage(options BuildOptions, buildPackageRoot string) (string,
 		logger.Debug("Skip validation of the built .zip package")
 	} else {
 		logger.Debugf("Validating built .zip package (path: %s)", zippedPackagePath)
-		errs, skipped := validation.ValidateAndFilterFromZip(zippedPackagePath)
+		errs, skipped := validation.ValidateBuiltFromZip(zippedPackagePath)
 		if skipped != nil {
 			logger.Infof("Skipped errors: %v", skipped)
 		}

internal/packages/installer/factory.go

@@ -80,7 +80,7 @@ func NewForPackage(options Options) (Installer, error) {
 			logger.Debug("Skip validation of the built .zip package")
 		} else {
 			logger.Debugf("Validating built .zip package (path: %s)", options.ZipPath)
-			errs, skipped := validation.ValidateAndFilterFromZip(options.ZipPath)
+			errs, skipped := validation.ValidateBuiltFromZip(options.ZipPath)
 			if skipped != nil {
 				logger.Infof("Skipped errors: %v", skipped)
 			}

internal/validation/testdata/built_package/LICENSE.txt

@@ -0,0 +1,3 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license

internal/validation/testdata/built_package/changelog.yml

@@ -0,0 +1,6 @@
+# newer versions go on top
+- version: "0.0.1"
+  changes:
+    - description: Initial draft of the package
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/1

internal/validation/testdata/built_package/data_stream/events/agent/stream/stream.yml.hbs

@@ -0,0 +1,4 @@
+paths:
+{{#each paths}}
+  - {{this}}
+{{/each}}

internal/validation/testdata/built_package/data_stream/events/fields/base-fields.yml

@@ -0,0 +1,12 @@
+- name: data_stream.type
+  type: constant_keyword
+  description: Data stream type.
+- name: data_stream.dataset
+  type: constant_keyword
+  description: Data stream dataset.
+- name: data_stream.namespace
+  type: constant_keyword
+  description: Data stream namespace.
+- name: "@timestamp"
+  type: date
+  description: Event timestamp.

internal/validation/testdata/built_package/data_stream/events/fields/fields.yml

@@ -0,0 +1,3 @@
+- name: message
+  type: keyword
+  description: Log message.

internal/validation/testdata/built_package/data_stream/events/manifest.yml

@@ -0,0 +1,23 @@
+title: Events
+type: logs
+elasticsearch:
+  index_template:
+    mappings:
+      dynamic_templates:
+        - _embedded_ecs:
+            match_mapping_type: string
+            mapping:
+              type: keyword
+streams:
+  - input: logfile
+    title: Events logs
+    description: Collect events log data
+    vars:
+      - name: paths
+        type: text
+        title: Paths
+        multi: true
+        required: true
+        show_user: true
+        default:
+          - /var/log/*.log

internal/validation/testdata/built_package/docs/README.md

@@ -0,0 +1,3 @@
+# Built Package
+
+Minimal built-package fixture for ValidateBuiltFromPath/Zip tests.

internal/validation/testdata/built_package/manifest.yml

@@ -0,0 +1,23 @@
+format_version: 3.6.0
+name: built_package
+title: Built Package
+description: Minimal built-package fixture for ValidateBuiltFromPath/Zip tests.
+version: 0.0.1
+type: integration
+source:
+  license: "Apache-2.0"
+conditions:
+  kibana:
+    version: '^8.0.0 || ^9.0.0'
+policy_templates:
+  - name: events
+    title: Events logs
+    description: Collect events data
+    inputs:
+      - type: logfile
+        title: Collect events logs
+        description: Collecting events log data
+        multi: false
+owner:
+  github: elastic/foobar
+  type: community

internal/validation/testdata/composable_source_package/LICENSE.txt

@@ -0,0 +1,3 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license

internal/validation/testdata/composable_source_package/_dev/build/docs/README.md

@@ -0,0 +1,3 @@
+# {{package.title}}
+
+{{package.description}}

internal/validation/testdata/composable_source_package/changelog.yml

@@ -0,0 +1,6 @@
+# newer versions go on top
+- version: "0.0.1"
+  changes:
+    - description: Initial draft of the package
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/1

internal/validation/testdata/composable_source_package/data_stream/events/agent/stream/stream.yml.hbs

@@ -0,0 +1,4 @@
+paths:
+{{#each paths}}
+  - {{this}}
+{{/each}}

internal/validation/testdata/composable_source_package/data_stream/events/fields/base-fields.yml

@@ -0,0 +1,12 @@
+- name: data_stream.type
+  type: constant_keyword
+  description: Data stream type.
+- name: data_stream.dataset
+  type: constant_keyword
+  description: Data stream dataset.
+- name: data_stream.namespace
+  type: constant_keyword
+  description: Data stream namespace.
+- name: "@timestamp"
+  type: date
+  description: Event timestamp.

internal/validation/testdata/composable_source_package/data_stream/events/manifest.yml

@@ -0,0 +1,6 @@
+title: Events
+type: logs
+streams:
+  - package: test_input
+    title: Events logs
+    description: Collect events log data via composable input

internal/validation/testdata/composable_source_package/docs/README.md

@@ -0,0 +1,3 @@
+# Composable Source Package
+
+Minimal composable source-package fixture for ValidateSourceFromPath tests.

internal/validation/testdata/composable_source_package/manifest.yml

@@ -0,0 +1,26 @@
+format_version: 3.6.0
+name: composable_source_package
+title: Composable Source Package
+description: "Minimal composable source-package fixture; uses package: references that are source-only."
+version: 0.0.1
+type: integration
+source:
+  license: "Apache-2.0"
+conditions:
+  kibana:
+    version: '^8.0.0 || ^9.0.0'
+requires:
+  input:
+    - package: test_input
+      version: "1.0.0"
+policy_templates:
+  - name: events
+    title: Events logs
+    description: Collect events data
+    inputs:
+      - package: test_input
+        title: Collect events logs
+        description: Collecting events log data via composable input
+owner:
+  github: elastic/foobar
+  type: community

internal/validation/testdata/source_package/LICENSE.txt

@@ -0,0 +1,3 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license

internal/validation/testdata/source_package/_dev/build/docs/README.md

@@ -0,0 +1,3 @@
+# {{package.title}}
+
+{{package.description}}

internal/validation/testdata/source_package/changelog.yml

@@ -0,0 +1,6 @@
+# newer versions go on top
+- version: "0.0.1"
+  changes:
+    - description: Initial draft of the package
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/1

internal/validation/testdata/source_package/data_stream/events/agent/stream/stream.yml.hbs

@@ -0,0 +1,4 @@
+paths:
+{{#each paths}}
+  - {{this}}
+{{/each}}

internal/validation/testdata/source_package/data_stream/events/fields/base-fields.yml

@@ -0,0 +1,12 @@
+- name: data_stream.type
+  type: constant_keyword
+  description: Data stream type.
+- name: data_stream.dataset
+  type: constant_keyword
+  description: Data stream dataset.
+- name: data_stream.namespace
+  type: constant_keyword
+  description: Data stream namespace.
+- name: "@timestamp"
+  type: date
+  description: Event timestamp.

internal/validation/testdata/source_package/data_stream/events/fields/fields.yml

@@ -0,0 +1,3 @@
+- name: message
+  type: keyword
+  description: Log message.

internal/validation/testdata/source_package/data_stream/events/manifest.yml

@@ -0,0 +1,15 @@
+title: Events
+type: logs
+streams:
+  - input: logfile
+    title: Events logs
+    description: Collect events log data
+    vars:
+      - name: paths
+        type: text
+        title: Paths
+        multi: true
+        required: true
+        show_user: true
+        default:
+          - /var/log/*.log

internal/validation/testdata/source_package/docs/README.md

@@ -0,0 +1,3 @@
+# Source Package
+
+Minimal source-package fixture for ValidateSourceFromPath tests.

internal/validation/testdata/source_package/manifest.yml

@@ -0,0 +1,23 @@
+format_version: 3.6.0
+name: source_package
+title: Source Package
+description: Minimal source-package fixture for ValidateSourceFromPath tests.
+version: 0.0.1
+type: integration
+source:
+  license: "Apache-2.0"
+conditions:
+  kibana:
+    version: '^8.0.0 || ^9.0.0'
+policy_templates:
+  - name: events
+    title: Events logs
+    description: Collect events data
+    inputs:
+      - type: logfile
+        title: Collect events logs
+        description: Collecting events log data
+        multi: false
+owner:
+  github: elastic/foobar
+  type: community

internal/validation/validation.go

@@ -13,59 +13,94 @@ import (
 
 	"github.com/elastic/package-spec/v3/code/go/pkg/specerrors"
 	"github.com/elastic/package-spec/v3/code/go/pkg/validator"
+
+	"github.com/elastic/elastic-package/internal/logger"
 )
 
-func ValidateFromPath(rootPath string) error {
-	return validator.ValidateFromPath(rootPath)
+// ValidateSourceFromPath validates a package source tree — checked out from version
+// control, not yet built. Source-only artifacts (_dev/, .link files, external: ecs
+// references) are permitted. Validation errors are filtered against the package's
+// validation.yml config; the first return value is the remaining errors after filtering,
+// the second is the errors that were filtered out.
+func ValidateSourceFromPath(packageRoot string) (error, error) {
+	return validateFromPath(validator.SourceMode, packageRoot)
 }
 
-func ValidateFromZip(packagePath string) error {
-	return validator.ValidateFromZip(packagePath)
+// ValidateBuiltFromPath validates a built (unzipped) package directory. Source-only
+// artifacts (_dev/, .link files, external: ecs references) are rejected. Validation
+// errors are filtered against the package's validation.yml config; the first return
+// value is the remaining errors after filtering, the second is the errors that were
+// filtered out.
+func ValidateBuiltFromPath(packageRoot string) (error, error) {
+	return validateFromPath(validator.BuildMode, packageRoot)
 }
 
-func ValidateAndFilterFromPath(packageRoot string) (error, error) {
-	allErrors := validator.ValidateFromPath(packageRoot)
+func validateFromPath(mode validator.Mode, packageRoot string) (error, error) {
+	v, err := validator.New(mode)
+	if err != nil {
+		return fmt.Errorf("failed to create validator: %w", err), nil
+	}
+	allErrors := v.ValidateFromPath(packageRoot)
 	if allErrors == nil {
 		return nil, nil
 	}
-
 	fsys := os.DirFS(packageRoot)
 	result, err := filterErrors(allErrors, fsys)
 	if err != nil {
-		return err, nil
+		logger.Debugf("failed to filter validation errors: %v", err)
+		return allErrors, nil
 	}
 	return result.Processed, result.Removed
 }
 
-func ValidateAndFilterFromZip(zipPackagePath string) (error, error) {
-	allErrors := validator.ValidateFromZip(zipPackagePath)
+// ValidateBuiltFromZip validates a built package zip archive. Zip files are always
+// treated as built artifacts; source-only artifacts are rejected. Validation errors
+// are filtered against the package's validation.yml config; the first return value
+// is the remaining errors after filtering, the second is the errors that were
+// filtered out.
+func ValidateBuiltFromZip(zipPackagePath string) (error, error) {
+	v, err := validator.New(validator.BuildMode)
+	if err != nil {
+		return fmt.Errorf("failed to create validator: %w", err), nil
+	}
+
+	allErrors := v.ValidateFromZip(zipPackagePath)
 	if allErrors == nil {
 		return nil, nil
 	}
-
+	// Open a separate, independent zip reader for filterErrors.
 	fsys, err := zip.OpenReader(zipPackagePath)
 	if err != nil {
-		return fmt.Errorf("failed to open zip file (%s): %w", zipPackagePath, err), nil
+		logger.Debugf("failed to open zip for filter: %v", err)
+		return allErrors, nil
 	}
 	defer fsys.Close()
-
+	// fsFromPackageZip navigates into the single package subdirectory so that
+	// filterErrors can locate validation.yml at the package root, not the zip root.
 	fsZip, err := fsFromPackageZip(fsys)
 	if err != nil {
-		return fmt.Errorf("failed to extract filesystem from zip file (%s): %w", zipPackagePath, err), nil
+		logger.Debugf("failed to extract filesystem from zip for filter: %v", err)
+		return allErrors, nil
 	}
-
 	result, err := filterErrors(allErrors, fsZip)
 	if err != nil {
-		return err, nil
+		logger.Debugf("failed to filter validation errors: %v", err)
+		return allErrors, nil
 	}
 	return result.Processed, result.Removed
 }
 
 func fsFromPackageZip(fsys fs.FS) (fs.FS, error) {
-	dirs, err := fs.ReadDir(fsys, ".")
+	entries, err := fs.ReadDir(fsys, ".")
 	if err != nil {
 		return nil, fmt.Errorf("failed to read root directory in zip file fs: %w", err)
 	}
+	var dirs []fs.DirEntry
+	for _, e := range entries {
+		if e.IsDir() {
+			dirs = append(dirs, e)
+		}
+	}
 	if len(dirs) != 1 {
 		return nil, fmt.Errorf("a single directory is expected in zip file, %d found", len(dirs))
 	}
@@ -77,6 +112,7 @@ func fsFromPackageZip(fsys fs.FS) (fs.FS, error) {
 	return subDir, nil
 }
 
+// TODO: follow-up issue — move this logic into specerrors as an exported function so consumers don't reimplement it.
 func filterErrors(allErrors error, fsys fs.FS) (specerrors.FilterResult, error) {
 	var errs specerrors.ValidationErrors
 	if !errors.As(allErrors, &errs) {