From 9de68367de48d6adb594499ddfe774fd12355d6b Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Fri, 12 May 2023 12:59:56 +0200 Subject: [PATCH] refactor: simplify assets testing --- gateway/assets/README.md | 18 ++-- gateway/assets/build/main.go | 12 ++- gateway/assets/dag-index.html | 102 +++++++++++------------ gateway/assets/directory-index.html | 122 ++++++++++++++-------------- gateway/assets/error.html | 58 ++++++------- gateway/assets/test/main.go | 81 +++++++++--------- 6 files changed, 194 insertions(+), 199 deletions(-) diff --git a/gateway/assets/README.md b/gateway/assets/README.md index 25d1a35e8..e73b8ce9c 100644 --- a/gateway/assets/README.md +++ b/gateway/assets/README.md @@ -1,6 +1,6 @@ # Required Assets for the Gateway -> DAG and Directory HTML for HTTP gateway +> DAG, Directory and Error HTML for HTTP gateway ## Updating @@ -11,17 +11,13 @@ When making updates to the templates, please note the following: ## Testing -1. Make sure you have [Go](https://golang.org/dl/) installed -2. Start the test server, which lives in its own directory: +1. Make sure you have [Go](https://golang.org/dl/) installed. +2. From the `assets/` directory, start the test server: `go run test/main.go`. -```bash -> cd test -> go run . -``` - -This will listen on [`localhost:3000`](http://localhost:3000/) and reload the template every time you refresh the page. Here you have two pages: +This will listen on [`localhost:3000`](http://localhost:3000/) and reload the template every time you refresh the page. Here you have three pages: - [`localhost:3000/dag`](http://localhost:3000/dag) for the DAG template preview; and -- [`localhost:3000/directory`](http://localhost:3000/directory) for the Directory template preview. +- [`localhost:3000/directory`](http://localhost:3000/directory) for the Directory template preview; and +- [`localhost:3000/error?code=500`](http://localhost:3000/error?status=500) for the Error template preview, you can replace `500` by a different status code. -If you get a "no such file or directory" error upon trying `go run .`, make sure you ran `go generate .` to generate the minified artifact that the test is looking for. +Please make sure you run `go generate .` to generate the minified artifact that the test server is looking for every time you make a change. diff --git a/gateway/assets/build/main.go b/gateway/assets/build/main.go index 123ceff10..6f7ad3cda 100644 --- a/gateway/assets/build/main.go +++ b/gateway/assets/build/main.go @@ -5,10 +5,16 @@ import ( "os" ) +var templates = []string{ + "directory-index.html", + "dag-index.html", + "error.html", +} + func main() { - buildTemplate("directory-index.html") - buildTemplate("dag-index.html") - buildTemplate("error.html") + for _, tpl := range templates { + buildTemplate(tpl) + } } func loadStyles() []byte { diff --git a/gateway/assets/dag-index.html b/gateway/assets/dag-index.html index fd78b3592..912bad938 100644 --- a/gateway/assets/dag-index.html +++ b/gateway/assets/dag-index.html @@ -1,64 +1,64 @@ - - - - - - - - - - - - - - - -{{ .Path }} - + + + + + + + + + + + + + + + + {{ .Path }} + -
- -
-
About IPFS
-
Install IPFS
-
About
-
Install
-
- - - -
+
+ +
+
About IPFS
+
Install IPFS
+
About
+
Install
+
+
-
-

CID: {{.CID}}
- Codec: {{.CodecName}} ({{.CodecHex}})

-
+
+

CID: {{.CID}}
+ Codec: {{.CodecName}} ({{.CodecHex}})

+
- - - - - - - -
-

Preview as JSON
(application/json)

-
-

Or download as: -

-

-
+ + + + + + + +
+

Preview as JSON
(application/json)

+
+

Or download as: +

+

+
diff --git a/gateway/assets/directory-index.html b/gateway/assets/directory-index.html index 34ba167fc..47e0b3ed4 100644 --- a/gateway/assets/directory-index.html +++ b/gateway/assets/directory-index.html @@ -2,39 +2,39 @@ {{ $root := . }} - - - - - - - - - - - - - - - -{{ .Path }} - + + + + + + + + + + + + + + + + {{ .Path }} + -
- -
-
About IPFS
-
Install IPFS
-
About
-
Install
-
- - - -
+
+ +
+
About IPFS
+
Install IPFS
+
About
+
Install
+
+
@@ -60,38 +60,38 @@ {{ end }}
- - {{ if .BackLink }} - - - - - - - {{ end }} - {{ range .Listing }} - - - - - - - {{ end }} -
-
 
- 		- .. -
-
 
- 		- {{ .Name }} - - {{ if .Hash }} - - {{ .ShortHash }} - - {{ end }} - {{ .Size }}
+ + {{ if .BackLink }} + + + + + + + {{ end }} + {{ range .Listing }} + + + + + + + {{ end }} +
+
 
+ 		+ .. +
+
 
+ 		+ {{ .Name }} + + {{ if .Hash }} + + {{ .ShortHash }} + + {{ end }} + {{ .Size }}
diff --git a/gateway/assets/error.html b/gateway/assets/error.html index 07913322c..c56afffc0 100644 --- a/gateway/assets/error.html +++ b/gateway/assets/error.html @@ -1,39 +1,39 @@ - - - - - - - - - - - - - - - -{{ .StatusCode }} {{ .StatusText }} - + + + + + + + + + + + + + + + + {{ .StatusCode }} {{ .StatusText }} + -
- -
-
About IPFS
-
Install IPFS
-
About
-
Install
-
- - - -
+
+ +
+
About IPFS
+
Install IPFS
+
About
+
Install
+
+
diff --git a/gateway/assets/test/main.go b/gateway/assets/test/main.go index d393c2a2d..517bc11e8 100644 --- a/gateway/assets/test/main.go +++ b/gateway/assets/test/main.go @@ -5,15 +5,12 @@ import ( "html/template" "net/http" "net/url" - "os" + "strconv" "github.com/ipfs/boxo/gateway/assets" ) const ( - directoryTemplateFile = "../directory-index.html" - dagTemplateFile = "../dag-index.html" - testPath = "/ipfs/QmFooBarQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7/a/b/c" ) @@ -67,60 +64,56 @@ var dagTestData = assets.DagTemplateData{ CodecHex: "0x129", } +var funcMap = template.FuncMap{ + "iconFromExt": func(name string) string { + return "ipfs-_blank" // place-holder + }, + "urlEscape": func(rawUrl string) string { + pathURL := url.URL{Path: rawUrl} + return pathURL.String() + }, +} + +func runTemplate(w http.ResponseWriter, filename string, data interface{}) { + tpl, err := template.New(filename).Funcs(funcMap).ParseFiles(filename) + if err != nil { + http.Error(w, fmt.Sprintf("failed to parse template file: %s", err), http.StatusInternalServerError) + return + } + err = tpl.Execute(w, data) + if err != nil { + http.Error(w, fmt.Sprintf("failed to execute template: %s", err), http.StatusInternalServerError) + return + } +} + func main() { mux := http.NewServeMux() mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { switch r.URL.Path { case "/dag": - dagTemplate, err := template.New("dag-index.html").ParseFiles(dagTemplateFile) - if err != nil { - http.Error(w, fmt.Sprintf("failed to parse template file: %s", err), http.StatusInternalServerError) - return - } - err = dagTemplate.Execute(w, &dagTestData) - if err != nil { - http.Error(w, fmt.Sprintf("failed to execute template: %s", err), http.StatusInternalServerError) - return - } + runTemplate(w, "dag-index.html", dagTestData) case "/directory": - directoryTemplate, err := template.New("directory-index.html").Funcs(template.FuncMap{ - "iconFromExt": func(name string) string { - return "ipfs-_blank" // place-holder - }, - "urlEscape": func(rawUrl string) string { - pathURL := url.URL{Path: rawUrl} - return pathURL.String() - }, - }).ParseFiles(directoryTemplateFile) - if err != nil { - http.Error(w, fmt.Sprintf("failed to parse template file: %s", err), http.StatusInternalServerError) - return - } - err = directoryTemplate.Execute(w, &directoryTestData) + runTemplate(w, "directory-index.html", directoryTestData) + case "/error": + statusCode, err := strconv.Atoi(r.URL.Query().Get("code")) if err != nil { - http.Error(w, fmt.Sprintf("failed to execute template: %s", err), http.StatusInternalServerError) - return + statusCode = 500 } + runTemplate(w, "error.html", &assets.ErrorTemplateData{ + Path: "/ipfs/baguqeerabn4wonmz6icnk7dfckuizcsf4e4igua2ohdboecku225xxmujepa", + StatusCode: statusCode, + StatusText: http.StatusText(statusCode), + Error: "this is just an example error", + }) case "/": - html := `

Test paths: DAG, Directory.` + html := `

Test paths: DAG, Directory, Error.` _, _ = w.Write([]byte(html)) default: http.Redirect(w, r, "/", http.StatusSeeOther) } }) - if _, err := os.Stat(directoryTemplateFile); err != nil { - wd, _ := os.Getwd() - fmt.Printf("could not open template file %q, relative to %q: %s\n", directoryTemplateFile, wd, err) - os.Exit(1) - } - - if _, err := os.Stat(dagTemplateFile); err != nil { - wd, _ := os.Getwd() - fmt.Printf("could not open template file %q, relative to %q: %s\n", dagTemplateFile, wd, err) - os.Exit(1) - } - - fmt.Printf("listening on localhost:3000\n") + fmt.Printf("listening on http://localhost:3000/\n") _ = http.ListenAndServe("localhost:3000", mux) }