Add GET operations for DeviceGroups and Network Slices #81

ghislainbourgeois · 2023-06-09T21:01:42Z

This PR goal is to introduce GET operations to the API for DeviceGroups and Network Slices. To do so, the following changes were needed:

Move the snapshots from in-memory maps to Mongo in new collections
Add GET operations for DeviceGroups and Slices, looking up in those new Mongo collections
Add some unit tests for the new code
Add test target to the Makefile
Add GitHub workflow to run the unit tests

The larger goal is to be able to create a simple web application to configure SD-Core without requiring a full Aether installation for simple use cases.

Previously, device groups and slices were stored only in memory and used to detect devices added or removed. This was susceptible to cause issue whenever the webconsole service restarted, losing some context. This change will also allow the addition of GET operations for DeviceGroups and NetworkSlices.

onf-bot · 2023-06-09T21:01:44Z

Can one of the admins verify this patch?

onf-bot · 2023-06-09T21:01:44Z

Can one of the admins verify this patch?

thakurajayL · 2023-06-09T22:50:37Z

add to whiltelist

thakurajayL · 2023-06-09T22:50:59Z

ok to test

ghislainbourgeois · 2023-08-31T12:50:53Z

@thakurajayL my org has now signed the CLA, this should be ready for review, sorry it took that long.

thakurajayL · 2023-09-10T18:01:07Z

add to whitelist

thakurajayL · 2023-09-10T18:01:19Z

ok to test

thakurajayL · 2023-09-10T18:02:22Z

.github/workflows/run-webconsole-unit-tests.yml

@@ -0,0 +1,21 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2022 Intel Corporation


May be add ONF copyright

I added the copyright.

thakurajayL · 2023-09-10T18:06:30Z

Dockerfile

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 #

-FROM golang:1.16.0-stretch AS builder
+FROM golang:1.16.0-buster AS builder


How is buster different than stretch ? You can think of updating golang as well.

Stretch is debian 9, which is an archived release under Extended LTS support. Buster is Debian 10, and it is under regular LTS support. The current stable release would be Bookworm, or Debian 12. I will test for further updates with golang updates that do not require extensive changes.

Debian releases

I have updated to latest go version on latest debian version.

thakurajayL · 2023-09-10T18:48:25Z

configapi/api_default.go

+	logger.WebUILog.Infoln("Get Device Group by name")
+
+	var deviceGroup configmodels.DeviceGroups
+	filter := bson.M{"DeviceGroupName": c.Param("group-name")}


Do you think it makes sense to query the presense of the param? and if present then only go to database.

group-name is a path parameter and is defined in the router. There is no way to get in this function if the param is not there.

thakurajayL · 2023-09-10T18:54:24Z

configapi/api_default.go

+	logger.WebUILog.Infoln("Get Network Slice by name")
+
+	var networkSlice configmodels.Slice
+	filter := bson.M{"SliceName": c.Param("slice-name")}


Please add check for query param presence.

It is also a path parameter defined in the router.

thakurajayL · 2023-09-10T18:55:06Z

configapi/api_default.go

+	if networkSlice.SliceName == "" {
+		c.JSON(http.StatusNotFound, nil)
+	} else {
+		c.JSON(http.StatusOK, networkSlice)


Can you share curl command output how it looks like both success & failure case

Sure, in the case that the slice does not exist, we get:

curl -v ${WEBUI_IP}:5000/config/v1/network-slice/default * Trying 10.1.213.205:5000... * Connected to 10.1.213.205 (10.1.213.205) port 5000 (#0) > GET /config/v1/network-slice/default HTTP/1.1 > Host: 10.1.213.205:5000 > User-Agent: curl/7.88.1 > Accept: */* > < HTTP/1.1 404 Not Found < Access-Control-Allow-Credentials: true < Access-Control-Allow-Headers: Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With < Access-Control-Allow-Methods: POST, OPTIONS, GET, PUT, PATCH, DELETE < Access-Control-Allow-Origin: * < Content-Type: application/json; charset=utf-8 < Date: Mon, 11 Sep 2023 20:57:59 GMT < Content-Length: 4 < * Connection #0 to host 10.1.213.205 left intact null

In the case where it exists, we get this:

curl -v ${WEBUI_IP}:5000/config/v1/network-slice/default * Trying 10.1.213.205:5000... * Connected to 10.1.213.205 (10.1.213.205) port 5000 (#0) > GET /config/v1/network-slice/default HTTP/1.1 > Host: 10.1.213.205:5000 > User-Agent: curl/7.88.1 > Accept: */* > < HTTP/1.1 200 OK < Access-Control-Allow-Credentials: true < Access-Control-Allow-Headers: Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, accept, origin, Cache-Control, X-Requested-With < Access-Control-Allow-Methods: POST, OPTIONS, GET, PUT, PATCH, DELETE < Access-Control-Allow-Origin: * < Content-Type: application/json; charset=utf-8 < Date: Mon, 11 Sep 2023 20:59:34 GMT < Content-Length: 238 < * Connection #0 to host 10.1.213.205 left intact {"SliceName":"default","slice-id":{"sst":"1","sd":"010203"},"site-device-group":["cows"],"site-info":{"site-name":"demo","plmn":{"mcc":"208","mnc":"93"},"gNodeBs":[{"name":"demo-gnb1","tac":1}],"upf":{"upf-name":"upf","upf-port":"8805"}}}

configmodels/model_device_groups.go

This reverts commit 786990a.

thakurajayL · 2023-09-27T22:03:05Z

add to whitelist

thakurajayL · 2023-09-27T22:03:18Z

ok to test

thakurajayL · 2023-10-09T14:43:18Z

retest this please

onf-bot · 2023-10-12T09:06:24Z

test this please

onf-bot · 2023-10-12T22:05:43Z

test this please

ghislainbourgeois added 6 commits June 8, 2023 13:47

Use Buster to build, Stretch is out of support

200219e

Add Gets for Device Groups and Network Slices

e9a3a8d

Add tests for new Get methods and fix API

04f5f0c

Add test target to Makefile

13afae2

Add GitHub workflow to run unit tests

bc532c2

ghislainbourgeois added 2 commits June 13, 2023 15:33

Refactor config handler loop and add tests

16c9c9e

Use Errorf instead of Fatalf in tests

17a5457

ghislainbourgeois marked this pull request as ready for review June 13, 2023 19:37

gruyaume mentioned this pull request Aug 29, 2023

[Feat] Only renders page content if backend is available canonical/sdcore-nms#70

Merged

6 tasks

thakurajayL reviewed Sep 10, 2023

View reviewed changes

ghislainbourgeois added 4 commits September 11, 2023 16:03

Update to latest golang version

6d2509f

Add ONF copyright

1fd9f74

Add back 'json:group-name'

786990a

Add missing License and Copyright information

98536a3

ghislainbourgeois requested a review from thakurajayL September 12, 2023 15:13

ghislainbourgeois added 2 commits September 26, 2023 11:20

Revert "Add back 'json:group-name'"

a3093f5

This reverts commit 786990a.

Use 'group-name' as field name in JSON

6dd1539

ghislainbourgeois added 2 commits September 28, 2023 20:27

Update to go 1.21

1e339c9

Prevent duplicate device groups in network slices

f37c9d7

thakurajayL approved these changes Oct 18, 2023

View reviewed changes

thakurajayL merged commit a21ec74 into omec-project:master Oct 18, 2023
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GET operations for DeviceGroups and Network Slices #81

Add GET operations for DeviceGroups and Network Slices #81

ghislainbourgeois commented Jun 9, 2023 •

edited

onf-bot commented Jun 9, 2023

onf-bot commented Jun 9, 2023

thakurajayL commented Jun 9, 2023

thakurajayL commented Jun 9, 2023

ghislainbourgeois commented Aug 31, 2023

thakurajayL commented Sep 10, 2023

thakurajayL commented Sep 10, 2023

thakurajayL Sep 10, 2023

ghislainbourgeois Sep 11, 2023

thakurajayL Sep 10, 2023

ghislainbourgeois Sep 11, 2023

ghislainbourgeois Sep 11, 2023

thakurajayL Sep 10, 2023

ghislainbourgeois Sep 11, 2023

thakurajayL Sep 10, 2023

ghislainbourgeois Sep 11, 2023

thakurajayL Sep 10, 2023

ghislainbourgeois Sep 11, 2023

thakurajayL commented Sep 27, 2023

thakurajayL commented Sep 27, 2023

thakurajayL commented Oct 9, 2023

onf-bot commented Oct 12, 2023

onf-bot commented Oct 12, 2023

		@@ -0,0 +1,21 @@
		# SPDX-License-Identifier: Apache-2.0
		# Copyright 2022 Intel Corporation

Add GET operations for DeviceGroups and Network Slices #81

Add GET operations for DeviceGroups and Network Slices #81

Conversation

ghislainbourgeois commented Jun 9, 2023 • edited

onf-bot commented Jun 9, 2023

onf-bot commented Jun 9, 2023

thakurajayL commented Jun 9, 2023

thakurajayL commented Jun 9, 2023

ghislainbourgeois commented Aug 31, 2023

thakurajayL commented Sep 10, 2023

thakurajayL commented Sep 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thakurajayL commented Sep 27, 2023

thakurajayL commented Sep 27, 2023

thakurajayL commented Oct 9, 2023

onf-bot commented Oct 12, 2023

onf-bot commented Oct 12, 2023

ghislainbourgeois commented Jun 9, 2023 •

edited