• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

MarkUsProject / Markus / 20174146560

12 Dec 2025 05:06PM UTC coverage: 91.53% (+0.02%) from 91.513%
20174146560

Pull #7754

github

web-flow
Merge a86e33fc6 into 3421ef3b2
Pull Request #7754: ISSUE-7711: Add GET - api/.../groups/test_results api route

914 of 1805 branches covered (50.64%)

Branch coverage included in aggregate %.

99 of 99 new or added lines in 4 files covered. (100.0%)

33 existing lines in 2 files now uncovered.

43747 of 46989 relevant lines covered (93.1%)

121.6 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.41
/app/controllers/api/groups_controller.rb
1
module Api
1✔
2
  # Allows for listing Markus groups for a particular assignment.
3
  # Uses Rails' RESTful routes (check 'rake routes' for the configured routes)
4
  class GroupsController < MainApiController
1✔
5
    # Define default fields to display for index and show methods
6
    DEFAULT_FIELDS = [:id, :group_name].freeze
1✔
7

8
    # Create an assignment's group
9
    # Requires: assignment_id
10
    # Optional: filter, fields
11
    def create
1✔
12
      assignment = Assignment.find(params[:assignment_id])
10✔
13
      begin
14
        group = assignment.add_group_api(params[:new_group_name], params[:members])
10✔
15
        respond_to do |format|
7✔
16
          format.xml do
7✔
17
            render xml: group.to_xml(root: 'group', skip_types: 'true')
7✔
18
          end
19
          format.json { render json: group.to_json }
7✔
20
        end
21
      rescue StandardError => e
22
        render 'shared/http_status', locals: { code: '422', message:
3✔
23
          e.message }, status: :unprocessable_content
24
      end
25
    end
26

27
    # Returns an assignment's groups along with their attributes
28
    # Requires: assignment_id
29
    # Optional: filter, fields
30
    def index
1✔
31
      groups = get_collection(assignment.groups) || return
12✔
32

33
      group_data = include_memberships(groups)
11✔
34

35
      respond_to do |format|
11✔
36
        format.xml do
11✔
37
          render xml: group_data.to_xml(root: 'groups', skip_types: 'true')
4✔
38
        end
39
        format.json { render json: group_data }
18✔
40
      end
41
    end
42

43
    # Returns a single group along with its attributes
44
    # Requires: id
45
    # Optional: fields
46
    def show
1✔
47
      group_data = include_memberships(Group.where(id: record.id))
6✔
48

49
      # We found a grouping for that assignment
50
      respond_to do |format|
6✔
51
        format.xml do
6✔
52
          render xml: group_data.to_xml(root: 'groups', skip_types: 'true')
3✔
53
        end
54
        format.json { render json: group_data }
9✔
55
      end
56
    end
57

58
    # Include student_memberships and user info
59
    def include_memberships(groups)
1✔
60
      groups.joins(groupings: [:assignment, { student_memberships: [:role] }])
17✔
61
            .where('assessments.id': params[:assignment_id])
62
            .pluck_to_hash(*DEFAULT_FIELDS, :membership_status, :role_id)
63
            .group_by { |h| h.slice(*DEFAULT_FIELDS) }
23✔
64
            .map { |k, v| k.merge(members: v.map { |h| h.except(*DEFAULT_FIELDS) }) }
46✔
65
    end
66

67
    def add_members
1✔
68
      if self.grouping.nil?
8✔
69
        # The group doesn't have a grouping associated with that assignment
70
        render 'shared/http_status', locals: { code: '422', message:
2✔
71
          'The group is not involved with that assignment' }, status: :unprocessable_content
72
        return
2✔
73
      end
74

75
      students = current_course.students.joins(:user).where('users.user_name': params[:members])
6✔
76
      students.each do |student|
6✔
77
        set_membership_status = if grouping.student_memberships.empty?
10✔
78
                                  StudentMembership::STATUSES[:inviter]
2✔
79
                                else
80
                                  StudentMembership::STATUSES[:accepted]
8✔
81
                                end
82
        grouping.invite(student.user_name, set_membership_status, invoked_by_instructor: true)
10✔
83
        grouping.reload
10✔
84
      end
85

86
      render 'shared/http_status', locals: { code: '200', message:
6✔
87
        HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
88
    end
89

90
    # Update the group's marks for the given assignment.
91
    def update_marks
1✔
92
      result = self.grouping&.current_submission_used&.get_latest_result
6✔
93
      return page_not_found('No submission exists for that group') if result.nil?
6✔
94

95
      # We shouldn't be able to update marks if marking is already complete.
96
      if result.marking_state == Result::MARKING_STATES[:complete]
6✔
97
        render 'shared/http_status', locals: { code: '404', message:
2✔
98
          'Marking for that submission is already completed' }, status: :not_found
99
        return
2✔
100
      end
101
      matched_criteria = assignment.criteria.where(name: params.keys)
4✔
102
      if matched_criteria.empty?
4✔
103
        render 'shared/http_status', locals: { code: '404', message:
×
104
          'No criteria were found that match that request.' }, status: :not_found
105
        return
×
106
      end
107

108
      matched_criteria.each do |crit|
4✔
109
        mark_to_change = result.marks.find_or_initialize_by(criterion_id: crit.id)
4✔
110
        mark_to_change.mark = params[crit.name] == 'nil' ? nil : params[crit.name].to_f
4✔
111
        unless mark_to_change.save
4✔
112
          # Some error occurred (including invalid mark)
113
          render 'shared/http_status', locals: { code: '500', message:
×
114
            mark_to_change.errors.full_messages.first }, status: :internal_server_error
115
          return
×
116
        end
117
      end
118
      result.save
4✔
119
      render 'shared/http_status', locals: { code: '200', message:
4✔
120
        HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
121
    end
122

123
    def create_extra_marks
1✔
124
      result = self.grouping&.current_submission_used&.get_latest_result
5✔
125
      return page_not_found('No submission exists for that group') if result.nil?
5✔
126

127
      begin
128
        ExtraMark.create!(result_id: result.id, extra_mark: params[:extra_marks],
4✔
129
                          description: params[:description], unit: ExtraMark::POINTS)
130
      rescue ActiveRecord::RecordInvalid => e
131
        # Some error occurred
132
        render 'shared/http_status', locals: { code: '500', message:
2✔
133
            e.message }, status: :internal_server_error
134
        return
2✔
135
      end
136
      render 'shared/http_status', locals: { code: '200', message:
2✔
137
          'Extra mark created successfully' }, status: :ok
138
    end
139

140
    def remove_extra_marks
1✔
141
      result = self.grouping&.current_submission_used&.get_latest_result
5✔
142
      return page_not_found('No submission exists for that group') if result.nil?
5✔
143
      extra_mark = ExtraMark.find_by(result_id: result.id,
4✔
144
                                     description: params[:description],
145
                                     extra_mark: params[:extra_marks])
146
      if extra_mark.nil?
4✔
147
        render 'shared/http_status', locals: { code: '404', message:
2✔
148
            'No such Extra Mark exist for that result' }, status: :not_found
149
        return
2✔
150
      end
151
      begin
152
        extra_mark.destroy
2✔
153
      rescue ActiveRecord::RecordNotDestroyed => e
154
        # Some other error occurred
155
        render 'shared/http_status', locals: { code: '500', message:
×
156
            e.message }, status: :internal_server_error
157
        return
×
158
      end
159
      # Successfully deleted the Extra Mark; render success
160
      render 'shared/http_status', locals: { code: '200', message:
2✔
161
          'Extra mark removed successfully' }, status: :ok
162
    end
163

164
    def annotations
1✔
165
      if record # this is a member route
2✔
166
        grouping_relation = assignment.groupings.where(group_id: record.id)
2✔
167
      else # this is a collection route
168
        grouping_relation = assignment.groupings
×
169
      end
170

171
      pluck_keys = ['annotations.type as type',
2✔
172
                    'annotation_texts.content as content',
173
                    'submission_files.filename as filename',
174
                    'submission_files.path as path',
175
                    'annotations.page as page',
176
                    'group_id',
177
                    'annotation_categories.annotation_category_name as category',
178
                    'annotations.creator_id as creator_id',
179
                    'annotation_texts.creator_id as content_creator_id',
180
                    'annotations.line_end as line_end',
181
                    'annotations.line_start as line_start',
182
                    'annotations.column_start as column_start',
183
                    'annotations.column_end as column_end',
184
                    'annotations.x1 as x1',
185
                    'annotations.y1 as y1',
186
                    'annotations.x2 as x2',
187
                    'annotations.y2 as y2']
188

189
      annotations = grouping_relation.left_joins(current_submission_used:
2✔
190
                                              [submission_files:
191
                                                 [annotations:
192
                                                    [annotation_text: :annotation_category]]])
193
                                     .where(assessment_id: params[:assignment_id])
194
                                     .where.not('annotations.id': nil)
195
                                     .pluck_to_hash(*pluck_keys)
196
      respond_to do |format|
2✔
197
        format.xml do
2✔
198
          render xml: annotations.to_xml(root: 'annotations', skip_types: 'true')
2✔
199
        end
200
        format.json do
2✔
201
          render json: annotations.to_json
×
202
        end
203
      end
204
    end
205

206
    def test_results
1✔
207
      return render_no_grouping_error unless grouping
10✔
208

209
      # Use the existing Assignment#summary_test_results method and filter for this specific group
210
      # This ensures format consistency with the UI download (summary_test_result_json)
211
      group_name = grouping.group.group_name
10✔
212
      all_results = assignment.summary_test_results
10✔
213
      results = all_results.select { |r| r.group_name == group_name }
22✔
214

215
      return render_no_grouping_error if results.blank?
10✔
216

217
      # Group by test_group name to match the summary_test_result_json format
218
      results_by_test_group = results.group_by(&:name)
9✔
219

220
      respond_to do |format|
9✔
221
        format.xml { render xml: results_by_test_group.to_xml(root: 'test_results', skip_types: 'true') }
11✔
222
        format.json { render json: results_by_test_group }
16✔
223
      end
224
    end
225

226
    def render_no_grouping_error
1✔
227
      render 'shared/http_status',
1✔
228
             locals: { code: '404', message: 'No test results found for this group' },
229
             status: :not_found
230
    end
231

232
    def add_annotations
1✔
233
      result = self.grouping&.current_result
1✔
234
      return page_not_found('No submission exists for that group') if result.nil?
1✔
235

236
      force_complete = params.fetch(:force_complete, false)
1✔
237
      # We shouldn't be able to update annotations if marking is already complete, unless forced.
238
      if result.marking_state == Result::MARKING_STATES[:complete] && !force_complete
1✔
UNCOV
239
        return page_not_found('Marking for that submission is already completed')
×
240
      end
241

242
      annotation_texts = []
1✔
243
      annotations = []
1✔
244
      count = result.submission.annotations.count + 1
1✔
245
      annotation_category = nil
1✔
246
      submission_file = nil
1✔
247
      params[:annotations].each_with_index do |annot_params, i|
1✔
248
        if annot_params[:annotation_category_name].nil?
2✔
UNCOV
249
          annotation_category_id = nil
×
250
        else
251
          name = annot_params[:annotation_category_name]
2✔
252
          if annotation_category.nil? || annotation_category.annotation_category_name != name
2✔
253
            annotation_category = assignment.annotation_categories.find_or_create_by(
1✔
254
              annotation_category_name: name
255
            )
256
          end
257
          annotation_category_id = annotation_category.id
2✔
258
        end
259
        if submission_file.nil? || submission_file.filename != annot_params[:filename]
2✔
260
          submission_file = result.submission.submission_files.find_by(filename: annot_params[:filename])
1✔
261
        end
262

263
        annotation_texts << {
2✔
264
          content: annot_params[:content],
265
          annotation_category_id: annotation_category_id,
266
          creator_id: current_role.id,
267
          last_editor_id: current_role.id
268
        }
269
        annotations << {
2✔
270
          line_start: annot_params[:line_start],
271
          line_end: annot_params[:line_end],
272
          column_start: annot_params[:column_start],
273
          column_end: annot_params[:column_end],
274
          annotation_text_id: nil,
275
          submission_file_id: submission_file.id,
276
          creator_id: current_role.id,
277
          creator_type: current_role.type,
278
          is_remark: !result.remark_request_submitted_at.nil?,
279
          annotation_number: count + i,
280
          result_id: result.id
281
        }
282
      end
283
      imported = AnnotationText.insert_all! annotation_texts
1✔
284
      imported.rows.zip(annotations) do |t, a|
1✔
285
        a[:annotation_text_id] = t[0]
2✔
286
      end
287
      TextAnnotation.insert_all! annotations
1✔
288
      render 'shared/http_status', locals: { code: '200', message:
1✔
289
        HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
290
    end
291

292
    # Return key:value pairs of group_name:group_id
293
    def group_ids_by_name
1✔
294
      reversed = assignment.groups.pluck(:group_name, :id).to_h
4✔
295
      respond_to do |format|
4✔
296
        format.xml do
4✔
297
          render xml: reversed.to_xml(root: 'groups', skip_types: 'true')
2✔
298
        end
299
        format.json do
4✔
300
          render json: reversed.to_json
2✔
301
        end
302
      end
303
    end
304

305
    # Allow user to set marking state to complete
306
    def update_marking_state
1✔
307
      if has_missing_params?([:marking_state])
4✔
308
        # incomplete/invalid HTTP params
UNCOV
309
        render 'shared/http_status', locals: { code: '422', message:
×
310
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
UNCOV
311
        return
×
312
      end
313
      result = self.grouping&.current_submission_used&.get_latest_result
4✔
314
      return page_not_found('No submission exists for that group') if result.nil?
4✔
315
      result.marking_state = params[:marking_state]
4✔
316
      if result.save
4✔
317
        render 'shared/http_status', locals: { code: '200', message:
4✔
318
            HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
319
      else
UNCOV
320
        render 'shared/http_status', locals: { code: '500', message:
×
321
            result.errors.full_messages.first }, status: :internal_server_error
322
      end
323
    end
324

325
    def add_tag
1✔
326
      grouping = self.grouping
2✔
327
      tag = self.assignment.tags.find_by(id: params[:tag_id])
2✔
328
      if tag.nil? || grouping.nil?
2✔
329
        raise 'tag or group not found'
1✔
330
      else
331
        grouping.tags << tag
1✔
332
        render 'shared/http_status', locals: { code: '200', message:
1✔
333
          HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
334
      end
335
    rescue StandardError
336
      render 'shared/http_status', locals: { code: '404', message: I18n.t('tags.not_found') }, status: :not_found
1✔
337
    end
338

339
    def remove_tag
1✔
340
      grouping = self.grouping
2✔
341
      tag = grouping.tags.find_by(id: params[:tag_id])
2✔
342
      if tag.nil? || grouping.nil?
2✔
343
        raise 'tag or grouping not found'
1✔
344
      else
345
        grouping.tags.destroy(tag)
1✔
346
        render 'shared/http_status', locals: { code: '200', message:
1✔
347
          HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
348
      end
349
    rescue StandardError
350
      render 'shared/http_status', locals: { code: '404', message: I18n.t('tags.not_found') }, status: :not_found
1✔
351
    end
352

353
    def extension
1✔
354
      grouping = Grouping.find_by(group_id: params[:id], assignment: params[:assignment_id])
12✔
355
      case request.method
12✔
356
      when 'DELETE'
357
        if grouping.extension.present?
2✔
358
          grouping.extension.destroy!
1✔
359
          # Successfully deleted the extension; render success
360
          render 'shared/http_status', locals: { code: '200', message:
1✔
361
            HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
362
        else
363
          # cannot delete a non existent extension; render failure
364
          render 'shared/http_status', locals: { code: '422', message:
1✔
365
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
366
        end
367
      when 'POST'
368
        if grouping.extension.nil?
5✔
369
          extension_values = extension_params
4✔
370
          extension_values[:time_delta] = time_delta_params if extension_values[:time_delta].present?
4✔
371
          grouping.create_extension!(extension_values)
4✔
372
          # Successfully created the extension record; render success
373
          render 'shared/http_status', locals: { code: '201', message:
2✔
374
            HttpStatusHelper::ERROR_CODE['message']['201'] }, status: :created
375
        else
376
          # cannot create extension as it already exists; render failure
377
          render 'shared/http_status', locals: { code: '422', message:
1✔
378
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
379
        end
380
      when 'PATCH'
381
        if grouping.extension.present?
4✔
382
          extension_values = extension_params
3✔
383
          extension_values[:time_delta] = time_delta_params if extension_values[:time_delta].present?
3✔
384
          grouping.extension.update!(extension_values)
3✔
385
          # Successfully updated the extension record; render success
386
          render 'shared/http_status', locals: { code: '200', message:
3✔
387
            HttpStatusHelper::ERROR_CODE['message']['200'] }, status: :ok
388
        else
389
          # cannot update extension as it does not exists; render failure
390
          render 'shared/http_status', locals: { code: '422', message:
1✔
391
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
392
        end
393
      end
394
    rescue ActiveRecord::RecordInvalid => e
395
      render 'shared/http_status', locals: { code: '422', message: e.to_s }, status: :unprocessable_content
2✔
396
    end
397

398
    def collect_submission
1✔
399
      @grouping = Grouping.find_by(group_id: params[:id], assignment: params[:assignment_id])
3✔
400
      unless @grouping.current_submission_used.nil?
3✔
401
        released = @grouping.current_submission_used.results.exists?(released_to_students: true)
1✔
402
        if released
1✔
403
          render 'shared/http_status', locals: { code: '422', message:
1✔
404
            HttpStatusHelper::ERROR_CODE['message']['422'] }, status: :unprocessable_content
405
          return
1✔
406
        end
407
      end
408

409
      @revision_identifier = params[:revision_identifier]
2✔
410
      apply_late_penalty = if params[:apply_late_penalty].nil?
2✔
UNCOV
411
                             false
×
412
                           else
413
                             params[:apply_late_penalty]
2✔
414
                           end
415
      retain_existing_grading = if params[:retain_existing_grading].nil?
2✔
UNCOV
416
                                  false
×
417
                                else
418
                                  params[:retain_existing_grading]
2✔
419
                                end
420
      SubmissionsJob.perform_now([@grouping],
2✔
421
                                 revision_identifier: @revision_identifier,
422
                                 collect_current: params[:collect_current],
423
                                 apply_late_penalty: apply_late_penalty,
424
                                 retain_existing_grading: retain_existing_grading)
425

426
      render 'shared/http_status', locals: { code: '201', message:
2✔
427
        HttpStatusHelper::ERROR_CODE['message']['201'] }, status: :created
428
    end
429

430
    def add_test_run
1✔
431
      m_logger = MarkusLogger.instance
15✔
432
      # Validate test results against contract schema
433
      validation = TestResultsContract.new.call(params[:test_results].as_json)
15✔
434

435
      if validation.failure?
15✔
436
        return render json: { errors: validation.errors.to_hash }, status: :unprocessable_content
1✔
437
      end
438

439
      # Verify grouping exists and is authorized (grouping helper method handles this)
440
      if grouping.nil?
14✔
UNCOV
441
        return render json: { errors: 'Group not found for this assignment' }, status: :not_found
×
442
      end
443

444
      # Verify submission exists before attempting to create test run
445
      submission = grouping.current_submission_used
14✔
446
      if submission.nil?
14✔
447
        return render json: { errors: 'No submission exists for this grouping' }, status: :unprocessable_content
1✔
448
      end
449

450
      begin
451
        ActiveRecord::Base.transaction do
13✔
452
          test_run = TestRun.create!(
13✔
453
            status: :in_progress,
454
            role: current_role,
455
            grouping: grouping,
456
            submission: submission
457
          )
458

459
          test_run.update_results!(JSON.parse(params[:test_results].to_json))
10✔
460
          render json: { status: 'success', test_run_id: test_run.id }, status: :created
7✔
461
        end
462
      rescue ActiveRecord::RecordInvalid => e
463
        render json: { errors: e.record.errors.full_messages }, status: :unprocessable_content
3✔
464
      rescue StandardError => e
465
        m_logger.log("Test results processing failed: #{e.message}\n#{e.backtrace.join("\n")}")
3✔
466
        render json: { errors: 'Failed to process test results' }, status: :internal_server_error
3✔
467
      end
468
    end
469

470
    def assignment
1✔
471
      return @assignment if defined?(@assignment)
92✔
472

473
      @assignment = Assignment.find_by(id: params[:assignment_id])
75✔
474
    end
475

476
    def grouping
1✔
477
      @grouping ||= record.grouping_for_assignment(assignment.id)
124✔
478
    end
479

480
    def annotations_params
1✔
UNCOV
481
      params.require(annotations: [
×
482
        :annotation_category_name,
483
        :column_end,
484
        :column_start,
485
        :content,
486
        :filename,
487
        :line_end,
488
        :line_start
489
      ])
490
    end
491

492
    def time_delta_params
1✔
493
      params = extension_params[:time_delta]
5✔
494
      Extension::PARTS.sum { |part| params[part].to_i.public_send(part) }
25✔
495
    end
496

497
    def extension_params
1✔
498
      params.require(:extension).permit({ time_delta: [:weeks, :days, :hours, :minutes] }, :apply_penalty, :note)
12✔
499
    end
500
  end
501
end
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc