-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2834 from Stono/master
Added permanent-redirect-code
- Loading branch information
Showing
4 changed files
with
239 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /* | ||
| Copyright 2018 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package redirect | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "strconv" | ||
| "testing" | ||
|
|
||
| extensions "k8s.io/api/extensions/v1beta1" | ||
|
|
||
| "k8s.io/ingress-nginx/internal/ingress/annotations/parser" | ||
| "k8s.io/ingress-nginx/internal/ingress/resolver" | ||
| ) | ||
|
|
||
| const ( | ||
| defRedirectURL = "http://some-site.com" | ||
| ) | ||
|
|
||
| func TestPermanentRedirectWithDefaultCode(t *testing.T) { | ||
| rp := NewParser(resolver.Mock{}) | ||
| if rp == nil { | ||
| t.Fatalf("Expected a parser.IngressAnnotation but returned nil") | ||
| } | ||
|
|
||
| ing := new(extensions.Ingress) | ||
|
|
||
| data := make(map[string]string, 1) | ||
| data[parser.GetAnnotationWithPrefix("permanent-redirect")] = defRedirectURL | ||
| ing.SetAnnotations(data) | ||
|
|
||
| i, err := rp.Parse(ing) | ||
| if err != nil { | ||
| t.Errorf("Unexpected error with ingress: %v", err) | ||
| } | ||
| redirect, ok := i.(*Config) | ||
| if !ok { | ||
| t.Errorf("Expected a Redirect type") | ||
| } | ||
| if redirect.URL != defRedirectURL { | ||
| t.Errorf("Expected %v as redirect but returned %s", defRedirectURL, redirect.URL) | ||
| } | ||
| if redirect.Code != defaultPermanentRedirectCode { | ||
| t.Errorf("Expected %v as redirect to have a code %d but had %d", defRedirectURL, defaultPermanentRedirectCode, redirect.Code) | ||
| } | ||
| } | ||
|
|
||
| func TestPermanentRedirectWithCustomCode(t *testing.T) { | ||
| rp := NewParser(resolver.Mock{}) | ||
| if rp == nil { | ||
| t.Fatalf("Expected a parser.IngressAnnotation but returned nil") | ||
| } | ||
|
|
||
| testCases := map[string]struct { | ||
| input int | ||
| expectOutput int | ||
| }{ | ||
| "valid code": {http.StatusPermanentRedirect, http.StatusPermanentRedirect}, | ||
| "invalid code": {http.StatusTeapot, defaultPermanentRedirectCode}, | ||
| } | ||
|
|
||
| for n, tc := range testCases { | ||
| t.Run(n, func(t *testing.T) { | ||
| ing := new(extensions.Ingress) | ||
|
|
||
| data := make(map[string]string, 2) | ||
| data[parser.GetAnnotationWithPrefix("permanent-redirect")] = defRedirectURL | ||
| data[parser.GetAnnotationWithPrefix("permanent-redirect-code")] = strconv.Itoa(tc.input) | ||
| ing.SetAnnotations(data) | ||
|
|
||
| i, err := rp.Parse(ing) | ||
| if err != nil { | ||
| t.Errorf("Unexpected error with ingress: %v", err) | ||
| } | ||
| redirect, ok := i.(*Config) | ||
| if !ok { | ||
| t.Errorf("Expected a redirect Config type") | ||
| } | ||
| if redirect.URL != defRedirectURL { | ||
| t.Errorf("Expected %v as redirect but returned %s", defRedirectURL, redirect.URL) | ||
| } | ||
| if redirect.Code != tc.expectOutput { | ||
| t.Errorf("Expected %v as redirect to have a code %d but had %d", defRedirectURL, tc.expectOutput, redirect.Code) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| /* | ||
| Copyright 2018 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package annotations | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| . "github.com/onsi/ginkgo" | ||
| . "github.com/onsi/gomega" | ||
|
|
||
| "github.com/parnurzeal/gorequest" | ||
|
|
||
| "k8s.io/ingress-nginx/test/e2e/framework" | ||
| ) | ||
|
|
||
| func noRedirectPolicyFunc(gorequest.Request, []gorequest.Request) error { | ||
| return http.ErrUseLastResponse | ||
| } | ||
|
|
||
| var _ = framework.IngressNginxDescribe("Annotations - Redirect", func() { | ||
| f := framework.NewDefaultFramework("redirect") | ||
|
|
||
| BeforeEach(func() { | ||
| }) | ||
|
|
||
| AfterEach(func() { | ||
| }) | ||
|
|
||
| It("should respond with a standard redirect code", func() { | ||
| By("setting permanent-redirect annotation") | ||
|
|
||
| host := "redirect" | ||
| redirectPath := "/something" | ||
| redirectURL := "http://redirect.example.com" | ||
|
|
||
| annotations := map[string]string{"nginx.ingress.kubernetes.io/permanent-redirect": redirectURL} | ||
|
|
||
| ing := framework.NewSingleIngress(host, redirectPath, host, f.IngressController.Namespace, "http-svc", 80, &annotations) | ||
| _, err := f.EnsureIngress(ing) | ||
|
|
||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(ing).NotTo(BeNil()) | ||
|
|
||
| err = f.WaitForNginxServer(host, | ||
| func(server string) bool { | ||
| return strings.Contains(server, fmt.Sprintf("if ($uri ~* %s) {", redirectPath)) && | ||
| strings.Contains(server, fmt.Sprintf("return 301 %s;", redirectURL)) | ||
| }) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
|
|
||
| By("sending request to redirected URL path") | ||
|
|
||
| resp, body, errs := gorequest.New(). | ||
| Get(f.IngressController.HTTPURL+redirectPath). | ||
| Set("Host", host). | ||
| RedirectPolicy(noRedirectPolicyFunc). | ||
| End() | ||
|
|
||
| Expect(errs).To(BeNil()) | ||
| Expect(resp.StatusCode).Should(BeNumerically("==", http.StatusMovedPermanently)) | ||
| Expect(resp.Header.Get("Location")).Should(Equal(redirectURL)) | ||
| Expect(body).Should(ContainSubstring("nginx/")) | ||
| }) | ||
|
|
||
| It("should respond with a custom redirect code", func() { | ||
| By("setting permanent-redirect-code annotation") | ||
|
|
||
| host := "redirect" | ||
| redirectPath := "/something" | ||
| redirectURL := "http://redirect.example.com" | ||
| redirectCode := http.StatusFound | ||
|
|
||
| annotations := map[string]string{ | ||
| "nginx.ingress.kubernetes.io/permanent-redirect": redirectURL, | ||
| "nginx.ingress.kubernetes.io/permanent-redirect-code": strconv.Itoa(redirectCode), | ||
| } | ||
|
|
||
| ing := framework.NewSingleIngress(host, redirectPath, host, f.IngressController.Namespace, "http-svc", 80, &annotations) | ||
| _, err := f.EnsureIngress(ing) | ||
|
|
||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(ing).NotTo(BeNil()) | ||
|
|
||
| err = f.WaitForNginxServer(host, | ||
| func(server string) bool { | ||
| return strings.Contains(server, fmt.Sprintf("if ($uri ~* %s) {", redirectPath)) && | ||
| strings.Contains(server, fmt.Sprintf("return %d %s;", redirectCode, redirectURL)) | ||
| }) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
|
|
||
| By("sending request to redirected URL path") | ||
|
|
||
| resp, body, errs := gorequest.New(). | ||
| Get(f.IngressController.HTTPURL+redirectPath). | ||
| Set("Host", host). | ||
| RedirectPolicy(noRedirectPolicyFunc). | ||
| End() | ||
|
|
||
| Expect(errs).To(BeNil()) | ||
| Expect(resp.StatusCode).Should(BeNumerically("==", redirectCode)) | ||
| Expect(resp.Header.Get("Location")).Should(Equal(redirectURL)) | ||
| Expect(body).Should(ContainSubstring("nginx/")) | ||
| }) | ||
| }) |