Add support to filter errors in packages based on codes (#1467)

Add support to filter errores in packages based on the codes
available in package-spec. These codes are defined in a new file
"validation.yml" that should be present at the root of the package.
A new test package has been added with this new file to check
that errors are filtered.

Author: mrodm

cmd/lint.go

@@ -10,11 +10,11 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/elastic/package-spec/v2/code/go/pkg/validator"
-
 	"github.com/elastic/elastic-package/internal/cobraext"
 	"github.com/elastic/elastic-package/internal/docs"
+	"github.com/elastic/elastic-package/internal/logger"
 	"github.com/elastic/elastic-package/internal/packages"
+	"github.com/elastic/elastic-package/internal/validation"
 )
 
 const lintLongDescription = `Use this command to validate the contents of a package using the package specification (see: https://github.com/elastic/package-spec).
@@ -69,10 +69,12 @@ func validateSourceCommandAction(cmd *cobra.Command, args []string) error {
 	if err != nil {
 		return fmt.Errorf("locating package root failed: %w", err)
 	}
-	err = validator.ValidateFromPath(packageRootPath)
-	if err != nil {
-		return fmt.Errorf("linting package failed: %w", err)
+	errs, skipped := validation.ValidateAndFilterFromPath(packageRootPath)
+	if skipped != nil {
+		logger.Infof("Skipped errors: %v", skipped)
+	}
+	if errs != nil {
+		return fmt.Errorf("linting package failed: %w", errs)
 	}
-
 	return nil
 }

docs/howto/filter_errors.md

@@ -0,0 +1,45 @@
+# HOWTO: Filter errors based on Validation Codes
+
+## Introduction
+
+Starting with package-spec 2.13.0, there is an option to filter some errors based on their validation codes.
+
+These validation codes are defined in package-spec [here][package-spec-code-errors].
+
+## How to filter specific errors
+
+Since package-spec 2.13.0, it's allowed to define a new file in the root of the package `validation.yml`.
+In this file, the errors to be filtered  will be configured following this syntax:
+
+```yaml
+errors:
+  exclude_checks:
+    - code1
+    - code2
+```
+
+`exclude_checks` key accepts a list of codes so more than one kind of error can be filtered.
+
+
+The code errors available to use in this configuration can be checked [here][package-spec-code-errors].
+The codes can be also checked in the error message itself shown by elastic-package. If the error is allowed
+to be filtered, it will have at the end of the message the code in parenthesis.
+
+For instance, in this example the error code is `SVR00002`:
+
+```
+[2023-09-28T19:10:19.758Z] Error: checking package failed: linting package failed: found 1 validation error:
+[2023-09-28T19:10:19.758Z]    1. file "/var/lib/jenkins/workspace/est-manager_integrations_PR-8012/src/github.com/elastic/integrations/packages/o365/kibana/dashboard/o365-712e2c00-685d-11ea-8d6a-292ef5d68366.json" is invalid: expected filter in dashboard: no filter found (SVR00002)
+```
+
+
+For that specific error, if it is needed to be filtered, then the configuration file `validation.yml` should be like:
+```yaml
+errors:
+  exclude_checks:
+    - SVR00002
+```
+
+
+[package-spec-code-errors]: https://github.com/elastic/package-spec/blob/49120aea627a1652823a7f344ba3d1c9b029fd5a/code/go/pkg/specerrors/constants.go
+

internal/builder/packages.go

@@ -12,12 +12,11 @@ import (
 
 	"github.com/magefile/mage/sh"
 
-	"github.com/elastic/package-spec/v2/code/go/pkg/validator"
-
 	"github.com/elastic/elastic-package/internal/environment"
 	"github.com/elastic/elastic-package/internal/files"
 	"github.com/elastic/elastic-package/internal/logger"
 	"github.com/elastic/elastic-package/internal/packages"
+	"github.com/elastic/elastic-package/internal/validation"
 )
 
 const builtPackagesFolder = "packages"
@@ -195,9 +194,12 @@ func BuildPackage(options BuildOptions) (string, error) {
 	}
 
 	logger.Debugf("Validating built package (path: %s)", destinationDir)
-	err = validator.ValidateFromPath(destinationDir)
-	if err != nil {
-		return "", fmt.Errorf("invalid content found in built package: %w", err)
+	errs, skipped := validation.ValidateAndFilterFromPath(destinationDir)
+	if skipped != nil {
+		logger.Infof("Skipped errors: %v", skipped)
+	}
+	if errs != nil {
+		return "", fmt.Errorf("invalid content found in built package: %w", errs)
 	}
 	return destinationDir, nil
 }
@@ -218,9 +220,12 @@ func buildZippedPackage(options BuildOptions, destinationDir string) (string, er
 		logger.Debug("Skip validation of the built .zip package")
 	} else {
 		logger.Debugf("Validating built .zip package (path: %s)", zippedPackagePath)
-		err = validator.ValidateFromZip(zippedPackagePath)
-		if err != nil {
-			return "", fmt.Errorf("invalid content found in built zip package: %w", err)
+		errs, skipped := validation.ValidateAndFilterFromZip(zippedPackagePath)
+		if skipped != nil {
+			logger.Infof("Skipped errors: %v", skipped)
+		}
+		if errs != nil {
+			return "", fmt.Errorf("invalid content found in built zip package: %w", errs)
 		}
 	}
 

internal/packages/archetype/package_test.go

@@ -9,11 +9,10 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/elastic/package-spec/v2/code/go/pkg/validator"
-
 	"github.com/stretchr/testify/require"
 
 	"github.com/elastic/elastic-package/internal/packages"
+	"github.com/elastic/elastic-package/internal/validation"
 )
 
 func TestPackage(t *testing.T) {
@@ -83,7 +82,7 @@ func createPackageDescriptorForTest(packageType, kibanaVersion string) PackageDe
 }
 
 func checkPackage(packageRoot string) error {
-	err := validator.ValidateFromPath(packageRoot)
+	err := validation.ValidateFromPath(packageRoot)
 	if err != nil {
 		return fmt.Errorf("linting package failed: %w", err)
 	}

internal/packages/installer/factory.go

@@ -10,12 +10,11 @@ import (
 
 	"github.com/Masterminds/semver/v3"
 
-	"github.com/elastic/package-spec/v2/code/go/pkg/validator"
-
 	"github.com/elastic/elastic-package/internal/builder"
 	"github.com/elastic/elastic-package/internal/kibana"
 	"github.com/elastic/elastic-package/internal/logger"
 	"github.com/elastic/elastic-package/internal/packages"
+	"github.com/elastic/elastic-package/internal/validation"
 )
 
 var semver8_7_0 = semver.MustParse("8.7.0")
@@ -61,9 +60,12 @@ func NewForPackage(options Options) (Installer, error) {
 		}
 		if !options.SkipValidation {
 			logger.Debugf("Validating built .zip package (path: %s)", options.ZipPath)
-			err := validator.ValidateFromZip(options.ZipPath)
-			if err != nil {
-				return nil, fmt.Errorf("invalid content found in built zip package: %w", err)
+			errs, skipped := validation.ValidateAndFilterFromZip(options.ZipPath)
+			if skipped != nil {
+				logger.Infof("Skipped errors: %v", skipped)
+			}
+			if errs != nil {
+				return nil, fmt.Errorf("invalid content found in built zip package: %w", errs)
 			}
 		}
 		logger.Debug("Skip validation of the built .zip package")

internal/validation/validation.go

@@ -0,0 +1,107 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License;
+// you may not use this file except in compliance with the Elastic License.
+
+package validation
+
+import (
+	"archive/zip"
+	"errors"
+	"fmt"
+	"io/fs"
+	"os"
+
+	"github.com/elastic/package-spec/v2/code/go/pkg/specerrors"
+	"github.com/elastic/package-spec/v2/code/go/pkg/validator"
+)
+
+func ValidateFromPath(rootPath string) error {
+	return validator.ValidateFromPath(rootPath)
+}
+
+func ValidateFromZip(packagePath string) error {
+	return validator.ValidateFromZip(packagePath)
+}
+
+func ValidateAndFilterFromPath(rootPath string) (error, error) {
+	allErrors := validator.ValidateFromPath(rootPath)
+	if allErrors == nil {
+		return nil, nil
+	}
+
+	fsys := os.DirFS(rootPath)
+	result, err := filterErrors(allErrors, fsys)
+	if err != nil {
+		return err, nil
+	}
+	return result.Processed, result.Removed
+}
+
+func ValidateAndFilterFromZip(packagePath string) (error, error) {
+	allErrors := validator.ValidateFromZip(packagePath)
+	if allErrors == nil {
+		return nil, nil
+	}
+
+	fsys, err := zip.OpenReader(packagePath)
+	if err != nil {
+		return fmt.Errorf("failed to open zip file (%s): %w", packagePath, err), nil
+	}
+	defer fsys.Close()
+
+	fsZip, err := fsFromPackageZip(fsys)
+	if err != nil {
+		return fmt.Errorf("failed to extract filesystem from zip file (%s): %w", packagePath, err), nil
+	}
+
+	result, err := filterErrors(allErrors, fsZip)
+	if err != nil {
+		return err, nil
+	}
+	return result.Processed, result.Removed
+}
+
+func fsFromPackageZip(fsys fs.FS) (fs.FS, error) {
+	dirs, err := fs.ReadDir(fsys, ".")
+	if err != nil {
+		return nil, fmt.Errorf("failed to read root directory in zip file fs: %w", err)
+	}
+	if len(dirs) != 1 {
+		return nil, fmt.Errorf("a single directory is expected in zip file, %d found", len(dirs))
+	}
+
+	subDir, err := fs.Sub(fsys, dirs[0].Name())
+	if err != nil {
+		return nil, err
+	}
+	return subDir, nil
+}
+
+func filterErrors(allErrors error, fsys fs.FS) (specerrors.FilterResult, error) {
+	errs, ok := allErrors.(specerrors.ValidationErrors)
+	if !ok {
+		return specerrors.FilterResult{Processed: allErrors, Removed: nil}, nil
+	}
+
+	config, err := specerrors.LoadConfigFilter(fsys)
+	if err != nil && errors.Is(err, fs.ErrNotExist) {
+		return specerrors.FilterResult{Processed: allErrors, Removed: nil}, nil
+	}
+	if err != nil {
+		return specerrors.FilterResult{Processed: allErrors, Removed: nil},
+			fmt.Errorf("failed to read config filter: %w", err)
+	}
+	if config == nil {
+		return specerrors.FilterResult{Processed: allErrors, Removed: nil}, nil
+	}
+
+	filter := specerrors.NewFilter(config)
+
+	result, err := filter.Run(errs)
+	if err != nil {
+		return specerrors.FilterResult{Processed: allErrors, Removed: nil},
+			fmt.Errorf("failed to filter errors: %w", err)
+	}
+	return result, nil
+
+}

test/packages/other/invalid_spec_filtered/LICENSE.txt

@@ -0,0 +1,93 @@
+Elastic License 2.0
+
+URL: https://www.elastic.co/licensing/elastic-license
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+*As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim.*
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

test/packages/other/invalid_spec_filtered/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 # FIXME Replace with the real PR link