Subscription REST interface update
[ric-plt/submgr.git] / pkg / control / ut_ctrl_submgr_test.go
index 197eb43..16c69b1 100644 (file)
 package control
 
 import (
-       "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
+       "fmt"
+       "io/ioutil"
+       "net/http"
+       "strconv"
+       "strings"
        "testing"
        "time"
+
+       "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"
 )
 
 //-----------------------------------------------------------------------------
 //
 //-----------------------------------------------------------------------------
 type testingSubmgrControl struct {
-       testingRmrControl
+       teststub.RmrControl
        c *Control
 }
 
-func createSubmgrControl(desc string, rtfile string, port string) *testingSubmgrControl {
+type Counter struct {
+       Name  string
+       Value uint64
+}
+
+type CountersToBeAdded []Counter
+
+var countersBeforeMap map[string]Counter
+var toBeAddedCountersMap map[string]Counter
+
+func createSubmgrControl(srcId teststub.RmrSrcId, rtgSvc teststub.RmrRtgSvc) *testingSubmgrControl {
        mainCtrl = &testingSubmgrControl{}
-       mainCtrl.testingRmrControl.init(desc, rtfile, port)
+       mainCtrl.RmrControl.Init("SUBMGRCTL", srcId, rtgSvc)
        mainCtrl.c = NewControl()
+       mainCtrl.c.LoggerLevel = int(xapp.Logger.GetLevel())
+       xapp.Logger.Debug("Test: LoggerLevel %v", mainCtrl.c.LoggerLevel)
+       xapp.Logger.Debug("Replacing real db with test db")
+       mainCtrl.c.e2SubsDb = CreateMock()             // This overrides real E2 Subscription database for testing
+       mainCtrl.c.restSubsDb = CreateRestSubsDbMock() // This overrides real REST Subscription database for testing
        xapp.SetReadyCB(mainCtrl.ReadyCB, nil)
        go xapp.RunWithParams(mainCtrl.c, false)
        mainCtrl.WaitCB()
+       mainCtrl.c.ReadyCB(nil)
        return mainCtrl
 }
 
-func (mc *testingSubmgrControl) wait_subs_clean(t *testing.T, e2SubsId int, secs int) bool {
+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.Initialize()
+       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.subIds = subIds
+               mainCtrl.c.registry.register = register
+               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)
+               }
+       }
+       restSubscriptions, err := mainCtrl.c.ReadAllRESTSubscriptionsFromSdl()
+       if err != nil {
+               mc.TestError(t, "%v", err)
+       } else {
+               mainCtrl.c.registry.restSubscriptions = restSubscriptions
+               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)
+       mainCtrl.c.ResetTestFlag = status
+}
+
+func (mc *testingSubmgrControl) removeExistingSubscriptions(t *testing.T) {
+
+       mc.TestLog(t, "Removing existing subscriptions")
+       mainCtrl.c.RemoveAllSubscriptionsFromSdl()
+       mainCtrl.c.registry.subIds = nil
+       // Initialize subIds slice and subscription map
+       mainCtrl.c.registry.Initialize()
+}
+
+func PringSubscriptionQueryResult(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.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*10; i++ {
+               cnt = len(mc.c.registry.register)
+               if cnt == 0 {
+                       return true
+               }
+               time.Sleep(100 * time.Millisecond)
+       }
+       mc.TestError(t, "(submgr) no registry empty within %d secs: %d, register: %v", secs, cnt, mc.c.registry.register)
+       return false
+}
+
+func (mc *testingSubmgrControl) get_registry_next_subid(t *testing.T) uint32 {
+       mc.c.registry.mutex.Lock()
+       defer mc.c.registry.mutex.Unlock()
+       return mc.c.registry.subIds[0]
+}
+
+func (mc *testingSubmgrControl) wait_registry_next_subid_change(t *testing.T, origSubId uint32, secs int) (uint32, bool) {
+       i := 1
+       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(100 * time.Millisecond)
+       }
+       mc.TestError(t, "(submgr) no subId change within %d secs", secs)
+       return 0, false
+}
+
+func (mc *testingSubmgrControl) wait_subs_clean(t *testing.T, e2SubsId uint32, secs int) bool {
        var subs *Subscription
        i := 1
-       for ; i <= secs*2; i++ {
-               subs = mc.c.registry.GetSubscription(uint16(e2SubsId))
+       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 {
-               testError(t, "(general) no clean within %d secs: %s", secs, subs.String())
+               mc.TestError(t, "(submgr) no clean within %d secs: %s", secs, subs.String())
        } else {
-               testError(t, "(general) no clean within %d secs: subs(N/A)", secs)
+               mc.TestError(t, "(submgr) no clean within %d secs: subs(N/A)", secs)
        }
        return false
 }
 
-func (mc *testingSubmgrControl) wait_subs_trans_clean(t *testing.T, e2SubsId int, secs int) bool {
-       var trans *Transaction
+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++ {
-               subs := mc.c.registry.GetSubscription(uint16(e2SubsId))
+       for ; i <= secs*10; i++ {
+               subs := mc.c.registry.GetSubscription(e2SubsId)
                if subs == nil {
                        return true
                }
@@ -73,50 +221,236 @@ func (mc *testingSubmgrControl) wait_subs_trans_clean(t *testing.T, e2SubsId int
                if trans == nil {
                        return true
                }
-               time.Sleep(500 * time.Millisecond)
+               time.Sleep(100 * time.Millisecond)
        }
        if trans != nil {
-               testError(t, "(general) no clean within %d secs: %s", secs, trans.String())
+               mc.TestError(t, "(submgr) no clean within %d secs: %s", secs, trans.String())
        } else {
-               testError(t, "(general) no clean within %d secs: trans(N/A)", secs)
+               mc.TestError(t, "(submgr) no clean within %d secs: trans(N/A)", secs)
        }
        return false
 }
 
-func (mc *testingSubmgrControl) get_subid(t *testing.T) uint16 {
-       mc.c.registry.mutex.Lock()
-       defer mc.c.registry.mutex.Unlock()
-       return mc.c.registry.subIds[0]
+func (mc *testingSubmgrControl) get_subs_entrypoint_cnt(t *testing.T, origSubId uint32) int {
+       subs := mc.c.registry.GetSubscription(origSubId)
+       if subs == nil {
+               mc.TestError(t, "(submgr) no subs %d exists during entrypoint cnt get", origSubId)
+               return -1
+       }
+       return subs.EpList.Size()
 }
 
-func (mc *testingSubmgrControl) wait_subid_change(t *testing.T, origSubId uint16, secs int) (uint16, bool) {
+func (mc *testingSubmgrControl) wait_subs_entrypoint_cnt_change(t *testing.T, origSubId uint32, orig int, secs int) (int, bool) {
+
+       subs := mc.c.registry.GetSubscription(origSubId)
+       if subs == nil {
+               mc.TestError(t, "(submgr) no subs %d exists during entrypoint cnt wait", origSubId)
+               return -1, true
+       }
+
        i := 1
-       for ; i <= secs*2; i++ {
-               mc.c.registry.mutex.Lock()
-               currSubId := mc.c.registry.subIds[0]
-               mc.c.registry.mutex.Unlock()
-               if currSubId != origSubId {
-                       return currSubId, true
+       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)
        }
-       testError(t, "(general) no subId change within %d secs", secs)
+       mc.TestError(t, "(submgr) no subs %d entrypoint cnt change within %d secs", origSubId, secs)
        return 0, false
 }
 
+//
+// Counter check for received message. Note might not be yet handled
+//
 func (mc *testingSubmgrControl) get_msgcounter(t *testing.T) uint64 {
-       return mc.c.msgCounter
+       return mc.c.CntRecvMsg
 }
 
 func (mc *testingSubmgrControl) wait_msgcounter_change(t *testing.T, orig uint64, secs int) (uint64, bool) {
        i := 1
-       for ; i <= secs*2; i++ {
-               curr := mc.c.msgCounter
+       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)
        }
-       testError(t, "(general) no msg counter change within %d secs", secs)
+       mc.TestError(t, "(submgr) no msg counter change within %d secs", secs)
        return 0, false
 }
+
+func (mc *testingSubmgrControl) GetMetrics(t *testing.T) (string, error) {
+       req, err := http.NewRequest("GET", "http://localhost:8080/ric/v1/metrics", nil)
+       if err != nil {
+               return "", fmt.Errorf("Error reading request. %v", err)
+       }
+       client := &http.Client{Timeout: time.Second * 10}
+       resp, err := client.Do(req)
+       if err != nil {
+               return "", fmt.Errorf("Error reading response. %v", err)
+       }
+       defer resp.Body.Close()
+
+       respBody, err := ioutil.ReadAll(resp.Body)
+       if err != nil {
+               return "", fmt.Errorf("Error reading body. %v", err)
+       }
+       return string(respBody[:]), nil
+}
+
+func (mc *testingSubmgrControl) CounterValuesToBeVeriefied(t *testing.T, countersToBeAdded CountersToBeAdded) {
+
+       if len(toBeAddedCountersMap) == 0 {
+               toBeAddedCountersMap = make(map[string]Counter)
+       }
+       for _, counter := range countersToBeAdded {
+               toBeAddedCountersMap[counter.Name] = counter
+       }
+       mc.GetCounterValuesBefore(t)
+}
+
+func (mc *testingSubmgrControl) GetCounterValuesBefore(t *testing.T) {
+       countersBeforeMap = make(map[string]Counter)
+       countersBeforeMap = mc.GetCurrentCounterValues(t, toBeAddedCountersMap)
+}
+
+func (mc *testingSubmgrControl) VerifyCounterValues(t *testing.T) {
+
+       // Check that expected counters are added ok
+       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 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)
+                       }
+               } else {
+                       mc.TestError(t, "Counter %v not in currentCountersMap", toBeAddedCounter.Name)
+               }
+       }
+
+       // Check that not any unexpected counter are added
+       for _, currentCounter := range currentCountersMap {
+               if _, ok := toBeAddedCountersMap[currentCounter.Name]; ok == false {
+                       if beforeCounter, ok := countersBeforeMap[currentCounter.Name]; ok == true {
+                               if currentCounter.Value != beforeCounter.Value {
+                                       mc.TestError(t, "Error: unexpected counter value added: counterName %v, current value %v, expected value %v",
+                                               currentCounter.Name, beforeCounter.Value, beforeCounter.Value)
+
+                                       //fmt.Printf("beforeCounter.Value=%v, toBeAddedCounter.Value=%v, \n",beforeCounter.Value, toBeAddedCounter.Value)
+                               }
+                       } else {
+                               mc.TestError(t, "Counter %v not in countersBeforeMap", beforeCounter.Name)
+                       }
+               }
+       }
+
+       // Make map empty
+       //fmt.Printf("toBeAddedCountersMap=%v\n",toBeAddedCountersMap)
+       toBeAddedCountersMap = make(map[string]Counter)
+}
+
+func (mc *testingSubmgrControl) GetCurrentCounterValues(t *testing.T, chekedCountersMap map[string]Counter) map[string]Counter {
+       countersString, err := mc.GetMetrics(t)
+       if err != nil {
+               mc.TestError(t, "Error GetMetrics() failed %v", err)
+               return nil
+       }
+
+       retCounterMap := make(map[string]Counter)
+       stringsTable := strings.Split(countersString, "\n")
+       for _, counter := range chekedCountersMap {
+               for _, counterString := range stringsTable {
+                       if !strings.Contains(counterString, "#") && strings.Contains(counterString, counter.Name) {
+                               counterString := strings.Split(counterString, " ")
+                               if strings.Contains(counterString[0], counter.Name) {
+                                       val, err := strconv.ParseUint(counterString[1], 10, 64)
+                                       if err != nil {
+                                               mc.TestError(t, "Error: strconv.ParseUint failed %v", err)
+                                       }
+                                       counter.Value = val
+                                       //fmt.Printf("counter=%v\n", counter)
+                                       retCounterMap[counter.Name] = counter
+                               }
+                       }
+               }
+       }
+
+       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) {
+
+       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
+       }
+       req.Header.Set("Cache-Control", "no-cache")
+       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) 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
+       }
+       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
+}