Merge pull request #13 from carlmontanari/scrapligo-v1.0.0

update to work with scrapligo/cfg v1.0.0

Author: hellt

.github/workflows/cicd.yml

@@ -14,36 +14,36 @@ env:
 
 jobs:
   unit-test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
         with:
           go-version: ${{ env.GOVER }}
       - run: go test -cover ./...
 
   lint:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: set up go lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.43.0
+          version: v1.46.2
 
   build-and-release:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/v')
     needs:
       - unit-test
       - lint
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
           go-version: ${{ env.GOVER }}
       - name: Run GoReleaser

.golangci.yml

@@ -111,6 +111,6 @@ run:
 # golangci.com configuration
 # https://github.com/golangci/golangci/wiki/Configuration
 service:
-  golangci-lint-version: 1.43.x # use the fixed version to not introduce new linters unexpectedly
+  golangci-lint-version: 1.46.x # use the fixed version to not introduce new linters unexpectedly
   prepare:
     - echo "here I can run custom commands, but no preparation needed for this repo"

Makefile

@@ -1,3 +1,3 @@
 lint:
 	docker run -it --rm -v $$(pwd):/work ghcr.io/hellt/golines:0.8.0 golines -w .
-	docker run -it --rm -v $$(pwd):/app -w /app golangci/golangci-lint:v1.43.0 golangci-lint run -v
+	docker run -it --rm -v $$(pwd):/app -w /app golangci/golangci-lint:v1.46.2 golangci-lint run -v

commando/cmdo.go

@@ -6,7 +6,9 @@ import (
 	"os"
 	"sync"
 
-	"github.com/scrapli/scrapligo/cfg"
+	"github.com/scrapli/scrapligocfg/response"
+
+	"github.com/scrapli/scrapligocfg"
 
 	"github.com/scrapli/scrapligo/driver/network"
 	log "github.com/sirupsen/logrus"
@@ -149,7 +151,11 @@ func (app *appCfg) run() error {
 	return nil
 }
 
-func runCfgGetConfig(name string, c *cfg.Cfg, op *cfgOperation) (*cfg.Response, error) {
+func runCfgGetConfig(
+	name string,
+	c *scrapligocfg.Cfg,
+	op *cfgOperation,
+) (*response.Response, error) {
 	source := "running"
 	if op.Source != "" {
 		source = op.Source
@@ -165,10 +171,10 @@ func runCfgGetConfig(name string, c *cfg.Cfg, op *cfgOperation) (*cfg.Response,
 	return r, nil
 }
 
-func runCfgLoadConfig(name string, c *cfg.Cfg, op *cfgOperation) ([]interface{}, error) {
+func runCfgLoadConfig(name string, c *scrapligocfg.Cfg, op *cfgOperation) ([]interface{}, error) {
 	var responses []interface{}
 
-	var r *cfg.Response
+	var r *response.Response
 
 	var err error
 
@@ -185,7 +191,7 @@ func runCfgLoadConfig(name string, c *cfg.Cfg, op *cfgOperation) ([]interface{},
 	}
 
 	if op.Diff {
-		dr, diffErr := c.DiffConfig()
+		dr, diffErr := c.DiffConfig("running")
 		if diffErr != nil {
 			log.Errorf("diff-config operation failed for device %s; error: %+v\n", name, diffErr)
 
@@ -221,7 +227,7 @@ func runCfg(name string, d *device, driver *network.Driver) ([]interface{}, erro
 		return nil, nil
 	}
 
-	c, err := cfg.NewCfgDriver(driver, d.Platform)
+	c, err := scrapligocfg.NewCfg(driver, d.Platform)
 	if err != nil {
 		log.Errorf("failed to create cfg connection for device %s; error: %+v\n", name, err)
 

commando/conn.go

@@ -1,58 +1,57 @@
 package commando
 
 import (
-	"github.com/scrapli/scrapligo/driver/base"
-	"github.com/scrapli/scrapligo/driver/core"
 	"github.com/scrapli/scrapligo/driver/network"
+	"github.com/scrapli/scrapligo/driver/options"
+	"github.com/scrapli/scrapligo/platform"
 	"github.com/scrapli/scrapligo/transport"
+	"github.com/scrapli/scrapligo/util"
 	log "github.com/sirupsen/logrus"
-	"github.com/srl-labs/srlinux-scrapli"
 )
 
 func (app *appCfg) validTransport(t string) bool {
 	switch t {
-	case transport.SystemTransportName:
+	case transport.SystemTransport:
 		return true
-	case transport.StandardTransportName:
+	case transport.StandardTransport:
 		return true
-	case transport.TelnetTransportName:
+	case transport.TelnetTransport:
 		return true
 	default:
 		return false
 	}
 }
 
-func (app *appCfg) loadCredentials(o []base.Option, c string) ([]base.Option, error) {
+func (app *appCfg) loadCredentials(o []util.Option, c string) ([]util.Option, error) {
 	creds, ok := app.credentials[c]
 	if !ok {
 		return o, errInvalidCredentialsName
 	}
 
 	if creds.Username != "" {
-		o = append(o, base.WithAuthUsername(creds.Username))
+		o = append(o, options.WithAuthUsername(creds.Username))
 	}
 
 	if creds.Password != "" {
-		o = append(o, base.WithAuthPassword(creds.Password))
+		o = append(o, options.WithAuthPassword(creds.Password))
 	}
 
 	if creds.SecondaryPassword != "" {
-		o = append(o, base.WithAuthSecondary(creds.SecondaryPassword))
+		o = append(o, options.WithAuthSecondary(creds.SecondaryPassword))
 	}
 
 	if creds.PrivateKey != "" {
-		o = append(o, base.WithAuthPrivateKey(creds.PrivateKey))
+		o = append(o, options.WithAuthPrivateKey(creds.PrivateKey, ""))
 	}
 
 	return o, nil
 }
 
-func (app *appCfg) loadTransport(o []base.Option, t string) ([]base.Option, error) {
-	// default to strict key false and standard transport, so load those into options first
+func (app *appCfg) loadTransport(o []util.Option, t string) ([]util.Option, error) {
+	// default to standard transport, so load those into options first
 	o = append(
 		o,
-		base.WithTransportType(transport.StandardTransportName),
-		base.WithAuthStrictKey(false),
+		options.WithTransportType(transport.StandardTransport),
 	)
 
 	transp, ok := app.transports[t]
@@ -66,31 +65,31 @@ func (app *appCfg) loadTransport(o []base.Option, t string) ([]base.Option, erro
 	}
 
 	if transp.Port != 0 {
-		o = append(o, base.WithPort(transp.Port))
+		o = append(o, options.WithPort(transp.Port))
 	}
 
-	if transp.StrictKey {
-		o = append(o, base.WithAuthStrictKey(transp.StrictKey))
+	if !transp.StrictKey {
+		o = append(o, options.WithAuthNoStrictKey())
 	}
 
 	if transp.SSHConfigFile != "" {
-		o = append(o, base.WithSSHConfigFile(transp.SSHConfigFile))
+		o = append(o, options.WithSSHConfigFile(transp.SSHConfigFile))
 	}
 
 	if transp.TransportType != "" {
 		if !app.validTransport(transp.TransportType) {
 			return nil, errInvalidTransport
 		}
 
-		o = append(o, base.WithTransportType(transp.TransportType))
+		o = append(o, options.WithTransportType(transp.TransportType))
 	}
 
 	return o, nil
 }
 
 // loadOptions loads options from the provided inventory.
-func (app *appCfg) loadOptions(d *device) ([]base.Option, error) {
-	var o []base.Option
+func (app *appCfg) loadOptions(d *device) ([]util.Option, error) {
+	var o []util.Option
 
 	var err error
 
@@ -133,22 +132,19 @@ func (app *appCfg) openCoreConn(name string, d *device) (*network.Driver, error)
 		return nil, err
 	}
 
-	switch d.Platform {
-	case "nokia_srlinux":
-		driver, err = srlinux.NewSRLinuxDriver(
-			d.Address,
-			o...,
-		)
-	default:
-		driver, err = core.NewCoreDriver(
-			d.Address,
-			d.Platform,
-			o...,
-		)
+	plat, err := platform.NewPlatform(
+		d.Platform,
+		d.Address,
+		o...,
+	)
+	if err != nil {
+		log.Errorf("failed to create platform instance for device %s; error: %+v\n", err, name)
+		return nil, err
 	}
 
+	driver, err = plat.GetNetworkDriver()
 	if err != nil {
-		log.Errorf("failed to create driver for device %s; error: %+v\n", err, name)
+		log.Errorf("failed to create driver instance for device %s; error: %+v\n", err, name)
 		return nil, err
 	}
 

commando/respwriter.go

@@ -7,9 +7,8 @@ import (
 	"strings"
 	"time"
 
-	"github.com/scrapli/scrapligo/driver/base"
-
-	"github.com/scrapli/scrapligo/cfg"
+	"github.com/scrapli/scrapligo/response"
+	cfgresponse "github.com/scrapli/scrapligocfg/response"
 
 	"github.com/fatih/color"
 )
@@ -62,27 +61,27 @@ func (w *consoleWriter) writeSuccess(r []interface{}, name string) error {
 
 	for _, mr := range r {
 		switch respObj := mr.(type) {
-		case *base.MultiResponse:
+		case *response.MultiResponse:
 			for _, resp := range respObj.Responses {
 				c := color.New(color.Bold)
-				c.Fprintf(os.Stderr, "\n-- %s:\n", resp.ChannelInput)
+				c.Fprintf(os.Stderr, "\n-- %s:\n", resp.Input)
 
 				if resp.Failed != nil {
 					color.Set(color.FgRed)
 				}
 
 				fmt.Println(resp.Result)
 			}
-		case *cfg.Response:
+		case *cfgresponse.Response:
 			c := color.New(color.Bold)
-			c.Fprintf(os.Stderr, "\n-- cfg-%s:\n", respObj.OperationType)
+			c.Fprintf(os.Stderr, "\n-- cfg-%s:\n", respObj.Op)
 
 			if respObj.Failed != nil {
 				color.Set(color.FgRed)
 			}
 
 			fmt.Println(respObj.Result)
-		case *cfg.DiffResponse:
+		case *cfgresponse.DiffResponse:
 			c := color.New(color.Bold)
 			c.Fprint(os.Stderr, "\n-- cfg-DiffConfig:\n")
 
@@ -118,26 +117,26 @@ func (w *fileWriter) WriteResponse(r []interface{}, name string) error {
 
 	for _, mr := range r {
 		switch respObj := mr.(type) {
-		case *base.MultiResponse:
+		case *response.MultiResponse:
 			for _, resp := range respObj.Responses {
-				c := sanitizeCmd(resp.ChannelInput)
+				c := sanitizeCmd(resp.Input)
 
 				rb := []byte(resp.Result)
 				if err := os.WriteFile(path.Join(outDir, c), rb, filePermissions); err != nil {
 					return err
 				}
 			}
-		case *cfg.Response:
+		case *cfgresponse.Response:
 			rb := []byte(respObj.Result)
-			if err := os.WriteFile(path.Join(outDir, respObj.OperationType), rb, filePermissions); err != nil {
+			if err := os.WriteFile(path.Join(outDir, respObj.Op), rb, filePermissions); err != nil {
 				return err
 			}
-		case *cfg.DiffResponse:
+		case *cfgresponse.DiffResponse:
 			rb := []byte(
 				fmt.Sprintf("Device Diff:\n%s\n\nSide By Side Diff:\n%s\n\nUnified Diff:\n%s",
 					respObj.DeviceDiff, respObj.SideBySideDiff(), respObj.UnifiedDiff()),
 			)
-			if err := os.WriteFile(path.Join(outDir, respObj.OperationType), rb, filePermissions); err != nil {
+			if err := os.WriteFile(path.Join(outDir, respObj.Op), rb, filePermissions); err != nil {
 				return err
 			}
 		}

go.mod

@@ -3,11 +3,10 @@ module github.com/hellt/cmdo
 go 1.16
 
 require (
-	github.com/carlmontanari/difflibgo v0.0.0-20210718194309-31b9e131c298 // indirect
 	github.com/fatih/color v1.12.0
-	github.com/scrapli/scrapligo v0.1.2
+	github.com/scrapli/scrapligo v1.0.2
+	github.com/scrapli/scrapligocfg v1.0.0
 	github.com/sirupsen/logrus v1.8.1
-	github.com/srl-labs/srlinux-scrapli v0.4.1
 	github.com/urfave/cli/v2 v2.3.0
 	gopkg.in/yaml.v2 v2.4.0
 )