|
| 1 | +package cache |
| 2 | + |
| 3 | +import ( |
| 4 | + "errors" |
| 5 | + "os" |
| 6 | + "testing" |
| 7 | + |
| 8 | + "github.com/adrg/xdg" |
| 9 | + "github.com/google/uuid" |
| 10 | +) |
| 11 | + |
| 12 | +func TestGetObject(t *testing.T) { |
| 13 | + tests := []struct { |
| 14 | + description string |
| 15 | + identifier string |
| 16 | + expectFile bool |
| 17 | + expectedErr error |
| 18 | + }{ |
| 19 | + { |
| 20 | + description: "identifier exists", |
| 21 | + identifier: "test-cache-get-exists", |
| 22 | + expectFile: true, |
| 23 | + expectedErr: nil, |
| 24 | + }, |
| 25 | + { |
| 26 | + description: "identifier does not exist", |
| 27 | + identifier: "test-cache-get-not-exists", |
| 28 | + expectFile: false, |
| 29 | + expectedErr: os.ErrNotExist, |
| 30 | + }, |
| 31 | + { |
| 32 | + description: "identifier is invalid", |
| 33 | + identifier: "in../../valid", |
| 34 | + expectFile: false, |
| 35 | + expectedErr: ErrorInvalidCacheIdentifier, |
| 36 | + }, |
| 37 | + } |
| 38 | + |
| 39 | + for _, tt := range tests { |
| 40 | + t.Run(tt.description, func(t *testing.T) { |
| 41 | + id := tt.identifier + "-" + uuid.NewString() |
| 42 | + |
| 43 | + // setup |
| 44 | + if tt.expectFile { |
| 45 | + err := createFolderIfNotExists(cacheFolderPath) |
| 46 | + if err != nil { |
| 47 | + t.Fatalf("create cache folder: %s", err.Error()) |
| 48 | + } |
| 49 | + path := cacheFolderPath + "/" + id |
| 50 | + if err := os.WriteFile(path, []byte("dummy"), 0o600); err != nil { |
| 51 | + t.Fatalf("setup: WriteFile (%s) failed", path) |
| 52 | + } |
| 53 | + } |
| 54 | + // test |
| 55 | + file, err := GetObject(id) |
| 56 | + |
| 57 | + if tt.expectedErr == os.ErrNotExist { |
| 58 | + if !os.IsNotExist(err) { |
| 59 | + t.Fatalf("expected err did not match ErrNotExist") |
| 60 | + } |
| 61 | + } else if !errors.Is(err, tt.expectedErr) { |
| 62 | + t.Fatalf("returned error (%q) does not match %q", err.Error(), tt.expectedErr.Error()) |
| 63 | + } |
| 64 | + |
| 65 | + if tt.expectFile { |
| 66 | + if len(file) < 1 { |
| 67 | + t.Fatalf("expected a file but byte array is empty (len %d)", len(file)) |
| 68 | + } |
| 69 | + } else { |
| 70 | + if len(file) > 0 { |
| 71 | + t.Fatalf("didn't expect a file, but byte array is not empty (len %d)", len(file)) |
| 72 | + } |
| 73 | + } |
| 74 | + }) |
| 75 | + } |
| 76 | +} |
| 77 | +func TestPutObject(t *testing.T) { |
| 78 | + // Also test createFolderIfNotExists here |
| 79 | + tests := []struct { |
| 80 | + description string |
| 81 | + identifier string |
| 82 | + existingFile bool |
| 83 | + expectFile bool |
| 84 | + expectedErr error |
| 85 | + customPath string |
| 86 | + }{ |
| 87 | + { |
| 88 | + description: "identifier already exists", |
| 89 | + identifier: "test-cache-put-exists", |
| 90 | + existingFile: true, |
| 91 | + expectFile: true, |
| 92 | + expectedErr: nil, |
| 93 | + }, |
| 94 | + { |
| 95 | + description: "identifier does not exist", |
| 96 | + identifier: "test-cache-put-not-exists", |
| 97 | + expectFile: true, |
| 98 | + expectedErr: nil, |
| 99 | + }, |
| 100 | + { |
| 101 | + description: "identifier is invalid", |
| 102 | + identifier: "in../../valid", |
| 103 | + expectFile: false, |
| 104 | + expectedErr: ErrorInvalidCacheIdentifier, |
| 105 | + }, |
| 106 | + { |
| 107 | + description: "directory does not yet exist", |
| 108 | + identifier: "test-cache-put-folder-not-exists", |
| 109 | + expectFile: true, |
| 110 | + expectedErr: nil, |
| 111 | + customPath: "/tmp/stackit-cli-test", |
| 112 | + }, |
| 113 | + } |
| 114 | + |
| 115 | + for _, tt := range tests { |
| 116 | + t.Run(tt.description, func(t *testing.T) { |
| 117 | + id := tt.identifier + "-" + uuid.NewString() |
| 118 | + if tt.customPath != "" { |
| 119 | + cacheFolderPath = tt.customPath |
| 120 | + } else { |
| 121 | + cacheFolderPath = xdg.CacheHome |
| 122 | + } |
| 123 | + path := cacheFolderPath + "/" + id |
| 124 | + |
| 125 | + // setup |
| 126 | + if tt.existingFile { |
| 127 | + if err := os.WriteFile(path, []byte("dummy"), 0o600); err != nil { |
| 128 | + t.Fatalf("setup: WriteFile (%s) failed", path) |
| 129 | + } |
| 130 | + } |
| 131 | + // test |
| 132 | + err := PutObject(id, []byte("dummy")) |
| 133 | + |
| 134 | + if tt.expectedErr == os.ErrNotExist { |
| 135 | + if !os.IsNotExist(err) { |
| 136 | + t.Fatalf("expected err did not match ErrNotExist") |
| 137 | + } |
| 138 | + } else if !errors.Is(err, tt.expectedErr) { |
| 139 | + t.Fatalf("returned error (%q) does not match %q", err.Error(), tt.expectedErr.Error()) |
| 140 | + } |
| 141 | + |
| 142 | + if tt.expectFile { |
| 143 | + if _, err := os.Stat(path); errors.Is(err, os.ErrNotExist) { |
| 144 | + t.Fatalf("expected file (%q) to exist", path) |
| 145 | + } |
| 146 | + } |
| 147 | + }) |
| 148 | + } |
| 149 | +} |
| 150 | + |
| 151 | +func TestDeleteObject(t *testing.T) { |
| 152 | + tests := []struct { |
| 153 | + description string |
| 154 | + identifier string |
| 155 | + existingFile bool |
| 156 | + expectedErr error |
| 157 | + }{ |
| 158 | + { |
| 159 | + description: "identifier exists", |
| 160 | + identifier: "test-cache-delete-exists", |
| 161 | + existingFile: true, |
| 162 | + expectedErr: nil, |
| 163 | + }, |
| 164 | + { |
| 165 | + description: "identifier does not exist", |
| 166 | + identifier: "test-cache-delete-not-exists", |
| 167 | + existingFile: false, |
| 168 | + expectedErr: nil, |
| 169 | + }, |
| 170 | + { |
| 171 | + description: "identifier is invalid", |
| 172 | + identifier: "in../../valid", |
| 173 | + existingFile: false, |
| 174 | + expectedErr: ErrorInvalidCacheIdentifier, |
| 175 | + }, |
| 176 | + } |
| 177 | + |
| 178 | + for _, tt := range tests { |
| 179 | + t.Run(tt.description, func(t *testing.T) { |
| 180 | + id := tt.identifier + "-" + uuid.NewString() |
| 181 | + path := cacheFolderPath + "/" + id |
| 182 | + |
| 183 | + // setup |
| 184 | + if tt.existingFile { |
| 185 | + if err := os.WriteFile(path, []byte("dummy"), 0o600); err != nil { |
| 186 | + t.Fatalf("setup: WriteFile (%s) failed", path) |
| 187 | + } |
| 188 | + } |
| 189 | + // test |
| 190 | + err := DeleteObject(id) |
| 191 | + |
| 192 | + if tt.expectedErr == os.ErrNotExist { |
| 193 | + if !os.IsNotExist(err) { |
| 194 | + t.Fatalf("expected err did not match ErrNotExist") |
| 195 | + } |
| 196 | + } else if !errors.Is(err, tt.expectedErr) { |
| 197 | + t.Fatalf("returned error (%q) does not match %q", err.Error(), tt.expectedErr.Error()) |
| 198 | + } |
| 199 | + |
| 200 | + if tt.existingFile { |
| 201 | + if _, err := os.Stat(path); !errors.Is(err, os.ErrNotExist) { |
| 202 | + t.Fatalf("expected file (%q) to not exist", path) |
| 203 | + } |
| 204 | + } |
| 205 | + }) |
| 206 | + } |
| 207 | +} |
0 commit comments