Search code examples
unit-testinggofilesystemsziparchive

Create unit test for archive function fs


I have the following function which is working as expected. Now I want to create unit test for it. The problem is that I'm using the file system and I am not able to figure out how to do it with some mocks or any other solution. Any idea how this can be done simply in Go? Should I really create a files and check then with unit test? I'm afraid that in some system it will work and some it breaks (winodos/ mac/linux)

This is the working function:

func Zipper(src string,artifact string,target string) error {

    zf, err := os.Create(artifact)
    if err != nil {
        return err
    }
    defer zf.Close()

    ziper := zip.NewWriter(zf)
    defer ziper.Close()

    fileInfo, err := os.Stat(src)
    if err != nil {
        return err
    }

    var bs string
    if fileInfo.IsDir(); len(target) > 0 {
        bs = target
    } else {
        bs = filepath.Base(src)
    }

    if bs != "" {
        bs += "/"
    }

    filepath.Walk(src, func(path string, info os.FileInfo, err error) error {
        if err != nil {
            return err
        }

        if info.IsDir() {
            return nil
        }

        header, err := zip.FileInfoHeader(info)
        if err != nil {
            return err
        }

        if bs != "" {
            header.Name = filepath.Join(strings.TrimPrefix(path, bs))
        }

        header.Method = zip.Deflate

        writer, err := ziper.CreateHeader(header)
        if err != nil {
            return err
        }

        file, err := os.Open(path)
        if err != nil {
            return err
        }
        defer file.Close()
        _, err = io.Copy(writer, file)
        return err
    })

    return err
}

I read the following but it not much helping in my case How to mock/abstract filesystem in go?


Solution

  • The simplest way to test a function that depends on the filesystem, is to add some set-up and tear-down around each test, which puts the necessary files in place before running the test, then removes them after running the test.

    func TestZipper(t *testing.T) {
        // Create temporary files
        defer func() {
            // Clean up temporary files
        }()
        t.Run("group", func(t *testing.T) { // This is necessary so the above defer function doesn't run too soon
            // your actual tests
        })
    }