Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup empty directories. #9

Merged
merged 4 commits into from
May 19, 2021
Merged

Cleanup empty directories. #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6ca64d
Cleanup empty directories.
Gerrit91 May 19, 2021
023322d
Next attempt.
Gerrit91 May 19, 2021
4370518
Fix with test.
Gerrit91 May 19, 2021
ef0345b
Revert renaming.
Gerrit91 May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 61 additions & 1 deletion cmd/internal/sync/syncer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package sync

import (
"context"

// nolint
"crypto/md5"
"fmt"
Expand Down Expand Up @@ -90,14 +91,19 @@ func (s *Syncer) Sync(rootPath string, entitiesToSync api.CacheEntities) error {
}
}

err = cleanEmptyDirs(s.fs, rootPath)
if err != nil {
return errors.Wrap(err, "error cleaning up empty directories")
}

return nil
}

func currentFileIndex(fs afero.Fs, rootPath string) (api.CacheEntities, error) {
var result api.CacheEntities
err := afero.Walk(fs, rootPath, func(p string, info os.FileInfo, innerErr error) error {
if innerErr != nil {
return errors.Wrap(innerErr, "error while walking through cache root")
return errors.Wrap(innerErr, fmt.Sprintf("error while walking through root path %s", rootPath))
}

if info.IsDir() {
Expand Down Expand Up @@ -308,3 +314,57 @@ func (s *Syncer) printSyncPlan(remove api.CacheEntities, keep []api.CacheEntity,
}
table.Render()
}

func cleanEmptyDirs(fs afero.Fs, rootPath string) error {
files, err := afero.ReadDir(fs, rootPath)
if err != nil {
return err
}

for _, info := range files {
if !info.IsDir() {
continue
}

err = recurseCleanEmptyDirs(fs, path.Join(rootPath, info.Name()))
if err != nil {
return err
}
}

return nil
}

func recurseCleanEmptyDirs(fs afero.Fs, p string) error {
files, err := afero.ReadDir(fs, p)
if err != nil {
return err
}

for _, info := range files {
if !info.IsDir() {
continue
}

nested := path.Join(p, info.Name())
err = recurseCleanEmptyDirs(fs, nested)
if err != nil {
return err
}
}

// re-read files because directories could delete themselves in first loop
files, err = afero.ReadDir(fs, p)
if err != nil {
return err
}

if len(files) == 0 {
err = fs.Remove(p)
if err != nil {
return err
}
}

return nil
}
134 changes: 133 additions & 1 deletion cmd/internal/sync/syncer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/metal-stack/metal-image-cache-sync/pkg/api"
"github.com/spf13/afero"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/zap/zaptest"
)
Expand Down Expand Up @@ -94,14 +95,18 @@ func Test_currentFileIndex(t *testing.T) {
}

func createTestFile(t *testing.T, fs afero.Fs, p string) {
require.Nil(t, fs.MkdirAll(path.Base(p), 0755))
createTestDir(t, fs, path.Base(p))
f, err := fs.Create(p)
require.Nil(t, err)
defer f.Close()
_, err = f.WriteString("Test")
require.Nil(t, err)
}

func createTestDir(t *testing.T, fs afero.Fs, p string) {
require.Nil(t, fs.MkdirAll(p, 0755))
}

func dlLoggingSvc(data []byte) (*s3.S3, *[]string, *[]string) {
var m sync.Mutex
names := []string{}
Expand Down Expand Up @@ -346,3 +351,130 @@ func TestSyncer_defineImageDiff(t *testing.T) {
func strPtr(s string) *string {
return &s
}

func Test_cleanEmptyDirs(t *testing.T) {
tests := []struct {
name string
fsModFunc func(t *testing.T, fs afero.Fs)
fsCheckFunc func(t *testing.T, fs afero.Fs)
wantErr error
}{
{
name: "no directory contents, nothing happens",
fsModFunc: nil,
wantErr: nil,
},
{
name: "flat deletion",
fsModFunc: func(t *testing.T, fs afero.Fs) {
createTestDir(t, fs, cacheRoot+"/ubuntu")
},
fsCheckFunc: func(t *testing.T, fs afero.Fs) {
exists, err := afero.Exists(fs, cacheRoot+"/ubuntu")
assert.NoError(t, err)
assert.False(t, exists, "dir still exists")
},
wantErr: nil,
},
{
name: "recursive deletion 1",
fsModFunc: func(t *testing.T, fs afero.Fs) {
createTestDir(t, fs, cacheRoot+"/ubuntu/20.10/20201027")
},
fsCheckFunc: func(t *testing.T, fs afero.Fs) {
exists, err := afero.Exists(fs, cacheRoot+"/ubuntu/20.10/20201027")
assert.NoError(t, err)
assert.False(t, exists, "dir still exists")

exists, err = afero.Exists(fs, cacheRoot+"/ubuntu/20.10")
assert.NoError(t, err)
assert.False(t, exists, "dir still exists")

exists, err = afero.Exists(fs, cacheRoot+"/ubuntu")
assert.NoError(t, err)
assert.False(t, exists, "dir still exists")
},
wantErr: nil,
},
{
name: "recursive deletion 2",
fsModFunc: func(t *testing.T, fs afero.Fs) {
createTestFile(t, fs, cacheRoot+"/ubuntu/20.04/20201028/img.tar.lz4")
createTestDir(t, fs, cacheRoot+"/ubuntu/20.10/20201027")
},
fsCheckFunc: func(t *testing.T, fs afero.Fs) {
exists, err := afero.Exists(fs, cacheRoot+"/ubuntu/20.10/20201027")
assert.NoError(t, err)
assert.False(t, exists, "dir still exists")

exists, err = afero.Exists(fs, cacheRoot+"/ubuntu/20.10")
assert.NoError(t, err)
assert.False(t, exists, "dir still exists")

exists, err = afero.Exists(fs, cacheRoot+"/ubuntu")
assert.NoError(t, err)
assert.True(t, exists, "dir was deleted")
},
wantErr: nil,
},
{
name: "kind of realistic scenario",

fsModFunc: func(t *testing.T, fs afero.Fs) {
createTestDir(t, fs, cacheRoot+"/boot/metal-hammer/releases/download/v0.8.0")
createTestFile(t, fs, cacheRoot+"/boot/metal-hammer/pull-requests/pr-title/metal-hammer-initrd.img.lz4")
createTestFile(t, fs, cacheRoot+"/boot/metal-hammer/pull-requests/pr-title/metal-hammer-initrd.img.lz4.md5")
createTestFile(t, fs, cacheRoot+"/ubuntu/20.10/20201026/img.tar.lz4")
createTestFile(t, fs, cacheRoot+"/ubuntu/20.10/20201026/img.tar.lz4.md5")
createTestDir(t, fs, cacheRoot+"/firewall/2.0/20210131")
createTestDir(t, fs, cacheRoot+"/firewall/2.0/20210207")
createTestFile(t, fs, cacheRoot+"/firewall/2.0/20210304/img.tar.lz4")
createTestFile(t, fs, cacheRoot+"/firewall/2.0/20210304/img.tar.lz4.md5")
},
fsCheckFunc: func(t *testing.T, fs afero.Fs) {
for _, subPath := range []string{
"/boot/metal-hammer/releases",
"/firewall/2.0.20210131",
"/firewall/2.0.20210207",
} {
exists, err := afero.Exists(fs, cacheRoot+subPath)
assert.NoError(t, err)
assert.False(t, exists, "dir still exists")
}

for _, subPath := range []string{
"/boot/metal-hammer/pull-requests/pr-title/metal-hammer-initrd.img.lz4",
"/boot/metal-hammer/pull-requests/pr-title/metal-hammer-initrd.img.lz4.md5",
"/ubuntu/20.10/20201026/img.tar.lz4",
"/ubuntu/20.10/20201026/img.tar.lz4.md5",
"/firewall/2.0/20210304/img.tar.lz4",
"/firewall/2.0/20210304/img.tar.lz4.md5",
} {
exists, err := afero.Exists(fs, cacheRoot+subPath)
assert.NoError(t, err)
assert.True(t, exists, "dir was deleted")
}
},
wantErr: nil,
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
fs := afero.NewMemMapFs()
require.Nil(t, fs.MkdirAll(cacheRoot, 0755))
if tt.fsModFunc != nil {
tt.fsModFunc(t, fs)
}

err := cleanEmptyDirs(fs, cacheRoot)
if diff := cmp.Diff(err, tt.wantErr); diff != "" {
t.Errorf("cleanEmptyDirs() diff = %v", diff)
}

if tt.fsCheckFunc != nil {
tt.fsCheckFunc(t, fs)
}
})
}
}