refactor: replace go-bindata with native embed package

muicoder · muicoder · commit 3320999494c2 · 2025-07-30T13:29:02.000+08:00
Signed-off-by: muicoder &lt;muicoder@gmail.com&gt;
diff --git a/cmd/k3s/main.go b/cmd/k3s/main.go
@@ -250,7 +250,7 @@ func stageAndRun(dataDir, cmd string, args []string, calledAsInternal bool) erro
 // getAssetAndDir returns the name of the bindata asset, along with a directory path
 // derived from the data-dir and bindata asset name.
 func getAssetAndDir(dataDir string) (string, string) {
-	asset := data.AssetNames()[0]
+	asset := data.AssetNames(data.FS)[0]
 	dir := filepath.Join(dataDir, "data", strings.SplitN(filepath.Base(asset), ".", 2)[0])
 	return asset, dir
 }
@@ -291,7 +291,7 @@ func extract(dataDir string) (string, error) {
 
 	logrus.Infof("Preparing data dir %s", dir)
 
-	content, err := data.Asset(asset)
+	content, err := data.Asset(data.FS, asset)
 	if err != nil {
 		return "", err
 	}
diff --git a/go.mod b/go.mod
@@ -94,7 +94,6 @@ require (
 	github.com/erikdubbelboer/gspt v0.0.0-20190125194910-e68493906b83
 	github.com/flannel-io/flannel v0.27.0
 	github.com/fsnotify/fsnotify v1.7.0
-	github.com/go-bindata/go-bindata v3.1.2+incompatible
 	github.com/go-logr/logr v1.4.2
 	github.com/go-logr/stdr v1.2.3-0.20220714215716-96bad1d688c5
 	github.com/go-test/deep v1.0.7
diff --git a/go.sum b/go.sum
@@ -487,8 +487,6 @@ github.com/fxamacker/cbor/v2 v2.8.0/go.mod h1:vM4b+DJCtHn+zz7h3FFp/hDAI9WNWCsZj2
 github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/gliderlabs/ssh v0.1.1/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0=
-github.com/go-bindata/go-bindata v3.1.2+incompatible h1:5vjJMVhowQdPzjE1LdxyFF7YFTXg5IgGVW4gBr5IbvE=
-github.com/go-bindata/go-bindata v3.1.2+incompatible/go.mod h1:xK8Dsgwmeed+BBsSy2XTopBn/8uK2HWuGSnA11C3Joo=
 github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q=
 github.com/go-errors/errors v1.4.2 h1:J6MZopCL4uSllY1OfXM374weqZFFItUbrImctkmUxIA=
 github.com/go-errors/errors v1.4.2/go.mod h1:sIVyrIiJhuEF+Pj9Ebtd6P/rEYROXFi3BopGUQ5a5Og=
diff --git a/main.go b/main.go
@@ -1,7 +1,3 @@
-//go:generate go run pkg/codegen/main.go
-//go:generate go fmt pkg/deploy/zz_generated_bindata.go
-//go:generate go fmt pkg/static/zz_generated_bindata.go
-
 package main
 
 import (
diff --git a/pkg/codegen/main.go b/pkg/codegen/main.go
diff --git a/pkg/data/data.go b/pkg/data/data.go
@@ -1 +1,26 @@
 package data
+
+import (
+	"embed"
+	"io/fs"
+	"sort"
+)
+
+//go:embed embed/*
+var FS embed.FS
+
+func Asset(embedFS embed.FS, name string) ([]byte, error) {
+	return embedFS.ReadFile("embed/" + name)
+}
+
+func AssetNames(embedFS embed.FS) []string {
+	var assets []string
+	fs.WalkDir(embedFS, ".", func(path string, entry fs.DirEntry, err error) error {
+		if entry.Type().IsRegular() {
+			assets = append(assets, path[6:])
+		}
+		return nil
+	})
+	sort.Strings(assets)
+	return assets
+}
diff --git a/pkg/deploy/stage.go b/pkg/deploy/stage.go
@@ -1,20 +1,26 @@
 //go:build !no_stage
+// +build !no_stage
 
 package deploy
 
 import (
 	"bytes"
+	"embed"
 	"os"
 	"path/filepath"
 	"strings"
 
+	"github.com/k3s-io/k3s/pkg/util"
 	pkgerrors "github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
 
+//go:embed embed/*
+var embedFS embed.FS
+
 func Stage(dataDir string, templateVars map[string]string, skips map[string]bool) error {
 staging:
-	for _, name := range AssetNames() {
+	for _, name := range util.AssetNames(embedFS) {
 		nameNoExtension := strings.TrimSuffix(name, filepath.Ext(name))
 		if skips[name] || skips[nameNoExtension] {
 			continue staging
@@ -27,7 +33,7 @@ staging:
 			}
 		}
 
-		content, err := Asset(name)
+		content, err := util.Asset(embedFS, name)
 		if err != nil {
 			return err
 		}
diff --git a/pkg/deploy/zz_generated_bindata.go b/pkg/deploy/zz_generated_bindata.go
diff --git a/pkg/static/stage.go b/pkg/static/stage.go
@@ -1,18 +1,24 @@
 //go:build !no_stage
+// +build !no_stage
 
 package static
 
 import (
+	"embed"
 	"os"
 	"path/filepath"
 
+	"github.com/k3s-io/k3s/pkg/util"
 	pkgerrors "github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
 
+//go:embed embed/*
+var embedFS embed.FS
+
 func Stage(dataDir string) error {
-	for _, name := range AssetNames() {
-		content, err := Asset(name)
+	for _, name := range util.AssetNames(embedFS) {
+		content, err := util.Asset(embedFS, name)
 		if err != nil {
 			return err
 		}
diff --git a/pkg/static/zz_generated_bindata.go b/pkg/static/zz_generated_bindata.go
diff --git a/pkg/util/embedutil.go b/pkg/util/embedutil.go
@@ -0,0 +1,23 @@
+package util
+
+import (
+	"embed"
+	"io/fs"
+	"sort"
+)
+
+func Asset(embedFS embed.FS, name string) ([]byte, error) {
+	return embedFS.ReadFile("embed/" + name)
+}
+
+func AssetNames(embedFS embed.FS) []string {
+	var assets []string
+	fs.WalkDir(embedFS, ".", func(path string, entry fs.DirEntry, err error) error {
+		if entry.Type().IsRegular() {
+			assets = append(assets, path[6:])
+		}
+		return nil
+	})
+	sort.Strings(assets)
+	return assets
+}
diff --git a/scripts/build b/scripts/build
@@ -172,6 +172,10 @@ if [ ! -x ${INSTALLBIN}/cni${BINARY_POSTFIX} ]; then
 fi
 
 echo Building k3s
+embedFS=pkg/deploy/embed
+rm -rf $embedFS;cp -av manifests $embedFS
+embedFS=pkg/static/embed
+rm -rf $embedFS;cp -av build/static $embedFS
 CGO_CFLAGS="-DSQLITE_ENABLE_DBSTAT_VTAB=1 -DSQLITE_USE_ALLOCA=1" \
 CGO_ENABLED=1 "${GO}" build $BLDFLAGS -tags "$TAGS" -buildvcs=false -gcflags="all=${GCFLAGS}" -ldflags "$VERSIONFLAGS $LDFLAGS $STATIC" -o bin/k3s${BINARY_POSTFIX} ./cmd/server
 
diff --git a/scripts/package-cli b/scripts/package-cli
@@ -79,6 +79,8 @@ LDFLAGS="
 "
 TAGS="urfave_cli_no_docs"
 STATIC="-extldflags '-static'"
+embedFS=pkg/data/embed
+rm -rf $embedFS;cp -av build/data $embedFS
 CGO_ENABLED=0 "${GO}" build -tags "$TAGS" -buildvcs=false -ldflags "$LDFLAGS $STATIC" -o ${CMD_NAME} ./cmd/k3s
 
 stat ${CMD_NAME}

-Original file line number
+Diff line change
 	github.com/erikdubbelboer/gspt v0.0.0-20190125194910-e68493906b83
 	github.com/flannel-io/flannel v0.27.0
 	github.com/fsnotify/fsnotify v1.7.0
 -	github.com/go-bindata/go-bindata v3.1.2+incompatible
 	github.com/go-logr/logr v1.4.2
 	github.com/go-logr/stdr v1.2.3-0.20220714215716-96bad1d688c5
 	github.com/go-test/deep v1.0.7