test/auto-test/README.md

   1 ## Overview
   2 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.
   3 A few of the bash scripts are so called 'suites', These suite scripts calls a sequence of the other bash scripts.
   4
   5 ## Automated test scripts
   6 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).
   7 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).
   8
   9 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.
  10 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 only been verified on MacOS.
  11
  12 ## Configuration
  13 The test scripts uses configuration from a single file, found in `../common/test_env.sh`, which contains all needed configuration in terms of image names, image tags, ports, file paths, passwords etc. This file can be modified if needed.  See the README.md in  `../common/` for all details of the config file.
  14
  15 ## How to run
  16 A test script, for example FTC1, is executed from the cmd line using the script filename and one or more parameters:
  17
  18  ./FTC1.sh remote docker --env-file ../common/test_env-oran-cherry.sh
  19
  20 Note that not is running on a released verion, the parameter "release" shall be included to run the released images.
  21
  22 See the README.md in  `../common/` for all details about available parameters and their meaning.
  23
  24 Each test script prints out the overall result of the tests in the end of the execution.
  25
  26 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.
  27
  28 To test all components on a very basic level, run the demo test script(s) for the desired release.
  29 Note that oran tests only include components from oran.
  30 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)
  31 ```
  32 ORAN CHERRY
  33 ===========
  34 ./PM_EI_DEMO.sh remote-remove  docker release   --env-file ../common/test_env-oran-cherry.sh
  35 ./PM_EI_DEMO.sh remote-remove  kube  release --env-file ../common/test_env-oran-cherry.sh
  36
  37 ORAN D-RELEASE
  38 =========
  39 ./PM_EI_DEMO.sh remote-remove  docker   --env-file ../common/test_env-oran-d-release.sh  --use-release-image SDNC
  40 ./PM_EI_DEMO.sh remote-remove  kube   --env-file ../common/test_env-oran-d-release.sh  --use-release-image SDNC
  41 Note that D-Release has not updated the SDNC so cherry release is used
  42 Note: When D-Release is released, add the 'release' arg to run released images.
  43
  44 ONAP GUILIN
  45 ===========
  46 ./PM_DEMO.sh remote-remove  docker release   --env-file ../common/test_env-onap-guilin.sh
  47 ./PM_DEMO.sh remote-remove  kube  release --env-file ../common/test_env-onap-guilin.sh
  48 Note that ECS was not available before oran cherry so a test script without ECS is used.
  49
  50 ONAP HONOLULU
  51 =============
  52 ./PM_EI_DEMO.sh remote-remove  docker release  --env-file ../common/test_env-onap-honolulu.sh
  53 ./PM_EI_DEMO.sh remote-remove  kube  release --env-file ../common/test_env-onap-honolulu.sh
  54
  55 ONAP ISTANBUL
  56 =============
  57 ./PM_EI_DEMO.sh remote-remove  docker   --env-file ../common/test_env-onap-istanbul.sh
  58 ./PM_EI_DEMO.sh remote-remove  kube   --env-file ../common/test_env-onap-istanbul.sh
  59 Note: When istanbul is released, add the 'release' arg to run released images.
  60 ```
  61 ## Test case categories
  62 The test script are number using these basic categories where 0-999 are releated to the policy managment and 1000-1999 are related to enrichment 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.
  63
  64 The numbering in each series corresponds to the following groupings
  65 1-99 - Basic sanity tests
  66
  67 100-199 - API tests
  68
  69 300-399 - Config changes and sync
  70
  71 800-899 - Stability and capacity test
  72
  73 900-999 - Misc test
  74
  75 Suites
  76
  77 To get an overview of the available test scripts, use the following command to print the test script description:
  78 'grep ONELINE *.sh' in the dir of the test scripts.
  79
  80 ## Test case file - template
  81 A test script contains a number of steps to verify a certain functionality.
  82 The empty template for a test case file looks like this.
  83 Only the parts noted with < and > shall be changed.
  84 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.
  85
  86 -----------------------------------------------------------
  87 ```
  88 #!/bin/bash
  89
  90 TC_ONELINE_DESCR="<test case description>"
  91
  92 DOCKER_INCLUDED_IMAGES=<list of used apps in this test case - for docker>
  93
  94 KUBE_INCLUDED_IMAGES=<list of used apps (started by the script) in this test case - for kube>
  95 KUBE_PRESTARTED_IMAGES=<list of used apps (prestartedd - i.e. not started by the script) in this test case - for kube>
  96
  97 SUPPORTED_PROFILES=<list of supported profile names>
  98
  99 SUPPORTED_RUNMODES=<List of runmodes, DOCKER and/or KUBE>
 100
 101 CONDITIONALLY_IGNORED_IMAGES=<list of images to exclude if it does not exist in the profile file>
 102
 103 . ../common/testcase_common.sh  $@
 104 < other scripts need to be sourced for specific interfaces>
 105
 106 setup_testenvironment
 107
 108 #### TEST BEGIN ####
 109
 110
 111 <tests here>
 112
 113
 114 #### TEST COMPLETE ####
 115
 116 store_logs          END
 117
 118 ```
 119 -----------------------------------------------------------
 120
 121
 122 ## License
 123
 124 Copyright (C) 2020 Nordix Foundation. All rights reserved.
 125 Licensed under the Apache License, Version 2.0 (the "License");
 126 you may not use this file except in compliance with the License.
 127 You may obtain a copy of the License at
 128
 129      http://www.apache.org/licenses/LICENSE-2.0
 130
 131 Unless required by applicable law or agreed to in writing, software
 132 distributed under the License is distributed on an "AS IS" BASIS,
 133 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 134 See the License for the specific language governing permissions and
 135 limitations under the License.