-
Notifications
You must be signed in to change notification settings - Fork 110
/
config.rs
676 lines (565 loc) · 18.5 KB
/
config.rs
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
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
use std::path::{Path, PathBuf};
use clap::arg_enum;
use serde::{Deserialize, Serialize};
use crate::error::FatalError;
pub trait ConfigSource {
fn exclude_paths(&self) -> Option<&[String]> {
None
}
fn sign_commit(&self) -> Option<bool> {
None
}
fn sign_tag(&self) -> Option<bool> {
None
}
fn push_remote(&self) -> Option<&str> {
None
}
fn registry(&self) -> Option<&str> {
None
}
fn disable_release(&self) -> Option<bool> {
None
}
fn disable_publish(&self) -> Option<bool> {
None
}
fn disable_push(&self) -> Option<bool> {
None
}
fn push_options(&self) -> Option<&[String]> {
None
}
fn dev_version_ext(&self) -> Option<&str> {
None
}
fn no_dev_version(&self) -> Option<bool> {
None
}
fn consolidate_commits(&self) -> Option<bool> {
None
}
fn consolidate_pushes(&self) -> Option<bool> {
None
}
fn pre_release_commit_message(&self) -> Option<&str> {
None
}
fn post_release_commit_message(&self) -> Option<&str> {
None
}
fn pre_release_replacements(&self) -> Option<&[Replace]> {
None
}
fn post_release_replacements(&self) -> Option<&[Replace]> {
None
}
fn pre_release_hook(&self) -> Option<&Command> {
None
}
fn tag_message(&self) -> Option<&str> {
None
}
fn tag_prefix(&self) -> Option<&str> {
None
}
fn tag_name(&self) -> Option<&str> {
None
}
fn disable_tag(&self) -> Option<bool> {
None
}
fn enable_features(&self) -> Option<&[String]> {
None
}
fn enable_all_features(&self) -> Option<bool> {
None
}
fn dependent_version(&self) -> Option<DependentVersion> {
None
}
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(deny_unknown_fields, default)]
#[serde(rename_all = "kebab-case")]
pub struct Config {
pub exclude_paths: Option<Vec<String>>,
pub sign_commit: Option<bool>,
pub sign_tag: Option<bool>,
pub push_remote: Option<String>,
pub registry: Option<String>,
pub disable_release: Option<bool>,
pub disable_publish: Option<bool>,
pub disable_push: Option<bool>,
pub push_options: Option<Vec<String>>,
pub dev_version_ext: Option<String>,
pub no_dev_version: Option<bool>,
pub consolidate_commits: Option<bool>,
pub consolidate_pushes: Option<bool>,
pub pre_release_commit_message: Option<String>,
pub post_release_commit_message: Option<String>,
pub pre_release_replacements: Option<Vec<Replace>>,
pub post_release_replacements: Option<Vec<Replace>>,
pub pre_release_hook: Option<Command>,
pub tag_message: Option<String>,
pub tag_prefix: Option<String>,
pub tag_name: Option<String>,
pub disable_tag: Option<bool>,
pub enable_features: Option<Vec<String>>,
pub enable_all_features: Option<bool>,
pub dependent_version: Option<DependentVersion>,
}
impl Config {
pub fn update(&mut self, source: &dyn ConfigSource) {
if let Some(exclude_paths) = source.exclude_paths() {
self.exclude_paths = Some(exclude_paths.to_vec());
}
if let Some(sign_commit) = source.sign_commit() {
self.sign_commit = Some(sign_commit);
}
if let Some(sign_tag) = source.sign_tag() {
self.sign_tag = Some(sign_tag);
}
if let Some(push_remote) = source.push_remote() {
self.push_remote = Some(push_remote.to_owned());
}
if let Some(registry) = source.registry() {
self.registry = Some(registry.to_owned());
}
if let Some(disable_release) = source.disable_release() {
self.disable_release = Some(disable_release);
}
if let Some(disable_publish) = source.disable_publish() {
self.disable_publish = Some(disable_publish);
}
if let Some(disable_push) = source.disable_push() {
self.disable_push = Some(disable_push);
}
if let Some(push_options) = source.push_options() {
self.push_options = Some(push_options.to_owned());
}
if let Some(dev_version_ext) = source.dev_version_ext() {
self.dev_version_ext = Some(dev_version_ext.to_owned());
}
if let Some(no_dev_version) = source.no_dev_version() {
self.no_dev_version = Some(no_dev_version);
}
if let Some(consolidate_commits) = source.consolidate_commits() {
self.consolidate_commits = Some(consolidate_commits);
}
if let Some(consolidate_pushes) = source.consolidate_pushes() {
self.consolidate_pushes = Some(consolidate_pushes);
}
if let Some(pre_release_commit_message) = source.pre_release_commit_message() {
self.pre_release_commit_message = Some(pre_release_commit_message.to_owned());
}
if let Some(post_release_commit_message) = source.post_release_commit_message() {
self.post_release_commit_message = Some(post_release_commit_message.to_owned());
}
if let Some(pre_release_replacements) = source.pre_release_replacements() {
self.pre_release_replacements = Some(pre_release_replacements.to_owned());
}
if let Some(post_release_replacements) = source.post_release_replacements() {
self.post_release_replacements = Some(post_release_replacements.to_owned());
}
if let Some(pre_release_hook) = source.pre_release_hook() {
self.pre_release_hook = Some(pre_release_hook.to_owned());
}
if let Some(tag_message) = source.tag_message() {
self.tag_message = Some(tag_message.to_owned());
}
if let Some(tag_prefix) = source.tag_prefix() {
self.tag_prefix = Some(tag_prefix.to_owned());
}
if let Some(tag_name) = source.tag_name() {
self.tag_name = Some(tag_name.to_owned());
}
if let Some(disable_tag) = source.disable_tag() {
self.disable_tag = Some(disable_tag);
}
if let Some(enable_features) = source.enable_features() {
self.enable_features = Some(enable_features.to_owned());
}
if let Some(enable_all_features) = source.enable_all_features() {
self.enable_all_features = Some(enable_all_features);
}
if let Some(dependent_version) = source.dependent_version() {
self.dependent_version = Some(dependent_version);
}
}
pub fn exclude_paths(&self) -> Option<&[String]> {
self.exclude_paths.as_ref().map(|v| v.as_ref())
}
pub fn sign_commit(&self) -> bool {
self.sign_commit.unwrap_or(false)
}
pub fn sign_tag(&self) -> bool {
self.sign_tag.unwrap_or(false)
}
pub fn push_remote(&self) -> &str {
self.push_remote.as_deref().unwrap_or("origin")
}
pub fn registry(&self) -> Option<&str> {
self.registry.as_deref()
}
pub fn disable_release(&self) -> bool {
self.disable_release.unwrap_or(false)
}
pub fn disable_publish(&self) -> bool {
self.disable_publish.unwrap_or(false)
}
pub fn disable_push(&self) -> bool {
self.disable_push.unwrap_or(false)
}
pub fn push_options(&self) -> &[String] {
self.push_options
.as_ref()
.map(|v| v.as_ref())
.unwrap_or(&[])
}
pub fn dev_version_ext(&self) -> &str {
self.dev_version_ext.as_deref().unwrap_or("alpha.0")
}
pub fn no_dev_version(&self) -> bool {
self.no_dev_version.unwrap_or(false)
}
pub fn consolidate_commits(&self) -> bool {
self.consolidate_commits.unwrap_or(false)
}
pub fn consolidate_pushes(&self) -> bool {
self.consolidate_pushes.unwrap_or(false)
}
pub fn pre_release_commit_message(&self) -> &str {
self.pre_release_commit_message
.as_deref()
.unwrap_or("(cargo-release) version {{version}}")
}
pub fn post_release_commit_message(&self) -> &str {
self.post_release_commit_message
.as_deref()
.unwrap_or("(cargo-release) start next development iteration {{next_version}}")
}
pub fn pre_release_replacements(&self) -> &[Replace] {
self.pre_release_replacements
.as_ref()
.map(|v| v.as_ref())
.unwrap_or(&[])
}
pub fn post_release_replacements(&self) -> &[Replace] {
self.post_release_replacements
.as_ref()
.map(|v| v.as_ref())
.unwrap_or(&[])
}
pub fn pre_release_hook(&self) -> Option<&Command> {
self.pre_release_hook.as_ref()
}
pub fn tag_message(&self) -> &str {
self.tag_message
.as_deref()
.unwrap_or("(cargo-release) {{crate_name}} version {{version}}")
}
pub fn tag_prefix(&self, is_root: bool) -> &str {
// crate_name as default tag prefix for multi-crate project
self.tag_prefix
.as_deref()
.unwrap_or_else(|| if !is_root { "{{crate_name}}-" } else { "" })
}
pub fn tag_name(&self) -> &str {
self.tag_name.as_deref().unwrap_or("{{prefix}}v{{version}}")
}
pub fn disable_tag(&self) -> bool {
self.disable_tag.unwrap_or(false)
}
pub fn enable_features(&self) -> &[String] {
self.enable_features
.as_ref()
.map(|v| v.as_ref())
.unwrap_or(&[])
}
pub fn enable_all_features(&self) -> bool {
self.enable_all_features.unwrap_or(false)
}
pub fn dependent_version(&self) -> DependentVersion {
self.dependent_version.unwrap_or_default()
}
}
impl ConfigSource for Config {
fn exclude_paths(&self) -> Option<&[String]> {
self.exclude_paths.as_ref().map(|v| v.as_ref())
}
fn sign_commit(&self) -> Option<bool> {
self.sign_commit
}
fn sign_tag(&self) -> Option<bool> {
self.sign_tag
}
fn push_remote(&self) -> Option<&str> {
self.push_remote.as_deref()
}
fn registry(&self) -> Option<&str> {
self.registry.as_deref()
}
fn disable_release(&self) -> Option<bool> {
self.disable_release
}
fn disable_publish(&self) -> Option<bool> {
self.disable_publish
}
fn disable_push(&self) -> Option<bool> {
self.disable_push
}
fn push_options(&self) -> Option<&[String]> {
self.push_options.as_ref().map(|v| v.as_ref())
}
fn dev_version_ext(&self) -> Option<&str> {
self.dev_version_ext.as_deref()
}
fn no_dev_version(&self) -> Option<bool> {
self.no_dev_version
}
fn consolidate_commits(&self) -> Option<bool> {
self.consolidate_commits
}
fn consolidate_pushes(&self) -> Option<bool> {
self.consolidate_pushes
}
fn pre_release_commit_message(&self) -> Option<&str> {
self.pre_release_commit_message.as_deref()
}
fn post_release_commit_message(&self) -> Option<&str> {
self.post_release_commit_message.as_deref()
}
fn pre_release_replacements(&self) -> Option<&[Replace]> {
self.pre_release_replacements.as_ref().map(|v| v.as_ref())
}
fn post_release_replacements(&self) -> Option<&[Replace]> {
self.post_release_replacements.as_ref().map(|v| v.as_ref())
}
fn pre_release_hook(&self) -> Option<&Command> {
self.pre_release_hook.as_ref()
}
fn tag_message(&self) -> Option<&str> {
self.tag_message.as_deref()
}
fn tag_prefix(&self) -> Option<&str> {
self.tag_prefix.as_deref()
}
fn tag_name(&self) -> Option<&str> {
self.tag_name.as_deref()
}
fn disable_tag(&self) -> Option<bool> {
self.disable_tag
}
fn enable_features(&self) -> Option<&[String]> {
self.enable_features.as_ref().map(|v| v.as_ref())
}
fn enable_all_features(&self) -> Option<bool> {
self.enable_all_features
}
fn dependent_version(&self) -> Option<DependentVersion> {
self.dependent_version
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Replace {
pub file: PathBuf,
pub search: String,
pub replace: String,
pub min: Option<usize>,
pub max: Option<usize>,
pub exactly: Option<usize>,
#[serde(default)]
pub prerelease: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum Command {
Line(String),
Args(Vec<String>),
}
impl Command {
pub fn args(&self) -> Vec<&str> {
match self {
Command::Line(ref s) => vec![s.as_str()],
Command::Args(ref a) => a.iter().map(|s| s.as_str()).collect(),
}
}
}
arg_enum! {
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum DependentVersion {
Upgrade,
Fix,
Error,
Warn,
Ignore,
}
}
impl Default for DependentVersion {
fn default() -> Self {
DependentVersion::Fix
}
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
struct CargoManifest {
workspace: Option<CargoWorkspace>,
package: Option<CargoPackage>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
struct CargoWorkspace {
metadata: Option<CargoMetadata>,
}
impl CargoWorkspace {
fn into_config(self) -> Option<Config> {
self.metadata?.release
}
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
struct CargoPackage {
include: Option<Vec<String>>,
exclude: Option<Vec<String>>,
metadata: Option<CargoMetadata>,
}
impl CargoPackage {
fn into_config(self) -> Option<Config> {
if self.include.is_none() && self.exclude.is_none() && self.metadata.is_none() {
return None;
}
let CargoPackage {
include,
exclude,
metadata,
} = self;
let mut config = metadata.and_then(|m| m.release).unwrap_or_default();
if config.exclude_paths.is_none() {
if let Some(_include) = include {
log::trace!("Ignoring `include` from Cargo.toml");
} else if let Some(exclude) = exclude {
config.exclude_paths = Some(exclude);
}
}
Some(config)
}
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
struct CargoMetadata {
release: Option<Config>,
}
fn get_pkg_config_from_manifest(manifest_path: &Path) -> Result<Option<Config>, FatalError> {
if manifest_path.exists() {
let m = std::fs::read_to_string(manifest_path).map_err(FatalError::from)?;
let c: CargoManifest = toml::from_str(&m).map_err(FatalError::from)?;
Ok(c.package.and_then(|p| p.into_config()))
} else {
Ok(None)
}
}
fn get_ws_config_from_manifest(manifest_path: &Path) -> Result<Option<Config>, FatalError> {
if manifest_path.exists() {
let m = std::fs::read_to_string(manifest_path).map_err(FatalError::from)?;
let c: CargoManifest = toml::from_str(&m).map_err(FatalError::from)?;
Ok(c.workspace.and_then(|p| p.into_config()))
} else {
Ok(None)
}
}
fn get_config_from_file(file_path: &Path) -> Result<Option<Config>, FatalError> {
if file_path.exists() {
let c = std::fs::read_to_string(file_path).map_err(FatalError::from)?;
let config = toml::from_str(&c).map_err(FatalError::from)?;
Ok(Some(config))
} else {
Ok(None)
}
}
pub fn resolve_custom_config(file_path: &Path) -> Result<Option<Config>, FatalError> {
get_config_from_file(file_path)
}
/// Try to resolve workspace configuration source.
///
/// This tries the following sources in order, merging the results:
/// 1. $HOME/.release.toml
/// 2. $(workspace)/release.toml
pub fn resolve_workspace_config(workspace_root: &Path) -> Result<Config, FatalError> {
let mut config = Config::default();
// User-local configuration from home directory.
let home_dir = dirs_next::home_dir();
if let Some(mut home) = home_dir {
home.push(".release.toml");
if let Some(cfg) = get_config_from_file(&home)? {
config.update(&cfg);
}
};
let default_config = workspace_root.join("release.toml");
let current_dir_config = get_config_from_file(&default_config)?;
if let Some(cfg) = current_dir_config {
config.update(&cfg);
};
// Crate manifest.
let manifest_path = workspace_root.join("Cargo.toml");
let current_dir_config = get_ws_config_from_manifest(&manifest_path)?;
if let Some(cfg) = current_dir_config {
config.update(&cfg);
};
Ok(config)
}
/// Try to resolve configuration source.
///
/// This tries the following sources in order, merging the results:
/// 1. $HOME/.release.toml
/// 2. $(workspace)/release.toml
/// 4. $(crate)/release.toml
/// 3. $(crate)/Cargo.toml `package.metadata.release`
///
/// `$(crate)/Cargo.toml` is a way to differentiate configuration for the root crate and the
/// workspace.
pub fn resolve_config(workspace_root: &Path, manifest_path: &Path) -> Result<Config, FatalError> {
let mut config = Config::default();
// User-local configuration from home directory.
let home_dir = dirs_next::home_dir();
if let Some(mut home) = home_dir {
home.push(".release.toml");
if let Some(cfg) = get_config_from_file(&home)? {
config.update(&cfg);
}
};
let crate_root = manifest_path.parent().unwrap_or_else(|| Path::new("."));
if crate_root != workspace_root {
let default_config = workspace_root.join("release.toml");
let current_dir_config = get_config_from_file(&default_config)?;
if let Some(cfg) = current_dir_config {
config.update(&cfg);
};
}
// Project release file.
let default_config = crate_root.join("release.toml");
let current_dir_config = get_config_from_file(&default_config)?;
if let Some(cfg) = current_dir_config {
config.update(&cfg);
};
// Crate manifest.
let current_dir_config = get_pkg_config_from_manifest(manifest_path)?;
if let Some(cfg) = current_dir_config {
config.update(&cfg);
};
Ok(config)
}
#[cfg(test)]
mod test {
use super::*;
mod resolve_config {
use super::*;
#[test]
fn doesnt_panic() {
let release_config = resolve_config(Path::new("."), Path::new("Cargo.toml")).unwrap();
assert!(release_config.sign_commit());
}
}
}