return data from download-or-update-course-exercises

Author: Heliozoa

tmc-langs-cli/src/app.rs

@@ -1,6 +1,6 @@
 //! Create clap app
 
-use crate::output::CombinedCourseData;
+use crate::output::{CombinedCourseData, DownloadOrUpdateCourseExercisesResult};
 use clap::{App, AppSettings, Arg, SubCommand};
 use schemars::JsonSchema;
 use std::path::PathBuf;
@@ -370,7 +370,7 @@ fn create_core_app() -> App<'static, 'static> {
 
         .subcommand(SubCommand::with_name("download-or-update-course-exercises")
             .about("Downloads exercises. If downloading an exercise that has been downloaded before, the student file policy will be used to avoid overwriting student files, effectively just updating the exercise files")
-            .long_about(SCHEMA_NULL)
+            .long_about(schema_leaked::<DownloadOrUpdateCourseExercisesResult>())
             .arg(Arg::with_name("exercise-id")
                 .help("Exercise id of an exercise that should be downloaded. Multiple ids can be given.")
                 .long("exercise-id")

tmc-langs-cli/src/main.rs

@@ -9,7 +9,8 @@ use self::config::ProjectsConfig;
 use self::config::{CourseConfig, Credentials, Exercise, TmcConfig};
 use self::error::{InvalidTokenError, SandboxTestError};
 use self::output::{
-    CombinedCourseData, ErrorData, Kind, Output, OutputData, OutputResult, Status, Warnings,
+    CombinedCourseData, DownloadOrUpdateCourseExercise, DownloadOrUpdateCourseExercisesResult,
+    ErrorData, Kind, Output, OutputData, OutputResult, Status, Warnings,
 };
 use anyhow::{Context, Result};
 use clap::{ArgMatches, Error, ErrorKind};
@@ -818,6 +819,8 @@ fn run_core(
 
             let mut course_data = HashMap::<String, Vec<(String, String)>>::new();
             let mut exercises_and_paths = vec![];
+            let mut downloaded = vec![];
+            let mut skipped = vec![];
             for exercise_detail in exercises_details {
                 // check if the checksum is different from what's already on disk
                 if let Some(course_config) =
@@ -834,10 +837,20 @@ fn run_core(
                                 exercise_detail.course_name,
                                 exercise_detail.exercise_name
                             );
+                            skipped.push(DownloadOrUpdateCourseExercise {
+                                course_slug: exercise_detail.course_name,
+                                exercise_slug: exercise_detail.exercise_name,
+                            });
                             continue;
                         }
                     }
                 }
+                // not skipped, will be downloaded
+                // if any download fails, an error is returned instead, so it's ok to just push them to downloaded here
+                downloaded.push(DownloadOrUpdateCourseExercise {
+                    course_slug: exercise_detail.course_name.clone(),
+                    exercise_slug: exercise_detail.exercise_name.clone(),
+                });
 
                 let target = ProjectsConfig::get_exercise_download_target(
                     &projects_dir,
@@ -873,12 +886,16 @@ fn run_core(
                 };
             }
 
-            let output = Output::OutputData::<()>(OutputData {
+            let data = DownloadOrUpdateCourseExercisesResult {
+                downloaded,
+                skipped,
+            };
+            let output = Output::OutputData(OutputData {
                 status: Status::Finished,
                 message: None,
                 result: OutputResult::RetrievedData,
                 percent_done: 1.0,
-                data: None,
+                data: Some(data),
             });
             print_output(&output, pretty, &warnings)?
         }

tmc-langs-cli/src/output.rs

@@ -79,6 +79,19 @@ pub struct CombinedCourseData {
     pub settings: CourseData,
 }
 
+#[derive(Debug, Serialize, JsonSchema)]
+pub struct DownloadOrUpdateCourseExercisesResult {
+    pub downloaded: Vec<DownloadOrUpdateCourseExercise>,
+    pub skipped: Vec<DownloadOrUpdateCourseExercise>,
+}
+
+#[derive(Debug, Serialize, JsonSchema)]
+#[serde(rename_all = "kebab-case")]
+pub struct DownloadOrUpdateCourseExercise {
+    pub course_slug: String,
+    pub exercise_slug: String,
+}
+
 #[derive(Debug, Serialize)]
 pub struct DownloadTarget {
     pub id: usize,