add unitary test inside ci/cd pipeline (5d23881a) · Commits · TFS / controller

.gitlab-ci.yml

+1 −0

Original line number	Diff line number	Diff line
		@@ -54,6 +54,7 @@ include:
		- local: '/src/qos_profile/.gitlab-ci.yml'
		- local: '/src/vnt_manager/.gitlab-ci.yml'
		- local: '/src/e2e_orchestrator/.gitlab-ci.yml'
		- local: '/src/ztp_server/.gitlab-ci.yml'

		# This should be last one: end-to-end integration tests
		- local: '/src/tests/.gitlab-ci.yml'

src/ztp_server/.gitlab-ci.yml

0 → 100644

+100 −0

Original line number	Diff line number	Diff line
		# Copyright 2022-2025 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)
		#
		# 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.

		# Build, tag, and push the Docker image to the GitLab Docker registry
		build ztp_server:
		variables:
		IMAGE_NAME: 'ztp_server' # name of the microservice
		IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)
		stage: build
		before_script:
		- docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
		script:
		- docker buildx build -t "$IMAGE_NAME:$IMAGE_TAG" -f ./src/$IMAGE_NAME/Dockerfile .
		- docker tag "$IMAGE_NAME:$IMAGE_TAG" "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"
		- docker push "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"
		after_script:
		- docker images --filter="dangling=true" --quiet \| xargs -r docker rmi
		rules:
		- if: '$CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop" \|\| $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH)'
		- if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "develop"'
		- changes:
		- src/common/*/.py
		- proto/*.proto
		- src/$IMAGE_NAME/*/.{py,in,yml}
		- src/$IMAGE_NAME/Dockerfile
		- src/$IMAGE_NAME/tests/*.py
		- manifests/${IMAGE_NAME}service.yaml
		- .gitlab-ci.yml

		# Apply unit test to the component
		unit_test ztp_server:
		variables:
		IMAGE_NAME: 'ztp_server' # name of the microservice
		IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)
		stage: unit_test
		needs:
		- build ztp_server
		before_script:
		- docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
		- docker ps -aq \| xargs -r docker rm -f
		- >
		if docker network list \| grep teraflowbridge; then
		echo "teraflowbridge is already created";
		else
		docker network create -d bridge teraflowbridge;
		fi
		- >
		if docker container ls \| grep $IMAGE_NAME; then
		docker rm -f $IMAGE_NAME;
		else
		echo "$IMAGE_NAME image is not in the system";
		fi
		- docker container prune -f
		script:
		- docker pull "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"
		- docker images --filter="dangling=true" --quiet \| xargs -r docker rmi
		- >
		docker run --name $IMAGE_NAME -d -v "$PWD/src/$IMAGE_NAME/tests:/opt/results"
		--network=teraflowbridge
		--env LOG_LEVEL=DEBUG
		--env FLASK_ENV=development"
		$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG
		- while ! docker logs $IMAGE_NAME 2>&1 \| grep -q 'Configured Resources:'; do sleep 1; done
		- sleep 5 # Give extra time to container to get ready
		- docker ps -a
		- docker logs $IMAGE_NAME
		- docker exec -i $IMAGE_NAME bash -c "coverage run --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_core.py --junitxml=/opt/results/${IMAGE_NAME}_report_core.xml"
		- docker exec -i $IMAGE_NAME bash -c "coverage run --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_unitary.py --junitxml=/opt/results/${IMAGE_NAME}_report_unitary.xml"
		- docker exec -i $IMAGE_NAME bash -c "coverage report --include='${IMAGE_NAME}/*' --show-missing"
		coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+%)/'
		after_script:
		- docker logs $IMAGE_NAME
		- docker rm -f $IMAGE_NAME
		- docker network rm teraflowbridge
		rules:
		- if: '$CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop" \|\| $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH)'
		- if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "develop"'
		- changes:
		- src/common/*/.py
		- proto/*.proto
		- src/$IMAGE_NAME/*/.{py,in,yml}
		- src/$IMAGE_NAME/Dockerfile
		- src/$IMAGE_NAME/tests/*.py
		- manifests/${IMAGE_NAME}service.yaml
		- .gitlab-ci.yml
		artifacts:
		when: always
		reports:
		junit: src/$IMAGE_NAME/tests/${IMAGE_NAME}_report_*.xml

src/ztp_server/service/ZtpServerServiceServicerImpl.py

+1 −1

Original line number	Diff line number	Diff line
		@@ -28,7 +28,7 @@ class ZtpServerServiceServicerImpl(ZtpServerServiceServicer):
		LOGGER.info('Servicer Created')

		@safe_and_metered_rpc_method(METRICS_POOL, LOGGER)
		def GetZtpProvisioning(self, request : ProvisioningScriptName, context : grpc.ServicerContext) -> ProvisioningScript:
		def GetProvisioningScript(self, request : ProvisioningScriptName, context : grpc.ServicerContext) -> ProvisioningScript:
		try:
		provisioningPath = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', '..', 'data', request.scriptname)
		with open(provisioningPath, 'r') as provisioning_file:

src/ztp_server/tests/Constants.py

0 → 100644

+28 −0

Original line number	Diff line number	Diff line
		# Copyright 2022-2025 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)
		#
		# 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.


		from common.Constants import ServiceNameEnum
		from common.Settings import get_service_baseurl_http, get_service_port_http


		USERNAME = 'admin'
		PASSWORD = 'admin'
		LOCAL_HOST = '127.0.0.1'
		MOCKSERVICE_PORT = 10000
		ZTP_SERVICE_PORT = get_service_port_http(ServiceNameEnum.ZTP_SERVER) + MOCKSERVICE_PORT # avoid privileged ports
		ZTP_SERVICE_PREFIX_URL = get_service_baseurl_http(ServiceNameEnum.ZTP_SERVER) or ''
		ZTP_SERVICE_BASE_URL = 'http://{:s}:{:s}@{:s}:{:d}{:s}'.format(
		USERNAME, PASSWORD, LOCAL_HOST, ZTP_SERVICE_PORT, ZTP_SERVICE_PREFIX_URL
		)

src/ztp_server/tests/PrepareTestScenario.py

0 → 100644

+125 −0

Original line number	Diff line number	Diff line
		# Copyright 2022-2025 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)
		#
		# 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.

		import enum, logging, os, pytest, requests, time # subprocess, threading
		from typing import Any, Dict, List, Optional, Set, Union

		from common.Constants import ServiceNameEnum
		from common.Settings import (
		ENVVAR_SUFIX_SERVICE_HOST, ENVVAR_SUFIX_SERVICE_PORT_GRPC,
		ENVVAR_SUFIX_SERVICE_PORT_HTTP, get_env_var_name
		)

		from ztp_server.service.rest_server import RestServer
		from ztp_server.service.rest_server.ztpServer_plugins.ztp_provisioning_api import register_ztp_provisioning

		from .Constants import (
		LOCAL_HOST, MOCKSERVICE_PORT, ZTP_SERVICE_BASE_URL, ZTP_SERVICE_PORT,
		USERNAME, PASSWORD
		)

		os.environ[get_env_var_name(ServiceNameEnum.ZTP_SERVER, ENVVAR_SUFIX_SERVICE_HOST )] = str(LOCAL_HOST)
		os.environ[get_env_var_name(ServiceNameEnum.ZTP_SERVER, ENVVAR_SUFIX_SERVICE_PORT_HTTP)] = str(ZTP_SERVICE_PORT)

		@pytest.fixture(scope='session')
		def ztp_server_application():
		_rest_server = RestServer()
		register_ztp_provisioning(_rest_server)
		_rest_server.start()
		time.sleep(1) # bring time for the server to start
		yield _rest_server
		_rest_server.shutdown()
		_rest_server.join()

		class RestRequestMethod(enum.Enum):
		GET = 'get'
		POST = 'post'
		PUT = 'put'
		PATCH = 'patch'
		DELETE = 'delete'

		EXPECTED_STATUS_CODES : Set[int] = {
		requests.codes['OK' ],
		requests.codes['CREATED' ],
		requests.codes['ACCEPTED' ],
		requests.codes['NO_CONTENT'],
		}

		def do_rest_request(
		method : RestRequestMethod, url : str, body : Optional[Any] = None, timeout : int = 10,
		allow_redirects : bool = True, expected_status_codes : Set[int] = EXPECTED_STATUS_CODES,
		logger : Optional[logging.Logger] = None
		) -> Optional[Union[Dict, List]]:
		request_url = ZTP_SERVICE_BASE_URL + url
		if logger is not None:
		msg = 'Request: {:s} {:s}'.format(str(method.value).upper(), str(request_url))
		if body is not None: msg += ' body={:s}'.format(str(body))
		logger.warning(msg)
		reply = requests.request(method.value, request_url, timeout=timeout, json=body, allow_redirects=allow_redirects)
		if logger is not None:
		logger.warning('Reply: {:s}'.format(str(reply.text)))
		assert reply.status_code in expected_status_codes, 'Reply failed with status code {:d}'.format(reply.status_code)

		if reply.content and len(reply.content) > 0: return reply.json()
		return None

		def do_rest_get_request(
		url : str, body : Optional[Any] = None, timeout : int = 10,
		allow_redirects : bool = True, expected_status_codes : Set[int] = EXPECTED_STATUS_CODES,
		logger : Optional[logging.Logger] = None
		) -> Optional[Union[Dict, List]]:
		return do_rest_request(
		RestRequestMethod.GET, url, body=body, timeout=timeout, allow_redirects=allow_redirects,
		expected_status_codes=expected_status_codes, logger=logger
		)

		def do_rest_post_request(
		url : str, body : Optional[Any] = None, timeout : int = 10,
		allow_redirects : bool = True, expected_status_codes : Set[int] = EXPECTED_STATUS_CODES,
		logger : Optional[logging.Logger] = None
		) -> Optional[Union[Dict, List]]:
		return do_rest_request(
		RestRequestMethod.POST, url, body=body, timeout=timeout, allow_redirects=allow_redirects,
		expected_status_codes=expected_status_codes, logger=logger
		)

		def do_rest_put_request(
		url : str, body : Optional[Any] = None, timeout : int = 10,
		allow_redirects : bool = True, expected_status_codes : Set[int] = EXPECTED_STATUS_CODES,
		logger : Optional[logging.Logger] = None
		) -> Optional[Union[Dict, List]]:
		return do_rest_request(
		RestRequestMethod.PUT, url, body=body, timeout=timeout, allow_redirects=allow_redirects,
		expected_status_codes=expected_status_codes, logger=logger
		)

		def do_rest_patch_request(
		url : str, body : Optional[Any] = None, timeout : int = 10,
		allow_redirects : bool = True, expected_status_codes : Set[int] = EXPECTED_STATUS_CODES,
		logger : Optional[logging.Logger] = None
		) -> Optional[Union[Dict, List]]:
		return do_rest_request(
		RestRequestMethod.PATCH, url, body=body, timeout=timeout, allow_redirects=allow_redirects,
		expected_status_codes=expected_status_codes, logger=logger
		)

		def do_rest_delete_request(
		url : str, body : Optional[Any] = None, timeout : int = 10,
		allow_redirects : bool = True, expected_status_codes : Set[int] = EXPECTED_STATUS_CODES,
		logger : Optional[logging.Logger] = None
		) -> Optional[Union[Dict, List]]:
		return do_rest_request(
		RestRequestMethod.DELETE, url, body=body, timeout=timeout, allow_redirects=allow_redirects,
		expected_status_codes=expected_status_codes, logger=logger
		)