Newer
Older
// Copyright 2018-2020 Parity Technologies (UK) Ltd.
// This file is part of cargo-contract.
Andrew Jones
committed
//
// ink! is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ink! is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with ink!. If not, see <http://www.gnu.org/licenses/>.
use anyhow::{Context, Result};
Andrew Jones
committed
use std::convert::{TryFrom, TryInto};
use std::{
Andrew Jones
committed
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
fs,
path::{Path, PathBuf},
};
use toml::value;
const MANIFEST_FILE: &str = "Cargo.toml";
/// Path to a Cargo.toml file
#[derive(Clone, Debug)]
pub struct ManifestPath {
path: PathBuf,
}
impl ManifestPath {
/// Create a new ManifestPath, errors if not path to `Cargo.toml`
pub fn new<P: AsRef<Path>>(path: P) -> Result<Self> {
let manifest = path.as_ref();
if let Some(file_name) = manifest.file_name() {
if file_name != MANIFEST_FILE {
anyhow::bail!("Manifest file must be a Cargo.toml")
}
}
Ok(ManifestPath {
path: manifest.into(),
})
}
/// Create an arg `--manifest-path=` for `cargo` command
pub fn cargo_arg(&self) -> String {
format!("--manifest-path={}", self.path.to_string_lossy())
}
/// The directory path of the manifest path.
///
/// Returns `None` if the path is just the plain file name `Cargo.toml`
pub fn directory(&self) -> Option<&Path> {
let just_a_file_name =
self.path.iter().collect::<Vec<_>>() == vec![Path::new(MANIFEST_FILE)];
if !just_a_file_name {
self.path.parent()
} else {
None
}
}
}
impl TryFrom<&PathBuf> for ManifestPath {
type Error = anyhow::Error;
fn try_from(value: &PathBuf) -> Result<Self, Self::Error> {
ManifestPath::new(value)
}
}
impl Default for ManifestPath {
fn default() -> ManifestPath {
ManifestPath::new(MANIFEST_FILE).expect("it's a valid manifest file")
}
}
impl AsRef<Path> for ManifestPath {
fn as_ref(&self) -> &Path {
self.path.as_ref()
}
}
/// Create, amend and save a copy of the specified `Cargo.toml`.
pub struct Manifest {
path: ManifestPath,
toml: value::Table,
}
impl Manifest {
/// Create new Manifest for the given manifest path.
Andrew Jones
committed
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
///
/// The path *must* be to a `Cargo.toml`.
pub fn new<P>(path: P) -> Result<Manifest>
where
P: TryInto<ManifestPath, Error = anyhow::Error>,
{
let manifest_path = path.try_into()?;
let toml = fs::read_to_string(&manifest_path).context("Loading Cargo.toml")?;
let toml: value::Table = toml::from_str(&toml)?;
Ok(Manifest {
path: manifest_path,
toml,
})
}
/// Get mutable reference to `[lib] crate-types = []` section
fn get_crate_types_mut(&mut self) -> Result<&mut value::Array> {
let lib = self
.toml
.get_mut("lib")
.ok_or(anyhow::anyhow!("lib section not found"))?;
let crate_types = lib
.get_mut("crate-type")
.ok_or(anyhow::anyhow!("crate-type section not found"))?;
crate_types
.as_array_mut()
.ok_or(anyhow::anyhow!("crate-types should be an Array"))
}
/// Add a value to the `[lib] crate-types = []` section.
///
/// If the value already exists, does nothing.
pub fn with_added_crate_type(&mut self, crate_type: &str) -> Result<&mut Self> {
let crate_types = self.get_crate_types_mut()?;
if !crate_type_exists(crate_type, crate_types) {
crate_types.push(crate_type.into());
}
Ok(self)
}
/// Set `[profile.release]` lto flag
pub fn with_profile_release_lto(&mut self, enabled: bool) -> Result<&mut Self> {
let lto = self
.get_profile_release_table_mut()?
.entry("lto")
.or_insert(enabled.into());
*lto = enabled.into();
Ok(self)
}
/// Set preferred defaults for the `[profile.release]` section
///
/// # Note
///
/// Existing user defined settings for this section are preserved. Only if a setting is not
/// defined is the preferred default set.
pub fn with_profile_release_defaults(&mut self, defaults: Profile) -> Result<&mut Self> {
let profile_release = self.get_profile_release_table_mut()?;
defaults.merge(profile_release);
Ok(self)
}
/// Get mutable reference to `[profile.release]` section
fn get_profile_release_table_mut(&mut self) -> Result<&mut value::Table> {
let profile = self
.toml
.entry("profile")
.or_insert(value::Value::Table(Default::default()));
let release = profile
.as_table_mut()
.ok_or(anyhow::anyhow!("profile should be a table"))?
.entry("release")
.or_insert(value::Value::Table(Default::default()));
.ok_or(anyhow::anyhow!("release should be a table"))
Andrew Jones
committed
/// Remove a value from the `[lib] crate-types = []` section
///
/// If the value does not exist, does nothing.
pub fn with_removed_crate_type(&mut self, crate_type: &str) -> Result<&mut Self> {
let crate_types = self.get_crate_types_mut()?;
if crate_type_exists(crate_type, crate_types) {
crate_types.retain(|v| v.as_str().map_or(true, |s| s != crate_type));
}
Ok(self)
}
/// Replace relative paths with absolute paths with the working directory.
///
/// Enables the use of a temporary amended copy of the manifest.
///
/// # Rewrites
///
/// - `[lib]/path`
/// - `[dependencies]`
///
/// Dependencies with package names specified in `exclude_deps` will not be rewritten.
pub(super) fn rewrite_relative_paths<I, S>(&mut self, exclude_deps: I) -> Result<&mut Self>
Andrew Jones
committed
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
where
I: IntoIterator<Item = S>,
S: AsRef<str>,
{
let abs_path = self.path.as_ref().canonicalize()?;
let abs_dir = abs_path
.parent()
.expect("The manifest path is a file path so has a parent; qed");
let to_absolute = |value_id: String, existing_path: &mut value::Value| -> Result<()> {
let path_str = existing_path
.as_str()
.ok_or(anyhow::anyhow!("{} should be a string", value_id))?;
let path = PathBuf::from(path_str);
if path.is_relative() {
let lib_abs = abs_dir.join(path);
log::debug!("Rewriting {} to '{}'", value_id, lib_abs.display());
*existing_path = value::Value::String(lib_abs.to_string_lossy().into())
}
Ok(())
};
let rewrite_path = |table_value: &mut value::Value, table_section: &str, default: &str| {
let table = table_value.as_table_mut().ok_or(anyhow::anyhow!(
"'[{}]' section should be a table",
table_section
))?;
match table.get_mut("path") {
Some(existing_path) => {
to_absolute(format!("[{}]/path", table_section), existing_path)
}
None => {
let default_path = PathBuf::from(default);
if !default_path.exists() {
anyhow::bail!(
"No path specified, and the default `{}` was not found",
default
)
}
let path = abs_dir.join(default_path);
log::debug!("Adding default path '{}'", path.display());
table.insert(
"path".into(),
value::Value::String(path.to_string_lossy().into()),
);
Ok(())
}
}
};
// Rewrite `[lib] path = /path/to/lib.rs`
if let Some(lib) = self.toml.get_mut("lib") {
rewrite_path(lib, "lib", "src/lib.rs")?;
}
// Rewrite `[[bin]] path = /path/to/main.rs`
if let Some(bin) = self.toml.get_mut("bin") {
let bins = bin
.as_array_mut()
.ok_or(anyhow::anyhow!("'[[bin]]' section should be a table array"))?;
// Rewrite `[[bin]] path =` value to an absolute path.
for bin in bins {
rewrite_path(bin, "[bin]", "src/main.rs")?;
}
}
// Rewrite any dependency relative paths
if let Some(dependencies) = self.toml.get_mut("dependencies") {
let exclude = exclude_deps
.into_iter()
.map(|s| s.as_ref().to_string())
.collect::<HashSet<_>>();
let table = dependencies
.as_table_mut()
.ok_or(anyhow::anyhow!("dependencies should be a table"))?;
for (name, value) in table {
let package_name = {
let package = value.get("package");
let package_name = package.and_then(|p| p.as_str()).unwrap_or(name);
package_name.to_string()
};
if !exclude.contains(&package_name) {
if let Some(dependency) = value.as_table_mut() {
if let Some(dep_path) = dependency.get_mut("path") {
to_absolute(format!("dependency {}", package_name), dep_path)?;
}
}
}
}
}
Ok(self)
}
/// Writes the amended manifest to the given path.
pub fn write(&self, path: &ManifestPath) -> Result<()> {
let manifest_path = path.as_ref();
if let Some(dir) = manifest_path.parent() {
fs::create_dir_all(&dir).context(format!("Creating directory '{}'", dir.display()))?;
}
let updated_toml = toml::to_string(&self.toml)?;
log::debug!("Writing updated manifest to '{}'", manifest_path.display());
fs::write(&manifest_path, updated_toml)?;
Ok(())
}
}
fn crate_type_exists(crate_type: &str, crate_types: &value::Array) -> bool {
crate_types
.iter()
.any(|v| v.as_str().map_or(false, |s| s == crate_type))
}