Merge pull request #141 from rage/etc

added tests and docs, fixed bugs

Author: Heliozoa

README.md

@@ -72,7 +72,7 @@ A "frontend" for tmc-langs. A binary CLI client for TMC-langs for IDEs. Intended
 
 ### tmc-langs
 
-The "backend". A library that provides a convenient API for implementing different frontends. A frontend (such as a CLI) should only depend on this and optionally the util library.
+The "backend". A library that provides a convenient API for implementing different frontends. A frontend (such as a CLI) should only depend on this.
 
 ### tmc-client
 

plugins/csharp/tests/data/failing-exercise/nuget.config

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>

plugins/csharp/tests/data/non-compiling-exercise/nuget.config

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>

plugins/csharp/tests/data/partially-passing/nuget.config

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>

plugins/csharp/tests/data/passing-exercise/nuget.config

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+</configuration>

tmc-client/src/error.rs

@@ -57,6 +57,8 @@ pub enum ClientError {
     CacheDir,
     #[error("No values found in exercise details map returned by server")]
     MissingDetailsValue,
+    #[error("List of exercises given was empty")]
+    NoExercisesGiven,
 
     #[error(transparent)]
     SystemTime(#[from] std::time::SystemTimeError),

tmc-client/src/tmc_client.rs

@@ -18,8 +18,7 @@ use std::sync::Arc;
 use std::thread;
 use std::time::Duration;
 use tempfile::NamedTempFile;
-use tmc_langs_util::{file_util, progress_reporter, FileError};
-use walkdir::WalkDir;
+use tmc_langs_util::{progress_reporter, FileError};
 
 /// Authentication token.
 pub type Token =
@@ -347,37 +346,6 @@ impl TmcClient {
         Ok(result)
     }
 
-    pub fn reset(&self, exercise_id: usize, exercise_path: PathBuf) -> Result<(), ClientError> {
-        // clear out the exercise directory
-        if exercise_path.exists() {
-            let mut tries = 0;
-            for entry in WalkDir::new(&exercise_path).min_depth(1) {
-                let entry = entry?;
-                log::debug!("{:?}", entry);
-                // windows sometimes fails due to files being in use, retry a few times
-                // todo: handle properly
-                if entry.path().is_dir() {
-                    while let Err(err) = file_util::remove_dir_all(entry.path()) {
-                        tries += 1;
-                        if tries > 8 {
-                            return Err(ClientError::FileError(err));
-                        }
-                        thread::sleep(Duration::from_secs(1));
-                    }
-                } else {
-                    while let Err(err) = file_util::remove_file(entry.path()) {
-                        tries += 1;
-                        if tries > 8 {
-                            return Err(ClientError::FileError(err));
-                        }
-                        thread::sleep(Duration::from_secs(1));
-                    }
-                }
-            }
-        }
-        self.download_exercise(exercise_id, &exercise_path)
-    }
-
     pub fn download_old_submission(
         &self,
         submission_id: usize,

tmc-client/src/tmc_client/api.rs

@@ -659,6 +659,10 @@ impl TmcClient {
         if self.0.token.is_none() {
             return Err(ClientError::NotLoggedIn);
         }
+        if exercise_ids.is_empty() {
+            return Err(ClientError::NoExercisesGiven);
+        }
+
         let url_tail = "core/exercises/details";
         let exercise_ids = (
             "ids".to_string(),

tmc-langs-cli/src/lib.rs

@@ -1059,7 +1059,7 @@ fn run_core(
             }
 
             // reset exercise
-            client.reset(exercise_id, exercise_path)?;
+            tmc_langs::reset(&client, exercise_id, exercise_path)?;
 
             let output = Output::finished_with_data("reset exercise", None);
             print_output(&output, pretty)?

tmc-langs-plugins/src/tmc_zip.rs

@@ -168,6 +168,7 @@ where
     Ok(())
 }
 
+// TODO: make more robust, use language plugins?
 fn find_project_dir<R: Read + Seek>(zip_archive: &mut ZipArchive<R>) -> Result<PathBuf, TmcError> {
     for i in 0..zip_archive.len() {
         let file = zip_archive.by_index(i)?;