fix: move the oci folder out of the stacker binary's way

This is done by organizing the code into pkg and internal directories. Files from cmd/ were also moved to cmd/stacker, according to the go guidelines. Fixes #296 Fixes #332 Signed-off-by: Ariel Miculas <[email protected]>
project-stacker · Dec 8, 2022 · 557d407 · 557d407
1 parent e937010
commit 557d407
Show file tree

Hide file tree

Showing 74 changed files with 98 additions and 98 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 *.swp
 *.stacker
-stacker
-stacker-dynamic
+/stacker
+/stacker-dynamic
 .build
 
 # IDEs

diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ BUILD_TAGS = exclude_graphdriver_btrfs exclude_graphdriver_devicemapper containe
 
 STACKER_OPTS=--oci-dir=.build/oci --roots-dir=.build/roots --stacker-dir=.build/stacker --storage-type=overlay
 
-build_stacker = go build -tags "$(BUILD_TAGS) $1" -ldflags "-X main.version=$(VERSION_FULL) -X main.lxc_version=$(LXC_VERSION) $2" -o $3 ./cmd
+build_stacker = go build -tags "$(BUILD_TAGS) $1" -ldflags "-X main.version=$(VERSION_FULL) -X main.lxc_version=$(LXC_VERSION) $2" -o $3 ./cmd/stacker
 
 STACKER_BUILD_BASE_IMAGE?=docker://alpine:edge
 LXC_CLONE_URL?=https://github.com/lxc/lxc
@@ -21,19 +21,19 @@ stacker: stacker-dynamic
 		--substitute LXC_CLONE_URL=$(LXC_CLONE_URL) \
 		--substitute LXC_BRANCH=$(LXC_BRANCH)
 
-stacker-static: $(GO_SRC) go.mod go.sum cmd/lxc-wrapper/lxc-wrapper
+stacker-static: $(GO_SRC) go.mod go.sum cmd/stacker/lxc-wrapper/lxc-wrapper
 	$(call build_stacker,static_build,-extldflags '-static',stacker)
 
 # TODO: because we clean lxc-wrapper in the nested build, this always rebuilds.
 # Could find a better way to do this.
-stacker-dynamic: $(GO_SRC) go.mod go.sum cmd/lxc-wrapper/lxc-wrapper
+stacker-dynamic: $(GO_SRC) go.mod go.sum cmd/stacker/lxc-wrapper/lxc-wrapper
 	$(call build_stacker,,,stacker-dynamic)
 
-cmd/lxc-wrapper/lxc-wrapper: cmd/lxc-wrapper/lxc-wrapper.c
-	make -C cmd/lxc-wrapper LDFLAGS=-static LDLIBS="$(shell pkg-config --static --libs lxc) -lpthread -ldl" lxc-wrapper
+cmd/stacker/lxc-wrapper/lxc-wrapper: cmd/stacker/lxc-wrapper/lxc-wrapper.c
+	make -C cmd/stacker/lxc-wrapper LDFLAGS=-static LDLIBS="$(shell pkg-config --static --libs lxc) -lpthread -ldl" lxc-wrapper
 
 .PHONY: lint
-lint: cmd/lxc-wrapper/lxc-wrapper $(GO_SRC)
+lint: cmd/stacker/lxc-wrapper/lxc-wrapper $(GO_SRC)
 	go mod tidy
 	go fmt ./... && ([ -z $(CI) ] || git diff --exit-code)
 	bash test/static-analysis.sh
@@ -60,4 +60,4 @@ vendorup:
 clean:
 	-unshare -Urm rm -rf stacker stacker-dynamic .build
 	-rm -r ./test/centos ./test/ubuntu
-	-make -C cmd/lxc-wrapper clean
+	-make -C cmd/stacker/lxc-wrapper clean
diff --git a/build.yaml b/build.yaml
@@ -86,5 +86,5 @@ build:
     export GOPATH=/stacker-tree/.build/gopath
     export LXC_VERSION=$(git -C /lxc rev-parse HEAD)
 
-    make -C /stacker-tree/cmd/lxc-wrapper clean
+    make -C /stacker-tree/cmd/stacker/lxc-wrapper clean
     make -C /stacker-tree stacker-static
diff --git a/cmd/build.go → cmd/stacker/build.go b/cmd/build.go → cmd/stacker/build.go
@@ -4,9 +4,9 @@ import (
 	"fmt"
 
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
-	"stackerbuild.io/stacker/squashfs"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/squashfs"
 )
 
 var buildCmd = cli.Command{

diff --git a/cmd/check.go → cmd/stacker/check.go b/cmd/check.go → cmd/stacker/check.go
@@ -8,7 +8,7 @@ import (
 	"github.com/pkg/errors"
 	"github.com/pkg/xattr"
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker/overlay"
+	"stackerbuild.io/stacker/internal/overlay"
 )
 
 var checkCmd = cli.Command{

diff --git a/cmd/chroot.go → cmd/stacker/chroot.go b/cmd/chroot.go → cmd/stacker/chroot.go
@@ -6,10 +6,10 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
-	"stackerbuild.io/stacker/container"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/container"
 )
 
 var chrootCmd = cli.Command{

diff --git a/cmd/clean.go → cmd/stacker/clean.go b/cmd/clean.go → cmd/stacker/clean.go
@@ -5,8 +5,8 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
-	"stackerbuild.io/stacker/log"
+	"stackerbuild.io/stacker/internal"
+	"stackerbuild.io/stacker/internal/log"
 )
 
 var cleanCmd = cli.Command{

diff --git a/cmd/gc.go → cmd/stacker/gc.go b/cmd/gc.go → cmd/stacker/gc.go
@@ -2,7 +2,7 @@ package main
 
 import (
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
+	"stackerbuild.io/stacker/internal"
 )
 
 var gcCmd = cli.Command{

diff --git a/cmd/grab.go → cmd/stacker/grab.go b/cmd/grab.go → cmd/stacker/grab.go
@@ -6,7 +6,7 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
+	"stackerbuild.io/stacker/internal"
 )
 
 var grabCmd = cli.Command{

diff --git a/cmd/inspect.go → cmd/stacker/inspect.go b/cmd/inspect.go → cmd/stacker/inspect.go
@@ -11,7 +11,7 @@ import (
 	"github.com/opencontainers/umoci/oci/casext"
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
-	stackeroci "stackerbuild.io/stacker/oci"
+	stackeroci "stackerbuild.io/stacker/pkg/oci"
 )
 
 var inspectCmd = cli.Command{

diff --git a/cmd/internal_go.go → cmd/stacker/internal_go.go b/cmd/internal_go.go → cmd/stacker/internal_go.go
@@ -10,10 +10,10 @@ import (
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
 	"golang.org/x/sys/unix"
-	"stackerbuild.io/stacker/atomfs"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/overlay"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/overlay"
+	"stackerbuild.io/stacker/pkg/atomfs"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 var internalGoCmd = cli.Command{

diff --git a/cmd/lxc-wrapper/.gitignore → cmd/stacker/lxc-wrapper/.gitignore b/cmd/lxc-wrapper/.gitignore → cmd/stacker/lxc-wrapper/.gitignore
diff --git a/cmd/lxc-wrapper/Makefile → cmd/stacker/lxc-wrapper/Makefile b/cmd/lxc-wrapper/Makefile → cmd/stacker/lxc-wrapper/Makefile
diff --git a/cmd/lxc-wrapper/lxc-wrapper.c → cmd/stacker/lxc-wrapper/lxc-wrapper.c b/cmd/lxc-wrapper/lxc-wrapper.c → cmd/stacker/lxc-wrapper/lxc-wrapper.c
diff --git a/cmd/main.go → cmd/stacker/main.go b/cmd/main.go → cmd/stacker/main.go
@@ -17,9 +17,9 @@ import (
 	"github.com/urfave/cli"
 	"golang.org/x/term"
 	"gopkg.in/yaml.v2"
-	"stackerbuild.io/stacker/container"
-	stackerlog "stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/types"
+	stackerlog "stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/container"
 )
 
 var (

diff --git a/cmd/publish.go → cmd/stacker/publish.go b/cmd/publish.go → cmd/stacker/publish.go
@@ -3,10 +3,10 @@ package main
 import (
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/squashfs"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
+	"stackerbuild.io/stacker/pkg/squashfs"
 )
 
 var publishCmd = cli.Command{

diff --git a/cmd/recursive-build.go → cmd/stacker/recursive-build.go b/cmd/recursive-build.go → cmd/stacker/recursive-build.go
@@ -2,8 +2,8 @@ package main
 
 import (
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
-	"stackerbuild.io/stacker/lib"
+	"stackerbuild.io/stacker/internal"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 const stackerFilePathRegex = "\\/stacker.yaml$"

diff --git a/cmd/unpriv-setup.go → cmd/stacker/unpriv-setup.go b/cmd/unpriv-setup.go → cmd/stacker/unpriv-setup.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
+	"stackerbuild.io/stacker/internal"
 )
 
 var unprivSetupCmd = cli.Command{

diff --git a/cmd/validate.go → cmd/stacker/validate.go b/cmd/validate.go → cmd/stacker/validate.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/urfave/cli"
-	"stackerbuild.io/stacker"
+	"stackerbuild.io/stacker/internal"
 )
 
 /*

diff --git a/api.go → internal/api.go b/api.go → internal/api.go
diff --git a/base.go → internal/base.go b/base.go → internal/base.go
@@ -11,9 +11,9 @@ import (
 	"github.com/opencontainers/umoci/oci/casext"
 	"github.com/opencontainers/umoci/oci/layer"
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 type BaseLayerOpts struct {

diff --git a/build.go → internal/build.go b/build.go → internal/build.go
@@ -15,9 +15,9 @@ import (
 	"github.com/opencontainers/umoci/mutate"
 	"github.com/opencontainers/umoci/oci/casext"
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/container"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/container"
 )
 
 const DefaultShell = "/bin/sh"

diff --git a/cache.go → internal/cache.go b/cache.go → internal/cache.go
@@ -17,9 +17,9 @@ import (
 	"github.com/opencontainers/umoci/oci/casext"
 	"github.com/pkg/errors"
 	"github.com/vbatts/go-mtree"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 const currentCacheVersion = 12

diff --git a/cache_test.go → internal/cache_test.go b/cache_test.go → internal/cache_test.go
@@ -10,7 +10,7 @@ import (
 	"github.com/opencontainers/umoci"
 	"github.com/opencontainers/umoci/oci/casext"
 	"github.com/stretchr/testify/assert"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/types"
 )
 
 func TestLayerHashing(t *testing.T) {

diff --git a/deps.go → internal/deps.go b/deps.go → internal/deps.go
@@ -2,8 +2,8 @@ package stacker
 
 import (
 	"sort"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 // StackerDepsDAG processes the dependencies between different stacker recipes

diff --git a/embed-exec/embed-exec.go → internal/embed-exec/embed-exec.go b/embed-exec/embed-exec.go → internal/embed-exec/embed-exec.go
diff --git a/git.go → internal/git.go b/git.go → internal/git.go
diff --git a/grab.go → internal/grab.go b/grab.go → internal/grab.go
@@ -6,8 +6,8 @@ import (
 	"path"
 
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/container"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/container"
 )
 
 func Grab(sc types.StackerConfig, storage types.Storage, name string, source string, targetDir string) error {

diff --git a/import.go → internal/import.go b/import.go → internal/import.go
@@ -10,9 +10,9 @@ import (
 	"github.com/pkg/errors"
 	"github.com/udhos/equalfile"
 	"github.com/vbatts/go-mtree"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 // filesDiffer returns true if the files are different, false if they are the same.

diff --git a/lock.go → internal/lock.go b/lock.go → internal/lock.go
@@ -9,7 +9,7 @@ import (
 	"syscall"
 
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/types"
 )
 
 func findLock(st *syscall.Stat_t) error {

diff --git a/log/log.go → internal/log/log.go b/log/log.go → internal/log/log.go
diff --git a/mtree/filter.go → internal/mtree/filter.go b/mtree/filter.go → internal/mtree/filter.go
diff --git a/network.go → internal/network.go b/network.go → internal/network.go
@@ -11,8 +11,8 @@ import (
 
 	"github.com/cheggaaa/pb/v3"
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/log"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 // download with caching support in the specified cache dir.

diff --git a/overlay/metadata.go → internal/overlay/metadata.go b/overlay/metadata.go → internal/overlay/metadata.go
@@ -10,9 +10,9 @@ import (
 	ispec "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/opencontainers/umoci/oci/casext"
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/log"
-	stackeroci "stackerbuild.io/stacker/oci"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	stackeroci "stackerbuild.io/stacker/pkg/oci"
 )
 
 type overlayMetadata struct {

diff --git a/overlay/metadata_test.go → internal/overlay/metadata_test.go b/overlay/metadata_test.go → internal/overlay/metadata_test.go
diff --git a/overlay/overlay-dirs.go → internal/overlay/overlay-dirs.go b/overlay/overlay-dirs.go → internal/overlay/overlay-dirs.go
@@ -7,8 +7,8 @@ import (
 	ispec "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/opencontainers/umoci"
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 // generateOverlayDirsLayers generates oci layers from all overlay_dirs of this image

diff --git a/overlay/overlay.go → internal/overlay/overlay.go b/overlay/overlay.go → internal/overlay/overlay.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/pkg/errors"
 	"golang.org/x/sys/unix"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/types"
 )
 
 var _ types.Storage = &overlay{}

diff --git a/overlay/pack.go → internal/overlay/pack.go b/overlay/pack.go → internal/overlay/pack.go
@@ -21,12 +21,12 @@ import (
 	"github.com/opencontainers/umoci/oci/layer"
 	"github.com/pkg/errors"
 	"github.com/pkg/xattr"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/log"
-	stackeroci "stackerbuild.io/stacker/oci"
-	"stackerbuild.io/stacker/squashfs"
-	"stackerbuild.io/stacker/storage"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/storage"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
+	stackeroci "stackerbuild.io/stacker/pkg/oci"
+	"stackerbuild.io/stacker/pkg/squashfs"
 )
 
 func safeOverlayName(d digest.Digest) string {

diff --git a/overlay/pool.go → internal/overlay/pool.go b/overlay/pool.go → internal/overlay/pool.go
diff --git a/overlay/unpriv-setup.go → internal/overlay/unpriv-setup.go b/overlay/unpriv-setup.go → internal/overlay/unpriv-setup.go
@@ -1,7 +1,7 @@
 package overlay
 
 import (
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/types"
 )
 
 func UnprivSetup(config types.StackerConfig, uid, gid int) error {

diff --git a/publisher.go → internal/publisher.go b/publisher.go → internal/publisher.go
@@ -11,9 +11,9 @@ import (
 	"github.com/opencontainers/umoci"
 	"github.com/opencontainers/umoci/oci/casext"
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/lib"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/types"
+	"stackerbuild.io/stacker/pkg/lib"
 )
 
 type PublishArgs struct {

diff --git a/storage.go → internal/storage.go b/storage.go → internal/storage.go
@@ -5,10 +5,10 @@ import (
 	"path"
 
 	"github.com/pkg/errors"
-	"stackerbuild.io/stacker/log"
-	"stackerbuild.io/stacker/overlay"
-	"stackerbuild.io/stacker/storage"
-	"stackerbuild.io/stacker/types"
+	"stackerbuild.io/stacker/internal/log"
+	"stackerbuild.io/stacker/internal/overlay"
+	"stackerbuild.io/stacker/internal/storage"
+	"stackerbuild.io/stacker/internal/types"
 )
 
 var storageTypeFile = "storage.type"