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
use crate::build::{ConstType, ConstVal, ShadowConst};
use crate::ci::CiType;
use crate::err::*;
use crate::time::BuildTime;
use crate::Format;
use chrono::SecondsFormat;
use std::collections::HashMap;
use std::io::{BufReader, Read};
use std::path::Path;
use std::process::{Command, Stdio};
pub const BRANCH: ShadowConst = "BRANCH";
pub(crate) const TAG: ShadowConst = "TAG";
const SHORT_COMMIT: ShadowConst = "SHORT_COMMIT";
const COMMIT_HASH: ShadowConst = "COMMIT_HASH";
const COMMIT_DATE: ShadowConst = "COMMIT_DATE";
const COMMIT_DATE_2822: ShadowConst = "COMMIT_DATE_2822";
const COMMIT_DATE_3339: ShadowConst = "COMMIT_DATE_3339";
const COMMIT_AUTHOR: ShadowConst = "COMMIT_AUTHOR";
const COMMIT_EMAIL: ShadowConst = "COMMIT_EMAIL";
const GIT_CLEAN: ShadowConst = "GIT_CLEAN";
const GIT_STATUS_FILE: ShadowConst = "GIT_STATUS_FILE";
#[derive(Default, Debug)]
pub struct Git {
map: HashMap<ShadowConst, ConstVal>,
ci_type: CiType,
}
impl Git {
fn update_str(&mut self, c: ShadowConst, v: String) {
if let Some(val) = self.map.get_mut(c) {
*val = ConstVal {
desc: val.desc.clone(),
v,
t: ConstType::Str,
}
}
}
fn update_bool(&mut self, c: ShadowConst, v: bool) {
if let Some(val) = self.map.get_mut(c) {
*val = ConstVal {
desc: val.desc.clone(),
v: v.to_string(),
t: ConstType::Bool,
}
}
}
fn init(&mut self, path: &Path, std_env: &HashMap<String, String>) -> SdResult<()> {
let x = command_git_clean();
self.update_bool(GIT_CLEAN, x);
let x = command_git_status_file();
self.update_str(GIT_STATUS_FILE, x);
self.init_git2(path)?;
if let Some(x) = command_current_branch() {
self.update_str(BRANCH, x)
};
if let Some(x) = command_current_tag() {
self.update_str(TAG, x)
}
self.ci_branch_tag(std_env);
Ok(())
}
fn init_git2(&mut self, path: &Path) -> SdResult<()> {
#[cfg(feature = "git2")]
{
use crate::git::git2_mod::git_repo;
use chrono::{DateTime, NaiveDateTime, Utc};
let repo = git_repo(path).map_err(ShadowError::new)?;
let reference = repo.head().map_err(ShadowError::new)?;
let branch = reference
.shorthand()
.map(|x| x.trim().to_string())
.or_else(command_current_branch)
.unwrap_or_default();
let tag = command_current_tag().unwrap_or_default();
self.update_str(BRANCH, branch);
self.update_str(TAG, tag);
if let Some(v) = reference.target() {
let commit = v.to_string();
self.update_str(COMMIT_HASH, commit.clone());
let mut short_commit = commit.as_str();
if commit.len() > 8 {
short_commit = &short_commit[0..8];
}
self.update_str(SHORT_COMMIT, short_commit.to_string());
}
let commit = reference.peel_to_commit().map_err(ShadowError::new)?;
let time_stamp = commit.time().seconds().to_string().parse::<i64>()?;
let dt = NaiveDateTime::from_timestamp(time_stamp, 0);
let date_time = BuildTime::Utc(DateTime::<Utc>::from_utc(dt, Utc));
self.update_str(COMMIT_DATE, date_time.human_format());
self.update_str(COMMIT_DATE_2822, date_time.to_rfc2822());
self.update_str(
COMMIT_DATE_3339,
date_time.to_rfc3339_opts(SecondsFormat::Secs, true),
);
let author = commit.author();
if let Some(v) = author.email() {
self.update_str(COMMIT_EMAIL, v.to_string());
}
if let Some(v) = author.name() {
self.update_str(COMMIT_AUTHOR, v.to_string());
}
let status_file = Self::git2_dirty_stage(&repo);
if status_file.trim().is_empty() {
self.update_bool(GIT_CLEAN, true);
} else {
self.update_bool(GIT_CLEAN, false);
}
self.update_str(GIT_STATUS_FILE, status_file);
}
Ok(())
}
#[cfg(feature = "git2")]
pub fn git2_dirty_stage(repo: &git2::Repository) -> String {
let mut repo_opts = git2::StatusOptions::new();
repo_opts.include_ignored(false);
if let Ok(statue) = repo.statuses(Some(&mut repo_opts)) {
let mut dirty_files = Vec::new();
let mut staged_files = Vec::new();
for status in statue.iter() {
if let Some(path) = status.path() {
match status.status() {
git2::Status::CURRENT => (),
git2::Status::INDEX_NEW
| git2::Status::INDEX_MODIFIED
| git2::Status::INDEX_DELETED
| git2::Status::INDEX_RENAMED
| git2::Status::INDEX_TYPECHANGE => staged_files.push(path.to_string()),
_ => dirty_files.push(path.to_string()),
};
}
}
filter_git_dirty_stage(dirty_files, staged_files)
} else {
"".into()
}
}
#[allow(clippy::manual_strip)]
fn ci_branch_tag(&mut self, std_env: &HashMap<String, String>) {
let mut branch: Option<String> = None;
let mut tag: Option<String> = None;
match self.ci_type {
CiType::Gitlab => {
if let Some(v) = std_env.get("CI_COMMIT_TAG") {
tag = Some(v.to_string());
} else if let Some(v) = std_env.get("CI_COMMIT_REF_NAME") {
branch = Some(v.to_string());
}
}
CiType::Github => {
if let Some(v) = std_env.get("GITHUB_REF") {
let ref_branch_prefix: &str = "refs/heads/";
let ref_tag_prefix: &str = "refs/tags/";
if v.starts_with(ref_branch_prefix) {
branch = Some(v[ref_branch_prefix.len()..].to_string())
} else if v.starts_with(ref_tag_prefix) {
tag = Some(v[ref_tag_prefix.len()..].to_string())
}
}
}
_ => {}
}
if let Some(x) = branch {
self.update_str(BRANCH, x);
}
if let Some(x) = tag {
self.update_str(TAG, x);
}
}
}
pub fn new_git(
path: &std::path::Path,
ci: CiType,
std_env: &HashMap<String, String>,
) -> HashMap<ShadowConst, ConstVal> {
let mut git = Git {
map: Default::default(),
ci_type: ci,
};
git.map
.insert(BRANCH, ConstVal::new("display current branch"));
git.map.insert(TAG, ConstVal::new("display current tag"));
git.map
.insert(COMMIT_HASH, ConstVal::new("display current commit_id"));
git.map.insert(
SHORT_COMMIT,
ConstVal::new("display current short commit_id"),
);
git.map.insert(
COMMIT_AUTHOR,
ConstVal::new("display current commit author"),
);
git.map
.insert(COMMIT_EMAIL, ConstVal::new("display current commit email"));
git.map
.insert(COMMIT_DATE, ConstVal::new("display current commit date"));
git.map.insert(
COMMIT_DATE_2822,
ConstVal::new("display current commit date by rfc2822"),
);
git.map.insert(
COMMIT_DATE_3339,
ConstVal::new("display current commit date by rfc3339"),
);
git.map.insert(
GIT_CLEAN,
ConstVal::new_bool("display current git repository status clean:'true or false'"),
);
git.map.insert(
GIT_STATUS_FILE,
ConstVal::new("display current git repository status files:'dirty or stage'"),
);
if let Err(e) = git.init(path, std_env) {
println!("{}", e.to_string());
}
git.map
}
#[cfg(feature = "git2")]
pub mod git2_mod {
use git2::Error as git2Error;
use git2::Repository;
use std::path::Path;
pub fn git_repo<P: AsRef<Path>>(path: P) -> Result<Repository, git2Error> {
git2::Repository::discover(path)
}
pub fn git2_current_branch(repo: &Repository) -> Option<String> {
repo.head()
.map(|x| x.shorthand().map(|x| x.to_string()))
.unwrap_or(None)
}
}
pub fn branch() -> String {
#[cfg(feature = "git2")]
{
use crate::git::git2_mod::{git2_current_branch, git_repo};
git_repo(".")
.map(|x| git2_current_branch(&x))
.unwrap_or_else(|_| command_current_branch())
.unwrap_or_default()
}
#[cfg(not(feature = "git2"))]
{
command_current_branch().unwrap_or_default()
}
}
pub fn tag() -> String {
command_current_tag().unwrap_or_default()
}
pub fn git_clean() -> bool {
#[cfg(feature = "git2")]
{
use crate::git::git2_mod::git_repo;
git_repo(".")
.map(|x| Git::git2_dirty_stage(&x))
.map(|x| x.trim().is_empty())
.unwrap_or(true)
}
#[cfg(not(feature = "git2"))]
{
command_git_clean()
}
}
pub fn git_status_file() -> String {
#[cfg(feature = "git2")]
{
use crate::git::git2_mod::git_repo;
git_repo(".")
.map(|x| Git::git2_dirty_stage(&x))
.unwrap_or_default()
}
#[cfg(not(feature = "git2"))]
{
command_git_status_file()
}
}
fn command_current_tag() -> Option<String> {
Command::new("git")
.args(&["tag", "-l", "--contains", "HEAD"])
.output()
.map(|x| String::from_utf8(x.stdout).ok())
.map(|x| x.map(|x| x.trim().to_string()))
.unwrap_or(None)
}
fn command_git_clean() -> bool {
Command::new("git")
.args(&["status", "--porcelain"])
.output()
.map(|x| String::from_utf8(x.stdout).ok())
.map(|x| x.map(|x| x.trim().to_string()))
.map(|x| x.is_none() || x.map(|y| y.is_empty()).unwrap_or_default())
.unwrap_or(true)
}
fn command_git_status_file() -> String {
let git_status_files =
move |args: &[&str], grep: &[&str], awk: &[&str]| -> SdResult<Vec<String>> {
let git_shell = Command::new("git")
.args(args)
.stdin(Stdio::piped())
.stdout(Stdio::piped())
.spawn()?;
let git_out = git_shell.stdout.ok_or("Failed to exec git stdout")?;
let grep_shell = Command::new("grep")
.args(grep)
.stdin(Stdio::from(git_out))
.stdout(Stdio::piped())
.spawn()?;
let grep_out = grep_shell.stdout.ok_or("Failed to exec grep stdout")?;
let mut awk_shell = Command::new("awk")
.args(awk)
.stdin(Stdio::from(grep_out))
.stdout(Stdio::piped())
.spawn()?;
let mut awk_out = BufReader::new(
awk_shell
.stdout
.as_mut()
.ok_or("Failed to exec awk stdout")?,
);
let mut line = String::new();
awk_out.read_to_string(&mut line)?;
Ok(line.lines().map(|x| x.into()).collect())
};
let dirty = git_status_files(&["status", "--porcelain"], &[r#"^\sM."#], &["{print $2}"])
.unwrap_or_default();
let stage = git_status_files(
&["status", "--porcelain", "--untracked-files=all"],
&[r#"^[A|M|D|R]"#],
&["{print $2}"],
)
.unwrap_or_default();
filter_git_dirty_stage(dirty, stage)
}
fn command_current_branch() -> Option<String> {
Command::new("git")
.args(&["symbolic-ref", "--short", "HEAD"])
.output()
.map(|x| String::from_utf8(x.stdout).ok())
.map(|x| x.map(|x| x.trim().to_string()))
.unwrap_or(None)
}
fn filter_git_dirty_stage(dirty_files: Vec<String>, staged_files: Vec<String>) -> String {
let mut concat_file = String::new();
for file in dirty_files {
concat_file.push_str(" * ");
concat_file.push_str(&file);
concat_file.push_str(" (dirty)\n");
}
for file in staged_files {
concat_file.push_str(" * ");
concat_file.push_str(&file);
concat_file.push_str(" (staged)\n");
}
concat_file
}
#[cfg(test)]
mod tests {
use super::*;
use crate::get_std_env;
use std::path::Path;
#[test]
fn test_git() {
let env_map = get_std_env();
let map = new_git(Path::new("./"), CiType::Github, &env_map);
for (k, v) in map {
assert!(!v.desc.is_empty());
if !k.eq(TAG) && !k.eq(BRANCH) && !k.eq(GIT_STATUS_FILE) {
assert!(!v.v.is_empty());
continue;
}
if let Some(github_ref) = env_map.get("GITHUB_REF") {
if github_ref.starts_with("refs/tags/") && k.eq(TAG) {
assert!(!v.v.is_empty());
} else if github_ref.starts_with("refs/heads/") && k.eq(BRANCH) {
assert!(!v.v.is_empty());
}
}
}
}
#[test]
fn test_current_branch() {
if get_std_env().get("GITHUB_REF").is_some() {
return;
}
#[cfg(feature = "git2")]
{
use crate::git::git2_mod::{git2_current_branch, git_repo};
let git2_branch = git_repo(".")
.map(|x| git2_current_branch(&x))
.unwrap_or(None);
let command_branch = command_current_branch();
assert!(git2_branch.is_some());
assert!(command_branch.is_some());
assert_eq!(command_branch, git2_branch);
}
assert_eq!(Some(branch()), command_current_branch());
}
}