-
Notifications
You must be signed in to change notification settings - Fork 36
Expand file tree
/
Copy pathtoken_cache_test.go
More file actions
615 lines (471 loc) · 15.6 KB
/
token_cache_test.go
File metadata and controls
615 lines (471 loc) · 15.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
// Copyright AGNTCY Contributors (https://github.com/agntcy)
// SPDX-License-Identifier: Apache-2.0
package client
import (
"encoding/json"
"os"
"path/filepath"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestNewTokenCache(t *testing.T) {
t.Run("should create cache with default directory", func(t *testing.T) {
cache := NewTokenCache()
require.NotNil(t, cache)
assert.NotEmpty(t, cache.CacheDir)
assert.Contains(t, cache.CacheDir, DefaultTokenCacheDir)
})
t.Run("should include home directory in path", func(t *testing.T) {
cache := NewTokenCache()
home, err := os.UserHomeDir()
require.NoError(t, err)
expectedPath := filepath.Join(home, DefaultTokenCacheDir)
assert.Equal(t, expectedPath, cache.CacheDir)
})
}
func TestNewTokenCacheWithDir(t *testing.T) {
t.Run("should create cache with custom directory", func(t *testing.T) {
customDir := "/tmp/test-cache"
cache := NewTokenCacheWithDir(customDir)
require.NotNil(t, cache)
assert.Equal(t, customDir, cache.CacheDir)
})
t.Run("should accept empty directory", func(t *testing.T) {
cache := NewTokenCacheWithDir("")
require.NotNil(t, cache)
assert.Empty(t, cache.CacheDir)
})
}
func TestTokenCache_GetCachePath(t *testing.T) {
t.Run("should return full path to cache file", func(t *testing.T) {
customDir := "/tmp/test-cache"
cache := NewTokenCacheWithDir(customDir)
path := cache.GetCachePath()
expectedPath := filepath.Join(customDir, TokenCacheFile)
assert.Equal(t, expectedPath, path)
})
t.Run("should handle trailing slash in directory", func(t *testing.T) {
cache := NewTokenCacheWithDir("/tmp/test-cache/")
path := cache.GetCachePath()
assert.Contains(t, path, TokenCacheFile)
})
}
func TestTokenCache_Save(t *testing.T) {
t.Run("should save token to cache", func(t *testing.T) {
// Create temporary directory for test
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
token := &CachedToken{
AccessToken: "test_token_123",
TokenType: "bearer",
Provider: "github",
User: "testuser",
ExpiresAt: time.Now().Add(time.Hour),
}
err := cache.Save(token)
require.NoError(t, err)
// Verify file exists
path := cache.GetCachePath()
_, statErr := os.Stat(path)
assert.NoError(t, statErr)
})
t.Run("should create directory if it doesn't exist", func(t *testing.T) {
tmpDir := filepath.Join(t.TempDir(), "nested", "dir")
cache := NewTokenCacheWithDir(tmpDir)
token := &CachedToken{
AccessToken: "test_token_123",
}
err := cache.Save(token)
require.NoError(t, err)
// Verify directory was created
_, statErr := os.Stat(tmpDir)
assert.NoError(t, statErr)
})
t.Run("should set CreatedAt if not set", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
token := &CachedToken{
AccessToken: "test_token_123",
// CreatedAt is zero
}
before := time.Now()
err := cache.Save(token)
after := time.Now()
require.NoError(t, err)
assert.False(t, token.CreatedAt.IsZero())
assert.True(t, token.CreatedAt.After(before.Add(-time.Second)))
assert.True(t, token.CreatedAt.Before(after.Add(time.Second)))
})
t.Run("should preserve existing CreatedAt", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
createdAt := time.Now().Add(-24 * time.Hour)
token := &CachedToken{
AccessToken: "test_token_123",
CreatedAt: createdAt,
}
err := cache.Save(token)
require.NoError(t, err)
assert.Equal(t, createdAt, token.CreatedAt)
})
t.Run("should write JSON with proper formatting", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
token := &CachedToken{
AccessToken: "test_token_123",
User: "testuser",
}
err := cache.Save(token)
require.NoError(t, err)
// Read and verify JSON formatting
data, readErr := os.ReadFile(cache.GetCachePath())
require.NoError(t, readErr)
// Should be indented JSON
assert.Contains(t, string(data), "\n")
assert.Contains(t, string(data), " ")
})
t.Run("should set secure file permissions", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
token := &CachedToken{
AccessToken: "test_token_123",
}
err := cache.Save(token)
require.NoError(t, err)
// Check file permissions
info, statErr := os.Stat(cache.GetCachePath())
require.NoError(t, statErr)
// Should be 0600 (owner read/write only)
assert.Equal(t, os.FileMode(0o600), info.Mode().Perm())
})
}
func TestTokenCache_Load(t *testing.T) {
t.Run("should load token from cache", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Save token first
originalToken := &CachedToken{
AccessToken: "test_token_123",
TokenType: "bearer",
Provider: "github",
User: "testuser",
Email: "test@example.com",
ExpiresAt: time.Now().Add(time.Hour),
}
err := cache.Save(originalToken)
require.NoError(t, err)
// Load token
loadedToken, loadErr := cache.Load()
require.NoError(t, loadErr)
require.NotNil(t, loadedToken)
assert.Equal(t, originalToken.AccessToken, loadedToken.AccessToken)
assert.Equal(t, originalToken.TokenType, loadedToken.TokenType)
assert.Equal(t, originalToken.Provider, loadedToken.Provider)
assert.Equal(t, originalToken.User, loadedToken.User)
assert.Equal(t, originalToken.Email, loadedToken.Email)
})
t.Run("should round-trip OIDC token with Issuer and RefreshToken", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
//nolint:gosec // G101: test fixture values, not real credentials
originalToken := &CachedToken{
AccessToken: "oidc_access_token",
TokenType: "bearer",
Provider: "oidc",
Issuer: "https://tenant.zitadel.cloud",
RefreshToken: "oidc_refresh_token",
User: "user@example.com",
UserID: "sub-123",
ExpiresAt: time.Now().Add(time.Hour),
}
err := cache.Save(originalToken)
require.NoError(t, err)
loadedToken, loadErr := cache.Load()
require.NoError(t, loadErr)
require.NotNil(t, loadedToken)
assert.Equal(t, "oidc", loadedToken.Provider)
assert.Equal(t, "https://tenant.zitadel.cloud", loadedToken.Issuer)
assert.Equal(t, "oidc_refresh_token", loadedToken.RefreshToken)
assert.Equal(t, "user@example.com", loadedToken.User)
assert.Equal(t, "sub-123", loadedToken.UserID)
})
t.Run("should return nil when cache doesn't exist", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
token, err := cache.Load()
require.NoError(t, err)
assert.Nil(t, token)
})
t.Run("should error on malformed JSON", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Write invalid JSON
err := os.MkdirAll(tmpDir, cacheDirPerms)
require.NoError(t, err)
invalidJSON := []byte("{invalid json")
writeErr := os.WriteFile(cache.GetCachePath(), invalidJSON, cacheFilePerms)
require.NoError(t, writeErr)
// Try to load
token, loadErr := cache.Load()
require.Error(t, loadErr)
assert.Nil(t, token)
assert.Contains(t, loadErr.Error(), "failed to parse token cache")
})
t.Run("should handle empty file", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Write empty file
err := os.MkdirAll(tmpDir, cacheDirPerms)
require.NoError(t, err)
writeErr := os.WriteFile(cache.GetCachePath(), []byte(""), cacheFilePerms)
require.NoError(t, writeErr)
// Try to load
token, loadErr := cache.Load()
require.Error(t, loadErr)
assert.Nil(t, token)
})
}
func TestTokenCache_Clear(t *testing.T) {
t.Run("should remove cached token", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Save token first
token := &CachedToken{AccessToken: "test_token"}
err := cache.Save(token)
require.NoError(t, err)
// Clear cache
clearErr := cache.Clear()
require.NoError(t, clearErr)
// Verify file is gone
_, statErr := os.Stat(cache.GetCachePath())
assert.True(t, os.IsNotExist(statErr))
})
t.Run("should not error if cache doesn't exist", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Clear non-existent cache
err := cache.Clear()
assert.NoError(t, err)
})
t.Run("should error if file cannot be removed", func(t *testing.T) {
// This test is platform-dependent, skip on Windows
if os.PathSeparator == '\\' {
t.Skip("Skipping on Windows")
}
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Save token
token := &CachedToken{AccessToken: "test_token"}
err := cache.Save(token)
require.NoError(t, err)
// Make directory read-only to prevent file deletion
chmodErr := os.Chmod(tmpDir, 0o500)
require.NoError(t, chmodErr)
defer func() {
// Restore permissions for cleanup
_ = os.Chmod(tmpDir, cacheDirPerms)
}()
// Try to clear (should fail)
clearErr := cache.Clear()
assert.Error(t, clearErr)
})
}
func TestTokenCache_IsValid(t *testing.T) {
t.Run("should return false for nil token", func(t *testing.T) {
cache := NewTokenCache()
valid := cache.IsValid(nil)
assert.False(t, valid)
})
t.Run("should return false for empty access token", func(t *testing.T) {
cache := NewTokenCache()
token := &CachedToken{
AccessToken: "",
}
valid := cache.IsValid(token)
assert.False(t, valid)
})
t.Run("should return true for valid token with future expiry", func(t *testing.T) {
cache := NewTokenCache()
token := &CachedToken{
AccessToken: "test_token",
ExpiresAt: time.Now().Add(time.Hour),
}
valid := cache.IsValid(token)
assert.True(t, valid)
})
t.Run("should return false for expired token", func(t *testing.T) {
cache := NewTokenCache()
token := &CachedToken{
AccessToken: "test_token",
ExpiresAt: time.Now().Add(-time.Hour),
}
valid := cache.IsValid(token)
assert.False(t, valid)
})
t.Run("should return false for token expiring within buffer", func(t *testing.T) {
cache := NewTokenCache()
// Token expires in 4 minutes (less than 5-minute buffer)
token := &CachedToken{
AccessToken: "test_token",
ExpiresAt: time.Now().Add(4 * time.Minute),
}
valid := cache.IsValid(token)
assert.False(t, valid)
})
t.Run("should use CreatedAt for tokens without expiry", func(t *testing.T) {
cache := NewTokenCache()
// Token created 1 hour ago, should be valid (default 8 hours)
token := &CachedToken{
AccessToken: "test_token",
CreatedAt: time.Now().Add(-time.Hour),
// ExpiresAt is zero
}
valid := cache.IsValid(token)
assert.True(t, valid)
})
t.Run("should return false for old token without expiry", func(t *testing.T) {
cache := NewTokenCache()
// Token created 9 hours ago, should be expired (default 8 hours)
token := &CachedToken{
AccessToken: "test_token",
CreatedAt: time.Now().Add(-9 * time.Hour),
// ExpiresAt is zero
}
valid := cache.IsValid(token)
assert.False(t, valid)
})
t.Run("should handle token at exact expiry boundary", func(t *testing.T) {
cache := NewTokenCache()
// Token expires exactly at buffer time (5 minutes from now)
token := &CachedToken{
AccessToken: "test_token",
ExpiresAt: time.Now().Add(TokenExpiryBuffer),
}
valid := cache.IsValid(token)
// Should be considered expired (not valid)
assert.False(t, valid)
})
}
func TestTokenCache_GetValidToken(t *testing.T) {
t.Run("should return valid token", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Save valid token
originalToken := &CachedToken{
AccessToken: "test_token",
ExpiresAt: time.Now().Add(time.Hour),
}
err := cache.Save(originalToken)
require.NoError(t, err)
// Get valid token
token, getErr := cache.GetValidToken()
require.NoError(t, getErr)
require.NotNil(t, token)
assert.Equal(t, originalToken.AccessToken, token.AccessToken)
})
t.Run("should return nil for expired token", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Save expired token
expiredToken := &CachedToken{
AccessToken: "test_token",
ExpiresAt: time.Now().Add(-time.Hour),
CreatedAt: time.Now().Add(-time.Hour),
}
err := cache.Save(expiredToken)
require.NoError(t, err)
// Get valid token
token, getErr := cache.GetValidToken()
require.NoError(t, getErr)
assert.Nil(t, token)
})
t.Run("should return nil when no cache exists", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Get valid token without saving first
token, err := cache.GetValidToken()
require.NoError(t, err)
assert.Nil(t, token)
})
t.Run("should return error for malformed cache", func(t *testing.T) {
tmpDir := t.TempDir()
cache := NewTokenCacheWithDir(tmpDir)
// Write invalid JSON
err := os.MkdirAll(tmpDir, cacheDirPerms)
require.NoError(t, err)
writeErr := os.WriteFile(cache.GetCachePath(), []byte("{invalid}"), cacheFilePerms)
require.NoError(t, writeErr)
// Try to get valid token
token, getErr := cache.GetValidToken()
require.Error(t, getErr)
assert.Nil(t, token)
})
}
func TestCachedToken_JSONSerialization(t *testing.T) {
t.Run("should serialize and deserialize correctly", func(t *testing.T) {
now := time.Now()
original := &CachedToken{
AccessToken: "test_token_123",
TokenType: "bearer",
Provider: "github",
ExpiresAt: now.Add(time.Hour),
User: "testuser",
UserID: "12345",
Email: "test@example.com",
CreatedAt: now,
}
// Marshal to JSON
data, err := json.Marshal(original) // #nosec G117: intentional field - for cached token
require.NoError(t, err)
// Unmarshal back
var decoded CachedToken
unmarshalErr := json.Unmarshal(data, &decoded)
require.NoError(t, unmarshalErr)
assert.Equal(t, original.AccessToken, decoded.AccessToken)
assert.Equal(t, original.TokenType, decoded.TokenType)
assert.Equal(t, original.Provider, decoded.Provider)
assert.Equal(t, original.User, decoded.User)
assert.Equal(t, original.UserID, decoded.UserID)
assert.Equal(t, original.Email, decoded.Email)
// Time comparison with truncation for JSON precision
assert.True(t, original.ExpiresAt.Truncate(time.Second).Equal(decoded.ExpiresAt.Truncate(time.Second)))
assert.True(t, original.CreatedAt.Truncate(time.Second).Equal(decoded.CreatedAt.Truncate(time.Second)))
})
t.Run("should omit empty optional fields", func(t *testing.T) {
token := &CachedToken{
AccessToken: "test_token",
CreatedAt: time.Now(),
}
data, err := json.Marshal(token) // #nosec G117: intentional field - for cached token
require.NoError(t, err)
// Should not contain omitted fields
jsonStr := string(data)
assert.NotContains(t, jsonStr, "token_type")
assert.NotContains(t, jsonStr, "provider")
assert.NotContains(t, jsonStr, "user")
assert.NotContains(t, jsonStr, "user_id")
assert.NotContains(t, jsonStr, "email")
})
t.Run("should handle zero time with omitzero", func(t *testing.T) {
token := &CachedToken{
AccessToken: "test_token",
CreatedAt: time.Now(),
// ExpiresAt is zero
}
data, err := json.Marshal(token) // #nosec G117: intentional field - for cached token
require.NoError(t, err)
// Should not contain expires_at
jsonStr := string(data)
assert.NotContains(t, jsonStr, "expires_at")
})
}
func TestTokenCacheConstants(t *testing.T) {
t.Run("should have reasonable default values", func(t *testing.T) {
assert.Equal(t, ".config/dirctl", DefaultTokenCacheDir)
assert.Equal(t, "auth-token.json", TokenCacheFile)
assert.Equal(t, 8*time.Hour, DefaultTokenValidityDuration)
assert.Equal(t, 5*time.Minute, TokenExpiryBuffer)
})
}