Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

new fields autobuild and deploybydefault for image components and kubernetes/openshift components #127

Merged
merged 3 commits into from
Jan 5, 2022
Merged

new fields autobuild and deploybydefault for image components and kubernetes/openshift components #127

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6385074
pull latest schema
yangcao77 Dec 20, 2021
f276a01
add setdefault test
yangcao77 Dec 21, 2021
70a6e35
pull latest schema change
yangcao77 Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module github.com/devfile/library
go 1.15

require (
github.com/devfile/api/v2 v2.0.0-20211118170330-959f3c8007c3
github.com/devfile/api/v2 v2.0.0-20211221202911-64979f3d994e
github.com/fatih/color v1.7.0
github.com/gobwas/glob v0.2.3
github.com/golang/mock v1.5.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/devfile/api/v2 v2.0.0-20211118170330-959f3c8007c3 h1:G7TIrgpGx5lcZ3X7bpQeVCeeeO7tv6SAzPPvB9ThHXE=
github.com/devfile/api/v2 v2.0.0-20211118170330-959f3c8007c3/go.mod h1:d99eTN6QxgzihOOFyOZA+VpUyD4Q1pYRYHZ/ci9J96Q=
github.com/devfile/api/v2 v2.0.0-20211221202911-64979f3d994e h1:+wtI5Pq9i58h1xUtQZxFV0Um1Y3l3euck6nhdXO6zik=
github.com/devfile/api/v2 v2.0.0-20211221202911-64979f3d994e/go.mod h1:d99eTN6QxgzihOOFyOZA+VpUyD4Q1pYRYHZ/ci9J96Q=
github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no=
github.com/docker/spdystream v0.0.0-20160310174837-449fdfce4d96/go.mod h1:Qh8CwZgvJUkLughtfhJv5dyTYa91l1fOUCrgjqmcifM=
Expand Down
33 changes: 31 additions & 2 deletions pkg/devfile/parser/data/v2/2.2.0/devfileJsonSchema220.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const JsonSchema220 = `{
],
"properties": {
"apply": {
"description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an 'apply' command is bound to a 'preStart' event, and references a 'container' component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its 'dedicatedPod' field set to 'true'.\n\nWhen no 'apply' command exist for a given component, it is assumed the component will be applied at devworkspace start by default.",
"description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an 'apply' command is bound to a 'preStart' event, and references a 'container' component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its 'dedicatedPod' field set to 'true'.\n\nWhen no 'apply' command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless 'deployByDefault' for that component is set to false.",
"type": "object",
"required": [
"component"
Expand Down Expand Up @@ -457,6 +457,10 @@ const JsonSchema220 = `{
}
],
"properties": {
"autoBuild": {
"description": "Defines if the image should be built during startup Default is false",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Default is false should be a separate sentence. Can we update it to Default value is 'false' so it's consistent with other descriptions?

library/pkg/devfile/parser/data/v2/2.2.0/devfileJsonSchema220.go

Line 200 in f276a01

"description": "Whether the command is capable to reload itself when source code changes. If set to 'true' the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is 'false'",

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This requires api change, PR created: devfile/api#718
Can you help review and approve that PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'll review it

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated the PR with the latest schema which includes the description change

"type": "boolean"
},
"dockerfile": {
"description": "Allows specifying dockerfile type build",
"type": "object",
Expand Down Expand Up @@ -577,6 +581,10 @@ const JsonSchema220 = `{
}
],
"properties": {
"deployByDefault": {
"description": "Defines if the component should be deployed during startup Default is false",
"type": "boolean"
},
"endpoints": {
"type": "array",
"items": {
Expand Down Expand Up @@ -674,6 +682,10 @@ const JsonSchema220 = `{
}
],
"properties": {
"deployByDefault": {
"description": "Defines if the component should be deployed during startup Default is false",
"type": "boolean"
},
"endpoints": {
"type": "array",
"items": {
Expand Down Expand Up @@ -935,7 +947,7 @@ const JsonSchema220 = `{
],
"properties": {
"apply": {
"description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an 'apply' command is bound to a 'preStart' event, and references a 'container' component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its 'dedicatedPod' field set to 'true'.\n\nWhen no 'apply' command exist for a given component, it is assumed the component will be applied at devworkspace start by default.",
"description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an 'apply' command is bound to a 'preStart' event, and references a 'container' component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its 'dedicatedPod' field set to 'true'.\n\nWhen no 'apply' command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless 'deployByDefault' for that component is set to false.",
"type": "object",
"properties": {
"component": {
Expand Down Expand Up @@ -1320,9 +1332,18 @@ const JsonSchema220 = `{
"required": [
"dockerfile"
]
},
{
"required": [
"autoBuild"
]
}
],
"properties": {
"autoBuild": {
"description": "Defines if the image should be built during startup Default is false",
"type": "boolean"
},
"dockerfile": {
"description": "Allows specifying dockerfile type build",
"type": "object",
Expand Down Expand Up @@ -1437,6 +1458,10 @@ const JsonSchema220 = `{
}
],
"properties": {
"deployByDefault": {
"description": "Defines if the component should be deployed during startup Default is false",
"type": "boolean"
},
"endpoints": {
"type": "array",
"items": {
Expand Down Expand Up @@ -1531,6 +1556,10 @@ const JsonSchema220 = `{
}
],
"properties": {
"deployByDefault": {
"description": "Defines if the component should be deployed during startup Default is false",
"type": "boolean"
},
"endpoints": {
"type": "array",
"items": {
Expand Down
12 changes: 10 additions & 2 deletions pkg/devfile/parser/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -549,10 +549,16 @@ func setDefaults(d DevfileObj) (err error) {

} else if component.Kubernetes != nil {
endpoints = component.Kubernetes.Endpoints

if devfileVersion != string(data.APISchemaVersion200) && devfileVersion != string(data.APISchemaVersion210) {
val := component.Kubernetes.GetDeployByDefault()
component.Kubernetes.DeployByDefault = &val
}
} else if component.Openshift != nil {

endpoints = component.Openshift.Endpoints
if devfileVersion != string(data.APISchemaVersion200) && devfileVersion != string(data.APISchemaVersion210) {
val := component.Openshift.GetDeployByDefault()
component.Openshift.DeployByDefault = &val
}

} else if component.Volume != nil && devfileVersion != string(data.APISchemaVersion200) {
volume := component.Volume
Expand All @@ -565,6 +571,8 @@ func setDefaults(d DevfileObj) (err error) {
val := dockerImage.GetRootRequired()
dockerImage.RootRequired = &val
}
val := component.Image.GetAutoBuild()
component.Image.AutoBuild = &val
}

if endpoints != nil {
Expand Down
40 changes: 24 additions & 16 deletions pkg/devfile/parser/parse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(divRRTrue, nil),
testingutil.GetDockerImageTestComponent(divRRTrue, nil, nil),
},
Events: &v1.Events{
DevWorkspaceEvents: v1.DevWorkspaceEvents{
Expand Down Expand Up @@ -498,7 +498,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(divRRFalse, parentOverridesFromMainDevfile),
testingutil.GetDockerImageTestComponent(divRRFalse, nil, parentOverridesFromMainDevfile),
{
Name: "runtime",
ComponentUnion: v1.ComponentUnion{
Expand Down Expand Up @@ -736,7 +736,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
},
},
//no overrides so expected values are the same as the parent
testingutil.GetDockerImageTestComponent(divRRTrue, importFromUri1),
testingutil.GetDockerImageTestComponent(divRRTrue, nil, importFromUri1),
{
Name: "runtime",
ComponentUnion: v1.ComponentUnion{
Expand Down Expand Up @@ -1462,7 +1462,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(divRRFalse, nil),
testingutil.GetDockerImageTestComponent(divRRFalse, nil, nil),
},
Events: &v1.Events{
DevWorkspaceEvents: v1.DevWorkspaceEvents{
Expand Down Expand Up @@ -1600,7 +1600,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(divRRTrue, pluginOverridesFromMainDevfile),
testingutil.GetDockerImageTestComponent(divRRTrue, nil, pluginOverridesFromMainDevfile),
{
Name: "runtime",
ComponentUnion: v1.ComponentUnion{
Expand Down Expand Up @@ -3107,7 +3107,7 @@ func Test_parseParentFromRegistry(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(defaultDiv, nil),
testingutil.GetDockerImageTestComponent(defaultDiv, nil, nil),
},
},
},
Expand Down Expand Up @@ -3249,7 +3249,7 @@ func Test_parseParentFromRegistry(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(div, parentOverridesFromMainDevfile),
testingutil.GetDockerImageTestComponent(div, nil, parentOverridesFromMainDevfile),
{
Name: "runtime2",
ComponentUnion: v1.ComponentUnion{
Expand Down Expand Up @@ -3389,7 +3389,7 @@ func Test_parseParentFromRegistry(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(defaultDiv, importFromRegistry),
testingutil.GetDockerImageTestComponent(defaultDiv, nil, importFromRegistry),
{
Name: "runtime2",
ComponentUnion: v1.ComponentUnion{
Expand Down Expand Up @@ -3503,7 +3503,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(defaultDiv, nil),
testingutil.GetDockerImageTestComponent(defaultDiv, nil, nil),
},
},
}
Expand All @@ -3522,7 +3522,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(defaultDiv, nil),
testingutil.GetDockerImageTestComponent(defaultDiv, nil, nil),
},
},
}
Expand Down Expand Up @@ -3626,7 +3626,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(div, parentOverridesFromMainDevfile),
testingutil.GetDockerImageTestComponent(div, nil, parentOverridesFromMainDevfile),
{
Name: "runtime",
ComponentUnion: v1.ComponentUnion{
Expand Down Expand Up @@ -3719,7 +3719,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
},
},
},
testingutil.GetDockerImageTestComponent(defaultDiv, importFromKubeCRD),
testingutil.GetDockerImageTestComponent(defaultDiv, nil, importFromKubeCRD),
{
Name: "runtime",
ComponentUnion: v1.ComponentUnion{
Expand Down Expand Up @@ -4490,7 +4490,7 @@ func getUnsetBooleanDevfileTestData(apiVersion string) (devfileData data.Devfile
}

if apiVersion != string(data.APISchemaVersion200) && apiVersion != string(data.APISchemaVersion210) {
comp := []v1.Component{testingutil.GetDockerImageTestComponent(testingutil.DockerImageValues{}, nil)}
comp := []v1.Component{testingutil.GetDockerImageTestComponent(testingutil.DockerImageValues{}, nil, nil)}
err = devfileData.AddComponents(comp)
}

Expand All @@ -4510,12 +4510,14 @@ func getBooleanDevfileTestData(apiVersion string, setDefault bool) (devfileData
isDefault *bool
rootRequired *bool
ephemeral *bool
autoBuild *bool
deployByDefaul *bool
}

//default values according to spec
defaultBools := boolValues{&isFalse, &isFalse, &isFalse, &isFalse, &isTrue, &isFalse, &isFalse, &isFalse}
defaultBools := boolValues{&isFalse, &isFalse, &isFalse, &isFalse, &isTrue, &isFalse, &isFalse, &isFalse, &isFalse, &isFalse}
//set values will be a mix of default and inverse values
setBools := boolValues{&isTrue, &isTrue, &isFalse, &isTrue, &isFalse, &isFalse, &isTrue, &isFalse}
setBools := boolValues{&isTrue, &isTrue, &isFalse, &isTrue, &isFalse, &isFalse, &isTrue, &isFalse, &isTrue, &isFalse}

var values boolValues

Expand Down Expand Up @@ -4644,8 +4646,14 @@ func getBooleanDevfileTestData(apiVersion string, setDefault bool) (devfileData
}

if apiVersion != string(data.APISchemaVersion200) && apiVersion != string(data.APISchemaVersion210) {
comp := []v1.Component{testingutil.GetDockerImageTestComponent(testingutil.DockerImageValues{RootRequired: values.rootRequired}, nil)}
comp := []v1.Component{testingutil.GetDockerImageTestComponent(testingutil.DockerImageValues{RootRequired: values.rootRequired}, values.autoBuild, nil)}
err = devfileData.AddComponents(comp)

openshiftComponent, _ := devfileData.GetComponents(common.DevfileOptions{ComponentOptions: common.ComponentOptions{
ComponentType: v1.OpenshiftComponentType,
}})
openshiftComponent[0].Openshift.DeployByDefault = values.deployByDefaul

}

return devfileData, err
Expand Down
3 changes: 2 additions & 1 deletion pkg/testingutil/devfile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,15 @@ type DockerImageValues struct {

//GetDockerImageTestComponent returns a docker image component that is used for testing.
//The parameters allow customization of the content. If they are set to nil, then the properties will not be set
func GetDockerImageTestComponent(div DockerImageValues, attr attributes.Attributes) v1.Component {
func GetDockerImageTestComponent(div DockerImageValues, autobuild *bool, attr attributes.Attributes) v1.Component {
comp := v1.Component{
Name: "image",
ComponentUnion: v1.ComponentUnion{
Image: &v1.ImageComponent{
Image: v1.Image{
ImageName: div.ImageName,
ImageUnion: v1.ImageUnion{
AutoBuild: autobuild,
Dockerfile: &v1.DockerfileImage{
DockerfileSrc: v1.DockerfileSrc{
Uri: div.Uri,
Expand Down