Remove plugins from the Devfile schema (#333)

* Remove plugins from devfile schema by... - adding an option in the jsonschema generator to allow skipping Plugin union members - setting this option to true on the Devfile jsonschema annotation. Signed-off-by: David Festal <dfestal@redhat.com> * Run the fixed generator ... ... to generate devfile schemas without `plugin` components in both the devfile main body and parent overrides Signed-off-by: David Festal <dfestal@redhat.com> * Update samples and tests for removing plugin Signed-off-by: Maysun J Faisal <maysunaneek@gmail.com> Co-authored-by: Maysun J Faisal <maysunaneek@gmail.com>
devfile · Apr 8, 2021 · a313872 · a313872
1 parent 1f33556
commit a313872
Show file tree

Hide file tree

Showing 21 changed files with 17 additions and 2,823 deletions.
diff --git a/generator/schemas/gen.go b/generator/schemas/gen.go
@@ -35,9 +35,12 @@ import (
 // GenerateJSONSchema drives whether a Json schema should be generated from this GO Struct type
 type GenerateJSONSchema struct {
 
-	// OmitCustomUnionMembers indicates that the Json schema gnerated from this type should omit Custom union members.
+	// OmitCustomUnionMembers indicates that the Json schema generated from this type should omit Custom union members.
 	OmitCustomUnionMembers bool `marker:",optional"`
 
+	// OmitPluginUnionMembers indicates that the Json schema generated from this type should omit Plugin component union members.
+	OmitPluginUnionMembers bool `marker:",optional"`
+
 	// Title indicates the content ot the Json Schema `title` attribute
 	Title string `marker:",optional"`
 }
@@ -213,6 +216,9 @@ This is not the case in the "%s' API group:
 			if schemaGenerateMarker.OmitCustomUnionMembers {
 				fieldsToSkip = append(fieldsToSkip, "Custom")
 			}
+			if schemaGenerateMarker.OmitPluginUnionMembers {
+				fieldsToSkip = append(fieldsToSkip, "Plugin")
+			}
 
 			genutils.AddUnionOneOfConstraints(&currentJSONSchema, toDo.unionDiscriminators, true, fieldsToSkip...)
 

diff --git a/generator/schemas/zz_generated.markerhelp.go b/generator/schemas/zz_generated.markerhelp.go
diff --git a/pkg/apis/workspaces/v1alpha2/devfile.go b/pkg/apis/workspaces/v1alpha2/devfile.go
@@ -6,7 +6,7 @@ import (
 
 // Devfile describes the structure of a cloud-native devworkspace and development environment.
 // +k8s:deepcopy-gen=false
-// +devfile:jsonschema:generate:omitCustomUnionMembers=true
+// +devfile:jsonschema:generate:omitCustomUnionMembers=true,omitPluginUnionMembers=true
 type Devfile struct {
 	devfile.DevfileHeader `json:",inline"`
 

diff --git a/samples/devfiles/job-apply-example.devfile.yaml b/samples/devfiles/job-apply-example.devfile.yaml
@@ -19,12 +19,6 @@ components:
                 command: ["some",  "command", "with", "parameters"]
               restartPolicy: Never
           backoffLimit: 4
-  - name: go-support
-    plugin:
-      id: ms-vscode/go/latest
-  - name: editor
-    plugin:
-      id: eclipse/che-theia/latest
 commands:
   - id: cleanup-job
     apply:

diff --git a/samples/devfiles/nodejs-stack.devfile.yaml b/samples/devfiles/nodejs-stack.devfile.yaml
@@ -7,19 +7,6 @@ projects:
       remotes:
         origin: "https://github.com/che-samples/web-nodejs-sample.git"
 components:
-  - name: editor
-    plugin:
-      id: eclipse/che-theia/7.1.0
-  - name: terminal
-    plugin:
-      id: eclipse/che-machine-exec-plugin/7.1.0
-  - name: typescript-plugin
-    plugin:
-      id: che-incubator/typescript/1.30.2
-      components:
-        - name: "somename"
-          container:
-            memoryLimit: 512Mi
   - name: nodejs
     container:
       image: quay.io/eclipse/che-nodejs10-ubi:nightly

diff --git a/samples/devfiles/sample-devfile.yaml b/samples/devfiles/sample-devfile.yaml
@@ -11,20 +11,6 @@ projects:
         revision: "main"
         remote: origin
 components:
-  - name: editor
-    attributes:
-      kjkh: "128M"
-      kjhkjh:
-        "": ""
-    plugin:
-      id: eclipse/che-theia/latest
-  - name: "ownplugin"
-    plugin:
-      id: acme/newPlugin/latest
-      registryUrl: "https://acme.com/registry/"
-  - name: "myplugin"
-    plugin:
-      uri: "https://github.com/johndoe/che-plugins/blob/master/cool-plugin/0.0.1/meta.yaml"
   - name: "mycontainer"
     container:
       image: "busybox"

diff --git a/samples/devfiles/simple-devfile.yaml b/samples/devfiles/simple-devfile.yaml
@@ -34,16 +34,6 @@ events:
   postStart:
     - "build-schema-and-open-devfile"
 components:
-  - name: yaml-support
-    plugin:
-      id: redhat/vscode-yaml/latest
-  - name: go-support
-    plugin:
-      id: ms-vscode/go/latest
-  - name: editor
-    plugin:
-      id: eclipse/che-theia/latest
-      registryUrl: "external-registry-url"
   - name: "build-tools"
     container:
       image: some container image with required build tools

diff --git a/samples/devfiles/spring-boot-http-booster-devfile.yaml b/samples/devfiles/spring-boot-http-booster-devfile.yaml
@@ -11,20 +11,7 @@ projects:
       checkoutFrom:
         revision: master
 components:
-  - name: java-support
-    plugin:
-      id: redhat/java8/latest
-      components:
-        - name: vscode-java            
-          container:
-            memoryLimit: 2Gi
-        - name: m2
-          volume:
-            size: 2G
-  - name: dependency-analytics
-    plugin:
-      id: redhat/dependency-analytics/latest
-  - name: maven-tooling
+  - name: maven
     container:
       image: registry.redhat.io/codeready-workspaces/stacks-java-rhel8:2.1
       mountSources: true
@@ -45,6 +32,9 @@ components:
       volumeMounts:
         - name: m2
           path: /home/jboss/.m2
+  - name: m2
+    volume:
+      size: 2G
 commands:
   - id: build 
     exec: