Merge "Test env updates"
[nonrtric.git] / test / usecases / linkfailure / README.md
1 # Use case Link Failure
2 # General
3
4 The Link Failure use case test provides a python script that regularly polls DMaaP Message Router (MR) for "CUS Link Failure"
5 messages.
6
7 When such a message appears with the "eventSeverity" set to "CRITICAL" a configuration change message with the
8 "administrative-state" set to "UNLOCKED" will be sent to the O-DU mapped to the O-RU that sent the alarm.
9
10 When such a message appears with the "eventSeverity" set to "NORMAL" a printout will be made to signal that the
11 alarm has been cleared, provided that the verbose option has been used when the test was started.
12
13 # Prerequisits
14 To run this script Python3 needs to be installed. To install the script's dependencies, run the following command from
15 the `app` folder: `pip install -r requirements.txt`
16
17 Also, the MR needs to be up and running with a topic created for the alarms and there must be an endpoint for the
18 configuration change event that will accept these.
19
20 For convenience, a message generator and a change event endpoint simulator are provided.
21
22 # How to run
23 Go to the `app/` folder and run `python3 main.py`. The script will start and run until stopped. Use the `-h` option to
24 see the options available for the script.
25
26
27 ## License
28
29 Copyright (C) 2021 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.