Add support to filter errors in packages based on codes #1467
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // 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" | ||
| "fmt" | ||
| "io/fs" | ||
| "os" | ||
|
|
||
| "github.com/elastic/package-spec/v2/code/go/pkg/specerrors" | ||
| "github.com/elastic/package-spec/v2/code/go/pkg/specerrors/processors" | ||
| "github.com/elastic/package-spec/v2/code/go/pkg/validator" | ||
|
|
||
| "github.com/elastic/elastic-package/internal/logger" | ||
| ) | ||
|
|
||
| const validationConfigPath = "validation.yml" | ||
|
|
||
| func ValidateFromPath(rootPath string) error { | ||
| return validator.ValidateFromPath(rootPath) | ||
| } | ||
|
|
||
| func ValidateFromZip(packagePath string) error { | ||
| return validator.ValidateFromPath(packagePath) | ||
mrodm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| func ValidateAndFilterFromPath(rootPath string) (error, error) { | ||
| allErrors := validator.ValidateFromPath(rootPath) | ||
| if allErrors == nil { | ||
| return nil, nil | ||
| } | ||
|
|
||
| fsys := os.DirFS(rootPath) | ||
| errors, skipped, err := filterErrors(allErrors, fsys, validationConfigPath) | ||
| if err != nil { | ||
| return err, nil | ||
| } | ||
| return errors, skipped | ||
| } | ||
|
|
||
| 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 | ||
| } | ||
|
|
||
| errors, skipped, err := filterErrors(allErrors, fsZip, validationConfigPath) | ||
| if err != nil { | ||
| return err, nil | ||
| } | ||
| return errors, skipped | ||
| } | ||
|
|
||
| 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, configPath string) (error, error, error) { | ||
| errs, ok := allErrors.(specerrors.ValidationErrors) | ||
| if !ok { | ||
| return allErrors, nil, nil | ||
| } | ||
|
|
||
| _, err := fs.Stat(fsys, configPath) | ||
| if err != nil { | ||
| logger.Debugf("file not found: %s", configPath) | ||
| return allErrors, nil, nil | ||
| } | ||
|
|
||
| config, err := processors.LoadConfigFilter(fsys, configPath) | ||
|
There was a problem hiding this comment. I still see this "processors" name as a too generic name, specially when used externally, but lets continue with it. There was a problem hiding this comment. Just changed all the code in processors to be in the same |
||
| if err != nil { | ||
| return nil, nil, fmt.Errorf("failed to read config filter: %w", err) | ||
| } | ||
|
|
||
| filter := processors.NewFilter(config) | ||
|
|
||
| filteredErrors, skippedErrors, err := filter.Run(errs) | ||
| if err != nil { | ||
| return nil, nil, fmt.Errorf("failed to filter errors: %w", err) | ||
| } | ||
| return filteredErrors, skippedErrors, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we log these at the warning level instead?