├── .gitignore ├── .travis.yml ├── Gopkg.toml ├── LICENSE.txt ├── README.md ├── _config.yml ├── filet.go └── filet_test.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | bin/ 3 | 4 | # package dependencies file generated by `dep ensure` command 5 | Gopkg.lock 6 | 7 | # Test binary, built with `go test -c` 8 | *.test 9 | 10 | # Output of the go coverage tool, specifically when used with LiteIDE 11 | *.out 12 | 13 | # Dependency directories (remove the comment below to include it) 14 | vendor/ 15 | 16 | # app log files 17 | *.log 18 | 19 | # Editors 20 | # PyCharm 21 | .idea 22 | # VIM 23 | *~ 24 | *.swp 25 | *.swo 26 | # Visual Studio Code 27 | .vscode/* 28 | !.vscode/settings.json 29 | !.vscode/tasks.json 30 | !.vscode/launch.json 31 | !.vscode/extensions.json 32 | *.code-workspace 33 | .history/ 34 | 35 | # Git 36 | *.orig 37 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | sudo: false 3 | 4 | go: 5 | - tip 6 | before_install: 7 | - go get github.com/mattn/goveralls 8 | script: 9 | - $HOME/gopath/bin/goveralls -service=travis-ci 10 | -------------------------------------------------------------------------------- /Gopkg.toml: -------------------------------------------------------------------------------- 1 | # Gopkg.toml example 2 | # 3 | # Refer to https://golang.github.io/dep/docs/Gopkg.toml.html 4 | # for detailed Gopkg.toml documentation. 5 | # 6 | # required = ["github.com/user/thing/cmd/thing"] 7 | # ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"] 8 | # 9 | # [[constraint]] 10 | # name = "github.com/user/project" 11 | # version = "1.0.0" 12 | # 13 | # [[constraint]] 14 | # name = "github.com/user/project2" 15 | # branch = "dev" 16 | # source = "github.com/myfork/project2" 17 | # 18 | # [[override]] 19 | # name = "github.com/x/y" 20 | # version = "2.4.0" 21 | # 22 | # [prune] 23 | # non-go = false 24 | # go-tests = true 25 | # unused-packages = true 26 | 27 | 28 | [[constraint]] 29 | name = "github.com/spf13/afero" 30 | version = "1.4.1" 31 | 32 | [[constraint]] 33 | name = "github.com/stretchr/testify" 34 | version = "1.6.1" 35 | 36 | [prune] 37 | go-tests = true 38 | unused-packages = true 39 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://travis-ci.org/Flaque/filet.svg?branch=master)](https://travis-ci.org/Flaque/filet) 2 | [![Go Report Card](https://goreportcard.com/badge/github.com/flaque/filet)](https://goreportcard.com/report/github.com/flaque/filet) 3 | 4 | # Filet 🍖 5 | A small temporary file utility for Go testing. Built on [Afero](https://github.com/spf13/afero) and heavily inspired by the way Afero tests itself. 6 | 7 | Install via: 8 | `$ go get github.com/Flaque/filet` 9 | 10 | Then import with: 11 | ``` 12 | import ( 13 | filet "github.com/Flaque/filet" 14 | ) 15 | ``` 16 | 17 | Quick overview at [GoDocs](https://godoc.org/github.com/Flaque/filet). 18 | 19 | ## Creating temporaries 20 | 21 | ### Creating temporary directories: 22 | ``` 23 | func TestFoo(t *testing.T) { 24 | filet.TmpDir(t, "") // Creates a temporary dir with no parent directory 25 | filet.TmpDir(t, "myPath") // Creates a temporary dir at `myPath` 26 | } 27 | ``` 28 | 29 | ### Creating temporary files: 30 | ``` 31 | func TestFoo(t *testing.T) { 32 | filet.TmpFile(t, "", "") // Creates a temporary file with no parent dir 33 | 34 | // Creates a temporary file with string "some content" 35 | filet.TmpFile(t, "", "some content") 36 | 37 | // Creates a temporary file with string "some content" 38 | filet.TmpFile(t, "myDir", "some content") 39 | } 40 | ``` 41 | 42 | ### Creating specified files: 43 | ``` 44 | func TestFoo(t *testing.T) { 45 | filet.File(t, "conf.yaml", "") // Creates a specified file 46 | 47 | // Creates a specified file with string "some content" 48 | filet.File(t, "/tmp/conf.yaml", "some content") 49 | } 50 | ``` 51 | 52 | ### Cleaning up after yourself: 53 | Filet lets you clean up after your files with `CleanUp`, which is 54 | most cleanly used at the beginning of a function with `defer`. For example: 55 | 56 | ``` 57 | func TestFoo(t *testing.T) { 58 | defer filet.CleanUp(t) 59 | 60 | // Create a bunch of temporary stuff here 61 | } 62 | ``` 63 | 64 | `CleanUp` will call `t.Error` if something goes wrong when removing the file. 65 | 66 | You can also access the `Files` itself if you want to add a specificly 67 | named file to the cleanup list. 68 | 69 | ``` 70 | filet.Files = append(filet.Files, "path/to/my/named/file") 71 | ``` 72 | 73 | ## Helpers 74 | 75 | Filet comes with a few helper functions that are useful for working with your 76 | temporary files. 77 | 78 | ### Checking Existence 79 | You can test if a file exists if you want. 80 | ``` 81 | func TestFoo(t *testing.T) { 82 | myBool := filet.Exists(t, "path/to/my/file") 83 | } 84 | ``` 85 | 86 | ### Checking DirContains 87 | You can test if a folder contains a file or another directory. 88 | ``` 89 | func TestFoo(t *testing.T) { 90 | myBool := filet.DirContains(t, "path/to/myFolder", "myFile") 91 | } 92 | ``` 93 | 94 | ### Checking if a FileSays what you want 95 | You can check if a file's contents says what you want it to with `FileSays`. 96 | 97 | ``` 98 | func TestFoo(t *testing.T) { 99 | myBool := filet.FileSays(t, "path/to/my/dir", []byte("my content here")) 100 | } 101 | ``` 102 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-minimal -------------------------------------------------------------------------------- /filet.go: -------------------------------------------------------------------------------- 1 | package filet 2 | 3 | import ( 4 | "bytes" 5 | "github.com/spf13/afero" 6 | "os" 7 | "path/filepath" 8 | ) 9 | 10 | // TestReporter can be used to report test failures. It is satisfied by the standard library's *testing.T. 11 | type TestReporter interface { 12 | Error(args ...interface{}) 13 | } 14 | 15 | // Files keeps track of files that we've used so we can clean up. 16 | var Files []string 17 | var appFs = afero.NewOsFs() 18 | 19 | /* 20 | TmpDir Creates a tmp directory for us to use. 21 | */ 22 | func TmpDir(t TestReporter, dir string) string { 23 | name, err := afero.TempDir(appFs, dir, "dir") 24 | if err != nil { 25 | t.Error("Failed to create the tmpDir: "+name, err) 26 | } 27 | 28 | Files = append(Files, name) 29 | return name 30 | } 31 | 32 | /* 33 | TmpFile Creates a tmp file for us to use when testing 34 | */ 35 | func TmpFile(t TestReporter, dir string, content string) afero.File { 36 | file, err := afero.TempFile(appFs, dir, "file") 37 | defer file.Close() 38 | 39 | if err != nil { 40 | t.Error("Failed to create the tmpFile: "+file.Name(), err) 41 | } 42 | 43 | file.WriteString(content) 44 | Files = append(Files, file.Name()) 45 | 46 | return file 47 | } 48 | 49 | /* 50 | File Creates a specified file for us to use when testing 51 | */ 52 | func File(t TestReporter, path string, content string) afero.File { 53 | file, err := appFs.OpenFile(path, os.O_RDWR|os.O_CREATE, 0600) 54 | defer file.Close() 55 | 56 | if err != nil { 57 | t.Error("Failed to create the file: "+path, err) 58 | return nil 59 | } 60 | 61 | file.WriteString(content) 62 | Files = append(Files, file.Name()) 63 | 64 | return file 65 | } 66 | 67 | /* 68 | FileSays returns true if the file at the path contains the expected byte array 69 | content. 70 | */ 71 | func FileSays(t TestReporter, path string, expected []byte) bool { 72 | content, err := afero.ReadFile(appFs, path) 73 | if err != nil { 74 | t.Error("Failed to read file: "+path, err) 75 | } 76 | 77 | return bytes.Equal(content, expected) 78 | } 79 | 80 | /* 81 | CleanUp removes all files in our test registry and calls `t.Error` if something goes 82 | wrong. 83 | */ 84 | func CleanUp(t TestReporter) { 85 | for _, path := range Files { 86 | if err := appFs.RemoveAll(path); err != nil { 87 | t.Error(appFs.Name(), err) 88 | } 89 | } 90 | 91 | Files = make([]string, 0) 92 | } 93 | 94 | /* 95 | Exists returns true if the file exists. Calls t.Error if something goes wrong while 96 | checking. 97 | */ 98 | func Exists(t TestReporter, path string) bool { 99 | exists, err := afero.Exists(appFs, path) 100 | if err != nil { 101 | t.Error("Something went wrong when checking if "+path+"exists!", err) 102 | } 103 | return exists 104 | } 105 | 106 | /* 107 | DirContains returns true if the dir contains the path. Calls t.Error if 108 | something goes wrong while checking. 109 | */ 110 | func DirContains(t TestReporter, dir string, path string) bool { 111 | fullPath := filepath.Join(dir, path) 112 | return Exists(t, fullPath) 113 | } -------------------------------------------------------------------------------- /filet_test.go: -------------------------------------------------------------------------------- 1 | package filet 2 | 3 | import ( 4 | "path/filepath" 5 | "testing" 6 | 7 | "github.com/stretchr/testify/assert" 8 | "github.com/stretchr/testify/require" 9 | ) 10 | 11 | func TestTmpDir(t *testing.T) { 12 | defer CleanUp(t) 13 | 14 | path := TmpDir(t, "") 15 | assert.Equal(t, Exists(t, path), true, 16 | "TmpDir should create a directory") 17 | } 18 | 19 | func TestTmpFile(t *testing.T) { 20 | defer CleanUp(t) 21 | 22 | // Test that file is actually created 23 | file := TmpFile(t, "", "") 24 | assert.Equal(t, Exists(t, file.Name()), true, 25 | "TmpFile should create the file") 26 | 27 | // Test that the content exists in the file 28 | file = TmpFile(t, "", "hey there") 29 | result := FileSays(t, file.Name(), []byte("hey there")) 30 | assert.Equal(t, result, true, 31 | "TmpFile should create a file with content") 32 | } 33 | 34 | func TestFile(t *testing.T) { 35 | defer CleanUp(t) 36 | 37 | // Test that file is actually created 38 | file := File(t, "conf.yaml", "") 39 | require.FileExists(t, file.Name(), "File should create the file") 40 | 41 | // Test that the content exists in the file 42 | file = File(t, "conf.yaml", "hey there") 43 | result := FileSays(t, file.Name(), []byte("hey there")) 44 | assert.True(t, result, "File should create a file with content") 45 | } 46 | 47 | func TestFileSays(t *testing.T) { 48 | defer CleanUp(t) 49 | 50 | file := TmpFile(t, "", "Gandhi") 51 | assert.Equal(t, FileSays(t, file.Name(), []byte("Gandhi")), true, 52 | "FileSays can correctly read a file.") 53 | assert.Equal(t, FileSays(t, file.Name(), []byte("nope!")), false, 54 | "FileSays can correctly tell when a file does not contain content.") 55 | 56 | newT := testing.T{} 57 | FileSays(&newT, "IdontEx", []byte("hi")) 58 | assert.Equal(t, newT.Failed(), true, 59 | "FileSays should fail the testing interface") 60 | } 61 | 62 | func TestExists(t *testing.T) { 63 | defer CleanUp(t) 64 | 65 | file := TmpFile(t, "", "I exist") 66 | assert.Equal(t, Exists(t, file.Name()), true, 67 | "Exists should correctly tell if a path exists") 68 | assert.Equal(t, Exists(t, "blahblahblah"), false, 69 | "Exists should correctly tell if a path does not exist") 70 | } 71 | 72 | func TestDirContains(t *testing.T) { 73 | defer CleanUp(t) 74 | 75 | dir := TmpDir(t, "") 76 | filePath := filepath.Base(TmpFile(t, dir, "").Name()) 77 | assert.Equal(t, DirContains(t, dir, filePath), true, 78 | "DirContains should correctly identify a file inside of a folder.") 79 | assert.Equal(t, DirContains(t, dir, "blahlleijiow"), false, 80 | "DirContains should correctly identify a file not inside of a folder.") 81 | } 82 | 83 | func TestCleanUp(t *testing.T) { 84 | defer CleanUp(t) // Kind of problematic. 85 | 86 | // Clear Files 87 | Files = make([]string, 0) 88 | 89 | // Create test files 90 | dir := TmpDir(t, "") 91 | secondDir := TmpDir(t, "") 92 | 93 | // Clean up and test that the files are gone 94 | CleanUp(t) 95 | assert.Equal(t, Exists(t, dir), false, "CleanUp should remove files.") 96 | assert.Equal(t, Exists(t, secondDir), false, "CleanUp should remove files.") 97 | 98 | // Create a new file and test that it's there. 99 | newDir := TmpDir(t, "") 100 | assert.Equal(t, Exists(t, newDir), true, 101 | "New files still exist after CleanUp") 102 | } 103 | --------------------------------------------------------------------------------