-
-
Notifications
You must be signed in to change notification settings - Fork 280
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add unit test and benchmark to URL function
- Loading branch information
Showing
4 changed files
with
78 additions
and
20 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
0.2.648 | ||
0.2.655 |
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,20 @@ | ||
package templ | ||
|
||
import "strings" | ||
|
||
// FailedSanitizationURL is returned if a URL fails sanitization checks. | ||
const FailedSanitizationURL = SafeURL("about:invalid#TemplFailedSanitizationURL") | ||
|
||
// URL sanitizes the input string s and returns a SafeURL. | ||
func URL(s string) SafeURL { | ||
if i := strings.IndexRune(s, ':'); i >= 0 && !strings.ContainsRune(s[:i], '/') { | ||
protocol := s[:i] | ||
if !strings.EqualFold(protocol, "http") && !strings.EqualFold(protocol, "https") && !strings.EqualFold(protocol, "mailto") && !strings.EqualFold(protocol, "tel") && !strings.EqualFold(protocol, "ftp") && !strings.EqualFold(protocol, "ftps") { | ||
return FailedSanitizationURL | ||
} | ||
} | ||
return SafeURL(s) | ||
} | ||
|
||
// SafeURL is a URL that has been sanitized. | ||
type SafeURL string |
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,57 @@ | ||
package templ | ||
|
||
import ( | ||
"strings" | ||
"testing" | ||
) | ||
|
||
type urlTest struct { | ||
url string | ||
expectSanitized bool | ||
} | ||
|
||
var urlTests = []urlTest{ | ||
{"//example.com", false}, | ||
{"/", false}, | ||
{"/index", false}, | ||
{"http://example.com", false}, | ||
{"https://example.com", false}, | ||
{"mailto:test@example.com", false}, | ||
{"tel:+1234567890", false}, | ||
{"ftp://example.com", false}, | ||
{"ftps://example.com", false}, | ||
{"irc://example.com", true}, | ||
{"bitcoin://example.com", true}, | ||
} | ||
|
||
func testURL(t *testing.T, url string, expectSanitized bool) { | ||
u := URL(url) | ||
wasSanitized := u == FailedSanitizationURL | ||
if expectSanitized != wasSanitized { | ||
t.Errorf("expected sanitized=%v, got %v", expectSanitized, wasSanitized) | ||
} | ||
} | ||
|
||
func TestURL(t *testing.T) { | ||
for _, test := range urlTests { | ||
t.Run(test.url, func(t *testing.T) { | ||
testURL(t, test.url, test.expectSanitized) | ||
}) | ||
test.url = strings.ToUpper(test.url) | ||
t.Run(strings.ToUpper(test.url), func(t *testing.T) { | ||
testURL(t, test.url, test.expectSanitized) | ||
}) | ||
} | ||
} | ||
|
||
func BenchmarkURL(b *testing.B) { | ||
for i := 0; i < b.N; i++ { | ||
for _, test := range urlTests { | ||
u := URL(test.url) | ||
wasSanitized := u == FailedSanitizationURL | ||
if test.expectSanitized != wasSanitized { | ||
b.Errorf("expected sanitized=%v, got %v", test.expectSanitized, wasSanitized) | ||
} | ||
} | ||
} | ||
} |