E2Manager/converters/x2_setup_failure_response_converter_test.go

   1 /*
   2  *   Copyright (c) 2019 AT&T Intellectual Property.
   3  *
   4  *   Licensed under the Apache License, Version 2.0 (the "License");
   5  *   you may not use this file except in compliance with the License.
   6  *   You may obtain a copy of the License at
   7  *
   8  *       http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *   Unless required by applicable law or agreed to in writing, software
  11  *   distributed under the License is distributed on an "AS IS" BASIS,
  12  *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *   See the License for the specific language governing permissions and
  14  *   limitations under the License.
  15  */
  16
  17 /*
  18  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
  19  * platform project (RICP).
  20  */
  21
  22 package converters
  23
  24 import (
  25         "e2mgr/logger"
  26         "fmt"
  27         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  28         "strings"
  29         "testing"
  30 )
  31
  32 /*
  33 Test permutations of x2 setup response to protobuf enb
  34 */
  35
  36 func TestUnpackX2SetupFailureResponseAndExtract(t *testing.T) {
  37         logger, _ := logger.InitLogger(logger.InfoLevel)
  38
  39         var testCases = []struct {
  40                 response  string
  41                 packedPdu string
  42                 failure   error
  43         }{
  44                 {
  45                         response: "CONNECTED_SETUP_FAILED network_layer_cause:HANDOVER_DESIRABLE_FOR_RADIO_REASONS time_to_wait:V1S criticality_diagnostics:<procedure_code:33 triggering_message:UNSUCCESSFUL_OUTCOME procedure_criticality:NOTIFY information_element_criticality_diagnostics:<ie_criticality:REJECT ie_id:128 type_of_error:MISSING > > ",
  46                         /*
  47                                 E2AP-PDU:
  48                                  unsuccessfulOutcome_t
  49                                   procedureCode_t = 0x6
  50                                   criticality_t = 0
  51                                   X2SetupFailure
  52                                    protocolIEs_t:
  53                                     ProtocolIE_Container_elm
  54                                      id_t = 0x5
  55                                      criticality_t = 0x1
  56                                      Cause:
  57                                       radioNetwork_t = 0
  58                                     ProtocolIE_Container_elm
  59                                      id_t = 0x16
  60                                      criticality_t = 0x1
  61                                      TimeToWait = 0
  62                                     ProtocolIE_Container_elm
  63                                      id_t = 0x11
  64                                      criticality_t = 0x1
  65                                      CriticalityDiagnostics
  66                                       procedureCode_t = 0x21
  67                                       triggeringMessage_t = 0x2
  68                                       procedureCriticality_t = 0x2
  69                                       iEsCriticalityDiagnostics_t:
  70                                        CriticalityDiagnostics_IE_List_elm
  71                                         iECriticality_t = 0
  72                                         iE_ID_t = 0x80
  73                                         typeOfError_t = 0x1
  74                         */
  75                         packedPdu: "4006001a0000030005400200000016400100001140087821a00000008040"},
  76                 {
  77                         response: "CONNECTED_SETUP_FAILED transport_layer_cause:TRANSPORT_RESOURCE_UNAVAILABLE criticality_diagnostics:<procedure_code:33 triggering_message:UNSUCCESSFUL_OUTCOME procedure_criticality:NOTIFY information_element_criticality_diagnostics:<ie_criticality:REJECT ie_id:128 type_of_error:MISSING > > ",
  78                         /*
  79                                 E2AP-PDU:
  80                                  unsuccessfulOutcome_t
  81                                   procedureCode_t = 0x6
  82                                   criticality_t = 0
  83                                   X2SetupFailure
  84                                    protocolIEs_t:
  85                                     ProtocolIE_Container_elm
  86                                      id_t = 0x5
  87                                      criticality_t = 0x1
  88                                      Cause:
  89                                       transport_t = 0
  90                                     ProtocolIE_Container_elm
  91                                      id_t = 0x11
  92                                      criticality_t = 0x1
  93                                      CriticalityDiagnostics
  94                                       procedureCode_t = 0x21
  95                                       triggeringMessage_t = 0x2
  96                                       procedureCriticality_t = 0x2
  97                                       iEsCriticalityDiagnostics_t:
  98                                        CriticalityDiagnostics_IE_List_elm
  99                                         iECriticality_t = 0
 100                                         iE_ID_t = 0x80
 101                                         typeOfError_t = 0x1
 102                         */
 103                         packedPdu: "400600140000020005400120001140087821a00000008040"},
 104                 {
 105                         response: "CONNECTED_SETUP_FAILED protocol_cause:ABSTRACT_SYNTAX_ERROR_IGNORE_AND_NOTIFY criticality_diagnostics:<triggering_message:UNSUCCESSFUL_OUTCOME procedure_criticality:NOTIFY information_element_criticality_diagnostics:<ie_criticality:REJECT ie_id:128 type_of_error:MISSING > > ",
 106                         /*
 107                                 E2AP-PDU:
 108                                  unsuccessfulOutcome_t
 109                                   procedureCode_t = 0x6
 110                                   criticality_t = 0
 111                                   X2SetupFailure
 112                                    protocolIEs_t:
 113                                     ProtocolIE_Container_elm
 114                                      id_t = 0x5
 115                                      criticality_t = 0x1
 116                                      Cause:
 117                                       protocol_t = 0x2
 118                                     ProtocolIE_Container_elm
 119                                      id_t = 0x11
 120                                      criticality_t = 0x1
 121                                      CriticalityDiagnostics
 122                                       triggeringMessage_t = 0x2
 123                                       procedureCriticality_t = 0x2
 124                                       iEsCriticalityDiagnostics_t:
 125                                        CriticalityDiagnostics_IE_List_elm
 126                                         iECriticality_t = 0
 127                                         iE_ID_t = 0x80
 128                                         typeOfError_t = 0x1
 129                         */
 130                         packedPdu: "400600130000020005400144001140073a800000008040"},
 131
 132                 {
 133                         response: "CONNECTED_SETUP_FAILED miscellaneous_cause:UNSPECIFIED criticality_diagnostics:<procedure_criticality:NOTIFY information_element_criticality_diagnostics:<ie_criticality:REJECT ie_id:128 type_of_error:MISSING > > ",
 134                         /*
 135                                 E2AP-PDU:
 136                                  unsuccessfulOutcome_t
 137                                   procedureCode_t = 0x6
 138                                   criticality_t = 0
 139                                   X2SetupFailure
 140                                    protocolIEs_t:
 141                                     ProtocolIE_Container_elm
 142                                      id_t = 0x5
 143                                      criticality_t = 0x1
 144                                      Cause:
 145                                       misc_t = 0x4
 146                                     ProtocolIE_Container_elm
 147                                      id_t = 0x11
 148                                      criticality_t = 0x1
 149                                      CriticalityDiagnostics
 150                                       procedureCriticality_t = 0x2
 151                                       iEsCriticalityDiagnostics_t:
 152                                        CriticalityDiagnostics_IE_List_elm
 153                                         iECriticality_t = 0
 154                                         iE_ID_t = 0x80
 155                                         typeOfError_t = 0x1
 156                         */
 157                         packedPdu: "400600120000020005400168001140061a0000008040"},
 158
 159                 {
 160                         response: "CONNECTED_SETUP_FAILED miscellaneous_cause:UNSPECIFIED criticality_diagnostics:<information_element_criticality_diagnostics:<ie_criticality:REJECT ie_id:128 type_of_error:MISSING > information_element_criticality_diagnostics:<ie_criticality:NOTIFY ie_id:255 type_of_error:NOT_UNDERSTOOD > > ",
 161                         /*
 162                                 E2AP-PDU:
 163                                  unsuccessfulOutcome_t
 164                                   procedureCode_t = 0x6
 165                                   criticality_t = 0
 166                                   X2SetupFailure
 167                                    protocolIEs_t:
 168                                     ProtocolIE_Container_elm
 169                                      id_t = 0x5
 170                                      criticality_t = 0x1
 171                                      Cause:
 172                                       misc_t = 0x4
 173                                     ProtocolIE_Container_elm
 174                                      id_t = 0x11
 175                                      criticality_t = 0x1
 176                                      CriticalityDiagnostics
 177                                       iEsCriticalityDiagnostics_t:
 178                                        CriticalityDiagnostics_IE_List_elm
 179                                         iECriticality_t = 0
 180                                         iE_ID_t = 0x80
 181                                         typeOfError_t = 0x1
 182                                        CriticalityDiagnostics_IE_List_elm
 183                                         iECriticality_t = 0x2
 184                                         iE_ID_t = 0xff
 185                                         typeOfError_t = 0
 186                         */
 187                         packedPdu: "4006001500000200054001680011400908010000804800ff00"},
 188
 189
 190                 {
 191                         response: "CONNECTED_SETUP_FAILED miscellaneous_cause:UNSPECIFIED criticality_diagnostics:<procedure_code:33 > ",
 192                         /*
 193                                 E2AP-PDU:
 194                                  unsuccessfulOutcome_t
 195                                   procedureCode_t = 0x6
 196                                   criticality_t = 0
 197                                   X2SetupFailure
 198                                    protocolIEs_t:
 199                                     ProtocolIE_Container_elm
 200                                      id_t = 0x5
 201                                      criticality_t = 0x1
 202                                      Cause:
 203                                       misc_t = 0x4
 204                                     ProtocolIE_Container_elm
 205                                      id_t = 0x11
 206                                      criticality_t = 0x1
 207                                      CriticalityDiagnostics
 208                                       procedureCode_t = 0x21
 209                         */
 210                         packedPdu: "4006000e0000020005400168001140024021"},
 211
 212                 {
 213                         response: "CONNECTED_SETUP_FAILED miscellaneous_cause:UNSPECIFIED ",
 214                         /*
 215                                 E2AP-PDU:
 216                                  unsuccessfulOutcome_t
 217                                   procedureCode_t = 0x6
 218                                   criticality_t = 0
 219                                   X2SetupFailure
 220                                    protocolIEs_t:
 221                                     ProtocolIE_Container_elm
 222                                      id_t = 0x5
 223                                      criticality_t = 0x1
 224                                      Cause:
 225                                       misc_t = 0x4
 226                         */
 227                         packedPdu: "400600080000010005400168"},
 228                 {
 229                         response: "CONNECTED_SETUP_FAILED network_layer_cause:HANDOVER_DESIRABLE_FOR_RADIO_REASONS time_to_wait:V1S criticality_diagnostics:<procedure_code:33 triggering_message:UNSUCCESSFUL_OUTCOME procedure_criticality:NOTIFY information_element_criticality_diagnostics:<ie_criticality:REJECT ie_id:128 type_of_error:MISSING > > ",
 230                         /*
 231                                 E2AP-PDU:
 232                                  unsuccessfulOutcome_t
 233                                   procedureCode_t = 0x6
 234                                   criticality_t = 0
 235                                   X2SetupFailure
 236                                    protocolIEs_t:
 237                                     ProtocolIE_Container_elm
 238                                      id_t = 0x5
 239                                      criticality_t = 0x1
 240                                      Cause:
 241                                       radioNetwork_t = 0
 242                                     ProtocolIE_Container_elm
 243                                      id_t = 0x16
 244                                      criticality_t = 0x1
 245                                      TimeToWait = 0
 246                                     ProtocolIE_Container_elm
 247                                      id_t = 0x11
 248                                      criticality_t = 0x1
 249                                      CriticalityDiagnostics
 250                                       procedureCode_t = 0x21
 251                                       triggeringMessage_t = 0x2
 252                                       procedureCriticality_t = 0x2
 253                                       iEsCriticalityDiagnostics_t:
 254                                        CriticalityDiagnostics_IE_List_elm
 255                                         iECriticality_t = 0
 256                                         iE_ID_t = 0x80
 257                                         typeOfError_t = 0x1
 258                         */
 259                         packedPdu: "4006001a0000030005400200000016400100001140087821a00000008040",
 260                         //failure: fmt.Errorf("getAtom for path [unsuccessfulOutcome_t X2SetupFailure protocolIEs_t ProtocolIE_Container_elm Cause radioNetwork_t] failed, rc = 2" /*NO_SPACE_LEFT*/),
 261                 },
 262         }
 263
 264         converter := NewX2SetupFailureResponseConverter(logger)
 265
 266         for _, tc := range testCases {
 267                 t.Run(tc.packedPdu, func(t *testing.T) {
 268
 269                         var payload []byte
 270                         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 271                         if err != nil {
 272                                 t.Errorf("convert inputPayloadAsStr to payloadAsByte. Error: %v\n", err)
 273                         }
 274
 275                         response, err := converter.UnpackX2SetupFailureResponseAndExtract(payload)
 276
 277                         if err != nil {
 278                                 if tc.failure == nil {
 279                                         t.Errorf("want: success, got: error: %v\n", err)
 280                                 } else {
 281                                         if strings.Compare(err.Error(), tc.failure.Error()) != 0 {
 282                                                 t.Errorf("want: %s, got: %s", tc.failure, err)
 283                                         }
 284                                 }
 285                         }
 286
 287                         if response == nil {
 288                                 if tc.failure == nil {
 289                                         t.Errorf("want: response=%s, got: empty response", tc.response)
 290                                 }
 291                         } else {
 292                                 nb := &entities.NodebInfo{}
 293                                 nb.ConnectionStatus = entities.ConnectionStatus_CONNECTED_SETUP_FAILED
 294                                 nb.SetupFailure = response
 295                                 nb.FailureType = entities.Failure_X2_SETUP_FAILURE
 296                                 respStr := fmt.Sprintf("%s %s", nb.ConnectionStatus, response)
 297                                 if !strings.EqualFold(respStr, tc.response) {
 298                                         t.Errorf("want: response=[%s], got: [%s]", tc.response, respStr)
 299                                 }
 300
 301                         }
 302                 })
 303         }
 304 }