Merge branch 'main' into dev

Author: ShootingStar91

src/commands/command_util.rs

@@ -507,8 +507,10 @@ static CONFIG_FILE_NAME: &str = "course_config.toml";
 
 /// Checks if current directory or given path
 /// contains valid exercise (i.e config file)
-/// Returns Err(msg) if given invalid path (including root )
-pub fn find_submit_or_paste_config(
+/// Returns Err(msg) if given invalid path (including root)
+/// Returns Ok(()) if no path given, but if current dir is not
+/// an exercise, leaves course_config as None
+pub fn find_course_config_for_exercise(
     exercise_slug: &mut String,
     course_config: &mut Option<CourseConfig>,
     exercise_dir: &mut PathBuf,
@@ -581,7 +583,7 @@ pub fn read_new_course_config(course_config_path: &Path) -> Result<Option<Course
     }
 }
 
-// retrieves exercise id for exercise from CourseConfig
+/// Retrieves exercise id for exercise from CourseConfig
 pub fn get_exercise_id_from_config(
     course_config: &CourseConfig,
     exercise_slug: &str,
@@ -593,7 +595,7 @@ pub fn get_exercise_id_from_config(
     }
 }
 
-// generates return_url for submissions and pastes
+/// Generates return_url for submissions and pastes
 pub fn generate_return_url(exercise_id: usize) -> String {
     format!(
         "{}/api/v8/core/exercises/{}/submissions",
@@ -609,7 +611,8 @@ pub fn get_projects_dir() -> PathBuf {
     tmc_langs::get_projects_dir(PLUGIN).unwrap()
 }
 
-/// Gives a list of all courses in projects-folder
+/// Choose course and then exercise interactively, return exercise path
+/// or Err(String) if either menu is interrupted or no items found
 pub fn choose_exercise() -> Result<PathBuf, String> {
     let mut courses: Vec<String> = Vec::new();
 

src/commands/download_command.rs

@@ -2,7 +2,7 @@ use std::path::PathBuf;
 use std::process::Command;
 
 use super::command_util;
-use super::command_util::*;
+use super::command_util::{get_projects_dir, Client};
 use crate::interactive;
 use crate::io_module::{Io, PrintColor};
 use crate::progress_reporting;

src/commands/exercises_command.rs

@@ -1,4 +1,4 @@
-use super::command_util::*;
+use super::command_util::{get_course_id_by_name, Client};
 use crate::io_module::{Io, PrintColor};
 
 use tmc_client::CourseExercise;

src/commands/paste_command.rs

@@ -1,5 +1,5 @@
 use super::command_util;
-use super::command_util::{ask_exercise_interactive, find_submit_or_paste_config, Client};
+use super::command_util::{ask_exercise_interactive, find_course_config_for_exercise, Client};
 use crate::io_module::{Io, PrintColor};
 use crate::progress_reporting;
 use crate::progress_reporting::ProgressBarManager;
@@ -24,7 +24,7 @@ pub fn paste(io: &mut dyn Io, client: &mut dyn Client, path: &str) {
     let mut course_config = None;
     let mut exercise_dir = std::path::PathBuf::new();
 
-    if let Err(error) = find_submit_or_paste_config(
+    if let Err(error) = find_course_config_for_exercise(
         &mut exercise_name,
         &mut course_config,
         &mut exercise_dir,

src/commands/submit_command.rs

@@ -1,5 +1,5 @@
 use super::command_util;
-use super::command_util::*;
+use super::command_util::{ask_exercise_interactive, find_course_config_for_exercise, Client};
 use crate::io_module::{Io, PrintColor};
 use crate::progress_reporting;
 use crate::progress_reporting::ProgressBarManager;
@@ -33,7 +33,7 @@ fn submit_logic(io: &mut dyn Io, client: &mut dyn Client, path: &str) {
     let mut course_config = None;
     let mut exercise_dir = std::path::PathBuf::new();
 
-    if let Err(error) = find_submit_or_paste_config(
+    if let Err(error) = find_course_config_for_exercise(
         &mut exercise_name,
         &mut course_config,
         &mut exercise_dir,
@@ -205,8 +205,8 @@ fn into_locale(arg: &str) -> Result<Language> {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use command_util::MockClient;
     use std::slice::Iter;
-
     pub struct IoTest<'a> {
         list: &'a mut Vec<String>,
         input: &'a mut Iter<'a, &'a str>,

src/commands/test_command.rs

@@ -1,51 +1,48 @@
 use crate::commands::command_util;
-use crate::commands::command_util::ask_exercise_interactive;
+use crate::commands::command_util::{ask_exercise_interactive, find_course_config_for_exercise};
 use crate::io_module::{Io, PrintColor};
-use std::env;
-use std::path::{Path, PathBuf};
+use std::path::Path;
 use tmc_langs::RunResult;
 
-/// Executes tmc tests for exercise(s)
+/// Executes tmc tests for one exercise. If path not given, check if current folder is an exercise.
+/// If not, asks exercise with an interactive menu.
 pub fn test(io: &mut dyn Io, exercise_folder: Option<&str>) {
-    let status = match env::current_dir() {
-        Ok(mut pathbuf) => {
-            if let Some(exercise) = exercise_folder {
-                pathbuf.push(exercise);
-            }
+    let mut exercise_name = "".to_string();
+    let mut course_config = None;
+    let mut exercise_dir = std::path::PathBuf::new();
 
-            match tmc_langs::find_exercise_directories(pathbuf.as_path()) {
-                Ok(exercises) => match exercises.len() {
-                    0 => ask_interactively_and_test(io),
-                    1 => test_exercise_path(io, exercises[0].as_path()),
-                    _ => test_exercises(io, exercises),
-                },
-                Err(_) => ask_interactively_and_test(io),
-            }
-        }
-        Err(error) => Err(format!(
-            "Invalid directory / Insufficient permissions: {}",
-            error
-        )),
-    };
+    let path = std::env::current_dir().unwrap();
+    let mut path = path.to_str().unwrap();
+    if let Some(folder) = exercise_folder {
+        path = folder;
+    }
 
-    if let Err(err) = status {
-        io.println(&err, PrintColor::Failed);
+    if let Err(error) = find_course_config_for_exercise(
+        &mut exercise_name,
+        &mut course_config,
+        &mut exercise_dir,
+        path,
+    ) {
+        if exercise_folder.is_some() {
+            io.println(&error, PrintColor::Failed);
+            return;
+        }
     }
-}
 
-/// Asks with interactive menu what exercise should be tested and runs tests
-fn ask_interactively_and_test(io: &mut dyn Io) -> Result<(), String> {
-    // No exercises found, ask with interactive menu
-    let mut exercise_name = String::from("");
-    let mut exercise_dir: PathBuf = PathBuf::new();
-    let mut course_config = None;
-    match ask_exercise_interactive(&mut exercise_name, &mut exercise_dir, &mut course_config) {
-        Ok(()) => (),
-        Err(msg) => {
-            return Err(msg);
+    if course_config.is_none() {
+        // Did not find course config, use interactive selection if possible
+        match ask_exercise_interactive(&mut exercise_name, &mut exercise_dir, &mut course_config) {
+            Ok(()) => (),
+            Err(msg) => {
+                io.println(&msg, PrintColor::Failed);
+                return;
+            }
         }
     }
-    test_exercise_path(io, &exercise_dir)
+
+    if let Err(err) = test_exercise_path(io, &exercise_dir) {
+        io.println(&err, PrintColor::Failed);
+    }
 }
 
 /// Wrapper around test_exercise funtion to get uniform Result type
@@ -56,25 +53,6 @@ fn test_exercise_path(io: &mut dyn Io, path: &Path) -> Result<(), String> {
         Ok(())
     }
 }
-/// Executes tmc tests for multiple exercises
-fn test_exercises(io: &mut dyn Io, paths: Vec<PathBuf>) -> Result<(), String> {
-    let mut exercises_completed = 0_usize;
-    let mut exercises_total = 0_usize;
-    for exercise_path in paths {
-        match test_exercise(io, exercise_path.as_path(), false) {
-            Ok(passed) => {
-                exercises_total += 1;
-                if passed {
-                    exercises_completed += 1;
-                }
-            }
-            Err(err) => return Err(err), // Stops iteration on first error
-        }
-    }
-
-    print_result_tests(io, exercises_completed, exercises_total);
-    Ok(())
-}
 
 /// Executes tests for a single exercise, returns true if all tests passed (false if not).
 fn test_exercise(io: &mut dyn Io, path: &Path, print_progress: bool) -> Result<bool, String> {
@@ -97,22 +75,6 @@ fn test_exercise(io: &mut dyn Io, path: &Path, print_progress: bool) -> Result<b
     }
 }
 
-/// Prints the end result of running multiple tests
-fn print_result_tests(io: &mut dyn Io, exercises_completed: usize, exercises_total: usize) {
-    io.println("", PrintColor::Normal);
-    io.println(
-        &format!(
-            "Total results: {}/{} exercises passed",
-            exercises_completed, exercises_total
-        ),
-        PrintColor::Normal,
-    );
-    io.println(
-        &command_util::get_progress_string(exercises_completed, exercises_total, 64),
-        PrintColor::Normal,
-    );
-}
-
 /// Prints the result of running tests for a single exercise
 fn print_result_test(
     io: &mut dyn Io,
@@ -485,71 +447,5 @@ mod tests {
                 "print_result_test returned true, expected false"
             );
         }
-
-        #[test]
-        fn print_multiple_completed_tests_results_test() {
-            let mut v: Vec<String> = Vec::new();
-            let input = vec![];
-            let mut input = input.iter();
-
-            let mut io = IoTest {
-                list: &mut v,
-                input: &mut input,
-            };
-
-            print_result_tests(&mut io, 10, 10);
-
-            assert_eq!(io.list[0], "");
-
-            assert!(
-                io.list[1].contains("Total results"),
-                "line does not contain 'Total results'"
-            );
-            assert!(
-                io.list[1].contains("10/10"),
-                "line does not contain total completed exercises '10/10'"
-            );
-            assert!(
-                io.list[2].contains("█"),
-                "line does not contain progress char '█'"
-            );
-            assert!(
-                !io.list[2].contains("░"),
-                "line contains progress char '░', which should not appear at 100% completed"
-            );
-        }
-
-        #[test]
-        fn print_multiple_failed_tests_results_test() {
-            let mut v: Vec<String> = Vec::new();
-            let input = vec![];
-            let mut input = input.iter();
-
-            let mut io = IoTest {
-                list: &mut v,
-                input: &mut input,
-            };
-
-            print_result_tests(&mut io, 5, 10);
-
-            assert_eq!(io.list[0], "");
-
-            assert!(
-                io.list[1].contains("Total results"),
-                "line does not contain 'Total results'"
-            );
-            assert!(
-                io.list[1].contains("5/10"),
-                "line does not contain total completed exercises '10/10'"
-            );
-            assert!(
-                io.list[2].contains("█"),
-                "line does not contain progress char '█'"
-            );
-            assert!(
-                io.list[2].contains("░"),
-                "line does not contain progress char '░'"
-            );
-        }
     }
 }

tests/command_line_test.rs

@@ -124,7 +124,7 @@ fn all_integration_tests() -> Result<(), Box<dyn std::error::Error>> {
         .arg("folder/nonexistant_ex");
     cmd.assert()
         .success()
-        .stdout(predicate::str::contains("No exercises found"));
+        .stdout(predicate::str::contains("Invalid exercise path given"));
 
     // tmc-cli-rust --testmode --no-update logout
     let mut cmd = Command::cargo_bin(PKG_NAME.unwrap())?;