deep-stack/kompose
7
0
Fork 0
forked from LaconicNetwork/kompose
Code Pull Requests Activity

added more e2e, more tests

Browse Source 
fallback to skip volume mount and log warning when path cannot be resolved, as /sys, /root, /var/lib/docker

in e2e TestMultipleContainersInPod directory /data replaced with /data-dir

Signed-off-by: jose luis <2064537+sosan@users.noreply.github.com>
This commit is contained in:
jose luis 2024-04-10 00:19:06 +02:00
parent 4cd0b268fc
commit e9f64cfd81
No known key found for this signature in database
GPG Key ID: 6D23FAD11F88081A
15 changed files with 711 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
pkg/transformer/kubernetes/k8sutils.go
View File

@ -989,14 +989,18 @@ func reformatSecretConfigUnderscoreWithDash(secretConfig types.ServiceSecretConf
// isConfigFile checks if the given filePath should be used as a configMap
// if dir is not empty, withindir are treated as cofigmaps
// if it's configMap, mount readonly as default
func isConfigFile(filePath string) (useConfigMap bool, readonly bool) {
if strings.HasSuffix(filePath, ".sock") {
func isConfigFile(filePath string) (useConfigMap bool, readonly bool, skip bool) {
if filePath == "" || strings.HasSuffix(filePath, ".sock") {
skip = true
return
}
fi, err := os.Stat(filePath)
if err != nil {
log.Warnf("Failed to check if the directory is empty: %v", err)
log.Warnf("File don't exist or failed to check if the directory is empty: %v", err)
// dir/file not exist
// here not assigned skip to true,
// maybe dont want to skip
return
}
@ -1004,26 +1008,36 @@ func isConfigFile(filePath string) (useConfigMap bool, readonly bool) {
isDirEmpty, err := checkIsEmptyDir(filePath)
if err != nil {
log.Warnf("Failed to check if the directory is empty: %v", err)
skip = true
return
}
if isDirEmpty {
return false, false
return
}
}
return true, true
return true, true, skip
}
// checkIsEmptyDir checks if filepath is empty
func checkIsEmptyDir(filePath string) (bool, error) {
entries, err := os.ReadDir(filePath)
files, err := os.ReadDir(filePath)
if err != nil {
return false, err
}
if len(entries) == 0 {
if len(files) == 0 {
return true, err
}
return false, err
for _, file := range files {
if !file.IsDir() {
return false, nil
}
_, err := checkIsEmptyDir(file.Name())
if err != nil {
return false, err
}
}
return true, nil
}
// setVolumeAccessMode sets the access mode for a volume based on the mode string

59
pkg/transformer/kubernetes/k8sutils_test.go
View File

@ -817,7 +817,17 @@ func Test_isConfigFile(t *testing.T) {
args args
wantUseConfigMap bool
wantReadonly bool
wantSkip bool
}{
{
name: "dir not empty",
args: args{
filePath: "../../../script/test/fixtures/configmap-file-configs/certs",
},
wantUseConfigMap: true,
wantReadonly: true,
wantSkip: false,
},
{
name: "sock",
args: args{
@ -825,6 +835,7 @@ func Test_isConfigFile(t *testing.T) {
},
wantUseConfigMap: false,
wantReadonly: false,
wantSkip: true,
},
{
name: "cannot resolve filepath",
@ -833,6 +844,7 @@ func Test_isConfigFile(t *testing.T) {
},
wantUseConfigMap: false,
wantReadonly: false,
wantSkip: false,
},
{
name: "file cert",
@ -841,25 +853,66 @@ func Test_isConfigFile(t *testing.T) {
},
wantUseConfigMap: true,
wantReadonly: true,
wantSkip: false,
},
{
name: "dir not empty",
name: "docker sock",
args: args{
filePath: "../../../script/test/fixtures/configmap-file-configs/certs",
filePath: "/var/run/docker.sock",
},
wantUseConfigMap: false,
wantReadonly: false,
wantSkip: true,
},
{
name: "dir sys",
args: args{
filePath: "/sys",
},
wantUseConfigMap: false,
wantReadonly: false,
wantSkip: true,
},
{
name: "dir root",
args: args{
filePath: "/root",
},
wantUseConfigMap: false,
wantReadonly: false,
wantSkip: true,
},
{
name: "docker var lib",
args: args{
filePath: "/var/lib/docker",
},
wantUseConfigMap: false,
wantReadonly: false,
wantSkip: true,
},
{
name: "file from 3 levels",
args: args{
filePath: "../../../script/test/fixtures/configmap-file-configs/certs-level1/certs-level2/certs-level3/cert2.pem",
},
wantUseConfigMap: true,
wantReadonly: true,
wantSkip: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gotUseConfigMap, gotReadonly := isConfigFile(tt.args.filePath)
gotUseConfigMap, gotReadonly, gotSkip := isConfigFile(tt.args.filePath)
if gotUseConfigMap != tt.wantUseConfigMap {
t.Errorf("isConfigFile() gotUseConfigMap = %v, want %v", gotUseConfigMap, tt.wantUseConfigMap)
}
if gotReadonly != tt.wantReadonly {
t.Errorf("isConfigFile() gotReadonly = %v, want %v", gotReadonly, tt.wantReadonly)
}
if gotSkip != tt.wantSkip {
t.Errorf("isConfigFile() gotSkip = %v, want %v", gotSkip, tt.wantSkip)
}
})
}
}

11
pkg/transformer/kubernetes/kubernetes.go
View File

@ -951,13 +951,22 @@ func (k *Kubernetes) ConfigVolumes(name string, service kobject.ServiceConfig) (
volumes = append(volumes, secretsVolumes...)
var count int
skip := false
//iterating over array of `Vols` struct as it contains all necessary information about volumes
for _, volume := range service.Volumes {
// check if ro/rw mode is defined, default rw
readonly := len(volume.Mode) > 0 && (volume.Mode == "ro" || volume.Mode == "rox")
mountHost := volume.Host
if mountHost == "" {
mountHost = volume.MountPath
}
// return useconfigmap and readonly,
// not used asigned readonly because dont break e2e
useConfigMap, _ = isConfigFile(volume.Host)
useConfigMap, _, skip = isConfigFile(mountHost)
if skip {
log.Warnf("Skip file in path %s ", volume.Host)
continue
}
if volume.VolumeName == "" {
if useEmptyVolumes {
volumeName = strings.Replace(volume.PVCName, "claim", "empty", 1)

2
pkg/transformer/kubernetes/kubernetes_test.go
View File

@ -757,7 +757,7 @@ func TestMultipleContainersInPod(t *testing.T) {
config.Volumes = []kobject.Volumes{
{
VolumeName: "mountVolume",
MountPath: "/data",
MountPath: "/data-dir",
},
}
return config

25
script/test/cmd/tests_new.sh
View File

@ -340,7 +340,26 @@ os_output="$KOMPOSE_ROOT/script/test/fixtures/resources-lowercase/output-os.yaml
convert::expect_success "$k8s_cmd" "$k8s_output" || exit 1
convert::expect_success "$os_cmd" "$os_output" || exit 1
#Test configmaps
k8s_cmd="kompose -f $KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/compose.yaml convert --stdout --with-kompose-annotation=false"
k8s_output="$KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/output-k8s.yaml"
#Test auto configmaps from files/dir
k8s_cmd="kompose -f $KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/compose-1.yaml convert --stdout --with-kompose-annotation=false"
k8s_output="$KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/output-k8s-1.yaml"
os_cmd="kompose -f $KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/compose-1.yaml convert --provider openshift --stdout --with-kompose-annotation=false"
os_output="$KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/output-os-1.yaml"
convert::expect_success "$k8s_cmd" "$k8s_output" || exit 1
convert::expect_success "$os_cmd" "$os_output" || exit 1
#Test auto configmaps from files/dir
k8s_cmd="kompose -f $KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/compose-2.yaml convert --stdout --with-kompose-annotation=false"
k8s_output="$KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/output-k8s-2.yaml"
os_cmd="kompose -f $KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/compose-2.yaml convert --provider openshift --stdout --with-kompose-annotation=false"
os_output="$KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/output-os-2.yaml"
convert::expect_success "$k8s_cmd" "$k8s_output" || exit 1
convert::expect_success "$os_cmd" "$os_output" || exit 1
#Test auto configmaps from files/dir
k8s_cmd="kompose -f $KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/compose-3.yaml convert --stdout --with-kompose-annotation=false"
k8s_output="$KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/output-k8s-3.yaml"
os_cmd="kompose -f $KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/compose-3.yaml convert --provider openshift --stdout --with-kompose-annotation=false"
os_output="$KOMPOSE_ROOT/script/test/fixtures/configmap-file-configs/output-os-3.yaml"
convert::expect_success "$k8s_cmd" "$k8s_output" || exit 1
convert::expect_success "$os_cmd" "$os_output" || exit 1

1
script/test/fixtures/configmap-file-configs/certs-level1/certs-level2/certs-level3/cert2.pem vendored Normal file
View File

@ -0,0 +1 @@
content from file cert2.pem

0
script/test/fixtures/configmap-file-configs/compose.yaml → script/test/fixtures/configmap-file-configs/compose-1.yaml vendored
View File

17
script/test/fixtures/configmap-file-configs/compose-2.yaml vendored Normal file
View File

@ -0,0 +1,17 @@
services:
busy:
image: busybox
ports:
- "8081:8080"
- "8026:8025"
volumes:
- ./certs:/certs
- ./certs-level1/certs-level2/certs-level3/cert2.pem:/certs/cert2.pem
- ./auth.txt:/auth.txt
- ./users.php:/users.php:ro
command:
[
"/bin/sh",
"-c",
"cat /auth.txt /users.php /certs/cert1.pem /certs/cert2.pem"
]

10
script/test/fixtures/configmap-file-configs/compose-3.yaml vendored Normal file
View File

@ -0,0 +1,10 @@
services:
busy:
image: busybox
ports:
- "8081:8080"
- "8026:8025"
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- /sys:/sys:ro
- /var/lib/docker/:/var/lib/docker:ro

0
script/test/fixtures/configmap-file-configs/output-k8s.yaml → script/test/fixtures/configmap-file-configs/output-k8s-1.yaml vendored
View File

137
script/test/fixtures/configmap-file-configs/output-k8s-2.yaml vendored Normal file
View File

@ -0,0 +1,137 @@
---
apiVersion: v1
kind: Service
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
ports:
- name: "8081"
port: 8081
targetPort: 8080
- name: "8026"
port: 8026
targetPort: 8025
selector:
io.kompose.service: busy
---
apiVersion: apps/v1
kind: Deployment
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
replicas: 1
selector:
matchLabels:
io.kompose.service: busy
strategy:
type: Recreate
template:
metadata:
labels:
io.kompose.network/configmap-file-configs-default: "true"
io.kompose.service: busy
spec:
containers:
- args:
- /bin/sh
- -c
- cat /auth.txt /users.php /certs/cert1.pem /certs/cert2.pem
image: busybox
name: busy
ports:
- containerPort: 8080
hostPort: 8081
protocol: TCP
- containerPort: 8025
hostPort: 8026
protocol: TCP
volumeMounts:
- mountPath: /certs
name: busy-cm0
- mountPath: /certs/cert2.pem
name: busy-cm1
subPath: cert2.pem
- mountPath: /auth.txt
name: busy-cm2
subPath: auth.txt
- mountPath: /users.php
name: busy-cm3
readOnly: true
subPath: users.php
restartPolicy: Always
volumes:
- configMap:
name: busy-cm0
name: busy-cm0
- configMap:
items:
- key: cert2.pem
path: cert2.pem
name: busy-cm1
name: busy-cm1
- configMap:
items:
- key: auth.txt
path: auth.txt
name: busy-cm2
name: busy-cm2
- configMap:
items:
- key: users.php
path: users.php
name: busy-cm3
name: busy-cm3
---
apiVersion: v1
data:
cert1.pem: |
content of file cert1.pem
kind: ConfigMap
metadata:
labels:
io.kompose.service: busy
name: busy-cm0
---
apiVersion: v1
data:
cert2.pem: content from file cert2.pem
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm1
---
apiVersion: v1
data:
auth.txt: |
content from file auth.txt
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm2
---
apiVersion: v1
data:
users.php: |
content from file users.php
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm3

49
script/test/fixtures/configmap-file-configs/output-k8s-3.yaml vendored Normal file
View File

@ -0,0 +1,49 @@
---
apiVersion: v1
kind: Service
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
ports:
- name: "8081"
port: 8081
targetPort: 8080
- name: "8026"
port: 8026
targetPort: 8025
selector:
io.kompose.service: busy
---
apiVersion: apps/v1
kind: Deployment
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
replicas: 1
selector:
matchLabels:
io.kompose.service: busy
strategy:
type: Recreate
template:
metadata:
labels:
io.kompose.network/configmap-file-configs-default: "true"
io.kompose.service: busy
spec:
containers:
- image: busybox
name: busy
ports:
- containerPort: 8080
hostPort: 8081
protocol: TCP
- containerPort: 8025
hostPort: 8026
protocol: TCP
restartPolicy: Always

144
script/test/fixtures/configmap-file-configs/output-os-1.yaml vendored Normal file
View File

@ -0,0 +1,144 @@
---
apiVersion: v1
kind: Service
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
ports:
- name: "8081"
port: 8081
targetPort: 8080
- name: "8026"
port: 8026
targetPort: 8025
selector:
io.kompose.service: busy
---
apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
replicas: 1
selector:
io.kompose.service: busy
strategy:
type: Recreate
template:
metadata:
labels:
io.kompose.network/configmap-file-configs-default: "true"
io.kompose.service: busy
spec:
containers:
- args:
- /bin/sh
- -c
- cat /auth.txt /users.php /certs/cert1.pem
image: ' '
name: busy
ports:
- containerPort: 8080
hostPort: 8081
protocol: TCP
- containerPort: 8025
hostPort: 8026
protocol: TCP
volumeMounts:
- mountPath: /certs
name: busy-cm0
- mountPath: /auth.txt
name: busy-cm1
subPath: auth.txt
- mountPath: /users.php
name: busy-cm2
readOnly: true
subPath: users.php
restartPolicy: Always
volumes:
- configMap:
name: busy-cm0
name: busy-cm0
- configMap:
items:
- key: auth.txt
path: auth.txt
name: busy-cm1
name: busy-cm1
- configMap:
items:
- key: users.php
path: users.php
name: busy-cm2
name: busy-cm2
test: false
triggers:
- type: ConfigChange
- imageChangeParams:
automatic: true
containerNames:
- busy
from:
kind: ImageStreamTag
name: busy:latest
type: ImageChange
---
apiVersion: image.openshift.io/v1
kind: ImageStream
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
lookupPolicy:
local: false
tags:
- from:
kind: DockerImage
name: busybox
name: latest
referencePolicy:
type: ""
---
apiVersion: v1
data:
cert1.pem: |
content of file cert1.pem
kind: ConfigMap
metadata:
labels:
io.kompose.service: busy
name: busy-cm0
---
apiVersion: v1
data:
auth.txt: |
content from file auth.txt
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm1
---
apiVersion: v1
data:
users.php: |
content from file users.php
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm2

165
script/test/fixtures/configmap-file-configs/output-os-2.yaml vendored Normal file
View File

@ -0,0 +1,165 @@
---
apiVersion: v1
kind: Service
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
ports:
- name: "8081"
port: 8081
targetPort: 8080
- name: "8026"
port: 8026
targetPort: 8025
selector:
io.kompose.service: busy
---
apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
replicas: 1
selector:
io.kompose.service: busy
strategy:
type: Recreate
template:
metadata:
labels:
io.kompose.network/configmap-file-configs-default: "true"
io.kompose.service: busy
spec:
containers:
- args:
- /bin/sh
- -c
- cat /auth.txt /users.php /certs/cert1.pem /certs/cert2.pem
image: ' '
name: busy
ports:
- containerPort: 8080
hostPort: 8081
protocol: TCP
- containerPort: 8025
hostPort: 8026
protocol: TCP
volumeMounts:
- mountPath: /certs
name: busy-cm0
- mountPath: /certs/cert2.pem
name: busy-cm1
subPath: cert2.pem
- mountPath: /auth.txt
name: busy-cm2
subPath: auth.txt
- mountPath: /users.php
name: busy-cm3
readOnly: true
subPath: users.php
restartPolicy: Always
volumes:
- configMap:
name: busy-cm0
name: busy-cm0
- configMap:
items:
- key: cert2.pem
path: cert2.pem
name: busy-cm1
name: busy-cm1
- configMap:
items:
- key: auth.txt
path: auth.txt
name: busy-cm2
name: busy-cm2
- configMap:
items:
- key: users.php
path: users.php
name: busy-cm3
name: busy-cm3
test: false
triggers:
- type: ConfigChange
- imageChangeParams:
automatic: true
containerNames:
- busy
from:
kind: ImageStreamTag
name: busy:latest
type: ImageChange
---
apiVersion: image.openshift.io/v1
kind: ImageStream
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
lookupPolicy:
local: false
tags:
- from:
kind: DockerImage
name: busybox
name: latest
referencePolicy:
type: ""
---
apiVersion: v1
data:
cert1.pem: |
content of file cert1.pem
kind: ConfigMap
metadata:
labels:
io.kompose.service: busy
name: busy-cm0
---
apiVersion: v1
data:
cert2.pem: content from file cert2.pem
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm1
---
apiVersion: v1
data:
auth.txt: |
content from file auth.txt
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm2
---
apiVersion: v1
data:
users.php: |
content from file users.php
kind: ConfigMap
metadata:
annotations:
use-subpath: "true"
labels:
io.kompose.service: busy
name: busy-cm3

77
script/test/fixtures/configmap-file-configs/output-os-3.yaml vendored Normal file
View File

@ -0,0 +1,77 @@
---
apiVersion: v1
kind: Service
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
ports:
- name: "8081"
port: 8081
targetPort: 8080
- name: "8026"
port: 8026
targetPort: 8025
selector:
io.kompose.service: busy
---
apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
replicas: 1
selector:
io.kompose.service: busy
strategy:
type: Recreate
template:
metadata:
labels:
io.kompose.network/configmap-file-configs-default: "true"
io.kompose.service: busy
spec:
containers:
- image: ' '
name: busy
ports:
- containerPort: 8080
hostPort: 8081
protocol: TCP
- containerPort: 8025
hostPort: 8026
protocol: TCP
restartPolicy: Always
test: false
triggers:
- type: ConfigChange
- imageChangeParams:
automatic: true
containerNames:
- busy
from:
kind: ImageStreamTag
name: busy:latest
type: ImageChange
---
apiVersion: image.openshift.io/v1
kind: ImageStream
metadata:
labels:
io.kompose.service: busy
name: busy
spec:
lookupPolicy:
local: false
tags:
- from:
kind: DockerImage
name: busybox
name: latest
referencePolicy:
type: ""