J release: Release container Image
[ric-plt/submgr.git] / pkg / control / ut_ctrl_submgr_test.go
index 009e70b..0af1da4 100644 (file)
@@ -28,6 +28,8 @@ import (
        "testing"
        "time"
 
+       "github.com/stretchr/testify/assert"
+
        "gerrit.o-ran-sc.org/r/ric-plt/submgr/pkg/teststub"
        "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/models"
        "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
@@ -48,15 +50,23 @@ type Counter struct {
 
 type CountersToBeAdded []Counter
 
-var countersBeforeMap map[string]Counter
+var allCountersMap map[string]Counter
+var allCountersBeforeMap map[string]Counter
+var toBeAddedCountersBeforeMap map[string]Counter
 var toBeAddedCountersMap map[string]Counter
 
 func createSubmgrControl(srcId teststub.RmrSrcId, rtgSvc teststub.RmrRtgSvc) *testingSubmgrControl {
        mainCtrl = &testingSubmgrControl{}
        mainCtrl.RmrControl.Init("SUBMGRCTL", srcId, rtgSvc)
        mainCtrl.c = NewControl()
+       mainCtrl.c.UTTesting = true
+       mainCtrl.c.LoggerLevel = 4
+       mainCtrl.c.e2ap.SetASN1DebugPrintStatus(mainCtrl.c.LoggerLevel)
+       xapp.Logger.Debug("Test: LoggerLevel %v", mainCtrl.c.LoggerLevel)
        xapp.Logger.Debug("Replacing real db with test db")
-       mainCtrl.c.db = CreateMock() // This overrides real database for testing
+       mainCtrl.c.e2SubsDb = CreateMock()              // This overrides real E2 Subscription database for testing
+       mainCtrl.c.restSubsDb = CreateRestSubsDbMock()  // This overrides real REST Subscription database for testing
+       mainCtrl.c.e2IfStateDb = CreateXappRnibIfMock() // This overrides real RNIB database for testing
        xapp.SetReadyCB(mainCtrl.ReadyCB, nil)
        go xapp.RunWithParams(mainCtrl.c, false)
        mainCtrl.WaitCB()
@@ -66,37 +76,39 @@ func createSubmgrControl(srcId teststub.RmrSrcId, rtgSvc teststub.RmrRtgSvc) *te
 
 func (mc *testingSubmgrControl) SimulateRestart(t *testing.T) {
        mc.TestLog(t, "Simulating submgr restart")
-       mainCtrl.c.registry.subIds = nil
+
        // Initialize subIds slice and subscription map
+       mainCtrl.c.registry.subIds = nil
        mainCtrl.c.registry.Initialize()
+       mainCtrl.c.restDuplicateCtrl.Init()
+
        // Read subIds and subscriptions from database
-       subIds, register, err := mainCtrl.c.ReadAllSubscriptionsFromSdl()
-       if err != nil {
-               mc.TestError(t, "%v", err)
-       } else {
-               mainCtrl.c.registry.register = nil
-               mainCtrl.c.registry.subIds = subIds
-               mainCtrl.c.registry.register = register
-
-               mc.TestLog(t, "register:")
-               for subId, subs := range register {
-                       mc.TestLog(t, "  subId=%v", subId)
-                       mc.TestLog(t, "  subs.SubRespRcvd=%v", subs.SubRespRcvd)
-                       mc.TestLog(t, "  subs=%v\n", subs)
-               }
+       mainCtrl.c.ReadE2Subscriptions()
+       mc.TestLog(t, "mainCtrl.c.registry.register:")
+       for subId, subs := range mainCtrl.c.registry.register {
+               mc.TestLog(t, "  subId=%v", subId)
+               mc.TestLog(t, "  subs.SubRespRcvd=%v", subs.SubRespRcvd)
+               mc.TestLog(t, "  subs=%v\n", subs)
+       }
 
-               mc.TestLog(t, "mainCtrl.c.registry.register:")
-               for subId, subs := range mainCtrl.c.registry.register {
-                       mc.TestLog(t, "  subId=%v", subId)
-                       mc.TestLog(t, "  subs.SubRespRcvd=%v", subs.SubRespRcvd)
-                       mc.TestLog(t, "  subs=%v\n", subs)
-               }
+       // Read REST subIds and REST subscriptions from database
+       mainCtrl.c.ReadRESTSubscriptions()
+       mc.TestLog(t, "mainCtrl.c.registry.restSubscriptions:")
+       for restSubId, restSubs := range mainCtrl.c.registry.restSubscriptions {
+               mc.TestLog(t, "  restSubId=%v", restSubId)
+               mc.TestLog(t, "  restSubs=%v\n", restSubs)
        }
-       go mainCtrl.c.HandleUncompletedSubscriptions(mainCtrl.c.registry.register)
+}
+
+func (mc *testingSubmgrControl) MakeTransactionNil(t *testing.T, subId uint32) {
+
+       mc.TestLog(t, "Makin transaction nil for SubId=%v", subId)
+       subs := mainCtrl.c.registry.GetSubscription(subId)
+       subs.TheTrans = nil
 }
 
 func (mc *testingSubmgrControl) SetResetTestFlag(t *testing.T, status bool) {
-       mc.TestLog(t, "ResetTestFlag set to %v=", status)
+       mc.TestLog(t, "ResetTestFlag set to %v", status)
        mainCtrl.c.ResetTestFlag = status
 }
 
@@ -109,25 +121,25 @@ func (mc *testingSubmgrControl) removeExistingSubscriptions(t *testing.T) {
        mainCtrl.c.registry.Initialize()
 }
 
-func PringSubscriptionQueryResult(resp models.SubscriptionList) {
+func PrintSubscriptionQueryResult(resp models.SubscriptionList) {
        for _, item := range resp {
                fmt.Printf("item.SubscriptionID=%v\n", item.SubscriptionID)
                fmt.Printf("item.Meid=%v\n", item.Meid)
-               fmt.Printf("item.Endpoint=%v\n", item.Endpoint)
+               fmt.Printf("item.ClientEndpoint=%v\n", item.ClientEndpoint)
        }
 }
 
 func (mc *testingSubmgrControl) wait_registry_empty(t *testing.T, secs int) bool {
        cnt := int(0)
        i := 1
-       for ; i <= secs*2; i++ {
+       for ; i <= secs*10; i++ {
                cnt = len(mc.c.registry.register)
                if cnt == 0 {
                        return true
                }
-               time.Sleep(500 * time.Millisecond)
+               time.Sleep(100 * time.Millisecond)
        }
-       mc.TestError(t, "(submgr) no registry empty within %d secs: %d", secs, cnt)
+       mc.TestError(t, "(submgr) no registry empty within %d secs: %d, register: %v", secs, cnt, mc.c.registry.register)
        return false
 }
 
@@ -139,14 +151,14 @@ func (mc *testingSubmgrControl) get_registry_next_subid(t *testing.T) uint32 {
 
 func (mc *testingSubmgrControl) wait_registry_next_subid_change(t *testing.T, origSubId uint32, secs int) (uint32, bool) {
        i := 1
-       for ; i <= secs*2; i++ {
+       for ; i <= secs*10; i++ {
                mc.c.registry.mutex.Lock()
                currSubId := mc.c.registry.subIds[0]
                mc.c.registry.mutex.Unlock()
                if currSubId != origSubId {
                        return currSubId, true
                }
-               time.Sleep(500 * time.Millisecond)
+               time.Sleep(100 * time.Millisecond)
        }
        mc.TestError(t, "(submgr) no subId change within %d secs", secs)
        return 0, false
@@ -155,12 +167,12 @@ func (mc *testingSubmgrControl) wait_registry_next_subid_change(t *testing.T, or
 func (mc *testingSubmgrControl) wait_subs_clean(t *testing.T, e2SubsId uint32, secs int) bool {
        var subs *Subscription
        i := 1
-       for ; i <= secs*2; i++ {
+       for ; i <= secs*10; i++ {
                subs = mc.c.registry.GetSubscription(e2SubsId)
                if subs == nil {
                        return true
                }
-               time.Sleep(500 * time.Millisecond)
+               time.Sleep(100 * time.Millisecond)
        }
        if subs != nil {
                mc.TestError(t, "(submgr) no clean within %d secs: %s", secs, subs.String())
@@ -170,10 +182,35 @@ func (mc *testingSubmgrControl) wait_subs_clean(t *testing.T, e2SubsId uint32, s
        return false
 }
 
+func (mc *testingSubmgrControl) wait_multi_subs_clean(t *testing.T, e2SubsIds []uint32, secs int) bool {
+
+       purgedSubscriptions := 0
+
+       for i := 1; i <= secs*10; i++ {
+               purgedSubscriptions = 0
+               for k := 0; k <= len(e2SubsIds); i++ {
+                       subs := mc.c.registry.GetSubscription(e2SubsIds[k])
+                       if subs == nil {
+                               mc.TestLog(t, "(submgr) subscriber purged for esSubsId %v", e2SubsIds[k])
+                               purgedSubscriptions += 1
+                               if purgedSubscriptions == len(e2SubsIds) {
+                                       return true
+                               }
+                       }
+               }
+               mc.TestLog(t, "(submgr) subscriptions pending purging %v/%v after %d msecs", purgedSubscriptions, len(e2SubsIds), i+500)
+               time.Sleep(100 * time.Millisecond)
+       }
+
+       mc.TestError(t, "(submgr) no clean within %d secs: subs(N/A) - %v/%v subscriptions found still", secs, purgedSubscriptions, len(e2SubsIds))
+
+       return false
+}
+
 func (mc *testingSubmgrControl) wait_subs_trans_clean(t *testing.T, e2SubsId uint32, secs int) bool {
        var trans TransactionIf
        i := 1
-       for ; i <= secs*2; i++ {
+       for ; i <= secs*10; i++ {
                subs := mc.c.registry.GetSubscription(e2SubsId)
                if subs == nil {
                        return true
@@ -182,7 +219,7 @@ func (mc *testingSubmgrControl) wait_subs_trans_clean(t *testing.T, e2SubsId uin
                if trans == nil {
                        return true
                }
-               time.Sleep(500 * time.Millisecond)
+               time.Sleep(100 * time.Millisecond)
        }
        if trans != nil {
                mc.TestError(t, "(submgr) no clean within %d secs: %s", secs, trans.String())
@@ -210,12 +247,12 @@ func (mc *testingSubmgrControl) wait_subs_entrypoint_cnt_change(t *testing.T, or
        }
 
        i := 1
-       for ; i <= secs*2; i++ {
+       for ; i <= secs*10; i++ {
                curr := subs.EpList.Size()
                if curr != orig {
                        return curr, true
                }
-               time.Sleep(500 * time.Millisecond)
+               time.Sleep(100 * time.Millisecond)
        }
        mc.TestError(t, "(submgr) no subs %d entrypoint cnt change within %d secs", origSubId, secs)
        return 0, false
@@ -230,17 +267,69 @@ func (mc *testingSubmgrControl) get_msgcounter(t *testing.T) uint64 {
 
 func (mc *testingSubmgrControl) wait_msgcounter_change(t *testing.T, orig uint64, secs int) (uint64, bool) {
        i := 1
-       for ; i <= secs*2; i++ {
+       for ; i <= secs*10; i++ {
                curr := mc.c.CntRecvMsg
                if curr != orig {
                        return curr, true
                }
-               time.Sleep(500 * time.Millisecond)
+               time.Sleep(100 * time.Millisecond)
        }
        mc.TestError(t, "(submgr) no msg counter change within %d secs", secs)
        return 0, false
 }
 
+func (mc *testingSubmgrControl) VerifyAllClean(t *testing.T) {
+
+       // Verify that all resources are freed. Wait cleaning up to 10 seconds
+       for i := 0; i < 100; i++ {
+               if len(mainCtrl.c.registry.register) == 0 && len(mainCtrl.c.registry.restSubscriptions) == 0 {
+                       RESTKeyCount, err := mainCtrl.c.GetRESTKeyCount()
+                       if err != nil {
+                               t.Errorf("TEST: %s", err.Error())
+                       }
+                       E2KeyCount, err := mainCtrl.c.GetE2KeyCount()
+                       if err != nil {
+                               t.Errorf("TEST: %s", err.Error())
+                       }
+                       if RESTKeyCount == 0 && E2KeyCount == 0 {
+                               break
+                       }
+               }
+               xapp.Logger.Debug("VerifyAllClean. Adding 100ms more delay to complete")
+               <-time.After(time.Millisecond * 100)
+       }
+
+       assert.Equal(t, 0, len(mainCtrl.c.registry.register))
+       if len(mainCtrl.c.registry.register) > 0 {
+               fmt.Printf("registry.register: %v\n", mainCtrl.c.registry.register)
+       }
+       assert.Equal(t, 0, len(mainCtrl.c.registry.restSubscriptions))
+       if len(mainCtrl.c.registry.restSubscriptions) > 0 {
+               fmt.Printf("registry.restSubscriptions: %v\n", mainCtrl.c.registry.restSubscriptions)
+       }
+       verifyRESTKeyCount(t, 0)
+       verifyE2KeyCount(t, 0)
+}
+
+func (mc *testingSubmgrControl) WaitOngoingRequestMapEmpty() {
+       for i := 0; i < 100; i++ {
+               if len(mainCtrl.c.restDuplicateCtrl.ongoingRequestMap) != 0 {
+                       <-time.After(time.Millisecond * 100)
+                       xapp.Logger.Debug("WaitOngoingRequestMapEmpty. Adding 100ms more delay to complete")
+               }
+       }
+}
+
+func (mc *testingSubmgrControl) WaitRESTSubscriptionDelete(restSubsId string) {
+       for i := 0; i < 100; i++ {
+               restSubscription, _ := mainCtrl.c.registry.GetRESTSubscription(restSubsId, false)
+               if restSubscription != nil {
+                       xapp.Logger.Debug("WaitRESTSubscriptionDelete. Adding 100ms more delay to complete")
+                       <-time.After(time.Millisecond * 100)
+               }
+       }
+}
+
 func (mc *testingSubmgrControl) GetMetrics(t *testing.T) (string, error) {
        req, err := http.NewRequest("GET", "http://localhost:8080/ric/v1/metrics", nil)
        if err != nil {
@@ -260,6 +349,17 @@ func (mc *testingSubmgrControl) GetMetrics(t *testing.T) (string, error) {
        return string(respBody[:]), nil
 }
 
+func (mc *testingSubmgrControl) InitAllCounterMap() {
+       counterOpts := GetMetricsOpts()
+
+       allCountersMap = make(map[string]Counter)
+       for _, counterOpt := range counterOpts {
+               //fmt.Printf("counterOpt.Name: '%v'\n", counterOpt.Name)
+               counter := Counter{counterOpt.Name, 0}
+               allCountersMap[counterOpt.Name] = counter
+       }
+}
+
 func (mc *testingSubmgrControl) CounterValuesToBeVeriefied(t *testing.T, countersToBeAdded CountersToBeAdded) {
 
        if len(toBeAddedCountersMap) == 0 {
@@ -272,32 +372,49 @@ func (mc *testingSubmgrControl) CounterValuesToBeVeriefied(t *testing.T, counter
 }
 
 func (mc *testingSubmgrControl) GetCounterValuesBefore(t *testing.T) {
-       countersBeforeMap = make(map[string]Counter)
-       countersBeforeMap = mc.GetCurrentCounterValues(t, toBeAddedCountersMap)
+       toBeAddedCountersBeforeMap = make(map[string]Counter)
+       toBeAddedCountersBeforeMap = mc.GetCurrentCounterValues(t, toBeAddedCountersMap)
+       allCountersBeforeMap = make(map[string]Counter)
+       allCountersBeforeMap = mc.GetCurrentCounterValues(t, allCountersMap)
 }
 
 func (mc *testingSubmgrControl) VerifyCounterValues(t *testing.T) {
+
+       // Check that expected counters are added ok
+       // Get current values of counters exected to be added
        currentCountersMap := mc.GetCurrentCounterValues(t, toBeAddedCountersMap)
        for _, toBeAddedCounter := range toBeAddedCountersMap {
                if currentCounter, ok := currentCountersMap[toBeAddedCounter.Name]; ok == true {
-                       if beforeCounter, ok := countersBeforeMap[toBeAddedCounter.Name]; ok == true {
+                       if beforeCounter, ok := toBeAddedCountersBeforeMap[toBeAddedCounter.Name]; ok == true {
                                if currentCounter.Value != beforeCounter.Value+toBeAddedCounter.Value {
                                        mc.TestError(t, "Error in expected counter value: counterName %v, current value %v, expected value %v",
                                                currentCounter.Name, currentCounter.Value, beforeCounter.Value+toBeAddedCounter.Value)
-
-                                       //fmt.Printf("beforeCounter.Value=%v, toBeAddedCounter.Value=%v, \n",beforeCounter.Value, toBeAddedCounter.Value)
                                }
                        } else {
-                               mc.TestError(t, "Counter %v not in countersBeforeMap", toBeAddedCounter.Name)
+                               mc.TestError(t, "Counter %v not in toBeAddedCountersBeforeMap", toBeAddedCounter.Name)
                        }
                } else {
                        mc.TestError(t, "Counter %v not in currentCountersMap", toBeAddedCounter.Name)
                }
        }
 
+       // Check that not any unexpected counter are added
+       // Get current values of all counters
+       currentCountersMap = mc.GetCurrentCounterValues(t, allCountersMap)
+       for _, currentCounter := range currentCountersMap {
+               if _, ok := toBeAddedCountersMap[currentCounter.Name]; ok == false {
+                       if beforeCounter, ok := allCountersBeforeMap[currentCounter.Name]; ok == true {
+                               if currentCounter.Value != beforeCounter.Value {
+                                       mc.TestError(t, "Error: unexpected counter added: counterName %v, current value %v, expected value %v",
+                                               currentCounter.Name, currentCounter.Value, beforeCounter.Value)
+                               }
+                       }
+               }
+       }
+
        // Make map empty
-       //fmt.Printf("toBeAddedCountersMap=%v\n",toBeAddedCountersMap)
        toBeAddedCountersMap = make(map[string]Counter)
+       allCountersBeforeMap = make(map[string]Counter)
 }
 
 func (mc *testingSubmgrControl) GetCurrentCounterValues(t *testing.T, chekedCountersMap map[string]Counter) map[string]Counter {
@@ -328,7 +445,126 @@ func (mc *testingSubmgrControl) GetCurrentCounterValues(t *testing.T, chekedCoun
 
        if len(retCounterMap) != len(chekedCountersMap) {
                mc.TestError(t, "Error: len(retCounterMap) != len(chekedCountersMap)")
-
        }
        return retCounterMap
 }
+
+func (mc *testingSubmgrControl) SendGetRequest(t *testing.T, addr string, path string) []byte {
+
+       mc.TestLog(t, "GET http://"+addr+"%v", path)
+       req, err := http.NewRequest("GET", "http://"+addr+path, nil)
+       if err != nil {
+               mc.TestError(t, "Error reading request. %v", err)
+               return nil
+       }
+
+       req.Header.Set("accept", "application/json")
+       client := &http.Client{Timeout: time.Second * 2}
+       resp, err := client.Do(req)
+       if err != nil {
+               mc.TestError(t, "Error reading response. %v", err)
+               return nil
+       }
+       defer resp.Body.Close()
+
+       mc.TestLog(t, "Response status: %v", resp.Status)
+       mc.TestLog(t, "Response Headers: %v", resp.Header)
+       if !strings.Contains(resp.Status, "200 OK") {
+               mc.TestError(t, "Wrong response status")
+               return nil
+       }
+
+       respBody, err := ioutil.ReadAll(resp.Body)
+       if err != nil {
+               mc.TestError(t, "Error reading body. %v", err)
+               return nil
+       }
+       mc.TestLog(t, "%s", respBody)
+       return respBody
+}
+
+func (mc *testingSubmgrControl) SendPostRequest(t *testing.T, addr string, path string) {
+
+       mc.TestLog(t, "POST http://"+addr+"%v", path)
+       req, err := http.NewRequest("POST", "http://"+addr+path, nil)
+       if err != nil {
+               mc.TestError(t, "Error reading request. %v", err)
+               return
+       }
+       req.Header.Set("accept", "application/json")
+       client := &http.Client{Timeout: time.Second * 2}
+       resp, err := client.Do(req)
+       if err != nil {
+               mc.TestError(t, "Error reading response. %v", err)
+               return
+       }
+       defer resp.Body.Close()
+
+       mc.TestLog(t, "Response status: %v", resp.Status)
+       mc.TestLog(t, "Response Headers: %v", resp.Header)
+       if !strings.Contains(resp.Status, "200 OK") {
+               mc.TestError(t, "Wrong response status")
+               return
+       }
+
+       respBody, err := ioutil.ReadAll(resp.Body)
+       if err != nil {
+               mc.TestError(t, "Error reading body. %v", err)
+               return
+       }
+       mc.TestLog(t, "%s", respBody)
+       return
+}
+
+func (mc *testingSubmgrControl) SendDeleteRequest(t *testing.T, addr string, path string) {
+
+       mc.TestLog(t, "DELETE http://"+addr+"%v", path)
+       req, err := http.NewRequest("DELETE", "http://"+addr+path, nil)
+       if err != nil {
+               mc.TestError(t, "Error reading request. %v", err)
+               return
+       }
+       req.Header.Set("accept", "application/json")
+       client := &http.Client{Timeout: time.Second * 2}
+       resp, err := client.Do(req)
+       if err != nil {
+               mc.TestError(t, "Error reading response. %v", err)
+               return
+       }
+       defer resp.Body.Close()
+
+       mc.TestLog(t, "Response status: %v", resp.Status)
+       mc.TestLog(t, "Response Headers: %v", resp.Header)
+
+       // Note that xapp gets '204 No Content' response through Swagger generated delete route.
+       // Inject route returns '200 OK'
+       if !(strings.Contains(resp.Status, "204 No Content") || strings.Contains(resp.Status, "200 OK")) {
+               mc.TestError(t, "Wrong response status")
+               return
+       }
+
+       respBody, err := ioutil.ReadAll(resp.Body)
+       if err != nil {
+               mc.TestError(t, "Error reading body. %v", err)
+               return
+       }
+       mc.TestLog(t, "%s", respBody)
+       return
+}
+
+func (mc *testingSubmgrControl) SetE2State(t *testing.T, ranNameState string) {
+
+       if err := mc.c.e2IfStateDb.XappRnibStoreAndPublish("RAN_CONNECTION_STATUS_CHANGE", ranNameState, "key1", "data1"); err != nil {
+               t.Errorf("XappRnibStoreAndPublish failed: %v", err)
+       }
+}
+
+func (mc *testingSubmgrControl) VerifyStringExistInSlice(verifiedString string, list []string) bool {
+
+       for _, listItem := range list {
+               if listItem == verifiedString {
+                       return true
+               }
+       }
+       return false
+}