Fix for E2 SubscriptionFailure message handling
[ric-plt/submgr.git] / pkg / control / ut_messaging_test.go
index cd8a832..5cc7458 100644 (file)
 package control
 
 import (
+       //"os"
        "strings"
        "testing"
        "time"
 
        "gerrit.o-ran-sc.org/r/ric-plt/e2ap/pkg/e2ap"
        "gerrit.o-ran-sc.org/r/ric-plt/e2ap/pkg/e2ap_wrapper"
+       "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
        "gerrit.o-ran-sc.org/r/ric-plt/submgr/pkg/teststube2ap"
        "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
        "github.com/stretchr/testify/assert"
 )
 
 func TestSuiteSetup(t *testing.T) {
-       // The effect of this call shall endure thgough the UT suite!
-       // If this causes any issues, the previout interface can be restored
+       // The effect of this call shall endure though the UT suite!
+       // If this causes any issues, the previous interface can be restored
        // like this:git log
        // SetPackerIf(e2ap_wrapper.NewAsn1E2APPacker())
 
        SetPackerIf(e2ap_wrapper.NewUtAsn1E2APPacker())
+       mainCtrl.c.restDuplicateCtrl.Init()
 
-       restDuplicateCtrl.Init()
+}
+func TestRanStatusChangeViaSDLNotification(t *testing.T) {
+
+       // Current UT test cases use these ran names
+       xappRnibMock.CreateGnb("RAN_NAME_1", entities.ConnectionStatus_DISCONNECTED)
+       xappRnibMock.CreateGnb("RAN_NAME_11", entities.ConnectionStatus_DISCONNECTED)
+       xappRnibMock.CreateGnb("RAN_NAME_2", entities.ConnectionStatus_DISCONNECTED)
+
+       mainCtrl.c.e2IfState.ReadE2ConfigurationFromRnib()
+       mainCtrl.c.e2IfState.SubscribeChannels()
+
+       mainCtrl.SetE2State(t, "RAN_NAME_1_CONNECTED")
+       mainCtrl.SetE2State(t, "RAN_NAME_2_CONNECTED")
+       mainCtrl.SetE2State(t, "RAN_NAME_11_CONNECTED")
+}
+
+//-----------------------------------------------------------------------------
+// TestRESTSubReqAfterE2ConnBreak
+//
+//   stub                             stub
+// +-------+        +---------+    +---------+
+// | xapp  |        | submgr  |    | e2term  |
+// +-------+        +---------+    +---------+
+//     |                 |              |
+//     |         [E2 Conn. DOWN]        |
+//     |                 |              |
+//     | RESTSubReq      |              |
+//     |---------------->|              |
+//     |     RESTSubFail |              |
+//     |<----------------|              |
+//     |                 |              |
+//
+//-----------------------------------------------------------------------------
+
+func TestRESTSubReqAfterE2ConnBreak(t *testing.T) {
+       CaseBegin("TestRESTSubReqAfterE2ConnBreak")
+
+       mainCtrl.CounterValuesToBeVeriefied(t, CountersToBeAdded{
+               Counter{cRestSubReqFromXapp, 1},
+               Counter{cRestReqRejDueE2Down, 1},
+       })
+
+       // E2 disconnect after E2term has received response
+       mainCtrl.SetE2State(t, "RAN_NAME_1_DISCONNECTED")
+       // Req
+       const subReqCount int = 1
+       params := xappConn1.GetRESTSubsReqReportParams(subReqCount)
+       xappConn1.SendRESTSubsReq(t, params)
+
+       // Restore E2 connection for following test cases
+       mainCtrl.SetE2State(t, "RAN_NAME_1_CONNECTED")
+
+       mainCtrl.VerifyCounterValues(t)
+}
+
+//-----------------------------------------------------------------------------
+// TestRESTSubReqE2ConnBreak
+//
+//   stub                             stub
+// +-------+        +---------+    +---------+
+// | xapp  |        | submgr  |    | e2term  |
+// +-------+        +---------+    +---------+
+//     |                 |              |
+//     | RESTSubReq      |              |
+//     |---------------->|              |
+//     |     RESTSubResp |              |
+//     |<----------------|              |
+//     |                 | SubReq       |
+//     |                 |------------->|
+//     |                 |      SubResp |
+//     |                 |<-------------|
+//     |                 |              |
+//     |         [E2 Conn. DOWN]        |
+//     |        [Int. SUBS DELETE]      |
+//     |                 |              |
+//     |      RESTNotif(unsuccessful)   |
+//     |<----------------|              |
+//     |                 |              |
+//     |                 |              |
+//
+//-----------------------------------------------------------------------------
+func TestRESTSubReqE2ConnBreak(t *testing.T) {
+       CaseBegin("TestRESTSubReqE2ConnBreak")
+
+       mainCtrl.CounterValuesToBeVeriefied(t, CountersToBeAdded{
+               Counter{cRestSubReqFromXapp, 1},
+               Counter{cRestSubRespToXapp, 1},
+               Counter{cSubReqToE2, 1},
+               Counter{cSubRespFromE2, 1},
+               Counter{cRestSubFailNotifToXapp, 1},
+       })
+
+       // Req
+       const subReqCount int = 1
+       params := xappConn1.GetRESTSubsReqReportParams(subReqCount)
+       restSubId := xappConn1.SendRESTSubsReq(t, params)
+
+       crereq, cremsg := e2termConn1.RecvSubsReq(t)
+       xappConn1.ExpectRESTNotification(t, restSubId)
+
+       // E2 disconnect after E2term has received response
+       mainCtrl.SetE2State(t, "RAN_NAME_1_DISCONNECTED")
+
+       e2termConn1.SendSubsResp(t, crereq, cremsg)
+       e2SubsId := xappConn1.WaitRESTNotification(t, restSubId)
+
+       <-time.After(time.Second * 1)
+       assert.Equal(t, 0, len(mainCtrl.c.registry.register))
+       assert.Equal(t, 0, len(mainCtrl.c.registry.restSubscriptions))
+
+       subIds, register, err := mainCtrl.c.ReadAllSubscriptionsFromSdl()
+       if err != nil {
+               xapp.Logger.Error("%v", err)
+       } else {
+               assert.Equal(t, 65534, len(subIds)) // range 1-65535 , FFFF = 65535
+               assert.Equal(t, 0, len(register))
+       }
+
+       restSubscriptions, err := mainCtrl.c.ReadAllRESTSubscriptionsFromSdl()
+       if err != nil {
+               xapp.Logger.Error("%v", err)
+       } else {
+               assert.Equal(t, 0, len(restSubscriptions))
+       }
+
+       // Restore E2 connection for following test cases
+       mainCtrl.SetE2State(t, "RAN_NAME_1_CONNECTED")
+
+       // Wait that subs is cleaned
+       waitSubsCleanup(t, e2SubsId, 10)
+       mainCtrl.VerifyCounterValues(t)
+}
+
+//-----------------------------------------------------------------------------
+// TestRESTSubscriptionDeleteAfterE2ConnectionBreak
+//
+//   stub                             stub
+// +-------+        +---------+    +---------+
+// | xapp  |        | submgr  |    | e2term  |
+// +-------+        +---------+    +---------+
+//     |                 |              |
+//     |            [SUBS CREATE]       |
+//     |                 |              |
+//     |           [E2 Conn. DOWN]      |
+//     |                 |              |
+//     | RESTSubDelReq   |              |
+//     |---------------->|              |
+//     |                 |              |
+//     |  RESTSubDelResp |              |
+//     |<----------------|              |
+//     |                 |              |
+//     |  [No valid subscription found] |
+//     |                 |              |
+//
+//-----------------------------------------------------------------------------
+func TestRESTSubscriptionDeleteAfterE2ConnectionBreak(t *testing.T) {
+       xapp.Logger.Debug("TEST: TestRESTSubscriptionDeleteAfterE2ConnectionBreak")
+
+       mainCtrl.CounterValuesToBeVeriefied(t, CountersToBeAdded{
+               Counter{cRestSubReqFromXapp, 1},
+               Counter{cRestSubRespToXapp, 1},
+               Counter{cSubReqToE2, 1},
+               Counter{cSubRespFromE2, 1},
+               Counter{cRestSubNotifToXapp, 1},
+               Counter{cRestSubDelReqFromXapp, 1},
+               Counter{cRestSubDelRespToXapp, 1},
+       })
+
+       // Req
+       var params *teststube2ap.RESTSubsReqParams = nil
+       restSubId, e2SubsId := createSubscription(t, xappConn1, e2termConn1, params)
+
+       // E2 disconnect after E2term has received response
+       mainCtrl.SetE2State(t, "RAN_NAME_1_DISCONNECTED")
 
+       // Del
+       xappConn1.SendRESTSubsDelReq(t, &restSubId)
+
+       <-time.After(time.Second * 1)
+       assert.Equal(t, 0, len(mainCtrl.c.registry.register))
+       assert.Equal(t, 0, len(mainCtrl.c.registry.restSubscriptions))
+
+       subIds, register, err := mainCtrl.c.ReadAllSubscriptionsFromSdl()
+       if err != nil {
+               xapp.Logger.Error("%v", err)
+       } else {
+               assert.Equal(t, 65534, len(subIds)) // range 1-65535 , FFFF = 65535
+               assert.Equal(t, 0, len(register))
+       }
+
+       restSubscriptions, err := mainCtrl.c.ReadAllRESTSubscriptionsFromSdl()
+       if err != nil {
+               xapp.Logger.Error("%v", err)
+       } else {
+               assert.Equal(t, 0, len(restSubscriptions))
+       }
+
+       // Restore E2 connection for following test cases
+       mainCtrl.SetE2State(t, "RAN_NAME_1_CONNECTED")
+
+       // Wait that subs is cleaned
+       mainCtrl.wait_subs_clean(t, e2SubsId, 10)
+
+       xappConn1.TestMsgChanEmpty(t)
+       e2termConn1.TestMsgChanEmpty(t)
+       mainCtrl.wait_registry_empty(t, 10)
+       mainCtrl.VerifyCounterValues(t)
+}
+
+//-----------------------------------------------------------------------------
+// TestRESTOtherE2ConnectionChanges
+//
+
+//   stub                             stub
+// +-------+        +---------+    +---------+
+// | xapp  |        | submgr  |    | e2term  |
+// +-------+        +---------+    +---------+
+//     |                 |              |
+//     |            [SUBS CREATE]       |
+//     |                 |              |
+//     |  [E2 CONNECTED_SETUP_FAILED]   |
+//     |         [E2 CONNECTING]        |
+//     |        [E2 SHUTTING_DOWN]      |
+//     |          [E2 SHUT_DOWN]        |
+//     |                 |              |
+//     |            [SUBS DELETE]       |
+//     |                 |              |
+//
+//-----------------------------------------------------------------------------
+func TestRESTOtherE2ConnectionChanges(t *testing.T) {
+       xapp.Logger.Debug("TEST: TestRESTOtherE2ConnectionChanges")
+
+       mainCtrl.CounterValuesToBeVeriefied(t, CountersToBeAdded{
+               Counter{cRestSubReqFromXapp, 1},
+               Counter{cRestSubRespToXapp, 1},
+               Counter{cSubReqToE2, 1},
+               Counter{cSubRespFromE2, 1},
+               Counter{cRestSubNotifToXapp, 1},
+               Counter{cRestSubDelReqFromXapp, 1},
+               Counter{cSubDelReqToE2, 1},
+               Counter{cSubDelRespFromE2, 1},
+               Counter{cRestSubDelRespToXapp, 1},
+       })
+
+       // Req
+       params := xappConn1.GetRESTSubsReqReportParams(subReqCount)
+       restSubId := xappConn1.SendRESTSubsReq(t, params)
+
+       crereq, cremsg := e2termConn1.RecvSubsReq(t)
+       xappConn1.ExpectRESTNotification(t, restSubId)
+       e2termConn1.SendSubsResp(t, crereq, cremsg)
+       e2SubsId := xappConn1.WaitRESTNotification(t, restSubId)
+
+       // Submgr should not react any other connection state changes than CONNECTED and DISCONNECTED
+       mainCtrl.SetE2State(t, "RAN_NAME_1_CONNECTED_SETUP_FAILED")
+       mainCtrl.SetE2State(t, "RAN_NAME_1_CONNECTING")
+       mainCtrl.SetE2State(t, "RAN_NAME_1_SHUTTING_DOWN")
+       mainCtrl.SetE2State(t, "RAN_NAME_1_SHUT_DOWN")
+
+       // Del
+       xappConn1.SendRESTSubsDelReq(t, &restSubId)
+       delreq, delmsg := e2termConn1.RecvSubsDelReq(t)
+       e2termConn1.SendSubsDelResp(t, delreq, delmsg)
+
+       // Restore E2 connection for following test cases
+       mainCtrl.SetE2State(t, "RAN_NAME_1_CONNECTED")
+
+       // Wait that subs is cleaned
+       waitSubsCleanup(t, e2SubsId, 10)
+       mainCtrl.VerifyCounterValues(t)
 }
 
 //-----------------------------------------------------------------------------
@@ -1175,12 +1446,6 @@ func TestSubReqTwoRetriesNoRespAtAllInSubmgr(t *testing.T) {
 //     |              |      SubFail |
 //     |              |<-------------|
 //     |              |              |
-//     |              | SubDelReq    |
-//     |              |------------->|
-//     |              |              |
-//     |              |   SubDelResp |
-//     |              |<-------------|
-//     |              |              |
 //     |      SubFail |              |
 //     |<-------------|              |
 //     |              |              |
@@ -1206,10 +1471,6 @@ func TestSubReqSubFailRespInSubmgr(t *testing.T) {
        fparams1.Set(crereq1)
        e2termConn1.SendSubsFail(t, fparams1, cremsg1)
 
-       // E2t: Receive SubsDelReq and send SubsDelResp (internal first)
-       delreq1, delmsg1 := e2termConn1.RecvSubsDelReq(t)
-       e2termConn1.SendSubsDelResp(t, delreq1, delmsg1)
-
        // Xapp: Receive SubsFail
        e2SubsId := xappConn1.RecvSubsFail(t, cretrans)
 
@@ -1484,8 +1745,6 @@ func TestSubReqAndSubDelOkSameAction(t *testing.T) {
        rparams2 := &teststube2ap.E2StubSubsReqParams{}
        rparams2.Init()
        cretrans2 := xappConn2.SendSubsReq(t, rparams2, nil)
-       //crereq2, cremsg2 := e2termConn1.RecvSubsReq(t)
-       //e2termConn1.SendSubsResp(t, crereq2, cremsg2)
        e2SubsId2 := xappConn2.RecvSubsResp(t, cretrans2)
 
        resp, _ := xapp.Subscription.QuerySubscriptions()
@@ -1495,11 +1754,7 @@ func TestSubReqAndSubDelOkSameAction(t *testing.T) {
 
        //Del1
        deltrans1 := xappConn1.SendSubsDelReq(t, nil, e2SubsId1)
-       //e2termConn1.RecvSubsDelReq(t)
-       //e2termConn1.SendSubsDelResp(t, delreq1, delmsg1)
        xappConn1.RecvSubsDelResp(t, deltrans1)
-       //Wait that subs is cleaned
-       //mainCtrl.wait_subs_clean(t, e2SubsId1, 10)
 
        //Del2
        deltrans2 := xappConn2.SendSubsDelReq(t, nil, e2SubsId2)
@@ -1621,11 +1876,6 @@ func TestSubReqAndSubDelOkSameActionParallel(t *testing.T) {
 //     |             |              |    SubFail1  |
 //     |             |              |<-------------|
 //     |             |              |              |
-//     |             |              | SubDelReq    |
-//     |             |              |------------->|
-//     |             |              |   SubDelResp |
-//     |             |              |<-------------|
-//     |             |              |              |
 //     |             |    SubFail1  |              |
 //     |             |<-------------|              |
 //     |             |              |              |
@@ -1656,10 +1906,6 @@ func TestSubReqAndSubDelNokSameActionParallel(t *testing.T) {
        fparams1.Set(crereq1)
        e2termConn1.SendSubsFail(t, fparams1, cremsg1)
 
-       // E2t: internal delete
-       delreq, delmsg := e2termConn1.RecvSubsDelReq(t)
-       e2termConn1.SendSubsDelResp(t, delreq, delmsg)
-
        //Fail1
        e2SubsId1 := xappConn1.RecvSubsFail(t, cretrans1)
        //Fail2
@@ -2563,7 +2809,6 @@ func TestRESTSubMergeDelAndRouteUpdateNok(t *testing.T) {
        deleteXapp2Subscription(t, &restSubId2)
 
        waitSubsCleanup(t, e2SubsId2, 10)
-
        mainCtrl.VerifyCounterValues(t)
 }
 
@@ -2619,15 +2864,11 @@ func TestRESTSubReqRetransmission(t *testing.T) {
 
        // Subs Create
        const subReqCount int = 1
-       //      const e2Timeout int64 = 2
-       //      const e2RetryCount int64 = 2
-       //      const routingNeeded bool = true
 
        // In order to force both XAPP's to create their own subscriptions, force rtmgr to block a while so that 2nd create
        // gets into execution before the rtmgrg responds for the first one.
        waiter := rtmgrHttp.AllocNextSleep(10, true)
        params := xappConn1.GetRESTSubsReqReportParams(subReqCount)
-       //      params.SetSubscriptionDirectives(e2Timeout, e2RetryCount, routingNeeded)
        restSubId1 := xappConn1.SendRESTSubsReq(t, params)
        xappConn2.SendRESTSubsReq(t, params)
 
@@ -3656,12 +3897,6 @@ func TestRESTSubReqTwoRetriesNoRespAtAllInSubmgr(t *testing.T) {
 //     |                 |      SubFail |
 //     |                 |<-------------|
 //     |                 |              |
-//     |                 | SubDelReq    |
-//     |                 |------------->|
-//     |                 |              |
-//     |                 |   SubDelResp |
-//     |                 |<-------------|
-//     |                 |              |
 //     |       RESTNotif |              |
 //     |       unsuccess |              |
 //     |<----------------|              |
@@ -3683,18 +3918,20 @@ func TestRESTSubReqSubFailRespInSubmgr(t *testing.T) {
        })
 
        const subReqCount int = 1
+       const e2Timeout int64 = 2
+       const e2RetryCount int64 = 1
+       const routingNeeded bool = true
 
        params := xappConn1.GetRESTSubsReqReportParams(subReqCount)
+       params.SetSubscriptionDirectives(e2Timeout, e2RetryCount, routingNeeded)
        restSubId := xappConn1.SendRESTSubsReq(t, params)
 
        crereq1, cremsg1 := e2termConn1.RecvSubsReq(t)
        fparams1 := &teststube2ap.E2StubSubsFailParams{}
        fparams1.Set(crereq1)
+       xappConn1.ExpectRESTNotificationNok(t, restSubId, "allFail")
        e2termConn1.SendSubsFail(t, fparams1, cremsg1)
 
-       delreq1, delmsg1 := e2termConn1.RecvSubsDelReq(t)
-       xappConn1.ExpectRESTNotificationNok(t, restSubId, "allFail")
-       e2termConn1.SendSubsDelResp(t, delreq1, delmsg1)
        e2SubsId := xappConn1.WaitRESTNotification(t, restSubId)
        xapp.Logger.Debug("TEST: REST notification received e2SubsId=%v", e2SubsId)
 
@@ -4219,12 +4456,8 @@ func TestRESTSubReqAndSubDelNoAnswerSameActionParallel(t *testing.T) {
 //     |                    RESTNotif2 |              |
 //     |             |       unsuccess |              |
 //     |<------------------------------|              |
-//     |             |                 | SubDelReq    |
-//     |             |                 |------------->|
-//     |             |                 |   SubDelResp |
-//     |             |                 |<-------------|
 //     |             |                 |              |
-//     |             | RESTSubDelReq1  |              |
+//     |             | RESTSubDelReq1  |              |   There is no need for xApp to send delete for failed subscriptions but some xApp might do so.
 //     |             |---------------->|              |
 //     |             |                 |              |
 //     |             | RESTSubDelResp1 |              |
@@ -4247,8 +4480,6 @@ func TestRESTSubReqAndSubDelNokSameActionParallel(t *testing.T) {
                Counter{cSubFailFromE2, 1},
                Counter{cRestSubFailNotifToXapp, 2},
                Counter{cRestSubDelReqFromXapp, 2},
-               Counter{cSubDelReqToE2, 1},
-               Counter{cSubDelRespFromE2, 1},
                Counter{cRestSubDelRespToXapp, 2},
        })
 
@@ -4271,11 +4502,7 @@ func TestRESTSubReqAndSubDelNokSameActionParallel(t *testing.T) {
        fparams1.Set(crereq1)
        e2termConn1.SendSubsFail(t, fparams1, cremsg1)
 
-       // E2t: internal delete
-       delreq, delmsg := e2termConn1.RecvSubsDelReq(t)
        xappConn1.WaitListedRestNotifications(t, []string{restSubId1, restSubId2})
-       e2termConn1.SendSubsDelResp(t, delreq, delmsg)
-
        e2SubsIdA := <-xappConn1.ListedRESTNotifications
        xapp.Logger.Debug("TEST: 1.st XAPP notification received e2SubsId=%v", e2SubsIdA)
        e2SubsIdB := <-xappConn1.ListedRESTNotifications
@@ -5691,11 +5918,7 @@ func TestRESTSubReqReportSameActionDiffSubsAction(t *testing.T) {
 //     |                 |<-------------|
 //     | RESTNotif (fail)|              |
 //     |<----------------|              |
-//     |                 | SubDelReq    |
-//     |                 |------------->|
 //     |                 |              |
-//     |                 |   SubDelResp |
-//     |                 |<-------------|
 //
 //-----------------------------------------------------------------------------
 
@@ -5721,9 +5944,6 @@ func TestRESTUnpackSubscriptionResponseDecodeFail(t *testing.T) {
        fparams.SetCauseVal(0, 1, 3) // CauseRIC / duplicate-action
        e2termConn1.SendSubsFail(t, fparams, cremsg)
 
-       delreq, delmsg := e2termConn1.RecvSubsDelReq(t)
-       e2termConn1.SendSubsDelResp(t, delreq, delmsg)
-
        instanceId := xappConn1.WaitRESTNotification(t, restSubId)
        xapp.Logger.Debug("TEST: REST notification received e2SubsId=%v", instanceId)
 
@@ -5919,11 +6139,7 @@ func TestRESTUnpackSubscriptionResponseNoTransaction(t *testing.T) {
 //     |                 |<-------------|
 //     | RESTNotif (fail)|              |
 //     |<----------------|              |
-//     |                 | SubDelReq    |
-//     |                 |------------->|
 //     |                 |              |
-//     |                 |   SubDelResp |
-//     |                 |<-------------|
 //
 //-----------------------------------------------------------------------------
 func TestRESTUnpackSubscriptionFailureDecodeFail(t *testing.T) {
@@ -5949,9 +6165,6 @@ func TestRESTUnpackSubscriptionFailureDecodeFail(t *testing.T) {
        fparams.SetCauseVal(0, 1, 3) // CauseRIC / duplicate-action
        e2termConn1.SendSubsFail(t, fparams, cremsg)
 
-       delreq, delmsg := e2termConn1.RecvSubsDelReq(t)
-       e2termConn1.SendSubsDelResp(t, delreq, delmsg)
-
        instanceId := xappConn1.WaitRESTNotification(t, restSubId)
        xapp.Logger.Debug("TEST: REST notification received e2SubsId=%v", instanceId)
 
@@ -6583,9 +6796,9 @@ func TestRESTSubReqPolicyUpdateTimeoutAndSubDelOkSameAction(t *testing.T) {
 
        crereq1, cremsg1 = e2termConn1.RecvSubsReq(t)
        xappConn1.ExpectRESTNotification(t, restSubId)
-       // SubsResp is missing
-       e2SubsId = xappConn1.WaitRESTNotification(t, restSubId)
-       xapp.Logger.Debug("TEST: REST notification received e2SubsId=%v", e2SubsId)
+       // SubsResp is missing, e2SubsId will be 0
+       zeroE2SubsId := xappConn1.WaitRESTNotification(t, restSubId)
+       xapp.Logger.Debug("TEST: REST notification received e2SubsId=%v", zeroE2SubsId)
 
        // Del
        xappConn1.SendRESTSubsDelReq(t, &restSubId)