--- /dev/null
+<!--
+Copyright 2020 ETSI OSM
+
+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
+-->
+
+# Guide to SOL005 integration into OSM's existing CI/CD pipeline
+## Add tests to test selection files
+### Locate the correct test selection file
+
+The test selection files are located in `/conformance-tests/test-lists/`. Each API has its own test selection file of the same name (i.e. NSDManagement-API.txt for NSDManagement-API).
+
+### Test selection files
+Each test selection file has the following format
+```git l
+-t [Test name]
+--variable [varName:value]
+```
+For example
+```
+-t PATCH NSD Content - Method not implemented
+-t DELETE NSD Content - Method not implemented
+--variable nsdInfoId:$NSD_INFO_ID
+--variable nsdInfoIdPlain:$NSD_INFO_ID
+```
+For values which need to be created dynamically (like resource IDs), use environment variables (see below).
+## Add resource management code
+### Resource creation
+The test management code resides in `/conformance-tests/run_conformance_tests.py`.
+Using the osm client, create the relevant resources and assign the required values to environment variables (using the `os.environ` dictionary).
+
+### Env variable subbing
+The code then replaces the environment variables referred to in the test selection files using the `envsubst` unix command).
+
+### Resource clearing
+Don't forget to clear all created resources at the end of the testing!
+
+## Reports
+The reports are located in `/conformance-tests/reports/{API_NAME}/*`.
\ No newline at end of file
--- /dev/null
+# Copyright 2020 ETSI OSM
+#
+# 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 subprocess import run, PIPE
+import requests
+
+class OSMException(Exception):
+ """A base class for MyProject exceptions."""
+
+class ResourceException(OSMException):
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args)
+ self.message = kwargs.get('message')
+
+class OSM:
+ def __init__(self, osm_hostname):
+ self.osm_hostname = osm_hostname
+
+ def run_command(self, command):
+ p = run(["osm {}".format(command)], shell=True, stdout=PIPE, stderr=PIPE)
+ if p.returncode != 0:
+ print(p.stdout)
+ print(p.stderr)
+ raise ResourceException(message=p.stdout)
+ else:
+ return self.clean_output(p.stdout)
+
+ def get_auth_token(self):
+ r = requests.post("https://{}:9999/osm/admin/v1/tokens".format(self.osm_hostname), verify=False, headers={"Accept":"application/json"}, json={
+ "username": "admin",
+ "password": "admin",
+ "project": "admin"
+ })
+ return r.json()["id"]
+
+ def clean_output(self, output):
+ return output.decode("utf-8").strip()
+
+ def create_nsd(self, filename):
+ return self.run_command("nsd-create {}".format(filename))
+
+ def create_vnfd(self, filename):
+ return self.run_command("vnfd-create {}".format(filename))
+
+ def delete_nsd(self, id):
+ return self.run_command("nsd-delete {}".format(id))
+
+ def delete_vnfd(self, id):
+ return self.run_command("vnfd-delete {}".format(id))
\ No newline at end of file
--- /dev/null
+# Copyright 2020 ETSI OSM
+#
+# 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 os
+from shutil import copy
+from subprocess import run
+from osm_client import *
+
+packages_folder = os.environ["PACKAGES_FOLDER"]
+conformance_folder = "{}/{}".format(os.environ["ROBOT_DEVOPS_FOLDER"], "conformance-tests")
+test_lists_folder = "{}/{}".format(conformance_folder, "test-lists")
+sol005_folder = "{}/repo/SOL005".format(conformance_folder)
+osm_hostname = os.environ["OSM_HOSTNAME"]
+
+
+def get_package_path(package_name):
+ return "{}/{}".format(packages_folder, package_name)
+
+
+def get_suite_path(suite_name):
+ return "{}/repo/SOL005/{}".format(conformance_folder, suite_name)
+
+
+def run_test_suite(suite_dir, suite_name, arg_file):
+ print("robot -d {}/repo/{}/reports --argumentfile {} .".format(conformance_folder, suite_name, arg_file))
+ run(["robot --loglevel=TRACE -d {}/reports/{} --argumentfile {} .".format(conformance_folder,
+ suite_name, arg_file)], cwd=suite_dir, shell=True)
+
+
+def sub_env_vars(file_dir, file_name):
+ run(["envsubst < {0} > {0}".format(file_name)], cwd=file_dir, shell=True)
+
+
+# RESOURCE CREATION HAPPENS BELOW
+nsd_id, vnfd_id = "", ""
+
+osm = OSM(osm_hostname)
+
+os.environ["AUTH_TOKEN"] = osm.get_auth_token()
+
+try:
+ vnfd_id = osm.create_vnfd(get_package_path("hackfest_basic_vnf/hackfest_basic_vnfd.yaml"))
+ nsd_id = osm.create_nsd(get_package_path("hackfest_basic_ns/hackfest_basic_nsd.yaml"))
+except ResourceException as e:
+ print(e.message)
+
+print("VNFD: {}\nNSD: {}".format(vnfd_id, nsd_id))
+# Apply relevant env variables (required for test vars)
+os.environ["NSD_INFO_ID"] = nsd_id
+
+# RESOURCE CREATION HAPPENS ABOVE
+
+# Copy test selection files over to relevant directories
+(_, _, filenames) = next(os.walk(test_lists_folder))
+for f in filenames:
+ if f.endswith(".txt"):
+ # Apply ENV Variables
+ sub_env_vars(test_lists_folder, f)
+
+ # Then copy to appropriate directory
+ print("Copying {} to {}".format(f, get_suite_path(f.split(".")[0])))
+ copy("{}/{}".format(test_lists_folder, f), get_suite_path(f.split(".")[0]))
+
+
+# Run the robot tests
+(_, directories, _) = next(os.walk(sol005_folder))
+for d in directories:
+ run_test_suite("{}/{}".format(sol005_folder, d), d, d + ".txt")
+
+# We then need to clear the created resources
+try:
+ osm.delete_nsd(nsd_id)
+ osm.delete_vnfd(vnfd_id)
+except ResourceException as e:
+ print("Deletion failed: {}".format(e.message))
+
+print("Cleared resources")
--- /dev/null
+# Copyright 2020 ETSI OSM
+#
+# 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
+
+-t GET Individual Network Service Descriptor Information with invalid resource identifier
+-t Disable Individual Network Service Descriptor
+-t Enable Individual Network Service Descriptor
+-t Enable Individual Network Service Descriptor with conflict due to operational state ENABLED
+# -t DELETE Individual Network Service Descriptor in operational state ENABLED
+-t POST Individual Network Service Descriptor - Method not implemented
+-t PUT Individual Network Service Descriptor - Method not implemented
+-t Get single file NSD Content in Plain Format
+-t Get NSD Content in Zip Format
+-t Get single file NSD Content in Plain or Zip Format
+-t Get multi file NSD Content in Plain or Zip Format
+-t Get multi file NSD Content in Plain Format
+-t Get NSD Content with invalid resource identifier
+-t Get NSD Content with conflict due to onboarding state
+-t GET NSD Content with Range Request and NFVO not supporting Range Requests
+-t Upload NSD Content as Zip file in synchronous mode
+-t Upload NSD Content as plain text file in synchronous mode
+-t POST NSD Content - Method not implemented
+-t PATCH NSD Content - Method not implemented
+-t DELETE NSD Content - Method not implemented
+--variable nsdInfoId:$NSD_INFO_ID
+--variable nsdInfoIdPlain:$NSD_INFO_ID
+
+--variable NFVO_HOST:$OSM_HOSTNAME
+--variable NFVO_PORT:9999
+--variable apiRoot:/osm/
+--variable AUTHORIZATION:Bearer $AUTH_TOKEN
\ No newline at end of file
--- /dev/null
+# Copyright 2020 ETSI OSM
+#
+# 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
+
+-t NS Fault Alarm Notification
\ No newline at end of file
--- /dev/null
+# Copyright 2020 ETSI OSM
+#
+# 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
+
+-t POST Cancel operation task
\ No newline at end of file
--- /dev/null
+# Copyright 2020 ETSI OSM
+#
+# 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
+
+-t Get Individual Performance Report
\ No newline at end of file
--- /dev/null
+# Copyright 2020 ETSI OSM
+#
+# 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
+
+-t GET Individual VNF Package Artifact
\ No newline at end of file
COPY robot-systest /robot-systest
COPY charm.sh /usr/sbin/charm
+# Copy conformance tests data
+COPY conformance-tests /robot-systest/conformance-tests
+
# Folder where Robot tests are stored
ENV ROBOT_DEVOPS_FOLDER=/robot-systest
# NS and VNF descriptor package files
vnfd_pkg1 = 'charm-packages/nscharm_policy_vnf'
vnfd_pkg2 = 'charm-packages/nscharm_user_vnf'
-nsd_pkg = 'charm-packages/nscharm_ns'
+nsd_pkg = 'charm-packages/native_charm_ns'
# NSD and VNFD names in OSM
vnfd_name1 = 'nscharm-policy-vnf'
vnfd_name2 = 'nscharm-user-vnf'
nsd_name = 'nscharm-ns'
# NS Descriptor file
-nsd_file = 'nscharm_nsd.yaml'
+nsd_file = 'native_charm_nsd.yaml'
# NS instance name
ns_name = 'test_nscharm'
# SSH keys to be used
git checkout ${PACKAGES})
}
+download_tst010(){
+ # Fetch conformance tests
+ git clone --single-branch --branch ${NFV_TESTS_BRANCH} https://forge.etsi.org/rep/nfv/api-tests.git /robot-systest/conformance-tests/repo
+ python3 -m pip install -r /robot-systest/conformance-tests/repo/requirements.txt
+}
+
create_vim(){
attempts=3
((i++))
if [[ $i -eq 5 ]]; then
echo "VIM stuck in PROCESSING after 50 seconds"
- osm vim-delete ${VIM_TARGET}
+ osm vim-delete --force ${VIM_TARGET}
sleep 5
break
fi
PARAMS=""
+RUN_CONFORMANCE_TESTS=false
while (( "$#" )); do
case "$1" in
create_vim
shift 1
;;
+ -T)
+ NFV_TESTS_BRANCH=$2 && download_tst010
+ RUN_CONFORMANCE_TESTS=true
+ shift 1
+ ;;
-h|--help)
echo "OSM TESTS TOOL
-o <osmclient_version> [OPTIONAL]: It is used to specify a particular osmclient version. Default: latest
-p <package_branch> [OPTIONAL]: OSM packages repository branch. Default: master
-t <testing_tags> [OPTIONAL]: Robot tests tags. [sanity, regression, particular_test]. Default: sanity
+ -T <testing_branch> [OPTIONAL]: Run SOL005 Robot conformance tests
-c To create a VIM for the tests
Volumes:
OSMCLIENT=$BRANCH_NAME && install_osmclient
fi
+
+if [ "$RUN_CONFORMANCE_TESTS" = true ] ; then
+ python3 ${ROBOT_DEVOPS_FOLDER}/conformance-tests/run_conformance_tests.py
+fi
+
if [[ -z "${TEST}" ]]; then
printf "Test not provided. \nRunning default test: sanity\n"
TEST="sanity"
projects / osm / tests.git / commitdiff