-
Notifications
You must be signed in to change notification settings - Fork 299
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Programming exercises
: Add MATLAB programming exercise template
#10039
Open
magaupp
wants to merge
9
commits into
develop
Choose a base branch
from
feature/programming-exercises/matlab-template
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+705
−39
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
53db0b2
Add basic MATLAB template
magaupp 81d200e
Update documentation
magaupp d73ae49
Move license handling to LicenseService
magaupp 7190c7d
Add documentation
magaupp c41362d
Disable project types with missing license
magaupp 86c680c
Add LicenseService tests
magaupp 41a9a27
Add example exercise
magaupp ba912b3
Fix tests
magaupp 81d4966
Improve null handling
magaupp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
src/main/java/de/tum/cit/aet/artemis/core/config/LicenseConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
package de.tum.cit.aet.artemis.core.config; | ||
|
||
import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; | ||
|
||
import jakarta.annotation.Nullable; | ||
|
||
import org.springframework.boot.context.properties.ConfigurationProperties; | ||
import org.springframework.context.annotation.Profile; | ||
|
||
@Profile(PROFILE_CORE) | ||
@ConfigurationProperties(prefix = "artemis.licenses") | ||
public class LicenseConfiguration { | ||
|
||
private final MatLabLicense matlab; | ||
|
||
public record MatLabLicense(String licenseServer) { | ||
} | ||
|
||
public LicenseConfiguration(MatLabLicense matlab) { | ||
this.matlab = matlab; | ||
} | ||
|
||
@Nullable | ||
public String getMatlabLicenseServer() { | ||
if (matlab == null) { | ||
return null; | ||
} | ||
return matlab.licenseServer(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,6 +47,7 @@ public enum ProgrammingLanguage { | |
JAVA, | ||
JAVASCRIPT, | ||
KOTLIN, | ||
MATLAB, | ||
OCAML, | ||
PYTHON, | ||
R, | ||
|
60 changes: 60 additions & 0 deletions
60
src/main/java/de/tum/cit/aet/artemis/programming/service/LicenseService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
package de.tum.cit.aet.artemis.programming.service; | ||
|
||
import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; | ||
|
||
import java.util.Map; | ||
import java.util.Objects; | ||
|
||
import jakarta.annotation.Nullable; | ||
|
||
import org.springframework.context.annotation.Profile; | ||
import org.springframework.stereotype.Service; | ||
|
||
import de.tum.cit.aet.artemis.core.config.LicenseConfiguration; | ||
import de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage; | ||
import de.tum.cit.aet.artemis.programming.domain.ProjectType; | ||
|
||
/** | ||
* Provides licensing information for proprietary software to build jobs via environment variables. | ||
*/ | ||
@Profile(PROFILE_CORE) | ||
@Service | ||
public class LicenseService { | ||
|
||
private final LicenseConfiguration licenseConfiguration; | ||
|
||
public LicenseService(LicenseConfiguration licenseConfiguration) { | ||
this.licenseConfiguration = licenseConfiguration; | ||
} | ||
|
||
/** | ||
* Checks whether a required license is configured for the specified exercise type. | ||
* If no license is required this returns true. | ||
* | ||
* @param programmingLanguage the programming language of the exercise type | ||
* @param projectType the project type of the exercise type | ||
* @return whether a required license is configured | ||
*/ | ||
public boolean isLicensed(ProgrammingLanguage programmingLanguage, @Nullable ProjectType projectType) { | ||
if (programmingLanguage == ProgrammingLanguage.MATLAB && projectType == null) { | ||
return licenseConfiguration.getMatlabLicenseServer() != null; | ||
} | ||
|
||
return true; | ||
} | ||
|
||
/** | ||
* Returns environment variables required to run programming exercise tests. | ||
* | ||
* @param programmingLanguage the programming language of the exercise | ||
* @param projectType the project type of the exercise | ||
* @return environment variables for the specified exercise type | ||
*/ | ||
public Map<String, String> getEnvironment(ProgrammingLanguage programmingLanguage, @Nullable ProjectType projectType) { | ||
if (programmingLanguage == ProgrammingLanguage.MATLAB && projectType == null) { | ||
return Map.of("MLM_LICENSE_FILE", Objects.requireNonNull(licenseConfiguration.getMatlabLicenseServer())); | ||
} | ||
|
||
return Map.of(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When can this happen, i.e. what would be the reason when its null / not null?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed that some of the tests related to exercise importing set this to null. Not sure if this can happen in production code.