Merge branch 'master-into-develop2' into 'master'

Master into develop2 into master

See merge request !244

build/ci/.build-container.yml

-variables:
-  DOCKER_TLS_CERTDIR: "/certs"
-
-build-docker:
-  before_script:
-    - echo "override global before script"
-  stage: build
-  allow_failure: false
-  needs: []
-  tags:
-    - shell-builder
-
-  rules:
-    - if: $CI_COMMIT_BRANCH == "develop" && $CI_NIGHTLY == null
-      variables:
-        TAG: $CI_REGISTRY_IMAGE:develop
-        BUILDARGS: -race
-    - if: $CI_NIGHTLY == "develop"
-      variables:
-        TAG: $CI_REGISTRY_IMAGE:nightly-develop
-        BUILDARGS: -race
-    - if: $CI_NIGHTLY == "mainline"
-      variables:
-        TAG: $CI_REGISTRY_IMAGE:nightly
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
-      variables:
-        TAG: $CI_REGISTRY_IMAGE:merge-request
-        BUILDARGS: -race
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_NIGHTLY == null
-      variables:
-        TAG: $CI_REGISTRY_IMAGE:latest
-    - if: '$CI_COMMIT_BRANCH'
-      variables:
-        TAG: $CI_REGISTRY_IMAGE:branch
-      
-  script:
-   - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-   - docker build --build-arg GITLAB_USER=$GO_MODULES_USER --build-arg GITLAB_TOKEN=$GO_MODULES_ACCESS_TOKEN --build-arg BUILDARGS=$BUILDARGS -t $DOCKER_IMAGE_SHA .
-   - docker push $DOCKER_IMAGE_SHA
-   - docker tag $DOCKER_IMAGE_SHA $TAG
-   - docker push $TAG
-   - docker build --target installer --build-arg GITLAB_USER=$GO_MODULES_USER --build-arg GITLAB_TOKEN=$GO_MODULES_ACCESS_TOKEN --build-arg BUILDARGS=$BUILDARGS -t ${CI_REGISTRY_IMAGE}:testing_${CI_PIPELINE_ID} .
-   - docker push ${CI_REGISTRY_IMAGE}:testing_${CI_PIPELINE_ID}

build/ci/.containerlab-ci.yml

-variables:
-  CEOS_CONTAINER_IMAGE: "$CI_REGISTRY_IMAGE/ceos:latest"
-  CLAB_INT1_TEMPLATE: "${CI_PROJECT_DIR}/test/containerlab/int01.clab.yml"
-  CLAB_NAME: "clab${CI_PIPELINE_IID}"
-  CLAB_DIR: "/mnt"
-
-
-.containerlab_rules: &containerlab_rules
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == 'develop')
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-    - if: $CI_NIGHTLY
-
-
-containerlab:template:
-  extends: .containerlab_rules
-  image: alpine:latest
-  stage: build
-  before_script:
-    - echo "Override global before_script"
-  script:
-    - ./build/ci/generate_octet.sh $CI_COMMIT_SHA >> $(pwd)/firstOctet
-    - ./build/ci/generate_octet.sh $CI_PIPELINE_ID >> $(pwd)/secondOctet
-    - export firstOctet=$(cat $(pwd)/firstOctet)
-    - export secondOctet=$(cat $(pwd)/secondOctet)
-    - export CLAB_MGMT_SUBNET="172.$firstOctet.$secondOctet.0/24"
-    - |
-      sed -e "s|@@CEOS_CONTAINER_IMAGE@@|${CEOS_CONTAINER_IMAGE}|g" \
-          -e "s|@@GOSDN_CONTAINER_IMAGE@@|${DOCKER_IMAGE_SHA}|g" \
-          -e "s|@@CLAB_NAME@@|${CLAB_NAME}|g" \
-          -e "s|@@CLAB_MGMT_SUBNET@@|${CLAB_MGMT_SUBNET}|g" \
-          ${CLAB_INT1_TEMPLATE} > ${CI_PROJECT_DIR}/${CLAB_NAME}.clab.yml
-    - cat ${CLAB_NAME}.clab.yml
-  artifacts:
-    name: ${CLAB_NAME}
-    paths:
-      - ${CI_PROJECT_DIR}/${CLAB_NAME}.clab.yml
-
-containerlab:deploy:
-  extends:
-    - .containerlab_rules
-  stage: apply
-  needs: ["containerlab:template", "build-docker"]
-  tags:
-    - shell
-  before_script:
-    - cd ${CLAB_DIR}
-    - echo "$CI_REGISTRY_PASSWORD" | docker login -u $CI_REGISTRY_USER --password-stdin $CI_REGISTRY
-    - echo $DOCKER_IMAGE_SHA
-    - docker pull $DOCKER_IMAGE_SHA
-    - docker pull ${CEOS_CONTAINER_IMAGE}
-  script:
-    - sudo containerlab deploy --topo ${CI_PROJECT_DIR}/${CLAB_NAME}.clab.yml --reconfigure
-    - echo "GOSDN_HTTP_PORT=$(docker inspect -f '{{ (index (index .NetworkSettings.Ports "8080/tcp") 0).HostPort }}' clab-${CLAB_NAME}-gosdn)" >> ${CI_PROJECT_DIR}/build.env
-    - echo "GOSDN_GRPC_PORT=$(docker inspect -f '{{ (index (index .NetworkSettings.Ports "55055/tcp") 0).HostPort }}' clab-${CLAB_NAME}-gosdn)" >> ${CI_PROJECT_DIR}/build.env
-    - echo "CEOS1_PORT=$(docker inspect -f '{{ (index (index .NetworkSettings.Ports "6030/tcp") 0).HostPort }}' clab-${CLAB_NAME}-ceos1)" >> ${CI_PROJECT_DIR}/build.env
-  dependencies:
-    - containerlab:template
-  artifacts:
-    reports:
-      dotenv: ${CI_PROJECT_DIR}/build.env
-
-containerlab:destroy:
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == 'develop')
-      when: always
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-      when: always
-    - if: $CI_NIGHTLY
-      when: always
-  stage: .post
-  tags:
-    - shell
-  before_script:
-    - cd ${CLAB_DIR}
-  script:
-    - sudo containerlab destroy --topo ${CI_PROJECT_DIR}/${CLAB_NAME}.clab.yml
-    - docker volume rm -f ${CLAB_NAME}-volume
-    - docker image rm -f ${DOCKER_IMAGE_SHA}
-  allow_failure: true
-  dependencies:
-    - containerlab:template

build/ci/.security-and-compliance-ci.yml

-sast:
-  variables:
-    SAST_ANALYZER_IMAGE_TAG: '2'
-    SAST_EXCLUDED_PATHS: spec, test, tests, tmp
-    SEARCH_MAX_DEPTH: '4'
-
-include:
-  - template: Security/SAST.gitlab-ci.yml
-  - template: Dependency-Scanning.gitlab-ci.yml
-  - template: Security/License-Scanning.gitlab-ci.yml

build/ci/.terraform-ci.yml

-
-variables:
-  TF_ROOT: ${CI_PROJECT_DIR}/test/terraform
-  TF_ADDRESS: ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/terraform/state/integration
-
-cache:
-  key: integration
-  paths:
-    - ${TF_ROOT}/.terraform
-
-.terraform_prefab: &tf
-  image: registry.gitlab.com/gitlab-org/terraform-images/stable:latest
-  variables:
-    CI_DEBUG_TRACE: "false"
-  before_script:
-    - cd ${TF_ROOT}
-    - export TF_VAR_integration_username=terraform
-    - export TF_VAR_integration_access_token=${TERRAFORM_API_TOKEN}
-    - export TF_VAR_integration_registry=${CI_REGISTRY}
-    - export TF_VAR_tls_key=${DOCKER_TLS_KEY}
-    - export TF_VAR_tls_cert=${DOCKER_TLS_CERT}
-    - export TF_VAR_tls_ca_cert=${DOCKER_TLS_CA}
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == 'develop')
-      variables:
-        TF_VAR_container_tag: $CI_REGISTRY_IMAGE:merge-request
-    - if: $CI_COMMIT_BRANCH == "integration-test"
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
-    - if: $CI_NIGHTLY
-
-init:
-  stage: .pre
-  script:
-    - gitlab-terraform init
-  <<: *tf
-
-validate:
-  stage: test
-  script:
-    - gitlab-terraform validate
-  needs: ["init"]
-  <<: *tf
-
-plan:
-  before_script:
-    - cd ${TF_ROOT}
-  stage: build
-  script:
-    - gitlab-terraform plan
-    - gitlab-terraform plan-json
-  artifacts:
-    name: plan
-    paths:
-      - ${TF_ROOT}/plan.cache
-    reports:
-      terraform: ${TF_ROOT}/plan.json
-  needs: ["validate"]
-  <<: *tf
-
-apply:
-  stage: apply
-  script:
-    - gitlab-terraform apply
-  dependencies:
-    - plan
-  <<: *tf
-
-destroy:tf:
-  stage: .post
-  script:
-    - gitlab-terraform destroy
-  <<: *tf
\ No newline at end of file

build/ci/generate_octet.bash

-#!/bin/bash
-
-input=$1
-#trailing_backspace=$2
-
-hashed_value=$(echo $input | sha256sum | awk '{print $1}' )
-
-decimal_value=$((16#$hashed_value))
-decimal_value=${decimal_value/-/}
-
-octet=$(((decimal_value % 255)))
-
-echo -n $octet
\ No newline at end of file

cli/capabilities.go

-package cli
-
-import (
-	"context"
-	"fmt"
-	"strings"
-
-	"code.fbi.h-da.de/danet/forks/goarista/gnmi"
-	"code.fbi.h-da.de/danet/gosdn/nucleus"
-	gpb "github.com/openconfig/gnmi/proto/gnmi"
-)
-
-// Capabilities sends a gNMI Capabilities request to the specified target
-// and prints the supported models to stdout
-func Capabilities(a, u, p string) error {
-	cfg := gnmi.Config{
-		Addr:     a,
-		Username: u,
-		Password: p,
-		Encoding: gpb.Encoding_JSON_IETF,
-	}
-	opts := &nucleus.GnmiTransportOptions{Config: cfg}
-	transport, err := nucleus.NewGnmiTransport(opts)
-	if err != nil {
-		return err
-	}
-	resp, err := transport.Capabilities(context.Background())
-	if err != nil {
-		return err
-	}
-	modelData := resp.(*gpb.CapabilityResponse).SupportedModels
-	b := strings.Builder{}
-	for _, elem := range modelData {
-		_, err := b.WriteString(elem.Name)
-		if err != nil {
-			return err
-		}
-		_, err = b.WriteString("\n")
-		if err != nil {
-			return err
-		}
-	}
-	fmt.Println(b.String())
-	return nil
-}

cli/get.go

-package cli
-
-import (
-	"context"
-
-	"code.fbi.h-da.de/danet/forks/goarista/gnmi"
-	"code.fbi.h-da.de/danet/gosdn/nucleus"
-	gpb "github.com/openconfig/gnmi/proto/gnmi"
-	log "github.com/sirupsen/logrus"
-)
-
-// Get sends a gNMI Get request to the specified target and prints the response to stdout
-func Get(a, u, p string, args ...string) (*gpb.GetResponse, error) {
-	sbi := &nucleus.OpenConfig{}
-	opts := &nucleus.GnmiTransportOptions{
-		Config: gnmi.Config{
-			Addr:     a,
-			Username: u,
-			Password: p,
-			Encoding: gpb.Encoding_JSON_IETF,
-		},
-		SetNode: sbi.SetNode(),
-	}
-	t, err := nucleus.NewGnmiTransport(opts)
-	if err != nil {
-		return nil, err
-	}
-	resp, err := t.Get(context.Background(), args...)
-	if err != nil {
-		return nil, err
-	}
-	log.Debug(resp)
-	r, ok := resp.(*gpb.GetResponse)
-	if !ok {
-		return nil, &nucleus.ErrInvalidTypeAssertion{}
-	}
-	return r, nil
-}

cli/http.go

-package cli
-
-import (
-	"errors"
-	"fmt"
-	log "github.com/sirupsen/logrus"
-	"github.com/spf13/viper"
-	"io/ioutil"
-	"net/http"
-	"strings"
-)
-
-const apiRoot = "?"
-
-var builder *strings.Builder
-
-func init() {
-	builder = &strings.Builder{}
-}
-
-// HTTPGet sends sends requests from the CLI to the gosdn HTTP API and processes any response data
-func HTTPGet(apiEndpoint, f string, args ...string) error {
-	for _, p := range args {
-		builder.WriteString("&")
-		builder.WriteString(p)
-	}
-	resp, err := http.Get(apiEndpoint + apiRoot + "q=" + f + builder.String())
-	if err != nil {
-		return err
-	}
-	builder.Reset()
-	switch resp.StatusCode {
-	case http.StatusOK:
-		defer resp.Body.Close()
-		bytes, err := ioutil.ReadAll(resp.Body)
-		if err != nil {
-			return err
-		}
-		switch f {
-		case "init":
-			pnd := string(bytes[:36])
-			sbi := string(bytes[36:])
-			viper.Set("CLI_PND", pnd)
-			viper.Set("CLI_SBI", sbi)
-			err := viper.WriteConfig()
-			if err != nil {
-				log.Error(err)
-			}
-		default:
-			fmt.Println(string(bytes))
-		}
-	case http.StatusCreated:
-		defer resp.Body.Close()
-		bytes, err := ioutil.ReadAll(resp.Body)
-		if err != nil {
-			return err
-		}
-		uuid := string(bytes[19:55])
-		viper.Set("LAST_DEVICE_UUID", uuid)
-		fmt.Println(string(bytes))
-	default:
-		log.WithFields(log.Fields{
-			"status code": resp.StatusCode,
-		}).Error("operation unsuccessful")
-		return errors.New(resp.Status)
-	}
-	return nil
-}

cli/init.go

-package cli
-
-import (
-	model "code.fbi.h-da.de/danet/yang-models/generated/arista"
-	"github.com/openconfig/ygot/ytypes"
-	log "github.com/sirupsen/logrus"
-)
-
-var testSchema *ytypes.Schema
-
-func init() {
-	var err error
-	testSchema, err = model.Schema()
-	if err != nil {
-		log.Fatal(err)
-	}
-}

cli/set.go

-package cli
-
-import (
-	"context"
-	"os"
-
-	"code.fbi.h-da.de/danet/forks/goarista/gnmi"
-	"code.fbi.h-da.de/danet/gosdn/nucleus"
-	"code.fbi.h-da.de/danet/gosdn/nucleus/util/proto"
-	pb "google.golang.org/protobuf/proto"
-)
-
-// Set sends a gNMI Set request to the specified target. Only one
-// request per invocation supported.
-func Set(a, u, p, typ string, args ...string) error {
-	opts := &nucleus.GnmiTransportOptions{
-		Config: gnmi.Config{
-			Addr:     a,
-			Username: u,
-			Password: p,
-		},
-	}
-	t, err := nucleus.NewGnmiTransport(opts)
-	if err != nil {
-		return err
-	}
-
-	path := gnmi.SplitPath(args[0])
-	req := []interface{}{
-		&gnmi.Operation{
-			Type:   typ,
-			Origin: "",
-			Target: "",
-			Path:   path,
-			Val:    args[1],
-		},
-	}
-
-	resp, err := t.Set(context.Background(), req...)
-	if err != nil {
-		return err
-	}
-
-	_, tap := os.LookupEnv("GOSDN_TAP")
-	if tap {
-		if err := proto.Write(resp.(pb.Message), "resp-set-system-config-hostname"); err != nil {
-			return err
-		}
-	}
-	return nil
-}

cli/subscribe.go

-package cli
-
-import (
-	"context"
-	"fmt"
-	"os"
-	"os/signal"
-	"syscall"
-	"time"
-
-	"code.fbi.h-da.de/danet/forks/goarista/gnmi"
-	"code.fbi.h-da.de/danet/gosdn/nucleus"
-	gpb "github.com/openconfig/gnmi/proto/gnmi"
-	log "github.com/sirupsen/logrus"
-)
-
-// Subscribe starts a gNMI subscriber requersting the specified paths on the target and
-// logs the response to stdout. Only 'stream' mode with 'sample' operation supported.
-func Subscribe(a, u, p string, sample, heartbeat int64, args ...string) error {
-	sbi := &nucleus.OpenConfig{}
-	tOpts := &nucleus.GnmiTransportOptions{
-		Config: gnmi.Config{
-			Addr:     a,
-			Username: u,
-			Password: p,
-			Encoding: gpb.Encoding_JSON_IETF,
-		},
-		SetNode:  sbi.SetNode(),
-		RespChan: make(chan *gpb.SubscribeResponse),
-	}
-
-	device, err := nucleus.NewDevice(sbi, tOpts)
-	if err != nil {
-		return err
-	}
-
-	opts := &gnmi.SubscribeOptions{
-		UpdatesOnly:       false,
-		Prefix:            "",
-		Mode:              "stream",
-		StreamMode:        "sample",
-		SampleInterval:    uint64(sample * time.Second.Nanoseconds()),
-		SuppressRedundant: false,
-		HeartbeatInterval: uint64(heartbeat * time.Second.Nanoseconds()),
-		Paths:             gnmi.SplitPaths(args),
-		Origin:            "",
-		Target:            a,
-	}
-	done := make(chan os.Signal, 1)
-	signal.Notify(done, syscall.SIGILL, syscall.SIGTERM)
-	ctx := context.WithValue(context.Background(), nucleus.CtxKeyOpts, opts) //nolint
-	go func() {
-		if err := device.Transport.Subscribe(ctx); err != nil {
-			log.Fatal(err)
-		}
-	}()
-	fmt.Println("awaiting signal")
-	<-done
-	fmt.Println("exiting")
-	return nil
-}

cli/target.go

-package cli
-
-import (
-	"context"
-	"net"
-	"reflect"
-
-	"code.fbi.h-da.de/danet/forks/google/gnmi"
-	oc "code.fbi.h-da.de/danet/yang-models/generated/openconfig"
-	pb "github.com/openconfig/gnmi/proto/gnmi"
-	"github.com/openconfig/goyang/pkg/yang"
-	"github.com/openconfig/ygot/util"
-	"github.com/openconfig/ygot/ygot"
-	log "github.com/sirupsen/logrus"
-	"google.golang.org/grpc"
-	"google.golang.org/grpc/reflection"
-)
-
-type server struct {
-	*gnmi.Server
-}
-
-func callback(newConfig ygot.ValidatedGoStruct) error {
-	// Apply the config to your device and return nil if success. return error if fails.
-	//
-	// Do something ...
-	return nil
-}
-
-func newServer(model *gnmi.Model, config []byte) (*server, error) {
-	s, err := gnmi.NewServer(model, config, callback)
-	if err != nil {
-		return nil, err
-	}
-	return &server{Server: s}, nil
-}
-
-// Get overrides the Get func of gnmi.Target to provide user auth.
-func (s *server) Get(ctx context.Context, req *pb.GetRequest) (*pb.GetResponse, error) {
-	return s.Server.Get(ctx, req)
-}
-
-// Set overrides the Set func of gnmi.Target to provide user auth.
-/*
-func (s *server) Set(ctx context.Context, req *pb.SetRequest) (*pb.SetResponse, error) {
-	msg, ok := credentials.AuthorizeUser(ctx)
-	if !ok {
-		log.Infof("denied a Set request: %v", msg)
-		return nil, status.Error(codes.PermissionDenied, msg)
-	}
-	log.Infof("allowed a Set request: %v", msg)
-	return s.Server.Set(ctx, req)
-}
-*/
-
-// Target starts a gNMI target listening on the specified port.
-func Target(bindAddr string) error {
-	entries := make([]*yang.Entry, 0)
-	for _, e := range oc.SchemaTree {
-		entries = append(entries, e)
-	}
-
-	modelData, err := util.FindModelData(entries)
-	if err != nil {
-		return err
-	}
-	// Google stuff from here
-	model := gnmi.NewModel(
-		modelData,
-		reflect.TypeOf((*oc.Device)(nil)),
-		oc.SchemaTree["Device"],
-		oc.Unmarshal,
-		oc.ΛEnum)
-
-	g := grpc.NewServer()
-
-	var configData []byte
-	s, err := newServer(model, configData)
-	if err != nil {
-		return err
-	}
-	pb.RegisterGNMIServer(g, s)
-	reflection.Register(g)
-
-	log.Infof("starting to listen on %s", bindAddr)
-	listen, err := net.Listen("tcp", bindAddr)
-	if err != nil {
-		return err
-	}
-
-	log.Info("starting to serve")
-	return g.Serve(listen)
-}

cmd/addDevice.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-// addDeviceCmd represents the addDevice command
-var addDeviceCmd = &cobra.Command{
-	Use:   "add-device",
-	Short: "adds a device to the controller",
-	Long: `Adds a device to the controller. 
-	
-Device address and user credentials need to be provided
-if they diverge from the default credentials.`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		return cli.HTTPGet(
-			apiEndpoint,
-			"addDevice",
-			"address="+address,
-			"password="+password,
-			"username="+username,
-			"sbi="+cliSbi,
-			"pnd="+cliPnd,
-		)
-	},
-}
-
-func init() {
-	cliCmd.AddCommand(addDeviceCmd)
-}

cmd/capabilities.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-// capabilitiesCmd represents the capabilities command
-var capabilitiesCmd = &cobra.Command{
-	Use:   "capabilities",
-	Short: "capabilities request",
-	Long: `Sends a gNMI Capabilities request to the specified target
-and prints the supported models to stdout.`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		return cli.Capabilities(username, password, address)
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(capabilitiesCmd)
-}

cmd/cli.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-var uuid string
-var apiEndpoint string
-
-// cliCmd represents the cli command
-var cliCmd = &cobra.Command{
-	Use:   "cli",
-	Short: "initialises the cli",
-	Long: `Initialises the CLI. The first PND UUID and SBI UUID 
-are written to the config file for subsequent requests.`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		return cli.HTTPGet(apiEndpoint, "init")
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(cliCmd)
-
-	cliCmd.PersistentFlags().StringVar(&apiEndpoint, "controller", "http://gosdn-develop.apps.ocp.fbi.h-da.de/api", "address of the controller")
-
-}

cmd/cliSet.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-// cliSetCmd represents the cliSet command
-var cliSetCmd = &cobra.Command{
-	Use:   "set",
-	Args:  cobra.ExactArgs(2),
-	Short: "set a value on a device",
-	Long: `Set a path value for a given device. Only one path and
-only one value supported for now`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		return cli.HTTPGet(
-			apiEndpoint,
-			"set",
-			"uuid="+uuid,
-			"cliSbi="+cliSbi,
-			"cliPnd="+cliPnd,
-			"path="+args[0],
-			"address="+address,
-			"value="+args[1],
-		)
-	},
-}
-
-func init() {
-	cliCmd.AddCommand(cliSetCmd)
-
-	cliSetCmd.Flags().StringVar(&uuid, "uuid", "", "uuid of the requested device")
-}

cmd/get.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-// getCmd represents the get command
-var getCmd = &cobra.Command{
-	Use:   "gosdn get",
-	Short: "get request",
-	Long: `Sends a gNMI Get request to the specified target and
-prints the response to stdout`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		_, err := cli.Get(address, username, password, args...)
-		return err
-	},
-}
-
-func init() {
-	rootCmd.AddCommand(getCmd)
-}

cmd/getDevice.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-// getDeviceCmd represents the getDevice command
-var getDeviceCmd = &cobra.Command{
-	Use:   "get-device",
-	Args:  cobra.ExactArgs(1),
-	Short: "gets device information from the controller",
-	Long: `Gets device information from the controller.
-	
-Device UUID needs to be specified as positional argument.`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		return cli.HTTPGet(
-			apiEndpoint,
-			"getDevice",
-			"uuid="+args[0],
-			"sbi="+cliSbi,
-			"pnd="+cliPnd,
-		)
-	},
-}
-
-func init() {
-	cliCmd.AddCommand(getDeviceCmd)
-}

cmd/getIds.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-// getIdsCmd represents the getIds command
-var getIdsCmd = &cobra.Command{
-	Use:   "get-ids",
-	Short: "gets device IDs from the controller",
-	Long:  `Gets device IDs from the controller and lists them.`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		return cli.HTTPGet(apiEndpoint, "getIDs")
-	},
-}
-
-func init() {
-	cliCmd.AddCommand(getIdsCmd)
-}

cmd/init.go

-/*
-Copyright © 2021 da/net research group <danet.fbi.h-da.de>
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice,
-   this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors
-   may be used to endorse or promote products derived from this software
-   without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
-*/
-
-package cmd
-
-import (
-	"code.fbi.h-da.de/danet/gosdn/cli"
-	"github.com/spf13/cobra"
-)
-
-// initCmd represents the init command
-var initCmd = &cobra.Command{
-	Use:   "init",
-	Short: "initialise SBI and PND",
-	Long: `Initialise SBI and PND and saves values to config file.
-	
-Same as invoking "gosdn cli" without any arguments`,
-	RunE: func(cmd *cobra.Command, args []string) error {
-		return cli.HTTPGet(apiEndpoint, "init")
-	},
-}
-
-func init() {
-	cliCmd.AddCommand(initCmd)
-
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// initCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// initCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
-}