GitLab CI/CD pipeline - OFC'24:

# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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 ofc22:

  variables:

    TEST_NAME: 'ofc22'

  stage: build

  before_script:

    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY

  script:

    - docker buildx build -t "${TEST_NAME}:latest" -f ./src/tests/${TEST_NAME}/Dockerfile .

    - docker tag "${TEST_NAME}:latest" "$CI_REGISTRY_IMAGE/${TEST_NAME}:latest"

    - docker push "$CI_REGISTRY_IMAGE/${TEST_NAME}:latest"

  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/tests/${TEST_NAME}/**/*.{py,in,sh,yml}

      - src/tests/${TEST_NAME}/Dockerfile

      - .gitlab-ci.yml

# Deploy TeraFlowSDN and Execute end-2-end test

end2end_test ofc22:

  variables:

    TEST_NAME: 'ofc22'

  stage: end2end_test

  # Disable to force running it after all other tasks

  #needs:

  #  - build ofc22

  before_script:

    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY

  script:

    # Download Docker image to run the test

    - docker pull "${CI_REGISTRY_IMAGE}/${TEST_NAME}:latest"

    # Check MicroK8s is ready

    - microk8s status --wait-ready

    - kubectl get pods --all-namespaces

    # Configure TeraFlowSDN deployment

    # Uncomment if DEBUG log level is needed for the components

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/contextservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/deviceservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="frontend").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/pathcompservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/serviceservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/sliceservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/nbiservice.yaml

    - source src/tests/${TEST_NAME}/deploy_specs.sh

    #- export TFS_REGISTRY_IMAGES="${CI_REGISTRY_IMAGE}"

    #- export TFS_SKIP_BUILD="YES"

    #- export TFS_IMAGE_TAG="latest"

    #- echo "TFS_REGISTRY_IMAGES=${CI_REGISTRY_IMAGE}"

    # Deploy TeraFlowSDN

    - ./deploy/crdb.sh

    - ./deploy/nats.sh

    - ./deploy/qdb.sh

    - ./deploy/expose_dashboard.sh

    - ./deploy/tfs.sh

    - ./deploy/show.sh

    # Wait for Context to be subscribed to NATS

    #- while ! kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/contextservice -c server 2>&1 | grep -q 'Subscriber is Ready? True'; do sleep 1; done

    #- kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/contextservice -c server

    # Run end-to-end tests

    - if docker ps -a | grep ${TEST_NAME}; then docker rm -f ${TEST_NAME}; fi

    - >

      docker run -t --name ${TEST_NAME} --network=host 

      --volume "$PWD/tfs_runtime_env_vars.sh:/var/teraflow/tfs_runtime_env_vars.sh"

      --volume "$PWD/src/tests/${TEST_NAME}:/opt/results"

      $CI_REGISTRY_IMAGE/${TEST_NAME}:latest

  after_script:

    - source src/tests/${TEST_NAME}/deploy_specs.sh

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/contextservice -c server

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/deviceservice -c server

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/pathcompservice -c frontend

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/serviceservice -c server

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/sliceservice -c server

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/nbiservice -c server

    - if docker ps -a | grep ${TEST_NAME}; then docker rm -f ${TEST_NAME}; fi

    - docker images --filter="dangling=true" --quiet | xargs -r docker rmi

  #coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+%)/'

  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"'

  artifacts:

      when: always

      reports:

        junit: ./src/tests/${TEST_NAME}/report_*.xml

# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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 python:3.9-slim

# Install dependencies

RUN apt-get --yes --quiet --quiet update && \

    apt-get --yes --quiet --quiet install wget g++ git && \

    rm -rf /var/lib/apt/lists/*

# Set Python to show logs as they occur

ENV PYTHONUNBUFFERED=0

# Download the gRPC health probe

RUN GRPC_HEALTH_PROBE_VERSION=v0.2.0 && \

    wget -qO/bin/grpc_health_probe https://github.com/grpc-ecosystem/grpc-health-probe/releases/download/${GRPC_HEALTH_PROBE_VERSION}/grpc_health_probe-linux-amd64 && \

    chmod +x /bin/grpc_health_probe

# Get generic Python packages

RUN python3 -m pip install --upgrade pip

RUN python3 -m pip install --upgrade setuptools wheel

RUN python3 -m pip install --upgrade pip-tools

# Get common Python packages

# Note: this step enables sharing the previous Docker build steps among all the Python components

WORKDIR /var/teraflow

COPY common_requirements.in common_requirements.in

RUN pip-compile --quiet --output-file=common_requirements.txt common_requirements.in

RUN python3 -m pip install -r common_requirements.txt

# Add common files into working directory

WORKDIR /var/teraflow/common

COPY src/common/. ./

RUN rm -rf proto

# Create proto sub-folder, copy .proto files, and generate Python code

RUN mkdir -p /var/teraflow/common/proto

WORKDIR /var/teraflow/common/proto

RUN touch __init__.py

COPY proto/*.proto ./

RUN python3 -m grpc_tools.protoc -I=. --python_out=. --grpc_python_out=. *.proto

RUN rm *.proto

RUN find . -type f -exec sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' {} \;

# Create component sub-folders, get specific Python packages

RUN mkdir -p /var/teraflow/tests/ofc24

WORKDIR /var/teraflow/tests/ofc24

COPY src/tests/ofc24/requirements.in requirements.in

RUN pip-compile --quiet --output-file=requirements.txt requirements.in

RUN python3 -m pip install -r requirements.txt

# Add component files into working directory

WORKDIR /var/teraflow

COPY src/__init__.py ./__init__.py

COPY src/common/*.py ./common/

COPY src/common/tests/. ./common/tests/

COPY src/common/tools/. ./common/tools/

COPY src/context/__init__.py context/__init__.py

COPY src/context/client/. context/client/

COPY src/device/__init__.py device/__init__.py

COPY src/device/client/. device/client/

#COPY src/monitoring/__init__.py monitoring/__init__.py

#COPY src/monitoring/client/. monitoring/client/

#COPY src/monitoring/__init__.py monitoring/__init__.py

#COPY src/monitoring/client/. monitoring/client/

COPY src/e2e_orchestrator/__init__.py e2e_orchestrator/__init__.py

COPY src/e2e_orchestrator/client/. e2e_orchestrator/client/

COPY src/service/__init__.py service/__init__.py

COPY src/service/client/. service/client/

COPY src/slice/__init__.py slice/__init__.py

COPY src/slice/client/. slice/client/

COPY src/tests/*.py ./tests/

COPY src/tests/ofc24/__init__.py ./tests/ofc24/__init__.py

COPY src/tests/ofc24/descriptors_topology.json ./tests/ofc24/descriptors_topology.json

COPY src/tests/ofc24/tests/. ./tests/ofc24/tests/

COPY src/tests/tools/. ./tests/tools/

RUN tee ./run_tests.sh <<EOF

#!/bin/bash

source /var/teraflow/tfs_runtime_env_vars.sh

export PYTHONPATH=/var/teraflow

pytest --verbose --log-level=INFO /var/teraflow/tests/ofc24/tests/test_functional_bootstrap.py      --junitxml=/opt/results/report_bootstrap.xml

pytest --verbose --log-level=INFO /var/teraflow/tests/ofc24/tests/test_functional_create_service.py --junitxml=/opt/results/report_create_service.xml

pytest --verbose --log-level=INFO /var/teraflow/tests/ofc24/tests/test_functional_delete_service.py --junitxml=/opt/results/report_delete_service.xml

pytest --verbose --log-level=INFO /var/teraflow/tests/ofc24/tests/test_functional_cleanup.py        --junitxml=/opt/results/report_cleanup.xml

EOF

RUN chmod ug+x ./run_tests.sh

# Run the tests

ENTRYPOINT ["./run_tests.sh"]

#!/bin/bash

# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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.

TEST_NAME="ofc24"

echo

echo "Pre-deploy clean-up:"

echo "--------------------"

docker rm -f na-t1 na-t2 na-r1 na-r2

docker network rm na-br

echo

echo "Pull Docker images:"

echo "-------------------"

docker pull asgamb1/flexscale-hhi.img:latest

docker pull asgamb1/flexscale-node.img:latest

echo

echo "Create Management Network and Node Agents:"

echo "------------------------------------------"

docker network create -d bridge --subnet=172.254.253.0/24 --gateway=172.254.253.254 --ip-range=172.254.253.0/24 na-br

docker run -d --name na-t1 --network=na-br --ip 172.254.253.1 \

    --volume "$PWD/src/tests/${TEST_NAME}/startNetconfAgent.sh:/confd/examples.confd/OC23/startNetconfAgent.sh" \

    --volume "$PWD/src/tests/${TEST_NAME}/platform_t1.xml:/confd/examples.confd/OC23/init_openconfig-platform.xml" \

    asgamb1/flexscale-hhi.img:latest /confd/examples.confd/OC23/startNetconfAgent.sh

docker run -d --name na-t2 --network=na-br --ip 172.254.253.2 \

    --volume "$PWD/src/tests/${TEST_NAME}/startNetconfAgent.sh:/confd/examples.confd/OC23/startNetconfAgent.sh" \

    --volume "$PWD/src/tests/${TEST_NAME}/platform_t2.xml:/confd/examples.confd/OC23/init_openconfig-platform.xml" \

    asgamb1/flexscale-hhi.img:latest /confd/examples.confd/OC23/startNetconfAgent.sh

docker run -d --name na-r1 --network=na-br --ip 172.254.253.101 \

    --volume "$PWD/src/tests/${TEST_NAME}/startNetconfAgent.sh:/confd/examples.confd/OC23/startNetconfAgent.sh" \

    --volume "$PWD/src/tests/${TEST_NAME}/platform_r1.xml:/confd/examples.confd/OC23/init_openconfig-platform.xml" \

    asgamb1/flexscale-node.img:latest /confd/examples.confd/OC23/startNetconfAgent.sh

docker run -d --name na-r2 --network=na-br --ip 172.254.253.102 \

    --volume "$PWD/src/tests/${TEST_NAME}/startNetconfAgent.sh:/confd/examples.confd/OC23/startNetconfAgent.sh" \

    --volume "$PWD/src/tests/${TEST_NAME}/platform_r2.xml:/confd/examples.confd/OC23/init_openconfig-platform.xml" \

    asgamb1/flexscale-node.img:latest /confd/examples.confd/OC23/startNetconfAgent.sh

echo

echo "Waiting for initialization..."

echo "-----------------------------"

docker ps -a

sleep 5

docker ps -a

while ! docker logs na-t1 2>&1 | grep -q '*** ConfD OpenConfig NETCONF agent ***'; do sleep 1; done

while ! docker logs na-t2 2>&1 | grep -q '*** ConfD OpenConfig NETCONF agent ***'; do sleep 1; done

while ! docker logs na-r1 2>&1 | grep -q '*** ConfD OpenConfig NETCONF agent ***'; do sleep 1; done

while ! docker logs na-r2 2>&1 | grep -q '*** ConfD OpenConfig NETCONF agent ***'; do sleep 1; done

sleep 2

docker ps -a

echo

echo "Dump Node Agent status:"

echo "-----------------------"

docker ps -a

#docker logs na-t1

#docker logs na-t2

#docker logs na-r1

#docker logs na-r2

#echo

#echo "Post-test clean-up:"

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

#docker rm -f na-t1 na-t2 na-r1 na-r2

#docker network rm na-br

echo "Done!"

#!/bin/bash

# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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.

# ----- TeraFlowSDN ------------------------------------------------------------

# Set the URL of the internal MicroK8s Docker registry where the images will be uploaded to.

export TFS_REGISTRY_IMAGES="http://localhost:32000/tfs/"

# Set the list of components, separated by spaces, you want to build images for, and deploy.

#export TFS_COMPONENTS="context device pathcomp service slice nbi webui load_generator"

export TFS_COMPONENTS="context device pathcomp service slice nbi webui"

# Uncomment to activate Monitoring

#export TFS_COMPONENTS="${TFS_COMPONENTS} monitoring"

# Uncomment to activate BGP-LS Speaker

#export TFS_COMPONENTS="${TFS_COMPONENTS} bgpls_speaker"

# Uncomment to activate Optical Controller

export TFS_COMPONENTS="${TFS_COMPONENTS} opticalcontroller"

# Uncomment to activate ZTP

#export TFS_COMPONENTS="${TFS_COMPONENTS} ztp"

# Uncomment to activate Policy Manager

#export TFS_COMPONENTS="${TFS_COMPONENTS} policy"

# Uncomment to activate Optical CyberSecurity

#export TFS_COMPONENTS="${TFS_COMPONENTS} dbscanserving opticalattackmitigator opticalattackdetector opticalattackmanager"

# Uncomment to activate L3 CyberSecurity

#export TFS_COMPONENTS="${TFS_COMPONENTS} l3_attackmitigator l3_centralizedattackdetector"

# Uncomment to activate TE

#export TFS_COMPONENTS="${TFS_COMPONENTS} te"

# Uncomment to activate Forecaster

#export TFS_COMPONENTS="${TFS_COMPONENTS} forecaster"

# Uncomment to activate E2E Orchestrator

#export TFS_COMPONENTS="${TFS_COMPONENTS} e2e_orchestrator"

# Set the tag you want to use for your images.

export TFS_IMAGE_TAG="dev"

# Set the name of the Kubernetes namespace to deploy TFS to.

export TFS_K8S_NAMESPACE="tfs"

# Set additional manifest files to be applied after the deployment

export TFS_EXTRA_MANIFESTS="manifests/nginx_ingress_http.yaml"

# Uncomment to monitor performance of components

export TFS_EXTRA_MANIFESTS="${TFS_EXTRA_MANIFESTS} manifests/servicemonitors.yaml"

# Uncomment when deploying Optical CyberSecurity

#export TFS_EXTRA_MANIFESTS="${TFS_EXTRA_MANIFESTS} manifests/cachingservice.yaml"

# Set the new Grafana admin password

export TFS_GRAFANA_PASSWORD="admin123+"

# Disable skip-build flag to rebuild the Docker images.

export TFS_SKIP_BUILD=""

# ----- CockroachDB ------------------------------------------------------------

# Set the namespace where CockroackDB will be deployed.

export CRDB_NAMESPACE="crdb"

# Set the external port CockroackDB Postgre SQL interface will be exposed to.

export CRDB_EXT_PORT_SQL="26257"

# Set the external port CockroackDB HTTP Mgmt GUI interface will be exposed to.

export CRDB_EXT_PORT_HTTP="8081"

# Set the database username to be used by Context.

export CRDB_USERNAME="tfs"

# Set the database user's password to be used by Context.

export CRDB_PASSWORD="tfs123"

# Set the database name to be used by Context.

export CRDB_DATABASE="tfs"

# Set CockroachDB installation mode to 'single'. This option is convenient for development and testing.

# See ./deploy/all.sh or ./deploy/crdb.sh for additional details

export CRDB_DEPLOY_MODE="single"

# Disable flag for dropping database, if it exists.

export CRDB_DROP_DATABASE_IF_EXISTS="YES"

# Disable flag for re-deploying CockroachDB from scratch.

export CRDB_REDEPLOY=""

# ----- NATS -------------------------------------------------------------------

# Set the namespace where NATS will be deployed.

export NATS_NAMESPACE="nats"

# Set the external port NATS Client interface will be exposed to.

export NATS_EXT_PORT_CLIENT="4222"

# Set the external port NATS HTTP Mgmt GUI interface will be exposed to.

export NATS_EXT_PORT_HTTP="8222"

# Disable flag for re-deploying NATS from scratch.

export NATS_REDEPLOY=""

# ----- QuestDB ----------------------------------------------------------------

# Set the namespace where QuestDB will be deployed.

export QDB_NAMESPACE="qdb"

# Set the external port QuestDB Postgre SQL interface will be exposed to.

export QDB_EXT_PORT_SQL="8812"

# Set the external port QuestDB Influx Line Protocol interface will be exposed to.

export QDB_EXT_PORT_ILP="9009"

# Set the external port QuestDB HTTP Mgmt GUI interface will be exposed to.

export QDB_EXT_PORT_HTTP="9000"

# Set the database username to be used for QuestDB.

export QDB_USERNAME="admin"

# Set the database user's password to be used for QuestDB.

export QDB_PASSWORD="quest"

# Set the table name to be used by Monitoring for KPIs.

export QDB_TABLE_MONITORING_KPIS="tfs_monitoring_kpis"

# Set the table name to be used by Slice for plotting groups.

export QDB_TABLE_SLICE_GROUPS="tfs_slice_groups"

# Disable flag for dropping tables if they exist.

export QDB_DROP_TABLES_IF_EXIST="YES"

# Disable flag for re-deploying QuestDB from scratch.

export QDB_REDEPLOY=""

# ----- K8s Observability ------------------------------------------------------

# Set the external port Prometheus Mgmt HTTP GUI interface will be exposed to.

export PROM_EXT_PORT_HTTP="9090"

# Set the external port Grafana HTTP Dashboards will be exposed to.

export GRAF_EXT_PORT_HTTP="3000"