Refactoring in progress

nucleus/principalNetworkDomain.go

 package nucleus
 
 import (
-	"code.fbi.h-da.de/cocsn/gosdn/nucleus/interfaces"
 	"github.com/google/uuid"
 )
 
+// PrincipalNetworkDomain provides an
+// interface for PND implementations
+type PrincipalNetworkDomain interface {
+	Destroy() error
+	AddSbi() error
+	RemoveSbi() error
+	AddDevice(Device) error
+	RemoveDevice(uuid uuid.UUID) error
+}
+
 type pndImplementation struct {
-	name         string
-	sbiContainer map[string]*nucleus.SouthboundInterface
-	devices      map[uuid.UUID]Device
+	name    string
+	sbi     map[string]SouthboundInterface
+	devices map[uuid.UUID]Device
 }
 
 //NewPND creates a Principle Network Domain
-func NewPND(name string, sbi *nucleus.SouthboundInterface) nucleus.PrincipalNetworkDomain {
-	sbic := make(map[string]*nucleus.SouthboundInterface)
+func NewPND(name string, sbi SouthboundInterface) PrincipalNetworkDomain {
+	sbic := make(map[string]SouthboundInterface)
 	sbic["default"] = sbi
+	devices := make(map[uuid.UUID]Device)
 	return &pndImplementation{
-		name:         name,
-		sbiContainer: sbic,
+		name:    name,
+		sbi:     sbic,
+		devices: devices,
 	}
 }
 
@@ -35,11 +46,11 @@ func (pnd *pndImplementation) RemoveSbi() error {
 }
 
 func (pnd *pndImplementation) AddDevice(device Device) error {
-	return addDevice(device)
+	return pnd.addDevice(device)
 }
 
 func (pnd *pndImplementation) RemoveDevice(uuid uuid.UUID) error {
-	return removeDevice(uuid)
+	return pnd.removeDevice(uuid)
 }
 
 // Actual implementation, bind to struct if
@@ -56,10 +67,12 @@ func removeSbi() error {
 	return nil
 }
 
-func addDevice(device Device) error {
+func (pnd *pndImplementation) addDevice(device Device) error {
+	pnd.devices[device.Config.Uuid] = device
 	return nil
 }
 
-func removeDevice(uuid uuid.UUID) error {
+func (pnd *pndImplementation) removeDevice(uuid uuid.UUID) error {
+	delete(pnd.devices, uuid)
 	return nil
 }

nucleus/restconf_transport.go

+package nucleus
+
+import "context"
+
+type Restconf struct {
+}
+
+func (rc *Restconf) SetConfig(interface{}) error {
+	return nil
+}
+
+func (rc *Restconf) GetConfig() interface{} {
+	return nil
+}
+
+func (rc *Restconf) Subscribe(ctx context.Context, params ...string) error {
+	return nil
+}

nucleus/sbi/openConfig.go

-package sbi
-
-import "code.fbi.h-da.de/cocsn/gosdn/nucleus/interfaces"
-
-type OpenConfig struct {
-	name            string
-	clientContainer []Client
-}
-
-//NewSouthboundInterface creates a Southbound Interface
-func NewSouthboundInterface(name string, clients ...nucleus.Client) nucleus.SouthboundInterface {
-	return &OpenConfig{
-		name:            name,
-		clientContainer: clients,
-	}
-}
-
-// Interface satisfaction
-func (sbi *OpenConfig) AddClient() error {
-	return addClient()
-}
-
-func (sbi *OpenConfig) RemoveClient() error {
-	return removeClient()
-}
-
-func (sbi *OpenConfig) CollectHeartbeats() error {
-	return collectHeartbeats()
-}
-
-func (sbi *OpenConfig) ListClients() map[int]nucleus.Client {
-	return listClients()
-}
-
-// Actual implementation, bind to struct if
-// neccessary
-func addClient() error {
-	return nil
-}
-
-func removeClient() error {
-	return nil
-}
-
-func collectHeartbeats() error {
-	return nil
-}
-
-func listClients() map[int]nucleus.Client {
-	return nil
-}

nucleus/southbound.go

+package nucleus
+
+// SouthboundInterface provides an
+// interface for SBI implementations
+type SouthboundInterface interface {
+	GetSBIString() string
+}
+
+type Tapi struct {
+}
+
+func (t *Tapi) Get(interface{}) (interface{}, error) {
+	return nil, nil
+}
+func (t *Tapi) Set(interface{}) error {
+	return nil
+}
+func (t *Tapi) Subscribe(interface{}) (interface{}, error) {
+	return nil, nil
+}
+
+type OpenConfig struct {
+}
+
+func (oc *OpenConfig) GetSBIString() string {
+	return "openconfig"
+}
+
+func (oc *OpenConfig) Get(interface{}) (interface{}, error) {
+	return nil, nil
+}
+func (oc *OpenConfig) Set(interface{}) error {
+	return nil
+}
+func (oc *OpenConfig) Subscribe(interface{}) (interface{}, error) {
+	return nil, nil
+}

sbi/restconf/util/unmarshal.go → nucleus/transport.go

-package util
+package nucleus
 
 import (
 	"bytes"
+	"context"
 	"io"
 )
 
+// Transport provides an interface for
+// Transport implementations like RESTCONF
+// or gnmi
+type Transport interface {
+	Get(ctx context.Context, params ...string) (interface{}, error)
+	Set(ctx context.Context, params ...string) (interface{}, error)
+	Subscribe(ctx context.Context, params ...string) error
+}
+
 // YANGConsumer is a auxillary type to redirect the response
 // of an RESTCONF call to a ygot YANG unmarshaler
 type YANGConsumer struct {

nucleus/transport/gnmi.go

-package transport

nucleus/transport/restconf.go

-package transport

sbi/restconf/client/ciena/client.go → plugins/ciena/mcp.go

@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"code.fbi.h-da.de/cocsn/gosdn/database"
 	"code.fbi.h-da.de/cocsn/gosdn/nucleus/interfaces"
-	"code.fbi.h-da.de/cocsn/gosdn/sbi/restconf/util"
+	t "code.fbi.h-da.de/cocsn/gosdn/nucleus/transport"
 	apiclient "code.fbi.h-da.de/cocsn/swagger/apis/mcp/client"
 	"code.fbi.h-da.de/cocsn/yang-modules/generated/tapi"
 	"crypto/tls"
@@ -19,8 +19,8 @@ import (
 	"strings"
 )
 
-//MCPClient handles requests to a Ciena MCP RESTCONF endpoint
-type MCPClient struct {
+//Mcp handles requests to a Ciena MCP RESTCONF endpoint
+type Mcp struct {
 	transport *httptransport.Runtime
 	client    *apiclient.ServiceTopologyTAPI
 	database  *database.Database
@@ -30,38 +30,38 @@ type MCPClient struct {
 }
 
 // GetConfig returns a ClientConfig struct containing
-// the current configuration stat of the Ciena SBI client
-func (c MCPClient) GetConfig() nucleus.ClientConfig {
+// the current configuration stat of the Ciena SBI ciena
+func (c Mcp) GetConfig() nucleus.ClientConfig {
 	return *c.config
 }
 
 // ListPorts is a stub to satisfy the interface
 // TODO: Implement
-func (c MCPClient) ListPorts() map[int]nucleus.Port {
+func (c Mcp) ListPorts() interface{} {
 	return nil
 }
 
 // PushReceiver is a stub to satisfy the interface
 // TODO: Implement
-func (c MCPClient) PushReceiver() error {
+func (c Mcp) PushReceiver() error {
 	return nil
 }
 
-//NewMCPClient creates a Ciena flavores TAPI client
-func NewMCPClient(endpoint, username, password string, database *database.Database, config *nucleus.ClientConfig) *MCPClient {
+//NewMCPClient creates a Ciena flavores TAPI ciena
+func NewMCPClient(endpoint, username, password string, database *database.Database, config *nucleus.ClientConfig) *Mcp {
 	// create the transport
 	transport := httptransport.New(endpoint, "/", nil)
 	transport.Transport.(*http.Transport).TLSClientConfig = &tls.Config{InsecureSkipVerify: true}
-	// create the API client, with the transport
+	// create the API ciena, with the transport
 	basicAuth := httptransport.BasicAuth(username, password)
-	// authenticate client
+	// authenticate ciena
 	transport.DefaultAuthentication = basicAuth
 	client := apiclient.New(transport, strfmt.Default)
 
 	buffer := new(bytes.Buffer)
-	transport.Consumers[runtime.JSONMime] = util.YANGConsumer{Data: buffer}
+	transport.Consumers[runtime.JSONMime] = t.YANGConsumer{Data: buffer}
 
-	return &MCPClient{
+	return &Mcp{
 		transport: transport,
 		client:    client,
 		database:  database,
@@ -72,8 +72,8 @@ func NewMCPClient(endpoint, username, password string, database *database.Databa
 }
 
 // GetConnections implements the TAPI Connectivity GetConnections call with a grain of
-// Ciena salt. The response is written to the client's buffer and passed to the database
-func (c *MCPClient) GetConnections() error {
+// Ciena salt. The response is written to the ciena's buffer and passed to the database
+func (c *Mcp) GetConnections() error {
 	defer c.buffer.Reset()
 	_, err := c.client.TapiConnectivityCore.GetTapiCoreContextConnection(nil)
 	if err != nil {
@@ -99,8 +99,8 @@ func (c *MCPClient) GetConnections() error {
 }
 
 // GetLinks implements the TAPI Topology GetLinks call with a grain of
-// Ciena salt. The response is written to the client's buffer and passed to the database
-func (c *MCPClient) GetLinks() error {
+// Ciena salt. The response is written to the ciena's buffer and passed to the database
+func (c *Mcp) GetLinks() error {
 	defer c.buffer.Reset()
 	_, err := c.client.TapiTopologyCore.GetTapiCoreContextTopologyMcpBaseTopologyLink(nil)
 	if err != nil {
@@ -126,8 +126,8 @@ func (c *MCPClient) GetLinks() error {
 }
 
 // GetNodes implements the TAPI Topology GetNodes call with a grain of
-// Ciena salt. The response is written to the client's buffer and passed to the database
-func (c *MCPClient) GetNodes() error {
+// Ciena salt. The response is written to the ciena's buffer and passed to the database
+func (c *Mcp) GetNodes() error {
 	defer c.buffer.Reset()
 	_, err := c.client.TapiTopologyCore.GetTapiCoreContextTopologyMcpBaseTopologyNode(nil)
 	if err != nil {
@@ -153,8 +153,8 @@ func (c *MCPClient) GetNodes() error {
 }
 
 // GetNodeEdgePoints implements the TAPI Topology GetNodeEdgePoints call with a grain of
-// Ciena salt. The response is written to the client's buffer and passed to the database
-func (c *MCPClient) GetNodeEdgePoints() error {
+// Ciena salt. The response is written to the ciena's buffer and passed to the database
+func (c *Mcp) GetNodeEdgePoints() error {
 	defer c.buffer.Reset()
 	_, err := c.client.TapiTopologyCore.GetTapiCoreContextTopologyMcpBaseTopologyNodeEdgePoint(nil)
 	if err != nil {

sbi/sbi-general.go → plugins/sbi-general.go

-package sbi
+package plugins
 
 import (
 	"fmt"