Thanks to visit codestin.com
Credit goes to github.com

Skip to content

🐹 🐛 fix cachedirectory.go to allow an existing empty dir as cache #123

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

Merged
merged 4 commits into from
Feb 4, 2025
Merged

🐹 🐛 fix cachedirectory.go to allow an existing empty dir as cache #123

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
e34cd16
:hamster: :bug: fix cachedirectory.go to reuse empty dir
marcellodesales Jan 28, 2025
603d851
:hamster: :bug: fix the check for the empty dir
marcellodesales Jan 29, 2025
b84492c
:hamster: :white_check_mark: add test case for empty cache dir
marcellodesales Jan 29, 2025
6f77278
Fix horribly confusing lint failure. 😅
chrisgavin Feb 4, 2025
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
51 changes: 39 additions & 12 deletions internal/cachedirectory/cachedirectory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package cachedirectory

import (
usererrors "errors"
"io"
"io/ioutil"
"os"
"path"
Expand All @@ -27,24 +26,37 @@ func NewCacheDirectory(path string) CacheDirectory {
}
}

func isEmptyOrNonExistentDirectory(path string) (bool, error) {
f, err := os.Open(path)
func isAccessibleDirectory(path string) (bool, error) {
_, err := os.Stat(path)

if err != nil {
if os.IsNotExist(err) {
return true, nil
return false, nil
}
return false, errors.Wrapf(err, "Could not access directory %s.", path)
}
defer f.Close()

_, err = f.Readdirnames(1)
return true, nil
}

func isEmptyDirectory(path string) (bool, error) {
files, err := ioutil.ReadDir(path)
if err != nil {
if err == io.EOF {
return true, nil
}
return false, errors.Wrapf(err, "Could not read contents of directory %s.", path)
}
return false, nil

return len(files) == 0, nil
}

func existsDirectory(path string) (bool, error) {
_, err := os.Stat(path)
if os.IsNotExist(err) {
return false, nil
}
if err != nil {
return false, errors.Wrapf(err, "Could not access directory %s.", path)
}
return true, nil
}

func (cacheDirectory *CacheDirectory) CheckOrCreateVersionFile(pull bool, version string) error {
Expand Down Expand Up @@ -77,15 +89,30 @@ func (cacheDirectory *CacheDirectory) CheckOrCreateVersionFile(pull bool, versio
}
}

isEmptyOrNonExistent, err := isEmptyOrNonExistentDirectory(cacheDirectory.path)
existsDirectory, err := existsDirectory(cacheDirectory.path)
if err != nil {
return err
}
if isEmptyOrNonExistent {
if !existsDirectory {
err := os.Mkdir(cacheDirectory.path, 0755)
if err != nil {
return errors.Wrap(err, "Could not create cache directory.")
}

} else {
isAccessible, err := isAccessibleDirectory(cacheDirectory.path)
if err != nil {
return err
}
if !isAccessible {
return errors.Wrap(err, "Cache dir exists, but the current user can't write to it.")
}
}
isEmpty, err := isEmptyDirectory(cacheDirectory.path)
if err != nil {
return err
}
if isEmpty {
err = ioutil.WriteFile(cacheVersionFilePath, []byte(version), 0644)
if err != nil {
return errors.Wrap(err, "Could not create cache version file.")
Expand Down
12 changes: 12 additions & 0 deletions internal/cachedirectory/cachedirectory_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,18 @@ func TestCreateCacheDirectoryWithTrailingSlash(t *testing.T) {
require.NoError(t, err)
}

func TestUseProvidedEmptyCacheDirectory(t *testing.T) {
temporaryDirectory := test.CreateTemporaryDirectory(t)
cacheDirectoryPath := path.Join(temporaryDirectory, "cache")
err := os.MkdirAll(cacheDirectoryPath, 0755)
require.NoError(t, err)
cacheDirectory := NewCacheDirectory(cacheDirectoryPath)
err = cacheDirectory.CheckOrCreateVersionFile(true, aVersion)
require.NoError(t, err)
cacheVersionFilePath := cacheDirectory.versionFilePath()
require.FileExists(t, cacheVersionFilePath)
}

func TestLocking(t *testing.T) {
temporaryDirectory := test.CreateTemporaryDirectory(t)
cacheDirectory := NewCacheDirectory(path.Join(temporaryDirectory, "cache"))
Expand Down
Loading