diff --git a/Makefile b/Makefile index a0c0d430..d26c2c6b 100644 --- a/Makefile +++ b/Makefile @@ -66,6 +66,11 @@ test-openshift: test-cmd: ./script/test/cmd/tests.sh +# generate commandline tests +.PHONY: generate-test-cmd +gen-cmd: + ./script/test/cmd/make-test.sh + # run all validation tests .PHONY: validate validate: gofmt vet lint diff --git a/docs/development.md b/docs/development.md index 49fa3d5e..1de76bde 100644 --- a/docs/development.md +++ b/docs/development.md @@ -106,6 +106,12 @@ OpenShift is using forked Kubernetes to carry some patches. Currently it is not possible to use different Kubernetes version from version that OpenShift uses. (for more see comments in `glide.yml`) +### Adding CLI tests + +[Kompose CLI tests](https://github.com/kubernetes/kompose/tree/master/script/test/cmd) run `kompose convert` with docker-compose files, and cross-check the k8s and OpenShift artifacts generated with the template files. + +To generate CLI tests, please run `make generate-test-cmd`. + ### CI For Kompose, we use numerous CI's: diff --git a/script/test/cmd/make-test.sh b/script/test/cmd/make-test.sh new file mode 100755 index 00000000..d6e25c10 --- /dev/null +++ b/script/test/cmd/make-test.sh @@ -0,0 +1,73 @@ +#!/bin/bash + +# Copyright 2017 The Kubernetes Authors All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing pe#rmissions and +# limitations under the License. + +# This script generates unit tests for Kompose +# Usage: ./script/test/cmd/make-test.sh + +KOMPOSE_ROOT=$(readlink -f $(dirname "${BASH_SOURCE}")/../../..) + +# Directory in which the output files have to be generated +# Eg. script/test/fixtures/group-add/ +echo -n "Enter the Test Directory where the files needs to be generated: " +read TEST_DIR + +# One-line description for the test case +echo -ne "\nEnter a description for the tests to be added: " +read TEST_DESCRIPTION + +echo -ne "\nPlease provide the name of docker-compose file to be used (docker-compose.yaml by default): " +read COMPOSE_FILE + +if [ -z $COMPOSE_FILE ]; then + COMPOSE_FILE="docker-compose.yaml" +fi + + +if [ -z $TEST_DIR ] || [ -z "${TEST_DESCRIPTION}" ]; then + echo "Please provide values for TEST_DIR and TEST_DESCRIPTION in the script" + exit 1; +fi + +COMPOSE_FILE=$TEST_DIR/$COMPOSE_FILE + +generate_k8s() { + ./kompose convert -f $COMPOSE_FILE -j -o $TEST_DIR/output-k8s.json + sed -i -e '/.*kompose.cmd.*:/ s/: .*/: "%CMD%"/' -e '/.*kompose.version.*:/ s/: .*/: "%VERSION%"/' ${TEST_DIR}/output-k8s.json +} + +generate_os() { + ./kompose convert --provider=openshift -f $COMPOSE_FILE -j -o $TEST_DIR/output-os.json + sed -i -e '/.*kompose.cmd.*:/ s/: .*/: "%CMD%"/' -e '/.*kompose.version.*:/ s/: .*/: "%VERSION%"/' ${TEST_DIR}/output-os.json +} + +# Generate k8s files +generate_k8s + +# Generate OS files +generate_os + +cat >> $KOMPOSE_ROOT/script/test/cmd/tests.sh < /tmp/output-k8s.json +convert::expect_success "kompose -f \$KOMPOSE_ROOT/$COMPOSE_FILE convert --stdout -j" +# OpenShift test +cmd="kompose --provider=openshift -f \$KOMPOSE_ROOT/${COMPOSE_FILE} convert --stdout -j" +sed -e "s;%VERSION%;\$version;g" -e "s;%CMD%;\$cmd;g" \$KOMPOSE_ROOT/${TEST_DIR}/output-os.json > /tmp/output-os.json +convert::expect_success "kompose --provider=openshift -f \$KOMPOSE_ROOT/$COMPOSE_FILE convert --stdout -j" + +EOF