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         "regexp"
  29         "strings"
  30         "testing"
  31 )
  32
  33 /*
  34 Test permutations of x2 setup response to protobuf enb
  35 */
  36
  37 func TestUnpackX2SetupFailureResponseAndExtract(t *testing.T) {
  38         InfoLevel := int8(3)
  39         logger, _ := logger.InitLogger(InfoLevel)
  40
  41         var testCases = []struct {
  42                 response  string
  43                 packedPdu string
  44                 failure   error
  45         }{
  46                 {
  47                         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}}",
  48                         /*
  49                                 E2AP-PDU:
  50                                  unsuccessfulOutcome_t
  51                                   procedureCode_t = 0x6
  52                                   criticality_t = 0
  53                                   X2SetupFailure
  54                                    protocolIEs_t:
  55                                     ProtocolIE_Container_elm
  56                                      id_t = 0x5
  57                                      criticality_t = 0x1
  58                                      Cause:
  59                                       radioNetwork_t = 0
  60                                     ProtocolIE_Container_elm
  61                                      id_t = 0x16
  62                                      criticality_t = 0x1
  63                                      TimeToWait = 0
  64                                     ProtocolIE_Container_elm
  65                                      id_t = 0x11
  66                                      criticality_t = 0x1
  67                                      CriticalityDiagnostics
  68                                       procedureCode_t = 0x21
  69                                       triggeringMessage_t = 0x2
  70                                       procedureCriticality_t = 0x2
  71                                       iEsCriticalityDiagnostics_t:
  72                                        CriticalityDiagnostics_IE_List_elm
  73                                         iECriticality_t = 0
  74                                         iE_ID_t = 0x80
  75                                         typeOfError_t = 0x1
  76                         */
  77                         packedPdu: "4006001a0000030005400200000016400100001140087821a00000008040"},
  78                 {
  79                         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}}",
  80                         /*
  81                                 E2AP-PDU:
  82                                  unsuccessfulOutcome_t
  83                                   procedureCode_t = 0x6
  84                                   criticality_t = 0
  85                                   X2SetupFailure
  86                                    protocolIEs_t:
  87                                     ProtocolIE_Container_elm
  88                                      id_t = 0x5
  89                                      criticality_t = 0x1
  90                                      Cause:
  91                                       transport_t = 0
  92                                     ProtocolIE_Container_elm
  93                                      id_t = 0x11
  94                                      criticality_t = 0x1
  95                                      CriticalityDiagnostics
  96                                       procedureCode_t = 0x21
  97                                       triggeringMessage_t = 0x2
  98                                       procedureCriticality_t = 0x2
  99                                       iEsCriticalityDiagnostics_t:
 100                                        CriticalityDiagnostics_IE_List_elm
 101                                         iECriticality_t = 0
 102                                         iE_ID_t = 0x80
 103                                         typeOfError_t = 0x1
 104                         */
 105                         packedPdu: "400600140000020005400120001140087821a00000008040"},
 106                 {
 107                         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}}",
 108                         /*
 109                                 E2AP-PDU:
 110                                  unsuccessfulOutcome_t
 111                                   procedureCode_t = 0x6
 112                                   criticality_t = 0
 113                                   X2SetupFailure
 114                                    protocolIEs_t:
 115                                     ProtocolIE_Container_elm
 116                                      id_t = 0x5
 117                                      criticality_t = 0x1
 118                                      Cause:
 119                                       protocol_t = 0x2
 120                                     ProtocolIE_Container_elm
 121                                      id_t = 0x11
 122                                      criticality_t = 0x1
 123                                      CriticalityDiagnostics
 124                                       triggeringMessage_t = 0x2
 125                                       procedureCriticality_t = 0x2
 126                                       iEsCriticalityDiagnostics_t:
 127                                        CriticalityDiagnostics_IE_List_elm
 128                                         iECriticality_t = 0
 129                                         iE_ID_t = 0x80
 130                                         typeOfError_t = 0x1
 131                         */
 132                         packedPdu: "400600130000020005400144001140073a800000008040"},
 133
 134                 {
 135                         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}}",
 136                         /*
 137                                 E2AP-PDU:
 138                                  unsuccessfulOutcome_t
 139                                   procedureCode_t = 0x6
 140                                   criticality_t = 0
 141                                   X2SetupFailure
 142                                    protocolIEs_t:
 143                                     ProtocolIE_Container_elm
 144                                      id_t = 0x5
 145                                      criticality_t = 0x1
 146                                      Cause:
 147                                       misc_t = 0x4
 148                                     ProtocolIE_Container_elm
 149                                      id_t = 0x11
 150                                      criticality_t = 0x1
 151                                      CriticalityDiagnostics
 152                                       procedureCriticality_t = 0x2
 153                                       iEsCriticalityDiagnostics_t:
 154                                        CriticalityDiagnostics_IE_List_elm
 155                                         iECriticality_t = 0
 156                                         iE_ID_t = 0x80
 157                                         typeOfError_t = 0x1
 158                         */
 159                         packedPdu: "400600120000020005400168001140061a0000008040"},
 160
 161                 {
 162                         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}}",
 163                         /*
 164                                 E2AP-PDU:
 165                                  unsuccessfulOutcome_t
 166                                   procedureCode_t = 0x6
 167                                   criticality_t = 0
 168                                   X2SetupFailure
 169                                    protocolIEs_t:
 170                                     ProtocolIE_Container_elm
 171                                      id_t = 0x5
 172                                      criticality_t = 0x1
 173                                      Cause:
 174                                       misc_t = 0x4
 175                                     ProtocolIE_Container_elm
 176                                      id_t = 0x11
 177                                      criticality_t = 0x1
 178                                      CriticalityDiagnostics
 179                                       iEsCriticalityDiagnostics_t:
 180                                        CriticalityDiagnostics_IE_List_elm
 181                                         iECriticality_t = 0
 182                                         iE_ID_t = 0x80
 183                                         typeOfError_t = 0x1
 184                                        CriticalityDiagnostics_IE_List_elm
 185                                         iECriticality_t = 0x2
 186                                         iE_ID_t = 0xff
 187                                         typeOfError_t = 0
 188                         */
 189                         packedPdu: "4006001500000200054001680011400908010000804800ff00"},
 190
 191
 192                 {
 193                         response: "CONNECTED_SETUP_FAILED miscellaneous_cause:UNSPECIFIED  criticality_diagnostics:{procedure_code:33}",
 194                         /*
 195                                 E2AP-PDU:
 196                                  unsuccessfulOutcome_t
 197                                   procedureCode_t = 0x6
 198                                   criticality_t = 0
 199                                   X2SetupFailure
 200                                    protocolIEs_t:
 201                                     ProtocolIE_Container_elm
 202                                      id_t = 0x5
 203                                      criticality_t = 0x1
 204                                      Cause:
 205                                       misc_t = 0x4
 206                                     ProtocolIE_Container_elm
 207                                      id_t = 0x11
 208                                      criticality_t = 0x1
 209                                      CriticalityDiagnostics
 210                                       procedureCode_t = 0x21
 211                         */
 212                         packedPdu: "4006000e0000020005400168001140024021"},
 213
 214                 {
 215                         response: "CONNECTED_SETUP_FAILED miscellaneous_cause:UNSPECIFIED",
 216                         /*
 217                                 E2AP-PDU:
 218                                  unsuccessfulOutcome_t
 219                                   procedureCode_t = 0x6
 220                                   criticality_t = 0
 221                                   X2SetupFailure
 222                                    protocolIEs_t:
 223                                     ProtocolIE_Container_elm
 224                                      id_t = 0x5
 225                                      criticality_t = 0x1
 226                                      Cause:
 227                                       misc_t = 0x4
 228                         */
 229                         packedPdu: "400600080000010005400168"},
 230                 {
 231                         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}}",
 232                         /*
 233                                 E2AP-PDU:
 234                                  unsuccessfulOutcome_t
 235                                   procedureCode_t = 0x6
 236                                   criticality_t = 0
 237                                   X2SetupFailure
 238                                    protocolIEs_t:
 239                                     ProtocolIE_Container_elm
 240                                      id_t = 0x5
 241                                      criticality_t = 0x1
 242                                      Cause:
 243                                       radioNetwork_t = 0
 244                                     ProtocolIE_Container_elm
 245                                      id_t = 0x16
 246                                      criticality_t = 0x1
 247                                      TimeToWait = 0
 248                                     ProtocolIE_Container_elm
 249                                      id_t = 0x11
 250                                      criticality_t = 0x1
 251                                      CriticalityDiagnostics
 252                                       procedureCode_t = 0x21
 253                                       triggeringMessage_t = 0x2
 254                                       procedureCriticality_t = 0x2
 255                                       iEsCriticalityDiagnostics_t:
 256                                        CriticalityDiagnostics_IE_List_elm
 257                                         iECriticality_t = 0
 258                                         iE_ID_t = 0x80
 259                                         typeOfError_t = 0x1
 260                         */
 261                         packedPdu: "4006001a0000030005400200000016400100001140087821a00000008040",
 262                         //failure: fmt.Errorf("getAtom for path [unsuccessfulOutcome_t X2SetupFailure protocolIEs_t ProtocolIE_Container_elm Cause radioNetwork_t] failed, rc = 2" /*NO_SPACE_LEFT*/),
 263                 },
 264         }
 265
 266         converter := NewX2SetupFailureResponseConverter(logger)
 267
 268         for _, tc := range testCases {
 269                 t.Run(tc.packedPdu, func(t *testing.T) {
 270
 271                         var payload []byte
 272                         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 273                         if err != nil {
 274                                 t.Errorf("convert inputPayloadAsStr to payloadAsByte. Error: %v\n", err)
 275                         }
 276
 277                         response, err := converter.UnpackX2SetupFailureResponseAndExtract(payload)
 278
 279                         if err != nil {
 280                                 if tc.failure == nil {
 281                                         t.Errorf("want: success, got: error: %v\n", err)
 282                                 } else {
 283                                         if strings.Compare(err.Error(), tc.failure.Error()) != 0 {
 284                                                 t.Errorf("want: %s, got: %s", tc.failure, err)
 285                                         }
 286                                 }
 287                         }
 288
 289                         if response == nil {
 290                                 if tc.failure == nil {
 291                                         t.Errorf("want: response=%s, got: empty response", tc.response)
 292                                 }
 293                         } else {
 294                                 nb := &entities.NodebInfo{}
 295                                 nb.ConnectionStatus = entities.ConnectionStatus_CONNECTED_SETUP_FAILED
 296                                 nb.SetupFailure = response
 297                                 nb.FailureType = entities.Failure_X2_SETUP_FAILURE
 298                                 respStr := fmt.Sprintf("%s %s", nb.ConnectionStatus, response)
 299
 300                                 space := regexp.MustCompile(`\s+`)
 301                                 s1 := space.ReplaceAllString(respStr, " ")
 302                                 s2 := space.ReplaceAllString(tc.response," ")
 303
 304                                 if !strings.EqualFold(s1, s2) {
 305                                         t.Errorf("want: [%s], got: [%s]", tc.response, respStr)
 306                                 }
 307
 308                         }
 309                 })
 310         }
 311 }