Migrate static assets to embed.FS

.circleci/config.yml

@@ -5,25 +5,6 @@ orbs:
   go: circleci/go@1.6.0
 
 jobs:
-  bindata:
-    executor:
-      name: go/default
-      tag: '1.16'
-
-    steps:
-      - checkout
-      - run:
-          name: Install go-bindata
-          command: |
-            go get github.com/go-bindata/go-bindata/...
-      - run:
-          name: Generate bindata.go
-          command: go generate -x
-      - persist_to_workspace:
-          root: .
-          paths:
-            - "bindata.go"
-
   build:
     parameters:
       go_version:
@@ -41,8 +22,6 @@ jobs:
     steps:
       - checkout
       - go/mod-download-cached
-      - attach_workspace:
-          at: .
       - run:
           name: Install SQLite
           command: |
@@ -97,32 +76,22 @@ jobs:
 workflows:
   Branch builds:
     jobs:
-      - bindata:
-          filters: &filters-branch
-            branches:
-              ignore: master
       - build:
-          requires:
-            - bindata
           matrix:
             parameters:
-              go_version: ["1.15", "1.16"]
-          filters:
-            <<: *filters-branch
+              go_version: ["1.16"]
+          filters: &filters-branch
+            branches:
+              ignore: master
 
   Release:
     jobs:
-      - bindata:
+      - build:
           filters: &filters-release
             branches:
               ignore: /.*/
             tags:
               only: /^v.*/
-      - build:
-          requires:
-            - bindata
-          filters:
-            <<: *filters-release
       - hold:
           type: approval
           requires:

Makefile

@@ -1,27 +1,15 @@
-GOBINDATA = $(shell go env GOPATH)/bin/go-bindata
-
 .PHONY: all
 all: build
 
 .PHONY: build
-build: assets scan
+build: scan
 
 dirs    := $(shell go list -f '{{.Dir}}' ./...)
 gofiles := $(foreach dir,$(dirs),$(wildcard $(dir)/*.go))
 
 scan: $(gofiles)
 	go build
 
-.PHONY: assets
-assets: bindata.go
-
-bindata.go: $(GOBINDATA) views/*.html
-	go generate
-
-$(GOBINDATA):
-	go get github.com/go-bindata/go-bindata/...
-
-
 .PHONY: sample-data
 sample-data:
 	curl -s -H "Content-Type: application/json" \

README.md

@@ -7,7 +7,7 @@ Scan is a small web service for recording and displaying [Masscan](https://githu
 
 ## Building and Installation
 
-As of v0.8.1 Scan uses Go modules. Go 1.13 or newer is required to build.
+As of v0.8.1 Scan uses Go modules. Go 1.16 or newer is required to build.
 
 Precompiled binaries for Linux on x86-64 are available on the GitHub releases page.
 
@@ -25,14 +25,12 @@ Or macOS:
 brew install sqlite
 ```
 
-To generate the `scan` binary run:
+To build the `scan` binary run:
 
 ```
-make
+go build
 ```
 
-This will generate the `bindata.go` containing static assets and build the binary.
-
 ## Database
 
 Scan stores results in a SQLite database. The database is automatically created and maintained at startup.

admin.go

@@ -36,7 +36,7 @@ func (app *App) adminHandler(w http.ResponseWriter, r *http.Request) {
 			w.WriteHeader(http.StatusUnauthorized)
 			session.Save(r, w)
 		}
-		tmpl.ExecuteTemplate(w, "index", data)
+		app.tmpl.ExecuteTemplate(w, "index", data)
 		return
 	}
 	v := session.Values["user"]
@@ -88,7 +88,7 @@ func (app *App) adminHandler(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	tmpl.ExecuteTemplate(w, "admin", data)
+	app.tmpl.ExecuteTemplate(w, "admin", data)
 }
 
 var (

go.mod

@@ -1,6 +1,6 @@
 module github.com/jamesog/scan
 
-go 1.14
+go 1.16
 
 require (
 	cloud.google.com/go v0.57.0 // indirect

job.go

@@ -31,7 +31,7 @@ func (app *App) newJob(w http.ResponseWriter, r *http.Request) {
 		}
 		if _, ok := session.Values["user"]; !ok {
 			data := jobData{indexData: indexData{URI: r.RequestURI}}
-			tmpl.ExecuteTemplate(w, "job", data)
+			app.tmpl.ExecuteTemplate(w, "job", data)
 			return
 		}
 		v := session.Values["user"]
@@ -113,7 +113,7 @@ func (app *App) newJob(w http.ResponseWriter, r *http.Request) {
 		Jobs:  jobs,
 	}
 
-	tmpl.ExecuteTemplate(w, "job", data)
+	app.tmpl.ExecuteTemplate(w, "job", data)
 }
 
 // Handler for GET /jobs

job_test.go

@@ -53,7 +53,7 @@ func TestUpdateJob(t *testing.T) {
 func TestJobHandler(t *testing.T) {
 	db := createDB("TestJobHandler")
 	defer db.Close()
-	app := App{db: db}
+	app := setup(db)
 
 	r := httptest.NewRequest("GET", "/job", nil)
 	w := httptest.NewRecorder()
@@ -84,7 +84,7 @@ func TestJobHandler(t *testing.T) {
 func TestJobsHandler(t *testing.T) {
 	db := createDB("TestJobsHandler")
 	defer db.Close()
-	app := App{db: db}
+	app := setup(db)
 
 	r := httptest.NewRequest("GET", "/jobs", nil)
 	w := httptest.NewRecorder()
@@ -104,7 +104,7 @@ func TestJobsHandler(t *testing.T) {
 func TestJobResultsHandler(t *testing.T) {
 	db := createDB("TestJobResultsHandler")
 	defer db.Close()
-	app := App{db: db}
+	app := setup(db)
 
 	data := bytes.NewBuffer([]byte(`[{"ip":"192.0.2.1","ports":[{"port":80,"proto":"tcp","status":"open","reason":"syn-ack","ttl":57}]}]`))
 

scan.go

@@ -2,9 +2,9 @@
 package main
 
 import (
-	"bytes"
 	"crypto/tls"
 	"database/sql"
+	"embed"
 	"encoding/json"
 	"errors"
 	"flag"
@@ -13,7 +13,6 @@ import (
 	"io"
 	"io/ioutil"
 	"log"
-	"mime"
 	"net"
 	"net/http"
 	"os"
@@ -38,9 +37,13 @@ var (
 	dataDir      string
 	httpsAddr    string
 	verbose      bool
+)
 
-	// HTML templates
-	tmpl *template.Template
+var (
+	//go:embed views/*
+	views embed.FS
+	//go:embed static
+	static embed.FS
 )
 
 type storage interface {
@@ -76,7 +79,8 @@ type indexData struct {
 }
 
 type App struct {
-	db storage
+	db   storage
+	tmpl *template.Template
 }
 
 // Handler for GET /
@@ -95,7 +99,7 @@ func (app *App) index(w http.ResponseWriter, r *http.Request) {
 				w.WriteHeader(http.StatusUnauthorized)
 				session.Save(r, w)
 			}
-			tmpl.ExecuteTemplate(w, "index", data)
+			app.tmpl.ExecuteTemplate(w, "index.html", data)
 			return
 		}
 		v := session.Values["user"]
@@ -133,7 +137,7 @@ func (app *App) index(w http.ResponseWriter, r *http.Request) {
 		Submission:    sub,
 		Data:          results,
 	}
-	tmpl.ExecuteTemplate(w, "index", data)
+	app.tmpl.ExecuteTemplate(w, "index", data)
 }
 
 func (app *App) saveResults(w http.ResponseWriter, r *http.Request, now time.Time) (int64, error) {
@@ -258,43 +262,6 @@ func redirectHTTPS(next http.Handler) http.Handler {
 	})
 }
 
-type assetMap map[string]asset
-
-var assets assetMap
-
-// loadAssetsFromDir gets all assets whose parent directory is "name" and
-// returns a map of the asset path to the asset function.
-func loadAssetsFromDir(name string) assetMap {
-	assets = make(assetMap)
-	for b := range _bindata {
-		if strings.HasPrefix(b, name+"/") {
-			a, err := _bindata[b]()
-			if err != nil {
-				log.Printf("Failed to load asset %s: %v", b, err)
-			}
-			assets[b] = *a
-		}
-	}
-	return assets
-}
-
-// staticHandler returns a static asset from the map generated by
-// loadAssetsFromDir.
-func staticHandler(w http.ResponseWriter, r *http.Request) {
-	path := strings.TrimPrefix(r.URL.Path, "/")
-	if a, ok := assets[path]; ok {
-		ct := mime.TypeByExtension(filepath.Ext(a.info.Name()))
-		if ct == "" {
-			ct = http.DetectContentType(a.bytes)
-		}
-		w.Header().Set("Content-Type", ct)
-		b := bytes.NewReader(a.bytes)
-		http.ServeContent(w, r, a.info.Name(), a.info.ModTime(), b)
-	}
-
-	http.NotFound(w, r)
-}
-
 func (app *App) setupRouter(middlewares ...func(http.Handler) http.Handler) *chi.Mux {
 	r := chi.NewRouter()
 	r.Use(middleware.RealIP)
@@ -303,8 +270,6 @@ func (app *App) setupRouter(middlewares ...func(http.Handler) http.Handler) *chi
 		r.Use(mw)
 	}
 
-	assets = loadAssetsFromDir("static")
-
 	r.Get("/", app.index)
 	r.Route("/admin", func(r chi.Router) {
 		r.Get("/", app.adminHandler)
@@ -320,36 +285,23 @@ func (app *App) setupRouter(middlewares ...func(http.Handler) http.Handler) *chi
 	r.Get("/logout", app.logoutHandler)
 	r.Post("/results", app.recvResults)
 	r.Put("/results/{id}", app.recvJobResults)
-	r.Get("/static/*", staticHandler)
+	r.Method(http.MethodGet, "/static/*", http.FileServer(http.FS(static)))
 	r.Post("/traceroute", app.recvTraceroute)
 	r.Get("/traceroute/{ip}", app.traceroute)
 
 	return r
 }
 
-func setupTemplates() {
+func (app *App) setupTemplates() {
 	funcMap := template.FuncMap{
 		"join": func(sep string, s []string) string {
 			return strings.Join(s, sep)
 		},
 	}
 
-	tmpl = template.New("").Funcs(funcMap)
-
-	views, err := AssetDir("views")
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	for _, file := range views {
-		b, err := Asset("views/" + file)
-		if err != nil {
-			log.Println(err)
-			continue
-		}
-		t := tmpl.New(filepath.Base(file))
-		template.Must(t.Parse(string(b)))
-	}
+	app.tmpl = template.Must(
+		template.New("").Funcs(funcMap).ParseFS(views, "views/*.html"),
+	)
 }
 
 func main() {
@@ -389,8 +341,6 @@ func main() {
 	}
 	app := &App{db: db}
 
-	setupTemplates()
-
 	var middlewares []func(http.Handler) http.Handler
 
 	if authDisabled {
@@ -410,6 +360,7 @@ func main() {
 	}
 
 	r := app.setupRouter(middlewares...)
+	app.setupTemplates()
 
 	// Common http.Server timeout values
 	readTimeout := 5 * time.Second