Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: make extra-output accept multiple values #1587

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 6 additions & 4 deletions cli/src/cmd/forge/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -192,13 +192,15 @@ impl Provider for CoreBuildArgs {
dict.insert("optimizer".to_string(), self.compiler.optimize.into());
}

if let Some(ref extra) = self.compiler.extra_output {
let selection: Vec<_> = extra.iter().map(|s| s.to_string()).collect();
if !self.compiler.extra_output.is_empty() {
let selection: Vec<_> =
self.compiler.extra_output.iter().map(|s| s.to_string()).collect();
dict.insert("extra_output".to_string(), selection.into());
}

if let Some(ref extra) = self.compiler.extra_output_files {
let selection: Vec<_> = extra.iter().map(|s| s.to_string()).collect();
if !self.compiler.extra_output_files.is_empty() {
let selection: Vec<_> =
self.compiler.extra_output_files.iter().map(|s| s.to_string()).collect();
dict.insert("extra_output_files".to_string(), selection.into());
}

Expand Down
8 changes: 2 additions & 6 deletions cli/src/cmd/forge/inspect.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ impl Cmd for InspectArgs {
let InspectArgs { contract, field, build, pretty } = self;

// Map field to ContractOutputSelection
let mut cos = build.compiler.extra_output.unwrap_or_default();
let mut cos = build.compiler.extra_output;
if !cos.iter().any(|&i| i.to_string() == field.to_string()) {
match field {
ContractArtifactFields::Abi => cos.push(ContractOutputSelection::Abi),
Expand Down Expand Up @@ -150,11 +150,7 @@ impl Cmd for InspectArgs {

// Build modified Args
let modified_build_args = CoreBuildArgs {
compiler: CompilerArgs {
extra_output: Some(cos),
optimize: optimized,
..build.compiler
},
compiler: CompilerArgs { extra_output: cos, optimize: optimized, ..build.compiler },
..build
};

Expand Down
12 changes: 6 additions & 6 deletions cli/src/opts/forge.rs
Original file line number Diff line number Diff line change
Expand Up @@ -173,16 +173,16 @@ pub struct CompilerArgs {
/// Example keys: evm.assembly, ewasm, ir, irOptimized, metadata
///
/// For a full description, see https://docs.soliditylang.org/en/v0.8.13/using-the-compiler.html#input-description
#[clap(long)]
#[serde(skip_serializing_if = "Option::is_none")]
pub extra_output: Option<Vec<ContractOutputSelection>>,
#[clap(long, min_values = 1)]
#[serde(skip_serializing_if = "Vec::is_empty")]
pub extra_output: Vec<ContractOutputSelection>,

/// Extra output to write to separate files.
///
/// Valid values: metadata, ir, irOptimized, ewasm, evm.assembly
#[clap(long)]
#[serde(skip_serializing_if = "Option::is_none")]
pub extra_output_files: Option<Vec<ContractOutputSelection>>,
#[clap(long, min_values = 1)]
#[serde(skip_serializing_if = "Vec::is_empty")]
pub extra_output_files: Vec<ContractOutputSelection>,
}

/// Represents the common dapp argument pattern for `<path>:<contractname>` where `<path>:` is
Expand Down
35 changes: 35 additions & 0 deletions cli/tests/it/cmd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,41 @@ forgetest_init!(can_emit_extra_output, |prj: TestProject, mut cmd: TestCommand|
let _artifact: Metadata = ethers::solc::utils::read_json_file(metadata_path).unwrap();
});

// checks that extra output works
forgetest_init!(can_emit_multiple_extra_output, |prj: TestProject, mut cmd: TestCommand| {
cmd.set_current_dir(prj.root());
cmd.args(["build", "--extra-output", "metadata", "ir-optimized", "--extra-output", "ir"]);
cmd.assert_non_empty_stdout();

let artifact_path = prj.paths().artifacts.join("Contract.sol/Contract.json");
let artifact: ConfigurableContractArtifact =
ethers::solc::utils::read_json_file(artifact_path).unwrap();
assert!(artifact.metadata.is_some());
assert!(artifact.ir.is_some());
assert!(artifact.ir_optimized.is_some());

cmd.forge_fuse()
.args([
"build",
"--extra-output-files",
"metadata",
"ir-optimized",
"evm.bytecode.sourceMap",
"--force",
])
.root_arg();
cmd.assert_non_empty_stdout();

let metadata_path = prj.paths().artifacts.join("Contract.sol/Contract.metadata.json");
let _artifact: Metadata = ethers::solc::utils::read_json_file(metadata_path).unwrap();

let iropt = prj.paths().artifacts.join("Contract.sol/Contract.iropt");
std::fs::read_to_string(iropt).unwrap();

let sourcemap = prj.paths().artifacts.join("Contract.sol/Contract.sourcemap");
std::fs::read_to_string(sourcemap).unwrap();
});

forgetest!(can_print_warnings, |prj: TestProject, mut cmd: TestCommand| {
prj.inner()
.add_source(
Expand Down