next

.github/workflows/docs.yml

@@ -14,17 +14,18 @@ jobs:
   deploy-docs:
     name: Deploy docs
     runs-on: ubuntu-latest
+    concurrency: ci-${{ github.ref }}
     steps:
       - name: Checkout main
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/setup-node@v2
         with:
           node-version: '16'
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.18
+          go-version-file: go.mod
 
       - name: Generate docs
         run: go generate -x

.github/workflows/lint.yml

@@ -0,0 +1,38 @@
+name: Lint
+
+on:
+  push:
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    concurrency: ci-lint-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - name: Install pre-commit deps
+        run: |
+          sudo apt install -y pre-commit
+          go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+          go install golang.org/x/tools/cmd/goimports@latest
+          go install github.com/fzipp/gocyclo/cmd/gocyclo@latest
+          go install -v github.com/go-critic/go-critic/cmd/gocritic@latest
+
+      - name: Hash key for Cache pre-commit
+        uses: seepine/hash-files@v1
+        id: key-hash
+        with:
+          patterns: ".pre-commit-config.yaml"
+
+      - name: Cache pre-commit
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit/
+          key: pre-commit-${{ steps.key-hash.outputs.hash }}
+
+      - run: pre-commit run --all-files

.github/workflows/release.yml

@@ -10,13 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Set up Go
-        uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.18
+          go-version-file: go.mod
 
       - name: Install PDF generation dependencies
         run: |

.github/workflows/snapshot.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -26,10 +26,9 @@ jobs:
           body: |
             Starting snapshot release [`${{ steps.snapshot_id.outputs.SNAPSHOT_ID }}`](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})
 
-      - name: Set up Go
-        uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.18
+          go-version-file: go.mod
 
       - name: Install PDF generation dependencies
         run: |

.github/workflows/test.yml

@@ -2,37 +2,24 @@ name: Test
 
 on:
   push:
-  pull_request:
 
 jobs:
   test:
     name: test
     runs-on: ubuntu-latest
+    concurrency: ci-test-${{ github.ref }}
     steps:
-      - name: Install bgpq4 and bird2
+      - name: Install bgpq4
         run: |
           wget http://ftp.us.debian.org/debian/pool/main/b/bgpq4/bgpq4_0.0.6-2_amd64.deb
           sudo dpkg -i bgpq4*.deb
-          sudo apt install -y bird2
 
-      - uses: actions/setup-go@v4
-        with:
-          go-version: '1.20'
-          cache: false
-
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+      - uses: actions/setup-go@v5
         with:
-          args: -E gosec
+          go-version-file: go.mod
 
-      - run: go get -v -t -d ./...
-      - run: sudo chown $(whoami):$(whoami) /run/bird/bird.ctl
-      - run: sudo chown -R $(whoami):$(whoami) /etc/bird/
-      - run: go generate -x
-      - run: go build -v .
-      - run: make dep
       - run: make test-setup
       - run: make test
 

.gitignore

@@ -25,7 +25,6 @@ vendorbuild/cisco/ioxclient
 vendorbuild/mikrotik/docker-buildx
 
 # Testing
-test-cache/
 test-conf.yml
 nohup.out
 coverage.txt

.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+exclude: '^\.idea/'
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  # TODO: upstream
+  - repo: https://github.com/natesales/goimports-reviser
+    rev: a807b1af1da00a44880668d880ef7d4ce51feb42
+    hooks:
+      - id: goimports-reviser
+
+  #  - repo: https://github.com/igorshubovych/markdownlint-cli
+  #    rev: v0.35.0
+  #    hooks:
+  #      - id: markdownlint
+  #        # MD013: line too long
+  #        # MD033: no inline HTML
+  #        # MD041: first line in a file should be a top-level heading
+  #        args: [ --disable, MD013, MD033, MD041, "--" ]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        args: [
+          --skip, "go.*",
+          -L, "statics,socio-economic"
+        ]
+        stages: [ commit, commit-msg ]
+        exclude_types: [ json ]
+
+  - repo: https://github.com/dnephin/pre-commit-golang
+    rev: v0.5.1
+    hooks:
+      - id: go-fmt
+      - id: go-vet
+      - id: go-imports
+      - id: go-cyclo
+        args: [ -over=25 ]
+      - id: golangci-lint
+      - id: go-critic
+      - id: go-build
+      - id: go-mod-tidy

Makefile

@@ -1,5 +1,7 @@
-dep:
-	pip3 install flask
+down:
+	docker rm -f pathvector-peeringdb-test-api || true
+	docker rm -f pathvector-bird || true
+	sudo ip link del dev dummy0 || true
 
 dummy-iface:
 	# Allow UDP ping. For more information, see https://github.com/go-ping/ping#linux
@@ -9,17 +11,36 @@ dummy-iface:
 	sudo ip addr add dev dummy0 2001:db8::1/64
 	sudo ip link set dev dummy0 up
 
-peeringdb-test-harness:
-	nohup python3 tests/peeringdb/peeringdb-test-api.py &
+build-pdb:
+	docker build -t peeringdb-test-api tests/peeringdb
 
-test-setup: dummy-iface peeringdb-test-harness
+run-pdb:
+	docker rm -f pathvector-peeringdb-test-api || true
+	docker run --name pathvector-peeringdb-test-api -d -p 5001:5001 peeringdb-test-api
+
+run-bird:
+	docker rm -f pathvector-bird || true
+	rm -rf /tmp/bird-conf || true
+	mkdir -p /tmp/bird-conf
+	echo "protocol device {}" > /tmp/bird-conf/bird.conf
+	docker run \
+		-d \
+		--privileged \
+		--name pathvector-bird \
+		-p 5002:5002 \
+		-v $(shell pwd)/tests/bird-entrypoint.sh:/entrypoint.sh \
+		-v /tmp/bird-conf/:/etc/bird/ \
+		-v /tmp/test-cache/:/tmp/test-cache/ \
+		pierky/bird:2.16 /entrypoint.sh
+
+pdb-api: build-pdb run-pdb
+
+test-setup: dummy-iface run-bird pdb-api
 
 test:
-	export PATHVECTOR_TEST=1 && go test -v -race -coverprofile=coverage.txt -covermode=atomic ./pkg/... ./cmd/...
+	go test -v -p 1 -coverprofile=coverage.txt -covermode=atomic ./pkg/... ./cmd/...
 
-test-teardown:
-	pkill -f tests/peeringdb/peeringdb-test-api.py
-	sudo ip link del dev dummy0
-	rm -f nohup.out
+test-sequence: test-setup test down
 
-test-sequence: test-setup test test-teardown
+snapshot:
+	goreleaser --snapshot --clean

cmd/bird_fmt.go

@@ -0,0 +1,80 @@
+package cmd
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/spf13/cobra"
+
+	"github.com/natesales/pathvector/pkg/bird"
+	"github.com/natesales/pathvector/pkg/util/log"
+)
+
+func init() {
+	rootCmd.AddCommand(birdFmtCmd)
+}
+
+func isDir(path string) (bool, error) {
+	fi, err := os.Stat(path)
+	if err != nil {
+		return false, err
+	}
+
+	return fi.IsDir(), nil
+}
+
+func formatFile(path string) error {
+	if !strings.HasSuffix(path, ".conf") {
+		log.Debugf("Skipping %s", path)
+		return nil
+	}
+
+	log.Infof("Formatting %s", path)
+
+	unformatted, err := os.ReadFile(path)
+	if err != nil {
+		return err
+	}
+
+	formatted := bird.Reformat(string(unformatted))
+
+	if err := os.WriteFile(path, []byte(formatted), 0644); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+var birdFmtCmd = &cobra.Command{
+	Use:   "bird-fmt [file/directory]",
+	Short: "Format BIRD config",
+	Run: func(cmd *cobra.Command, args []string) {
+		if len(args) == 0 {
+			log.Fatal("No file/directory specified")
+		}
+
+		target := args[0]
+
+		// Check if directory
+		dir, err := isDir(target)
+		if err != nil {
+			log.Fatal(err)
+		}
+		if dir {
+			// For file in walk directory
+			if err := filepath.Walk(target, func(path string, info os.FileInfo, err error) error {
+				if err != nil {
+					log.Fatal(err)
+				}
+				return formatFile(path)
+			}); err != nil {
+				log.Fatal(err)
+			}
+		} else {
+			if err := formatFile(target); err != nil {
+				log.Fatal(err)
+			}
+		}
+	},
+}

cmd/birdsh.go

@@ -2,15 +2,14 @@ package cmd
 
 import (
 	"bufio"
-	"fmt"
 	"net"
 	"os"
 	"strings"
 
-	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
 	"github.com/natesales/pathvector/pkg/bird"
+	"github.com/natesales/pathvector/pkg/util/log"
 )
 
 var socket = ""
@@ -50,7 +49,7 @@ var birdshCmd = &cobra.Command{
 
 		r := bufio.NewReader(os.Stdin)
 		for {
-			fmt.Print("bird> ")
+			log.Printf("bird> ")
 			cmd, _ := r.ReadString('\n')
 			cmd = strings.ReplaceAll(cmd, "\n", "")
 			if cmd != "" {