From 2ffd42f0de88f544c715800b3e3e7b1f2f567b09 Mon Sep 17 00:00:00 2001
From: Fabian Seidl <fabian.b.seidl@stud.h-da.de>
Date: Thu, 4 Aug 2022 15:57:17 +0200
Subject: [PATCH] fugly godot commit
---
.golangci.yml | 3 +-
cli/adapter/PndAdapter.go | 36 +++++++-------
cli/cmd/change.go | 2 +-
cli/cmd/changeCommit.go | 2 +-
cli/cmd/changeConfirm.go | 2 +-
cli/cmd/changeGet.go | 2 +-
cli/cmd/changeList.go | 2 +-
cli/cmd/device.go | 2 +-
cli/cmd/deviceCreate.go | 2 +-
cli/cmd/deviceDelete.go | 2 +-
cli/cmd/deviceGet.go | 2 +-
cli/cmd/deviceList.go | 2 +-
cli/cmd/deviceRemove.go | 2 +-
cli/cmd/deviceSet.go | 2 +-
cli/cmd/deviceShow.go | 2 +-
cli/cmd/deviceSubscribe.go | 2 +-
cli/cmd/list.go | 2 +-
cli/cmd/login.go | 2 +-
cli/cmd/logout.go | 2 +-
cli/cmd/pnd.go | 2 +-
cli/cmd/pndCreate.go | 2 +-
cli/cmd/pndGet.go | 2 +-
cli/cmd/pndList.go | 2 +-
cli/cmd/pndRemove.go | 2 +-
cli/cmd/pndUse.go | 2 +-
cli/cmd/prompt.go | 8 ++--
cli/cmd/root.go | 2 +-
cli/cmd/userCreate.go | 2 +-
cli/cmd/userDelete.go | 2 +-
cli/cmd/userGet.go | 2 +-
cli/cmd/userGetAll.go | 2 +-
cli/cmd/userUpdate.go | 2 +-
cli/cmd/utils.go | 2 +-
cli/completer/yangSchemaCompleter.go | 6 +--
controller/api/auth.go | 4 +-
controller/api/change.go | 10 ++--
controller/api/device.go | 8 ++--
controller/api/grpc.go | 4 +-
controller/api/pnd.go | 2 +-
controller/api/role.go | 12 ++---
controller/api/user.go | 10 ++--
controller/cmd/root.go | 2 +-
controller/config/config.go | 36 +++++++-------
controller/config/environment.go | 6 +--
controller/controller.go | 8 ++--
controller/initialise_test.go | 2 +-
controller/interfaces/change/change.go | 2 +-
controller/interfaces/device/device.go | 6 +--
controller/interfaces/event/service.go | 2 +-
controller/interfaces/rbac/rbacService.go | 4 +-
controller/interfaces/rbac/role.go | 2 +-
controller/interfaces/rbac/user.go | 2 +-
controller/interfaces/southbound/sbi.go | 2 +-
controller/interfaces/transport/transport.go | 6 +--
controller/northbound/client/core.go | 2 +-
controller/northbound/client/pnd.go | 2 +-
controller/northbound/client/rbac.go | 6 +--
controller/northbound/client/sbi.go | 2 +-
controller/northbound/server/auth.go | 4 +-
.../northbound/server/auth_interceptor.go | 6 +--
controller/northbound/server/core.go | 10 ++--
controller/northbound/server/csbi.go | 4 +-
controller/northbound/server/nbi.go | 2 +-
controller/northbound/server/pnd.go | 30 ++++++------
controller/northbound/server/sbi.go | 4 +-
controller/northbound/server/topology.go | 6 +--
controller/northbound/server/user.go | 8 ++--
controller/nucleus/change.go | 6 +--
controller/nucleus/clientConfig.go | 2 +-
.../nucleus/database/mongo-connection.go | 4 +-
controller/nucleus/databaseDeviceStore.go | 4 +-
controller/nucleus/databasePndStore.go | 8 ++--
controller/nucleus/databaseSbiStore.go | 4 +-
controller/nucleus/device.go | 48 +++++++++----------
controller/nucleus/deviceFilesystemStore.go | 2 +-
controller/nucleus/deviceService.go | 2 +-
controller/nucleus/deviceServiceMock.go | 12 ++---
controller/nucleus/deviceStore.go | 2 +-
controller/nucleus/deviceWatcher.go | 2 +-
controller/nucleus/genericService.go | 10 ++--
controller/nucleus/gnmi_transport.go | 14 +++---
controller/nucleus/gnmi_transport_test.go | 2 +-
controller/nucleus/initialise_test.go | 8 ++--
controller/nucleus/memoryPndStore.go | 6 +--
controller/nucleus/pndFilesystemStore.go | 6 +--
controller/nucleus/pndStore.go | 4 +-
controller/nucleus/principalNetworkDomain.go | 34 ++++++-------
controller/nucleus/restconf_transport.go | 12 ++---
controller/nucleus/sbiFilesystemStore.go | 4 +-
controller/nucleus/sbiStore.go | 4 +-
controller/nucleus/southbound.go | 28 +++++------
controller/nucleus/transport.go | 2 +-
controller/nucleus/types/types.go | 8 ++--
controller/nucleus/util/path/translate.go | 2 +-
controller/nucleus/util/path/traverse.go | 8 ++--
controller/nucleus/util/pluginVariables.go | 8 ++--
controller/nucleus/util/proto/message.go | 4 +-
controller/rbac/databaseRoleStore.go | 4 +-
controller/rbac/databaseUserStore.go | 4 +-
controller/rbac/role.go | 6 +--
controller/rbac/roleFileSystemStore.go | 12 ++---
controller/rbac/roleStore.go | 2 +-
controller/rbac/user.go | 8 ++--
controller/rbac/userFileSystemStore.go | 12 ++---
controller/rbac/userStore.go | 2 +-
controller/store/changeStores.go | 10 ++--
controller/store/filesystem-settings.go | 10 ++--
controller/store/initialise_test.go | 2 +-
controller/store/oldGenericStore.go | 4 +-
controller/store/storageMode.go | 6 +--
controller/store/utils.go | 8 ++--
controller/topology/links/link.go | 4 +-
controller/topology/nodes/node.go | 4 +-
controller/topology/nodes/nodeService.go | 18 +++----
controller/topology/nodes/nodeStore.go | 6 +--
.../ports/configuration/configuration.go | 4 +-
controller/topology/ports/port.go | 4 +-
controller/topology/ports/portService.go | 18 +++----
controller/topology/ports/portStore.go | 6 +--
controller/topology/routing-tables/route.go | 2 +-
.../topology/routing-tables/routingTable.go | 4 +-
.../routing-tables/routingTableService.go | 18 +++----
.../routing-tables/routingTableStore.go | 6 +--
controller/topology/topologyService.go | 18 +++----
controller/topology/topologyStore.go | 6 +--
csbi/cmd/deploy.go | 2 +-
csbi/cmd/discover.go | 2 +-
csbi/cmd/generate.go | 2 +-
csbi/cmd/hello.go | 4 +-
csbi/cmd/init.go | 2 +-
csbi/cmd/repository.go | 2 +-
csbi/cmd/root.go | 2 +-
csbi/config/config.go | 8 ++--
csbi/deployment.go | 2 +-
csbi/discover.go | 2 +-
csbi/orchestrator.go | 4 +-
csbi/repository.go | 2 +-
csbi/run.go | 2 +-
csbi/templates.go | 8 ++--
csbi/write.go | 4 +-
140 files changed, 423 insertions(+), 422 deletions(-)
diff --git a/.golangci.yml b/.golangci.yml
index 894b443b9..9b743a6ea 100644
--- a/.golangci.yml
+++ b/.golangci.yml
@@ -34,7 +34,7 @@ linters:
# enable the specific needed linters
# see here for full list: https://golangci-lint.run/usage/linters/
# linters to consider: gosimple, containedctx, contextcheck, depguard, errchkjson, errname, exhaustive, exhaustruct, forbidigo,
- # gochecknoinits, gocognit, goconst, gocritic, godot, gofumpt, gomnd, gosec, importas, lll, nestif, nilerr, nlreturn, noctx, nolintlint,
+ # gochecknoinits, gocognit, goconst, gocritic, gofumpt, gomnd, gosec, importas, lll, nestif, nilerr, nlreturn, noctx, nolintlint,
# nosnakecase, paralleltest, prealloc, structcheck, testpackage, tparallel, unparam, wastedassign, wrapcheck, wsl
disable-all: true
enable:
@@ -60,6 +60,7 @@ linters:
- misspell
- nilnil
- predeclared
+ - godot
# custom settings for linters
linters-settings:
diff --git a/cli/adapter/PndAdapter.go b/cli/adapter/PndAdapter.go
index 4c7f8b212..0cf799683 100644
--- a/cli/adapter/PndAdapter.go
+++ b/cli/adapter/PndAdapter.go
@@ -16,7 +16,7 @@ import (
)
// PndAdapter is an API adapter to reflect the NetworkDomain
-// interface
+// interface.
type PndAdapter struct {
id uuid.UUID
endpoint string
@@ -35,12 +35,12 @@ func NewPndAdapter(id, endpoint string) (*PndAdapter, error) {
}, nil
}
-// AddSbi adds an SBI to the PND Adapter. Currently not implemented
+// AddSbi adds an SBI to the PND Adapter. Currently not implemented.
func (p *PndAdapter) AddSbi(s southbound.SouthboundInterface) error {
return &errors.ErrNotYetImplemented{}
}
-// RemoveSbi removes an SBI from the PND Adapter. Currently not implemented
+// RemoveSbi removes an SBI from the PND Adapter. Currently not implemented.
func (p *PndAdapter) RemoveSbi(uuid.UUID) error {
return &errors.ErrNotYetImplemented{}
}
@@ -85,7 +85,7 @@ func (p *PndAdapter) GetFlattenedDevices(ctx context.Context) (*ppb.GetFlattened
return resp, nil
}
-// RemoveDevice removes a device from the controller
+// RemoveDevice removes a device from the controller.
func (p *PndAdapter) RemoveDevice(ctx context.Context, did uuid.UUID) (*ppb.DeleteOndResponse, error) {
resp, err := api.DeleteDevice(ctx, p.endpoint, p.id.String(), did.String())
if err != nil {
@@ -94,7 +94,7 @@ func (p *PndAdapter) RemoveDevice(ctx context.Context, did uuid.UUID) (*ppb.Dele
return resp, nil
}
-// RemovePnd removes a PND from the controller
+// RemovePnd removes a PND from the controller.
func (p *PndAdapter) RemovePnd(ctx context.Context, pid uuid.UUID) (*core.DeletePndResponse, error) {
resp, err := api.DeletePnd(ctx, p.endpoint, pid.String())
if err != nil {
@@ -105,7 +105,7 @@ func (p *PndAdapter) RemovePnd(ctx context.Context, pid uuid.UUID) (*core.Delete
// ChangeOND sends an API call to the controller requesting the creation of
// a change from the provided Operation, path and value. The Change is marked
-// as Pending and times out after the specified timeout period
+// as Pending and times out after the specified timeout period.
func (p *PndAdapter) ChangeOND(ctx context.Context, duid uuid.UUID, operation ppb.ApiOperation, path string, value ...string) (*ppb.SetPathListResponse, error) {
var v string
if len(value) != 0 {
@@ -119,7 +119,7 @@ func (p *PndAdapter) ChangeOND(ctx context.Context, duid uuid.UUID, operation pp
}
// Request sends an API call to the controller requesting the specified path
-// for the specified device
+// for the specified device.
func (p *PndAdapter) Request(ctx context.Context, did uuid.UUID, path string) (*ppb.GetPathResponse, error) {
resp, err := api.GetPath(ctx, p.endpoint, p.id.String(), did.String(), path)
if err != nil {
@@ -129,7 +129,7 @@ func (p *PndAdapter) Request(ctx context.Context, did uuid.UUID, path string) (*
}
// SubscribeONDPath sends an API call to the controller requesting to subscribe
-// to a specific path of a specifc device
+// to a specific path of a specifc device.
func (p *PndAdapter) SubscribeONDPath(ctx context.Context, did uuid.UUID, slist *ppb.SubscriptionList) (ppb.PndService_SubscribePathClient, error) {
resp, err := api.SubscribePath(ctx, p.endpoint, p.id.String(), did.String(), slist)
if err != nil {
@@ -169,7 +169,7 @@ func (p *PndAdapter) RequestAll(ctx context.Context, path string) ([]proto.Messa
}
// ContainsDevice sends an API call to the controller checking if a device
-// with the given UUID is present. Not implemented, always returns false
+// with the given UUID is present. Not implemented, always returns false.
func (p *PndAdapter) ContainsDevice(uuid.UUID) bool {
return false
}
@@ -185,7 +185,7 @@ func (p *PndAdapter) GetSbi(ctx context.Context, sid string) (*ppb.GetSbiRespons
}
// GetSBIs sends an API call to the controller requesting the
-// registered SBIs. Not implemented, always returns nil
+// registered SBIs. Not implemented, always returns nil.
func (p *PndAdapter) GetSBIs(ctx context.Context) (*ppb.GetSbiListResponse, error) {
resp, err := api.GetSBIs(ctx, p.endpoint, p.id.String())
if err != nil {
@@ -194,18 +194,18 @@ func (p *PndAdapter) GetSBIs(ctx context.Context) (*ppb.GetSbiListResponse, erro
return resp, nil
}
-// ID returns the PND Adapter's UUID
+// ID returns the PND Adapter's UUID.
func (p *PndAdapter) ID() uuid.UUID {
return p.id
}
-// Endpoint returns the PND Adapter's endpoint
+// Endpoint returns the PND Adapter's endpoint.
func (p *PndAdapter) Endpoint() string {
return p.endpoint
}
// PendingChanges sends an API call to the controller requesting
-// the UUIDs of all pending changes
+// the UUIDs of all pending changes.
func (p *PndAdapter) PendingChanges(ctx context.Context) ([]*ppb.Change, error) {
resp, err := api.GetChanges(ctx, p.endpoint, p.id.String())
if err != nil {
@@ -215,7 +215,7 @@ func (p *PndAdapter) PendingChanges(ctx context.Context) ([]*ppb.Change, error)
}
// CommittedChanges sends an API call to the controller requesting
-// the UUIDs of all committed changes
+// the UUIDs of all committed changes.
func (p *PndAdapter) CommittedChanges(ctx context.Context) ([]*ppb.Change, error) {
resp, err := api.GetChanges(ctx, p.endpoint, p.id.String())
if err != nil {
@@ -225,7 +225,7 @@ func (p *PndAdapter) CommittedChanges(ctx context.Context) ([]*ppb.Change, error
}
// ConfirmedChanges sends an API call to the controller requesting
-// the UUIDs of all confirmed changes
+// the UUIDs of all confirmed changes.
func (p *PndAdapter) ConfirmedChanges(ctx context.Context) ([]*ppb.Change, error) {
resp, err := api.GetChanges(ctx, p.endpoint, p.id.String())
if err != nil {
@@ -235,7 +235,7 @@ func (p *PndAdapter) ConfirmedChanges(ctx context.Context) ([]*ppb.Change, error
}
// GetChange sends an API call to the controller requesting one or more changes
-// for the specific PND
+// for the specific PND.
func (p *PndAdapter) GetChange(ctx context.Context, identifier ...string) (*ppb.GetChangeResponse, error) {
resp, err := api.GetChange(ctx, p.endpoint, p.id.String(), identifier...)
if err != nil {
@@ -244,7 +244,7 @@ func (p *PndAdapter) GetChange(ctx context.Context, identifier ...string) (*ppb.
return resp, nil
}
-// Commit sends an API call to the controller committing the specified change
+// Commit sends an API call to the controller committing the specified change.
func (p *PndAdapter) Commit(ctx context.Context, cuid uuid.UUID) (*ppb.SetChangeListResponse, error) {
resp, err := api.Commit(ctx, p.endpoint, p.id.String(), cuid.String())
if err != nil {
@@ -253,7 +253,7 @@ func (p *PndAdapter) Commit(ctx context.Context, cuid uuid.UUID) (*ppb.SetChange
return resp, nil
}
-// Confirm sends an API call to the controller confirming the specified change
+// Confirm sends an API call to the controller confirming the specified change.
func (p *PndAdapter) Confirm(ctx context.Context, cuid uuid.UUID) (*ppb.SetChangeListResponse, error) {
resp, err := api.Confirm(ctx, p.endpoint, p.id.String(), cuid.String())
if err != nil {
diff --git a/cli/cmd/change.go b/cli/cmd/change.go
index 07eadbeef..6f7eafc86 100644
--- a/cli/cmd/change.go
+++ b/cli/cmd/change.go
@@ -35,7 +35,7 @@ import (
"github.com/spf13/cobra"
)
-// changeCmd represents the change command
+// changeCmd represents the change command.
var changeCmd = &cobra.Command{
Use: "change",
Short: "manage changes of the specified PND",
diff --git a/cli/cmd/changeCommit.go b/cli/cmd/changeCommit.go
index 2c271e9ca..49e035eed 100644
--- a/cli/cmd/changeCommit.go
+++ b/cli/cmd/changeCommit.go
@@ -37,7 +37,7 @@ import (
"github.com/spf13/cobra"
)
-// commitCmd represents the commit command
+// commitCmd represents the commit command.
var commitCmd = &cobra.Command{
Use: "commit [uuid]",
Args: cobra.ExactArgs(1),
diff --git a/cli/cmd/changeConfirm.go b/cli/cmd/changeConfirm.go
index cdc69f876..249738c6e 100644
--- a/cli/cmd/changeConfirm.go
+++ b/cli/cmd/changeConfirm.go
@@ -37,7 +37,7 @@ import (
"github.com/spf13/cobra"
)
-// confirmCmd represents the confirm command
+// confirmCmd represents the confirm command.
var confirmCmd = &cobra.Command{
Use: "confirm [uuid]",
Args: cobra.ExactArgs(1),
diff --git a/cli/cmd/changeGet.go b/cli/cmd/changeGet.go
index 6495b1e3f..a7c1aa331 100644
--- a/cli/cmd/changeGet.go
+++ b/cli/cmd/changeGet.go
@@ -37,7 +37,7 @@ import (
"google.golang.org/protobuf/encoding/protojson"
)
-// confirmCmd represents the confirm command
+// confirmCmd represents the confirm command.
var getCmd = &cobra.Command{
Use: "get [uuid]",
Args: cobra.ExactArgs(1),
diff --git a/cli/cmd/changeList.go b/cli/cmd/changeList.go
index ad780f4fe..d5b0ea11e 100644
--- a/cli/cmd/changeList.go
+++ b/cli/cmd/changeList.go
@@ -36,7 +36,7 @@ import (
"github.com/spf13/cobra"
)
-// changeListCmd represents the list command
+// changeListCmd represents the list command.
var changeListCmd = &cobra.Command{
Use: "list",
Aliases: []string{"ls"},
diff --git a/cli/cmd/device.go b/cli/cmd/device.go
index 8d72c373c..41a9cd51c 100644
--- a/cli/cmd/device.go
+++ b/cli/cmd/device.go
@@ -41,7 +41,7 @@ var password string
//var duid string
-// deviceCmd represents the device command
+// deviceCmd represents the device command.
var deviceCmd = &cobra.Command{
Use: "device",
Aliases: []string{"dev"},
diff --git a/cli/cmd/deviceCreate.go b/cli/cmd/deviceCreate.go
index d8380a581..9b064025d 100644
--- a/cli/cmd/deviceCreate.go
+++ b/cli/cmd/deviceCreate.go
@@ -40,7 +40,7 @@ import (
tpb "code.fbi.h-da.de/danet/gosdn/api/go/gosdn/transport"
)
-// deviceCreateCmd represents the create command
+// deviceCreateCmd represents the create command.
var deviceCreateCmd = &cobra.Command{
Use: "create",
Short: "creates a device on the controller",
diff --git a/cli/cmd/deviceDelete.go b/cli/cmd/deviceDelete.go
index 7cec3094a..fce779b73 100644
--- a/cli/cmd/deviceDelete.go
+++ b/cli/cmd/deviceDelete.go
@@ -38,7 +38,7 @@ import (
"github.com/spf13/cobra"
)
-// deviceDeleteCmd represents the delete command
+// deviceDeleteCmd represents the delete command.
var deviceDeleteCmd = &cobra.Command{
Use: "delete [uuid] [path]",
Args: cobra.ExactArgs(2),
diff --git a/cli/cmd/deviceGet.go b/cli/cmd/deviceGet.go
index 240eff050..dc47ec9a2 100644
--- a/cli/cmd/deviceGet.go
+++ b/cli/cmd/deviceGet.go
@@ -39,7 +39,7 @@ import (
"google.golang.org/protobuf/encoding/protojson"
)
-// deviceGetCmd represents the get command
+// deviceGetCmd represents the get command.
var deviceGetCmd = &cobra.Command{
Use: "get [uuid] [path]",
Args: cobra.ExactArgs(2),
diff --git a/cli/cmd/deviceList.go b/cli/cmd/deviceList.go
index e1c50d3a6..870332ecb 100644
--- a/cli/cmd/deviceList.go
+++ b/cli/cmd/deviceList.go
@@ -37,7 +37,7 @@ import (
"github.com/spf13/cobra"
)
-// deviceListCmd represents the listDevice command
+// deviceListCmd represents the listDevice command.
var deviceListCmd = &cobra.Command{
Use: "list",
Aliases: []string{"ls"},
diff --git a/cli/cmd/deviceRemove.go b/cli/cmd/deviceRemove.go
index af1346fba..591ee7ad4 100644
--- a/cli/cmd/deviceRemove.go
+++ b/cli/cmd/deviceRemove.go
@@ -38,7 +38,7 @@ import (
"github.com/spf13/cobra"
)
-// deviceRemoveCmd represents the remove command
+// deviceRemoveCmd represents the remove command.
var deviceRemoveCmd = &cobra.Command{
Use: "remove [uuid]",
Aliases: []string{"rm"},
diff --git a/cli/cmd/deviceSet.go b/cli/cmd/deviceSet.go
index baaae3419..60a7fccb9 100644
--- a/cli/cmd/deviceSet.go
+++ b/cli/cmd/deviceSet.go
@@ -44,7 +44,7 @@ var replace bool
var file string
var forcePush bool
-// deviceSetCmd represents the set command
+// deviceSetCmd represents the set command.
var deviceSetCmd = &cobra.Command{
Use: "set [uuid] [path] [value]",
Args: cobra.RangeArgs(2, 3),
diff --git a/cli/cmd/deviceShow.go b/cli/cmd/deviceShow.go
index 12b08b726..51be7acf7 100644
--- a/cli/cmd/deviceShow.go
+++ b/cli/cmd/deviceShow.go
@@ -36,7 +36,7 @@ import (
"github.com/spf13/cobra"
)
-// deviceShowCmd represents the show command
+// deviceShowCmd represents the show command.
var deviceShowCmd = &cobra.Command{
Use: "show",
Args: cobra.ExactArgs(1),
diff --git a/cli/cmd/deviceSubscribe.go b/cli/cmd/deviceSubscribe.go
index 691fed159..1297891fe 100644
--- a/cli/cmd/deviceSubscribe.go
+++ b/cli/cmd/deviceSubscribe.go
@@ -42,7 +42,7 @@ import (
"github.com/spf13/cobra"
)
-// deviceGetCmd represents the get command
+// deviceGetCmd represents the get command.
var deviceSubscribeCmd = &cobra.Command{
Use: "subscribe [uuid] [path]",
Args: cobra.ExactArgs(2),
diff --git a/cli/cmd/list.go b/cli/cmd/list.go
index ad2295ca2..62216bc03 100644
--- a/cli/cmd/list.go
+++ b/cli/cmd/list.go
@@ -40,7 +40,7 @@ import (
//TODO: this requires us to make getDevices in grpc.go of gosdn public and we
//also need to implement GetSBI()
-// pndCmd represents the pnd command
+// pndCmd represents the pnd command.
var listCmd = &cobra.Command{
Use: "list",
Aliases: []string{"ls"},
diff --git a/cli/cmd/login.go b/cli/cmd/login.go
index 0596b6852..c6909d96d 100644
--- a/cli/cmd/login.go
+++ b/cli/cmd/login.go
@@ -40,7 +40,7 @@ import (
"github.com/spf13/viper"
)
-// loginCmd represents the login command
+// loginCmd represents the login command.
var loginCmd = &cobra.Command{
Use: "login",
Short: "Logs in for further actions",
diff --git a/cli/cmd/logout.go b/cli/cmd/logout.go
index 2aeb75e9a..997b035aa 100644
--- a/cli/cmd/logout.go
+++ b/cli/cmd/logout.go
@@ -40,7 +40,7 @@ import (
"github.com/spf13/viper"
)
-// logoutCmd represents the logout command
+// logoutCmd represents the logout command.
var logoutCmd = &cobra.Command{
Use: "logout",
Short: "Logs the current user out",
diff --git a/cli/cmd/pnd.go b/cli/cmd/pnd.go
index 8c42fa66d..82ee3470f 100644
--- a/cli/cmd/pnd.go
+++ b/cli/cmd/pnd.go
@@ -35,7 +35,7 @@ import (
"github.com/spf13/cobra"
)
-// pndCmd represents the pnd command
+// pndCmd represents the pnd command.
var pndCmd = &cobra.Command{
Use: "pnd",
Short: "The pnd command contains all sub-commands for PND management",
diff --git a/cli/cmd/pndCreate.go b/cli/cmd/pndCreate.go
index 4ff4f8c37..ac5c05556 100644
--- a/cli/cmd/pndCreate.go
+++ b/cli/cmd/pndCreate.go
@@ -39,7 +39,7 @@ import (
"github.com/spf13/viper"
)
-// pndCreateCmd represents the create command
+// pndCreateCmd represents the create command.
var pndCreateCmd = &cobra.Command{
Use: "create [description]",
Args: cobra.ExactArgs(0),
diff --git a/cli/cmd/pndGet.go b/cli/cmd/pndGet.go
index 735018a6f..1c2c0a4d6 100644
--- a/cli/cmd/pndGet.go
+++ b/cli/cmd/pndGet.go
@@ -37,7 +37,7 @@ import (
"github.com/spf13/viper"
)
-// pndGetCmd represents the get command
+// pndGetCmd represents the get command.
var pndGetCmd = &cobra.Command{
Use: "get",
Args: cobra.ExactArgs(1),
diff --git a/cli/cmd/pndList.go b/cli/cmd/pndList.go
index b0e46360a..8e77bbb30 100644
--- a/cli/cmd/pndList.go
+++ b/cli/cmd/pndList.go
@@ -38,7 +38,7 @@ import (
"github.com/spf13/cobra"
)
-// pndListCmd represents the listPND command
+// pndListCmd represents the listPND command.
var pndListCmd = &cobra.Command{
Use: "list",
Aliases: []string{"ls"},
diff --git a/cli/cmd/pndRemove.go b/cli/cmd/pndRemove.go
index 98fb573ee..9b4eafca3 100644
--- a/cli/cmd/pndRemove.go
+++ b/cli/cmd/pndRemove.go
@@ -38,7 +38,7 @@ import (
"github.com/spf13/cobra"
)
-// pndRemoveCmd represents the remove command
+// pndRemoveCmd represents the remove command.
var pndRemoveCmd = &cobra.Command{
Use: "remove",
Aliases: []string{"rm"},
diff --git a/cli/cmd/pndUse.go b/cli/cmd/pndUse.go
index f3f77d797..64a1656ba 100644
--- a/cli/cmd/pndUse.go
+++ b/cli/cmd/pndUse.go
@@ -39,7 +39,7 @@ import (
"github.com/spf13/viper"
)
-// pndUseCmd represents the pnd command
+// pndUseCmd represents the pnd command.
var pndUseCmd = &cobra.Command{
Use: "use [uuid]",
Args: cobra.ExactArgs(1),
diff --git a/cli/cmd/prompt.go b/cli/cmd/prompt.go
index 57c72b695..ffc0dd8ca 100644
--- a/cli/cmd/prompt.go
+++ b/cli/cmd/prompt.go
@@ -46,7 +46,7 @@ import (
"github.com/spf13/viper"
)
-// PromptCompleter provides completion for a device
+// PromptCompleter provides completion for a device.
type PromptCompleter struct {
yangSchemaCompleterMap map[uuid.UUID]*completer.YangSchemaCompleter
currentSuggestions []prompt.Suggest
@@ -55,14 +55,14 @@ type PromptCompleter struct {
history []string
}
-// NewPromptCompleter returns a new promptCompleter
+// NewPromptCompleter returns a new promptCompleter.
func NewPromptCompleter() *PromptCompleter {
return &PromptCompleter{
yangSchemaCompleterMap: make(map[uuid.UUID]*completer.YangSchemaCompleter),
}
}
-// Run starts the interactive completion
+// Run starts the interactive completion.
func (pc *PromptCompleter) Run() {
title, _ := pterm.DefaultBigText.WithLetters(
pterm.NewLettersFromString("go"),
@@ -347,7 +347,7 @@ var exitCmd = &cobra.Command{
},
}
-// deviceListCmd represents the listDevice command
+// deviceListCmd represents the listDevice command.
var promptCmd = &cobra.Command{
Use: "prompt",
Short: "The prompt command runs the CLI in an interactive shell.",
diff --git a/cli/cmd/root.go b/cli/cmd/root.go
index 40ad5467d..8e2e8a30f 100644
--- a/cli/cmd/root.go
+++ b/cli/cmd/root.go
@@ -56,7 +56,7 @@ var userToken string
var pndAdapter *adapter.PndAdapter
-// rootCmd represents the base command when called without any subcommands
+// rootCmd represents the base command when called without any subcommands.
var rootCmd = &cobra.Command{
Use: "gosdnc",
Short: "goSDN CLI",
diff --git a/cli/cmd/userCreate.go b/cli/cmd/userCreate.go
index 8246187e1..f233acaf8 100644
--- a/cli/cmd/userCreate.go
+++ b/cli/cmd/userCreate.go
@@ -39,7 +39,7 @@ import (
"github.com/spf13/viper"
)
-// loginCmd represents the login command
+// loginCmd represents the login command.
var userCreateCmd = &cobra.Command{
Use: "userCreate",
Short: "Creates a user with provided data",
diff --git a/cli/cmd/userDelete.go b/cli/cmd/userDelete.go
index 5efe1f925..160ed5f49 100644
--- a/cli/cmd/userDelete.go
+++ b/cli/cmd/userDelete.go
@@ -38,7 +38,7 @@ import (
"github.com/spf13/viper"
)
-// loginCmd represents the login command
+// loginCmd represents the login command.
var userDeleteCmd = &cobra.Command{
Use: "userDelete",
Short: "Deletes a user with provided data",
diff --git a/cli/cmd/userGet.go b/cli/cmd/userGet.go
index 5fcacd84e..f235141dc 100644
--- a/cli/cmd/userGet.go
+++ b/cli/cmd/userGet.go
@@ -39,7 +39,7 @@ import (
"github.com/spf13/viper"
)
-// loginCmd represents the login command
+// loginCmd represents the login command.
var userGetCmd = &cobra.Command{
Use: "userGet",
Short: "Requests one user",
diff --git a/cli/cmd/userGetAll.go b/cli/cmd/userGetAll.go
index e0719ef78..cc9fa0973 100644
--- a/cli/cmd/userGetAll.go
+++ b/cli/cmd/userGetAll.go
@@ -38,7 +38,7 @@ import (
"github.com/spf13/viper"
)
-// loginCmd represents the login command
+// loginCmd represents the login command.
var userGetAllCmd = &cobra.Command{
Use: "userGetAll",
Short: "Requests all the available users",
diff --git a/cli/cmd/userUpdate.go b/cli/cmd/userUpdate.go
index b9a2bd1ff..dc1d5d48a 100644
--- a/cli/cmd/userUpdate.go
+++ b/cli/cmd/userUpdate.go
@@ -39,7 +39,7 @@ import (
"github.com/spf13/viper"
)
-// loginCmd represents the login command
+// loginCmd represents the login command.
var userUpdateCmd = &cobra.Command{
Use: "userUpdate",
Short: "Updates a user with provided data",
diff --git a/cli/cmd/utils.go b/cli/cmd/utils.go
index 27478a991..e6858699f 100644
--- a/cli/cmd/utils.go
+++ b/cli/cmd/utils.go
@@ -53,7 +53,7 @@ func checkIPPort(string) error {
return nil
}
-// sliceContains checks if a slice contains the given item
+// sliceContains checks if a slice contains the given item.
func sliceContains[T comparable](slice []T, toCompare T) bool {
for _, sliceEntry := range slice {
if sliceEntry == toCompare {
diff --git a/cli/completer/yangSchemaCompleter.go b/cli/completer/yangSchemaCompleter.go
index 2ebea1b2a..fe47412d5 100644
--- a/cli/completer/yangSchemaCompleter.go
+++ b/cli/completer/yangSchemaCompleter.go
@@ -12,14 +12,14 @@ import (
)
var (
- // YangSchemaCompletionSeperator is the separator for yang schemas
+ // YangSchemaCompletionSeperator is the separator for yang schemas.
YangSchemaCompletionSeperator = string([]byte{' ', '/'})
)
// The idea of path suggestions for a SBI's YANG schema is heavily inspired by
// gnmic (https://github.com/karimra/gnmic)
-// YangSchemaCompleter represents the YangSchemaCompleter
+// YangSchemaCompleter represents the YangSchemaCompleter.
type YangSchemaCompleter struct {
Cache map[string]*yang.Entry
Entry *yang.Entry
@@ -106,7 +106,7 @@ func promptFromYangEntry(e *yang.Entry) []prompt.Suggest {
return []prompt.Suggest{}
}
-// Complete provides the actual completion
+// Complete provides the actual completion.
func (c *YangSchemaCompleter) Complete(d prompt.Document) []prompt.Suggest {
p := d.GetWordBeforeCursor()
diff --git a/controller/api/auth.go b/controller/api/auth.go
index 02d1331d9..3aaee47ea 100644
--- a/controller/api/auth.go
+++ b/controller/api/auth.go
@@ -8,7 +8,7 @@ import (
nbi "code.fbi.h-da.de/danet/gosdn/controller/northbound/client"
)
-// Login logs a user in
+// Login logs a user in.
func Login(ctx context.Context, addr, username, pwd string) (*apb.LoginResponse, error) {
authClient, err := nbi.AuthClient(addr, dialOptions...)
if err != nil {
@@ -23,7 +23,7 @@ func Login(ctx context.Context, addr, username, pwd string) (*apb.LoginResponse,
return authClient.Login(ctx, r)
}
-// Logout logs a user out
+// Logout logs a user out.
func Logout(ctx context.Context, addr, username string) (*apb.LogoutResponse, error) {
authClient, err := nbi.AuthClient(addr, dialOptions...)
if err != nil {
diff --git a/controller/api/change.go b/controller/api/change.go
index 57b826085..2d5ad6e2e 100644
--- a/controller/api/change.go
+++ b/controller/api/change.go
@@ -9,7 +9,7 @@ import (
nbi "code.fbi.h-da.de/danet/gosdn/controller/northbound/client"
)
-// GetChanges requests all pending and unconfirmed changes from the controller
+// GetChanges requests all pending and unconfirmed changes from the controller.
func GetChanges(ctx context.Context, addr, pnd string) (*ppb.GetChangeListResponse, error) {
client, err := nbi.PndClient(addr, dialOptions...)
if err != nil {
@@ -22,7 +22,7 @@ func GetChanges(ctx context.Context, addr, pnd string) (*ppb.GetChangeListRespon
return client.GetChangeList(ctx, req)
}
-// GetChange requests one or more changes from the controller
+// GetChange requests one or more changes from the controller.
func GetChange(ctx context.Context, addr string, pnd string, args ...string) (*ppb.GetChangeResponse, error) {
client, err := nbi.PndClient(addr, dialOptions...)
if err != nil {
@@ -53,7 +53,7 @@ func Commit(ctx context.Context, addr, pnd string, cuids ...string) (*ppb.SetCha
}
// Confirm sends a Confirm request for one or multiple changes to the
-// controller
+// controller.
func Confirm(ctx context.Context, addr, pnd string, cuids ...string) (*ppb.SetChangeListResponse, error) {
changes := make([]*ppb.SetChange, len(cuids))
for i, arg := range cuids {
@@ -65,7 +65,7 @@ func Confirm(ctx context.Context, addr, pnd string, cuids ...string) (*ppb.SetCh
return CommitConfirm(ctx, addr, pnd, changes)
}
-// CommitConfirm confirms a commit
+// CommitConfirm confirms a commit.
func CommitConfirm(ctx context.Context, addr, pnd string, changes []*ppb.SetChange) (*ppb.SetChangeListResponse, error) {
client, err := nbi.PndClient(addr, dialOptions...)
if err != nil {
@@ -94,7 +94,7 @@ func ChangeRequest(ctx context.Context, addr, did, pid, path, value string, op p
return SendChangeRequest(ctx, addr, pid, req)
}
-// SendChangeRequest sends a change request
+// SendChangeRequest sends a change request.
func SendChangeRequest(ctx context.Context, addr, pid string, req *ppb.ChangeRequest) (*ppb.SetPathListResponse, error) {
pndClient, err := nbi.PndClient(addr, dialOptions...)
if err != nil {
diff --git a/controller/api/device.go b/controller/api/device.go
index a9d91f615..27db2d3df 100644
--- a/controller/api/device.go
+++ b/controller/api/device.go
@@ -72,7 +72,7 @@ func GetDevice(ctx context.Context, addr, pid string, did string) (*ppb.GetOndRe
return pndClient.GetOnd(ctx, req)
}
-// GetSbiSchemaTree gets the sbi tree for a sbi
+// GetSbiSchemaTree gets the sbi tree for a sbi.
func GetSbiSchemaTree(ctx context.Context, addr string, pid, sid uuid.UUID) (map[string]*yang.Entry, error) {
sbiClient, err := nbi.SbiClient(addr, dialOptions...)
if err != nil {
@@ -136,7 +136,7 @@ func GetFlattenedDevices(ctx context.Context, addr, pid string) (*ppb.GetFlatten
return pndClient.GetFlattenedOndList(ctx, req)
}
-// GetPath requests a specific path
+// GetPath requests a specific path.
func GetPath(ctx context.Context, addr, pid, did, path string) (*ppb.GetPathResponse, error) {
pndClient, err := nbi.PndClient(addr, dialOptions...)
if err != nil {
@@ -153,7 +153,7 @@ func GetPath(ctx context.Context, addr, pid, did, path string) (*ppb.GetPathResp
return pndClient.GetPath(ctx, req)
}
-// SubscribePath subscribes to paths on a device
+// SubscribePath subscribes to paths on a device.
func SubscribePath(ctx context.Context, addr, pid, did string, slist *ppb.SubscriptionList) (ppb.PndService_SubscribePathClient, error) {
log.Println("subscribePath called")
pndClient, err := nbi.PndClient(addr, dialOptions...)
@@ -171,7 +171,7 @@ func SubscribePath(ctx context.Context, addr, pid, did string, slist *ppb.Subscr
return pndClient.SubscribePath(ctx, req)
}
-// DeleteDevice deletes a device
+// DeleteDevice deletes a device.
func DeleteDevice(ctx context.Context, addr, pid, did string) (*ppb.DeleteOndResponse, error) {
pndClient, err := nbi.PndClient(addr, dialOptions...)
if err != nil {
diff --git a/controller/api/grpc.go b/controller/api/grpc.go
index b4927635d..f1f9491d6 100644
--- a/controller/api/grpc.go
+++ b/controller/api/grpc.go
@@ -38,7 +38,7 @@ func Init(ctx context.Context, addr string) error {
return viper.WriteConfig()
}
-// GetIds requests all UUID information from the controller
+// GetIds requests all UUID information from the controller.
func GetIds(ctx context.Context, addr string) ([]*ppb.PrincipalNetworkDomain, error) {
resp, err := GetAllCore(ctx, addr)
if err != nil {
@@ -47,7 +47,7 @@ func GetIds(ctx context.Context, addr string) ([]*ppb.PrincipalNetworkDomain, er
return resp.Pnd, nil
}
-// GetAllCore requests all PNDs
+// GetAllCore requests all PNDs.
func GetAllCore(ctx context.Context, addr string) (*pb.GetPndListResponse, error) {
coreClient, err := nbi.CoreClient(addr, dialOptions...)
if err != nil {
diff --git a/controller/api/pnd.go b/controller/api/pnd.go
index a6c9eb0ac..0aaa0a8a1 100644
--- a/controller/api/pnd.go
+++ b/controller/api/pnd.go
@@ -10,7 +10,7 @@ import (
)
// AddPnd takes a name, description and SBI UUID to create a new
-// PrincipalNetworkDomain on the controller
+// PrincipalNetworkDomain on the controller.
func AddPnd(ctx context.Context, addr, name, description, sbi string) (*pb.CreatePndListResponse, error) {
coreClient, err := nbi.CoreClient(addr, dialOptions...)
if err != nil {
diff --git a/controller/api/role.go b/controller/api/role.go
index cef731972..2f7d517ff 100644
--- a/controller/api/role.go
+++ b/controller/api/role.go
@@ -9,7 +9,7 @@ import (
"github.com/google/uuid"
)
-// CreateRoles creates roles with provided data
+// CreateRoles creates roles with provided data.
func CreateRoles(ctx context.Context, addr string, roles []*apb.Role) (*apb.CreateRolesResponse, error) {
roleClient, err := nbi.RoleClient(addr, dialOptions...)
if err != nil {
@@ -24,7 +24,7 @@ func CreateRoles(ctx context.Context, addr string, roles []*apb.Role) (*apb.Crea
return roleClient.CreateRoles(ctx, r)
}
-// GetRole returns one requested role found by name
+// GetRole returns one requested role found by name.
func GetRole(ctx context.Context, addr, name string, uuid uuid.UUID) (*apb.GetRoleResponse, error) {
roleClient, err := nbi.RoleClient(addr, dialOptions...)
if err != nil {
@@ -40,7 +40,7 @@ func GetRole(ctx context.Context, addr, name string, uuid uuid.UUID) (*apb.GetRo
return roleClient.GetRole(ctx, r)
}
-// GetRoles returns all available roles
+// GetRoles returns all available roles.
func GetRoles(ctx context.Context, addr string) (*apb.GetRolesResponse, error) {
roleClient, err := nbi.RoleClient(addr, dialOptions...)
if err != nil {
@@ -54,7 +54,7 @@ func GetRoles(ctx context.Context, addr string) (*apb.GetRolesResponse, error) {
return roleClient.GetRoles(ctx, r)
}
-// UpdateRoles updates the procided roles
+// UpdateRoles updates the procided roles.
func UpdateRoles(ctx context.Context, addr string, roles []*apb.Role) (*apb.UpdateRolesResponse, error) {
roleClient, err := nbi.RoleClient(addr, dialOptions...)
if err != nil {
@@ -69,7 +69,7 @@ func UpdateRoles(ctx context.Context, addr string, roles []*apb.Role) (*apb.Upda
return roleClient.UpdateRoles(ctx, r)
}
-// DeletePermissionForRole deletes the provided permissions from one role found by name
+// DeletePermissionForRole deletes the provided permissions from one role found by name.
func DeletePermissionForRole(ctx context.Context, addr, name string, permissionsToDelete []string) (*apb.DeletePermissionsForRoleResponse, error) {
roleClient, err := nbi.RoleClient(addr, dialOptions...)
if err != nil {
@@ -85,7 +85,7 @@ func DeletePermissionForRole(ctx context.Context, addr, name string, permissions
return roleClient.DeletePermissionsForRole(ctx, r)
}
-// DeleteRoles deletes all the provided roles with their permissions
+// DeleteRoles deletes all the provided roles with their permissions.
func DeleteRoles(ctx context.Context, addr string, roleName []string) (*apb.DeleteRolesResponse, error) {
roleClient, err := nbi.RoleClient(addr, dialOptions...)
if err != nil {
diff --git a/controller/api/user.go b/controller/api/user.go
index f5f49ea4d..484ebe3b7 100644
--- a/controller/api/user.go
+++ b/controller/api/user.go
@@ -10,7 +10,7 @@ import (
"github.com/google/uuid"
)
-// CreateUsers creates users with provided data
+// CreateUsers creates users with provided data.
func CreateUsers(ctx context.Context, addr string, users []*apb.User) (*apb.CreateUsersResponse, error) {
userClient, err := nbi.UserClient(addr, dialOptions...)
if err != nil {
@@ -25,7 +25,7 @@ func CreateUsers(ctx context.Context, addr string, users []*apb.User) (*apb.Crea
return userClient.CreateUsers(ctx, r)
}
-//GetUser returns one requested user found by name
+//GetUser returns one requested user found by name.
func GetUser(ctx context.Context, addr, name string, uuid uuid.UUID) (*apb.GetUserResponse, error) {
userClient, err := nbi.UserClient(addr, dialOptions...)
if err != nil {
@@ -41,7 +41,7 @@ func GetUser(ctx context.Context, addr, name string, uuid uuid.UUID) (*apb.GetUs
return userClient.GetUser(ctx, r)
}
-// GetAllUsers return all the available users
+// GetAllUsers return all the available users.
func GetAllUsers(ctx context.Context, addr string) (*apb.GetUsersResponse, error) {
userClient, err := nbi.UserClient(addr, dialOptions...)
if err != nil {
@@ -55,7 +55,7 @@ func GetAllUsers(ctx context.Context, addr string) (*apb.GetUsersResponse, error
return userClient.GetUsers(ctx, r)
}
-// UpdateUsers updates all provided users
+// UpdateUsers updates all provided users.
func UpdateUsers(ctx context.Context, addr string, users []*apb.User) (*apb.UpdateUsersResponse, error) {
userClient, err := nbi.UserClient(addr, dialOptions...)
if err != nil {
@@ -70,7 +70,7 @@ func UpdateUsers(ctx context.Context, addr string, users []*apb.User) (*apb.Upda
return userClient.UpdateUsers(ctx, r)
}
-// DeleteUsers deletes all provided users
+// DeleteUsers deletes all provided users.
func DeleteUsers(ctx context.Context, addr string, userNames []string) (*apb.DeleteUsersResponse, error) {
userClient, err := nbi.UserClient(addr, dialOptions...)
if err != nil {
diff --git a/controller/cmd/root.go b/controller/cmd/root.go
index 6149c2aff..727634402 100644
--- a/controller/cmd/root.go
+++ b/controller/cmd/root.go
@@ -52,7 +52,7 @@ var csbiOrchestrator string
var pluginFolder string
var security string
-// rootCmd represents the base command when called without any subcommands
+// rootCmd represents the base command when called without any subcommands.
var rootCmd = &cobra.Command{
Use: "gosdn",
Short: "starts the gosdn controller",
diff --git a/controller/config/config.go b/controller/config/config.go
index 1c8fba0be..a5b70bc3c 100644
--- a/controller/config/config.go
+++ b/controller/config/config.go
@@ -23,7 +23,7 @@ const (
jwtSecretKey = "jwtSecret"
gNMISubscriptionsFilePathKey = "gNMISubscriptionsPath"
- // RabbitMQ Broker
+ // RabbitMQ Broker.
amqpPrefixKey = "amqpPrefix"
amqpUserKey = "amqpUser"
amqpPasswordKey = "amqpPassword"
@@ -31,52 +31,52 @@ const (
amqpPortKey = "amqpPort"
)
-// BasePndUUID is an uuid for the base PND
+// BasePndUUID is an uuid for the base PND.
var BasePndUUID uuid.UUID
-// BaseSouthBoundType is the type of the base SBI
+// BaseSouthBoundType is the type of the base SBI.
var BaseSouthBoundType int32
-// BaseSouthBoundUUID is an uuid for the base SBI
+// BaseSouthBoundUUID is an uuid for the base SBI.
var BaseSouthBoundUUID uuid.UUID
-// ChangeTimeout is the default timeout for a change
+// ChangeTimeout is the default timeout for a change.
var ChangeTimeout time.Duration
-// LogLevel ist the default log level
+// LogLevel ist the default log level.
var LogLevel logrus.Level
-// DatabaseConnection holds the credentials and address of the used database
+// DatabaseConnection holds the credentials and address of the used database.
var DatabaseConnection string
-// FilesystemPathToStores determines in which folder the stores should be saved
+// FilesystemPathToStores determines in which folder the stores should be saved.
var FilesystemPathToStores = "stores_testing"
-// JWTDuration determines how long a jwt is valid
+// JWTDuration determines how long a jwt is valid.
var JWTDuration time.Duration
-// JWTSecret determines the scret that is used to sign tokens
+// JWTSecret determines the scret that is used to sign tokens.
var JWTSecret string
-// AMQPPrefix is the amqp prefix
+// AMQPPrefix is the amqp prefix.
var AMQPPrefix string
-// AMQPUser is the amqp user
+// AMQPUser is the amqp user.
var AMQPUser string
-// AMQPPassword is the amqp user password
+// AMQPPassword is the amqp user password.
var AMQPPassword string
-// AMQPHost is the amqp host
+// AMQPHost is the amqp host.
var AMQPHost string
-// AMQPPort is the amqp port
+// AMQPPort is the amqp port.
var AMQPPort string
-// GNMISubscriptionsFilePath is the path to the file used for automated subscriptions
+// GNMISubscriptionsFilePath is the path to the file used for automated subscriptions.
var GNMISubscriptionsFilePath string
-// Init gets called on module import
+// Init gets called on module import.
func Init() {
err := InitializeConfig()
if err != nil {
@@ -84,7 +84,7 @@ func Init() {
}
}
-// InitializeConfig loads the configuration
+// InitializeConfig loads the configuration.
func InitializeConfig() error {
var err error
diff --git a/controller/config/environment.go b/controller/config/environment.go
index 9e916e7c1..e2d2285ae 100644
--- a/controller/config/environment.go
+++ b/controller/config/environment.go
@@ -9,11 +9,11 @@ import (
type Environment int64
const (
- // Development is used for local development
+ // Development is used for local development.
Development Environment = iota
- // Production is used for production deployments
+ // Production is used for production deployments.
Production
- // Testing is used for tests
+ // Testing is used for tests.
Testing
)
diff --git a/controller/controller.go b/controller/controller.go
index a79d4cea9..822c8439a 100644
--- a/controller/controller.go
+++ b/controller/controller.go
@@ -47,7 +47,7 @@ import (
var coreLock sync.RWMutex
var coreOnce sync.Once
-// Core is the representation of the controller's core
+// Core is the representation of the controller's core.
type Core struct {
pndStore networkdomain.PndStore
userService rbac.UserService
@@ -67,7 +67,7 @@ type Core struct {
var c *Core
-// initialize does start-up housekeeping like reading controller config files
+// initialize does start-up housekeeping like reading controller config files.
func initialize() error {
err := config.InitializeConfig()
if err != nil {
@@ -187,7 +187,7 @@ func startGrpc() error {
return nil
}
-// createPrincipalNetworkDomain initializes the controller with an initial PND
+// createPrincipalNetworkDomain initializes the controller with an initial PND.
func createPrincipalNetworkDomain() error {
basePnd, err := c.pndStore.Get(store.Query{ID: config.BasePndUUID})
if err != nil {
@@ -295,7 +295,7 @@ func ensureDefaultUserExists() error {
return nil
}
-// Run calls initialize to start the controller
+// Run calls initialize to start the controller.
func Run(ctx context.Context) error {
var initError error
coreOnce.Do(func() {
diff --git a/controller/initialise_test.go b/controller/initialise_test.go
index b5e8b80a3..d76a591b9 100644
--- a/controller/initialise_test.go
+++ b/controller/initialise_test.go
@@ -12,7 +12,7 @@ import (
const apiEndpoint = "http://localhost:8080"
-// UUIDs for test cases
+// UUIDs for test cases.
var mdid uuid.UUID
var defaultPndID uuid.UUID
var cuid uuid.UUID
diff --git a/controller/interfaces/change/change.go b/controller/interfaces/change/change.go
index 40e8cc90e..72dd99905 100644
--- a/controller/interfaces/change/change.go
+++ b/controller/interfaces/change/change.go
@@ -11,7 +11,7 @@ import (
// Change is an intended change to an OND. It is unique and immutable.
// It has a cuid, a timestamp, and holds both the previous and the new
// state. It keeps track if the state is committed and confirmed. A callback
-// exists to acess the proper transport for the changed OND
+// exists to acess the proper transport for the changed OND.
type Change interface {
ID() uuid.UUID
Commit() error
diff --git a/controller/interfaces/device/device.go b/controller/interfaces/device/device.go
index 8de21b4c6..4becb471c 100644
--- a/controller/interfaces/device/device.go
+++ b/controller/interfaces/device/device.go
@@ -11,7 +11,7 @@ import (
)
// Device represents an Orchestrated Network Device (OND) which is managed by
-// nucleus
+// nucleus.
type Device interface {
ID() uuid.UUID
GetModel() ygot.GoStruct
@@ -24,7 +24,7 @@ type Device interface {
GetModelAsString() (string, error)
}
-// Details contains details of a device used by the cSBI mechanism
+// Details contains details of a device used by the cSBI mechanism.
type Details struct {
ID string
Address string
@@ -62,7 +62,7 @@ func (ld *LoadedDevice) SetConvertFunction(cf func(LoadedDevice) (Device, error)
}
// ConvertToDevice calls the LoadedDevice's convert function and converts the
-// LoadedDevice into a Device
+// LoadedDevice into a Device.
func (ld LoadedDevice) ConvertToDevice() (Device, error) {
return ld.convertFunc(ld)
}
diff --git a/controller/interfaces/event/service.go b/controller/interfaces/event/service.go
index 49cf8f6bc..73f3c97d2 100644
--- a/controller/interfaces/event/service.go
+++ b/controller/interfaces/event/service.go
@@ -2,7 +2,7 @@ package event
import "code.fbi.h-da.de/danet/gosdn/controller/event"
-// Service is the event service
+// Service is the event service.
type Service interface {
PublishEvent(topic string, event event.Event) error
CloseConnection()
diff --git a/controller/interfaces/rbac/rbacService.go b/controller/interfaces/rbac/rbacService.go
index 74c938ac2..eddfbfce1 100644
--- a/controller/interfaces/rbac/rbacService.go
+++ b/controller/interfaces/rbac/rbacService.go
@@ -13,7 +13,7 @@ type UserService interface {
GetAll() ([]User, error)
}
-// LoadedUser represents a User that was loaded
+// LoadedUser represents a User that was loaded.
type LoadedUser struct {
ID string `json:"_id" bson:"_id"`
UserName string `json:"username"`
@@ -32,7 +32,7 @@ type RoleService interface {
GetAll() ([]Role, error)
}
-// LoadedRole represents a Role that was loaded
+// LoadedRole represents a Role that was loaded.
type LoadedRole struct {
ID string `json:"_id" bson:"_id"`
RoleName string `json:"rolename"`
diff --git a/controller/interfaces/rbac/role.go b/controller/interfaces/rbac/role.go
index 41ab642f9..d08884215 100644
--- a/controller/interfaces/rbac/role.go
+++ b/controller/interfaces/rbac/role.go
@@ -2,7 +2,7 @@ package rbac
import "github.com/google/uuid"
-// Role represents a role with permissions
+// Role represents a role with permissions.
type Role interface {
ID() uuid.UUID
Name() string
diff --git a/controller/interfaces/rbac/user.go b/controller/interfaces/rbac/user.go
index 37b4f9021..0cec5417b 100644
--- a/controller/interfaces/rbac/user.go
+++ b/controller/interfaces/rbac/user.go
@@ -2,7 +2,7 @@ package rbac
import "github.com/google/uuid"
-// User represents an User which is managed by rbac
+// User represents an User which is managed by rbac.
type User interface {
ID() uuid.UUID
Name() string
diff --git a/controller/interfaces/southbound/sbi.go b/controller/interfaces/southbound/sbi.go
index 3c6911265..2667d5051 100644
--- a/controller/interfaces/southbound/sbi.go
+++ b/controller/interfaces/southbound/sbi.go
@@ -11,7 +11,7 @@ import (
)
// SouthboundInterface provides an
-// interface for SBI implementations
+// interface for SBI implementations.
type SouthboundInterface interface { // nolint
// SetNode injects SBI specific model
// representation to the transport.
diff --git a/controller/interfaces/transport/transport.go b/controller/interfaces/transport/transport.go
index 2822639fa..2be9f287f 100644
--- a/controller/interfaces/transport/transport.go
+++ b/controller/interfaces/transport/transport.go
@@ -10,7 +10,7 @@ import (
)
// Transport provides an interface for Transport implementations
-// like RESTCONF or gnmi
+// like RESTCONF or gnmi.
type Transport interface {
Get(ctx context.Context, params ...string) (interface{}, error)
Set(ctx context.Context, payload change.Payload, path string, schema *ytypes.Schema) error
@@ -24,13 +24,13 @@ type Transport interface {
}
type (
- // HandleSubscribeResponse is the callback function to handle subcription responses
+ // HandleSubscribeResponse is the callback function to handle subcription responses.
HandleSubscribeResponse func(*gpb.SubscribeResponse, *SubscriptionInformation)
)
// SubscriptionInformation contains additional information used for internal subscriptions
// for distinguishing from which device the information is from, to stop subscriptions and
-// error handling
+// error handling.
type SubscriptionInformation struct {
PndID string
DeviceID string
diff --git a/controller/northbound/client/core.go b/controller/northbound/client/core.go
index eccdb2a6a..1f2e18b17 100644
--- a/controller/northbound/client/core.go
+++ b/controller/northbound/client/core.go
@@ -7,7 +7,7 @@ import (
// CoreClient returns a client for the gRPC Core service. It takes
// the address of the gRPC endpoint and optional grpc.DialOption
-// as argument
+// as argument.
func CoreClient(addr string, opts ...grpc.DialOption) (pb.CoreServiceClient, error) {
conn, err := grpc.Dial(addr, opts...)
if err != nil {
diff --git a/controller/northbound/client/pnd.go b/controller/northbound/client/pnd.go
index 12a513ad0..c392566ea 100644
--- a/controller/northbound/client/pnd.go
+++ b/controller/northbound/client/pnd.go
@@ -7,7 +7,7 @@ import (
// PndClient returns a client for the gRPC PND service. It takes
// the address of the gRPC endpoint and optional grpc.DialOption
-// as argument
+// as argument.
func PndClient(addr string, opts ...grpc.DialOption) (ppb.PndServiceClient, error) {
conn, err := grpc.Dial(addr, opts...)
if err != nil {
diff --git a/controller/northbound/client/rbac.go b/controller/northbound/client/rbac.go
index d6b6c1eaa..c5f9a9700 100644
--- a/controller/northbound/client/rbac.go
+++ b/controller/northbound/client/rbac.go
@@ -7,7 +7,7 @@ import (
// AuthClient returns a client for the gRPC Auth service. It takes
// the address of the gRPC endpoint and optional grpc.DialOption
-// as argument
+// as argument.
func AuthClient(addr string, opts ...grpc.DialOption) (apb.AuthServiceClient, error) {
conn, err := grpc.Dial(addr, opts...)
if err != nil {
@@ -18,7 +18,7 @@ func AuthClient(addr string, opts ...grpc.DialOption) (apb.AuthServiceClient, er
// UserClient returns a client for the gRPC User service. It takes
// the address of the gRPC endpoint and optional grpc.DialOption
-// as argument
+// as argument.
func UserClient(addr string, opts ...grpc.DialOption) (apb.UserServiceClient, error) {
conn, err := grpc.Dial(addr, opts...)
if err != nil {
@@ -29,7 +29,7 @@ func UserClient(addr string, opts ...grpc.DialOption) (apb.UserServiceClient, er
// RoleClient returns a client for the gRPC Role service. It takes
// the address of the gRPC endpoint and optional grpc.DialOption
-// as argument
+// as argument.
func RoleClient(addr string, opts ...grpc.DialOption) (apb.RoleServiceClient, error) {
conn, err := grpc.Dial(addr, opts...)
if err != nil {
diff --git a/controller/northbound/client/sbi.go b/controller/northbound/client/sbi.go
index 43ebcb3fc..c89d58006 100644
--- a/controller/northbound/client/sbi.go
+++ b/controller/northbound/client/sbi.go
@@ -7,7 +7,7 @@ import (
// SbiClient returns a client for the gRPC SBI service. It takes
// the address of the gRPC endpoint and optional grpc.DialOption
-// as argument
+// as argument.
func SbiClient(addr string, opts ...grpc.DialOption) (spb.SbiServiceClient, error) {
conn, err := grpc.Dial(addr, opts...)
if err != nil {
diff --git a/controller/northbound/server/auth.go b/controller/northbound/server/auth.go
index 18eccd0c4..e7459f7b5 100644
--- a/controller/northbound/server/auth.go
+++ b/controller/northbound/server/auth.go
@@ -32,7 +32,7 @@ func NewAuthServer(jwtManager *rbac.JWTManager, userService rbacInterfaces.UserS
}
}
-// Login logs a user in
+// Login logs a user in.
func (s AuthServer) Login(ctx context.Context, request *apb.LoginRequest) (*apb.LoginResponse, error) {
labels := prometheus.Labels{"service": "auth", "rpc": "post"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -74,7 +74,7 @@ func (s AuthServer) Login(ctx context.Context, request *apb.LoginRequest) (*apb.
}, nil
}
-// Logout logs a user out
+// Logout logs a user out.
func (s AuthServer) Logout(ctx context.Context, request *apb.LogoutRequest) (*apb.LogoutResponse, error) {
labels := prometheus.Labels{"service": "auth", "rpc": "post"}
start := metrics.StartHook(labels, grpcRequestsTotal)
diff --git a/controller/northbound/server/auth_interceptor.go b/controller/northbound/server/auth_interceptor.go
index 11338596b..30ffa2ea9 100644
--- a/controller/northbound/server/auth_interceptor.go
+++ b/controller/northbound/server/auth_interceptor.go
@@ -16,7 +16,7 @@ import (
"google.golang.org/grpc/status"
)
-// AuthInterceptor provides an AuthInterceptor
+// AuthInterceptor provides an AuthInterceptor.
type AuthInterceptor struct {
jwtManager *rbac.JWTManager
userService rbacInterfaces.UserService
@@ -36,7 +36,7 @@ func NewAuthInterceptor(
}
}
-// Unary returns a unary interceptor function to authenticate and authorize unary RPC calls
+// Unary returns a unary interceptor function to authenticate and authorize unary RPC calls.
func (auth *AuthInterceptor) Unary() grpc.UnaryServerInterceptor {
return func(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (any, error) {
switch req.(type) {
@@ -57,7 +57,7 @@ func (auth *AuthInterceptor) Unary() grpc.UnaryServerInterceptor {
}
}
-// Stream returns a server interceptor function to authorize stream RPC calls
+// Stream returns a server interceptor function to authorize stream RPC calls.
func (auth *AuthInterceptor) Stream() grpc.StreamServerInterceptor {
return func(
srv interface{},
diff --git a/controller/northbound/server/core.go b/controller/northbound/server/core.go
index 451be0354..388b3ad8f 100644
--- a/controller/northbound/server/core.go
+++ b/controller/northbound/server/core.go
@@ -14,7 +14,7 @@ import (
"github.com/prometheus/client_golang/prometheus"
)
-// CoreServer represents a core server
+// CoreServer represents a core server.
type CoreServer struct {
pb.UnimplementedCoreServiceServer
pndStore networkdomain.PndStore
@@ -27,7 +27,7 @@ func NewCoreServer(pndStore networkdomain.PndStore) *CoreServer {
}
}
-// GetPnd returns a existing pnd
+// GetPnd returns a existing pnd.
func (s CoreServer) GetPnd(ctx context.Context, request *pb.GetPndRequest) (*pb.GetPndResponse, error) {
labels := prometheus.Labels{"service": "core", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -55,7 +55,7 @@ func (s CoreServer) GetPnd(ctx context.Context, request *pb.GetPndRequest) (*pb.
}, nil
}
-// GetPndList returns all existing pnds
+// GetPndList returns all existing pnds.
func (s CoreServer) GetPndList(ctx context.Context, request *pb.GetPndListRequest) (*pb.GetPndListResponse, error) {
labels := prometheus.Labels{"service": "core", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -80,7 +80,7 @@ func (s CoreServer) GetPndList(ctx context.Context, request *pb.GetPndListReques
}, nil
}
-// CreatePndList creates a pnd list
+// CreatePndList creates a pnd list.
func (s CoreServer) CreatePndList(ctx context.Context, request *pb.CreatePndListRequest) (*pb.CreatePndListResponse, error) {
labels := prometheus.Labels{"service": "core", "rpc": "set"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -100,7 +100,7 @@ func (s CoreServer) CreatePndList(ctx context.Context, request *pb.CreatePndList
}, nil
}
-// DeletePnd deletes an existing pnd
+// DeletePnd deletes an existing pnd.
func (s CoreServer) DeletePnd(ctx context.Context, request *pb.DeletePndRequest) (*pb.DeletePndResponse, error) {
labels := prometheus.Labels{"service": "core", "rpc": "set"}
start := metrics.StartHook(labels, grpcRequestsTotal)
diff --git a/controller/northbound/server/csbi.go b/controller/northbound/server/csbi.go
index 00a68aea1..77cb9b7fb 100644
--- a/controller/northbound/server/csbi.go
+++ b/controller/northbound/server/csbi.go
@@ -19,7 +19,7 @@ import (
"google.golang.org/grpc/status"
)
-// CsbiServer represents a csbi server
+// CsbiServer represents a csbi server.
type CsbiServer struct {
cpb.UnimplementedCsbiServiceServer
pndStore networkdomain.PndStore
@@ -32,7 +32,7 @@ func NewCsbiServer(pndStore networkdomain.PndStore) *CsbiServer {
}
}
-// Hello is used for tests
+// Hello is used for tests.
func (s CsbiServer) Hello(ctx context.Context, syn *cpb.Syn) (*cpb.Ack, error) {
labels := prometheus.Labels{"service": "csbi", "rpc": "hello"}
start := metrics.StartHook(labels, grpcRequestsTotal)
diff --git a/controller/northbound/server/nbi.go b/controller/northbound/server/nbi.go
index e17416592..211b30bcf 100644
--- a/controller/northbound/server/nbi.go
+++ b/controller/northbound/server/nbi.go
@@ -29,7 +29,7 @@ type NorthboundInterface struct {
Device *DeviceServer
}
-// NewNBI receives a PndStore and returns a new gRPC *NorthboundInterface
+// NewNBI receives a PndStore and returns a new gRPC *NorthboundInterface.
func NewNBI(
pnds networkdomain.PndStore,
users rbacInterfaces.UserService,
diff --git a/controller/northbound/server/pnd.go b/controller/northbound/server/pnd.go
index c0dc0367d..3805364c1 100644
--- a/controller/northbound/server/pnd.go
+++ b/controller/northbound/server/pnd.go
@@ -23,7 +23,7 @@ import (
"google.golang.org/grpc/status"
)
-// PndServer implements a pnd server
+// PndServer implements a pnd server.
type PndServer struct {
ppb.UnimplementedPndServiceServer
pndStore networkdomain.PndStore
@@ -36,7 +36,7 @@ func NewPndServer(pndStore networkdomain.PndStore) *PndServer {
}
}
-// GetOnd gets a specific ond
+// GetOnd gets a specific ond.
func (p PndServer) GetOnd(ctx context.Context, request *ppb.GetOndRequest) (*ppb.GetOndResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -75,7 +75,7 @@ func (p PndServer) GetOnd(ctx context.Context, request *ppb.GetOndRequest) (*ppb
}, nil
}
-// GetOndList returns a list of existing onds
+// GetOndList returns a list of existing onds.
func (p PndServer) GetOndList(ctx context.Context, request *ppb.GetOndListRequest) (*ppb.GetOndListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -116,7 +116,7 @@ func (p PndServer) GetOndList(ctx context.Context, request *ppb.GetOndListReques
}, nil
}
-// GetFlattenedOndList returns a list of existing onds
+// GetFlattenedOndList returns a list of existing onds.
func (p PndServer) GetFlattenedOndList(ctx context.Context, request *ppb.GetOndListRequest) (*ppb.GetFlattenedOndListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -217,7 +217,7 @@ func genGnmiNotification(path *gnmi.Path, val any) (*gnmi.Notification, error) {
}, nil
}
-// GetSbi gets a specific sbi
+// GetSbi gets a specific sbi.
func (p PndServer) GetSbi(ctx context.Context, request *ppb.GetSbiRequest) (*ppb.GetSbiResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -257,7 +257,7 @@ func (p PndServer) GetSbi(ctx context.Context, request *ppb.GetSbiRequest) (*ppb
}, nil
}
-// GetSbiList gets all existing sbis
+// GetSbiList gets all existing sbis.
func (p PndServer) GetSbiList(ctx context.Context, request *ppb.GetSbiListRequest) (*ppb.GetSbiListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -318,7 +318,7 @@ func stringArrayToUUIDs(sid []string) ([]uuid.UUID, error) {
return UUIDs, nil
}
-// GetPath gets a path on a ond
+// GetPath gets a path on a ond.
func (p PndServer) GetPath(ctx context.Context, request *ppb.GetPathRequest) (*ppb.GetPathResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -371,7 +371,7 @@ func (p PndServer) GetPath(ctx context.Context, request *ppb.GetPathRequest) (*p
}, nil
}
-// GetChange gets a specific change of a ond
+// GetChange gets a specific change of a ond.
func (p PndServer) GetChange(ctx context.Context, request *ppb.GetChangeRequest) (*ppb.GetChangeResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -402,7 +402,7 @@ func (p PndServer) GetChange(ctx context.Context, request *ppb.GetChangeRequest)
}, nil
}
-// GetChangeList gets all existing changes
+// GetChangeList gets all existing changes.
func (p PndServer) GetChangeList(ctx context.Context, request *ppb.GetChangeListRequest) (*ppb.GetChangeListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -479,7 +479,7 @@ func fillChanges(pnd networkdomain.NetworkDomain, all bool, cuid ...string) ([]*
return changes, nil
}
-// SetOndList updates the list of onds
+// SetOndList updates the list of onds.
func (p PndServer) SetOndList(ctx context.Context, request *ppb.SetOndListRequest) (*ppb.SetOndListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "set"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -521,7 +521,7 @@ func (p PndServer) SetOndList(ctx context.Context, request *ppb.SetOndListReques
}, nil
}
-// SetChangeList sets a list of changes
+// SetChangeList sets a list of changes.
func (p PndServer) SetChangeList(ctx context.Context, request *ppb.SetChangeListRequest) (*ppb.SetChangeListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "set"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -573,7 +573,7 @@ func (p PndServer) SetChangeList(ctx context.Context, request *ppb.SetChangeList
}, nil
}
-// SetPathList sets a list of paths
+// SetPathList sets a list of paths.
func (p PndServer) SetPathList(ctx context.Context, request *ppb.SetPathListRequest) (*ppb.SetPathListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "set"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -614,7 +614,7 @@ func (p PndServer) SetPathList(ctx context.Context, request *ppb.SetPathListRequ
}, nil
}
-// SetSbiList sets a list of sbis
+// SetSbiList sets a list of sbis.
func (p PndServer) SetSbiList(ctx context.Context, request *ppb.SetSbiListRequest) (*ppb.SetSbiListResponse, error) {
labels := prometheus.Labels{"service": "pnd", "rpc": "set"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -670,7 +670,7 @@ func filterSbiType(sbiType ppb.SbiType) spb.Type {
return spbType
}
-// DeleteOnd deletes a ond
+// DeleteOnd deletes a ond.
func (p PndServer) DeleteOnd(ctx context.Context, request *ppb.DeleteOndRequest) (*ppb.DeleteOndResponse, error) {
pid, err := uuid.Parse(request.Pid)
if err != nil {
@@ -698,7 +698,7 @@ func (p PndServer) DeleteOnd(ctx context.Context, request *ppb.DeleteOndRequest)
}, nil
}
-// SubscribePath subscribes to specifc paths of an ond
+// SubscribePath subscribes to specifc paths of an ond.
func (p PndServer) SubscribePath(request *ppb.SubscribePathRequest, stream ppb.PndService_SubscribePathServer) error {
pid, err := uuid.Parse(request.Pid)
if err != nil {
diff --git a/controller/northbound/server/sbi.go b/controller/northbound/server/sbi.go
index aefdc38ba..32374d526 100644
--- a/controller/northbound/server/sbi.go
+++ b/controller/northbound/server/sbi.go
@@ -24,7 +24,7 @@ const (
MB
)
-// SbiServer represents a sbi server
+// SbiServer represents a sbi server.
type SbiServer struct {
spb.UnimplementedSbiServiceServer
pndStore networkdomain.PndStore
@@ -37,7 +37,7 @@ func NewSbiServer(pndStore networkdomain.PndStore) *SbiServer {
}
}
-// GetSchema returns the schema of a sbi
+// GetSchema returns the schema of a sbi.
func (s SbiServer) GetSchema(request *spb.GetSchemaRequest, stream spb.SbiService_GetSchemaServer) error {
labels := prometheus.Labels{"service": "pnd", "rpc": "get schema"}
start := metrics.StartHook(labels, grpcRequestsTotal)
diff --git a/controller/northbound/server/topology.go b/controller/northbound/server/topology.go
index e833576bc..60e43fa9c 100644
--- a/controller/northbound/server/topology.go
+++ b/controller/northbound/server/topology.go
@@ -37,7 +37,7 @@ func NewTopologyServer(
}
}
-// AddLink adds a new link to the topology
+// AddLink adds a new link to the topology.
func (t *TopologyServer) AddLink(ctx context.Context, request *topopb.AddLinkRequest) (*topopb.AddLinkResponse, error) {
sourceNode, sourcePort, err := t.ensureNodeAndPortExists(request.Link.SourceNode, request.Link.SourcePort)
if err != nil {
@@ -68,7 +68,7 @@ func (t *TopologyServer) AddLink(ctx context.Context, request *topopb.AddLinkReq
}, nil
}
-// GetTopology returns the current topology in the form of all links
+// GetTopology returns the current topology in the form of all links.
func (t *TopologyServer) GetTopology(ctx context.Context, request *topopb.GetTopologyRequest) (*topopb.GetTopologyResponse, error) {
topo, err := t.topologyService.GetAll()
if err != nil {
@@ -115,7 +115,7 @@ func (t *TopologyServer) GetTopology(ctx context.Context, request *topopb.GetTop
}, nil
}
-// DeleteLink deletes a link
+// DeleteLink deletes a link.
func (t *TopologyServer) DeleteLink(ctx context.Context, request *topopb.DeleteLinkRequest) (*topopb.DeleteLinkResponse, error) {
linkID, err := uuid.Parse(request.Id)
if err != nil {
diff --git a/controller/northbound/server/user.go b/controller/northbound/server/user.go
index f7a4ce57c..3288087fd 100644
--- a/controller/northbound/server/user.go
+++ b/controller/northbound/server/user.go
@@ -37,7 +37,7 @@ func NewUserServer(jwtManager *rbac.JWTManager, userService rbacInterfaces.UserS
}
}
-// CreateUsers creates new users, can be 1 or more
+// CreateUsers creates new users, can be 1 or more.
func (u UserServer) CreateUsers(ctx context.Context, request *apb.CreateUsersRequest) (*apb.CreateUsersResponse, error) {
labels := prometheus.Labels{"service": "auth", "rpc": "post"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -106,7 +106,7 @@ func (u UserServer) GetUser(ctx context.Context, request *apb.GetUserRequest) (*
}, nil
}
-// GetUsers returns all availbale users
+// GetUsers returns all availbale users.
func (u UserServer) GetUsers(ctx context.Context, request *apb.GetUsersRequest) (*apb.GetUsersResponse, error) {
labels := prometheus.Labels{"service": "auth", "rpc": "get"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -133,7 +133,7 @@ func (u UserServer) GetUsers(ctx context.Context, request *apb.GetUsersRequest)
}, nil
}
-// UpdateUsers updates the user data of one or more users provided in the request
+// UpdateUsers updates the user data of one or more users provided in the request.
func (u UserServer) UpdateUsers(ctx context.Context, request *apb.UpdateUsersRequest) (*apb.UpdateUsersResponse, error) {
labels := prometheus.Labels{"service": "auth", "rpc": "post"}
start := metrics.StartHook(labels, grpcRequestsTotal)
@@ -166,7 +166,7 @@ func (u UserServer) UpdateUsers(ctx context.Context, request *apb.UpdateUsersReq
}, nil
}
-// DeleteUsers deletes one or more users provided in the request
+// DeleteUsers deletes one or more users provided in the request.
func (u UserServer) DeleteUsers(ctx context.Context, request *apb.DeleteUsersRequest) (*apb.DeleteUsersResponse, error) {
labels := prometheus.Labels{"service": "auth", "rpc": "delete"}
start := metrics.StartHook(labels, grpcRequestsTotal)
diff --git a/controller/nucleus/change.go b/controller/nucleus/change.go
index 4bd1c388a..feae600c8 100644
--- a/controller/nucleus/change.go
+++ b/controller/nucleus/change.go
@@ -56,7 +56,7 @@ func NewChange(device uuid.UUID, currentState ygot.GoStruct, change ygot.GoStruc
// Change is an intended change to an OND. It is unique and immutable.
// It has a cuid, a timestamp, and holds both the previous and the new
// state. It keeps track if the state is committed and confirmed. A callback
-// exists to acess the proper transport for the changed OND
+// exists to acess the proper transport for the changed OND.
type Change struct {
cuid uuid.UUID
duid uuid.UUID
@@ -72,7 +72,7 @@ type Change struct {
stateManagerCancel context.CancelFunc
}
-// ID returns the Change's UUID
+// ID returns the Change's UUID.
func (c *Change) ID() uuid.UUID {
return c.cuid
}
@@ -103,7 +103,7 @@ func (c *Change) Confirm() error {
}
}
-// Age returns the passed time since the Change was created
+// Age returns the passed time since the Change was created.
func (c *Change) Age() time.Duration {
return time.Since(c.timestamp)
}
diff --git a/controller/nucleus/clientConfig.go b/controller/nucleus/clientConfig.go
index c88b951fc..de6be1a9f 100644
--- a/controller/nucleus/clientConfig.go
+++ b/controller/nucleus/clientConfig.go
@@ -2,7 +2,7 @@ package nucleus
// ClientConfig contains SBI client
// configuration parameters
-// Deprecated in favor of spf viper
+// Deprecated in favor of spf viper.
type ClientConfig struct {
Identifier string `toml:"identifier"`
Endpoint string `toml:"endpoint"`
diff --git a/controller/nucleus/database/mongo-connection.go b/controller/nucleus/database/mongo-connection.go
index c02196508..96520f53d 100644
--- a/controller/nucleus/database/mongo-connection.go
+++ b/controller/nucleus/database/mongo-connection.go
@@ -11,13 +11,13 @@ import (
)
const (
- // Timeout operations after N seconds
+ // Timeout operations after N seconds.
connectTimeout = 5
// DatabaseName is the name of the mongoDB database used.
DatabaseName = "gosdn"
)
-// GetMongoConnection Retrieves a client to the MongoDB
+// GetMongoConnection Retrieves a client to the MongoDB.
func GetMongoConnection() (*mongo.Client, context.Context, context.CancelFunc) {
mongoConnection := config.DatabaseConnection
client, err := mongo.NewClient(options.Client().ApplyURI(mongoConnection))
diff --git a/controller/nucleus/databaseDeviceStore.go b/controller/nucleus/databaseDeviceStore.go
index bde970aaa..a7664706c 100644
--- a/controller/nucleus/databaseDeviceStore.go
+++ b/controller/nucleus/databaseDeviceStore.go
@@ -15,12 +15,12 @@ import (
log "github.com/sirupsen/logrus"
)
-// DatabaseDeviceStore is used to store Devices
+// DatabaseDeviceStore is used to store Devices.
type DatabaseDeviceStore struct {
storeName string
}
-// NewDatabaseDeviceStore returns a DeviceStore
+// NewDatabaseDeviceStore returns a DeviceStore.
func NewDatabaseDeviceStore(pndUUID uuid.UUID) device.Store {
return &DatabaseDeviceStore{
storeName: fmt.Sprintf("device-store-%s.json", pndUUID.String()),
diff --git a/controller/nucleus/databasePndStore.go b/controller/nucleus/databasePndStore.go
index 49352a793..6a8ca9603 100644
--- a/controller/nucleus/databasePndStore.go
+++ b/controller/nucleus/databasePndStore.go
@@ -19,7 +19,7 @@ import (
"google.golang.org/grpc/credentials/insecure"
)
-// DatabasePndStore is used to store PrincipalNetworkDomains
+// DatabasePndStore is used to store PrincipalNetworkDomains.
type DatabasePndStore struct {
pndStoreName string
pendingChannels map[uuid.UUID]chan device.Details
@@ -174,7 +174,7 @@ func (s *DatabasePndStore) Delete(pndToDelete networkdomain.NetworkDomain) (err
}
// PendingChannels holds channels used communicate with pending
-// cSBI deployments
+// cSBI deployments.
func (s *DatabasePndStore) PendingChannels(id uuid.UUID, parseErrors ...error) (chan device.Details, error) {
ch, ok := s.pendingChannels[id]
if !ok {
@@ -183,12 +183,12 @@ func (s *DatabasePndStore) PendingChannels(id uuid.UUID, parseErrors ...error) (
return ch, nil
}
-// AddPendingChannel adds a pending channel to the map
+// AddPendingChannel adds a pending channel to the map.
func (s *DatabasePndStore) AddPendingChannel(id uuid.UUID, ch chan device.Details) {
s.pendingChannels[id] = ch
}
-// RemovePendingChannel removes a pending channel from the map
+// RemovePendingChannel removes a pending channel from the map.
func (s *DatabasePndStore) RemovePendingChannel(id uuid.UUID) {
delete(s.pendingChannels, id)
}
diff --git a/controller/nucleus/databaseSbiStore.go b/controller/nucleus/databaseSbiStore.go
index 9b20be4f6..77e4d4d33 100644
--- a/controller/nucleus/databaseSbiStore.go
+++ b/controller/nucleus/databaseSbiStore.go
@@ -14,7 +14,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// DatabaseSbiStore is used to store SouthboundInterfaces
+// DatabaseSbiStore is used to store SouthboundInterfaces.
type DatabaseSbiStore struct {
sbiStoreName string
}
@@ -96,7 +96,7 @@ func (s *DatabaseSbiStore) Get(query store.Query) (loadedSbi southbound.LoadedSb
return loadedSbi, nil
}
-// GetAll returns all SBIs
+// GetAll returns all SBIs.
func (s *DatabaseSbiStore) GetAll() (loadedSbis []southbound.LoadedSbi, err error) {
client, ctx, cancel := database.GetMongoConnection()
defer cancel()
diff --git a/controller/nucleus/device.go b/controller/nucleus/device.go
index bd3795d78..ae4057ecc 100644
--- a/controller/nucleus/device.go
+++ b/controller/nucleus/device.go
@@ -16,7 +16,7 @@ import (
"google.golang.org/protobuf/proto"
)
-// NewDevice creates a Device
+// NewDevice creates a Device.
func NewDevice(name string, uuidInput uuid.UUID, opt *tpb.TransportOption, sbi southbound.SouthboundInterface) (device.Device, error) {
t, err := NewTransport(opt, sbi)
if err != nil {
@@ -71,7 +71,7 @@ func NewDevice(name string, uuidInput uuid.UUID, opt *tpb.TransportOption, sbi s
}, nil
}
-// CommonDevice represents an OND
+// CommonDevice represents an OND.
type CommonDevice struct {
// UUID represents the Devices UUID
UUID uuid.UUID
@@ -91,57 +91,57 @@ type CommonDevice struct {
transportOptions *tpb.TransportOption
}
-// ID returns the UUID of the Device
+// ID returns the UUID of the Device.
func (d *CommonDevice) ID() uuid.UUID {
return d.UUID
}
-// GetModel returns the ygot representation of the Device
+// GetModel returns the ygot representation of the Device.
func (d *CommonDevice) GetModel() ygot.GoStruct {
return d.Model
}
-// CreateModelCopy returns a copy of the ygot representation of the Device
+// CreateModelCopy returns a copy of the ygot representation of the Device.
func (d *CommonDevice) CreateModelCopy() (ygot.ValidatedGoStruct, error) {
return createValidatedCopy(d)
}
-// Transport returns the Transport of the device
+// Transport returns the Transport of the device.
func (d *CommonDevice) Transport() transport.Transport {
return d.transport
}
-// Name returns the name of the device
+// Name returns the name of the device.
func (d *CommonDevice) Name() string {
return d.name
}
-// SBI returns the sbi of the Device
+// SBI returns the sbi of the Device.
func (d *CommonDevice) SBI() southbound.SouthboundInterface {
return d.sbi
}
-// SetTransport sets the Device's Transport
+// SetTransport sets the Device's Transport.
func (d *CommonDevice) SetTransport(t transport.Transport) {
d.transport = t
}
-// SetName sets the Device's name
+// SetName sets the Device's name.
func (d *CommonDevice) SetName(n string) {
d.name = n
}
-// SetSBI sets the Device's SBI
+// SetSBI sets the Device's SBI.
func (d *CommonDevice) SetSBI(sbi southbound.SouthboundInterface) {
d.sbi = sbi
}
-// ProcessResponse processes a response for the Device
+// ProcessResponse processes a response for the Device.
func (d *CommonDevice) ProcessResponse(resp proto.Message) error {
return d.transport.ProcessResponse(resp, d.Model, d.sbi.Schema())
}
-// IsTransportValid returns a boolean if the transport of a device is valid
+// IsTransportValid returns a boolean if the transport of a device is valid.
func (d *CommonDevice) IsTransportValid() bool {
if d.transportOptions != nil && d.transportOptions.Address != "" {
return true
@@ -155,37 +155,37 @@ type CsbiDevice struct {
CommonDevice
}
-// ID returns the UUID of the Device
+// ID returns the UUID of the Device.
func (d *CsbiDevice) ID() uuid.UUID {
return d.UUID
}
-// GetModel returns the ygot representation of the Device
+// GetModel returns the ygot representation of the Device.
func (d *CsbiDevice) GetModel() ygot.GoStruct {
return d.Model
}
-// CreateModelCopy returns a copy of the ygot representation of the Device
+// CreateModelCopy returns a copy of the ygot representation of the Device.
func (d *CsbiDevice) CreateModelCopy() (ygot.ValidatedGoStruct, error) {
return createValidatedCopy(d)
}
-// Transport returns the Transport of the device
+// Transport returns the Transport of the device.
func (d *CsbiDevice) Transport() transport.Transport {
return d.transport
}
-// Name returns the name of the device
+// Name returns the name of the device.
func (d *CsbiDevice) Name() string {
return d.name
}
-// SBI returns the sbi of the Device
+// SBI returns the sbi of the Device.
func (d *CsbiDevice) SBI() southbound.SouthboundInterface {
return d.sbi
}
-// ProcessResponse processes a response for the Device
+// ProcessResponse processes a response for the Device.
func (d *CsbiDevice) ProcessResponse(resp proto.Message) error {
// TODO: callback to send response to caller
return d.transport.ProcessResponse(resp, d.Model, d.sbi.Schema())
@@ -209,7 +209,7 @@ func createValidatedCopy(d device.Device) (ygot.ValidatedGoStruct, error) {
return validatedCpy, nil
}
-// IsTransportValid returns a boolean if the transport of a device is valid
+// IsTransportValid returns a boolean if the transport of a device is valid.
func (d *CsbiDevice) IsTransportValid() bool {
if d.transportOptions != nil && d.transportOptions.Address != "" {
return true
@@ -218,7 +218,7 @@ func (d *CsbiDevice) IsTransportValid() bool {
return false
}
-// MarshalJSON implements the MarshalJSON interface to store a device as JSON
+// MarshalJSON implements the MarshalJSON interface to store a device as JSON.
func (d *CommonDevice) MarshalJSON() ([]byte, error) {
var transportType string
var transportAddress string
@@ -279,7 +279,7 @@ func (d *CommonDevice) MarshalJSON() ([]byte, error) {
})
}
-// MarshalBSON implements the MarshalBSON interface to store a device as BSON
+// MarshalBSON implements the MarshalBSON interface to store a device as BSON.
func (d *CommonDevice) MarshalBSON() ([]byte, error) {
var transportType string
var transportAddress string
@@ -332,7 +332,7 @@ func (d *CommonDevice) MarshalBSON() ([]byte, error) {
})
}
-// GetModelAsString returns the YANG model of a device as string
+// GetModelAsString returns the YANG model of a device as string.
func (d *CommonDevice) GetModelAsString() (string, error) {
modelAsString, err := ygot.EmitJSON(d.Model, d.getYgotEmitJSONConfig())
if err != nil {
diff --git a/controller/nucleus/deviceFilesystemStore.go b/controller/nucleus/deviceFilesystemStore.go
index 33664b76f..ec10e8468 100644
--- a/controller/nucleus/deviceFilesystemStore.go
+++ b/controller/nucleus/deviceFilesystemStore.go
@@ -12,7 +12,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// FilesystemDeviceStore is the filesystem implementation of the device store
+// FilesystemDeviceStore is the filesystem implementation of the device store.
type FilesystemDeviceStore struct {
pndUUID uuid.UUID
fileMutex sync.Mutex
diff --git a/controller/nucleus/deviceService.go b/controller/nucleus/deviceService.go
index 7f025b5ed..7e2e00c8a 100644
--- a/controller/nucleus/deviceService.go
+++ b/controller/nucleus/deviceService.go
@@ -22,7 +22,7 @@ const (
)
// DeviceService provides a device service implementation.
-// This services provides abstraction between the user (e.g a PND) and the matching store (e.g. deviceStore)
+// This services provides abstraction between the user (e.g a PND) and the matching store (e.g. deviceStore).
type DeviceService struct {
deviceStore device.Store
sbiService southbound.Service
diff --git a/controller/nucleus/deviceServiceMock.go b/controller/nucleus/deviceServiceMock.go
index 8d6fa09ee..e90ec1c49 100644
--- a/controller/nucleus/deviceServiceMock.go
+++ b/controller/nucleus/deviceServiceMock.go
@@ -20,7 +20,7 @@ func NewDeviceServiceMock() device.Service {
}
}
-// Add adds a item device.Device
+// Add adds a item device.Device.
func (t *DeviceServiceMock) Add(item device.Device) error {
_, ok := t.Store[item.ID()]
if ok {
@@ -33,7 +33,7 @@ func (t *DeviceServiceMock) Add(item device.Device) error {
return nil
}
-// Update updates a item device.Device
+// Update updates a item device.Device.
func (t *DeviceServiceMock) Update(item device.Device) error {
_, ok := t.Store[item.ID()]
if ok {
@@ -46,7 +46,7 @@ func (t *DeviceServiceMock) Update(item device.Device) error {
return nil
}
-// UpdateModel updates a item device.Device
+// UpdateModel updates a item device.Device.
func (t *DeviceServiceMock) UpdateModel(item device.Device, model string) error {
_, ok := t.Store[item.ID()]
if ok {
@@ -59,14 +59,14 @@ func (t *DeviceServiceMock) UpdateModel(item device.Device, model string) error
return nil
}
-// Delete deletes a item device.Device
+// Delete deletes a item device.Device.
func (t *DeviceServiceMock) Delete(item device.Device) error {
delete(t.Store, item.ID())
return nil
}
-// Get gets a item device.Device
+// Get gets a item device.Device.
func (t *DeviceServiceMock) Get(query store.Query) (device.Device, error) {
// First search for direct hit on UUID.
item, ok := t.Store[query.ID]
@@ -88,7 +88,7 @@ func (t *DeviceServiceMock) Get(query store.Query) (device.Device, error) {
return item, nil
}
-// GetAll gets all items
+// GetAll gets all items.
func (t *DeviceServiceMock) GetAll() ([]device.LoadedDevice, error) {
var allItems []device.LoadedDevice
diff --git a/controller/nucleus/deviceStore.go b/controller/nucleus/deviceStore.go
index 681209da5..22db66967 100644
--- a/controller/nucleus/deviceStore.go
+++ b/controller/nucleus/deviceStore.go
@@ -10,7 +10,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// NewDeviceStore returns a DeviceStore
+// NewDeviceStore returns a DeviceStore.
func NewDeviceStore(pndUUID uuid.UUID) device.Store {
storeMode := store.GetStoreMode()
log.Debugf("StoreMode: %s", storeMode)
diff --git a/controller/nucleus/deviceWatcher.go b/controller/nucleus/deviceWatcher.go
index 72a4c2021..d6326e43a 100644
--- a/controller/nucleus/deviceWatcher.go
+++ b/controller/nucleus/deviceWatcher.go
@@ -117,7 +117,7 @@ func (d *DeviceWatcher) StopAndRemoveDeviceSubscription(subID uuid.UUID) {
}
// handleSubscribeResponse takes the subscribe response and additional information about the device to distinguish
-// from which device a subscribe response was sent including improved error handling
+// from which device a subscribe response was sent including improved error handling.
func (d *DeviceWatcher) handleSubscribeResponse(resp *gpb.SubscribeResponse, subscriptionInfo *transport.SubscriptionInformation) {
switch resp := resp.Response.(type) {
case *gpb.SubscribeResponse_Error:
diff --git a/controller/nucleus/genericService.go b/controller/nucleus/genericService.go
index a794928e7..af0193d53 100644
--- a/controller/nucleus/genericService.go
+++ b/controller/nucleus/genericService.go
@@ -24,7 +24,7 @@ func NewGenericService[T storableConstraint]() GenericService[T] {
}
}
-// Add adds a item T
+// Add adds a item T.
func (t *GenericService[T]) Add(item T) error {
_, ok := t.Store[item.ID()]
if ok {
@@ -37,7 +37,7 @@ func (t *GenericService[T]) Add(item T) error {
return nil
}
-// Update updates a item T
+// Update updates a item T.
func (t *GenericService[T]) Update(item T) error {
_, ok := t.Store[item.ID()]
if ok {
@@ -50,14 +50,14 @@ func (t *GenericService[T]) Update(item T) error {
return nil
}
-// Delete deletes a item T
+// Delete deletes a item T.
func (t *GenericService[T]) Delete(item T) error {
delete(t.Store, item.ID())
return nil
}
-// Get gets a item T
+// Get gets a item T.
func (t *GenericService[T]) Get(query store.Query) (T, error) {
// First search for direct hit on UUID.
item, ok := t.Store[query.ID]
@@ -79,7 +79,7 @@ func (t *GenericService[T]) Get(query store.Query) (T, error) {
return item, nil
}
-// GetAll gets all items
+// GetAll gets all items.
func (t *GenericService[T]) GetAll() ([]T, error) {
var allItems []T
diff --git a/controller/nucleus/gnmi_transport.go b/controller/nucleus/gnmi_transport.go
index 029c33fa1..f5a4482c7 100644
--- a/controller/nucleus/gnmi_transport.go
+++ b/controller/nucleus/gnmi_transport.go
@@ -195,7 +195,7 @@ func createSetRequest(ctx context.Context, diff *gpb.Notification, json []byte,
return req, nil
}
-//Subscribe subscribes to a gNMI target
+//Subscribe subscribes to a gNMI target.
func (g *Gnmi) Subscribe(ctx context.Context, params ...string) error {
if g.client == nil {
return &errors.ErrNilClient{}
@@ -213,7 +213,7 @@ func (g *Gnmi) ControlPlaneSubscribe(ctx context.Context, subscribeCallbackFunc
return g.controlPlaneSubscribe(ctx, subscribeCallbackFunc, subscriptionInfo)
}
-// Type returns the gNMI transport type
+// Type returns the gNMI transport type.
func (g *Gnmi) Type() string {
return "gnmi"
}
@@ -337,7 +337,7 @@ func (g *Gnmi) processResponseDeletes(deletes []*gpb.Path, deviceModel ygot.Vali
return nil
}
-// Capabilities calls GNMI capabilities
+// Capabilities calls GNMI capabilities.
func (g *Gnmi) Capabilities(ctx context.Context) (interface{}, error) {
log.WithFields(log.Fields{
"target": g.Options.Address,
@@ -351,7 +351,7 @@ func (g *Gnmi) Capabilities(ctx context.Context) (interface{}, error) {
return resp, nil
}
-// get calls GNMI get
+// get calls GNMI get.
func (g *Gnmi) get(ctx context.Context, paths [][]string, origin string) (interface{}, error) {
ctx = context.WithValue(ctx, types.CtxKeyConfig, g.config) //nolint
req, err := gnmi.NewGetRequest(ctx, paths, origin)
@@ -448,7 +448,7 @@ func (g *Gnmi) controlPlaneSubscribe(ctx context.Context, subcribeCallbackFunc f
return gnmi.SubscribeErr(ctx, g.client, opts, g.RespChan)
}
-// Close calls GNMI close
+// Close calls GNMI close.
func (g *Gnmi) Close() error {
return nil
}
@@ -460,12 +460,12 @@ func (g *Gnmi) CustomSet(ctx context.Context, req *gpb.SetRequest) (*gpb.SetResp
return g.client.Set(ctx, req)
}
-// SetPassthrough allows to pass an existing SetRequest. Used for cSBI
+// SetPassthrough allows to pass an existing SetRequest. Used for cSBI.
func (g *Gnmi) SetPassthrough(ctx context.Context, req *gpb.SetRequest) (*gpb.SetResponse, error) {
return g.client.Set(ctx, req)
}
-// GetPassthrough allows to pass an existing GetRequest. Used for cSBI
+// GetPassthrough allows to pass an existing GetRequest. Used for cSBI.
func (g *Gnmi) GetPassthrough(ctx context.Context, req *gpb.GetRequest) (*gpb.GetResponse, error) {
return g.client.Get(ctx, req)
}
diff --git a/controller/nucleus/gnmi_transport_test.go b/controller/nucleus/gnmi_transport_test.go
index 87a1909ae..146b1ce8b 100644
--- a/controller/nucleus/gnmi_transport_test.go
+++ b/controller/nucleus/gnmi_transport_test.go
@@ -25,7 +25,7 @@ import (
"github.com/stretchr/testify/mock"
)
-// testSetupGnmi bootstraps tests for gnmi transport
+// testSetupGnmi bootstraps tests for gnmi transport.
func testSetupGnmi() {
// TODO: Set sane defaults
gnmiConfig = &gnmi.Config{
diff --git a/controller/nucleus/initialise_test.go b/controller/nucleus/initialise_test.go
index 98bbe72e9..88c55cedb 100644
--- a/controller/nucleus/initialise_test.go
+++ b/controller/nucleus/initialise_test.go
@@ -26,7 +26,7 @@ import (
pb "google.golang.org/protobuf/proto"
)
-// UUIDs for test cases
+// UUIDs for test cases.
var did uuid.UUID
var mdid uuid.UUID
var defaultSbiID uuid.UUID
@@ -45,7 +45,7 @@ var stopGnmiTarget chan bool
var mockContext = mock.MatchedBy(func(ctx context.Context) bool { return true })
// TestMain bootstraps all tests. Humongous beast
-// TODO: Move somewhere more sensible
+// TODO: Move somewhere more sensible.
func TestMain(m *testing.M) {
log.SetReportCaller(true)
@@ -176,7 +176,7 @@ func newPnd() pndImplementation {
}
// removeTestPlugins removes the plugins created during running the test in the current directory based on their name consisting of a uuid
-// and the time since they`ve been created
+// and the time since they`ve been created.
func removeTestPlugins() {
currentDirectory := "./"
// pattern to match plugin uuid used as dir name
@@ -204,7 +204,7 @@ func removeTestPlugins() {
}
// isDirYoungerThanSeconds returns true if the provided dir is younger than the given amount in seconds
-// and therefore was created as part of the test suite
+// and therefore was created as part of the test suite.
func isDirYoungerThanSeconds(dirName string, seconds int64) bool {
fileInfo, err := os.Stat(dirName)
if err != nil {
diff --git a/controller/nucleus/memoryPndStore.go b/controller/nucleus/memoryPndStore.go
index c86337899..15cc6909e 100644
--- a/controller/nucleus/memoryPndStore.go
+++ b/controller/nucleus/memoryPndStore.go
@@ -63,7 +63,7 @@ func (t *MemoryPndStore) GetAll() ([]networkdomain.NetworkDomain, error) {
}
// PendingChannels holds channels used communicate with pending
-// cSBI deployments
+// cSBI deployments.
func (t *MemoryPndStore) PendingChannels(id uuid.UUID, parseErrors ...error) (chan device.Details, error) {
ch, ok := t.pendingChannels[id]
if !ok {
@@ -72,12 +72,12 @@ func (t *MemoryPndStore) PendingChannels(id uuid.UUID, parseErrors ...error) (ch
return ch, nil
}
-// AddPendingChannel adds a pending channel to the map
+// AddPendingChannel adds a pending channel to the map.
func (t *MemoryPndStore) AddPendingChannel(id uuid.UUID, ch chan device.Details) {
t.pendingChannels[id] = ch
}
-// RemovePendingChannel removes a pending channel from the map
+// RemovePendingChannel removes a pending channel from the map.
func (t *MemoryPndStore) RemovePendingChannel(id uuid.UUID) {
delete(t.pendingChannels, id)
}
diff --git a/controller/nucleus/pndFilesystemStore.go b/controller/nucleus/pndFilesystemStore.go
index 8720714fb..c179d5330 100644
--- a/controller/nucleus/pndFilesystemStore.go
+++ b/controller/nucleus/pndFilesystemStore.go
@@ -167,7 +167,7 @@ func (t *FilesystemPndStore) GetAll() ([]networkdomain.NetworkDomain, error) {
}
// PendingChannels holds channels used communicate with pending
-// cSBI deployments
+// cSBI deployments.
func (t *FilesystemPndStore) PendingChannels(id uuid.UUID, parseErrors ...error) (chan device.Details, error) {
ch, ok := t.pendingChannels[id]
if !ok {
@@ -176,12 +176,12 @@ func (t *FilesystemPndStore) PendingChannels(id uuid.UUID, parseErrors ...error)
return ch, nil
}
-// AddPendingChannel adds a pending channel to the map
+// AddPendingChannel adds a pending channel to the map.
func (t *FilesystemPndStore) AddPendingChannel(id uuid.UUID, ch chan device.Details) {
t.pendingChannels[id] = ch
}
-// RemovePendingChannel removes a pending channel from the map
+// RemovePendingChannel removes a pending channel from the map.
func (t *FilesystemPndStore) RemovePendingChannel(id uuid.UUID) {
delete(t.pendingChannels, id)
}
diff --git a/controller/nucleus/pndStore.go b/controller/nucleus/pndStore.go
index 6e4a4b005..61f87daa9 100644
--- a/controller/nucleus/pndStore.go
+++ b/controller/nucleus/pndStore.go
@@ -16,11 +16,11 @@ type LoadedPnd struct {
Description string `json:"description,omitempty"`
}
-// PndStore is used to store PrincipalNetworkDomains
+// PndStore is used to store PrincipalNetworkDomains.
type PndStore struct {
}
-// NewPndStore returns a PndStore
+// NewPndStore returns a PndStore.
func NewPndStore() networkdomain.PndStore {
storeMode := store.GetStoreMode()
log.Debugf("StoreMode: %s", storeMode)
diff --git a/controller/nucleus/principalNetworkDomain.go b/controller/nucleus/principalNetworkDomain.go
index c264b6335..ea13d0988 100644
--- a/controller/nucleus/principalNetworkDomain.go
+++ b/controller/nucleus/principalNetworkDomain.go
@@ -49,7 +49,7 @@ import (
// changeStores in memory for now.
var changeStoreMap = make(map[uuid.UUID]*store.ChangeStore)
-// NewPND creates a Principle Network Domain
+// NewPND creates a Principle Network Domain.
func NewPND(
name string,
description string,
@@ -163,17 +163,17 @@ func (pnd *pndImplementation) Devices() []device.LoadedDevice {
return allDevices
}
-// GetName returns the name of the PND
+// GetName returns the name of the PND.
func (pnd *pndImplementation) GetName() string {
return pnd.Name
}
-// GetDescription returns the current description of the PND
+// GetDescription returns the current description of the PND.
func (pnd *pndImplementation) GetDescription() string {
return pnd.Description
}
-// GetSBIs returns the registered SBIs
+// GetSBIs returns the registered SBIs.
func (pnd *pndImplementation) GetSBIs() ([]southbound.SouthboundInterface, error) {
sbis, err := pnd.southboundService.GetAll()
if err != nil {
@@ -182,7 +182,7 @@ func (pnd *pndImplementation) GetSBIs() ([]southbound.SouthboundInterface, error
return sbis, nil
}
-// GetSBIs returns the registered SBIs
+// GetSBIs returns the registered SBIs.
func (pnd *pndImplementation) GetSBI(sbiUUID uuid.UUID) (southbound.SouthboundInterface, error) {
sbis, err := pnd.southboundService.Get(store.Query{ID: sbiUUID})
if err != nil {
@@ -191,18 +191,18 @@ func (pnd *pndImplementation) GetSBI(sbiUUID uuid.UUID) (southbound.SouthboundIn
return sbis, nil
}
-// Destroy destroys the PND
+// Destroy destroys the PND.
func (pnd *pndImplementation) Destroy() error {
return destroy()
}
-// AddSbi adds a SBI to the PND which will be supported
+// AddSbi adds a SBI to the PND which will be supported.
func (pnd *pndImplementation) AddSbi(s southbound.SouthboundInterface) error {
return pnd.addSbi(s)
}
// RemoveSbi removes a SBI from the PND
-// devices and remove the devices using this SBI
+// devices and remove the devices using this SBI.
func (pnd *pndImplementation) RemoveSbi(sid uuid.UUID) error {
var associatedDevices []device.LoadedDevice
@@ -238,7 +238,7 @@ func (pnd *pndImplementation) RemoveSbi(sid uuid.UUID) error {
return pnd.removeSbi(sid)
}
-// AddDevice adds a new device to the PND
+// AddDevice adds a new device to the PND.
func (pnd *pndImplementation) AddDevice(name string, opt *tpb.TransportOption, sid uuid.UUID) (uuid.UUID, error) {
labels := prometheus.Labels{"type": opt.Type.String()}
start := metrics.StartHook(labels, deviceCreationsTotal)
@@ -270,7 +270,7 @@ func (pnd *pndImplementation) AddDevice(name string, opt *tpb.TransportOption, s
return pnd.addDevice(d)
}
-// TODO: (maba): This should be changed to UUID
+// TODO: (maba): This should be changed to UUID.
func (pnd *pndImplementation) GetDevice(identifier string) (device.Device, error) {
id, err := uuid.Parse(identifier)
if err != nil {
@@ -291,12 +291,12 @@ func (pnd *pndImplementation) GetDevice(identifier string) (device.Device, error
return d, nil
}
-// RemoveDevice removes a device from the PND
+// RemoveDevice removes a device from the PND.
func (pnd *pndImplementation) RemoveDevice(uuid uuid.UUID) error {
return pnd.removeDevice(uuid)
}
-// UpdateDeviceModel updates a device from the PND
+// UpdateDeviceModel updates a device from the PND.
func (pnd *pndImplementation) UpdateDevice(device device.Device, modelAsString string) error {
err := pnd.deviceService.UpdateModel(device, modelAsString)
if err != nil {
@@ -311,7 +311,7 @@ func (pnd *pndImplementation) UpdateDevice(device device.Device, modelAsString s
return err
}
-// Actual implementation, bind to struct if necessary
+// Actual implementation, bind to struct if necessary.
func destroy() error {
return nil
}
@@ -397,7 +397,7 @@ func (pnd *pndImplementation) MarshalDevice(identifier string) (string, error) {
return string(jsonTree), nil
}
-// Request sends a get request to a specific device
+// Request sends a get request to a specific device.
func (pnd *pndImplementation) Request(uuid uuid.UUID, path string) (proto.Message, error) {
d, err := pnd.deviceService.Get(store.Query{
ID: uuid,
@@ -434,7 +434,7 @@ func (pnd *pndImplementation) Request(uuid uuid.UUID, path string) (proto.Messag
return resp, nil
}
-// RequestAll sends a request for all registered devices
+// RequestAll sends a request for all registered devices.
func (pnd *pndImplementation) RequestAll(path string) error {
allDevices, err := pnd.deviceService.GetAll()
if err != nil {
@@ -497,7 +497,7 @@ func (pnd *pndImplementation) ensureIntendedConfigurationIsAppliedOnDevice(devic
//nolint:gocyclo
// ChangeOND creates a change from the provided Operation, path and value.
-// The Change is Pending and times out after the specified timeout period
+// The Change is Pending and times out after the specified timeout period.
func (pnd *pndImplementation) ChangeOND(duid uuid.UUID, operation ppb.ApiOperation, path string, value ...string) (uuid.UUID, error) {
//TODO: check if we can get cyclomatic complexity from 16 to at least 15
d, err := pnd.deviceService.Get(store.Query{
@@ -929,7 +929,7 @@ func saveStreamToFile[T StreamClient](sc T, filename string, id uuid.UUID) (err
return nil
}
-// MarshalBSON implements the MarshalBSON interface to store a device as BSON
+// MarshalBSON implements the MarshalBSON interface to store a device as BSON.
func (pnd *pndImplementation) MarshalBSON() ([]byte, error) {
return bson.Marshal(&struct {
ID string `bson:"_id"`
diff --git a/controller/nucleus/restconf_transport.go b/controller/nucleus/restconf_transport.go
index 07ecbb1f2..c00c852d6 100644
--- a/controller/nucleus/restconf_transport.go
+++ b/controller/nucleus/restconf_transport.go
@@ -12,32 +12,32 @@ import (
// possibility to access a Restconf endpoint.
type Restconf struct{}
-// Get not yet implemented
+// Get not yet implemented.
func (r Restconf) Get(ctx context.Context, params ...string) (interface{}, error) {
return nil, &errors.ErrNotYetImplemented{}
}
-// Set not yet implemented
+// Set not yet implemented.
func (r Restconf) Set(ctx context.Context, params ...interface{}) error {
return &errors.ErrNotYetImplemented{}
}
-// Subscribe not yet implemented
+// Subscribe not yet implemented.
func (r Restconf) Subscribe(ctx context.Context, params ...string) error {
return &errors.ErrNotYetImplemented{}
}
-// Type not yet implemented
+// Type not yet implemented.
func (r Restconf) Type() string {
return "restconf"
}
-// GetOptions not yet implemented
+// GetOptions not yet implemented.
func (r Restconf) GetOptions() interface{} {
return &errors.ErrNotYetImplemented{}
}
-// ProcessResponse not yet implemented
+// ProcessResponse not yet implemented.
func (r Restconf) ProcessResponse(resp interface{}, root interface{}, models *ytypes.Schema) error {
return &errors.ErrNotYetImplemented{}
}
diff --git a/controller/nucleus/sbiFilesystemStore.go b/controller/nucleus/sbiFilesystemStore.go
index 7f8a4e95e..7ead5bf27 100644
--- a/controller/nucleus/sbiFilesystemStore.go
+++ b/controller/nucleus/sbiFilesystemStore.go
@@ -13,7 +13,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// FilesystemSbiStore is used to store SouthboundInterfaces
+// FilesystemSbiStore is used to store SouthboundInterfaces.
type FilesystemSbiStore struct {
pndUUID uuid.UUID
fileMutex sync.Mutex
@@ -138,7 +138,7 @@ func (s *FilesystemSbiStore) Get(query store.Query) (southbound.LoadedSbi, error
return sbi, &errors.ErrCouldNotFind{ID: query.ID, Name: query.Name}
}
-// GetAll returns all SBIs
+// GetAll returns all SBIs.
func (s *FilesystemSbiStore) GetAll() ([]southbound.LoadedSbi, error) {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
diff --git a/controller/nucleus/sbiStore.go b/controller/nucleus/sbiStore.go
index f413ae6f5..5b07b69ea 100644
--- a/controller/nucleus/sbiStore.go
+++ b/controller/nucleus/sbiStore.go
@@ -9,11 +9,11 @@ import (
"github.com/google/uuid"
)
-// SbiStore is used to store SouthboundInterfaces
+// SbiStore is used to store SouthboundInterfaces.
type SbiStore struct {
}
-// NewSbiStore returns a sbiStore
+// NewSbiStore returns a sbiStore.
func NewSbiStore(pndUUID uuid.UUID) southbound.Store {
storeMode := store.GetStoreMode()
diff --git a/controller/nucleus/southbound.go b/controller/nucleus/southbound.go
index 72278e294..4e3f4c1bd 100644
--- a/controller/nucleus/southbound.go
+++ b/controller/nucleus/southbound.go
@@ -84,17 +84,17 @@ type OpenConfig struct {
// SbiIdentifier returns the string representation of
// the SBI
-// deprecated
+// deprecated.
func (oc *OpenConfig) SbiIdentifier() string {
return "openconfig"
}
-// Name returns the name of a sbi
+// Name returns the name of a sbi.
func (oc *OpenConfig) Name() string {
return oc.SbiIdentifier()
}
-// Schema returns a ygot generated openconfig Schema as ytypes.Schema
+// Schema returns a ygot generated openconfig Schema as ytypes.Schema.
func (oc *OpenConfig) Schema() *ytypes.Schema {
schema, err := openconfig.Schema()
oc.schema = schema
@@ -165,17 +165,17 @@ func unmarshal(schema *ytypes.Schema, bytes []byte, path *gpb.Path, goStruct ygo
return ygot.MergeStructInto(goStruct, validatedDeepCopy, opts...)
}
-// ID returns the ID of the OpenConfig SBI
+// ID returns the ID of the OpenConfig SBI.
func (oc *OpenConfig) ID() uuid.UUID {
return oc.id
}
-// SetID sets the ID of the OpenConfig SBI
+// SetID sets the ID of the OpenConfig SBI.
func (oc *OpenConfig) SetID(id uuid.UUID) {
oc.id = id
}
-// Type returns the Southbound's type
+// Type returns the Southbound's type.
func (oc *OpenConfig) Type() spb.Type {
return spb.Type_TYPE_OPENCONFIG
}
@@ -188,7 +188,7 @@ type SouthboundPlugin struct {
manifest *plugin.Manifest
}
-// Name returns the name of a sbi
+// Name returns the name of a sbi.
func (p *SouthboundPlugin) Name() string {
return "plugin"
}
@@ -199,7 +199,7 @@ func (p *SouthboundPlugin) SetNode(schema *yang.Entry, root interface{}, path *g
return p.sbi.SetNode(schema, root, path, val, opts...)
}
-// Schema returns a ygot generated Schema as ytypes.Schema
+// Schema returns a ygot generated Schema as ytypes.Schema.
func (p *SouthboundPlugin) Schema() *ytypes.Schema {
return p.sbi.Schema()
}
@@ -215,12 +215,12 @@ func (p *SouthboundPlugin) ID() uuid.UUID {
return p.sbi.ID()
}
-// SetID sets the ID of the SouthboundPlugin's SBI
+// SetID sets the ID of the SouthboundPlugin's SBI.
func (p *SouthboundPlugin) SetID(id uuid.UUID) {
p.sbi.SetID(id)
}
-// Type returns the Southbound's type of the SouthboundPlugin
+// Type returns the Southbound's type of the SouthboundPlugin.
func (p *SouthboundPlugin) Type() spb.Type {
return p.sbi.Type()
}
@@ -297,7 +297,7 @@ func (p *SouthboundPlugin) Update() error {
return nil
}
-// MarshalJSON implements the MarshalJSON interface to store a sbi as JSON
+// MarshalJSON implements the MarshalJSON interface to store a sbi as JSON.
func (p *SouthboundPlugin) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
ID string `json:"_id"`
@@ -308,7 +308,7 @@ func (p *SouthboundPlugin) MarshalJSON() ([]byte, error) {
})
}
-// MarshalJSON implements the MarshalJSON interface to store a sbi as JSON
+// MarshalJSON implements the MarshalJSON interface to store a sbi as JSON.
func (oc *OpenConfig) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
ID string `json:"_id"`
@@ -319,7 +319,7 @@ func (oc *OpenConfig) MarshalJSON() ([]byte, error) {
})
}
-// MarshalBSON implements the MarshalBSON interface to store a sbi as BSON
+// MarshalBSON implements the MarshalBSON interface to store a sbi as BSON.
func (p *SouthboundPlugin) MarshalBSON() ([]byte, error) {
return bson.Marshal(&struct {
ID string `bson:"_id"`
@@ -330,7 +330,7 @@ func (p *SouthboundPlugin) MarshalBSON() ([]byte, error) {
})
}
-// MarshalBSON implements the MarshalBSON interface to store a sbi as BSON
+// MarshalBSON implements the MarshalBSON interface to store a sbi as BSON.
func (oc *OpenConfig) MarshalBSON() ([]byte, error) {
return bson.Marshal(&struct {
ID string `bson:"_id"`
diff --git a/controller/nucleus/transport.go b/controller/nucleus/transport.go
index 384cd5071..a2db1ff28 100644
--- a/controller/nucleus/transport.go
+++ b/controller/nucleus/transport.go
@@ -8,7 +8,7 @@ import (
)
// NewTransport receives TransportOptions and returns an appropriate Transport
-// implementation
+// implementation.
func NewTransport(opts *tpb.TransportOption, sbi southbound.SouthboundInterface) (transport.Transport, error) {
if opts == nil {
return nil, &errors.ErrInvalidParameters{
diff --git a/controller/nucleus/types/types.go b/controller/nucleus/types/types.go
index aa514b17b..bc8228c30 100644
--- a/controller/nucleus/types/types.go
+++ b/controller/nucleus/types/types.go
@@ -3,14 +3,14 @@ package types
// CtxKeyType is a custom type to be used as key in a context.WithValue() or
// context.Value() call. For more information see:
// https://www.calhoun.io/pitfalls-of-context-values-and-how-to-avoid-or-mitigate-them/
-// TODO: Unexport to comply with best practice
+// TODO: Unexport to comply with best practice.
type CtxKeyType string
const (
- // CtxKeyOpts context key for gnmi.SubscribeOptions
+ // CtxKeyOpts context key for gnmi.SubscribeOptions.
CtxKeyOpts CtxKeyType = "opts"
- // CtxKeyConfig is a context key for gnmi.Config
+ // CtxKeyConfig is a context key for gnmi.Config.
CtxKeyConfig = "config"
- // CtxKeyOperation is a context key for a gNMI operation (update, replace, delete)
+ // CtxKeyOperation is a context key for a gNMI operation (update, replace, delete).
CtxKeyOperation = "op"
)
diff --git a/controller/nucleus/util/path/translate.go b/controller/nucleus/util/path/translate.go
index fdd6ab1f4..6d6ab7f27 100644
--- a/controller/nucleus/util/path/translate.go
+++ b/controller/nucleus/util/path/translate.go
@@ -6,7 +6,7 @@ import (
gpb "github.com/openconfig/gnmi/proto/gnmi"
)
-// ToStrings translates a gNMI path to a slice of strings
+// ToStrings translates a gNMI path to a slice of strings.
func ToStrings(path *gpb.Path) []string {
elems := make([]string, len(path.Elem))
for i, e := range path.Elem {
diff --git a/controller/nucleus/util/path/traverse.go b/controller/nucleus/util/path/traverse.go
index 2505fe9f4..0615422df 100644
--- a/controller/nucleus/util/path/traverse.go
+++ b/controller/nucleus/util/path/traverse.go
@@ -11,13 +11,13 @@ import (
const delim = "/"
-// Element represents a node in a path containing its name and possible child nodes
+// Element represents a node in a path containing its name and possible child nodes.
type Element struct {
Children []*Element
Name string
}
-// Print prints the path element to stdout. It calls printElement recursively
+// Print prints the path element to stdout. It calls printElement recursively.
func (p *Element) Print() {
printElement(0, p)
}
@@ -34,7 +34,7 @@ func printElement(indent int, pe *Element) {
}
}
-// ParseSchema takes a YANG schema and parses it into paths
+// ParseSchema takes a YANG schema and parses it into paths.
func ParseSchema(schema *ytypes.Schema, root string) (map[string]*Element, error) {
paths := make(map[string]*Element)
tree := schema.SchemaTree
@@ -69,7 +69,7 @@ func processEntry(e *yang.Entry) *Element {
}
// Strings constructs a slice containing all possible root to leaf paths.
-// Calls stringBuilder internally
+// Calls stringBuilder internally.
func Strings(paths map[string]*Element) []string {
ch := make(chan string)
stop := make(chan bool)
diff --git a/controller/nucleus/util/pluginVariables.go b/controller/nucleus/util/pluginVariables.go
index dc1851885..27d876432 100644
--- a/controller/nucleus/util/pluginVariables.go
+++ b/controller/nucleus/util/pluginVariables.go
@@ -2,15 +2,15 @@ package util
const (
// GoStructName references the name of a generated gostruct file that has
- // been requested while creating a new device of type plugin/csbi
+ // been requested while creating a new device of type plugin/csbi.
GoStructName string = "gostructs.go"
// ManifestFileName references the name of a manifest file that has been
- // requested while creating a new device of type plugin/csbi
+ // requested while creating a new device of type plugin/csbi.
ManifestFileName string = "plugin.yml"
// GoStructAdditionsName references the name of a additional file
// containing the sbi specific methods. It is provided in the process of
- // creating a new device of type plugin/csbi
+ // creating a new device of type plugin/csbi.
GoStructAdditionsName string = "csbiAdditions.go"
- // PluginOutputName references the name of a generated plugin
+ // PluginOutputName references the name of a generated plugin.
PluginOutputName string = "plugin.so"
)
diff --git a/controller/nucleus/util/proto/message.go b/controller/nucleus/util/proto/message.go
index cda7787d7..96db7baec 100644
--- a/controller/nucleus/util/proto/message.go
+++ b/controller/nucleus/util/proto/message.go
@@ -12,7 +12,7 @@ import (
Copycat source: https://dev.to/techschoolguru/go-generate-serialize-protobuf-message-4m7a
*/
-// Write writes protocol buffer message to binary file
+// Write writes protocol buffer message to binary file.
func Write(message proto.Message, filename string) error {
data, err := proto.Marshal(message)
if err != nil {
@@ -28,7 +28,7 @@ func Write(message proto.Message, filename string) error {
}
// Read reads a binary file (containing a marshaled protocol buffer message)
-// and unmarshals it back into a protocol buffer message
+// and unmarshals it back into a protocol buffer message.
func Read(filename string, message proto.Message) error {
data, err := ioutil.ReadFile(filepath.Clean(filename))
if err != nil {
diff --git a/controller/rbac/databaseRoleStore.go b/controller/rbac/databaseRoleStore.go
index 6fd402e83..871edf47e 100644
--- a/controller/rbac/databaseRoleStore.go
+++ b/controller/rbac/databaseRoleStore.go
@@ -15,7 +15,7 @@ import (
"go.mongodb.org/mongo-driver/mongo/options"
)
-// DatabaseRoleStore is used to store roles in database
+// DatabaseRoleStore is used to store roles in database.
type DatabaseRoleStore struct {
roleStoreName string
}
@@ -174,7 +174,7 @@ func (s *DatabaseRoleStore) GetAll() (loadedRoles []rbac.LoadedRole, err error)
return loadedRoles, nil
}
-// Update updates the role
+// Update updates the role.
func (s *DatabaseRoleStore) Update(roleToUpdate rbac.Role) (err error) {
var updatedLoadedRole rbac.LoadedRole
diff --git a/controller/rbac/databaseUserStore.go b/controller/rbac/databaseUserStore.go
index e58f54756..b1f6eeee7 100644
--- a/controller/rbac/databaseUserStore.go
+++ b/controller/rbac/databaseUserStore.go
@@ -15,7 +15,7 @@ import (
"go.mongodb.org/mongo-driver/mongo/options"
)
-// DatabaseUserStore is used to store users in database
+// DatabaseUserStore is used to store users in database.
type DatabaseUserStore struct {
userStoreName string
}
@@ -140,7 +140,7 @@ func (s *DatabaseUserStore) getByName(nameOfUser string) (loadedUser rbac.Loaded
return loadedUser, nil
}
-// GetAll returns all Users
+// GetAll returns all Users.
func (s *DatabaseUserStore) GetAll() (loadedUsers []rbac.LoadedUser, err error) {
client, ctx, cancel := database.GetMongoConnection()
defer cancel()
diff --git a/controller/rbac/role.go b/controller/rbac/role.go
index a506247ac..0e7c01b14 100644
--- a/controller/rbac/role.go
+++ b/controller/rbac/role.go
@@ -49,7 +49,7 @@ func (r Role) GetPermissions() []string {
return r.Permissions
}
-// RemovePermissionsFromRole takes permissions that should be removed from a role and updates the current permissions accordingly
+// RemovePermissionsFromRole takes permissions that should be removed from a role and updates the current permissions accordingly.
func (r *Role) RemovePermissionsFromRole(permissionsToRemove []string) {
for _, permToRemove := range permissionsToRemove {
r.removePermissionFromRoles(permToRemove)
@@ -65,7 +65,7 @@ func (r *Role) removePermissionFromRoles(permToRemove string) {
}
}
-// MarshalJSON implements the MarshalJSON interface to store a role as JSON
+// MarshalJSON implements the MarshalJSON interface to store a role as JSON.
func (r *Role) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
RoleID uuid.UUID `json:"_id"`
@@ -80,7 +80,7 @@ func (r *Role) MarshalJSON() ([]byte, error) {
})
}
-// MarshalBSON implments the MarshalBSON interface to store a role as BSON
+// MarshalBSON implments the MarshalBSON interface to store a role as BSON.
func (r *Role) MarshalBSON() ([]byte, error) {
return bson.Marshal(&struct {
RoleID string `bson:"_id"`
diff --git a/controller/rbac/roleFileSystemStore.go b/controller/rbac/roleFileSystemStore.go
index d9f71993c..b6785cd66 100644
--- a/controller/rbac/roleFileSystemStore.go
+++ b/controller/rbac/roleFileSystemStore.go
@@ -11,7 +11,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// FileSystemRoleStore is the filesystem implementation of the role store
+// FileSystemRoleStore is the filesystem implementation of the role store.
type FileSystemRoleStore struct {
fileMutex sync.Mutex
pathToRoleFile string
@@ -58,7 +58,7 @@ func (s *FileSystemRoleStore) writeAllRolesToFile(roles []rbac.LoadedRole) error
return nil
}
-// Add adds a Role to the Role store
+// Add adds a Role to the Role store.
func (s *FileSystemRoleStore) Add(roleToAdd rbac.Role) error {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -84,7 +84,7 @@ func (s *FileSystemRoleStore) Add(roleToAdd rbac.Role) error {
return nil
}
-//Delete deletes a Role from the Role store
+//Delete deletes a Role from the Role store.
func (s *FileSystemRoleStore) Delete(roleToDelete rbac.Role) error {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -112,7 +112,7 @@ func (s *FileSystemRoleStore) Delete(roleToDelete rbac.Role) error {
return &errors.ErrCouldNotDelete{Identifier: roleToDelete.ID(), Type: roleToDelete, Err: err}
}
-//Get takes a Roles ID and return the Role if found
+//Get takes a Roles ID and return the Role if found.
func (s *FileSystemRoleStore) Get(query store.Query) (rbac.LoadedRole, error) {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -132,7 +132,7 @@ func (s *FileSystemRoleStore) Get(query store.Query) (rbac.LoadedRole, error) {
return role, &errors.ErrCouldNotFind{ID: query.ID, Name: query.Name}
}
-// GetAll returns all the Roles
+// GetAll returns all the Roles.
func (s *FileSystemRoleStore) GetAll() ([]rbac.LoadedRole, error) {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -141,7 +141,7 @@ func (s *FileSystemRoleStore) GetAll() ([]rbac.LoadedRole, error) {
return Roles, err
}
-//Update updates an exsisting Role
+//Update updates an exsisting Role.
func (s *FileSystemRoleStore) Update(roleToUpdate rbac.Role) error {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
diff --git a/controller/rbac/roleStore.go b/controller/rbac/roleStore.go
index 908f81033..ad76beaa7 100644
--- a/controller/rbac/roleStore.go
+++ b/controller/rbac/roleStore.go
@@ -5,7 +5,7 @@ import (
"code.fbi.h-da.de/danet/gosdn/controller/store"
)
-// NewRoleStore returns a roleStore
+// NewRoleStore returns a roleStore.
func NewRoleStore() rbac.RoleStore {
storeMode := store.GetStoreMode()
diff --git a/controller/rbac/user.go b/controller/rbac/user.go
index 52514adc5..19d9dc4f6 100644
--- a/controller/rbac/user.go
+++ b/controller/rbac/user.go
@@ -60,12 +60,12 @@ func (u *User) GetToken() string {
return u.Token
}
-// SetName sets the name of the user
+// SetName sets the name of the user.
func (u *User) SetName(name string) {
u.UserName = name
}
-// SetToken sets the token of the user
+// SetToken sets the token of the user.
func (u *User) SetToken(token string) {
u.Token = token
}
@@ -75,7 +75,7 @@ func (u *User) GetSalt() string {
return u.Salt
}
-// MarshalJSON implements the MarshalJSON interface to store a user as JSON
+// MarshalJSON implements the MarshalJSON interface to store a user as JSON.
func (u *User) MarshalJSON() ([]byte, error) {
return json.Marshal(&struct {
UserID uuid.UUID `json:"_id"`
@@ -94,7 +94,7 @@ func (u *User) MarshalJSON() ([]byte, error) {
})
}
-// MarshalBSON implments the MarshalBSON interface to store a user as BSON
+// MarshalBSON implments the MarshalBSON interface to store a user as BSON.
func (u *User) MarshalBSON() ([]byte, error) {
return bson.Marshal(&struct {
UserID string `bson:"_id"`
diff --git a/controller/rbac/userFileSystemStore.go b/controller/rbac/userFileSystemStore.go
index 2eb30c241..4c181842f 100644
--- a/controller/rbac/userFileSystemStore.go
+++ b/controller/rbac/userFileSystemStore.go
@@ -11,7 +11,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// FileSystemUserStore is the filesystem implementation of the user store
+// FileSystemUserStore is the filesystem implementation of the user store.
type FileSystemUserStore struct {
fileMutex sync.Mutex
pathToUserFile string
@@ -58,7 +58,7 @@ func (s *FileSystemUserStore) writeAllUsersToFile(users []rbac.LoadedUser) error
return nil
}
-// Add adds a User to the User store
+// Add adds a User to the User store.
func (s *FileSystemUserStore) Add(UserToAdd rbac.User) error {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -84,7 +84,7 @@ func (s *FileSystemUserStore) Add(UserToAdd rbac.User) error {
return nil
}
-//Delete deletes a User from the User store
+//Delete deletes a User from the User store.
func (s *FileSystemUserStore) Delete(userToDelete rbac.User) error {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -112,7 +112,7 @@ func (s *FileSystemUserStore) Delete(userToDelete rbac.User) error {
return &errors.ErrCouldNotDelete{Identifier: userToDelete.ID(), Type: userToDelete, Err: err}
}
-//Get takes a Users ID and return the User if found
+//Get takes a Users ID and return the User if found.
func (s *FileSystemUserStore) Get(query store.Query) (rbac.LoadedUser, error) {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -132,7 +132,7 @@ func (s *FileSystemUserStore) Get(query store.Query) (rbac.LoadedUser, error) {
return user, &errors.ErrCouldNotFind{ID: query.ID, Name: query.Name}
}
-// GetAll returns all the Users
+// GetAll returns all the Users.
func (s *FileSystemUserStore) GetAll() ([]rbac.LoadedUser, error) {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
@@ -141,7 +141,7 @@ func (s *FileSystemUserStore) GetAll() ([]rbac.LoadedUser, error) {
return Users, err
}
-//Update updates an exsisting user
+//Update updates an exsisting user.
func (s *FileSystemUserStore) Update(userToUpdate rbac.User) error {
s.fileMutex.Lock()
defer s.fileMutex.Unlock()
diff --git a/controller/rbac/userStore.go b/controller/rbac/userStore.go
index f9f646b3b..48e6c8618 100644
--- a/controller/rbac/userStore.go
+++ b/controller/rbac/userStore.go
@@ -5,7 +5,7 @@ import (
"code.fbi.h-da.de/danet/gosdn/controller/store"
)
-// NewUserStore returns a userStore
+// NewUserStore returns a userStore.
func NewUserStore() rbac.UserStore {
storeMode := store.GetStoreMode()
diff --git a/controller/store/changeStores.go b/controller/store/changeStores.go
index 8b07a09c4..3b38a6e00 100644
--- a/controller/store/changeStores.go
+++ b/controller/store/changeStores.go
@@ -9,12 +9,12 @@ import (
ppb "code.fbi.h-da.de/danet/gosdn/api/go/gosdn/pnd"
)
-// ChangeStore is used to store Changes
+// ChangeStore is used to store Changes.
type ChangeStore struct {
*genericStore
}
-// NewChangeStore returns a ChangeStore
+// NewChangeStore returns a ChangeStore.
func NewChangeStore() *ChangeStore {
return &ChangeStore{genericStore: newGenericStore()}
}
@@ -39,17 +39,17 @@ func (s *ChangeStore) GetChange(id uuid.UUID) (change.Change, error) {
return c, nil
}
-// Pending returns the UUIDs of all pending changes
+// Pending returns the UUIDs of all pending changes.
func (s *ChangeStore) Pending() []uuid.UUID {
return filterChanges(s, ppb.ChangeState_CHANGE_STATE_PENDING)
}
-// Committed returns the UUIDs of all pending changes
+// Committed returns the UUIDs of all pending changes.
func (s *ChangeStore) Committed() []uuid.UUID {
return filterChanges(s, ppb.ChangeState_CHANGE_STATE_COMMITTED)
}
-// Confirmed returns the UUIDs of all pending changes
+// Confirmed returns the UUIDs of all pending changes.
func (s *ChangeStore) Confirmed() []uuid.UUID {
return filterChanges(s, ppb.ChangeState_CHANGE_STATE_CONFIRMED)
}
diff --git a/controller/store/filesystem-settings.go b/controller/store/filesystem-settings.go
index 5a23dd0b9..cba093e64 100644
--- a/controller/store/filesystem-settings.go
+++ b/controller/store/filesystem-settings.go
@@ -1,14 +1,14 @@
package store
const (
- // PndFilename is the name of the file where the pnds are stored
+ // PndFilename is the name of the file where the pnds are stored.
PndFilename string = "pndStore.json"
- // DeviceFilenameSuffix is the suffix of the file where the devices are stored
+ // DeviceFilenameSuffix is the suffix of the file where the devices are stored.
DeviceFilenameSuffix string = "deviceStore.json"
- // SbiFilenameSuffix is the suffix of the file where the sbis are stored
+ // SbiFilenameSuffix is the suffix of the file where the sbis are stored.
SbiFilenameSuffix string = "sbiStore.json"
- // UserFilename is the name of the file where the users are stored
+ // UserFilename is the name of the file where the users are stored.
UserFilename string = "userStore.json"
- // RoleFilename is the name of the file where the roles are stored
+ // RoleFilename is the name of the file where the roles are stored.
RoleFilename string = "roleStore.json"
)
diff --git a/controller/store/initialise_test.go b/controller/store/initialise_test.go
index 732bad161..894d994b3 100644
--- a/controller/store/initialise_test.go
+++ b/controller/store/initialise_test.go
@@ -8,7 +8,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// UUIDs for test cases
+// UUIDs for test cases.
var mdid uuid.UUID
var defaultPndID uuid.UUID
var cuid uuid.UUID
diff --git a/controller/store/oldGenericStore.go b/controller/store/oldGenericStore.go
index 19ab0cc7b..a08d8c628 100644
--- a/controller/store/oldGenericStore.go
+++ b/controller/store/oldGenericStore.go
@@ -11,7 +11,7 @@ import (
log "github.com/sirupsen/logrus"
)
-// newGenericStore returns a genericStore
+// newGenericStore returns a genericStore.
func newGenericStore() *genericStore {
return &genericStore{Store: make(map[uuid.UUID]store.Storable), storeLock: sync.RWMutex{}}
}
@@ -29,7 +29,7 @@ func (s *genericStore) Exists(id uuid.UUID) bool {
return ok
}
-// Add adds a Storable to the Store
+// Add adds a Storable to the Store.
func (s *genericStore) Add(item store.Storable) error {
if s.Exists(item.ID()) {
return &errors.ErrAlreadyExists{Item: item}
diff --git a/controller/store/storageMode.go b/controller/store/storageMode.go
index bd295dc34..7cc86367e 100644
--- a/controller/store/storageMode.go
+++ b/controller/store/storageMode.go
@@ -6,11 +6,11 @@ import "code.fbi.h-da.de/danet/gosdn/controller/config"
type StorageMode int64
const (
- // Memory is the default storage mode
+ // Memory is the default storage mode.
Memory StorageMode = iota
- // Filesystem is a persistent storage mode
+ // Filesystem is a persistent storage mode.
Filesystem
- // Database is a persistent storage mode provided by a database
+ // Database is a persistent storage mode provided by a database.
Database
)
diff --git a/controller/store/utils.go b/controller/store/utils.go
index 769889c7c..b6866b6cb 100644
--- a/controller/store/utils.go
+++ b/controller/store/utils.go
@@ -27,7 +27,7 @@ func FromString(id string) (uuid.UUID, error) {
return idAsUUID, nil
}
-//EnsureFilesystemStorePathExists ensures that the filesystem store path exists
+//EnsureFilesystemStorePathExists ensures that the filesystem store path exists.
func EnsureFilesystemStorePathExists(storeFileName string) error {
completeStorePath := filepath.Join(config.FilesystemPathToStores, storeFileName)
if _, err := os.Stat(completeStorePath); os.IsNotExist(err) {
@@ -67,12 +67,12 @@ func ensureDirExists(fileName string) error {
return nil
}
-//GetCompletePathToFileStore gets the complete path to a file store
+//GetCompletePathToFileStore gets the complete path to a file store.
func GetCompletePathToFileStore(storeName string) string {
return filepath.Join(config.FilesystemPathToStores, storeName)
}
-//TransformObjectToLoadedObject transform an object into an loadedObject
+//TransformObjectToLoadedObject transform an object into an loadedObject.
func TransformObjectToLoadedObject[T, R any](object T) (R, error) {
var loadedObject R
@@ -89,7 +89,7 @@ func TransformObjectToLoadedObject[T, R any](object T) (R, error) {
return loadedObject, err
}
-//GetStoreFilenameForUUID returns the full filename for a given pndUUID and suffix
+//GetStoreFilenameForUUID returns the full filename for a given pndUUID and suffix.
func GetStoreFilenameForUUID(pndUUID uuid.UUID, deviceFilenameSuffix string) string {
return pndUUID.String() + "-" + deviceFilenameSuffix
}
diff --git a/controller/topology/links/link.go b/controller/topology/links/link.go
index b90faf44a..be6a79d06 100644
--- a/controller/topology/links/link.go
+++ b/controller/topology/links/link.go
@@ -6,7 +6,7 @@ import (
"github.com/google/uuid"
)
-// Link is a representation of a physical or virtual link between two nodes and their ports
+// Link is a representation of a physical or virtual link between two nodes and their ports.
type Link struct {
ID uuid.UUID `bson:"_id"`
Name string `bson:"name,omitempty"`
@@ -16,7 +16,7 @@ type Link struct {
TargetPort ports.Port `bson:"target_port,omitempty"`
}
-// GetID returns the id of a link
+// GetID returns the id of a link.
func (l Link) GetID() uuid.UUID {
return l.ID
}
diff --git a/controller/topology/nodes/node.go b/controller/topology/nodes/node.go
index 02ec4ac68..a9c836fcd 100644
--- a/controller/topology/nodes/node.go
+++ b/controller/topology/nodes/node.go
@@ -4,13 +4,13 @@ import (
"github.com/google/uuid"
)
-// Node is a representation of a network element
+// Node is a representation of a network element.
type Node struct {
ID uuid.UUID `bson:"_id"`
Name string `bson:"name"`
}
-// GetID returns the id of a node
+// GetID returns the id of a node.
func (n Node) GetID() uuid.UUID {
return n.ID
}
diff --git a/controller/topology/nodes/nodeService.go b/controller/topology/nodes/nodeService.go
index 135d41c40..76e2de209 100644
--- a/controller/topology/nodes/nodeService.go
+++ b/controller/topology/nodes/nodeService.go
@@ -10,11 +10,11 @@ import (
)
const (
- // NodeEventTopic is the used topic for node related entity changes
+ // NodeEventTopic is the used topic for node related entity changes.
NodeEventTopic = "node"
)
-// Service defines a interface for a NodeService
+// Service defines a interface for a NodeService.
type Service interface {
EnsureExists(Node) (Node, error)
Update(Node) error
@@ -23,13 +23,13 @@ type Service interface {
GetAll() ([]Node, error)
}
-// NodeService is a NodeService
+// NodeService is a NodeService.
type NodeService struct {
store Store
eventService eventInterfaces.Service
}
-// NewNodeService creates a NodeService
+// NewNodeService creates a NodeService.
func NewNodeService(store Store, eventService eventInterfaces.Service) Service {
return &NodeService{
store: store,
@@ -37,7 +37,7 @@ func NewNodeService(store Store, eventService eventInterfaces.Service) Service {
}
}
-// EnsureExists either creates a new node or returns an already existing node
+// EnsureExists either creates a new node or returns an already existing node.
func (n *NodeService) EnsureExists(node Node) (Node, error) {
if node.ID == uuid.Nil {
node.ID = uuid.New()
@@ -67,7 +67,7 @@ func (n *NodeService) createNode(node Node) (Node, error) {
return node, nil
}
-// Update updates an existing node
+// Update updates an existing node.
func (n *NodeService) Update(node Node) error {
err := n.store.Update(node)
if err != nil {
@@ -81,7 +81,7 @@ func (n *NodeService) Update(node Node) error {
return nil
}
-// Delete deletes a node
+// Delete deletes a node.
func (n *NodeService) Delete(node Node) error {
err := n.store.Delete(node)
if err != nil {
@@ -95,7 +95,7 @@ func (n *NodeService) Delete(node Node) error {
return nil
}
-// Get gets a node
+// Get gets a node.
func (n *NodeService) Get(query query.Query) (Node, error) {
node, err := n.store.Get(query)
if err != nil {
@@ -105,7 +105,7 @@ func (n *NodeService) Get(query query.Query) (Node, error) {
return node, nil
}
-// GetAll gets all existing nodes
+// GetAll gets all existing nodes.
func (n *NodeService) GetAll() ([]Node, error) {
nodes, err := n.store.GetAll()
if err != nil {
diff --git a/controller/topology/nodes/nodeStore.go b/controller/topology/nodes/nodeStore.go
index 706d8699b..3f69c80d0 100644
--- a/controller/topology/nodes/nodeStore.go
+++ b/controller/topology/nodes/nodeStore.go
@@ -13,7 +13,7 @@ import (
"go.mongodb.org/mongo-driver/mongo/options"
)
-// Store defines a NodeStore interface
+// Store defines a NodeStore interface.
type Store interface {
Add(Node) error
Update(Node) error
@@ -22,12 +22,12 @@ type Store interface {
GetAll() ([]Node, error)
}
-// DatabaseNodeStore is a database store for nodes
+// DatabaseNodeStore is a database store for nodes.
type DatabaseNodeStore struct {
storeName string
}
-// NewDatabaseNodeStore returns a NodeStore
+// NewDatabaseNodeStore returns a NodeStore.
func NewDatabaseNodeStore() Store {
return &DatabaseNodeStore{
storeName: fmt.Sprint("node-store.json"),
diff --git a/controller/topology/ports/configuration/configuration.go b/controller/topology/ports/configuration/configuration.go
index cc22dd092..e61f512f6 100644
--- a/controller/topology/ports/configuration/configuration.go
+++ b/controller/topology/ports/configuration/configuration.go
@@ -5,13 +5,13 @@ import (
"net"
)
-// IPConfig represents an interface configuration for a cEOS instance
+// IPConfig represents an interface configuration for a cEOS instance.
type IPConfig struct {
IP net.IP `bson:"ip,omitempty"`
PrefixLength int64 `bson:"prefix_length,omitempty"`
}
-// New creates a new IPConfig
+// New creates a new IPConfig.
func New(ip string, prefixLength int64) (IPConfig, error) {
newIPConfig := IPConfig{}
parsedIP := net.ParseIP(ip)
diff --git a/controller/topology/ports/port.go b/controller/topology/ports/port.go
index e7456af6f..2614f745c 100644
--- a/controller/topology/ports/port.go
+++ b/controller/topology/ports/port.go
@@ -5,14 +5,14 @@ import (
"github.com/google/uuid"
)
-// Port is a representation of physical port on a network element
+// Port is a representation of physical port on a network element.
type Port struct {
ID uuid.UUID `bson:"_id"`
Name string `bson:"name,omitempty"`
Configuration configuration.IPConfig `bson:"configuration,omitempty"`
}
-// GetID returns the id of a port
+// GetID returns the id of a port.
func (p Port) GetID() uuid.UUID {
return p.ID
}
diff --git a/controller/topology/ports/portService.go b/controller/topology/ports/portService.go
index feb3626c7..1625155a0 100644
--- a/controller/topology/ports/portService.go
+++ b/controller/topology/ports/portService.go
@@ -10,11 +10,11 @@ import (
)
const (
- // PortEventTopic is the used topic for port related entity changes
+ // PortEventTopic is the used topic for port related entity changes.
PortEventTopic = "port"
)
-// Service defines an interface for a PortService
+// Service defines an interface for a PortService.
type Service interface {
EnsureExists(Port) (Port, error)
Update(Port) error
@@ -23,13 +23,13 @@ type Service interface {
GetAll() ([]Port, error)
}
-// PortService is a service for ports
+// PortService is a service for ports.
type PortService struct {
store Store
eventService eventInterfaces.Service
}
-// NewPortService creates a new PortService
+// NewPortService creates a new PortService.
func NewPortService(store Store, eventService eventInterfaces.Service) Service {
return &PortService{
store: store,
@@ -37,7 +37,7 @@ func NewPortService(store Store, eventService eventInterfaces.Service) Service {
}
}
-// EnsureExists either creates a new port or returns an already existing port
+// EnsureExists either creates a new port or returns an already existing port.
func (p *PortService) EnsureExists(port Port) (Port, error) {
if port.ID == uuid.Nil {
port.ID = uuid.New()
@@ -65,7 +65,7 @@ func (p *PortService) createPort(port Port) (Port, error) {
return port, nil
}
-// Update updates an existing port
+// Update updates an existing port.
func (p *PortService) Update(port Port) error {
err := p.store.Update(port)
if err != nil {
@@ -79,7 +79,7 @@ func (p *PortService) Update(port Port) error {
return nil
}
-// Delete deletes a port
+// Delete deletes a port.
func (p *PortService) Delete(port Port) error {
err := p.store.Delete(port)
if err != nil {
@@ -93,7 +93,7 @@ func (p *PortService) Delete(port Port) error {
return nil
}
-// Get gets a port
+// Get gets a port.
func (p *PortService) Get(query query.Query) (Port, error) {
port, err := p.store.Get(query)
if err != nil {
@@ -103,7 +103,7 @@ func (p *PortService) Get(query query.Query) (Port, error) {
return port, nil
}
-// GetAll gets all existing ports
+// GetAll gets all existing ports.
func (p *PortService) GetAll() ([]Port, error) {
nodes, err := p.store.GetAll()
if err != nil {
diff --git a/controller/topology/ports/portStore.go b/controller/topology/ports/portStore.go
index a5a9a8b3a..0c44a0b3b 100644
--- a/controller/topology/ports/portStore.go
+++ b/controller/topology/ports/portStore.go
@@ -14,7 +14,7 @@ import (
"go.mongodb.org/mongo-driver/mongo/options"
)
-// Store defines a PortStore interface
+// Store defines a PortStore interface.
type Store interface {
Add(Port) error
Update(Port) error
@@ -23,12 +23,12 @@ type Store interface {
GetAll() ([]Port, error)
}
-// DatabasePortStore is a database store for ports
+// DatabasePortStore is a database store for ports.
type DatabasePortStore struct {
storeName string
}
-// NewDatabasePortStore returns a PortStore
+// NewDatabasePortStore returns a PortStore.
func NewDatabasePortStore() Store {
return &DatabasePortStore{
storeName: fmt.Sprint("port-store.json"),
diff --git a/controller/topology/routing-tables/route.go b/controller/topology/routing-tables/route.go
index f25292501..c96378300 100644
--- a/controller/topology/routing-tables/route.go
+++ b/controller/topology/routing-tables/route.go
@@ -4,7 +4,7 @@ import (
"github.com/google/uuid"
)
-// Route is a routing table entry on a device
+// Route is a routing table entry on a device.
type Route struct {
ID uuid.UUID `bson:"_id"`
TargetIPRange string `bson:"target_ip_range"`
diff --git a/controller/topology/routing-tables/routingTable.go b/controller/topology/routing-tables/routingTable.go
index 833c91df3..5398bdc53 100644
--- a/controller/topology/routing-tables/routingTable.go
+++ b/controller/topology/routing-tables/routingTable.go
@@ -2,14 +2,14 @@ package routingtables
import "github.com/google/uuid"
-// RoutingTable is the routing table of a device
+// RoutingTable is the routing table of a device.
type RoutingTable struct {
ID uuid.UUID `bson:"_id"`
NodeID uuid.UUID `bson:"node_id"`
Routes Route `bson:"routes"`
}
-// GetID returns the id of a routingtable
+// GetID returns the id of a routingtable.
func (r RoutingTable) GetID() uuid.UUID {
return r.ID
}
diff --git a/controller/topology/routing-tables/routingTableService.go b/controller/topology/routing-tables/routingTableService.go
index cdb3ae2c1..eec4efb2f 100644
--- a/controller/topology/routing-tables/routingTableService.go
+++ b/controller/topology/routing-tables/routingTableService.go
@@ -11,11 +11,11 @@ import (
)
const (
- // RoutingTableEventTopic is the used topic for routing table related entity changes
+ // RoutingTableEventTopic is the used topic for routing table related entity changes.
RoutingTableEventTopic = "routingTable"
)
-// Service defines a interface for a RoutingTableService
+// Service defines a interface for a RoutingTableService.
type Service interface {
EnsureExists(RoutingTable) (RoutingTable, error)
Update(RoutingTable) error
@@ -24,7 +24,7 @@ type Service interface {
GetAll() ([]RoutingTable, error)
}
-// RoutingTableService is a RoutingTableService
+// RoutingTableService is a RoutingTableService.
type RoutingTableService struct {
store Store
nodeService nodes.Service
@@ -32,7 +32,7 @@ type RoutingTableService struct {
eventService eventInterfaces.Service
}
-// NewRoutingTableService creates a RoutingTableService
+// NewRoutingTableService creates a RoutingTableService.
func NewRoutingTableService(
store Store,
nodeService nodes.Service,
@@ -47,7 +47,7 @@ func NewRoutingTableService(
}
}
-// EnsureExists either creates a new routingTable or returns an already existing routingTable
+// EnsureExists either creates a new routingTable or returns an already existing routingTable.
func (r *RoutingTableService) EnsureExists(routingTable RoutingTable) (RoutingTable, error) {
if routingTable.ID == uuid.Nil {
routingTable.ID = uuid.New()
@@ -75,7 +75,7 @@ func (r *RoutingTableService) createRoutingTable(routingTable RoutingTable) (Rou
return routingTable, nil
}
-// Update updates an existing routingTable
+// Update updates an existing routingTable.
func (r *RoutingTableService) Update(routingTable RoutingTable) error {
err := r.store.Update(routingTable)
if err != nil {
@@ -89,7 +89,7 @@ func (r *RoutingTableService) Update(routingTable RoutingTable) error {
return nil
}
-// Delete deletes a routingTable
+// Delete deletes a routingTable.
func (r *RoutingTableService) Delete(routingTable RoutingTable) error {
err := r.store.Delete(routingTable)
if err != nil {
@@ -103,7 +103,7 @@ func (r *RoutingTableService) Delete(routingTable RoutingTable) error {
return nil
}
-// Get gets a routingTable
+// Get gets a routingTable.
func (r *RoutingTableService) Get(query query.Query) (RoutingTable, error) {
routingTable, err := r.store.Get(query)
if err != nil {
@@ -113,7 +113,7 @@ func (r *RoutingTableService) Get(query query.Query) (RoutingTable, error) {
return routingTable, nil
}
-// GetAll gets all existing routingTables
+// GetAll gets all existing routingTables.
func (r *RoutingTableService) GetAll() ([]RoutingTable, error) {
nodes, err := r.store.GetAll()
if err != nil {
diff --git a/controller/topology/routing-tables/routingTableStore.go b/controller/topology/routing-tables/routingTableStore.go
index 38bb029f0..0bdd82c77 100644
--- a/controller/topology/routing-tables/routingTableStore.go
+++ b/controller/topology/routing-tables/routingTableStore.go
@@ -13,7 +13,7 @@ import (
"go.mongodb.org/mongo-driver/mongo/options"
)
-// Store defines a RoutingTable store interface
+// Store defines a RoutingTable store interface.
type Store interface {
Add(RoutingTable) error
Update(RoutingTable) error
@@ -22,12 +22,12 @@ type Store interface {
GetAll() ([]RoutingTable, error)
}
-// DatabaseRoutingTableStore is a database store for routingTables
+// DatabaseRoutingTableStore is a database store for routingTables.
type DatabaseRoutingTableStore struct {
storeName string
}
-// NewDatabaseRoutingTableStore returns a RoutingTableStore
+// NewDatabaseRoutingTableStore returns a RoutingTableStore.
func NewDatabaseRoutingTableStore() Store {
return &DatabaseRoutingTableStore{
storeName: fmt.Sprint("routing-table-store.json"),
diff --git a/controller/topology/topologyService.go b/controller/topology/topologyService.go
index bcd42eb49..694910843 100644
--- a/controller/topology/topologyService.go
+++ b/controller/topology/topologyService.go
@@ -11,11 +11,11 @@ import (
)
const (
- // LinkEventTopic is the used topic for link related entity changes
+ // LinkEventTopic is the used topic for link related entity changes.
LinkEventTopic = "link"
)
-// Service defines an interface for a Service
+// Service defines an interface for a Service.
type Service interface {
AddLink(links.Link) error
UpdateLink(links.Link) error
@@ -24,7 +24,7 @@ type Service interface {
GetAll() ([]links.Link, error)
}
-// service is a service for ports
+// service is a service for ports.
type service struct {
store Store
nodeService nodes.Service
@@ -32,7 +32,7 @@ type service struct {
eventService eventInterfaces.Service
}
-// NewTopologyService creates a new TopologyService
+// NewTopologyService creates a new TopologyService.
func NewTopologyService(
store Store,
nodeService nodes.Service,
@@ -47,7 +47,7 @@ func NewTopologyService(
}
}
-// AddLink adds a new link to the topology
+// AddLink adds a new link to the topology.
func (t *service) AddLink(link links.Link) error {
// These checks are also happening in the current NBI implementation.
// This should be refactored to only to these checks here.
@@ -81,7 +81,7 @@ func (t *service) AddLink(link links.Link) error {
return nil
}
-// UpdateLink updates an existing link
+// UpdateLink updates an existing link.
func (t *service) UpdateLink(link links.Link) error {
err := t.store.Update(link)
if err != nil {
@@ -95,7 +95,7 @@ func (t *service) UpdateLink(link links.Link) error {
return nil
}
-// DeleteLink deletes a link
+// DeleteLink deletes a link.
func (t *service) DeleteLink(link links.Link) error {
// TODO: Delete should also check if a node or port is used somewhere else and
// if not, delete the node and its ports
@@ -111,7 +111,7 @@ func (t *service) DeleteLink(link links.Link) error {
return nil
}
-// GetAll returns the current topology
+// GetAll returns the current topology.
func (t *service) GetAll() ([]links.Link, error) {
topo, err := t.store.GetAll()
if err != nil {
@@ -120,7 +120,7 @@ func (t *service) GetAll() ([]links.Link, error) {
return topo, nil
}
-// GetAll returns the current topology
+// GetAll returns the current topology.
func (t *service) Get(query query.Query) (links.Link, error) {
link, err := t.store.Get(query)
if err != nil {
diff --git a/controller/topology/topologyStore.go b/controller/topology/topologyStore.go
index 0dc6431f4..dc12b10af 100644
--- a/controller/topology/topologyStore.go
+++ b/controller/topology/topologyStore.go
@@ -14,7 +14,7 @@ import (
"go.mongodb.org/mongo-driver/mongo/options"
)
-// Store defines a Topology store interface
+// Store defines a Topology store interface.
type Store interface {
Add(links.Link) error
Update(links.Link) error
@@ -23,12 +23,12 @@ type Store interface {
GetAll() ([]links.Link, error)
}
-// DatabaseTopologyStore is a database store for the topology
+// DatabaseTopologyStore is a database store for the topology.
type DatabaseTopologyStore struct {
storeName string
}
-// NewDatabaseTopologyStore returns a TopologyStore
+// NewDatabaseTopologyStore returns a TopologyStore.
func NewDatabaseTopologyStore() Store {
return &DatabaseTopologyStore{
storeName: fmt.Sprint("topology-store.json"),
diff --git a/csbi/cmd/deploy.go b/csbi/cmd/deploy.go
index 94233a706..9d1918508 100644
--- a/csbi/cmd/deploy.go
+++ b/csbi/cmd/deploy.go
@@ -37,7 +37,7 @@ import (
"github.com/spf13/cobra"
)
-// deployCmd represents the deploy command
+// deployCmd represents the deploy command.
var deployCmd = &cobra.Command{
Use: "deploy",
Short: "A brief description of your command",
diff --git a/csbi/cmd/discover.go b/csbi/cmd/discover.go
index 21457cb96..38fe3ba09 100644
--- a/csbi/cmd/discover.go
+++ b/csbi/cmd/discover.go
@@ -37,7 +37,7 @@ import (
"github.com/spf13/cobra"
)
-// discoverCmd represents the discover command
+// discoverCmd represents the discover command.
var discoverCmd = &cobra.Command{
Use: "discover",
Short: "A brief description of your command",
diff --git a/csbi/cmd/generate.go b/csbi/cmd/generate.go
index 9713dd284..86be06f3b 100644
--- a/csbi/cmd/generate.go
+++ b/csbi/cmd/generate.go
@@ -43,7 +43,7 @@ import (
"google.golang.org/grpc/peer"
)
-// generateCmd represents the generate command
+// generateCmd represents the generate command.
var generateCmd = &cobra.Command{
Use: "generate",
Short: "generates a blank csbi boilerplate",
diff --git a/csbi/cmd/hello.go b/csbi/cmd/hello.go
index 7a82f17b8..b2c7ecd26 100644
--- a/csbi/cmd/hello.go
+++ b/csbi/cmd/hello.go
@@ -45,7 +45,7 @@ import (
"google.golang.org/grpc"
)
-// helloCmd represents the hello command
+// helloCmd represents the hello command.
var helloCmd = &cobra.Command{
Use: "hello",
Short: "serves Hello service for testing purposes",
@@ -87,7 +87,7 @@ func (s server) Hello(ctx context.Context, syn *pb.Syn) (*pb.Ack, error) {
return ack, nil
}
-// Run bootstraps the orchestrator and waits for the shutdown signal
+// Run bootstraps the orchestrator and waits for the shutdown signal.
func Run(bindAddr string) {
g := grpc.NewServer()
s := &server{}
diff --git a/csbi/cmd/init.go b/csbi/cmd/init.go
index 3d06f85cd..8a1f9ec68 100644
--- a/csbi/cmd/init.go
+++ b/csbi/cmd/init.go
@@ -37,7 +37,7 @@ import (
"github.com/spf13/cobra"
)
-// initCmd represents the init command
+// initCmd represents the init command.
var initCmd = &cobra.Command{
Use: "init",
Short: "A brief description of your command",
diff --git a/csbi/cmd/repository.go b/csbi/cmd/repository.go
index c1142b913..21eda8bb6 100644
--- a/csbi/cmd/repository.go
+++ b/csbi/cmd/repository.go
@@ -38,7 +38,7 @@ import (
"github.com/spf13/cobra"
)
-// repositoryCmd represents the repository command
+// repositoryCmd represents the repository command.
var repositoryCmd = &cobra.Command{
Use: "repository",
Short: "run the 'repository' command",
diff --git a/csbi/cmd/root.go b/csbi/cmd/root.go
index 75eef6f39..da6ae200e 100644
--- a/csbi/cmd/root.go
+++ b/csbi/cmd/root.go
@@ -51,7 +51,7 @@ var logLevel string
var repoBasePath string
-// rootCmd represents the base command when called without any subcommands
+// rootCmd represents the base command when called without any subcommands.
var rootCmd = &cobra.Command{
Use: "csbi",
Short: "start the csbi orchestrator",
diff --git a/csbi/config/config.go b/csbi/config/config.go
index c029ed8aa..045b52673 100644
--- a/csbi/config/config.go
+++ b/csbi/config/config.go
@@ -6,22 +6,22 @@ import (
"github.com/spf13/viper"
)
-// RepositoryBasePath returns the repository base path from viper
+// RepositoryBasePath returns the repository base path from viper.
func RepositoryBasePath() string {
return viper.GetString("repository-base-path")
}
-// RepositoryAccessToken returns the repository access token from viper
+// RepositoryAccessToken returns the repository access token from viper.
func RepositoryAccessToken() string {
return viper.GetString("repository-access-token")
}
-// OrchestratorShutdownTimeout returns the orchestrator shutdown timer from viper
+// OrchestratorShutdownTimeout returns the orchestrator shutdown timer from viper.
func OrchestratorShutdownTimeout() time.Duration {
return viper.GetDuration("orchestrator-shutown-timeout")
}
-// DockerOrchestratorNetwork returns the docker orchestrator network from viper
+// DockerOrchestratorNetwork returns the docker orchestrator network from viper.
func DockerOrchestratorNetwork() string {
return viper.GetString("docker-orchestrator-network")
}
diff --git a/csbi/deployment.go b/csbi/deployment.go
index 72d25a4c5..8cf1da970 100644
--- a/csbi/deployment.go
+++ b/csbi/deployment.go
@@ -31,7 +31,7 @@ type DeploymentStore struct {
}
// NewDeploymentStore returns a DeploymentStore. It takes a time.Duration
-// variable to configure the garbage collection interval
+// variable to configure the garbage collection interval.
func NewDeploymentStore(garbageCollectionInterval ...time.Duration) DeploymentStore {
var gcInterval time.Duration
if len(garbageCollectionInterval) > 0 {
diff --git a/csbi/discover.go b/csbi/discover.go
index 78bceec3e..fb270c111 100644
--- a/csbi/discover.go
+++ b/csbi/discover.go
@@ -12,7 +12,7 @@ import (
)
// Discover sends a gnmi Capabilities request to the specified target and
-// returns the gnmi.ModelData
+// returns the gnmi.ModelData.
func Discover(ctx context.Context, opts *tpb.TransportOption) ([]*gnmi.ModelData, error) {
sbi, err := nucleus.NewSBI(spb.Type_TYPE_OPENCONFIG)
if err != nil {
diff --git a/csbi/orchestrator.go b/csbi/orchestrator.go
index df556937a..d2a29be54 100644
--- a/csbi/orchestrator.go
+++ b/csbi/orchestrator.go
@@ -31,7 +31,7 @@ const (
Docker OrchestratorType = iota
)
-// Orchestrator manages the lifecycle of cSBI deployments
+// Orchestrator manages the lifecycle of cSBI deployments.
type Orchestrator interface {
Build(ctx context.Context, model []*gpb.ModelData) (Deployment, error)
Deploy(deployment Deployment) error
@@ -43,7 +43,7 @@ type Orchestrator interface {
// NewOrchestrator returns an implementation of the Orchestrator interface
// depending on the passed OrchestratorTYpe. Returns an error if an invalid
-// type is passed
+// type is passed.
func NewOrchestrator(flavour OrchestratorType) (Orchestrator, error) {
switch flavour {
case Docker:
diff --git a/csbi/repository.go b/csbi/repository.go
index 92a4ce9c1..e4da27900 100644
--- a/csbi/repository.go
+++ b/csbi/repository.go
@@ -20,7 +20,7 @@ type Repository interface {
YANGPathsWithSuffix() ([]string, error)
}
-// NewRepository returns a implementation of the Repository interface
+// NewRepository returns a implementation of the Repository interface.
func NewRepository(basePath string) Repository {
return &repo{
fs: &filesystem{
diff --git a/csbi/run.go b/csbi/run.go
index 469899836..a5eaf9ae8 100644
--- a/csbi/run.go
+++ b/csbi/run.go
@@ -21,7 +21,7 @@ func init() {
signal.Notify(stopChan, os.Interrupt, syscall.SIGTERM)
}
-// Run bootstraps the orchestrator and waits for the shutdown signal
+// Run bootstraps the orchestrator and waits for the shutdown signal.
func Run(bindAddr string) {
g := grpc.NewServer()
o, err := NewOrchestrator(Docker)
diff --git a/csbi/templates.go b/csbi/templates.go
index 89f5407e8..9289fc248 100644
--- a/csbi/templates.go
+++ b/csbi/templates.go
@@ -2,7 +2,7 @@ package csbi
import "github.com/openconfig/ygot/ygen"
-// deprecated
+// deprecated.
var southboundStruct = ygen.GoStructCodeSnippet{
StructName: "Csbi",
StructDef: `type Csbi struct {
@@ -88,7 +88,7 @@ func (csbi *Csbi) ID() uuid.UUID {
`,
}
-// deprecated
+// deprecated.
const southboundStructCsbiAmendmend = `
// Type returns the Southbound's type
@@ -102,7 +102,7 @@ func (csbi *Csbi) Name() string {
}
`
-// deprecated
+// deprecated.
const southboundStructPluginAmendmend = `
// Type returns the Southbound's type
@@ -117,7 +117,7 @@ func (csbi *Csbi) Name() string {
`
-// deprecated
+// deprecated.
const southboundImportAmendmend = `
"code.fbi.h-da.de/danet/gosdn/controller/nucleus/errors"
diff --git a/csbi/write.go b/csbi/write.go
index 78dab546d..ccc679bcf 100644
--- a/csbi/write.go
+++ b/csbi/write.go
@@ -165,7 +165,7 @@ func writeGoStruct(path string, code *ygen.GeneratedGoCode, t spb.Type) error {
return nil
}
-// deprecated
+// deprecated.
func writeCode(path string, code *ygen.GeneratedGoCode, t spb.Type) error {
code.CommonHeader = strings.TrimSuffix(code.CommonHeader, ")\n")
code.CommonHeader = code.CommonHeader + southboundImportAmendmend
@@ -216,7 +216,7 @@ func writeCode(path string, code *ygen.GeneratedGoCode, t spb.Type) error {
return nil
}
-// Manifest represents a csbi manifest
+// Manifest represents a csbi manifest.
type Manifest struct {
Name, Author, Version string
}
--
GitLab