improved tmc-client's public API and added test

Author: Heliozoa

tmc-client/src/lib.rs

@@ -12,18 +12,13 @@
 //!
 
 mod error;
-mod request;
-mod response;
+pub mod request;
+pub mod response;
 mod tmc_client;
 
 pub use self::error::ClientError;
-pub use self::request::FeedbackAnswer;
-pub use self::response::{
-    Course, CourseData, CourseDataExercise, CourseDataExercisePoint, CourseDetails, CourseExercise,
-    Exercise, ExerciseDetails, ExercisesDetails, NewSubmission, Organization, Review, Submission,
-    SubmissionFeedbackResponse, SubmissionFinished, SubmissionProcessingStatus, SubmissionStatus,
-    User,
-};
 pub use self::tmc_client::{api_v8, ClientUpdateData, TmcClient, Token, UpdateResult};
+
+// these types are part of tmc-client's API and thus re-exported
 pub use oauth2;
-pub use tmc_langs_plugins::{Language, RunResult, StyleValidationResult, StyleValidationStrategy};
+pub use tmc_langs_plugins::Language;

tmc-client/src/tmc_client.rs

@@ -5,7 +5,6 @@ use self::api_v8::{PasteData, ReviewData};
 use crate::error::ClientError;
 use crate::request::*;
 use crate::response::*;
-use crate::Language;
 use oauth2::{
     basic::BasicClient, AuthUrl, ClientId, ClientSecret, ResourceOwnerPassword,
     ResourceOwnerUsername, TokenUrl,
@@ -19,6 +18,7 @@ use std::thread;
 use std::time::Duration;
 use std::{collections::HashMap, io::Cursor};
 use std::{io::Write, u32};
+use tmc_langs_plugins::Language;
 use tmc_langs_util::progress_reporter;
 
 /// Authentication token.
@@ -571,17 +571,6 @@ impl TmcClient {
         Ok(())
     }
 
-    /// Checks the status of a submission on the server. May require authentication.
-    ///
-    /// # Errors
-    /// If authentication is required but the client is not authenticated, if there's some problem reaching the API, or if the API returns an error.
-    pub fn check_submission(
-        &self,
-        submission_id: u32,
-    ) -> Result<SubmissionProcessingStatus, ClientError> {
-        api_v8::get_submission(self, submission_id)
-    }
-
     /// Request code review. Requires authentication.
     ///
     /// # Errors
@@ -596,12 +585,6 @@ impl TmcClient {
     }
 }
 
-impl AsRef<TmcCore> for TmcClient {
-    fn as_ref(&self) -> &TmcCore {
-        &self.0
-    }
-}
-
 fn start_stage(steps: u32, message: impl Into<String>, data: impl Into<Option<ClientUpdateData>>) {
     progress_reporter::start_stage(steps, message.into(), data.into())
 }
@@ -617,6 +600,9 @@ fn finish_stage(message: impl Into<String>, data: impl Into<Option<ClientUpdateD
 #[cfg(test)]
 #[allow(clippy::clippy::unwrap_used)]
 mod test {
+    use std::sync::atomic::AtomicBool;
+
+    // many of TmcClient's functions simply call already tested functions from api_v8 and don't need testing
     use super::*;
     use mockito::Matcher;
     use oauth2::{basic::BasicTokenType, AccessToken, EmptyExtraTokenFields};
@@ -760,4 +746,57 @@ mod test {
         assert_eq!(update_result.updated.len(), 1);
         assert_eq!(update_result.updated[0].checksum, "zz");
     }
+
+    #[test]
+    fn waits_for_submission() {
+        init();
+
+        let client = make_client();
+        let m = mockito::mock("GET", "/api/v8/core/submission/0")
+            .match_query(Matcher::AllOf(vec![
+                Matcher::UrlEncoded("client".into(), "some_client".into()),
+                Matcher::UrlEncoded("client_version".into(), "some_ver".into()),
+            ]))
+            .with_body_from_fn(|w| {
+                static CALLED: AtomicBool = AtomicBool::new(false);
+                if !CALLED.load(std::sync::atomic::Ordering::SeqCst) {
+                    CALLED.store(true, std::sync::atomic::Ordering::SeqCst);
+                    w.write_all(
+                        br#"
+                    {
+                        "status": "processing",
+                        "sandbox_status": "created"
+                    }
+                    "#,
+                    )
+                    .unwrap();
+                } else {
+                    w.write_all(
+                        br#"
+                    {
+                        "api_version": 0,
+                        "user_id": 1,
+                        "login": "",
+                        "course": "",
+                        "exercise_name": "",
+                        "status": "processing",
+                        "points": [],
+                        "submission_url": "",
+                        "submitted_at": "",
+                        "reviewed": false,
+                        "requests_review": false,
+                        "missing_review_points": []
+                    }
+                    "#,
+                    )
+                    .unwrap();
+                }
+                Ok(())
+            })
+            .expect(2)
+            .create();
+
+        let _res = client.wait_for_submission(0).unwrap();
+        m.assert();
+    }
 }

tmc-client/tests/api_integration.rs

@@ -1,6 +1,6 @@
 use dotenv::dotenv;
 use std::{env, io::Read};
-use tmc_client::{api_v8, FeedbackAnswer, TmcClient};
+use tmc_client::{api_v8, request::FeedbackAnswer, TmcClient};
 
 const ORGANIZATION_SLUG: &str = "hy";
 const COURSE_NAME: &str = "java-1-f2020";

tmc-langs/src/data.rs

@@ -4,7 +4,7 @@ use schemars::JsonSchema;
 use serde::Serialize;
 use std::fmt::{Display, Formatter, Result as FmtResult};
 use std::{collections::HashMap, path::PathBuf};
-use tmc_client::{CourseData, CourseDetails, CourseExercise};
+use tmc_client::response::{CourseData, CourseDetails, CourseExercise};
 
 use crate::error::{LangsError, ParamError};
 

tmc-langs/src/lib.rs

@@ -26,13 +26,16 @@ use hmac::{Hmac, NewMac};
 use serde::Serialize;
 use sha2::Sha256;
 pub use tmc_client::{
-    ClientError, ClientUpdateData, Course, CourseData, CourseDetails, CourseExercise,
-    ExerciseDetails, FeedbackAnswer, NewSubmission, Organization, Review, RunResult,
-    StyleValidationResult, Submission, SubmissionFeedbackResponse, SubmissionFinished, TmcClient,
-    Token, UpdateResult,
+    request::FeedbackAnswer,
+    response::{
+        Course, CourseData, CourseDetails, CourseExercise, ExerciseDetails, NewSubmission,
+        Organization, Review, Submission, SubmissionFeedbackResponse, SubmissionFinished,
+    },
+    ClientError, ClientUpdateData, TmcClient, Token, UpdateResult,
 };
 pub use tmc_langs_framework::{
     CommandError, ExerciseDesc, ExercisePackagingConfiguration, Language, LanguagePlugin,
+    RunResult, StyleValidationResult,
 };
 pub use tmc_langs_util::{
     file_util::{self, FileLockGuard},
@@ -1003,7 +1006,7 @@ fn extract_project_overwrite(
 #[allow(clippy::clippy::unwrap_used)]
 mod test {
     use std::io::Write;
-    use tmc_client::ExercisesDetails;
+    use tmc_client::response::ExercisesDetails;
 
     use super::*;