overhaul jwt v2 and v1 inter-tangling (#195)

Move all the top-level go code into v2/v1compat and explicitly refer to that, and with all other go.??? files removed, so that from the go module handling perspective, this is all in one Go module. This will prevent v1 code references from going out to Go modules and fetching old vulnerable code. We would use v2/internal/v1compat but we want this compatibility code to be visible to tests in other software, such as nats-io/nats-account-server too. This PR changes modules, imports, and CI test invocations, but makes no changes to the Go functionality of the library.
nats-io · Mar 16, 2023 · e3e39d6 · e3e39d6
1 parent 8d1c62f
commit e3e39d6
Show file tree

Hide file tree

Showing 39 changed files with 28 additions and 69 deletions.
diff --git a/.github/workflows/go-test.yaml b/.github/workflows/go-test.yaml
@@ -40,6 +40,7 @@ jobs:
       - name: Lint
         shell: bash --noprofile --norc -x -eo pipefail {0}
         run: |
+          cd v2
           GO_LIST=$(go list ./...)
           go build
           $(exit $(go fmt $GO_LIST | wc -l))
@@ -54,27 +55,31 @@ jobs:
         run: |
           set -e
           mkdir -p cov
-          go get -t ./...
-          go test -v -race -covermode=atomic -coverprofile=./cov/v1.out -coverpkg=github.com/nats-io/jwt .
           cd v2
-          go test -modfile=go_test.mod -v -race -covermode=atomic -coverprofile=../cov/v2.out -coverpkg=github.com/nats-io/jwt/v2 .
-          cd ..
-          gocovmerge ./cov/*.out > coverage.out
+          go get -t ./...
+          go test -v -race -covermode=atomic -coverprofile=../cov/v2.out -coverpkg=github.com/nats-io/jwt/v2 .
+          cd v1compat
+          go test -v -race -covermode=atomic -coverprofile=../../cov/v1.out -coverpkg=github.com/nats-io/jwt/v2/v1compat .
+          cd ../..
+          gocovmerge ./cov/*.out > ./coverage.out
           set +e
         if: matrix.canonical
 
       - name: Tests (Windows)
         shell: bash --noprofile --norc -x -eo pipefail {0}
         run: |
           set -e
+          cd v2
           go get -t ./...
           go test -v -race .
-          go test -modfile=v2/go_test.mod -v -race .
           set +e
         if: runner.os == 'Windows'
 
       - name: Coverage
         uses: shogo82148/actions-goveralls@v1
         with:
-          path-to-profile: coverage.out
+          # this needs to be where it can find a go.mod
+          working-directory: ./v2
+          # this path-to-profile is relative to the working-directory
+          path-to-profile: ../coverage.out
         if: matrix.canonical
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
diff --git a/v2/go.mod b/v2/go.mod
@@ -2,11 +2,9 @@ module github.com/nats-io/jwt/v2
 
 go 1.18
 
-require (
-	github.com/nats-io/nkeys v0.3.1-0.20221205184623-5d8a6730c42c
-)
+require github.com/nats-io/nkeys v0.4.4
 
 require (
-	golang.org/x/crypto v0.6.0 // indirect
-	golang.org/x/sys v0.5.0 // indirect
+	golang.org/x/crypto v0.7.0 // indirect
+	golang.org/x/sys v0.6.0 // indirect
 )
diff --git a/v2/go.sum b/v2/go.sum
@@ -1,6 +1,6 @@
-github.com/nats-io/nkeys v0.3.1-0.20221205184623-5d8a6730c42c h1:3/I6jrE5AT258Nl8IZCu/9oGIfIsV/GL8aKQR8+Lpq4=
-github.com/nats-io/nkeys v0.3.1-0.20221205184623-5d8a6730c42c/go.mod h1:JOEZlxMfMnmaLwr+mpmP+RGIYSxLNBFsZykCGaI2PvA=
-golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
-golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58=
-golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU=
-golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+github.com/nats-io/nkeys v0.4.4 h1:xvBJ8d69TznjcQl9t6//Q5xXuVhyYiSos6RPtvQNTwA=
+github.com/nats-io/nkeys v0.4.4/go.mod h1:XUkxdLPTufzlihbamfzQ7mw/VGx6ObUs+0bN5sNvt64=
+golang.org/x/crypto v0.7.0 h1:AvwMYaRytfdeVt3u6mLaxYtErKYjxA2OXjJ1HHq6t3A=
+golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU=
+golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
diff --git a/v2/go_test.mod b/v2/go_test.mod
diff --git a/v2/go_test.sum b/v2/go_test.sum
diff --git a/v2/test/decoder_migration_test.go b/v2/test/decoder_migration_test.go
@@ -20,9 +20,10 @@ import (
 	"testing"
 	"time"
 
-	v1jwt "github.com/nats-io/jwt"
-	. "github.com/nats-io/jwt/v2"
 	"github.com/nats-io/nkeys"
+
+	. "github.com/nats-io/jwt/v2"
+	v1jwt "github.com/nats-io/jwt/v2/v1compat"
 )
 
 func createExport(sub string) *v1jwt.Export {

diff --git a/v2/test/genericclaims_test.go b/v2/test/genericclaims_test.go
@@ -19,8 +19,8 @@ import (
 	"testing"
 	"time"
 
-	jwtv1 "github.com/nats-io/jwt"
 	. "github.com/nats-io/jwt/v2"
+	jwtv1 "github.com/nats-io/jwt/v2/v1compat"
 )
 
 func TestNewGenericClaims(t *testing.T) {

diff --git a/v2/test/util_test.go b/v2/test/util_test.go
@@ -22,8 +22,9 @@ import (
 	"strings"
 	"testing"
 
-	. "github.com/nats-io/jwt/v2"
 	"github.com/nats-io/nkeys"
+
+	. "github.com/nats-io/jwt/v2"
 )
 
 func Trace(message string) string {

diff --git a/Makefile → v2/v1compat/Makefile b/Makefile → v2/v1compat/Makefile
@@ -4,7 +4,7 @@ build:
 	go build
 
 test:
-	./scripts/test.sh
+	../../../scripts/test.sh
 
 fmt:
 	gofmt -w -s *.go

diff --git a/account_claims.go → v2/v1compat/account_claims.go b/account_claims.go → v2/v1compat/account_claims.go
diff --git a/account_claims_test.go → v2/v1compat/account_claims_test.go b/account_claims_test.go → v2/v1compat/account_claims_test.go
diff --git a/activation_claims.go → v2/v1compat/activation_claims.go b/activation_claims.go → v2/v1compat/activation_claims.go
diff --git a/activation_claims_test.go → v2/v1compat/activation_claims_test.go b/activation_claims_test.go → v2/v1compat/activation_claims_test.go
diff --git a/claims.go → v2/v1compat/claims.go b/claims.go → v2/v1compat/claims.go
diff --git a/cluster_claims.go → v2/v1compat/cluster_claims.go b/cluster_claims.go → v2/v1compat/cluster_claims.go
diff --git a/cluster_claims_test.go → v2/v1compat/cluster_claims_test.go b/cluster_claims_test.go → v2/v1compat/cluster_claims_test.go
diff --git a/creds_utils.go → v2/v1compat/creds_utils.go b/creds_utils.go → v2/v1compat/creds_utils.go
diff --git a/creds_utils_test.go → v2/v1compat/creds_utils_test.go b/creds_utils_test.go → v2/v1compat/creds_utils_test.go
diff --git a/decoder_test.go → v2/v1compat/decoder_test.go b/decoder_test.go → v2/v1compat/decoder_test.go
diff --git a/exports.go → v2/v1compat/exports.go b/exports.go → v2/v1compat/exports.go
diff --git a/exports_test.go → v2/v1compat/exports_test.go b/exports_test.go → v2/v1compat/exports_test.go
diff --git a/genericclaims_test.go → v2/v1compat/genericclaims_test.go b/genericclaims_test.go → v2/v1compat/genericclaims_test.go
diff --git a/genericlaims.go → v2/v1compat/genericlaims.go b/genericlaims.go → v2/v1compat/genericlaims.go
diff --git a/header.go → v2/v1compat/header.go b/header.go → v2/v1compat/header.go
diff --git a/imports.go → v2/v1compat/imports.go b/imports.go → v2/v1compat/imports.go
diff --git a/imports_test.go → v2/v1compat/imports_test.go b/imports_test.go → v2/v1compat/imports_test.go
diff --git a/operator_claims.go → v2/v1compat/operator_claims.go b/operator_claims.go → v2/v1compat/operator_claims.go
diff --git a/operator_claims_test.go → v2/v1compat/operator_claims_test.go b/operator_claims_test.go → v2/v1compat/operator_claims_test.go
diff --git a/revocation_list.go → v2/v1compat/revocation_list.go b/revocation_list.go → v2/v1compat/revocation_list.go
diff --git a/server_claims.go → v2/v1compat/server_claims.go b/server_claims.go → v2/v1compat/server_claims.go
diff --git a/server_claims_test.go → v2/v1compat/server_claims_test.go b/server_claims_test.go → v2/v1compat/server_claims_test.go
diff --git a/types.go → v2/v1compat/types.go b/types.go → v2/v1compat/types.go
diff --git a/types_test.go → v2/v1compat/types_test.go b/types_test.go → v2/v1compat/types_test.go
diff --git a/user_claims.go → v2/v1compat/user_claims.go b/user_claims.go → v2/v1compat/user_claims.go
diff --git a/user_claims_test.go → v2/v1compat/user_claims_test.go b/user_claims_test.go → v2/v1compat/user_claims_test.go
diff --git a/util_test.go → v2/v1compat/util_test.go b/util_test.go → v2/v1compat/util_test.go
diff --git a/validation.go → v2/v1compat/validation.go b/validation.go → v2/v1compat/validation.go