Merge pull request #1129 from oauth2-proxy/redirect-test-ginkgo

Rewrite OpenRedirect tests in ginkgo

CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ## Changes since v7.1.1
 
+- [#1129](https://github.com/oauth2-proxy/oauth2-proxy/pull/1129) Rewrite OpenRedirect tests in ginkgo (@JoelSpeed)
+
 # V7.1.1
 
 ## Release Highlights

oauthproxy_test.go

@@ -27,6 +27,8 @@ import (
 	"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/upstream"
 	"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/validation"
 	"github.com/oauth2-proxy/oauth2-proxy/v7/providers"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -316,54 +318,47 @@ func TestIsValidRedirect(t *testing.T) {
 	}
 }
 
-func TestOpenRedirects(t *testing.T) {
+var _ = Describe("OpenRedirect Tests", func() {
-	opts := baseTestOptions()
+	var proxy *OAuthProxy
-	// Should match domains that are exactly foo.bar and any subdomain of bar.foo
-	opts.WhitelistDomains = []string{
-		"foo.bar",
-		".bar.foo",
-		"port.bar:8080",
-		".sub.port.bar:8080",
-		"anyport.bar:*",
-		".sub.anyport.bar:*",
-		"www.whitelisteddomain.tld",
-	}
-	err := validation.Validate(opts)
-	assert.NoError(t, err)
 
-	proxy, err := NewOAuthProxy(opts, func(string) bool { return true })
+	BeforeEach(func() {
-	if err != nil {
+		opts := baseTestOptions()
-		t.Fatal(err)
+		// Should match domains that are exactly foo.bar and any subdomain of bar.foo
-	}
+		opts.WhitelistDomains = []string{
+			"foo.bar",
+			".bar.foo",
+			"port.bar:8080",
+			".sub.port.bar:8080",
+			"anyport.bar:*",
+			".sub.anyport.bar:*",
+			"www.whitelisteddomain.tld",
+		}
+		Expect(validation.Validate(opts)).To(Succeed())
+
+		var err error
+		proxy, err = NewOAuthProxy(opts, func(string) bool { return true })
+		Expect(err).ToNot(HaveOccurred())
+	})
 
 	file, err := os.Open("./testdata/openredirects.txt")
-	if err != nil {
+	Expect(err).ToNot(HaveOccurred())
-		t.Fatal(err)
+	defer func() {
-	}
+		Expect(file.Close()).To(Succeed())
-	defer func(t *testing.T) {
+	}()
-		if err := file.Close(); err != nil {
-			t.Fatal(err)
-		}
-	}(t)
 
 	scanner := bufio.NewScanner(file)
 	for scanner.Scan() {
 		rd := scanner.Text()
-		t.Run(rd, func(t *testing.T) {
+		It(rd, func() {
 			rdUnescaped, err := url.QueryUnescape(rd)
-			if err != nil {
+			Expect(err).ToNot(HaveOccurred())
-				t.Fatal(err)
+
-			}
+			Expect(proxy.IsValidRedirect(rdUnescaped)).To(BeFalse(), "Expected redirect not to be valid")
-			if proxy.IsValidRedirect(rdUnescaped) {
-				t.Errorf("Expected %q to not be valid (unescaped: %q)", rd, rdUnescaped)
-			}
 		})
 	}
 
-	if err := scanner.Err(); err != nil {
+	Expect(scanner.Err()).ToNot(HaveOccurred())
-		t.Fatal(err)
+})
-	}
-}
 
 type TestProvider struct {
 	*providers.ProviderData