Merge branch 'dev-testing' into dev

.github/workflows/push_branch.yml

@@ -29,7 +29,7 @@ jobs:
       with:
         toolchain: stable
     - name: Test
-      run: cargo test --verbose
+      run: TEST_SETTING=0 cargo test --verbose
 
   # Push formatting commit even if compilation/testing fails. This does not
   # push a commit if no formatting is required.

.github/workflows/push_main.yml

@@ -33,7 +33,7 @@ jobs:
       with:
         toolchain: stable
     - name: Test
-      run: cargo test --verbose
+      run: TEST_SETTING=0 cargo test --verbose
 
   check_format:
     runs-on: ubuntu-latest

src/game/test.rs

@@ -27,6 +27,11 @@ impl mock::Session<'_> {
     /// Creates an SVG visualization of the game graph in the visuals directory
     /// under the development data directory at the project root.
     pub fn visualize(&self, module: &str) -> Result<()> {
+        match test_setting()? {
+            TestSetting::Correctness => return Ok(()),
+            TestSetting::Development => (),
+        }
+
         let name = format!("{}.svg", self.name()).replace(" ", "-");
         let mut dir = get_directory(TestData::Visuals)?;
 

src/test.rs

@@ -12,10 +12,12 @@ use strum_macros::Display;
 
 use std::{env, fs, path};
 
-/* DATA RESOURCES DIRECTORY */
+/* CONSTANTS */
 
 const DATA_DIRECTORY: &str = "data";
 
+/* DEFINITIONS */
+
 /// Specifies directories for different kinds of data generated for development
 /// purposes, which should not be distributed.
 #[derive(Display)]
@@ -24,8 +26,34 @@ pub enum TestData {
     Visuals,
 }
 
+/// Specifies the level of side effects to generate during testing. This
+/// corresponds to the `TEST_SETTING` environment variable.
+pub enum TestSetting {
+    Correctness,
+    Development,
+}
+
 /* UTILITY FUNCTIONS */
 
+/// Returns the testing side effects setting as obtained from the `TEST_SETTING`
+/// environment variable.
+pub fn test_setting() -> Result<TestSetting> {
+    if let Ok(setting) = env::var("TEST_SETTING") {
+        match &setting[..] {
+            "0" => Ok(TestSetting::Correctness),
+            "1" => Ok(TestSetting::Development),
+            _ => Err(anyhow! {
+                format!(
+                    "TEST_SETTING assignment '{}' not recognized.",
+                    setting
+                )
+            }),
+        }
+    } else {
+        Ok(TestSetting::Development)
+    }
+}
+
 /// Returns a PathBuf corresponding to the correct subdirectory for storing
 /// development `data`, creating it in the process if it does not exist.
 pub fn get_directory(data: TestData) -> Result<path::PathBuf> {