Skip to content

Commit 271e052

Browse files
authored
fix: Improve error handling and fix wrong compress dir for windows (#367) (#368)
* fix: Improve error handling and fix wrong compress dir for windows * refactor: Refactor fileutil package for pass linter
1 parent c9beee2 commit 271e052

File tree

3 files changed

+108
-30
lines changed

3 files changed

+108
-30
lines changed

cmd/hack-browser-data/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ func Execute() {
6262

6363
if compress {
6464
if err = fileutil.CompressDir(outputDir); err != nil {
65-
slog.Error("compress error: ", "err", err)
65+
slog.Error("compress error", "err", err)
6666
}
6767
slog.Info("compress success")
6868
}

utils/fileutil/filetutil.go

+55-29
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import (
55
"bytes"
66
"fmt"
77
"os"
8-
"path"
98
"path/filepath"
109
"strings"
1110

@@ -94,40 +93,67 @@ func ParentBaseDir(p string) string {
9493
func CompressDir(dir string) error {
9594
files, err := os.ReadDir(dir)
9695
if err != nil {
97-
return err
96+
return fmt.Errorf("read dir error: %w", err)
9897
}
99-
b := new(bytes.Buffer)
100-
zw := zip.NewWriter(b)
101-
for _, f := range files {
102-
fw, err := zw.Create(f.Name())
103-
if err != nil {
104-
return err
105-
}
106-
name := path.Join(dir, f.Name())
107-
content, err := os.ReadFile(name)
108-
if err != nil {
109-
return err
110-
}
111-
_, err = fw.Write(content)
112-
if err != nil {
113-
return err
114-
}
115-
err = os.Remove(name)
116-
if err != nil {
117-
return err
98+
if len(files) == 0 {
99+
// Return an error if no files are found in the directory
100+
return fmt.Errorf("no files to compress in: %s", dir)
101+
}
102+
103+
buffer := new(bytes.Buffer)
104+
zipWriter := zip.NewWriter(buffer)
105+
defer func() {
106+
_ = zipWriter.Close()
107+
}()
108+
109+
for _, file := range files {
110+
if err := addFileToZip(zipWriter, filepath.Join(dir, file.Name())); err != nil {
111+
return fmt.Errorf("failed to add file to zip: %w", err)
118112
}
119113
}
120-
if err := zw.Close(); err != nil {
121-
return err
114+
115+
if err := zipWriter.Close(); err != nil {
116+
return fmt.Errorf("error closing zip writer: %w", err)
122117
}
123-
filename := filepath.Join(dir, fmt.Sprintf("%s.zip", dir))
124-
outFile, err := os.Create(filepath.Clean(filename))
118+
119+
zipFilename := filepath.Join(dir, filepath.Base(dir)+".zip")
120+
return writeFile(buffer, zipFilename)
121+
}
122+
123+
func addFileToZip(zw *zip.Writer, filename string) error {
124+
content, err := os.ReadFile(filename)
125125
if err != nil {
126-
return err
126+
return fmt.Errorf("error reading file %s: %w", filename, err)
127127
}
128-
_, err = b.WriteTo(outFile)
128+
129+
fw, err := zw.Create(filepath.Base(filename))
129130
if err != nil {
130-
return err
131+
return fmt.Errorf("error creating zip entry for %s: %w", filename, err)
131132
}
132-
return outFile.Close()
133+
134+
if _, err = fw.Write(content); err != nil {
135+
return fmt.Errorf("error writing content to zip for %s: %w", filename, err)
136+
}
137+
138+
if err = os.Remove(filename); err != nil {
139+
return fmt.Errorf("error removing original file %s: %w", filename, err)
140+
}
141+
142+
return nil
143+
}
144+
145+
func writeFile(buffer *bytes.Buffer, filename string) error {
146+
outFile, err := os.Create(filename)
147+
if err != nil {
148+
return fmt.Errorf("error creating output file %s: %w", filename, err)
149+
}
150+
defer func() {
151+
_ = outFile.Close()
152+
}()
153+
154+
if _, err = buffer.WriteTo(outFile); err != nil {
155+
return fmt.Errorf("error writing data to file %s: %w", filename, err)
156+
}
157+
158+
return nil
133159
}

utils/fileutil/fileutil_test.go

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
package fileutil
2+
3+
import (
4+
"os"
5+
"path/filepath"
6+
"testing"
7+
8+
"github.com/stretchr/testify/assert"
9+
"github.com/stretchr/testify/require"
10+
)
11+
12+
func setupTestDir(t *testing.T, files []string) string {
13+
t.Helper() // Marks the function as a helper function.
14+
15+
tempDir, err := os.MkdirTemp("", "testCompressDir")
16+
require.NoError(t, err, "failed to create a temporary directory")
17+
18+
for _, file := range files {
19+
filePath := filepath.Join(tempDir, file)
20+
err := os.WriteFile(filePath, []byte("test content"), 0o644)
21+
require.NoError(t, err, "failed to create a test file")
22+
}
23+
return tempDir
24+
}
25+
26+
func TestCompressDir(t *testing.T) {
27+
t.Run("Normal Operation", func(t *testing.T) {
28+
tempDir := setupTestDir(t, []string{"file1.txt", "file2.txt", "file3.txt"})
29+
defer os.RemoveAll(tempDir)
30+
31+
err := CompressDir(tempDir)
32+
assert.NoError(t, err, "compressDir should not return an error")
33+
34+
// Check if the zip file exists
35+
zipFile := filepath.Join(tempDir, filepath.Base(tempDir)+".zip")
36+
assert.FileExists(t, zipFile, "zip file should be created")
37+
})
38+
39+
t.Run("Directory Does Not Exist", func(t *testing.T) {
40+
err := CompressDir("/path/to/nonexistent/directory")
41+
assert.Error(t, err, "should return an error for non-existent directory")
42+
})
43+
44+
t.Run("Empty Directory", func(t *testing.T) {
45+
tempDir, err := os.MkdirTemp("", "testEmptyDir")
46+
require.NoError(t, err, "failed to create empty test directory")
47+
defer os.RemoveAll(tempDir)
48+
49+
err = CompressDir(tempDir)
50+
assert.Error(t, err, "should return an error for an empty directory")
51+
})
52+
}

0 commit comments

Comments
 (0)