remove packr in favor of embed (#761)

Author: vitorvezani

.gitignore

@@ -1,9 +1,7 @@
 goldilocks
 cover*
 goreleaser.deb
-*-packr.go
 dist
-packrd
 coverage.txt
 *.out
 debug

.goreleaser.yml

@@ -1,8 +1,6 @@
 before:
   hooks:
     - go mod tidy
-    - go install github.com/gobuffalo/packr/v2/packr2@latest
-    - packr2
 builds:
   - id: goldilocks
     ldflags:

Makefile

@@ -24,7 +24,6 @@ clean:
 	$(GOCLEAN)
 	$(GOCMD) fmt ./...
 	rm -f $(BINARY_NAME)
-	packr2 clean
 	rm -rf e2e/results/*
 	rm *-report*
 	rm coverage.txt

go.mod

@@ -5,7 +5,6 @@ go 1.22.7
 require (
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc
 	github.com/fairwindsops/controller-utils v0.3.4
-	github.com/gobuffalo/packr/v2 v2.8.3
 	github.com/google/uuid v1.6.0
 	github.com/gorilla/mux v1.8.1
 	github.com/samber/lo v1.47.0
@@ -28,8 +27,6 @@ require (
 	github.com/go-openapi/jsonpointer v0.19.6 // indirect
 	github.com/go-openapi/jsonreference v0.20.2 // indirect
 	github.com/go-openapi/swag v0.22.4 // indirect
-	github.com/gobuffalo/logger v1.0.6 // indirect
-	github.com/gobuffalo/packd v1.0.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/gnostic-models v0.6.8 // indirect
@@ -39,19 +36,13 @@ require (
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/karrick/godirwalk v1.16.1 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
-	github.com/markbates/errx v1.1.0 // indirect
-	github.com/markbates/oncer v1.0.0 // indirect
-	github.com/markbates/safe v1.0.1 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
-	github.com/sirupsen/logrus v1.8.1 // indirect
 	github.com/x448/float16 v0.8.4 // indirect
-	golang.org/x/crypto v0.31.0 // indirect
 	golang.org/x/net v0.33.0 // indirect
 	golang.org/x/oauth2 v0.21.0 // indirect
 	golang.org/x/sys v0.28.0 // indirect

go.sum

@@ -1,26 +1,19 @@
 package dashboard
 
 import (
+	"embed"
 	"net/http"
 
-	"github.com/gobuffalo/packr/v2"
 	"k8s.io/klog/v2"
 )
 
-var assetBox = (*packr.Box)(nil)
-
-// getAssetBox returns a binary-friendly set of assets packaged from disk
-func getAssetBox() *packr.Box {
-	if assetBox == (*packr.Box)(nil) {
-		assetBox = packr.New("Assets", "assets")
-	}
-	return assetBox
-}
+//go:embed all:assets
+var assetsFS embed.FS
 
 // Asset replies with the contents of the loaded asset from disk
 func Asset(assetPath string) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		asset, err := getAssetBox().Find(assetPath)
+		asset, err := assetsFS.ReadFile(assetPath)
 		if err != nil {
 			klog.Errorf("Error getting asset: %v", err)
 			http.Error(w, "Error getting asset", http.StatusInternalServerError)
@@ -32,9 +25,3 @@ func Asset(assetPath string) http.Handler {
 		}
 	})
 }
-
-// StaticAssets replies with a FileServer for all assets, the prefix is used to strip the URL path
-func StaticAssets(prefix string) http.Handler {
-	klog.V(3).Infof("stripping prefix: %s", prefix)
-	return http.StripPrefix(prefix, http.FileServer(getAssetBox()))
-}

pkg/dashboard/assets.go

@@ -15,35 +15,15 @@
 package dashboard
 
 import (
+	"io/fs"
 	"net/http"
 	"path"
 	"strings"
 
-	"k8s.io/klog/v2"
-
-	packr "github.com/gobuffalo/packr/v2"
 	"github.com/gorilla/mux"
+	"k8s.io/klog/v2"
 )
 
-var (
-	markdownBox = (*packr.Box)(nil)
-)
-
-// GetMarkdownBox returns a binary-friendly set of markdown files with error details
-func GetMarkdownBox() *packr.Box {
-	if markdownBox == (*packr.Box)(nil) {
-		markdownBox = packr.New("Markdown", "../../docs")
-	}
-	return markdownBox
-}
-
-func GetAssetBox() *packr.Box {
-	if assetBox == (*packr.Box)(nil) {
-		assetBox = packr.New("Assets", "assets")
-	}
-	return assetBox
-}
-
 // GetRouter returns a mux router serving all routes necessary for the dashboard
 func GetRouter(setters ...Option) *mux.Router {
 	opts := defaultOptions()
@@ -58,8 +38,18 @@ func GetRouter(setters ...Option) *mux.Router {
 	router.Handle("/healthz", Healthz())
 
 	// assets
-	router.Handle("/favicon.ico", Asset("/images/favicon-32x32.png"))
-	fileServer := http.FileServer(GetAssetBox())
+	router.Handle("/favicon.ico", Asset("assets/images/favicon-32x32.png"))
+
+	subAssetsFS, err := fs.Sub(assetsFS, "assets")
+	if err != nil {
+		klog.Fatalf("error creating sub filesystem for assets: %v", err)
+	}
+
+	if subAssetsFS == nil {
+		klog.Fatal("subAssetsFS is nil, this should not happen")
+	}
+
+	fileServer := http.FileServerFS(subAssetsFS)
 	router.PathPrefix("/static/").Handler(http.StripPrefix(path.Join(opts.BasePath, "/static/"), fileServer))
 
 	// dashboard

pkg/dashboard/router.go

@@ -2,19 +2,17 @@ package dashboard
 
 import (
 	"bytes"
+	"embed"
 	"encoding/json"
 	"fmt"
 	"html/template"
 	"net/http"
 	"strings"
 
 	"github.com/fairwindsops/goldilocks/pkg/dashboard/helpers"
-	"github.com/gobuffalo/packr/v2"
 	"k8s.io/klog/v2"
 )
 
-var templateBox = (*packr.Box)(nil)
-
 // templates
 const (
 	ContainerTemplateName   = "container.gohtml"
@@ -50,13 +48,8 @@ type baseTemplateData struct {
 	JSON template.JS
 }
 
-// getTemplateBox returns a binary-friendly set of templates for rendering the dash
-func getTemplateBox() *packr.Box {
-	if templateBox == (*packr.Box)(nil) {
-		templateBox = packr.New("Templates", "templates")
-	}
-	return templateBox
-}
+//go:embed all:templates
+var templatedFS embed.FS
 
 // getTemplate puts together a template. Individual pieces can be overridden before rendering.
 func getTemplate(name string, opts Options, includedTemplates ...string) (*template.Template, error) {
@@ -83,9 +76,8 @@ func getTemplate(name string, opts Options, includedTemplates ...string) (*templ
 
 // parseTemplateFiles combines the template with the included templates into one parsed template
 func parseTemplateFiles(tmpl *template.Template, includedTemplates []string) (*template.Template, error) {
-	templateBox := getTemplateBox()
 	for _, fname := range includedTemplates {
-		templateFile, err := templateBox.Find(fmt.Sprintf("%s.gohtml", fname))
+		templateFile, err := templatedFS.ReadFile(fmt.Sprintf("templates/%s.gohtml", fname))
 		if err != nil {
 			return nil, err
 		}