test/auto-test/README.md

   1 # Overview
   2
   3 The bash scripts in this dir are intended for function test of the Non-RT RIC in different configurations, using simulators when needed for the external interfaces.
   4 A few of the bash scripts are so called 'suites', These suite scripts calls a sequence of the other bash test scripts.
   5
   6 ## Automated test scripts
   7
   8 There are two types of scripts, filenames in the format FTCXXX.sh test one or more components of the Non-RT RIC. Filenames in the format SuiteZZZZ.sh tests a number of FTCXXX.sh script as one suite. (XXX is an integer selected from the categories described further below).
   9 FTC is short for Function Test Case. In addition, there are also other test scripts with other naming format used for demo setup etc (e.g PM_DEMO.sh).
  10
  11 The requirements, in terms of the execution enviroment, to run a script or a suite is to have docker, docker-compose and python3 installed (the scripts warns if not installed). As an option, the scripts can also be executed in a Minikube or Kubernetes installation. The additional requirement is to have a clean minikube/kubernetes installation, perferably with the kube dashboard installed.
  12 The scripts have been tested to work on both MacOS and Ubuntu using docker. They should work also in git-bash on windows (for docker) but only partly verified. Running using minikube has only been verified on Ubuntu and running on kubernetes has been verified on MacOS and Ubuntu. Successful sample tests has been made on google cloud.
  13
  14 ## Configuration
  15
  16 The test scripts uses configuration from a single profile file, found in `../common/test_env-*.sh`, which contains all needed configuration in terms of image names, image tags, ports, file paths, passwords etc. There is one profile file for system (ORAN/ONAP) and release.
  17 If temporary changes are needed to the settings in a profile file, use an override file containing only the variable to override.
  18
  19 ## How to run
  20
  21 A test script, for example FTC1, is executed from the cmd line using the script filename and one or more parameters:
  22
  23  >```./FTC1.sh remote docker --env-file ../common/test_env-oran-cherry.sh```
  24
  25 Note that not is running on a released verion, the parameter "release" shall be included to run the released images.
  26
  27 See the README.md in  `../common/` for all details about available parameters and their meaning.
  28
  29 Each test script prints out the overall result of the tests in the end of the execution.
  30
  31 The test scripts produce quite a number of logs; all container logs, a log of all http/htps calls from the test scripts including the payload, some configuration created during test and also a test case log (same as what is printed on the screen during execution). All these logs are stored in `logs/FTCXXX/`. So each test script is using its own log directory.
  32
  33 To test all components on a very basic level, run the demo test script(s) for the desired release.
  34 Note that oran tests only include components from oran (exception is the onap sdnc).
  35 Note that onap test uses components from onap combined with released oran components available at that onap release (e.g. Honolulu contains onap images from honolulu and oran images from cherry)
  36
  37
  38 ORAN CHERRY
  39 ===========
  40 >```./PM_EI_DEMO.sh remote-remove  docker release   --env-file ../common/test_env-oran-cherry.sh```
  41
  42 >```./PM_EI_DEMO.sh remote-remove  kube  release --env-file ../common/test_env-oran-cherry.sh```
  43
  44 ORAN D-RELEASE
  45 =========
  46 >```./PM_EI_DEMO.sh remote-remove  docker  release  --env-file ../common/test_env-oran-d-release.sh  --use-release-image SDNC```
  47
  48 >```./PM_EI_DEMO.sh remote-remove  kube  release  --env-file ../common/test_env-oran-d-release.sh  --use-release-image SDNC```
  49
  50 ORAN E-RELEASE
  51 =========
  52 >```./PM_EI_DEMO.sh remote-remove  docker  release  --env-file ../common/test_env-oran-e-release.sh```
  53
  54 >```./PM_EI_DEMO.sh remote-remove  kube  release --env-file ../common/test_env-oran-e-release.sh```
  55
  56 ORAN E-RELEASE with nonrtric deployed with helm charts for the "dep" repo
  57 >```../FTC_HELM_E_RELEASE.sh remote-remove  kube  release --env-file ../common/test_env-oran-e-release.sh --override override_ftc_helm_e_release.sh```
  58
  59 ONAP GUILIN
  60 ===========
  61 >```./PM_DEMO.sh remote-remove  docker release   --env-file ../common/test_env-onap-guilin.sh```
  62
  63 >```./PM_DEMO.sh remote-remove  kube  release --env-file ../common/test_env-onap-guilin.sh```
  64
  65 Note that ICS was not available before oran cherry so a test script without ICS is used.
  66
  67 ONAP HONOLULU
  68 =============
  69 >```./PM_EI_DEMO.sh remote-remove  docker release  --env-file ../common/test_env-onap-honolulu.sh```
  70
  71 >```./PM_EI_DEMO.sh remote-remove  kube  release --env-file ../common/test_env-onap-honolulu.sh```
  72
  73 ONAP ISTANBUL
  74 =============
  75 >```./PM_EI_DEMO.sh remote-remove  docker  release  --env-file ../common/test_env-onap-istanbul.sh```
  76
  77 >```./PM_EI_DEMO.sh remote-remove  kube  release  --env-file ../common/test_env-onap-istanbul.sh```
  78
  79
  80 ## Test case categories
  81
  82 The test script are number using these basic categories where 0-999 are releated to the policy managment and 1000-1999 are related to information management. 2000-2999 are for southbound http proxy. There are also demo test cases that test more or less all components. These test scripts does not use the numbering scheme below.
  83
  84 The numbering in each series corresponds to the following groupings
  85 1-99 - Basic sanity tests, PMS
  86
  87 100-199 - API tests, PMS
  88
  89 300-399 - Config changes and sync, PMS
  90
  91 800-899 - Stability and capacity test, PMS
  92
  93 900-999 - Misc test, PMS
  94
  95 11XX - ICS API Tests
  96
  97 18XX - ICS Stability and capacity test
  98
  99 20XX - Southbound http proxy tests
 100
 101 30XX - rApp tests
 102
 103 Suites
 104
 105 To get an overview of the available test scripts, use the following command to print the test script description:
 106 'grep ONELINE *.sh' in the dir of the test scripts.
 107
 108 ## Test case file - template
 109
 110 A test script contains a number of steps to verify a certain functionality.
 111 The empty template for a test case file looks like this.
 112 Only the parts noted with < and > shall be changed.
 113 It is strongly suggested to look at the existing test scripts, it is probably easier to copy an existing test script instead of creating one from scratch. The README.md in  `../common/` describes the functions available in the test script in detail.
 114
 115 -----------------------------------------------------------
 116
 117 ```
 118 #!/bin/bash
 119
 120 TC_ONELINE_DESCR="<test case description>"
 121
 122 DOCKER_INCLUDED_IMAGES=<list of used apps in this test case - for docker>
 123
 124 KUBE_INCLUDED_IMAGES=<list of used apps (started by the script) in this test case - for kube>
 125 KUBE_PRESTARTED_IMAGES=<list of used apps (prestarte - i.e. not started by the script) in this test case - for kube>
 126
 127 SUPPORTED_PROFILES=<list of supported profile names>
 128
 129 SUPPORTED_RUNMODES=<List of runmodes, DOCKER and/or KUBE>
 130
 131 CONDITIONALLY_IGNORED_IMAGES=<list of images to exclude if it does not exist in the profile file>
 132
 133 . ../common/testcase_common.sh $@
 134
 135 setup_testenvironment
 136
 137 #### TEST BEGIN ####
 138
 139
 140 <tests here>
 141
 142
 143 #### TEST COMPLETE ####
 144
 145 print_result
 146
 147 store_logs          END
 148
 149 ```
 150
 151 -----------------------------------------------------------
 152
 153 ## License
 154
 155 Copyright (C) 2020 Nordix Foundation. All rights reserved.
 156 Licensed under the Apache License, Version 2.0 (the "License");
 157 you may not use this file except in compliance with the License.
 158 You may obtain a copy of the License at
 159
 160      http://www.apache.org/licenses/LICENSE-2.0
 161
 162 Unless required by applicable law or agreed to in writing, software
 163 distributed under the License is distributed on an "AS IS" BASIS,
 164 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 165 See the License for the specific language governing permissions and
 166 limitations under the License.