Commit 3eeec585 authored by Elisabetta Giani's avatar Elisabetta Giani
Browse files

Merge branch 'tango-util' into 'master' 

Tango util

See merge request ska-telescope/csp-lmc!10
parents 541b0f4e 8fbe1999

csp-lmc-mid/.gitlab-ci.yml

+5 −6
Original line number Diff line number Diff line
@@ -108,7 +108,7 @@ integration:csp-lmc-mid: 
  script:

    - export KUBE_NAMESPACE="ci-csp-proto-$CI_COMMIT_SHORT_SHA"

    - cd $BUILD_PATH  

    - make k8s_test

    - make test

  environment:

      name: test

  after_script:
@@ -190,12 +190,12 @@ publish:csp-lmc-mid: 


publish_chart:

  variables:

    CHARTS_TO_PUBLISH: csp-proto

    CHARTS_TO_PUBLISH: mid-csp

  stage: publish

  when: manual

  tags:

  - k8srunner

  image: nexus.engageska-portugal.pt/ska-docker/deploy:0.4.2

  image: nexus.engageska-portugal.pt/ska-docker/deploy:0.4.3

  before_script:

    - apt-get -y update

    - apt-get install -y curl ca-certificates --no-install-recommends
@@ -204,7 +204,6 @@ publish_chart: 
    - curl -s https://gitlab.com/ska-telescope/stupid/raw/master/scripts/publish-charts.sh | bash

  variables:

    BUILD_PATH: csp-lmc-mid



#

# Release csp-lmc-mid image on nexus

#

csp-lmc-mid/.make/.make-release-support

+7 −0
Original line number Diff line number Diff line
@@ -69,6 +69,13 @@ function differsFromRelease() { 
	! tagExists $tag || test -n "$(git diff --shortstat -r $tag .)"

}



function getBaseVersion() {

	result=$(getRelease)



	result="$result-$(git log -n 1 --format=%h .)"

	echo $result

}



function getVersion() {

	result=$(getRelease)

csp-lmc-mid/.make/docker.mk

0 → 100644
+34 −0
Original line number Diff line number Diff line 
#

# IMAGE_TO_TEST defines the tag of the Docker image to test

#

IMAGE_TO_TEST = $(DOCKER_REGISTRY_HOST)/$(DOCKER_REGISTRY_USER)/$(PROJECT):$(IMAGE_TAG)



#

# Never use the network=host mode when running CI jobs, and add extra

# distinguishing identifiers to the network name and container names to

# prevent collisions with jobs from the same project running at the same

# time.

#

ifneq ($(CI_JOB_ID),)

NETWORK_MODE := tangonet-$(CI_JOB_ID)

CONTAINER_NAME_PREFIX := $(PROJECT)-$(CI_JOB_ID)-

else

CONTAINER_NAME_PREFIX := $(PROJECT)-

endif



#

# Defines a default make target so that help is printed if make is called

# without a target

#

.DEFAULT_GOAL := help



pull:  ## download the application image

	docker pull $(IMAGE_TO_TEST)



# piplock: build  ## overwrite Pipfile.lock with the image version

# 	docker run $(IMAGE_TO_TEST) cat /app/Pipfile.lock > $(CURDIR)/Pipfile.lock



interactive:  ## start an interactive session 

	docker run --rm -it -p 3000:3000 --name=$(CONTAINER_NAME_PREFIX)dev -e TANGO_HOST=$(TANGO_HOST)  -v $(CURDIR):/app $(IMAGE_TO_TEST) /bin/bash

csp-lmc-mid/.make/k8s.mk

+178 −125
Original line number Diff line number Diff line 
IMAGE_TO_RUN_TEST ?=  nexus.engageska-portugal.pt/ska-docker/ska-python-buildenv:latest

HELM_HOST ?= https://nexus.engageska-portugal.pt## helm host url https

MINIKUBE ?= true## Minikube or not

MARK ?= all

IMAGE_TO_TEST ?= $(DOCKER_REGISTRY_HOST)/$(DOCKER_REGISTRY_USER)/$(PROJECT):$(IMAGE_TAG)## docker image that will be run for testing purpose	

TANGO_HOST = tango-host-databaseds-from-makefile-$(HELM_RELEASE):10000## TANGO_HOST is an input!

LINTING_OUTPUT=$(shell helm lint charts/* | grep ERROR -c | tail -1)



CHARTS ?= mid-csp-umbrella mid-csp ## list of charts to be published on gitlab -- umbrella charts for testing purpose



CI_PROJECT_PATH_SLUG ?= mid-csp

CI_ENVIRONMENT_SLUG ?= mid-csp



# in release.mk it's defined the value of the variable IMAGE_TAG

SET_IMAGE_TAG ?= --set mid-csp.midcsplmc.image.tag=$(IMAGE_TAG) 

.DEFAULT_GOAL := help



k8s: ## Which kubernetes are we connected to

	@echo "Kubernetes cluster-info:"

	@kubectl cluster-info
@@ -8,9 +23,24 @@ k8s: ## Which kubernetes are we connected to 
	@echo ""

	@echo "Helm version:"

	@helm version --client

	@echo $(TANGO_HOST)

	@echo "git branch: $(BRANCH_NAME)"

	@echo "image tag: $(IMAGE_TAG)"

	@echo "image tag: $(IMAGE_TO_TEST)"



clean: ## clean out references to chart tgz's

	@rm -f ./charts/*/charts/*.tgz ./charts/*/Chart.lock ./charts/*/requirements.lock ./repository/*



watch:

	watch kubectl get all,pv,pvc,ingress -n $(KUBE_NAMESPACE)



namespace: ## create the kubernetes namespace

	kubectl describe namespace $(KUBE_NAMESPACE) || kubectl create namespace $(KUBE_NAMESPACE)

	@kubectl describe namespace $(KUBE_NAMESPACE) > /dev/null 2>&1 ; \

		K_DESC=$$? ; \

		if [ $$K_DESC -eq 0 ] ; \

		then kubectl describe namespace $(KUBE_NAMESPACE); \

		else kubectl create namespace $(KUBE_NAMESPACE); \

		fi



delete_namespace: ## delete the kubernetes namespace

	@if [ "default" == "$(KUBE_NAMESPACE)" ] || [ "kube-system" == "$(KUBE_NAMESPACE)" ]; then \
@@ -20,73 +50,84 @@ delete_namespace: ## delete the kubernetes namespace 
	kubectl describe namespace $(KUBE_NAMESPACE) && kubectl delete namespace $(KUBE_NAMESPACE); \

	fi



deploy: namespace mkcerts depends ## deploy the helm chart

	@helm install $(HELM_RELEASE) charts/$(HELM_CHART)/ \

		--namespace $(KUBE_NAMESPACE) \

		--set xauthority="$(XAUTHORITYx)" \

		--set display="$(DISPLAY)" \

		--set ingress.hostname=$(INGRESS_HOST) \

		--set helmTests=false 



delete: ## delete the helm chart release

	@helm uninstall $(HELM_RELEASE) --namespace $(KUBE_NAMESPACE)

	# if charts deployed locally, remove the repo charts files

	# created in charts/mid-csp/charts directory

	@if [ "a"$(CI_JOB_ID) == "a" ]; then \

	find ./charts -type f -name "tango*" -delete; \

	find ./charts -type f -name "csp-proto*" -delete; \

	find ./charts -type f -name "requirements.lock" -delete; \

	fi

# To package a chart directory into a chart archive

package: ## package charts

	@echo "Packaging helm charts. Any existing file won't be overwritten."; \

	mkdir -p ../tmp

	@for i in $(CHARTS); do \

	helm package charts/$${i} --destination ../tmp > /dev/null; \

	done; \

	mkdir -p ../repository && cp -n ../tmp/* ../repository; \

	cd ../repository && helm repo index .; \

	rm -rf ../tmp



install: namespace mkcerts  ## install the helm chart

	@helm install $(HELM_RELEASE) charts/$(HELM_CHART)/ \

		--namespace $(KUBE_NAMESPACE) \

		--set xauthority="$(XAUTHORITYx)" \

		--set display="$(DISPLAY)" \

		--set ingress.hostname=$(INGRESS_HOST)

dep-up: ## update dependencies for every charts in the env var CHARTS

	@cd charts; \

	for i in $(CHARTS); do \

	echo "+++ Updating $${i} chart +++"; \

	helm dependency update $${i}; \

	done;



show: mkcerts ## show the helm chart

	@helm template $(HELM_RELEASE) charts/$(HELM_CHART)/ \

		--namespace $(KUBE_NAMESPACE) \

		--set xauthority="$(XAUTHORITYx)" \

		--set display="$(DISPLAY)" \

		--set ingress.hostname=$(INGRESS_HOST)

# This job is used to create a deployment of tmc-mid charts

# Currently umbreall chart for tmc-mid path is given

install-chart: clean dep-up namespace ## install the helm chart with name HELM_RELEASE and path UMBRELLA_CHART_PATH on the namespace KUBE_NAMESPACE 

	@echo $(TANGO_HOST)

	@sed -e 's/CI_PROJECT_PATH_SLUG/$(CI_PROJECT_PATH_SLUG)/' $(UMBRELLA_CHART_PATH)values.yaml > generated_values.yaml; \

	sed -e 's/CI_ENVIRONMENT_SLUG/$(CI_ENVIRONMENT_SLUG)/' generated_values.yaml > values.yaml; \

	helm dependency update $(UMBRELLA_CHART_PATH); \

	helm install $(HELM_RELEASE) \

	--set global.minikube=$(MINIKUBE) \

	--set global.tango_host=$(TANGO_HOST) \

	--values values.yaml $(SET_IMAGE_TAG) \

         $(UMBRELLA_CHART_PATH) --namespace $(KUBE_NAMESPACE); \

	rm generated_values.yaml; \

	rm values.yaml



chart_lint: ## lint check the helm chart

	@for i in `ls charts/`; \

	do echo " char dir$${i}"; \

	helm lint charts/$${i}/ \

		--namespace $(KUBE_NAMESPACE) \

		--set ingress.hostname=$(INGRESS_HOST) \

		--set xauthority="$(XAUTHORITYx)" \

		--set display="$(DISPLAY)";\

	done

template-chart: clean dep-up## install the helm chart with name RELEASE_NAME and path UMBRELLA_CHART_PATH on the namespace KUBE_NAMESPACE

	@sed -e 's/CI_PROJECT_PATH_SLUG/$(CI_PROJECT_PATH_SLUG)/' $(UMBRELLA_CHART_PATH)values.yaml > generated_values.yaml; \

	sed -e 's/CI_ENVIRONMENT_SLUG/$(CI_ENVIRONMENT_SLUG)/' generated_values.yaml > values.yaml; \

	helm template $(RELEASE_NAME) \

	--set global.minikube=$(MINIKUBE) \

	--set global.tango_host=$(TANGO_HOST) \

	--values values.yaml $(SET_IMAGE_TAG) \

	--debug \

	 $(UMBRELLA_CHART_PATH) --namespace $(KUBE_NAMESPACE); \

	 rm generated_values.yaml; \

	 rm values.yaml



helm_delete: ## delete the helm chart release (with Tiller)

	@helm delete $(HELM_RELEASE) --purge \

# This job is used to delete a deployment of tmc-mid charts

# Currently umbreall chart for tmc-mid path is given

uninstall-chart: ## uninstall the tmc-mid helm chart on the namespace tmcprototype

	helm template  $(HELM_RELEASE) $(UMBRELLA_CHART_PATH) --set global.minikube=$(MINIKUBE) --set global.tango_host=$(TANGO_HOST) --namespace $(KUBE_NAMESPACE)  | kubectl delete -f - ; \

	helm uninstall  $(HELM_RELEASE) --namespace $(KUBE_NAMESPACE) 



reinstall-chart: uninstall-chart install-chart ## reinstall the tmc-mid helm chart on the namespace tmcprototype



traefik: ## install the helm chart for traefik (in the kube-system namespace). @param: EXTERNAL_IP (i.e. private ip of the master node).

	@TMP=`mktemp -d`; \

	$(helm_add_stable_repo) && \

	helm fetch stable/traefik --untar --untardir $$TMP && \

	helm template $(helm_install_shim) $$TMP/traefik -n traefik0 --namespace kube-system \

		--set externalIP="$(EXTERNAL_IP)" \

		| kubectl apply -n kube-system -f - && \

		rm -rf $$TMP ; \

upgrade-chart: ## upgrade the mid-csp-umbrella helm chart on the namespace mid-csp 

	helm upgrade --set global.minikube=$(MINIKUBE) --set global.tango_host=$(TANGO_HOST) $(HELM_RELEASE) $(UMBRELLA_CHART_PATH) --namespace $(KUBE_NAMESPACE) 



wait:## wait for pods to be ready

	@echo "Waiting for pods to be ready"

	@date

	@kubectl -n $(KUBE_NAMESPACE) get pods

	@jobs=$$(kubectl get job --output=jsonpath={.items..metadata.name} -n $(KUBE_NAMESPACE)); kubectl wait job --for=condition=complete --timeout=120s $$jobs -n $(KUBE_NAMESPACE)

	@kubectl -n $(KUBE_NAMESPACE) wait --for=condition=ready -l app=mid-csp-lmc --timeout=120s pods || exit 1

	@date



delete_traefik: ## delete the helm chart for traefik. @param: EXTERNAL_IP

	@TMP=`mktemp -d`; \

	$(helm_add_stable_repo) && \

	helm fetch stable/traefik --untar --untardir $$TMP && \

	helm template $(helm_install_shim) $$TMP/traefik -n traefik0 --namespace kube-system \

		--set externalIP="$(EXTERNAL_IP)" \

		| kubectl delete -n kube-system -f - && \

		rm -rf $$TMP

# Error in --set

show: ## show the helm chart

	@helm template $(HELM_RELEASE) charts/$(HELM_CHART)/ \

		--namespace $(KUBE_NAMESPACE) \

		--set xauthority="$(XAUTHORITYx)" \

		--set display="$(DISPLAY)" 



# Linting chart tmc-mid

chart_lint: ## lint check the helm chart

	@helm lint $(UMBRELLA_CHART_PATH) \

		--namespace $(KUBE_NAMESPACE) 



describe: ## describe Pods executed from Helm chart

	@for i in `kubectl -n $(KUBE_NAMESPACE) get pods -l release=$(HELM_RELEASE) -o=name`; \

	@for i in `kubectl -n $(KUBE_NAMESPACE) get pods -l app=mid-csp-lmc -o=name`; \

	do echo "---------------------------------------------------"; \

	echo "Describe for $${i}"; \

	echo kubectl -n $(KUBE_NAMESPACE) describe $${i}; \
@@ -119,30 +160,9 @@ logs: ## show Helm chart POD logs 
	echo "---------------------------------------------------"; \

	echo ""; echo ""; echo ""; \

	done

log: 	# get the logs of pods @param: $POD_NAME

	kubectl logs -n $(KUBE_NAMESPACE) $(POD_NAME)



localip:  ## set local Minikube IP in /etc/hosts file for Ingress $(INGRESS_HOST)

	@new_ip=`minikube ip` && \

	existing_ip=`grep $(INGRESS_HOST) /etc/hosts || true` && \

	echo "New IP is: $${new_ip}" && \

	echo "Existing IP: $${existing_ip}" && \

	if [ -z "$${existing_ip}" ]; then echo "$${new_ip} $(INGRESS_HOST)" | sudo tee -a /etc/hosts; \

	else sudo perl -i -ne "s/\d+\.\d+.\d+\.\d+/$${new_ip}/ if /$(INGRESS_HOST)/; print" /etc/hosts; fi && \

	echo "/etc/hosts is now: " `grep $(INGRESS_HOST) /etc/hosts`



mkcerts:  ## Make dummy certificates for $(INGRESS_HOST) and Ingress

	@if [ ! -d charts/$(HELM_CHART)/secrets ]; then \

            mkdir -p charts/$(HELM_CHART)/secrets; \

        else \

        echo "Creating secrets directory in  $(HELM_CHART)"; \

        fi

	@if [ ! -f charts/$(HELM_CHART)/secrets/tls.key ]; then \

	openssl req -x509 -sha256 -nodes -days 365 -newkey rsa:2048 \

	   -keyout charts/$(HELM_CHART)/secrets/tls.key \

		 -out charts/$(HELM_CHART)/secrets/tls.crt \

		 -subj "/CN=$(INGRESS_HOST)/O=Minikube"; \

	else \

	echo "SSL cert already exits in charts/$(HELM_CHART)/secrets ... skipping"; \

	fi



# Utility target to install Helm dependencies

helm_dependencies:
@@ -174,18 +194,28 @@ kubectl_dependencies: 
	@kubectl version



kubeconfig: ## export current KUBECONFIG as base64 ready for KUBE_CONFIG_BASE64

	@KUBE_CONFIG_BASE64=`kubectl config view --flatten | base64 -w 0`; \

	@KUBE_CONFIG_BASE64=`kubectl config view --flatten | base64`; \

	echo "KUBE_CONFIG_BASE64: $$(echo $${KUBE_CONFIG_BASE64} | cut -c 1-40)..."; \

	echo "appended to: PrivateRules.mak"; \

	echo -e "\n\n# base64 encoded from: kubectl config view --flatten\nKUBE_CONFIG_BASE64 = $${KUBE_CONFIG_BASE64}" >> PrivateRules.mak



wait:

	@echo "Waiting for device servers to be ready"

	@date

	@kubectl -n $(KUBE_NAMESPACE) get pods -l cspServer

	@jobs=$$(kubectl get job --output=jsonpath={.items..metadata.name} -n $(KUBE_NAMESPACE)); kubectl wait job --for=condition=complete --timeout=300s $$jobs -n $(KUBE_NAMESPACE)

	@kubectl -n $(KUBE_NAMESPACE) wait --for=condition=ready --timeout=300s -l cspServer pods

	@date

# run the test function

# save the status

# clean out build dir

# print the logs minus the base64 encoded payload

# pull out the base64 payload and unpack build/ dir

# base64 payload is given a boundary "~~~~BOUNDARY~~~~" and extracted using perl

# clean up the run to completion container

# exit the saved status

test: install-chart wait ## test the application on K8s

	$(call k8s_test,test); \

		status=$$?; \

		rm -rf build; \

		kubectl --namespace $(KUBE_NAMESPACE) logs $(TEST_RUNNER) | \

		perl -ne 'BEGIN {$$on=0;}; if (index($$_, "~~~~BOUNDARY~~~~")!=-1){$$on+=1;next;}; print if $$on % 2;' | \

		base64 -d | tar -xzf -; \

		kubectl --namespace $(KUBE_NAMESPACE) delete pod $(TEST_RUNNER); \

		exit $$status



#

# defines a function to copy the ./test-harness directory into the K8s TEST_RUNNER
@@ -197,37 +227,20 @@ k8s_test = tar -c . | \ 
		kubectl run $(TEST_RUNNER) \

		--namespace $(KUBE_NAMESPACE) -i --wait --restart=Never \

		--image-pull-policy=IfNotPresent \

		--image=$(IMAGE_TO_RUN_TEST) -- \

		--image=$(IMAGE_TO_TEST) -- \

		/bin/bash -c "tar xv --strip-components 1 --warning=all && \

		python3 -m pip install --extra-index-url https://nexus.engageska-portugal.pt/repository/pypi/simple -r requirements.txt &&\

		python3 -m pip install . &&\

		cd test-harness &&\

		make TANGO_HOST=databaseds-tango-base-$(HELM_RELEASE):10000 $1 && \

		make TANGO_HOST=$(TANGO_HOST) $1 && \

		tar -czvf /tmp/build.tgz build && \

                echo '~~~~BOUNDARY~~~~' && \

                cat /tmp/build.tgz | base64 && \

                echo '~~~~BOUNDARY~~~~'" \

                2>&1



# run the test function

# save the status

# clean out build dir

# print the logs minus the base64 encoded payload

# pull out the base64 payload and unpack build/ dir

# base64 payload is given a boundary "~~~~BOUNDARY~~~~" and extracted using perl

# clean up the run to completion container

# exit the saved status

k8s_test: deploy wait## test the application on K8s

	@echo "KUBE_NAMESPACE: $(KUBE_NAMESPACE)"

	$(call k8s_test,test); \

	  status=$$?; \

	  rm -fr build; \

	  kubectl --namespace $(KUBE_NAMESPACE) logs $(TEST_RUNNER) | perl -ne 'BEGIN {$$on=1;}; if (index($$_, "~~~~BOUNDARY~~~~")!=-1){$$on+=1;next;}; print if $$on % 2;'; \

		kubectl --namespace $(KUBE_NAMESPACE) logs $(TEST_RUNNER) | \

		perl -ne 'BEGIN {$$on=0;}; if (index($$_, "~~~~BOUNDARY~~~~")!=-1){$$on+=1;next;}; print if $$on % 2;' | \

		base64 -d | tar -xzf -; \

		kubectl --namespace $(KUBE_NAMESPACE) delete pod $(TEST_RUNNER); \

	  exit $$status

# to resolve the problem with the forwarded attributes, the CSP.LMC devices have to be restarted.

restart_csp: 

	kubectl delete pod -l app=mid-csp-lmc -n $(KUBE_NAMESPACE);\

	kubectl -n $(KUBE_NAMESPACE) wait --for=condition=ready -l app=mid-csp-lmc --timeout=60s pods || exit 1





rlint:  ## run lint check on Helm Chart using gitlab-runner
@@ -279,21 +292,61 @@ rk8s_test: ## run k8s_test on K8s using gitlab-runner 
helm_tests:  ## run Helm chart tests 

	helm test $(HELM_RELEASE) --cleanup



ingress_check:  ## curl test Tango REST API - https://tango-controls.readthedocs.io/en/latest/development/advanced/rest-api.html#tango-rest-api-implementations

	@echo "---------------------------------------------------"

	@echo "Test HTTP:"; echo ""

	curl -u "tango-cs:tango" -XGET http://$(INGRESS_HOST)/tango/rest/rc4/hosts/databaseds-tango-example-$(HELM_RELEASE)/10000 | json_pp

	@echo "", echo ""

	@echo "---------------------------------------------------"

	@echo "Test HTTPS:"; echo ""

	curl -k -u "tango-cs:tango" -XGET https://$(INGRESS_HOST)/tango/rest/rc4/hosts/databaseds-tango-example-$(HELM_RELEASE)/10000 | json_pp

	@echo ""



help:  ## show this help.

	@echo "make targets:"

	@grep -hE '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

	@echo ""; echo "make vars (+defaults):"

	@grep -hE '^[0-9a-zA-Z_-]+ \?=.*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = " \?\= "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\#\#/  \#/'



depends:

	helm dependency update charts/$(HELM_CHART)/
 
smoketest: ## check that the number of waiting containers is zero (10 attempts, wait time 30s).

	@echo "Smoke test START"; \

 	n=10; \

 	while [ $$n -gt 0 ]; do \

 		waiting=`kubectl get pods -n $(KUBE_NAMESPACE) -o=jsonpath='{.items[*].status.containerStatuses[*].state.waiting.reason}' | wc -w`; \

 		echo "Waiting containers=$$waiting"; \

 		if [ $$waiting -ne 0 ]; then \

 			echo "Waiting 30s for pods to become running...#$$n"; \

 			sleep 30s; \

 		fi; \

 		if [ $$waiting -eq 0 ]; then \

 			echo "Smoke test SUCCESS"; \

 			exit 0; \

 		fi; \

 		if [ $$n -eq 1 ]; then \

 			waiting=`kubectl get pods -n $(KUBE_NAMESPACE) -o=jsonpath='{.items[*].status.containerStatuses[*].state.waiting.reason}' | wc -w`; \

 			echo "Smoke test FAILS"; \

 			echo "Found $$waiting waiting containers: "; \

 			kubectl get pods -n $(KUBE_NAMESPACE) -o=jsonpath='{range .items[*].status.containerStatuses[?(.state.waiting)]}{.state.waiting.message}{"\n"}{end}'; \

 			exit 1; \

 		fi; \

 		n=`expr $$n - 1`; \

 	done

traefik: ## install the helm chart for traefik (in the kube-system namespace). @param: EXTERNAL_IP (i.e. private ip of the master node).

	@TMP=`mktemp -d`; \

	$(helm_add_stable_repo) && \

	helm fetch stable/traefik --untar --untardir $$TMP && \

	helm template $(helm_install_shim) $$TMP/traefik -n traefik0 --namespace kube-system \

		--set externalIP="$(EXTERNAL_IP)" \

		| kubectl apply -n kube-system -f - && \

		rm -rf $$TMP ; \





delete_traefik: ## delete the helm chart for traefik. @param: EXTERNAL_IP

	@TMP=`mktemp -d`; \

	$(helm_add_stable_repo) && \

	helm fetch stable/traefik --untar --untardir $$TMP && \

	helm template $(helm_install_shim) $$TMP/traefik -n traefik0 --namespace kube-system \

		--set externalIP="$(EXTERNAL_IP)" \

		| kubectl delete -n kube-system -f - && \

		rm -rf $$TMP



#this is so that you can load dashboards previously saved, TODO: make the name of the pod variable

dump_dashboards: # @param: name of the dashborad

	kubectl exec -i pod/mongodb-webjive-test-0 -n $(KUBE_NAMESPACE) -- mongodump --archive > $(DASHBOARD)



load_dashboards: # @param: name of the dashborad

	kubectl exec -i pod/mongodb-webjive-test-0 -n $(KUBE_NAMESPACE) -- mongorestore --archive < $(DASHBOARD)

csp-lmc-mid/.make/postdeploy.mk

deleted100644 → 0
+0 −130
Original line number Diff line number Diff line 
.PHONY: k8s_test smoketest template_tests tango_rest_ingress_check



#

# IMAGE_TO_TEST defines the tag of the Docker image to test

#

IMAGE_TO_TEST ?= nexus.engageska-portugal.pt/ska-docker/tango-vscode:0.2.4## docker image that will be run for testing purpose

#IMAGE_TO_TEST = $(DOCKER_REGISTRY_HOST)/$(DOCKER_REGISTRY_USER)/$(PROJECT):latest

# Test runner - run to completion job in K8s

TEST_RUNNER = test-makefile-runner-$(CI_JOB_ID)-$(KUBE_NAMESPACE)-$(HELM_RELEASE)##name of the pod running the k8s_tests

#

# defines a function to copy the ./test-harness directory into the K8s TEST_RUNNER

# and then runs the requested make target in the container.

# capture the output of the test in a build folder inside the container 

# 

TANGO_HOST = databaseds-tango-base-$(HELM_RELEASE):10000

MARK ?= fast## this will allow to add the mark parameter of pytest 

SLEEPTIME ?= 30s ##amount of sleep time for the smoketest target



#

# defines a function to copy the ./test-harness directory into the K8s TEST_RUNNER

# and then runs the requested make target in the container.

# capture the output of the test in a tar file

# stream the tar file base64 encoded to the Pod logs

# 

ktest = tar -c post-deployment/ | \

		kubectl run $(TEST_RUNNER) \

		--namespace $(KUBE_NAMESPACE) -i --wait --restart=Never \

		--image-pull-policy=IfNotPresent \

		--image=$(IMAGE_TO_TEST) -- \

		/bin/bash -c "mkdir csp-lmc-mid && tar xv --directory csp-lmc-mid --strip-components 1 --warning=all && cd csp-lmc-mid && \

		make KUBE_NAMESPACE=$(KUBE_NAMESPACE) HELM_RELEASE=$(HELM_RELEASE) TANGO_HOST=$(TANGO_HOST) MARK=$(MARK) $1 && \

		tar -czvf /tmp/build.tgz build && \

		echo '~~~~BOUNDARY~~~~' && \

		cat /tmp/build.tgz | base64 && \

		echo '~~~~BOUNDARY~~~~'" \

		2>&1



# run the test function

# save the status

# clean out build dir

# print the logs minus the base64 encoded payload

# pull out the base64 payload and unpack build/ dir

# base64 payload is given a boundary "~~~~BOUNDARY~~~~" and extracted using perl

# clean up the run to completion container

# exit the saved status

ktest: smoketest## test the application on K8s

	$(call ktest,test); \

		status=$$?; \

		rm -fr build; \

		kubectl --namespace $(KUBE_NAMESPACE) logs $(TEST_RUNNER) | \

		perl -ne 'BEGIN {$$on=0;}; if (index($$_, "~~~~BOUNDARY~~~~")!=-1){$$on+=1;next;}; print if $$on % 2;' | \

		base64 -d | tar -xzf -; \

		kubectl --namespace $(KUBE_NAMESPACE) delete pod $(TEST_RUNNER); \

		exit $$status





smoketest: ## check that the number of waiting containers is zero (10 attempts, wait time 30s).

	@echo "Smoke test START"; \

	n=10; \

	while [ $$n -gt 0 ]; do \

		waiting=`kubectl get pods -n $(KUBE_NAMESPACE) -o=jsonpath='{.items[*].status.containerStatuses[*].state.waiting.reason}' | wc -w`; \

		echo "Waiting containers=$$waiting"; \

		if [ $$waiting -ne 0 ]; then \

			echo "Waiting $(SLEEPTIME) for pods to become running...#$$n"; \

			sleep $(SLEEPTIME); \

		fi; \

		if [ $$waiting -eq 0 ]; then \

			echo "Smoke test SUCCESS"; \

			exit 0; \

		fi; \

		if [ $$n -eq 1 ]; then \

			waiting=`kubectl get pods -n $(KUBE_NAMESPACE) -o=jsonpath='{.items[*].status.containerStatuses[*].state.waiting.reason}' | wc -w`; \

			echo "Smoke test FAILS"; \

			echo "Found $$waiting waiting containers: "; \

			kubectl get pods -n $(KUBE_NAMESPACE) -o=jsonpath='{range .items[*].status.containerStatuses[?(.state.waiting)]}{.state.waiting.message}{"\n"}{end}'; \

			exit 1; \

		fi; \

		n=`expr $$n - 1`; \

	done



template_tests:

	rc=0; \

	for chrt in `ls charts/`; do \

	helm unittest -f template_tests/*_test.yaml charts/$$chrt \

		|| rc=2 && continue; \

	done; \

	exit $$rc



tango_rest_ingress_check:  ## curl test Tango REST API - https://tango-controls.readthedocs.io/en/latest/development/advanced/rest-api.html#tango-rest-api-implementations

	@echo "---------------------------------------------------"

	@echo "Test HTTP:"; echo ""

	curl -u "tango-cs:tango" -XGET http://tango.rest.$(INGRESS_HOST)/tango/rest/rc4/hosts/databaseds-tango-base-$(HELM_RELEASE)/10000 | json_pp

	# @echo "", echo ""

	# @echo "---------------------------------------------------"

	# @echo "Test HTTPS:"; echo ""

	# curl -k -u "tango-cs:tango" -XGET https://tango.rest.$(INGRESS_HOST)/tango/rest/rc4/hosts/databaseds-tango-base-$(HELM_RELEASE)/10000 | json_pp

	# @echo ""



oet_podname = $(shell kubectl get pods -l app=rest-oet-$(HELM_RELEASE) -o=jsonpath='{..metadata.name}')

sut_cdm_ver= $(shell kubectl exec -it $(oet_podname) pip list | grep "cdm-shared-library" | awk ' {print $$2}' | awk 'BEGIN { FS = "+" } ; {print $$1}')

sut_cdm_cur_ver=$(shell grep "cdm-shared-library" post-deployment/SUT_requirements.txt | awk 'BEGIN { FS = "==" } ; {print $$2}')

sut_oet_ver = $(shell kubectl exec -it $(oet_podname) pip list | grep "observation-execution-tool" | awk ' {print $$2}' | awk 'BEGIN { FS = "+" } ; {print $$1}')

sut_oet_cur_ver=$(shell grep "observation-execution-tool" post-deployment/SUT_requirements.txt | awk 'BEGIN { FS = "==" } ; {print $$2}')



check_oet_packages:

	@echo "MVP is based on cdm-shared-library=$(sut_cdm_ver)"

	@echo "Test are based on cdm-shared-library=$(sut_cdm_cur_ver)"

	@if [ $(sut_cdm_ver) != $(sut_cdm_cur_ver) ] ; then \

	echo "Warning: cdm-shared-library package for MVP is not the same as used for testing!"; \

	fi

	@echo "MVP is based on observation-execution-tool=$(sut_oet_ver)"

	@echo "Test are based on observation-execution-tool=$(sut_oet_cur_ver)"

	@if [ $(sut_oet_ver) != $(sut_oet_cur_ver) ] ; then \

	echo "Warning: observation-execution-tool package for MVP is not the same as used for testing!"; \

	fi



##the following section is for developers requiring the testing pod to be instantiated with a volume mappig to skampi

-include dev-testing.mk



timestamp=$(shell date -u +"%s")



sleepy_time:

	sleep 5s



measure_time:

	time1=$$SECONDS; \

	make sleepy_time; \

	time2=$$SECONDS; \

	elapsed=$$((time2 - time1)); \

	echo $$elapsed