cli/environment/
crateinfo.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
//! # crateinfo
//!
//! Loads crate information.
//!

#[cfg(test)]
#[path = "crateinfo_test.rs"]
mod crateinfo_test;

use crate::error::CargoMakeError;
use crate::types::{CrateDependency, CrateInfo, PackageInfo, Workspace};
use cargo_metadata::camino::Utf8PathBuf;
use cargo_metadata::{Metadata, MetadataCommand};
use glob::glob;
use indexmap::IndexMap;
use itertools::Itertools;
use std::env;
use std::ffi::OsStr;
use std::path::{Path, PathBuf};

#[derive(Debug, Deserialize)]
struct CargoConfig {
    build: Option<CargoConfigBuild>,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "kebab-case")]
struct CargoConfigBuild {
    target: Option<RustTarget>,
}

#[derive(Debug, Deserialize)]
#[serde(from = "PathBuf")]
struct RustTarget(PathBuf);

impl RustTarget {
    fn name(&self) -> &str {
        self.0.file_stem().unwrap().to_str().unwrap()
    }
}

impl From<PathBuf> for RustTarget {
    fn from(buf: PathBuf) -> Self {
        Self(buf)
    }
}

impl AsRef<OsStr> for RustTarget {
    fn as_ref(&self) -> &OsStr {
        self.0.as_ref()
    }
}

#[derive(Serialize, Deserialize, Debug, Clone, Default)]
/// Holds crate information loaded from the Cargo.toml file.
struct CrateInfoMinimal {
    /// workspace info
    workspace: Option<Workspace>,
    /// crate dependencies
    dependencies: Option<IndexMap<String, CrateDependency>>,
}

impl CrateInfoMinimal {
    /// Creates and returns a new instance.
    fn new() -> CrateInfoMinimal {
        Default::default()
    }
}

fn expand_glob_members(glob_member: &str) -> Vec<String> {
    let emulation = envmnt::is("CARGO_MAKE_WORKSPACE_EMULATION");

    match glob(glob_member) {
        Ok(entries) => {
            let mut members = vec![];

            for entry in entries {
                match entry {
                    Ok(path) => {
                        let should_add = if emulation {
                            // emulation may be used for non rust projects
                            // so no extra validations
                            true
                        } else {
                            // ensure Cargo.toml is found
                            let mut cargo_path = path.clone();
                            cargo_path.push("Cargo.toml");
                            let exists = cargo_path.exists();

                            exists
                        };

                        if should_add {
                            let mut updated_path = path.to_str().unwrap().to_string();
                            updated_path = updated_path.replace("\\", "/");
                            members.push(updated_path);
                        }
                    }
                    _ => (),
                };
            }

            members
        }
        _ => vec![],
    }
}

fn normalize_members(crate_info: &mut CrateInfo) {
    match crate_info.workspace {
        Some(ref mut workspace) => {
            if let Some(ref mut members) = workspace.members {
                let existing_members = members.clone();

                let mut index = 0;
                for member in existing_members.iter() {
                    // glob
                    if member.contains("*") {
                        let mut expanded_members = expand_glob_members(&member);

                        members.remove(index);
                        members.append(&mut expanded_members);
                    } else {
                        index = index + 1;
                    }
                }
            }
        }
        None => (), //not a workspace
    }
}

fn get_members_from_dependencies(crate_info: &CrateInfo) -> Vec<String> {
    get_members_from_dependencies_map(crate_info.dependencies.clone(), false)
}

fn get_members_from_workspace_dependencies(crate_info: &CrateInfo) -> Vec<String> {
    let workspace = crate_info.workspace.clone();
    match workspace {
        Some(workspace) => get_members_from_dependencies_map(workspace.dependencies, true),
        None => vec![],
    }
}

fn get_members_from_dependencies_map(
    dependencies: Option<IndexMap<String, CrateDependency>>,
    ensure_inside_workspace: bool,
) -> Vec<String> {
    let mut members = vec![];
    debug!("Searching members in dependencies: {:#?}", &dependencies);

    match dependencies {
        Some(ref dependencies) => {
            for value in dependencies.values() {
                match *value {
                    CrateDependency::Info(ref info) => match info.path {
                        Some(ref path) => {
                            // workspace dependencies are members only if inside the workspace
                            // directory (this is a simple not accurate check for that)
                            if ensure_inside_workspace && path.starts_with("..") {
                                // skip
                            } else if path.starts_with("./") {
                                let member_path =
                                    path.chars().skip(2).take(path.len() - 2).collect();
                                members.push(member_path);
                            } else if Path::new(path).is_relative() {
                                members.push(path.to_string());
                            }
                        }
                        None => (),
                    },
                    _ => (),
                };
            }
        }
        None => (),
    };

    members
}

fn add_members(crate_info: &mut CrateInfo, new_members: Vec<String>) {
    if new_members.len() > 0 {
        match crate_info.workspace {
            Some(ref mut workspace) => match workspace.members {
                Some(ref mut members) => {
                    for new_member in new_members.iter() {
                        let member_string = new_member.to_string();

                        match members.iter().position(|member| *member == member_string) {
                            None => members.push(member_string),
                            _ => (),
                        }
                    }
                }
                None => workspace.members = Some(new_members),
            },
            None => (), //not a workspace
        }
    }
}

fn dedup_members(crate_info: &mut CrateInfo) {
    if let Some(ref mut workspace) = crate_info.workspace {
        if let Some(ref members) = workspace.members {
            workspace.members = Some(
                members
                    .into_iter()
                    .unique()
                    .map(|value| value.to_string())
                    .collect(),
            );
        }
    }
}

fn remove_excludes(crate_info: &mut CrateInfo) -> bool {
    let mut removed = false;

    match crate_info.workspace {
        Some(ref mut workspace) => match workspace.exclude {
            Some(ref excludes) => match workspace.members {
                Some(ref mut members) => {
                    for exclude in excludes.iter() {
                        let exclude_string = exclude.to_string();

                        let result = members.iter().position(|member| *member == exclude_string);
                        match result {
                            Some(index) => {
                                members.remove(index);

                                removed = true;

                                ()
                            }
                            None => (),
                        };
                    }
                }
                None => (),
            },
            None => (),
        },
        None => (), //not a workspace
    };

    removed
}

fn load_workspace_members(crate_info: &mut CrateInfo) {
    if crate_info.workspace.is_some() {
        normalize_members(crate_info);

        let dependencies = get_members_from_dependencies(&crate_info);
        add_members(crate_info, dependencies);
        let workspace_dependencies = get_members_from_workspace_dependencies(&crate_info);
        add_members(crate_info, workspace_dependencies);

        if crate_info.package.is_some() {
            let members_vec = vec![".".to_string()];
            add_members(crate_info, members_vec);
        }

        dedup_members(crate_info);

        remove_excludes(crate_info);
    }
}

/// Loads the crate info based on the Cargo.toml found in the current working directory.
pub(crate) fn load() -> Result<CrateInfo, CargoMakeError> {
    load_from(Path::new("Cargo.toml").to_path_buf())
}

pub(crate) fn load_from(file_path: PathBuf) -> Result<CrateInfo, CargoMakeError> {
    if file_path.exists() {
        debug!("Calling cargo metadata to extract project info");

        match MetadataCommand::new().manifest_path(&file_path).exec() {
            Ok(metadata) => {
                debug!("Cargo metadata done");
                trace!("Cargo metadata: {:#?}", &metadata);
                let mut crate_info = convert_metadata_to_crate_info(&metadata);

                trace!("Reading file: {:#?}", &file_path);
                let crate_info_string = fsio::file::read_text_file(&file_path)?;

                let crate_info_deserialized: CrateInfoMinimal =
                    match toml::from_str(&crate_info_string) {
                        Ok(value) => value,
                        Err(error) => {
                            warn!("Unable to parse Cargo.toml, {}", error);
                            CrateInfoMinimal::new()
                        }
                    };
                crate_info.workspace = crate_info_deserialized.workspace;
                crate_info.dependencies = crate_info_deserialized.dependencies;

                load_workspace_members(&mut crate_info);

                trace!("Loaded Cargo.toml: {:#?}", &crate_info);

                Ok(crate_info)
            }
            Err(error) => {
                warn!(
                    "Unable to parse Cargo.toml via cargo-metadata, fallbacking. {}",
                    error
                );

                let crate_info_string = fsio::file::read_text_file(&file_path)?;

                toml::from_str(&crate_info_string).map_err(From::from)
            }
        }
    } else {
        Ok(CrateInfo::new())
    }
}

fn convert_metadata_to_crate_info(metadata: &Metadata) -> CrateInfo {
    let mut crate_info = CrateInfo::new();

    if let Some(root_package) = metadata.root_package() {
        let mut package_info = PackageInfo::new();
        package_info.name = Some(root_package.name.clone());
        package_info.version = Some(root_package.version.to_string());
        package_info.description = root_package.description.clone();
        package_info.license = root_package.license.clone();
        package_info.documentation = root_package.documentation.clone();
        package_info.homepage = root_package.homepage.clone();
        package_info.repository = root_package.repository.clone();

        crate_info.package = Some(package_info);
    }

    crate_info
}

fn get_cargo_config(home: Option<PathBuf>) -> Option<CargoConfig> {
    let path = env::current_dir().ok()?;

    let config_file = path
        .ancestors()
        .map(|ancestor| ancestor.join(".cargo"))
        .chain(home)
        .map(|config_file| config_file.join("config"))
        .filter_map(|config_file| {
            let config_file_with_extension = config_file.with_extension("toml");

            if config_file.exists() {
                Some(config_file)
            } else if config_file_with_extension.exists() {
                Some(config_file_with_extension)
            } else {
                None
            }
        })
        .next()?;

    let config_file = fsio::file::read_text_file(&config_file).ok()?;
    toml::from_str(&config_file).ok()
}

pub(crate) fn crate_target_triple(
    default_target_triple: Option<String>,
    home: Option<PathBuf>,
) -> Option<String> {
    get_cargo_config(home)
        .and_then(|config| config.build)
        .and_then(|build| build.target)
        .map(|target| target.name().to_string())
        .or(default_target_triple)
}

#[derive(Debug, PartialEq, Eq)]
pub(crate) struct CrateTargetDirs {
    pub(crate) host: Utf8PathBuf,
    pub(crate) custom: Option<Utf8PathBuf>,
}

pub(crate) fn crate_target_dirs(home: Option<PathBuf>) -> CrateTargetDirs {
    let metadata = MetadataCommand::new()
        .exec()
        .map_err(|err| debug!("Unable to extract cargo metadata, error: {}", err))
        .ok();
    let host = metadata
        .map(|metadata| metadata.target_directory)
        .unwrap_or_else(|| "target".into());
    let custom = get_cargo_config(home)
        .and_then(|config| config.build)
        .and_then(|build| build.target)
        .map(|target_triple| host.join(target_triple.name()));
    CrateTargetDirs { host, custom }
}

pub(crate) fn search_workspace_root() -> Option<String> {
    if envmnt::is("CARGO_MAKE_WORKSPACE_EMULATION") {
        search_workspace_root_for_emulation()
    } else {
        search_workspace_root_via_metadata()
    }
}

fn search_workspace_root_for_emulation() -> Option<String> {
    let path_value = envmnt::get_any(
        &vec![
            "CARGO_MAKE_WORKSPACE_EMULATION_ROOT_DIRECTORY",
            "CARGO_MAKE_WORKING_DIRECTORY",
        ],
        "",
    );

    if path_value.is_empty() {
        None
    } else {
        Some(path_value)
    }
}

fn search_workspace_root_via_metadata() -> Option<String> {
    debug!("Getting cargo metadata.");

    MetadataCommand::new()
        .exec()
        .map(|metadata| metadata.workspace_root.to_string())
        .map_err(|err| debug!("Unable to extract cargo metadata, error: {:#?}", err))
        .ok()
}