Skip to content

Commit fe639c2

Browse files
yangcao77yangcao77
authored
Merge pull request #127 from yangcao77/693-add-autobuild-to-image-kubernetes
new fields `autobuild` and `deploybydefault` for image components and kubernetes/openshift components
2 parents de570f0 + 70a6e35 commit fe639c2

File tree

6 files changed

+70
-24
lines changed

6 files changed

+70
-24
lines changed

‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module github.com/devfile/library
33
go 1.15
44

55
require (
6-
github.com/devfile/api/v2 v2.0.0-20211118170330-959f3c8007c3
6+
github.com/devfile/api/v2 v2.0.0-20220105201057-dd1d65d4d91f
77
github.com/fatih/color v1.7.0
88
github.com/gobwas/glob v0.2.3
99
github.com/golang/mock v1.5.0

‎go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ
8383
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
8484
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
8585
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
86-
github.com/devfile/api/v2 v2.0.0-20211118170330-959f3c8007c3 h1:G7TIrgpGx5lcZ3X7bpQeVCeeeO7tv6SAzPPvB9ThHXE=
87-
github.com/devfile/api/v2 v2.0.0-20211118170330-959f3c8007c3/go.mod h1:d99eTN6QxgzihOOFyOZA+VpUyD4Q1pYRYHZ/ci9J96Q=
86+
github.com/devfile/api/v2 v2.0.0-20220105201057-dd1d65d4d91f h1:Mdj4fXcQ0hEd7iMsqwydqrW0JfxepoPjzwxrshtvqYY=
87+
github.com/devfile/api/v2 v2.0.0-20220105201057-dd1d65d4d91f/go.mod h1:d99eTN6QxgzihOOFyOZA+VpUyD4Q1pYRYHZ/ci9J96Q=
8888
github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
8989
github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no=
9090
github.com/docker/spdystream v0.0.0-20160310174837-449fdfce4d96/go.mod h1:Qh8CwZgvJUkLughtfhJv5dyTYa91l1fOUCrgjqmcifM=

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

+31-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const JsonSchema220 = `{
4141
],
4242
"properties": {
4343
"apply": {
44-
"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.",
44+
"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.",
4545
"type": "object",
4646
"required": [
4747
"component"
@@ -457,6 +457,10 @@ const JsonSchema220 = `{
457457
}
458458
],
459459
"properties": {
460+
"autoBuild": {
461+
"description": "Defines if the image should be built during startup.\n\nDefault value is 'false'",
462+
"type": "boolean"
463+
},
460464
"dockerfile": {
461465
"description": "Allows specifying dockerfile type build",
462466
"type": "object",
@@ -577,6 +581,10 @@ const JsonSchema220 = `{
577581
}
578582
],
579583
"properties": {
584+
"deployByDefault": {
585+
"description": "Defines if the component should be deployed during startup.\n\nDefault value is 'false'",
586+
"type": "boolean"
587+
},
580588
"endpoints": {
581589
"type": "array",
582590
"items": {
@@ -674,6 +682,10 @@ const JsonSchema220 = `{
674682
}
675683
],
676684
"properties": {
685+
"deployByDefault": {
686+
"description": "Defines if the component should be deployed during startup.\n\nDefault value is 'false'",
687+
"type": "boolean"
688+
},
677689
"endpoints": {
678690
"type": "array",
679691
"items": {
@@ -935,7 +947,7 @@ const JsonSchema220 = `{
935947
],
936948
"properties": {
937949
"apply": {
938-
"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.",
950+
"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.",
939951
"type": "object",
940952
"properties": {
941953
"component": {
@@ -1320,9 +1332,18 @@ const JsonSchema220 = `{
13201332
"required": [
13211333
"dockerfile"
13221334
]
1335+
},
1336+
{
1337+
"required": [
1338+
"autoBuild"
1339+
]
13231340
}
13241341
],
13251342
"properties": {
1343+
"autoBuild": {
1344+
"description": "Defines if the image should be built during startup.\n\nDefault value is 'false'",
1345+
"type": "boolean"
1346+
},
13261347
"dockerfile": {
13271348
"description": "Allows specifying dockerfile type build",
13281349
"type": "object",
@@ -1437,6 +1458,10 @@ const JsonSchema220 = `{
14371458
}
14381459
],
14391460
"properties": {
1461+
"deployByDefault": {
1462+
"description": "Defines if the component should be deployed during startup.\n\nDefault value is 'false'",
1463+
"type": "boolean"
1464+
},
14401465
"endpoints": {
14411466
"type": "array",
14421467
"items": {
@@ -1531,6 +1556,10 @@ const JsonSchema220 = `{
15311556
}
15321557
],
15331558
"properties": {
1559+
"deployByDefault": {
1560+
"description": "Defines if the component should be deployed during startup.\n\nDefault value is 'false'",
1561+
"type": "boolean"
1562+
},
15341563
"endpoints": {
15351564
"type": "array",
15361565
"items": {

‎pkg/devfile/parser/parse.go

+10-2
Original file line numberDiff line numberDiff line change
@@ -549,10 +549,16 @@ func setDefaults(d DevfileObj) (err error) {
549549

550550
} else if component.Kubernetes != nil {
551551
endpoints = component.Kubernetes.Endpoints
552-
552+
if devfileVersion != string(data.APISchemaVersion200) && devfileVersion != string(data.APISchemaVersion210) {
553+
val := component.Kubernetes.GetDeployByDefault()
554+
component.Kubernetes.DeployByDefault = &val
555+
}
553556
} else if component.Openshift != nil {
554-
555557
endpoints = component.Openshift.Endpoints
558+
if devfileVersion != string(data.APISchemaVersion200) && devfileVersion != string(data.APISchemaVersion210) {
559+
val := component.Openshift.GetDeployByDefault()
560+
component.Openshift.DeployByDefault = &val
561+
}
556562

557563
} else if component.Volume != nil && devfileVersion != string(data.APISchemaVersion200) {
558564
volume := component.Volume
@@ -565,6 +571,8 @@ func setDefaults(d DevfileObj) (err error) {
565571
val := dockerImage.GetRootRequired()
566572
dockerImage.RootRequired = &val
567573
}
574+
val := component.Image.GetAutoBuild()
575+
component.Image.AutoBuild = &val
568576
}
569577

570578
if endpoints != nil {

‎pkg/devfile/parser/parse_test.go

+24-16
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
160160
},
161161
},
162162
},
163-
testingutil.GetDockerImageTestComponent(divRRTrue, nil),
163+
testingutil.GetDockerImageTestComponent(divRRTrue, nil, nil),
164164
},
165165
Events: &v1.Events{
166166
DevWorkspaceEvents: v1.DevWorkspaceEvents{
@@ -498,7 +498,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
498498
},
499499
},
500500
},
501-
testingutil.GetDockerImageTestComponent(divRRFalse, parentOverridesFromMainDevfile),
501+
testingutil.GetDockerImageTestComponent(divRRFalse, nil, parentOverridesFromMainDevfile),
502502
{
503503
Name: "runtime",
504504
ComponentUnion: v1.ComponentUnion{
@@ -736,7 +736,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
736736
},
737737
},
738738
//no overrides so expected values are the same as the parent
739-
testingutil.GetDockerImageTestComponent(divRRTrue, importFromUri1),
739+
testingutil.GetDockerImageTestComponent(divRRTrue, nil, importFromUri1),
740740
{
741741
Name: "runtime",
742742
ComponentUnion: v1.ComponentUnion{
@@ -1462,7 +1462,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
14621462
},
14631463
},
14641464
},
1465-
testingutil.GetDockerImageTestComponent(divRRFalse, nil),
1465+
testingutil.GetDockerImageTestComponent(divRRFalse, nil, nil),
14661466
},
14671467
Events: &v1.Events{
14681468
DevWorkspaceEvents: v1.DevWorkspaceEvents{
@@ -1600,7 +1600,7 @@ func Test_parseParentAndPluginFromURI(t *testing.T) {
16001600
},
16011601
},
16021602
},
1603-
testingutil.GetDockerImageTestComponent(divRRTrue, pluginOverridesFromMainDevfile),
1603+
testingutil.GetDockerImageTestComponent(divRRTrue, nil, pluginOverridesFromMainDevfile),
16041604
{
16051605
Name: "runtime",
16061606
ComponentUnion: v1.ComponentUnion{
@@ -3107,7 +3107,7 @@ func Test_parseParentFromRegistry(t *testing.T) {
31073107
},
31083108
},
31093109
},
3110-
testingutil.GetDockerImageTestComponent(defaultDiv, nil),
3110+
testingutil.GetDockerImageTestComponent(defaultDiv, nil, nil),
31113111
},
31123112
},
31133113
},
@@ -3249,7 +3249,7 @@ func Test_parseParentFromRegistry(t *testing.T) {
32493249
},
32503250
},
32513251
},
3252-
testingutil.GetDockerImageTestComponent(div, parentOverridesFromMainDevfile),
3252+
testingutil.GetDockerImageTestComponent(div, nil, parentOverridesFromMainDevfile),
32533253
{
32543254
Name: "runtime2",
32553255
ComponentUnion: v1.ComponentUnion{
@@ -3389,7 +3389,7 @@ func Test_parseParentFromRegistry(t *testing.T) {
33893389
},
33903390
},
33913391
},
3392-
testingutil.GetDockerImageTestComponent(defaultDiv, importFromRegistry),
3392+
testingutil.GetDockerImageTestComponent(defaultDiv, nil, importFromRegistry),
33933393
{
33943394
Name: "runtime2",
33953395
ComponentUnion: v1.ComponentUnion{
@@ -3503,7 +3503,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
35033503
},
35043504
},
35053505
},
3506-
testingutil.GetDockerImageTestComponent(defaultDiv, nil),
3506+
testingutil.GetDockerImageTestComponent(defaultDiv, nil, nil),
35073507
},
35083508
},
35093509
}
@@ -3522,7 +3522,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
35223522
},
35233523
},
35243524
},
3525-
testingutil.GetDockerImageTestComponent(defaultDiv, nil),
3525+
testingutil.GetDockerImageTestComponent(defaultDiv, nil, nil),
35263526
},
35273527
},
35283528
}
@@ -3626,7 +3626,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
36263626
},
36273627
},
36283628
},
3629-
testingutil.GetDockerImageTestComponent(div, parentOverridesFromMainDevfile),
3629+
testingutil.GetDockerImageTestComponent(div, nil, parentOverridesFromMainDevfile),
36303630
{
36313631
Name: "runtime",
36323632
ComponentUnion: v1.ComponentUnion{
@@ -3719,7 +3719,7 @@ func Test_parseParentFromKubeCRD(t *testing.T) {
37193719
},
37203720
},
37213721
},
3722-
testingutil.GetDockerImageTestComponent(defaultDiv, importFromKubeCRD),
3722+
testingutil.GetDockerImageTestComponent(defaultDiv, nil, importFromKubeCRD),
37233723
{
37243724
Name: "runtime",
37253725
ComponentUnion: v1.ComponentUnion{
@@ -4490,7 +4490,7 @@ func getUnsetBooleanDevfileTestData(apiVersion string) (devfileData data.Devfile
44904490
}
44914491

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

@@ -4510,12 +4510,14 @@ func getBooleanDevfileTestData(apiVersion string, setDefault bool) (devfileData
45104510
isDefault *bool
45114511
rootRequired *bool
45124512
ephemeral *bool
4513+
autoBuild *bool
4514+
deployByDefaul *bool
45134515
}
45144516

45154517
//default values according to spec
4516-
defaultBools := boolValues{&isFalse, &isFalse, &isFalse, &isFalse, &isTrue, &isFalse, &isFalse, &isFalse}
4518+
defaultBools := boolValues{&isFalse, &isFalse, &isFalse, &isFalse, &isTrue, &isFalse, &isFalse, &isFalse, &isFalse, &isFalse}
45174519
//set values will be a mix of default and inverse values
4518-
setBools := boolValues{&isTrue, &isTrue, &isFalse, &isTrue, &isFalse, &isFalse, &isTrue, &isFalse}
4520+
setBools := boolValues{&isTrue, &isTrue, &isFalse, &isTrue, &isFalse, &isFalse, &isTrue, &isFalse, &isTrue, &isFalse}
45194521

45204522
var values boolValues
45214523

@@ -4644,8 +4646,14 @@ func getBooleanDevfileTestData(apiVersion string, setDefault bool) (devfileData
46444646
}
46454647

46464648
if apiVersion != string(data.APISchemaVersion200) && apiVersion != string(data.APISchemaVersion210) {
4647-
comp := []v1.Component{testingutil.GetDockerImageTestComponent(testingutil.DockerImageValues{RootRequired: values.rootRequired}, nil)}
4649+
comp := []v1.Component{testingutil.GetDockerImageTestComponent(testingutil.DockerImageValues{RootRequired: values.rootRequired}, values.autoBuild, nil)}
46484650
err = devfileData.AddComponents(comp)
4651+
4652+
openshiftComponent, _ := devfileData.GetComponents(common.DevfileOptions{ComponentOptions: common.ComponentOptions{
4653+
ComponentType: v1.OpenshiftComponentType,
4654+
}})
4655+
openshiftComponent[0].Openshift.DeployByDefault = values.deployByDefaul
4656+
46494657
}
46504658

46514659
return devfileData, err

‎pkg/testingutil/devfile.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,15 @@ type DockerImageValues struct {
126126

127127
//GetDockerImageTestComponent returns a docker image component that is used for testing.
128128
//The parameters allow customization of the content. If they are set to nil, then the properties will not be set
129-
func GetDockerImageTestComponent(div DockerImageValues, attr attributes.Attributes) v1.Component {
129+
func GetDockerImageTestComponent(div DockerImageValues, autobuild *bool, attr attributes.Attributes) v1.Component {
130130
comp := v1.Component{
131131
Name: "image",
132132
ComponentUnion: v1.ComponentUnion{
133133
Image: &v1.ImageComponent{
134134
Image: v1.Image{
135135
ImageName: div.ImageName,
136136
ImageUnion: v1.ImageUnion{
137+
AutoBuild: autobuild,
137138
Dockerfile: &v1.DockerfileImage{
138139
DockerfileSrc: v1.DockerfileSrc{
139140
Uri: div.Uri,

0 commit comments

Comments
 (0)