Disable Java plugin on musl

Heliozoa · Heliozoa · commit b7aa86893079 · 2024-09-09T11:18:49.000+03:00
diff --git a/crates/plugins/java/README.md b/crates/plugins/java/README.md
@@ -15,6 +15,8 @@ The `./deps` directory contains some Java dependencies, such as a bundled Maven
   - https://maven.mooc.fi/snapshots/fi/helsinki/cs/tmc/tmc-junit-runner/{VERSION}/maven-metadata.xml (Find the `snapshotVersion.value`)
   - https://maven.mooc.fi/snapshots/fi/helsinki/cs/tmc/tmc-junit-runner/{VERSION}/tmc-junit-runner-{SNAPSHOT_VERSION}.jar
 
+Note that this plugin is not supported on musl due to dynamic loading not being supported on the platform.
+
 ## Maven
 
 ### Student file policy
diff --git a/crates/plugins/java/src/error.rs b/crates/plugins/java/src/error.rs
@@ -42,8 +42,6 @@ stderr: {}
     },
     #[error("J4rs panicked: {0}")]
     J4rsPanic(String),
-    #[error("This program does not support Java on this platform due to dynamic loading not being supported on musl. As a result, J4rs panicked: {0}")]
-    UnsupportedPlatformMusl(String),
 
     #[error(transparent)]
     WalkDir(#[from] walkdir::Error),
diff --git a/crates/plugins/java/src/lib.rs b/crates/plugins/java/src/lib.rs
@@ -2,6 +2,9 @@
 
 //! Java plugins for ant and maven
 
+#[cfg(target_env = "musl")]
+compile_error!("The Java plugin does not work on musl");
+
 mod ant_plugin;
 mod ant_policy;
 mod error;
@@ -165,15 +168,7 @@ fn instantiate_jvm() -> Result<JvmWrapper, JavaError> {
                 "J4rs panicked without an error message".to_string()
             };
 
-            // it's expected that we end up here when running on musl as libjvm is dynamically linked
-            // (and statically linking it seems challenging)
-            // we could fail early and error as soon as we recognise a Java project on musl,
-            // but this is a very niche issue and this is a foolproof place to detect it
-            if cfg!(target_env = "musl") {
-                return Err(JavaError::UnsupportedPlatformMusl(error_message));
-            } else {
-                return Err(JavaError::J4rsPanic(error_message));
-            }
+            return Err(JavaError::J4rsPanic(error_message));
         }
     };
 
diff --git a/crates/tmc-langs-plugins/Cargo.toml b/crates/tmc-langs-plugins/Cargo.toml
@@ -11,7 +11,6 @@ tmc-langs-framework.workspace = true
 tmc-langs-util.workspace = true
 
 tmc-langs-csharp.workspace = true
-tmc-langs-java.workspace = true
 tmc-langs-make.workspace = true
 tmc-langs-notests.workspace = true
 tmc-langs-python3.workspace = true
@@ -25,6 +24,10 @@ walkdir = "2.3.2"
 zip = "2.2.0"
 zstd = "0.13.0"
 
+# The Java plugin causes compilation to fail on musl
+[target.'cfg(not(target_env = "musl"))'.dependencies]
+tmc-langs-java.workspace = true
+
 [dev-dependencies]
 simple_logger = "5.0.0"
 tempfile = "3.3.0"
diff --git a/crates/tmc-langs-plugins/src/error.rs b/crates/tmc-langs-plugins/src/error.rs
@@ -1,20 +1,29 @@
 //! Contains the PluginError type.
 
 use std::path::PathBuf;
+// the Java plugin is disabled on musl
+#[cfg(not(target_env = "musl"))]
 use tmc_langs_java::JavaError;
 
 #[derive(thiserror::Error, Debug)]
 pub enum PluginError {
+    // on musl, warn the user about the Java plugin being nonfunctional
+    #[cfg(not(target_env = "musl"))]
     #[error("No matching plugin found for {0}")]
     PluginNotFound(PathBuf),
-    #[error("No matching plugin found in archive")]
+    #[cfg(target_env = "musl")]
+    #[error("No matching plugin found for {0}. Note that Java support is disabled on musl.")]
+    PluginNotFound(PathBuf),
+    #[error("No matching plugin found in archive.")]
     PluginNotFoundInArchive,
     #[error(transparent)]
     Tmc(#[from] tmc_langs_framework::TmcError),
     #[error(transparent)]
     Walkdir(#[from] walkdir::Error),
 }
 
+// the Java plugin is disabled on musl
+#[cfg(not(target_env = "musl"))]
 impl From<JavaError> for PluginError {
     fn from(e: JavaError) -> Self {
         Self::Tmc(e.into())
diff --git a/crates/tmc-langs-plugins/src/lib.rs b/crates/tmc-langs-plugins/src/lib.rs
@@ -18,6 +18,8 @@ pub use tmc_langs_framework::{
     NothingIsStudentFilePolicy, RunResult, StudentFilePolicy, StyleValidationResult,
     StyleValidationStrategy,
 };
+// the Java plugin is disabled on musl
+#[cfg(not(target_env = "musl"))]
 pub use tmc_langs_java::{AntPlugin, MavenPlugin};
 pub use tmc_langs_make::MakePlugin;
 pub use tmc_langs_notests::NoTestsPlugin;
@@ -62,19 +64,17 @@ pub fn compress_project(
 }
 
 /// Enum containing variants for each language plugin.
-#[impl_enum::with_methods(
-    pub fn clean(&self, path: &Path) -> Result<(), TmcError>
-    pub fn scan_exercise(&self, path: &Path, exercise_name: String) -> Result<ExerciseDesc, TmcError>
-    pub fn run_tests(&self, path: &Path) -> Result<RunResult, TmcError>
-    pub fn check_code_style(&self, path: &Path, locale: Language) -> Result<Option<StyleValidationResult>, TmcError>
-)]
 pub enum Plugin {
     CSharp(CSharpPlugin),
     Make(MakePlugin),
+    // the Java plugin is disabled on musl
+    #[cfg(not(target_env = "musl"))]
     Maven(MavenPlugin),
     NoTests(NoTestsPlugin),
     Python3(Python3Plugin),
     R(RPlugin),
+    // the Java plugin is disabled on musl
+    #[cfg(not(target_env = "musl"))]
     Ant(AntPlugin),
 }
 
@@ -87,22 +87,102 @@ impl Plugin {
             PluginType::Make => Plugin::Make(MakePlugin::new()),
             PluginType::Python3 => Plugin::Python3(Python3Plugin::new()),
             PluginType::R => Plugin::R(RPlugin::new()),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
             PluginType::Maven => Plugin::Maven(MavenPlugin::new()?),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
             PluginType::Ant => Plugin::Ant(AntPlugin::new()?),
         };
         Ok(plugin)
     }
+
+    pub fn clean(&self, path: &Path) -> Result<(), TmcError> {
+        match self {
+            Plugin::CSharp(plugin) => plugin.clean(path),
+            Plugin::Make(plugin) => plugin.clean(path),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Maven(plugin) => plugin.clean(path),
+            Plugin::NoTests(plugin) => plugin.clean(path),
+            Plugin::Python3(plugin) => plugin.clean(path),
+            Plugin::R(plugin) => plugin.clean(path),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Ant(plugin) => plugin.clean(path),
+        }
+    }
+
+    pub fn scan_exercise(
+        &self,
+        path: &Path,
+        exercise_name: String,
+    ) -> Result<ExerciseDesc, TmcError> {
+        match self {
+            Plugin::CSharp(plugin) => plugin.scan_exercise(path, exercise_name),
+            Plugin::Make(plugin) => plugin.scan_exercise(path, exercise_name),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Maven(plugin) => plugin.scan_exercise(path, exercise_name),
+            Plugin::NoTests(plugin) => plugin.scan_exercise(path, exercise_name),
+            Plugin::Python3(plugin) => plugin.scan_exercise(path, exercise_name),
+            Plugin::R(plugin) => plugin.scan_exercise(path, exercise_name),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Ant(plugin) => plugin.scan_exercise(path, exercise_name),
+        }
+    }
+
+    pub fn run_tests(&self, path: &Path) -> Result<RunResult, TmcError> {
+        match self {
+            Plugin::CSharp(plugin) => plugin.run_tests(path),
+            Plugin::Make(plugin) => plugin.run_tests(path),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Maven(plugin) => plugin.run_tests(path),
+            Plugin::NoTests(plugin) => plugin.run_tests(path),
+            Plugin::Python3(plugin) => plugin.run_tests(path),
+            Plugin::R(plugin) => plugin.run_tests(path),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Ant(plugin) => plugin.run_tests(path),
+        }
+    }
+
+    pub fn check_code_style(
+        &self,
+        path: &Path,
+        locale: Language,
+    ) -> Result<Option<StyleValidationResult>, TmcError> {
+        match self {
+            Plugin::CSharp(plugin) => plugin.check_code_style(path, locale),
+            Plugin::Make(plugin) => plugin.check_code_style(path, locale),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Maven(plugin) => plugin.check_code_style(path, locale),
+            Plugin::NoTests(plugin) => plugin.check_code_style(path, locale),
+            Plugin::Python3(plugin) => plugin.check_code_style(path, locale),
+            Plugin::R(plugin) => plugin.check_code_style(path, locale),
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            Plugin::Ant(plugin) => plugin.check_code_style(path, locale),
+        }
+    }
 }
 
 /// Allows calling LanguagePlugin functions without constructing the plugin.
 #[derive(Clone, Copy)]
 pub enum PluginType {
     CSharp,
     Make,
+    // the Java plugin is disabled on musl
+    #[cfg(not(target_env = "musl"))]
     Maven,
     NoTests,
     Python3,
     R,
+    // the Java plugin is disabled on musl
+    #[cfg(not(target_env = "musl"))]
     Ant,
 }
 
@@ -111,10 +191,14 @@ macro_rules! delegate_plugin_type {
         match $self {
             Self::CSharp => CSharpPlugin::$($args)*,
             Self::Make => MakePlugin::$($args)*,
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
             Self::Maven => MavenPlugin::$($args)*,
             Self::NoTests => NoTestsPlugin::$($args)*,
             Self::Python3 => Python3Plugin::$($args)*,
             Self::R => RPlugin::$($args)*,
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
             Self::Ant => AntPlugin::$($args)*,
         }
     };
@@ -132,12 +216,18 @@ impl PluginType {
             (Python3Plugin::PLUGIN_NAME, PluginType::Python3)
         } else if RPlugin::is_exercise_type_correct(path) {
             (RPlugin::PLUGIN_NAME, PluginType::R)
-        } else if MavenPlugin::is_exercise_type_correct(path) {
-            (MavenPlugin::PLUGIN_NAME, PluginType::Maven)
-        } else if AntPlugin::is_exercise_type_correct(path) {
-            // TODO: currently, ant needs to be last because any project with src and test are recognized as ant
-            (AntPlugin::PLUGIN_NAME, PluginType::Ant)
         } else {
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            if MavenPlugin::is_exercise_type_correct(path) {
+                (MavenPlugin::PLUGIN_NAME, PluginType::Maven)
+            } else if AntPlugin::is_exercise_type_correct(path) {
+                // TODO: currently, ant needs to be last because any project with src and test are recognized as ant
+                (AntPlugin::PLUGIN_NAME, PluginType::Ant)
+            } else {
+                return Err(PluginError::PluginNotFound(path.to_path_buf()));
+            }
+            #[cfg(target_env = "musl")]
             return Err(PluginError::PluginNotFound(path.to_path_buf()));
         };
         log::info!("Detected project at {} as {}", path.display(), plugin_name);
@@ -155,12 +245,18 @@ impl PluginType {
             (Python3Plugin::PLUGIN_NAME, PluginType::Python3)
         } else if RPlugin::is_archive_type_correct(archive) {
             (RPlugin::PLUGIN_NAME, PluginType::R)
-        } else if MavenPlugin::is_archive_type_correct(archive) {
-            (MavenPlugin::PLUGIN_NAME, PluginType::Maven)
-        } else if AntPlugin::is_archive_type_correct(archive) {
-            // TODO: currently, ant needs to be last because any project with src and test are recognized as ant
-            (AntPlugin::PLUGIN_NAME, PluginType::Ant)
         } else {
+            // the Java plugin is disabled on musl
+            #[cfg(not(target_env = "musl"))]
+            if MavenPlugin::is_archive_type_correct(archive) {
+                (MavenPlugin::PLUGIN_NAME, PluginType::Maven)
+            } else if AntPlugin::is_archive_type_correct(archive) {
+                // TODO: currently, ant needs to be last because any project with src and test are recognized as ant
+                (AntPlugin::PLUGIN_NAME, PluginType::Ant)
+            } else {
+                return Err(PluginError::PluginNotFoundInArchive);
+            }
+            #[cfg(target_env = "musl")]
             return Err(PluginError::PluginNotFoundInArchive);
         };
         log::info!("Detected project in archive as {}", plugin_name);
@@ -222,9 +318,13 @@ pub fn get_student_file_policy(path: &Path) -> Result<Box<dyn StudentFilePolicy>
             path,
         )?),
         PluginType::R => Box::new(<RPlugin as LanguagePlugin>::StudentFilePolicy::new(path)?),
+        // the Java plugin is disabled on musl
+        #[cfg(not(target_env = "musl"))]
         PluginType::Maven => Box::new(<MavenPlugin as LanguagePlugin>::StudentFilePolicy::new(
             path,
         )?),
+        // the Java plugin is disabled on musl
+        #[cfg(not(target_env = "musl"))]
         PluginType::Ant => Box::new(<AntPlugin as LanguagePlugin>::StudentFilePolicy::new(path)?),
     };
     Ok(policy)
diff --git a/crates/tmc-langs/src/lib.rs b/crates/tmc-langs/src/lib.rs
@@ -41,16 +41,16 @@ use std::{
     path::{Path, PathBuf},
     sync::{Arc, Mutex},
 };
-use tmc_langs_framework::{Archive, TmcError};
+use tmc_langs_framework::Archive;
 pub use tmc_langs_framework::{
     CommandError, Compression, ExerciseDesc, ExercisePackagingConfiguration, Language,
     LanguagePlugin, PythonVer, RunResult, RunStatus, StyleValidationError, StyleValidationResult,
     StyleValidationStrategy, TestDesc, TestResult, TmcProjectYml,
 };
 use tmc_langs_plugins::{
-    AntPlugin, CSharpPlugin, MakePlugin, MavenPlugin, NoTestsPlugin, Plugin, PluginType,
-    Python3Plugin, RPlugin,
+    CSharpPlugin, MakePlugin, NoTestsPlugin, Plugin, PluginType, Python3Plugin, RPlugin,
 };
+// the Java plugin is disabled on musl
 pub use tmc_langs_util::{
     file_util::{self, FileLockGuard},
     notification_reporter, progress_reporter,
@@ -60,6 +60,11 @@ pub use tmc_testmycode_client as tmc;
 use toml::Value as TomlValue;
 use url::Url;
 use walkdir::WalkDir;
+#[cfg(not(target_env = "musl"))]
+use {
+    tmc_langs_framework::TmcError,
+    tmc_langs_plugins::{AntPlugin, MavenPlugin},
+};
 
 const TMC_LANGS_CONFIG_DIR_VAR: &str = "TMC_LANGS_CONFIG_DIR";
 
@@ -920,6 +925,8 @@ pub fn prepare_stub(exercise_path: &Path, dest_path: &Path) -> Result<(), LangsE
     submission_processing::prepare_stub(exercise_path, dest_path)?;
 
     // The Ant plugin needs some additional files to be copied over.
+    // the Java plugin is disabled on musl
+    #[cfg(not(target_env = "musl"))]
     if let Ok(PluginType::Ant) = PluginType::from_exercise(exercise_path) {
         AntPlugin::copy_tmc_junit_runner(dest_path).map_err(|e| TmcError::Plugin(Box::new(e)))?;
     }
@@ -1076,7 +1083,11 @@ fn get_default_sandbox_image(path: &Path) -> Result<&'static str, LangsError> {
     let img = match PluginType::from_exercise(path)? {
         PluginType::CSharp => CSharpPlugin::DEFAULT_SANDBOX_IMAGE,
         PluginType::Make => MakePlugin::DEFAULT_SANDBOX_IMAGE,
+        // the Java plugin is disabled on musl
+        #[cfg(not(target_env = "musl"))]
         PluginType::Maven => MavenPlugin::DEFAULT_SANDBOX_IMAGE,
+        // the Java plugin is disabled on musl
+        #[cfg(not(target_env = "musl"))]
         PluginType::Ant => AntPlugin::DEFAULT_SANDBOX_IMAGE,
         PluginType::NoTests => NoTestsPlugin::DEFAULT_SANDBOX_IMAGE,
         PluginType::Python3 => Python3Plugin::DEFAULT_SANDBOX_IMAGE,
