Suite for "fixme" tests (rust-lang#660)

* Enable `rmc-fixme` suite in `compiletest`

* Add "rmc-fixme" suite to regular regression

Author: adpaco-aws

scripts/rmc-regression.sh

@@ -25,7 +25,7 @@ check-cbmc-viewer-version.py --major 2 --minor 5
 ./scripts/setup/build_rmc_lib.sh
 
 # Standalone rmc tests, expected tests, and cargo tests
-./x.py test -i --stage 1 rmc firecracker prusti smack expected cargo-rmc rmc-docs
+./x.py test -i --stage 1 rmc firecracker prusti smack expected cargo-rmc rmc-docs rmc-fixme
 ./x.py test -i --stage 0 compiler/cbmc
 
 # Check codegen for the standard library

src/bootstrap/builder.rs

@@ -474,6 +474,7 @@ impl<'a> Builder<'a> {
                 test::Dashboard,
                 test::Stub,
                 test::RmcDocs,
+                test::RmcFixme,
                 // Run run-make last, since these won't pass without make on Windows
                 test::RunMake,
             ),

src/bootstrap/test.rs

@@ -1231,6 +1231,8 @@ default_test!(Dashboard { path: "src/test/dashboard", mode: "rmc", suite: "dashb
 
 default_test!(RmcDocs { path: "src/test/rmc-docs", mode: "rmc", suite: "rmc-docs" });
 
+default_test!(RmcFixme { path: "src/test/rmc-fixme", mode: "rmc-fixme", suite: "rmc-fixme" });
+
 default_test!(Stub { path: "src/test/stub-tests", mode: "stub-tests", suite: "stub-tests" });
 
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]

src/test/rmc-fixme

@@ -0,0 +1 @@
+rmc

src/test/rmc/SaturatingIntrinsics/fixme_128.rs renamed to src/test/rmc/SaturatingIntrinsics/add_128.rs

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
-// Fails with a type safety error - see TODO in rvalue.rs::codegen_misc_cast()
+
 fn main() {
     let s = String::from("hello");
     let _b = s.into_boxed_str();

src/test/rmc/Strings/fixme_boxed_str.rs renamed to src/test/rmc/Strings/boxed_str.rs

@@ -6,7 +6,6 @@ fn test2() {
     assert!(s.chars().nth(1) == Some('o'));
 }
 
-/// Runs forever
 fn test3() {
     let s: &str = &("f".to_string() + "o");
     assert!(s.len() == 2);
@@ -20,7 +19,7 @@ fn test4() {
 
     unsafe {
         assert!(!ptr.is_null());
-        //assert!(*ptr.offset(1) as char == '2'); // u8 to char not handled yet
+        assert!(*ptr.offset(1) as char == '2'); // u8 to char not handled yet
     }
 }
 fn main() {

src/test/rmc/Strings/fixme_main.rs

@@ -1,5 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
+// rmc-flags: --unwind 0
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd)]
 pub struct GuestAddress(pub u64);
 

src/test/rmc/Strings/fixme_os_str.rs renamed to src/test/rmc/Strings/os_str.rs

@@ -24,6 +24,7 @@ pub enum Mode {
     MirOpt,
     Assembly,
     RMC,
+    RmcFixme,
     CargoRMC,
     Expected,
     Stub,
@@ -58,6 +59,7 @@ impl FromStr for Mode {
             "mir-opt" => Ok(MirOpt),
             "assembly" => Ok(Assembly),
             "rmc" => Ok(RMC),
+            "rmc-fixme" => Ok(RmcFixme),
             "cargo-rmc" => Ok(CargoRMC),
             "expected" => Ok(Expected),
             "stub-tests" => Ok(Stub),
@@ -83,6 +85,7 @@ impl fmt::Display for Mode {
             MirOpt => "mir-opt",
             Assembly => "assembly",
             RMC => "rmc",
+            RmcFixme => "rmc-fixme",
             CargoRMC => "cargo-rmc",
             Expected => "expected",
             Stub => "stub-tests",

src/test/rmc/Vectors/fixme_main.rs

@@ -953,6 +953,21 @@ pub fn make_test_description<R: Read>(
         ignore |= file_path.contains("fixme") || file_path.contains("ignore");
     }
 
+    // The `RmcFixme` mode runs tests that are ignored in the `rmc` suite
+    if config.mode == Mode::RmcFixme {
+        let file_path = path.to_str().unwrap();
+
+        // `file_path` is going to be `src/test/rmc-fixme/...` so we
+        // need to extract the base name if we want to ignore it
+        let test_name: Vec<&str> = file_path.rsplit('/').collect();
+        let base_name = test_name[0];
+
+        // If the base name does NOT contain "fixme" or "ignore", we skip it.
+        // All "fixme" tests are expected to fail
+        ignore |= !(base_name.contains("fixme") || base_name.contains("ignore"));
+        should_fail = true;
+    }
+
     iter_header(path, src, &mut |revision, ln| {
         if revision.is_some() && revision != cfg {
             return;

src/tools/compiletest/src/common.rs

@@ -5,8 +5,8 @@ use crate::common::{
 };
 use crate::common::{incremental_dir, output_base_dir, output_base_name, output_testname_unique};
 use crate::common::{
-    Assembly, CargoRMC, Expected, Incremental, JsDocTest, MirOpt, RunMake, RustdocJson, Stub, Ui,
-    RMC,
+    Assembly, CargoRMC, Expected, Incremental, JsDocTest, MirOpt, RmcFixme, RunMake, RustdocJson,
+    Stub, Ui, RMC,
 };
 use crate::common::{Codegen, CodegenUnits, DebugInfo, Debugger, Rustdoc};
 use crate::common::{CompareMode, FailMode, PassMode};
@@ -255,6 +255,7 @@ impl<'test> TestCx<'test> {
             Assembly => self.run_assembly_test(),
             JsDocTest => self.run_js_doc_test(),
             RMC => self.run_rmc_test(),
+            RmcFixme => self.run_rmc_test(),
             CargoRMC => self.run_cargo_rmc_test(),
             Expected => self.run_expected_test(),
             Stub => self.run_stub_test(),
@@ -1843,7 +1844,7 @@ impl<'test> TestCx<'test> {
                 rustc.arg(dir_opt);
             }
             RunPassValgrind | Pretty | DebugInfo | Codegen | Rustdoc | RustdocJson | RunMake
-            | CodegenUnits | JsDocTest | Assembly | RMC | CargoRMC | Expected | Stub => {
+            | CodegenUnits | JsDocTest | Assembly | RMC | RmcFixme | CargoRMC | Expected | Stub => {
                 // do not use JSON output
             }
         }