8f7209b · typeable/oauth2-proxy

git.iko.soy/typeable/oauth2-proxy

pkg/http: Fix leaking goroutines in tests

By using the context created by the test, the goroutines produced in http.Client is actually closed when cancelled and such, not leaked. Signed-off-by: Josef Johansson <josef86@gmail.com>

commit8f7209ba1a836b7e26ecdf18f1d23b289447df28 authorJosef Johansson <josef86@gmail.com> dateSun 3 Mar 2024, 20:17 (3 years ago) parentbb6aba4

3 files changed+42−32

compare with master

unifiedsplit

CHANGELOG.md+2 pkg/http/http_suite_test.go+14−6 pkg/http/server_test.go+26−26

CHANGELOG.md+2

@@ -8,6 +8,8 @@

99## Changes since v7.6.0

1010

11+- [#2539](https://github.com/oauth2-proxy/oauth2-proxy/pull/2539) pkg/http: Fix leaky test (@isodude)

12+

1113# V7.6.0

1214

1315## Release Highlights

pkg/http/http_suite_test.go+14−6

@@ -2,6 +2,7 @@ package http

33import (

44 "bytes"

5+ "context"

56 "crypto/tls"

67 "crypto/x509"

78 "encoding/pem"

@@ -18,7 +19,7 @@ import (

1819var ipv4CertData, ipv6CertData []byte

1920var ipv4CertDataSource, ipv4KeyDataSource options.SecretSource

2021var ipv6CertDataSource, ipv6KeyDataSource options.SecretSource

21−var client *http.Client

22+var transport *http.Transport

2223

2324func TestHTTPSuite(t *testing.T) {

2425 logger.SetOutput(GinkgoWriter)

@@ -28,6 +29,17 @@ func TestHTTPSuite(t *testing.T) {

2829 RunSpecs(t, "HTTP")

2930}

3031

32+func httpGet(ctx context.Context, url string) (*http.Response, error) {

33+ c := &http.Client{

34+ Transport: transport.Clone(),

35+ }

36+ req, err := http.NewRequestWithContext(ctx, "GET", url, nil)

37+ if err != nil {

38+ return nil, err

39+ }

40+ return c.Do(req)

41+}

42+

3143var _ = BeforeSuite(func() {

3244 By("Generating a ipv4 self-signed cert for TLS tests", func() {

3345 certBytes, keyBytes, err := util.GenerateCert("127.0.0.1")

@@ -70,11 +82,7 @@ var _ = BeforeSuite(func() {

7082 certpool.AddCert(ipv4certificate)

7183 certpool.AddCert(ipv6certificate)

7284

73− transport := http.DefaultTransport.(*http.Transport).Clone()

85+ transport = http.DefaultTransport.(*http.Transport).Clone()

7486 transport.TLSClientConfig.RootCAs = certpool

75−

76− client = &http.Client{

77− Transport: transport,

78− }

7987 })

8088})

pkg/http/server_test.go+26−26

@@ -587,7 +587,7 @@ var _ = Describe("Server", func() {

587587 Expect(srv.Start(ctx)).To(Succeed())

588588 }()

589589

590− resp, err := client.Get(listenAddr)

590+ resp, err := httpGet(ctx, listenAddr)

591591 Expect(err).ToNot(HaveOccurred())

592592 Expect(resp.StatusCode).To(Equal(http.StatusOK))

593593

@@ -602,13 +602,13 @@ var _ = Describe("Server", func() {

602602 Expect(srv.Start(ctx)).To(Succeed())

603603 }()

604604

605− _, err := client.Get(listenAddr)

605+ _, err := httpGet(ctx, listenAddr)

606606 Expect(err).ToNot(HaveOccurred())

607607

608608 cancel()

609609

610610 Eventually(func() error {

611− _, err := client.Get(listenAddr)

611+ _, err := httpGet(ctx, listenAddr)

612612 return err

613613 }).Should(HaveOccurred())

614614 })

@@ -641,7 +641,7 @@ var _ = Describe("Server", func() {

641641 Expect(srv.Start(ctx)).To(Succeed())

642642 }()

643643

644− resp, err := client.Get(secureListenAddr)

644+ resp, err := httpGet(ctx, secureListenAddr)

645645 Expect(err).ToNot(HaveOccurred())

646646 Expect(resp.StatusCode).To(Equal(http.StatusOK))

647647

@@ -656,13 +656,13 @@ var _ = Describe("Server", func() {

656656 Expect(srv.Start(ctx)).To(Succeed())

657657 }()

658658

659− _, err := client.Get(secureListenAddr)

659+ _, err := httpGet(ctx, secureListenAddr)

660660 Expect(err).ToNot(HaveOccurred())

661661

662662 cancel()

663663

664664 Eventually(func() error {

665− _, err := client.Get(secureListenAddr)

665+ _, err := httpGet(ctx, secureListenAddr)

666666 return err

667667 }).Should(HaveOccurred())

668668 })

@@ -673,7 +673,7 @@ var _ = Describe("Server", func() {

673673 Expect(srv.Start(ctx)).To(Succeed())

674674 }()

675675

676− resp, err := client.Get(secureListenAddr)

676+ resp, err := httpGet(ctx, secureListenAddr)

677677 Expect(err).ToNot(HaveOccurred())

678678 Expect(resp.StatusCode).To(Equal(http.StatusOK))

679679

@@ -712,7 +712,7 @@ var _ = Describe("Server", func() {

712712 Expect(srv.Start(ctx)).To(Succeed())

713713 }()

714714

715− resp, err := client.Get(listenAddr)

715+ resp, err := httpGet(ctx, listenAddr)

716716 Expect(err).ToNot(HaveOccurred())

717717 Expect(resp.StatusCode).To(Equal(http.StatusOK))

718718

@@ -727,7 +727,7 @@ var _ = Describe("Server", func() {

727727 Expect(srv.Start(ctx)).To(Succeed())

728728 }()

729729

730− resp, err := client.Get(secureListenAddr)

730+ resp, err := httpGet(ctx, secureListenAddr)

731731 Expect(err).ToNot(HaveOccurred())

732732 Expect(resp.StatusCode).To(Equal(http.StatusOK))

733733

@@ -742,19 +742,19 @@ var _ = Describe("Server", func() {

742742 Expect(srv.Start(ctx)).To(Succeed())

743743 }()

744744

745− _, err := client.Get(listenAddr)

745+ _, err := httpGet(ctx, listenAddr)

746746 Expect(err).ToNot(HaveOccurred())

747− _, err = client.Get(secureListenAddr)

747+ _, err = httpGet(ctx, secureListenAddr)

748748 Expect(err).ToNot(HaveOccurred())

749749

750750 cancel()

751751

752752 Eventually(func() error {

753− _, err := client.Get(listenAddr)

753+ _, err := httpGet(ctx, listenAddr)

754754 return err

755755 }).Should(HaveOccurred())

756756 Eventually(func() error {

757− _, err := client.Get(secureListenAddr)

757+ _, err := httpGet(ctx, secureListenAddr)

758758 return err

759759 }).Should(HaveOccurred())

760760 })

@@ -784,7 +784,7 @@ var _ = Describe("Server", func() {

784784 Expect(srv.Start(ctx)).To(Succeed())

785785 }()

786786

787− resp, err := client.Get(listenAddr)

787+ resp, err := httpGet(ctx, listenAddr)

788788 Expect(err).ToNot(HaveOccurred())

789789 Expect(resp.StatusCode).To(Equal(http.StatusOK))

790790

@@ -799,13 +799,13 @@ var _ = Describe("Server", func() {

799799 Expect(srv.Start(ctx)).To(Succeed())

800800 }()

801801

802− _, err := client.Get(listenAddr)

802+ _, err := httpGet(ctx, listenAddr)

803803 Expect(err).ToNot(HaveOccurred())

804804

805805 cancel()

806806

807807 Eventually(func() error {

808− _, err := client.Get(listenAddr)

808+ _, err := httpGet(ctx, listenAddr)

809809 return err

810810 }).Should(HaveOccurred())

811811 })

@@ -839,7 +839,7 @@ var _ = Describe("Server", func() {

839839 Expect(srv.Start(ctx)).To(Succeed())

840840 }()

841841

842− resp, err := client.Get(secureListenAddr)

842+ resp, err := httpGet(ctx, secureListenAddr)

843843 Expect(err).ToNot(HaveOccurred())

844844 Expect(resp.StatusCode).To(Equal(http.StatusOK))

845845

@@ -854,13 +854,13 @@ var _ = Describe("Server", func() {

854854 Expect(srv.Start(ctx)).To(Succeed())

855855 }()

856856

857− _, err := client.Get(secureListenAddr)

857+ _, err := httpGet(ctx, secureListenAddr)

858858 Expect(err).ToNot(HaveOccurred())

859859

860860 cancel()

861861

862862 Eventually(func() error {

863− _, err := client.Get(secureListenAddr)

863+ _, err := httpGet(ctx, secureListenAddr)

864864 return err

865865 }).Should(HaveOccurred())

866866 })

@@ -871,7 +871,7 @@ var _ = Describe("Server", func() {

871871 Expect(srv.Start(ctx)).To(Succeed())

872872 }()

873873

874− resp, err := client.Get(secureListenAddr)

874+ resp, err := httpGet(ctx, secureListenAddr)

875875 Expect(err).ToNot(HaveOccurred())

876876 Expect(resp.StatusCode).To(Equal(http.StatusOK))

877877

@@ -911,7 +911,7 @@ var _ = Describe("Server", func() {

911911 Expect(srv.Start(ctx)).To(Succeed())

912912 }()

913913

914− resp, err := client.Get(listenAddr)

914+ resp, err := httpGet(ctx, listenAddr)

915915 Expect(err).ToNot(HaveOccurred())

916916 Expect(resp.StatusCode).To(Equal(http.StatusOK))

917917

@@ -926,7 +926,7 @@ var _ = Describe("Server", func() {

926926 Expect(srv.Start(ctx)).To(Succeed())

927927 }()

928928

929− resp, err := client.Get(secureListenAddr)

929+ resp, err := httpGet(ctx, secureListenAddr)

930930 Expect(err).ToNot(HaveOccurred())

931931 Expect(resp.StatusCode).To(Equal(http.StatusOK))

932932

@@ -941,19 +941,19 @@ var _ = Describe("Server", func() {

941941 Expect(srv.Start(ctx)).To(Succeed())

942942 }()

943943

944− _, err := client.Get(listenAddr)

944+ _, err := httpGet(ctx, listenAddr)

945945 Expect(err).ToNot(HaveOccurred())

946− _, err = client.Get(secureListenAddr)

946+ _, err = httpGet(ctx, secureListenAddr)

947947 Expect(err).ToNot(HaveOccurred())

948948

949949 cancel()

950950

951951 Eventually(func() error {

952− _, err := client.Get(listenAddr)

952+ _, err := httpGet(ctx, listenAddr)

953953 return err

954954 }).Should(HaveOccurred())

955955 Eventually(func() error {

956− _, err := client.Get(secureListenAddr)

956+ _, err := httpGet(ctx, secureListenAddr)

957957 return err

958958 }).Should(HaveOccurred())

959959 })