AT5-370: Added docker folder with docker and docker-compose configuration

#!/bin/bash

#

#   Copyright 2015  Xebia Nederland B.V.

#   Modifications copyright 2019 SKA Organisation

#

#   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 permissions and

#   limitations under the License.

#

function hasChanges() {

	test -n "$(git status -s .)"

}

function getRelease() {

	awk -F= '/^release=/{print $2}' .release

}

function getBaseTag() {

		sed -n -e "s/^tag=\(.*\)$(getRelease)\$/\1/p" .release

}

function getTag() {

	if [ -z "$1" ] ; then

		awk -F= '/^tag/{print $2}' .release

	else

		echo "$(getBaseTag)$1"

	fi

}

function setRelease() {

	if [ -n "$1" ] ; then

		sed -i.x -e "s/^tag=.*/tag=$(getTag $1)/" .release

		sed -i.x -e "s/^release=.*/release=$1/g" .release

		rm -f .release.x

		runPreTagCommand "$1"

	else

		echo "ERROR: missing release version parameter " >&2

		return 1

	fi

}

function runPreTagCommand() {

	if [ -n "$1" ] ; then

		COMMAND=$(sed -n -e "s/@@RELEASE@@/$1/g" -e 's/^pre_tag_command=\(.*\)/\1/p' .release)

		if [ -n "$COMMAND" ] ; then

			if ! OUTPUT=$(bash -c "$COMMAND" 2>&1) ; then echo $OUTPUT >&2 && exit 1 ; fi

		fi

	else

		echo "ERROR: missing release version parameter " >&2

		return 1

	fi

}

function tagExists() {

	tag=${1:-$(getTag)}

	test -n "$tag" && test -n "$(git tag | grep "^$tag\$")"

}

function differsFromRelease() {

	tag=$(getTag)

	! tagExists $tag || test -n "$(git diff --shortstat -r $tag .)"

}

function getVersion() {

	result=$(getRelease)

	if differsFromRelease; then

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

	fi

	if hasChanges ; then

		result="$result-dirty"

	fi

	echo $result

}

function nextPatchLevel() {

	version=${1:-$(getRelease)}

	major_and_minor=$(echo $version | cut -d. -f1,2)

	patch=$(echo $version | cut -d. -f3)

	version=$(printf "%s.%d" $major_and_minor $(($patch + 1)))

	echo $version

}

function nextMinorLevel() {

	version=${1:-$(getRelease)}

	major=$(echo $version | cut -d. -f1);

	minor=$(echo $version | cut -d. -f2);

	version=$(printf "%d.%d.0" $major $(($minor + 1))) ;

	echo $version

}

function nextMajorLevel() {

	version=${1:-$(getRelease)}

	major=$(echo $version | cut -d. -f1);

	version=$(printf "%d.0.0" $(($major + 1)))

	echo $version

}

#

#   Copyright 2015  Xebia Nederland B.V.

#

#   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 permissions and

#   limitations under the License.

#

ifeq ($(strip $(PROJECT)),)

  NAME=$(shell basename $(CURDIR))

else

  NAME=$(PROJECT)

endif

RELEASE_SUPPORT := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))/.make-release-support

ifeq ($(strip $(DOCKER_REGISTRY_HOST)),)

  DOCKER_REGISTRY_HOST = nexus.engageska-portugal.pt

endif

ifeq ($(strip $(DOCKER_REGISTRY_USER)),)

  DOCKER_REGISTRY_USER = ska-docker

endif

IMAGE=$(DOCKER_REGISTRY_HOST)/$(DOCKER_REGISTRY_USER)/$(NAME)

#VERSION = release version + git sha

VERSION=$(shell . $(RELEASE_SUPPORT) ; getVersion)

#BASE_VERSION

BASE_VERSION=$(shell . $(RELEASE_SUPPORT) ; getRelease)

#TAG = project name + release version

TAG=$(shell . $(RELEASE_SUPPORT); getTag)

#DEFAULT_TAG = image name + BASE_VERSION

DEFAULT_TAG=$(IMAGE):$(BASE_VERSION)

SHELL=/bin/bash

DOCKER_BUILD_CONTEXT=..

DOCKER_FILE_PATH=Dockerfile

.PHONY: pre-build docker-build post-build build release patch-release minor-release major-release tag check-status check-release showver \

	push pre-push do-push post-push

build: pre-build docker-build post-build  ## build the application image

pre-build:

post-build:

pre-push:

post-push:

docker-build: .release

	@echo "Building image: $(IMAGE):$(VERSION)"

	@echo "NAME: $(NAME)"

	docker build $(DOCKER_BUILD_ARGS) -t $(IMAGE):$(VERSION) $(DOCKER_BUILD_CONTEXT) -f $(DOCKER_FILE_PATH) --build-arg DOCKER_REGISTRY_HOST=$(DOCKER_REGISTRY_HOST) --build-arg DOCKER_REGISTRY_USER=$(DOCKER_REGISTRY_USER)

	@DOCKER_MAJOR=$(shell docker -v | sed -e 's/.*version //' -e 's/,.*//' | cut -d\. -f1) ; \

	DOCKER_MINOR=$(shell docker -v | sed -e 's/.*version //' -e 's/,.*//' | cut -d\. -f2) ; \

	if [ $$DOCKER_MAJOR -eq 1 ] && [ $$DOCKER_MINOR -lt 10 ] ; then \

		echo docker tag -f $(IMAGE):$(VERSION) $(IMAGE):latest ;\

		docker tag -f $(IMAGE):$(VERSION) $(IMAGE):latest ;\

	else \

		echo docker tag $(IMAGE):$(VERSION) $(IMAGE):latest ;\

		docker tag $(IMAGE):$(VERSION) $(IMAGE):latest ; \

	fi

release: check-status check-release build push

push: pre-push do-push post-push  ## push the image to the Docker registry

do-push: ## Push the image tagged as $(IMAGE):$(VERSION) and $(DEFAULT_TAG)

	@echo -e "Tagging: $(IMAGE):$(VERSION) -> $(DEFAULT_TAG)"

	docker tag $(IMAGE):$(VERSION) $(DEFAULT_TAG)

	@echo -e "Pushing: $(IMAGE):$(VERSION)"

	docker push $(IMAGE):$(VERSION)

	@echo -e "Pushing: $(DEFAULT_TAG)"

	docker push $(DEFAULT_TAG)

tag_latest: do-push ## Tag the images as latest

	@echo "Tagging: $(DEFAULT_TAG) -> $(IMAGE):latest"

	@docker tag $(DEFAULT_TAG) $(IMAGE):latest

push_latest: tag_latest ## Push the image tagged as :latest

	@echo "Pushing: $(IMAGE):latest"

	@docker push $(IMAGE):latest

snapshot: build push

showver: .release

	@. $(RELEASE_SUPPORT); getVersion

bump-patch-release: VERSION := $(shell . $(RELEASE_SUPPORT); nextPatchLevel)

bump-patch-release: .release tag

bump-minor-release: VERSION := $(shell . $(RELEASE_SUPPORT); nextMinorLevel)

bump-minor-release: .release tag

bump-major-release: VERSION := $(shell . $(RELEASE_SUPPORT); nextMajorLevel)

bump-major-release: .release tag

patch-release: tag-patch-release release

	@echo $(VERSION)

minor-release: tag-minor-release release

	@echo $(VERSION)

major-release: tag-major-release release

	@echo $(VERSION)

tag: TAG=$(shell . $(RELEASE_SUPPORT); getTag $(VERSION))

tag: check-status

#	@. $(RELEASE_SUPPORT) ; ! tagExists $(TAG) || (echo "ERROR: tag $(TAG) for version $(VERSION) already tagged in git" >&2 && exit 1) ;

	@. $(RELEASE_SUPPORT) ; setRelease $(VERSION)

#	git add .

#	git commit -m "bumped to version $(VERSION)" ;

#	git tag $(TAG) ;

#	@ if [ -n "$(shell git remote -v)" ] ; then git push --tags ; else echo 'no remote to push tags to' ; fi

check-status:

	@. $(RELEASE_SUPPORT) ; ! hasChanges || (echo "ERROR: there are still outstanding changes" >&2 && exit 1) ;

check-release: .release

	@. $(RELEASE_SUPPORT) ; tagExists $(TAG) || (echo "ERROR: version not yet tagged in git. make [minor,major,patch]-release." >&2 && exit 1) ;

	@. $(RELEASE_SUPPORT) ; ! differsFromRelease $(TAG) || (echo "ERROR: current directory differs from tagged $(TAG). make [minor,major,patch]-release." ; exit 1)

# -*- coding: utf-8 -*-

#

# This file is part of the CSP.LMC prototype project

#

#

# Distributed under the terms of the BSD-3-Clause license.

# See LICENSE.txt for more info.

"""Release information for Python Package"""

name = """csplmc-subelement"""

version = "0.1.0"

version_info = version.split(".")

description = """SKA CSP.LMC Subelement Classes"""

author = "E.G"

author_email = "elisabetta.giani@inaf.it"

license = """BSD-3-Clause"""

url = """www.tango-controls.org"""

copyright = """"""

release=0.1.0

tag=csp-lmc-subelement-0.1.0

FROM nexus.engageska-portugal.pt/ska-docker/ska-python-buildenv:9.3.1 AS buildenv

FROM nexus.engageska-portugal.pt/ska-docker/ska-python-runtime:9.3.1 AS runtime

# create ipython profile to so that itango doesn't fail if ipython hasn't run yet

RUN ipython profile create

#RUN python3 -m pip install --user pytest-forked

ENV PATH=/home/tango/.local/bin:$PATH

#install csp-lmc-common with dependencies

RUN python3 -m pip install -e . --user --extra-index-url https://nexus.engageska-portugal.pt/repository/pypi/simple

CMD ["/venv/bin/python", "/app/cspse/lmc/SubElementMaster.py" ]

#

# Project makefile for a Tango project. You should normally only need to modify

# DOCKER_REGISTRY_USER and PROJECT below.

#

#

# DOCKER_REGISTRY_HOST, DOCKER_REGISTRY_USER and PROJECT are combined to define

# the Docker tag for this project. The definition below inherits the standard

# value for DOCKER_REGISTRY_HOST (=rnexus.engageska-portugal.pt) and overwrites

# DOCKER_REGISTRY_USER and PROJECT to give a final Docker tag of

# nexus.engageska-portugal.pt/tango-example/csplmc

#

DOCKER_REGISTRY_USER:=ska-docker

PROJECT = csp-lmc-subelement

#

# include makefile to pick up the standard Make targets, e.g., 'make build'

# build, 'make push' docker push procedure, etc. The other Make targets

# ('make interactive', 'make test', etc.) are defined in this file.

#

include .make/Makefile.mk

#

# IMAGE_TO_TEST defines the tag of the Docker image to test

#

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

#

# CACHE_VOLUME is the name of the Docker volume used to cache eggs and wheels

# used during the test procedure. The volume is not used during the build

# procedure

#

CACHE_VOLUME = $(PROJECT)-test-cache

# optional docker run-time arguments

DOCKER_RUN_ARGS =

#

# 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

COMPOSE_FILES := $(wildcard *.yml)

COMPOSE_FILE_ARGS := $(foreach yml,$(COMPOSE_FILES),-f $(yml))

ifeq ($(OS),Windows_NT)

    $(error Sorry, Windows is not supported yet)

else

	UNAME_S := $(shell uname -s)

	ifeq ($(UNAME_S),Linux)

		DISPLAY ?= :0.0

		NETWORK_MODE ?= host

		XAUTHORITY_MOUNT := /tmp/.X11-unix:/tmp/.X11-unix

		XAUTHORITY ?= /hosthome/.Xauthority

		# /bin/sh (=dash) does not evaluate 'docker network' conditionals correctly

		SHELL := /bin/bash

	endif

	ifeq ($(UNAME_S),Darwin)

		IF_INTERFACE := $(shell netstat -nr | awk '{ if ($$1 ~/default/) { print $$6} }')

		DISPLAY := $(shell ifconfig $(IF_INTERFACE) | awk '{ if ($$1 ~/inet$$/) { print $$2} }'):0

		# network_mode = host doesn't work on MacOS, so fix to the internal network

		NETWORK_MODE := tangonet

		XAUTHORITY_MOUNT := $(HOME):/hosthome:ro

		XAUTHORITY := /hosthome/.Xauthority

	endif

endif

#

# When running in network=host mode, point devices at a port on the host

# machine rather than at the container.

#

ifeq ($(NETWORK_MODE),host)

TANGO_HOST := $(shell hostname):10000

MYSQL_HOST := $(shell hostname):3306

else

# distinguish the bridge network from others by adding the project name

NETWORK_MODE := $(NETWORK_MODE)-$(PROJECT)

TANGO_HOST := $(CONTAINER_NAME_PREFIX)databaseds:10000

MYSQL_HOST := $(CONTAINER_NAME_PREFIX)tangodb:3306

endif

DOCKER_COMPOSE_ARGS := DISPLAY=$(DISPLAY) XAUTHORITY=$(XAUTHORITY) TANGO_HOST=$(TANGO_HOST) \

		NETWORK_MODE=$(NETWORK_MODE) XAUTHORITY_MOUNT=$(XAUTHORITY_MOUNT) MYSQL_HOST=$(MYSQL_HOST) \

		DOCKER_REGISTRY_HOST=$(DOCKER_REGISTRY_HOST) DOCKER_REGISTRY_USER=$(DOCKER_REGISTRY_USER) \

		CONTAINER_NAME_PREFIX=$(CONTAINER_NAME_PREFIX) COMPOSE_IGNORE_ORPHANS=true

#

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

# without a target

#

.DEFAULT_GOAL := help

#

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

# and then runs the requested make target in the container. The container is:

#

#   1. attached to the network of the docker-compose test system

#   2. uses a persistent volume to cache Python eggs and wheels so that fewer

#      downloads are required

#   3. uses a transient volume as a working directory, in which untarred files

#      and test output can be written in the container and subsequently copied

#      to the host

#

make = tar -c test-harness/ | \

	   docker run -i --rm --network=$(NETWORK_MODE) \

	   -e TANGO_HOST=$(TANGO_HOST) \

	   -v $(CACHE_VOLUME):/home/tango/.cache \

	   -v /build -w /build -u tango $(DOCKER_RUN_ARGS) $(IMAGE_TO_TEST) \

	   bash -c "sudo chown -R tango:tango /build && \

	   tar x --strip-components 1 --warning=all && \

	   make TANGO_HOST=$(TANGO_HOST) $1"

test: DOCKER_RUN_ARGS = --volumes-from=$(BUILD)

test: build up ## test the application

	@echo "BUILD: $(BUILD)"

	$(INIT_CACHE)

	$(call make,test); \

	  status=$$?; \

	  rm -fr build; \

          #docker-compose $(COMPOSE_FILE_ARGS) logs;

	  docker cp $(BUILD):/build .; \

	  docker rm -f -v $(BUILD); \

	  $(MAKE) down; \

	  exit $$status

lint: DOCKER_RUN_ARGS = --volumes-from=$(BUILD) 

lint: build up ## lint the application (static code analysis)

	$(INIT_CACHE)

	$(call make,lint); \

	status=$$?; \

	docker cp $(BUILD):/build .; \

	$(MAKE) down; \

	exit $$status	  

pull:  ## download the application image

	docker pull $(IMAGE_TO_TEST)

up: build  ## start develop/test environment

ifneq ($(NETWORK_MODE),host)

	docker network inspect $(NETWORK_MODE) &> /dev/null || ([ $$? -ne 0 ] && docker network create $(NETWORK_MODE))

endif

	#$(DOCKER_COMPOSE_ARGS) docker-compose $(COMPOSE_FILE_ARGS) pull

	#to pull only the mid-cbf-mcs image remove comment on row below.

	#docker pull $(DOCKER_REGISTRY_HOST)/$(DOCKER_REGISTRY_USER)/mid-cbf-mcs:latest

	$(DOCKER_COMPOSE_ARGS) docker-compose -f se-tangodb.yml up -d

	# put a sleep to wait TANGO DB 

	@sleep 10

	$(DOCKER_COMPOSE_ARGS) docker-compose $(COMPOSE_FILE_ARGS) up -d 

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

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

interactive: up

interactive:  ## start an interactive session using the project image (caution: R/W mounts source directory to /app)

	docker run --rm -it -p 3000:3000 --name=$(CONTAINER_NAME_PREFIX)dev -e TANGO_HOST=$(TANGO_HOST) --network=$(NETWORK_MODE) \

	  -v $(CURDIR):/app $(IMAGE_TO_TEST) /bin/bash

down:  ## stop develop/test environment and any interactive session

	docker ps | grep $(CONTAINER_NAME_PREFIX)dev && docker stop $(PROJECT)-dev || true

	$(DOCKER_COMPOSE_ARGS) docker-compose $(COMPOSE_FILE_ARGS) down

ifneq ($(NETWORK_MODE),host)

	docker network inspect $(NETWORK_MODE) &> /dev/null && ([ $$? -eq 0 ] && docker network rm $(NETWORK_MODE)) || true

endif

dsconfigdump: up ## dump the entire configuration to the file dsconfig.json

	docker exec -it $(CONTAINER_NAME_PREFIX)dsconfigdump python -m dsconfig.dump

	docker exec -it $(CONTAINER_NAME_PREFIX)dsconfigdump python -m dsconfig.dump > dsconfig.json

dsconfigadd: up ## Add a configuration json file (environment variable DSCONFIG_JSON_FILE) to the database

	-docker exec -it $(CONTAINER_NAME_PREFIX)dsconfigdump json2tango -u -w -a $(DSCONFIG_JSON_FILE)

dsconfigcheck: up ## check a json file (environment variable DSCONFIG_JSON_FILE) according to the project lib-maxiv-dsconfig json schema

	-docker exec -it $(CONTAINER_NAME_PREFIX)dsconfigdump json2tango -a $(DSCONFIG_JSON_FILE)

help:  ## show this help.

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

.PHONY: all test up down help

# Creates Docker volume for use as a cache, if it doesn't exist already

INIT_CACHE = \

	docker volume ls | grep $(CACHE_VOLUME) || \

	docker create --name $(CACHE_VOLUME) -v $(CACHE_VOLUME):/cache $(IMAGE_TO_TEST)

# http://cakoose.com/wiki/gnu_make_thunks

BUILD_GEN = $(shell docker create -v /build $(IMAGE_TO_TEST))

BUILD = $(eval BUILD := $(BUILD_GEN))$(BUILD)