Run CI on Windows and MacOS (#35)

* Run CI on Windows and MacOS (#34)

* Setup tmate session in case of CI failure (#34)

* Removes windows

* cargo test on single thread

* cd before removing current dir

* windows ci is back

* fix cargo doc warnings

Co-authored-by: Daniel T <30197399+danwt@users.noreply.github.com>
Co-authored-by: Ranadeep Biswas <ranadeep@informal.systems>

.github/workflows/ci.yml

@@ -5,7 +5,13 @@ on: [push, pull_request]
 jobs:
   test:
     name: Test Suite
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - windows-latest
+          - ubuntu-latest
+          - macos-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
@@ -17,6 +23,11 @@ jobs:
         with:
           command: test
           args: -- --test-threads=1
+      - name: Setup tmate session
+        if: ${{ failure() }}
+        uses: mxschmitt/action-tmate@v3
+        with:
+          limit-access-to-actor: true
 
   fmt:
     name: Rustfmt

modelator/src/lib.rs

@@ -118,10 +118,10 @@ pub fn traces<P: AsRef<Path>>(
         )
         .collect::<Result<Vec<_>, _>>()?;
 
-    // cleanup everything by removing the temporary directory
-    dir.close()?;
     // restore the current directory
     env::set_current_dir(current_dir)?;
+    // cleanup everything by removing the temporary directory
+    dir.close()?;
 
     // convert each tla trace to json
     traces

modelator/src/module/apalache/mod.rs

@@ -12,14 +12,14 @@ use std::process::Command;
 pub struct Apalache;
 
 impl Apalache {
-    /// ```ignore
-    /// TODO: ignoring because of https://github.com/informalsystems/modelator/issues/47
+    /// TODO: ignoring because of <https://github.com/informalsystems/modelator/issues/47>
+    ///
     /// Generate a TLA+ trace given a [TlaFile] and a [TlaConfigFile] produced
     /// by [crate::module::Tla::generate_tests].
     ///
     /// # Examples
     ///
-    /// ```
+    /// ```ignore
     /// use modelator::artifact::{TlaFile, TlaConfigFile};
     /// use modelator::module::{Tla, Apalache};
     /// use modelator::Options;
@@ -78,14 +78,14 @@ impl Apalache {
         }
     }
 
-    /// ```ignore
-    /// TODO: ignoring because of https://github.com/informalsystems/modelator/issues/47
+    /// TODO: ignoring because of <https://github.com/informalsystems/modelator/issues/47>.
+    ///
     /// Runs Apalache's `parse` command, returning the [TlaFile] produced by
     /// Apalache.
     ///
     /// # Examples
     ///
-    /// ```
+    /// ```ignore
     /// use modelator::artifact::TlaFile;
     /// use modelator::module::Apalache;
     /// use modelator::Options;