Merge pull request #1076 from CraftSpider/improve-tests

Make file expectations always check all expected files at once

Author: pkgw

crates/bridge_core/src/lib.rs

@@ -1224,10 +1224,14 @@ pub unsafe extern "C" fn ttbc_diag_append(diag: &mut Diagnostic, text: *const li
 }
 
 /// "Finish" a diagnostic: report it to the driver and free the diagnostic object.
+///
+/// # Safety
+///
+/// This function is unsafe because it dereferences a raw Diagnostic pointer
 #[no_mangle]
-pub extern "C" fn ttbc_diag_finish(es: &mut CoreBridgeState, diag: *mut Diagnostic) {
+pub unsafe extern "C" fn ttbc_diag_finish(es: &mut CoreBridgeState, diag: *mut Diagnostic) {
     // By creating the box, we will free the diagnostic when this function exits.
-    let rdiag = unsafe { Box::from_raw(diag as *mut Diagnostic) };
+    let rdiag = Box::from_raw(diag);
     es.status
         .report(rdiag.kind, format_args!("{}", rdiag.message), None);
 }

crates/docmodel/src/workspace.rs

@@ -144,10 +144,10 @@ impl WorkspaceCreator {
             tex_dir.push("_preamble.tex");
             let mut f = fs::File::create(&tex_dir)?;
             f.write_all(
-                br#"\documentclass{article}
+                br"\documentclass{article}
 \title{My Title}
 \begin{document}
-"#,
+",
             )?;
             tex_dir.pop();
         }
@@ -156,8 +156,8 @@ impl WorkspaceCreator {
             tex_dir.push("index.tex");
             let mut f = fs::File::create(&tex_dir)?;
             f.write_all(
-                br#"Hello, world.
-"#,
+                br"Hello, world.
+",
             )?;
             tex_dir.pop();
         }
@@ -166,8 +166,8 @@ impl WorkspaceCreator {
             tex_dir.push("_postamble.tex");
             let mut f = fs::File::create(&tex_dir)?;
             f.write_all(
-                br#"\end{document}
-"#,
+                br"\end{document}
+",
             )?;
             tex_dir.pop();
         }

crates/io_base/src/lib.rs

@@ -674,7 +674,7 @@ fn try_normalize_tex_path(path: &str) -> Option<String> {
 
     let r = repeat("..")
         .take(parent_level)
-        .chain(r.into_iter())
+        .chain(r)
         // No `join` on `Iterator`.
         .collect::<Vec<_>>()
         .join("/");

dist/azure-build-and-test.yml

@@ -173,16 +173,52 @@ parameters:
     vars:
       TARGET: i686-unknown-linux-gnu
 
-  - name: mips_unknown_linux_gnu
-    vars:
-      TARGET: mips-unknown-linux-gnu
-
   - name: x86_64_unknown_linux_musl
     vars:
       TARGET: x86_64-unknown-linux-musl
 
 jobs:
 
+# rustfmt check
+- job: rustfmt
+  pool:
+    vmImage: ubuntu-20.04
+  steps:
+    - bash: rustup component add rustfmt
+      displayName: "Install rustfmt"
+    - bash: cargo fmt --all -- --check
+      displayName: "Check rustfmt (cargo)"
+  variables:
+    TOOLCHAIN: stable
+
+# clippy check
+- job: clippy
+  pool:
+    vmImage: ubuntu-20.04
+  steps:
+    - template: azure-generic-build-setup.yml
+    - bash: |
+        rustup component add clippy
+        cargo clippy --version
+      displayName: "Install clippy"
+    # Ew, redundant with stock builds:
+    - bash: |
+        set -xeuo pipefail
+        sudo apt-get update
+        sudo env DEBIAN_FRONTEND=noninteractive apt-get install -y \
+          libgraphite2-dev \
+          libharfbuzz-dev \
+          libfontconfig1-dev \
+          libicu-dev \
+          libssl-dev \
+          openssl \
+          zlib1g-dev
+      displayName: "Install pkg-config dependencies (Ubuntu)"
+    - bash: cargo clippy --all --all-targets --all-features -- --deny warnings
+      displayName: "Check clippy (cargo)"
+  variables:
+    TOOLCHAIN: stable
+
 # pkg-config builds
 - ${{ each build in parameters.pkgconfigBuilds }}:
   - job: ${{ format('build_{0}_pkgconfig', build.name) }}
@@ -227,46 +263,6 @@ jobs:
   variables:
     TOOLCHAIN: stable
 
-# rustfmt check
-- job: rustfmt
-  pool:
-    vmImage: ubuntu-20.04
-  steps:
-    - bash: rustup component add rustfmt
-      displayName: "Install rustfmt"
-    - bash: cargo fmt --all -- --check
-      displayName: "Check rustfmt (cargo)"
-  variables:
-    TOOLCHAIN: stable
-
-# clippy check
-- job: clippy
-  pool:
-    vmImage: ubuntu-20.04
-  steps:
-    - template: azure-generic-build-setup.yml
-    - bash: |
-        rustup component add clippy
-        cargo clippy --version
-      displayName: "Install clippy"
-    # Ew, redundant with stock builds:
-    - bash: |
-        set -xeuo pipefail
-        sudo apt-get update
-        sudo env DEBIAN_FRONTEND=noninteractive apt-get install -y \
-          libgraphite2-dev \
-          libharfbuzz-dev \
-          libfontconfig1-dev \
-          libicu-dev \
-          libssl-dev \
-          openssl \
-          zlib1g-dev
-      displayName: "Install pkg-config dependencies (Ubuntu)"
-    - bash: cargo clippy --all --all-targets --all-features -- --deny warnings
-      displayName: "Check clippy (cargo)"
-  variables:
-    TOOLCHAIN: stable
-
 # book build
 - job: book
   pool:

tests/bibtex.rs

@@ -8,12 +8,11 @@ use std::path::PathBuf;
 use tectonic::io::{FilesystemIo, IoProvider, IoStack, MemoryIo};
 use tectonic::BibtexEngine;
 use tectonic_bridge_core::{CoreBridgeLauncher, MinimalDriver};
-use tectonic_io_base::stdstreams::GenuineStdoutIo;
 use tectonic_status_base::NoopStatusBackend;
 
 #[path = "util/mod.rs"]
 mod util;
-use crate::util::{test_path, ExpectedInfo};
+use crate::util::{test_path, Expected, ExpectedFile};
 
 struct TestCase {
     stem: String,
@@ -55,9 +54,7 @@ impl TestCase {
 
         let mut assets = FilesystemIo::new(&p, false, false, HashSet::new());
 
-        let mut genio = GenuineStdoutIo::new();
-
-        let io_list: Vec<&mut dyn IoProvider> = vec![&mut genio, &mut mem, &mut assets];
+        let io_list: Vec<&mut dyn IoProvider> = vec![&mut mem, &mut assets];
 
         let io = IoStack::new(io_list);
         let mut hooks = MinimalDriver::new(io);
@@ -74,13 +71,16 @@ impl TestCase {
 
         let files = mem.files.borrow();
 
+        let mut expect = Expected::new();
+
         if self.test_bbl {
-            let expected_bbl = ExpectedInfo::read_with_extension(&mut p, "bbl");
-            expected_bbl.test_from_collection(&files);
+            expect =
+                expect.file(ExpectedFile::read_with_extension(&mut p, "bbl").collection(&files));
         }
 
-        let expected_blg = ExpectedInfo::read_with_extension(&mut p, "blg");
-        expected_blg.test_from_collection(&files);
+        expect
+            .file(ExpectedFile::read_with_extension(&mut p, "blg").collection(&files))
+            .finish();
     }
 }
 

tests/executable.rs

@@ -403,7 +403,7 @@ fn biber_no_such_tool() {
 
     command.env("TECTONIC_TEST_FAKE_BIBER", "ohnothereisnobiberprogram");
 
-    const REST: &str = r#"\bye"#;
+    const REST: &str = r"\bye";
     let tex = format!("{BIBER_TRIGGER_TEX}{REST}");
 
     command
@@ -431,15 +431,15 @@ fn biber_signal() {
 
 #[test]
 fn biber_success() {
-    const REST: &str = r#"
+    const REST: &str = r"
 \ifsecond
 \ifnum\input{biberout.qqq}=456\relax
 a
 \else
 \ohnothebiberdidntwork
 \fi
 \fi
-\bye"#;
+\bye";
     let tex = format!("{BIBER_TRIGGER_TEX}{REST}");
     let output = run_with_biber("success", &tex);
     success_or_panic(&output);
@@ -771,14 +771,14 @@ fn v2_dump_suffix() {
         writeln!(
             file,
             "{}", // <= works around {} fussiness in Rust format strings
-            r#"\newwrite\w
+            r"\newwrite\w
 \immediate\openout\w=first.demo\relax
 \immediate\write\w{content-un}
 \immediate\closeout\w
 \immediate\openout\w=second.demo\relax
 \immediate\write\w{content-deux}
 \immediate\closeout\w
-"#
+"
         )
         .unwrap();
     }
@@ -806,15 +806,15 @@ fn v2_dump_suffix() {
     assert!(saw_first && saw_second);
 }
 
-const SHELL_ESCAPE_TEST_DOC: &str = r#"\immediate\write18{mkdir shellwork}
+const SHELL_ESCAPE_TEST_DOC: &str = r"\immediate\write18{mkdir shellwork}
 \immediate\write18{echo 123 >shellwork/persist}
 \ifnum123=\input{shellwork/persist}
 a
 \else
 \ohnotheshellescapedidntwork
 \fi
 \bye
-"#;
+";
 
 /// Test that shell escape actually runs the commands
 #[test]

tests/tex-outputs.rs

@@ -17,7 +17,7 @@ use tectonic_status_base::NoopStatusBackend;
 
 #[path = "util/mod.rs"]
 mod util;
-use crate::util::{ensure_plain_format, test_path, ExpectedInfo};
+use crate::util::{ensure_plain_format, test_path, Expected, ExpectedFile};
 
 struct TestCase {
     stem: String,
@@ -107,7 +107,7 @@ impl TestCase {
         // add this layer.
         let mut assets = FilesystemIo::new(&test_path(&["assets"]), false, false, HashSet::new());
 
-        let expected_log = ExpectedInfo::read_with_extension(&mut p, "log");
+        let expected_log = ExpectedFile::read_with_extension(&mut p, "log");
 
         // Run the engine(s)!
         let res = {
@@ -159,20 +159,24 @@ impl TestCase {
 
         let files = mem.files.borrow();
 
-        expected_log.test_from_collection(&files);
+        let mut expect = Expected::new().file(expected_log.collection(&files));
 
         if expect_xdv {
-            ExpectedInfo::read_with_extension(&mut p, "xdv").test_from_collection(&files);
+            expect =
+                expect.file(ExpectedFile::read_with_extension(&mut p, "xdv").collection(&files));
         }
-
         if self.check_synctex {
-            ExpectedInfo::read_with_extension_rooted_gz(&mut p, "synctex.gz")
-                .test_from_collection(&files);
+            expect = expect.file(
+                ExpectedFile::read_with_extension_rooted_gz(&mut p, "synctex.gz")
+                    .collection(&files),
+            );
         }
-
         if self.check_pdf {
-            ExpectedInfo::read_with_extension(&mut p, "pdf").test_from_collection(&files);
+            expect =
+                expect.file(ExpectedFile::read_with_extension(&mut p, "pdf").collection(&files));
         }
+
+        expect.finish();
     }
 }
 

tests/trip.rs

@@ -24,7 +24,7 @@ use tectonic_status_base::NoopStatusBackend;
 
 #[path = "util/mod.rs"]
 mod util;
-use crate::util::{test_path, ExpectedInfo};
+use crate::util::{test_path, Expected, ExpectedFile};
 
 #[test]
 fn trip_test() {
@@ -41,11 +41,11 @@ fn trip_test() {
     let mut tfm = SingleInputFileIo::new(&p);
 
     // Read in the expected outputs.
-    let expected_log = ExpectedInfo::read_with_extension(&mut p, "log");
-    let expected_xdv = ExpectedInfo::read_with_extension(&mut p, "xdv");
-    let expected_fot = ExpectedInfo::read_with_extension(&mut p, "fot");
+    let expected_log = ExpectedFile::read_with_extension(&mut p, "log");
+    let expected_xdv = ExpectedFile::read_with_extension(&mut p, "xdv");
+    let expected_fot = ExpectedFile::read_with_extension(&mut p, "fot");
     p.set_file_name("tripos");
-    let expected_os = ExpectedInfo::read_with_extension(&mut p, "tex");
+    let expected_os = ExpectedFile::read_with_extension(&mut p, "tex");
 
     // MemoryIo layer that will accept the outputs. Save `files` since the
     // engine consumes `mem`.
@@ -81,10 +81,12 @@ fn trip_test() {
 
     // Check that outputs match expectations.
     let files = &*mem.files.borrow();
-    expected_log.test_from_collection(files);
-    expected_xdv.test_from_collection(files);
-    expected_os.test_from_collection(files);
-    expected_fot.test_data(&files.get("").unwrap().data);
+    Expected::new()
+        .file(expected_log.collection(files))
+        .file(expected_xdv.collection(files))
+        .file(expected_os.collection(files))
+        .file(expected_fot.data(&files.get("").unwrap().data))
+        .finish();
 }
 
 #[test]
@@ -102,10 +104,10 @@ fn etrip_test() {
     let mut tfm = SingleInputFileIo::new(&p);
 
     // Read in the expected outputs.
-    let expected_log = ExpectedInfo::read_with_extension(&mut p, "log");
-    let expected_xdv = ExpectedInfo::read_with_extension(&mut p, "xdv");
-    let expected_fot = ExpectedInfo::read_with_extension(&mut p, "fot");
-    let expected_out = ExpectedInfo::read_with_extension(&mut p, "out");
+    let expected_log = ExpectedFile::read_with_extension(&mut p, "log");
+    let expected_xdv = ExpectedFile::read_with_extension(&mut p, "xdv");
+    let expected_fot = ExpectedFile::read_with_extension(&mut p, "fot");
+    let expected_out = ExpectedFile::read_with_extension(&mut p, "out");
 
     // MemoryIo layer that will accept the outputs. Save `files` since the
     // engine consumes `mem`.
@@ -142,8 +144,10 @@ fn etrip_test() {
 
     // Check that outputs match expectations.
     let files = &*files.borrow();
-    expected_log.test_from_collection(files);
-    expected_xdv.test_from_collection(files);
-    expected_out.test_from_collection(files);
-    expected_fot.test_data(&files.get("").unwrap().data);
+    Expected::new()
+        .file(expected_log.collection(files))
+        .file(expected_xdv.collection(files))
+        .file(expected_out.collection(files))
+        .file(expected_fot.data(&files.get("").unwrap().data))
+        .finish();
 }