test/usecases/healthcheck/README.md

   1 # Use case Health Check test
   2
   3 ## General
   4
   5 The Health Check use case test provides a python script that regularly creates, reads, updates, and deletes a policy
   6 in all Near-RT RICs that support the type used by the script. A self refreshing web page provides a view of statistics
   7 for these regular checks.
   8
   9 ## Prerequisits
  10
  11 To run this script Python3 needs to be installed. To install the script's dependencies, run the following command from
  12 the `src` folder: `pip install -r requirements.txt`
  13
  14 ## How to run
  15
  16 Go to the `src/` folder and run `python3 main.py`. The script will start and run until stopped. Use the `-h` option to
  17 see the options available for the script.
  18
  19 As default, the script uses the "Hello World" policy type with ID "2". To create the instances it uses the body file
  20 `nonrtric/test/autotest/testdata/OSC/pihw_template.json`. The body file contains the string "XXX" as a parameter value.
  21 This string vill be replaced with dynamic data during creation. It is possible to provide a custom policy type and
  22 body file to the script at startup.
  23
  24 To see the web page, navigate to `localhost:9990/stats`. The page refreshes itself with the same interval as the script
  25 uses.
  26
  27 ## License
  28
  29 Copyright (C) 2020 Nordix Foundation.
  30 Licensed under the Apache License, Version 2.0 (the "License")
  31 you may not use this file except in compliance with the License.
  32 You may obtain a copy of the License at
  33
  34       http://www.apache.org/licenses/LICENSE-2.0
  35
  36 Unless required by applicable law or agreed to in writing, software
  37 distributed under the License is distributed on an "AS IS" BASIS,
  38 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  39 See the License for the specific language governing permissions and
  40 limitations under the License.
  41
  42 For more information about license please see the [LICENSE](LICENSE.txt) file for details.