git-ar 1.1.12

Git all remotes. Git cli tool that targets both Github and Gitlab. Brings common development operations such as opening a pull request down to the shell. This is an alternative to both Github https://github.com/cli/cli and Gitlab https://gitlab.com/gitlab-org/cli cli tools.
Documentation 
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

use gr::error::GRError;
use std::path::PathBuf;
use std::{fs, sync::Arc};
use tempfile::TempDir;

use gr::{
    api_traits::ApiOperation,
    cache::{filesystem::FileCache, Cache, CacheState},
    config::ConfigProperties,
    http::{Headers, Resource},
    io::{HttpResponse, ResponseField},
};

struct TestConfig {
    cache_dir: PathBuf,
}

impl ConfigProperties for TestConfig {
    fn api_token(&self) -> &str {
        "test_token"
    }

    fn cache_location(&self) -> Option<&str> {
        Some(self.cache_dir.to_str().unwrap())
    }

    fn get_cache_expiration(&self, _: &ApiOperation) -> &str {
        "3600s"
    }
}

#[test]
fn test_file_cache_fresh() {
    // Create a temporary directory for our cache
    let temp_dir = TempDir::new().unwrap();
    let config = TestConfig {
        cache_dir: temp_dir.path().to_path_buf(),
    };

    let file_cache = FileCache::new(Arc::new(config));

    let resource = Resource::new("https://api.example.com/test", Some(ApiOperation::Project));

    let response = HttpResponse::builder()
        .status(200)
        .body("Test response body".to_string())
        .headers({
            let mut h = Headers::new();
            h.set(
                "cache-control".to_string(),
                "max-age=7200, no-cache".to_string(),
            );
            h
        })
        .build()
        .unwrap();

    file_cache.set(&resource, &response).unwrap();

    // Verify the cache file was created
    let cache_file = file_cache.get_cache_file(&resource.url);
    assert!(fs::metadata(&cache_file).is_ok());

    // Test getting a fresh value from the cache
    match file_cache.get(&resource).unwrap() {
        CacheState::Fresh(cached_response) => {
            assert_eq!(cached_response.status, 200);
            assert_eq!(cached_response.body, "Test response body");
            assert_eq!(
                cached_response
                    .headers
                    .unwrap()
                    .get("cache-control")
                    .unwrap(),
                "max-age=7200, no-cache"
            );
        }
        _ => panic!("Expected a fresh cache state"),
    }
}

#[test]
fn test_file_cache_stale_user_expired_no_cache() {
    let temp_dir = TempDir::new().unwrap();
    let config = TestConfig {
        cache_dir: temp_dir.path().to_path_buf(),
    };

    let file_cache = FileCache::new(Arc::new(config));

    let resource = Resource::new("https://api.example.com/test", Some(ApiOperation::Project));

    let response = HttpResponse::builder()
        .status(200)
        .body("Test response body".to_string())
        .headers({
            let mut h = Headers::new();
            h.set(
                "cache-control".to_string(),
                "max-age=7200, no-cache".to_string(),
            );
            h
        })
        .build()
        .unwrap();

    file_cache.set(&resource, &response).unwrap();

    let cache_file = file_cache.get_cache_file(&resource.url);

    // Simulate passage of time (beyond user-defined expiration)
    let cache_file_path = PathBuf::from(cache_file);
    let metadata = fs::metadata(&cache_file_path).unwrap();
    let mtime = metadata.modified().unwrap() - std::time::Duration::from_secs(4000);
    filetime::set_file_mtime(&cache_file_path, filetime::FileTime::from(mtime)).unwrap();

    // Test getting a stale value from the cache (due to user expiration). Cache
    // control contains no-cache directive, so the cache should be considered stale.
    match file_cache.get(&resource).unwrap() {
        CacheState::Stale(cached_response) => {
            assert_eq!(cached_response.status, 200);
            assert_eq!(cached_response.body, "Test response body");
        }
        _ => panic!("Expected a stale cache state"),
    }
}

#[test]
fn test_file_cache_fresh_user_expired_but_under_max_age() {
    let temp_dir = TempDir::new().unwrap();
    let config = TestConfig {
        cache_dir: temp_dir.path().to_path_buf(),
    };

    let file_cache = FileCache::new(Arc::new(config));

    let resource = Resource::new("https://api.example.com/test", Some(ApiOperation::Project));

    let response = HttpResponse::builder()
        .status(200)
        .body("Test response body".to_string())
        .headers({
            let mut h = Headers::new();
            h.set("cache-control".to_string(), "max-age=7200".to_string());
            h
        })
        .build()
        .unwrap();

    file_cache.set(&resource, &response).unwrap();

    let cache_file = file_cache.get_cache_file(&resource.url);

    // Simulate passage of time (beyond user-defined expiration but within HTTP cache control)
    let cache_file_path = PathBuf::from(cache_file);
    let metadata = fs::metadata(&cache_file_path).unwrap();
    let mtime = metadata.modified().unwrap() - std::time::Duration::from_secs(4000);
    filetime::set_file_mtime(&cache_file_path, filetime::FileTime::from(mtime)).unwrap();

    match file_cache.get(&resource).unwrap() {
        CacheState::Fresh(cached_response) => {
            assert_eq!(cached_response.status, 200);
            assert_eq!(cached_response.body, "Test response body");
            assert_eq!(
                cached_response
                    .headers
                    .unwrap()
                    .get("cache-control")
                    .unwrap(),
                "max-age=7200"
            );
        }
        _ => panic!("Expected a fresh cache state"),
    }
}

#[test]
fn test_cache_stale_both_user_expired_and_max_aged_expired() {
    let temp_dir = TempDir::new().unwrap();
    let config = TestConfig {
        cache_dir: temp_dir.path().to_path_buf(),
    };

    let file_cache = FileCache::new(Arc::new(config));

    let resource = Resource::new("https://api.example.com/test", Some(ApiOperation::Project));

    let response = HttpResponse::builder()
        .status(200)
        .body("Test response body".to_string())
        .headers({
            let mut h = Headers::new();
            h.set("cache-control".to_string(), "max-age=7200".to_string());
            h
        })
        .build()
        .unwrap();

    file_cache.set(&resource, &response).unwrap();

    let cache_file = file_cache.get_cache_file(&resource.url);
    // Simulate passage of time (beyond both user-defined and HTTP cache control
    // expiration)
    let cache_file_path = PathBuf::from(cache_file);
    let metadata = fs::metadata(&cache_file_path).unwrap();
    let mtime = metadata.modified().unwrap() - std::time::Duration::from_secs(8000);
    filetime::set_file_mtime(cache_file_path, filetime::FileTime::from(mtime)).unwrap();

    // Test getting a stale value from the cache (due to both expirations)
    match file_cache.get(&resource).unwrap() {
        CacheState::Stale(cached_response) => {
            assert_eq!(cached_response.status, 200);
            assert_eq!(cached_response.body, "Test response body");
        }
        _ => panic!("Expected a stale cache state"),
    }
}

#[test]
fn test_cache_update_refreshes_cache() {
    let temp_dir = TempDir::new().unwrap();
    let config = TestConfig {
        cache_dir: temp_dir.path().to_path_buf(),
    };

    let file_cache = FileCache::new(Arc::new(config));

    let resource = Resource::new("https://api.example.com/test", Some(ApiOperation::Project));

    // First response
    let response = HttpResponse::builder()
        .status(200)
        .body("Test response body".to_string())
        .headers({
            let mut h = Headers::new();
            h.set("cache-control".to_string(), "max-age=7200".to_string());
            h
        })
        .build()
        .unwrap();

    file_cache.set(&resource, &response).unwrap();

    // Second call, we get a 304 response
    let new_response = HttpResponse::builder()
        .status(304)
        .headers(Headers::new())
        .build()
        .unwrap();

    // Update the cache with new headers
    file_cache
        .update(&resource, &new_response, &ResponseField::Headers)
        .unwrap();

    // Cache gets refreshed, so we should get a fresh cache state
    match file_cache.get(&resource).unwrap() {
        CacheState::Fresh(cached_response) => {
            assert_eq!(cached_response.status, 200);
            assert_eq!(cached_response.body, "Test response body");
        }
        _ => panic!("Expected a fresh cache state"),
    }
}

#[test]
fn test_validate_cache_location_success() {
    let temp_dir = TempDir::new().unwrap();
    let config = TestConfig {
        cache_dir: temp_dir.path().to_path_buf(),
    };

    let file_cache = FileCache::new(Arc::new(config));
    assert!(file_cache.validate_cache_location().is_ok());
}

#[test]
fn test_validate_cache_location_not_found() {
    let config = TestConfig {
        cache_dir: PathBuf::from("/non/existent/directory"),
    };

    let file_cache = FileCache::new(Arc::new(config));
    let err = file_cache.validate_cache_location().unwrap_err();
    match err.downcast_ref::<GRError>() {
        Some(GRError::CacheLocationDoesNotExist(msg)) => {
            assert!(msg.contains("/non/existent/directory"));
        }
        _ => panic!("Expected CacheLocationDoesNotExist error"),
    }
}

#[test]
fn test_validate_cache_location_not_a_directory() {
    let temp_dir = TempDir::new().unwrap();
    let temp_file = temp_dir.path().join("not_a_directory");
    fs::write(&temp_file, "").unwrap();

    let config = TestConfig {
        cache_dir: temp_file.clone(),
    };

    let file_cache = FileCache::new(Arc::new(config));
    let err = file_cache.validate_cache_location().unwrap_err();
    match err.downcast_ref::<GRError>() {
        Some(GRError::CacheLocationIsNotADirectory(msg)) => {
            assert!(msg.contains(temp_file.to_string_lossy().as_ref()));
        }
        _ => panic!("Expected CacheLocationIsNotADirectory error"),
    }
}

#[test]
fn test_validate_cache_location_not_writable() {
    let temp_dir = TempDir::new().unwrap();
    let cache_dir = temp_dir.path().to_path_buf();

    // Make the directory read-only
    let mut perms = fs::metadata(&cache_dir).unwrap().permissions();
    perms.set_readonly(true);
    fs::set_permissions(&cache_dir, perms).unwrap();

    let config = TestConfig {
        cache_dir: cache_dir.clone(),
    };

    let file_cache = FileCache::new(Arc::new(config));
    let err = file_cache.validate_cache_location().unwrap_err();
    match err.downcast_ref::<GRError>() {
        Some(GRError::CacheLocationIsNotWriteable(msg)) => {
            assert!(msg.contains(cache_dir.to_string_lossy().as_ref()));
        }
        _ => panic!("Expected CacheLocationIsNotWriteable error"),
    }

    // Restore permissions for cleanup
    let mut perms = fs::metadata(&cache_dir).unwrap().permissions();
    perms.set_readonly(false);
    fs::set_permissions(&cache_dir, perms).unwrap();
}

#[test]
fn test_validate_cache_location_config_not_found() {
    struct NoConfig;

    impl ConfigProperties for NoConfig {
        fn api_token(&self) -> &str {
            "test_token"
        }

        fn cache_location(&self) -> Option<&str> {
            None
        }

        fn get_cache_expiration(&self, _: &ApiOperation) -> &str {
            "3600s"
        }
    }

    let file_cache = FileCache::new(Arc::new(NoConfig));
    let err = file_cache.validate_cache_location().unwrap_err();
    match err.downcast_ref::<GRError>() {
        Some(GRError::ConfigurationNotFound) => {}
        _ => panic!("Expected ConfigurationNotFound error"),
    }
}