Skip to content
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.

Sign up for GitHub

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

Development: Add JavaDocs to UtilServices and Factories [3] #7271

Merged
merged 8 commits into from
Oct 13, 2023
Merged

Development: Add JavaDocs to UtilServices and Factories [3] #7271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
611465b
Empty Commit
DominikRemo Sep 26, 2023
9ccfc58
Add documentation
DominikRemo Sep 26, 2023
2bc0057
Merge branch 'development/add-javadoc-to-utilservices-and-factories/m…
DominikRemo Oct 4, 2023
ca9fe5e
Merge branch 'development/add-javadoc-to-utilservices-and-factories/m…
DominikRemo Oct 6, 2023
46ce6d0
Add documentation
DominikRemo Oct 6, 2023
52368f3
Actually commit and push all changes
DominikRemo Oct 6, 2023
745d86e
Merge branch 'development/add-javadoc-to-utilservices-and-factories/m…
DominikRemo Oct 13, 2023
9d72902
Implement feedback by @laadvo
DominikRemo Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 68 additions & 58 deletions src/test/java/de/tum/in/www1/artemis/exam/ExamFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
public class ExamFactory {

/**
* Generates a real exam with student review dates set
* Creates an Exam with student review dates set [now; now + 60min]
*
* @param course the associated course
* @return the created exam
* @param course The associated course
* @return The newly created Exam
*/
public static Exam generateExamWithStudentReviewDates(Course course) {
Exam exam = generateExamHelper(course, false);
Expand All @@ -32,50 +32,50 @@ public static Exam generateExamWithStudentReviewDates(Course course) {
}

/**
* Generates a real exam without student review dates set
* Creates an Exam without student review dates set
*
* @param course the associated course
* @return the created exam
* @param course The associated course
* @return The newly created Exam
*/
public static Exam generateExam(Course course) {
return generateExamHelper(course, false);
}

/**
* Generates a real exam without student review dates set and attaches a channel
* Creates an Exam with a Channel and without student review dates set
*
* @param course the associated course
* @param channelName the channel name
* @return the created exam
* @param course The associated course
* @param channelName The channel name
* @return The newly created Exam
*/
public static Exam generateExam(Course course, String channelName) {
return generateExamHelper(course, false, channelName);
}

/**
* Generates an exam without channel
* Creates an Exam without a Channel
*
* @param course the associated course
* @param visibleDate the visible date of the exam
* @param startDate the start date of the exam
* @param endDate the end date of the exam
* @param testExam if the exam is a test exam
* @return the created exam
* @param course The associated course
* @param visibleDate The visible date of the Exam
* @param startDate The start date of the Exam
* @param endDate The end date of the Exam
* @param testExam True, if the Exam is a test exam
* @return The newly created Exam
*/
public static Exam generateExam(Course course, ZonedDateTime visibleDate, ZonedDateTime startDate, ZonedDateTime endDate, boolean testExam) {
return generateExam(course, visibleDate, startDate, endDate, testExam, null);
}

/**
* Generates an exam with channel
* Creates an Exam with a Channel
*
* @param course the associated course
* @param visibleDate the visible date of the exam
* @param startDate the start date of the exam
* @param endDate the end date of the exam
* @param testExam if the exam is a test exam
* @param channelName the channel name
* @return the created exam
* @param course The associated course
* @param visibleDate The visible date of the Exam
* @param startDate The start date of the Exam
* @param endDate The end date of the Exam
* @param testExam True, if the Exam is a test exam
* @param channelName The channel name
* @return The newly created Exam
*/
public static Exam generateExam(Course course, ZonedDateTime visibleDate, ZonedDateTime startDate, ZonedDateTime endDate, boolean testExam, String channelName) {
Exam exam = new Exam();
Expand All @@ -99,58 +99,56 @@ public static Exam generateExam(Course course, ZonedDateTime visibleDate, ZonedD
}

/**
* Generates a test exam (test exams have no student review dates)
* Creates a test Exam (test exams have no student review dates)
*
* @param course the associated course
* @return the created exam
* @param course The associated course
* @return The newly created Exam
*/
public static Exam generateTestExam(Course course) {
return generateExamHelper(course, true);
}

/**
* Helper method to create an exam without a channel
* Creates an exam without a Channel
*
* @param course the associated course
* @param testExam Boolean flag to determine whether it is a test exam
* @return the created Exam
* @param course The associated course
* @param testExam True, if the Exam is a test exam
* @return The newly created Exam
*/
private static Exam generateExamHelper(Course course, boolean testExam) {
return generateExamHelper(course, testExam, null);
}

/**
* Helper method to create an exam with a channel
* Creates an Exam with a Channel
*
* @param course the associated course
* @param testExam Boolean flag to determine whether it is a test exam
* @return the created Exam
* @param course The associated course
* @param testExam True, if the Exam is a test exam
* @return The newly created Exam
*/
private static Exam generateExamHelper(Course course, boolean testExam, String channelName) {
ZonedDateTime currentTime = now();
return generateExam(course, currentTime, currentTime.plusMinutes(10), currentTime.plusMinutes(testExam ? 80 : 60), testExam, channelName);
}

/**
* generates an exercise group for an exam
* Creates an ExerciseGroup and adds it to the given exam
*
* @param mandatory if the exercise group is mandatory
* @param exam the exam that this exercise group should be added to
*
* @return the newly created exercise
* @param mandatory True, if the exercise group is mandatory
* @param exam The exam that this exercise group should be added to
* @return The newly created ExerciseGroup
*/
public static ExerciseGroup generateExerciseGroup(boolean mandatory, Exam exam) {
return generateExerciseGroupWithTitle(mandatory, exam, "Exercise group title");
}

/**
* generates an exercise group for an exam with the given title
*
* @param mandatory if the exercise group is mandatory
* @param exam the exam that this exercise group should be added to
* @param title title of the exercise group
* Creates an ExerciseGroup for an Exam
*
* @return the newly created exercise
* @param mandatory True, if the exercise group is mandatory
* @param exam The exam that this exercise group should be added to
* @param title The title of the exercise group
* @return The newly created ExerciseGroup
*/
public static ExerciseGroup generateExerciseGroupWithTitle(boolean mandatory, Exam exam, String title) {
ExerciseGroup exerciseGroup = new ExerciseGroup();
Expand All @@ -160,6 +158,12 @@ public static ExerciseGroup generateExerciseGroupWithTitle(boolean mandatory, Ex
return exerciseGroup;
}

/**
* Creates a StudentExam that is linked to the given exam
*
* @param exam The exam to be linked to the studentExam
* @return The newly created StudentExam
*/
public static StudentExam generateStudentExam(Exam exam) {
StudentExam studentExam = new StudentExam();
studentExam.setExam(exam);
Expand All @@ -168,10 +172,10 @@ public static StudentExam generateStudentExam(Exam exam) {
}

/**
* Helper Method to generate a studentExam for a test exam
* Creates a StudentExam for a test exam
*
* @param exam the exam to be linked to the studentExam
* @return a StudentExam for a test exam
* @param exam The exam to be linked to the studentExam
* @return The newly created StudentExam
*/
public static StudentExam generateStudentExamForTestExam(Exam exam) {
StudentExam studentExam = new StudentExam();
Expand All @@ -181,6 +185,12 @@ public static StudentExam generateStudentExamForTestExam(Exam exam) {
return studentExam;
}

/**
* Creates a StudentExam that is linked to the given exam and is a test run
*
* @param exam The exam to be linked to the studentExam
* @return The newly created StudentExam
*/
public static StudentExam generateExamTestRun(Exam exam) {
StudentExam studentExam = new StudentExam();
studentExam.setExam(exam);
Expand All @@ -189,11 +199,11 @@ public static StudentExam generateExamTestRun(Exam exam) {
}

/**
* generates an exam with one exercise group
* Creates an Exam with an ExerciseGroup
*
* @param course course of the exam
* @param mandatory if the exercise group is mandatory
* @return newly generated exam
* @param course The associated course
* @param mandatory True, if the exercise group is mandatory
* @return The newly created Exam
*/
public static Exam generateExamWithExerciseGroup(Course course, boolean mandatory) {
Exam exam = generateExam(course);
Expand All @@ -203,11 +213,11 @@ public static Exam generateExamWithExerciseGroup(Course course, boolean mandator
}

/**
* creates exam session DTOs
* Creates a Set of ExamSessionDTOs from the given exam sessions
*
* @param session1 firts exam session
* @param session2 second exam session
* @return set of exam session DTOs
* @param session1 The first exam session
* @param session2 The second exam session
* @return The created set of ExamSessionDTOs
*/
public static Set<ExamSessionDTO> createExpectedExamSessionDTOs(ExamSession session1, ExamSession session2) {
var expectedDTOs = new HashSet<ExamSessionDTO>();
Expand Down
Loading