Switch for disabling validation

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Package validation is disabled by default. [#667] (https://github.com/elastic/package-registry/pull/667)
+
 ### Deprecated
 
 ### Known Issues

main.go

@@ -46,6 +46,7 @@ func init() {
 	flag.StringVar(&address, "address", "localhost:8080", "Address of the package-registry service.")
 	// This flag is experimental and might be removed in the future or renamed
 	flag.BoolVar(&dryRun, "dry-run", false, "Runs a dry-run of the registry without starting the web service (experimental)")
+	flag.BoolVar(&util.EnablePackageValidation, "validate", false, "Validate package content")
 }
 
 type Config struct {
@@ -61,6 +62,10 @@ func main() {
 	log.Println("Package registry started.")
 	defer log.Println("Package registry stopped.")
 
+	if dryRun {
+		util.EnablePackageValidation = true // dry-run enables the package validation
+	}
+
 	config := mustLoadConfig()
 	packagesBasePaths := getPackagesBasePaths(config)
 	ensurePackagesAvailable(packagesBasePaths)

util/data_stream.go

@@ -151,22 +151,11 @@ func NewDataStream(basePath string, p *Package) (*DataStream, error) {
 	if !IsValidRelease(d.Release) {
 		return nil, fmt.Errorf("invalid release: %s", d.Release)
 	}
-	return d, nil
-}
 
-func (d *DataStream) Validate() error {
 	pipelineDir := filepath.Join(d.BasePath, "elasticsearch", DirIngestPipeline)
 	paths, err := filepath.Glob(filepath.Join(pipelineDir, "*"))
 	if err != nil {
-		return err
-	}
-
-	if strings.Contains(d.Dataset, "-") {
-		return fmt.Errorf("data stream name is not allowed to contain `-`: %s", d.Dataset)
-	}
-
-	if !d.validType() {
-		return fmt.Errorf("type is not valid: %s", d.Type)
+		return nil, err
 	}
 
 	if d.Elasticsearch != nil && d.Elasticsearch.IngestPipelineName == "" {
@@ -189,9 +178,25 @@ func (d *DataStream) Validate() error {
 			}
 		}
 	}
-
 	if d.IngestPipeline == "" && len(paths) > 0 {
-		return fmt.Errorf("unused pipelines in the package (dataset: %s): %s", d.Dataset, strings.Join(paths, ","))
+		return nil, fmt.Errorf("unused pipelines in the package (dataset: %s): %s", d.Dataset, strings.Join(paths, ","))
+	}
+	return d, nil
+}
+
+func (d *DataStream) Validate() error {
+	if !EnablePackageValidation {
+		return nil
+	}
+
+	pipelineDir := filepath.Join(d.BasePath, "elasticsearch", DirIngestPipeline)
+
+	if strings.Contains(d.Dataset, "-") {
+		return fmt.Errorf("data stream name is not allowed to contain `-`: %s", d.Dataset)
+	}
+
+	if !d.validType() {
+		return fmt.Errorf("type is not valid: %s", d.Type)
 	}
 
 	// In case an ingest pipeline is set, check if it is around
@@ -204,7 +209,7 @@ func (d *DataStream) Validate() error {
 			return errors.Wrapf(errJSON, "stat ingest pipeline JSON file failed (path: %s)", jsonPipelinePath)
 		}
 		if !os.IsNotExist(errJSON) {
-			err = validateIngestPipelineFile(jsonPipelinePath)
+			err := validateIngestPipelineFile(jsonPipelinePath)
 			if err != nil {
 				return errors.Wrapf(err, "validating ingest pipeline JSON file failed (path: %s)", jsonPipelinePath)
 			}
@@ -217,7 +222,7 @@ func (d *DataStream) Validate() error {
 			return errors.Wrapf(errYAML, "stat ingest pipeline YAML file failed (path: %s)", jsonPipelinePath)
 		}
 		if !os.IsNotExist(errYAML) {
-			err = validateIngestPipelineFile(yamlPipelinePath)
+			err := validateIngestPipelineFile(yamlPipelinePath)
 			if err != nil {
 				return errors.Wrapf(err, "validating ingest pipeline YAML file failed (path: %s)", jsonPipelinePath)
 			}
@@ -229,7 +234,7 @@ func (d *DataStream) Validate() error {
 		}
 	}
 
-	err = d.validateRequiredFields()
+	err := d.validateRequiredFields()
 	if err != nil {
 		return errors.Wrap(err, "validating required fields failed")
 	}

util/package.go

@@ -168,6 +168,11 @@ func NewPackage(basePath string) (*Package, error) {
 		p.License = DefaultLicense
 	}
 
+	p.versionSemVer, err = semver.StrictNewVersion(p.Version)
+	if err != nil {
+		return nil, errors.Wrap(err, "invalid package version")
+	}
+
 	if p.Icons != nil {
 		for k, i := range p.Icons {
 			p.Icons[k].Path = i.getPath(p)
@@ -308,6 +313,10 @@ func collectAssets(pattern string) ([]string, error) {
 // Validate is called during Unpack of the manifest.
 // The validation here is only related to the fields directly specified in the manifest itself.
 func (p *Package) Validate() error {
+	if !EnablePackageValidation {
+		return nil
+	}
+
 	if p.FormatVersion == "" {
 		return fmt.Errorf("no format_version set: %v", p)
 	}
@@ -336,11 +345,6 @@ func (p *Package) Validate() error {
 		}
 	}
 
-	p.versionSemVer, err = semver.StrictNewVersion(p.Version)
-	if err != nil {
-		return errors.Wrap(err, "invalid package version")
-	}
-
 	for _, i := range p.Icons {
 		_, err := os.Stat(filepath.Join(p.BasePath, i.Src))
 		if err != nil {

util/package_test.go

@@ -112,6 +112,7 @@ var packageTests = []struct {
 }
 
 func TestValidate(t *testing.T) {
+	EnablePackageValidation = true
 	for _, tt := range packageTests {
 		t.Run(tt.description, func(t *testing.T) {
 			err := tt.p.Validate()

util/packages.go

@@ -13,6 +13,10 @@ import (
 	"github.com/pkg/errors"
 )
 
+// EnablePackageValidation is a flag which can enable package content validation (package, data streams, assets, etc.).
+// As the validation is relatively heavy process, it's disabled in runtime by default.
+var EnablePackageValidation bool
+
 var packageList Packages
 
 type Packages []Package