Require --message-format=json with CARGO_PRINT_RUN

Author: matklad

src/cargo/ops/cargo_run.rs

@@ -1,6 +1,6 @@
 use std::path::Path;
 
-use ops::{self, CompileFilter, Packages};
+use ops::{self, CompileFilter, Packages, MessageFormat};
 use util::{self, human, CargoResult, ProcessError};
 use util::machine_message::{self, RunProfile};
 use core::Workspace;
@@ -66,6 +66,9 @@ pub fn run(ws: &Workspace,
     process.args(args).cwd(config.cwd());
 
     if config.print_run() {
+        if options.message_format != MessageFormat::Json {
+            bail!("CARGO_PRINT_RUN requires --message-format=json")
+        }
         machine_message::emit(RunProfile::new(&process));
         Ok(None)
     } else {

src/cargo/ops/cargo_test.rs

@@ -1,6 +1,6 @@
 use std::ffi::{OsString, OsStr};
 
-use ops::{self, Compilation};
+use ops::{self, Compilation, MessageFormat};
 use util::{self, CargoResult, CargoTestError, Test, ProcessError};
 use util::machine_message::{self, RunProfile};
 use core::Workspace;
@@ -98,6 +98,9 @@ fn run_unit_tests(options: &TestOptions,
         })?;
 
         if config.print_run() {
+            if options.compile_opts.message_format != MessageFormat::Json {
+                bail!("CARGO_PRINT_RUN requires --message-format=json")
+            }
             machine_message::emit(RunProfile::new(&cmd));
         } else {
             config.shell().verbose(|shell| {

tests/print_run.rs

@@ -18,12 +18,22 @@ fn single_bin() {
             fn main() { println!("hello"); }
         "#);
 
-    assert_that(p.cargo_process("run").env("CARGO_PRINT_RUN", "1"),
+    assert_that(p.cargo_process("run").env("CARGO_PRINT_RUN", "1").arg("--message-format=json"),
                 execs().with_status(0)
                        .with_stderr(&"\
 [COMPILING] foo v0.0.1 ([..])
 [FINISHED] dev [unoptimized + debuginfo] target(s) in [..]")
                        .with_json(r#"
+{
+  "features": [],
+  "filenames": ["[..]target[/]debug[/]foo"],
+  "fresh": false,
+  "package_id": "foo 0.0.1 ([..])",
+  "profile": "{...}",
+  "reason": "compiler-artifact",
+  "target": "{...}"
+}
+
 {
   "reason": "run-profile",
   "program": "[..][/]foo[/]target[/]debug[/]foo",
@@ -87,9 +97,26 @@ fn several_tests() {
         "CARGO_MANIFEST_DIR": "[..]",
         "CARGO": "[..]"
     }"#;
-    assert_that(p.cargo_process("test").env("CARGO_PRINT_RUN", "1"),
+    let artifact = r#"{
+  "features": [],
+  "filenames": "{...}",
+  "fresh": false,
+  "package_id": "foo 0.0.1 ([..])",
+  "profile": "{...}",
+  "reason": "compiler-artifact",
+  "target": "{...}"
+}"#;
+    assert_that(p.cargo_process("test").env("CARGO_PRINT_RUN", "1").arg("--message-format=json"),
                 execs().with_status(0)
                        .with_json(&format!(r#"
+{artifact}
+
+{artifact}
+
+{artifact}
+
+{artifact}
+
 {{
   "reason": "run-profile",
   "program": "[..]bar-[..]",
@@ -113,6 +140,29 @@ fn several_tests() {
   "cwd": "[..]",
   "args": []
 }}
-"#, env=env)));
+"#, env=env, artifact=artifact)));
 }
 
+#[test]
+fn print_run_needs_json() {
+    let p = project("foo")
+        .file("Cargo.toml", r#"
+            [project]
+            name = "foo"
+            version = "0.0.1"
+            authors = []
+        "#)
+        .file("src/main.rs", r#"
+            fn main() { println!("hello"); }
+        "#);
+    p.build();
+
+    assert_that(p.cargo("run").env("CARGO_PRINT_RUN", "1"),
+                execs().with_status(101).with_stderr_contains("\
+[ERROR] CARGO_PRINT_RUN requires --message-format=json"));
+
+    assert_that(p.cargo("test").env("CARGO_PRINT_RUN", "1"),
+                execs().with_status(101).with_stderr_contains("\
+[ERROR] CARGO_PRINT_RUN requires --message-format=json"));
+
+}