post 2.0.0 fixes (#16)

* ...aaaaaaand update doc references as well * it is not obvious how go.mod should work for submods * v2 before submodule name in replace * fix docs for new go.mod approach * add benchmark for enumerate * make sure all the addresses are actually present * add linefeed at end to avoid go test error * race detector didnt like var re-use * fixes for 'golangci-lint run' * swap over from circleci/coveralls to actions * update readme's for new test badges * explicitly pick a golangci action version
c-robinson · Dec 30, 2023 · 808dd52 · 808dd52
1 parent 6e3a574
commit 808dd52
Show file tree

Hide file tree

Showing 18 changed files with 155 additions and 84 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,96 @@
+name: Test
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  GO111MODULE: on
+
+permissions:
+  contents: read
+
+jobs:
+  golangci-lint:
+    permissions:
+      contents: read
+      pull-requests: read
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version: '^1.20'
+          check-latest: true
+          cache: true
+
+      - uses: golangci/golangci-lint-action@v3.7.0
+        with:
+          version: latest
+          args: --verbose
+
+
+  test-unix:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - ubuntu
+          - macOS
+        go:
+          - 20
+          - 21
+    name: '${{ matrix.platform }} | 1.${{ matrix.go }}.x'
+    runs-on: ${{ matrix.platform }}-latest
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.${{ matrix.go }}.x
+          cache: true
+
+      - run: |
+          export GOBIN=$HOME/go/bin
+          go install github.com/kyoh86/richgo@latest
+      - run: RICHGO_FORCE_COLOR=1 PATH=$HOME/go/bin/:$PATH richgo test -v -race ./...
+
+
+  test-win:
+    name: MINGW64
+    defaults:
+      run:
+        shell: msys2 {0}
+    runs-on: windows-latest
+    steps:
+
+      - shell: bash
+        run: git config --global core.autocrlf input
+
+      - uses: msys2/setup-msys2@v2
+        with:
+          msystem: MINGW64
+          update: true
+          install: >
+            git
+            make
+            unzip
+            mingw-w64-x86_64-go
+
+      - uses: actions/checkout@v4
+
+      - uses: actions/cache@v3
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-${{ matrix.go }}-${{ hashFiles('**/go.sum') }}
+          restore-keys: ${{ runner.os }}-${{ matrix.go }}-
+
+      - run: |
+          export GOBIN=$HOME/go/bin
+          go install github.com/kyoh86/richgo@latest
+
+      - run: RICHGO_FORCE_COLOR=1 PATH=$HOME/go/bin/:$PATH richgo test -v ./...
diff --git a/README.md b/README.md
@@ -1,8 +1,7 @@
 # IPLib
-[![Documentation](https://godoc.org/github.com/c-robinson/iplib?status.svg)](http://godoc.org/github.com/c-robinson/iplib)
-[![CircleCI](https://circleci.com/gh/c-robinson/iplib/tree/main.svg?style=svg)](https://circleci.com/gh/c-robinson/iplib/tree/main)
+[![Documentation](https://godoc.org/github.com/c-robinson/iplib?status.svg)](https://pkg.go.dev/github.com/c-robinson/iplib/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/c-robinson/iplib)](https://goreportcard.com/report/github.com/c-robinson/iplib)
-[![Coverage Status](https://coveralls.io/repos/github/c-robinson/iplib/badge.svg?branch=main)](https://coveralls.io/github/c-robinson/iplib?branch=main)
+[![Tests](https://img.shields.io/github/actions/workflow/status/c-robinson/iplib/test.yml?branch=main&longCache=true&label=Test&logo=github%20actions&logoColor=fff)](https://github.com/c-robinson/iplib/actions?query=workflow%3ATest)
 
 **ATTENTION** version 2.0.0 is a breaking change from previous versions for
 handling IPv6 addresses (functions for IPv4 are unchanged). Calls that result

diff --git a/go.mod b/go.mod
@@ -2,4 +2,9 @@ module github.com/c-robinson/iplib/v2
 
 go 1.20
 
+replace (
+	github.com/c-robinson/iplib/v2/iana => ./iana
+	github.com/c-robinson/iplib/v2/iid => ./iid
+)
+
 require lukechampine.com/uint128 v1.3.0
diff --git a/hostmask.go b/hostmask.go
@@ -276,8 +276,7 @@ func decrementBoundaryByte(bb, bv byte, count uint128.Uint128) (uint128.Uint128,
 	byteMax := uint128.From64(256 - uint64(bb)) // max value of unmasked bits in the byte
 	byteVal := uint128.From64(uint64(bv))       // cur value of unmasked bits in the byte
 
-	mod := uint128.New(0, 0)
-
+	var mod uint128.Uint128
 	count, mod = count.QuoRem(byteMax)
 
 	// extract the actual modulus into bmod
@@ -342,7 +341,7 @@ func incrementBoundaryByte(bb, bv byte, count uint128.Uint128) (uint128.Uint128,
 		return uint128.Uint128{}, byte(count.Lo)
 	}
 
-	mod := uint128.New(0, 0)
+	var mod uint128.Uint128
 	count, mod = count.QuoRem(byteMax)
 	rb := make([]byte, 16)
 	mod.PutBytesBE(rb)

diff --git a/iana/README.md b/iana/README.md
@@ -1,8 +1,7 @@
 # iana
-[![Documentation](https://godoc.org/github.com/c-robinson/iplib?status.svg)](http://godoc.org/github.com/c-robinson/iplib/iana)
-[![CircleCI](https://circleci.com/gh/c-robinson/iplib/tree/main.svg?style=svg)](https://circleci.com/gh/c-robinson/iplib/tree/main)
+[![Documentation](https://godoc.org/github.com/c-robinson/iplib?status.svg)](http://godoc.org/github.com/c-robinson/iplib/v2/iana)
 [![Go Report Card](https://goreportcard.com/badge/github.com/c-robinson/iplib)](https://goreportcard.com/report/github.com/c-robinson/iplib)
-[![Coverage Status](https://coveralls.io/repos/github/c-robinson/iplib/badge.svg?branch=main)](https://coveralls.io/github/c-robinson/iplib?branch=main)
+[![Tests](https://img.shields.io/github/actions/workflow/status/c-robinson/iplib/test.yml?branch=main&longCache=true&label=Test&logo=github%20actions&logoColor=fff)](https://github.com/c-robinson/iplib/actions?query=workflow%3ATest)
 
 This package imports the [Internet Assigned Number Authority (IANA)](https://www.iana.org/)
 Special IP Address Registry for [IPv4](https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml)
@@ -14,7 +13,7 @@ are contained within an reserved IP address block.
 ## Installing
 
 ```sh
-go get -u github.com/c-robinson/iplib/v2/iana
+go get -u github.com/c-robinson/iplib/v2
 ```
 
 ## Using IANA

diff --git a/iana/go.mod b/iana/go.mod
diff --git a/iana/go.sum b/iana/go.sum
diff --git a/iana/iana.go b/iana/iana.go
@@ -172,7 +172,7 @@ func GetRFCsForNetwork(n iplib.Net) []string {
 func IsForwardable(n iplib.Net) bool {
 	reservations := GetReservationsForNetwork(n)
 	for _, r := range reservations {
-		if r.Forwardable == false {
+		if !r.Forwardable {
 			return false
 		}
 	}
@@ -187,7 +187,7 @@ func IsForwardable(n iplib.Net) bool {
 func IsGlobal(n iplib.Net) bool {
 	reservations := GetReservationsForNetwork(n)
 	for _, r := range reservations {
-		if r.Global == false {
+		if !r.Global {
 			return false
 		}
 	}
@@ -203,7 +203,7 @@ func IsGlobal(n iplib.Net) bool {
 func IsReserved(n iplib.Net) bool {
 	reservations := GetReservationsForNetwork(n)
 	for _, r := range reservations {
-		if r.Reserved == true {
+		if r.Reserved {
 			return true
 		}
 	}

diff --git a/iid/README.md b/iid/README.md
@@ -1,8 +1,7 @@
 # iid
-[![Documentation](https://godoc.org/github.com/c-robinson/iplib?status.svg)](http://godoc.org/github.com/c-robinson/iplib/iid)
-[![CircleCI](https://circleci.com/gh/c-robinson/iplib/tree/main.svg?style=svg)](https://circleci.com/gh/c-robinson/iplib/tree/main)
+[![Documentation](https://godoc.org/github.com/c-robinson/iplib?status.svg)](http://godoc.org/github.com/c-robinson/iplib/v2/iid)
 [![Go Report Card](https://goreportcard.com/badge/github.com/c-robinson/iplib)](https://goreportcard.com/report/github.com/c-robinson/iplib)
-[![Coverage Status](https://coveralls.io/repos/github/c-robinson/iplib/badge.svg?branch=main)](https://coveralls.io/github/c-robinson/iplib?branch=main)
+[![Tests](https://img.shields.io/github/actions/workflow/status/c-robinson/iplib/test.yml?branch=main&longCache=true&label=Test&logo=github%20actions&logoColor=fff)](https://github.com/c-robinson/iplib/actions?query=workflow%3ATest)
 
 This package implements functions for generating and validating IPv6 Interface
 Identifiers (IID's) for use in link-local, global unicast and Stateless Address
@@ -13,7 +12,7 @@ given interface on a network, and is unique _within_ that network.
 ## Installing
 
 ```sh
-go get -u github.com/c-robinson/iplib/v2/iid
+go get -u github.com/c-robinson/iplib/v2
 ```
 
 ## Using IID

diff --git a/iid/go.mod b/iid/go.mod
diff --git a/iid/go.sum b/iid/go.sum
diff --git a/iplib.go b/iplib.go
@@ -86,10 +86,7 @@ func (bi ByIP) Swap(a, b int) {
 // implementation, see CompareIPs()
 func (bi ByIP) Less(a, b int) bool {
 	val := CompareIPs(bi[a], bi[b])
-	if val == -1 {
-		return true
-	}
-	return false
+	return val == -1
 }
 
 // ARPAToIP takes a strings containing an ARPA domain and returns the
@@ -191,8 +188,7 @@ func CompareNets(a, b Net) int {
 // CopyIP creates a new net.IP object containing the same data as the supplied
 // net.IP (e.g. creates a new array and duplicates the contents)
 func CopyIP(ip net.IP) net.IP {
-	var xip []byte
-	xip = make([]byte, len(ip))
+	xip := make([]byte, len(ip))
 	copy(xip, ip)
 	return xip
 }
@@ -323,7 +319,7 @@ func ForceIP4(ip net.IP) net.IP {
 // or ':'
 func HexStringToIP(s string) net.IP {
 	normalize := func(c rune) rune {
-		if strings.IndexRune(":.", c) == -1 {
+		if !strings.ContainsRune(":.", c) {
 			return c
 		}
 		return -1
@@ -603,8 +599,3 @@ func generateNetLimits(version int, filler byte) net.IP {
 	}
 	return b
 }
-
-func getCloneBigInt(z *big.Int) *big.Int {
-	nz := new(big.Int)
-	return nz.Set(z)
-}
diff --git a/iplib_bench_test.go b/iplib_bench_test.go
@@ -9,13 +9,13 @@ import (
 
 func BenchmarkParseCIDR4(b *testing.B) {
 	for i := 0; i < b.N; i++ {
-		ParseCIDR("10.0.0.0/24")
+		_, _, _ = ParseCIDR("10.0.0.0/24")
 	}
 }
 
 func BenchmarkParseCIDR6(b *testing.B) {
 	for i := 0; i < b.N; i++ {
-		ParseCIDR("2001:db8::/98")
+		_, _, _ = ParseCIDR("2001:db8::/98")
 	}
 }
 
@@ -271,3 +271,12 @@ func BenchmarkNet6_NextIPWithinHostmask(b *testing.B) {
 		xip, _ = NextIP6WithinHostmask(xip, hm)
 	}
 }
+
+func BenchmarkNet6_Enumerate(b *testing.B) {
+	_, n, _ := ParseCIDR("2001:db8::/98")
+	n6 := n.(Net6)
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		n6.Enumerate(8192, 1024)
+	}
+}
diff --git a/net.go b/net.go
@@ -69,10 +69,7 @@ func (bn ByNet) Swap(a, b int) {
 // implementation, see CompareNets()
 func (bn ByNet) Less(a, b int) bool {
 	val := CompareNets(bn[a], bn[b])
-	if val == -1 {
-		return true
-	}
-	return false
+	return val == -1
 }
 
 // ParseCIDR returns a new Net object. It is a passthrough to net.ParseCIDR
@@ -111,5 +108,5 @@ func fitNetworkBetween(a, b net.IP, mask int) (Net, bool, error) {
 	if va == 0 && vb == 0 {
 		return xnet, true, nil
 	}
-	return fitNetworkBetween(a, b, mask + 1)
-}
+	return fitNetworkBetween(a, b, mask+1)
+}
diff --git a/net4_test.go b/net4_test.go
@@ -243,6 +243,11 @@ func TestNet4_Enumerate(t *testing.T) {
 		if x != 0 {
 			t.Errorf("[%d] want last address %s, got %s", i, tt.last, addrlist[tt.total-1])
 		}
+		for ii, a := range addrlist {
+			if a == nil {
+				t.Errorf("[%d] address %d is nil", i, ii)
+			}
+		}
 	}
 }