Skip to content

opnfv/functest-kubernetes

Repository files navigation

Functest

Network virtualization has dramatically modified our architectures which asks for more automation and powerful testing tools like Functest, a collection of state-of-the-art virtual infrastructure test suites, including automatic VNF testing (cf. [1]).

In context of OPNFV, Functest verifies any kind of OpenStack and Kubernetes deployments including production environments. It conforms to upstream rules and integrates smoothly lots of the test cases available in the opensource market. It includes about 3000+ functional tests and 3 hours upstream API and dataplane benchmarks. It’s completed by Virtual Network Function deployments and testing (vIMS, vRouter and vEPC) to ensure that the platforms meet Network Functions Virtualization requirements. Raspberry PI is also supported to verify datacenters as the lowest cost (50 euros hardware and software included).

Functest releases Kubernetes releases
v1.28 v1.28
v1.29 v1.29
v1.30 v1.30
v1.31 v1.31
Master latest

Prepare your environment

cat env

DEPLOY_SCENARIO=k8s-XXX

Run healthcheck suite

sudo docker run --env-file env \
    -v $(pwd)/config:/home/xtesting/.kube/config \
    opnfv/functest-kubernetes-healthcheck
+-------------------+------------------+---------------------+------------------+----------------+
|     TEST CASE     |     PROJECT      |         TIER        |     DURATION     |     RESULT     |
+-------------------+------------------+---------------------+------------------+----------------+
|     k8s_quick     |     functest     |     healthcheck     |      00:04       |      PASS      |
|     k8s_smoke     |     functest     |     healthcheck     |      00:18       |      PASS      |
+-------------------+------------------+---------------------+------------------+----------------+

Run smoke suite

sudo docker run --env-file env \
    -v $(pwd)/config:/home/xtesting/.kube/config \
    opnfv/functest-kubernetes-smoke
+----------------------------------+------------------+---------------+------------------+----------------+
|            TEST CASE             |     PROJECT      |      TIER     |     DURATION     |     RESULT     |
+----------------------------------+------------------+---------------+------------------+----------------+
|        xrally_kubernetes         |     functest     |     smoke     |      09:32       |      PASS      |
|         k8s_conformance          |     functest     |     smoke     |      13:08       |      PASS      |
|      k8s_conformance_serial      |     functest     |     smoke     |      12:14       |      PASS      |
|        sig_api_machinery         |     functest     |     smoke     |      02:14       |      PASS      |
|     sig_api_machinery_serial     |     functest     |     smoke     |      01:41       |      PASS      |
|             sig_apps             |     functest     |     smoke     |      03:33       |      PASS      |
|         sig_apps_serial          |     functest     |     smoke     |      03:36       |      PASS      |
|             sig_auth             |     functest     |     smoke     |      09:04       |      PASS      |
|      sig_cluster_lifecycle       |     functest     |     smoke     |      00:22       |      PASS      |
|       sig_instrumentation        |     functest     |     smoke     |      00:03       |      PASS      |
|           sig_network            |     functest     |     smoke     |      04:32       |      PASS      |
|             sig_node             |     functest     |     smoke     |      28:56       |      PASS      |
|      sig_scheduling_serial       |     functest     |     smoke     |      05:53       |      PASS      |
|           sig_storage            |     functest     |     smoke     |      19:03       |      PASS      |
|        sig_storage_serial        |     functest     |     smoke     |      01:10       |      PASS      |
+----------------------------------+------------------+---------------+------------------+----------------+

Run security suite

sudo docker run --env-file env \
    -v $(pwd)/config:/home/xtesting/.kube/config \
    opnfv/functest-kubernetes-security
+---------------------------+------------------+------------------+------------------+----------------+
|         TEST CASE         |     PROJECT      |       TIER       |     DURATION     |     RESULT     |
+---------------------------+------------------+------------------+------------------+----------------+
|        kube_hunter        |     functest     |     security     |      00:37       |      PASS      |
|     kube_bench_master     |     functest     |     security     |      00:07       |      PASS      |
|      kube_bench_node      |     functest     |     security     |      00:06       |      PASS      |
+---------------------------+------------------+------------------+------------------+----------------+

Run benchmarking suite

sudo docker run --env-file env \
    -v $(pwd)/config:/home/xtesting/.kube/config \
    opnfv/functest-kubernetes-benchmarking
+--------------------------------+------------------+----------------------+------------------+----------------+
|           TEST CASE            |     PROJECT      |         TIER         |     DURATION     |     RESULT     |
+--------------------------------+------------------+----------------------+------------------+----------------+
|     xrally_kubernetes_full     |     functest     |     benchmarking     |      25:32       |      PASS      |
|            netperf             |     functest     |     benchmarking     |      41:15       |      PASS      |
+--------------------------------+------------------+----------------------+------------------+----------------+

Run cnf suite

sudo docker run --env-file env \
    -v $(pwd)/config:/home/xtesting/.kube/config \
    opnfv/functest-kubernetes-cnf
+--------------------------------+------------------+--------------+------------------+----------------+
|           TEST CASE            |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
+--------------------------------+------------------+--------------+------------------+----------------+
|            k8s_vims            |     functest     |     cnf      |      10:02       |      PASS      |
|           helm_vims            |     functest     |     cnf      |      07:20       |      PASS      |
|         cnf_testsuite          |     functest     |     cnf      |      06:31       |      PASS      |
|     cnf_testsuite_workload     |     functest     |     cnf      |      16:01       |      PASS      |
+--------------------------------+------------------+--------------+------------------+----------------+

Use on air gap environments (no access to Internet)

To test a Kubernetes without access to Internet, repository mirrors needs to be provided.

Currently, all tests supports this feature except cnf conformance.

There's two ways for providing the repository mirrors:

  • Give an environment variable (MIRROR_REPO) which gives a repository with all needed images.
  • Gives an environment variable per needed repo:
    • DOCKERHUB_REPO for DockerHub repository (docker.io)
    • GCR_REPO for Google Cloud repository (gcr.io)
    • K8S_GCR_REPO for Kubernetes repository (k8s.gcr.io)
    • QUAY_REPO for Quay repository (quay.io)

All needed images are given in functest_kubernetes/ci/images.txt

For e2e tests, docker.io is hardcoded. it does mean that you'll have to set up a mirror on docker. An example on how to set it up on docker daemon is provided here: daemon-configuration-file

Check how cloud native your CNFs are

Functest Kubernetes integrates the CNTi Test Catalog which is an open source and vendor neutral tool that can be used to validate a telco application's adherence to cloud native principles and best practices.

Both cnf_testsuite and cnf_testsuite_workload leverages CoreDNS as the target CNF but you're free to validate your own CNFs as the following example.

Download cnf-testsuite.yml and the helm dir to test Envoy

git clone https://github.com/cnti-testcatalog/testsuite.git
mv testsuite/example-cnfs/envoy .
rm -rf testsuite

Write testcases.yaml

cat << EOF > testcases.yaml
---
tiers:
  - name: cnf
    testcases:
      - case_name: cnf_testsuite
        project_name: functest
        blocking: false
        criteria: 15
        run:
          name: cnf_testsuite
          args:
            cnf-config: /src/envoy/cnf-testsuite.yml
            tag: cert
      - case_name: cnf_testsuite_workload
        project_name: functest
        blocking: false
        criteria: 50
        run:
          name: cnf_testsuite
          args:
            cnf-config: /src/envoy/cnf-testsuite.yml
            tag: workload
EOF

Run the CNTi certification and the CNTi workload suite

sudo docker run \
    -v $(pwd)/config:/home/xtesting/.kube/config \
    -v $(pwd)/envoy:/src/envoy \
    -v $(pwd)/testcases.yaml:/etc/xtesting/testcases.yaml \
    opnfv/functest-kubernetes-cnf
+--------------------------------+------------------+--------------+------------------+----------------+
|           TEST CASE            |     PROJECT      |     TIER     |     DURATION     |     RESULT     |
+--------------------------------+------------------+--------------+------------------+----------------+
|         cnf_testsuite          |     functest     |     cnf      |      08:11       |      FAIL      |
|     cnf_testsuite_workload     |     functest     |     cnf      |      16:14       |      PASS      |
+--------------------------------+------------------+--------------+------------------+----------------+

Please note that Envoy as proposed as example fails the CNTi certification which requires passing at least 15 of the 19 total Essential tests. It scores 70% on workload gouping the following test categories: compatibility, state, security, configuration, observability, microservice and resilience.