Fill deprecated license field with the value of the new subscription …

…condition (#826) Add a compatibility layer to copy the new value into the old field.
elastic · Jul 19, 2022 · 2013a47 · 2013a47
1 parent b764e3b
commit 2013a47
Show file tree

Hide file tree

Showing 19 changed files with 77 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Add `elastic.subscription` condition to package index metadata, use this value for backwards compatibility with previous `license` field. [#826](https://github.com/elastic/package-registry/pull/826)
+
 ### Deprecated
 
 ### Known Issues

diff --git a/packages/package.go b/packages/package.go
@@ -122,7 +122,8 @@ type PolicyTemplate struct {
 }
 
 type Conditions struct {
-	Kibana *KibanaConditions `config:"kibana,omitempty" json:"kibana,omitempty" yaml:"kibana,omitempty"`
+	Kibana  *KibanaConditions  `config:"kibana,omitempty" json:"kibana,omitempty" yaml:"kibana,omitempty"`
+	Elastic *ElasticConditions `config:"elastic,omitempty" json:"elastic,omitempty" yaml"elastic,omitempty"`
 }
 
 // KibanaConditions defines conditions for Kibana (e.g. required version).
@@ -131,6 +132,11 @@ type KibanaConditions struct {
 	constraint *semver.Constraints
 }
 
+// ElasticConditions defines conditions related to Elastic subscriptions or partnerships.
+type ElasticConditions struct {
+	Subscription string `config:"subscription" json:"subscription" yaml:"subscription"`
+}
+
 type Version struct {
 	Min string `config:"min,omitempty" json:"min,omitempty"`
 	Max string `config:"max,omitempty" json:"max,omitempty"`
@@ -251,7 +257,12 @@ func NewPackage(basePath string, fsBuilder FileSystemBuilder) (*Package, error)
 
 	// If not license is set, basic is assumed
 	if p.License == "" {
-		p.License = DefaultLicense
+		// Keep compatibility with deprecated license field.
+		if p.Conditions != nil && p.Conditions.Elastic != nil && p.Conditions.Elastic.Subscription != "" {
+			p.License = p.Conditions.Elastic.Subscription
+		} else {
+			p.License = DefaultLicense
+		}
 	}
 
 	err = p.setRuntimeFields()

diff --git a/packages/testdata/marshaler/packages.json b/packages/testdata/marshaler/packages.json
@@ -806,6 +806,9 @@
    "conditions": {
     "kibana": {
      "version": "^7.16.0 || ^8.0.0"
+    },
+    "elastic": {
+     "subscription": "gold"
     }
    },
    "owner": {
@@ -818,7 +821,7 @@
    ],
    "format_version": "1.0.0",
    "readme": "/package/example/1.2.0-rc1/docs/README.md",
-   "license": "basic",
+   "license": "gold",
    "screenshots": [
     {
      "src": "/img/kibana-envoyproxy.jpg",
@@ -1544,6 +1547,9 @@
    "conditions": {
     "kibana": {
      "version": "\u003e6.7.0"
+    },
+    "elastic": {
+     "subscription": "gold"
     }
    },
    "categories": [
@@ -1552,7 +1558,7 @@
    ],
    "format_version": "1.0.0",
    "readme": "/package/longdocs/1.0.4/docs/README.md",
-   "license": "basic",
+   "license": "gold",
    "assets": [
     "/package/longdocs/1.0.4/manifest.yml",
     "/package/longdocs/1.0.4/docs/README.md",

diff --git a/testdata/generated/package/example/1.2.0-rc1/index.json b/testdata/generated/package/example/1.2.0-rc1/index.json
@@ -10,6 +10,9 @@
   "conditions": {
     "kibana": {
       "version": "^7.16.0 || ^8.0.0"
+    },
+    "elastic": {
+      "subscription": "gold"
     }
   },
   "owner": {
@@ -22,7 +25,7 @@
   ],
   "format_version": "1.0.0",
   "readme": "/package/example/1.2.0-rc1/docs/README.md",
-  "license": "basic",
+  "license": "gold",
   "screenshots": [
     {
       "src": "/img/kibana-envoyproxy.jpg",

diff --git a/testdata/generated/package/longdocs/1.0.4/index.json b/testdata/generated/package/longdocs/1.0.4/index.json
@@ -17,6 +17,9 @@
   "conditions": {
     "kibana": {
       "version": ">6.7.0"
+    },
+    "elastic": {
+      "subscription": "gold"
     }
   },
   "categories": [
@@ -25,7 +28,7 @@
   ],
   "format_version": "1.0.0",
   "readme": "/package/longdocs/1.0.4/docs/README.md",
-  "license": "basic",
+  "license": "gold",
   "assets": [
     "/package/longdocs/1.0.4/manifest.yml",
     "/package/longdocs/1.0.4/docs/README.md",

diff --git a/testdata/generated/search-all.json b/testdata/generated/search-all.json
@@ -267,6 +267,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-category-custom.json b/testdata/generated/search-category-custom.json
@@ -171,6 +171,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-category-datastore-prerelease.json b/testdata/generated/search-category-datastore-prerelease.json
@@ -59,6 +59,9 @@
     "conditions": {
       "kibana": {
         "version": "^7.16.0 || ^8.0.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "owner": {

diff --git a/testdata/generated/search-category-datastore.json b/testdata/generated/search-category-datastore.json
@@ -59,6 +59,9 @@
     "conditions": {
       "kibana": {
         "version": "^7.16.0 || ^8.0.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "owner": {

diff --git a/testdata/generated/search-category-web-all.json b/testdata/generated/search-category-web-all.json
@@ -18,6 +18,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-category-web.json b/testdata/generated/search-category-web.json
@@ -18,6 +18,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-kibana721.json b/testdata/generated/search-kibana721.json
@@ -124,6 +124,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-kibana800.json b/testdata/generated/search-kibana800.json
@@ -167,6 +167,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-package-experimental.json b/testdata/generated/search-package-experimental.json
@@ -164,6 +164,9 @@
     "conditions": {
       "kibana": {
         "version": "^7.16.0 || ^8.0.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "owner": {
@@ -356,6 +359,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-package-internal.json b/testdata/generated/search-package-internal.json
@@ -203,6 +203,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search-package-prerelease.json b/testdata/generated/search-package-prerelease.json
@@ -164,6 +164,9 @@
     "conditions": {
       "kibana": {
         "version": "^7.16.0 || ^8.0.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "owner": {
@@ -356,6 +359,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/generated/search.json b/testdata/generated/search.json
@@ -203,6 +203,9 @@
     "conditions": {
       "kibana": {
         "version": ">6.7.0"
+      },
+      "elastic": {
+        "subscription": "gold"
       }
     },
     "categories": [

diff --git a/testdata/package/example/1.2.0-rc1/manifest.yml b/testdata/package/example/1.2.0-rc1/manifest.yml
@@ -13,6 +13,8 @@ owner.github: "ruflin"
 conditions:
   kibana:
     version: "^7.16.0 || ^8.0.0"
+  elastic:
+    subscription: "gold"
 
 screenshots:
   - src: /img/kibana-envoyproxy.jpg

diff --git a/testdata/package/longdocs/1.0.4/manifest.yml b/testdata/package/longdocs/1.0.4/manifest.yml
@@ -11,11 +11,12 @@ description: >
 version: 1.0.4
 categories: ["custom", "web"]
 release: ga
-license: basic
 
 conditions:
   kibana:
     version: ">6.7.0"
+  elastic:
+    subscription: "gold"
 
 icons:
 - src: "/img/icon.svg"