Coursemology/coursemology2

# frozen_string_literal: true
module Course::Assessment::Answer::ProgrammingTestCaseHelper
  # Get a hint message. Use the one from test_result if available, else fallback to the one from
  # the test case.
  #
  # @param [Course::Assessment::Question::ProgrammingTestCase] The test case
  # @param [Course::Assessment::Answer::ProgrammingAutoGradingTestResult] The test result
  # @return [String] The hint, or an empty string if there isn't one
  def get_hint(test_case, test_case_result)
    hint = test_case_result.messages['hint'] if test_case_result
    hint ||= test_case.hint
    hint || ''
  end

  # Get the output message for the tutors to see when grading. Use the output meta attribute if
  # available, else fallback to the failure message, error message, and finally empty string.
  #
  # @param [Course::Assessment::Answer::ProgrammingAutoGradingTestResult] The test result
  # @return [String] The output, failure message, error message or empty string
  #   if the previous 3 don't exist.
  def get_output(test_case_result)
    if test_case_result
      output = test_case_result.messages['output']
      output = test_case_result.messages['failure'] if output.blank?
      # For codaveri programming test output, the stderror for each test case
      # is shown as a full stack message. Thus, we only want the last line
      # to be displayed.
      output = test_case_result.messages['error']&.split("\n")&.last if output.blank?
    end
    output || ''
  end

  # If the test case type has a failed test case, return the first one.
  #
  # @param [Hash] test_cases_by_type The test cases and their results keyed by type
  # @return [Hash] Failed test case and its result, if any
  def get_failed_test_cases_by_type(test_cases_and_results)
    {}.tap do |result|
      test_cases_and_results.each do |test_case_type, test_cases_and_results_of_type|
        result[test_case_type] = get_first_failed_test(test_cases_and_results_of_type)
      end
    end
  end

  # Organize the test cases and test results into a hash, keyed by test case type.
  #   If there is no test result, the test case key points to nil.
  #   nil is needed to make sure test cases are still displayed before they have a test result.
  #   Currently test_cases are ordered by sorting on the identifier of the ProgrammingTestCase.
  # e.g. { 'public_test': { test_case_1: result_1, test_case_2: result_2, test_case_3: nil },
  #        'private_test': { priv_case_1: priv_result_1 },
  #        'evaluation_test': { eval_case1: eval_result_1 } }
  #
  # @param [Hash] test_cases_by_type The test cases keyed by type
  # @param [Course::Assessment::Answer::ProgrammingAutoGrading] auto_grading Auto grading object
  # @return [Hash] The hash structure described above
  def get_test_cases_and_results(test_cases_by_type, auto_grading)
    results_hash = auto_grading ? auto_grading.test_results.includes(:test_case).group_by(&:test_case) : {}
    test_cases_by_type.each do |type, test_cases|
      test_cases_by_type[type] =
        test_cases.map { |test_case| [test_case, results_hash[test_case]&.first] }.
        sort_by { |test_case, _| test_case.identifier }.to_h
    end
  end

  private

  # Return a hash of the first failing test case and its test result
  #
  # @param [Hash] test_cases_and_results_of_type A hash of test cases and results keyed by type
  # @return [Hash] the failed test case and result, nil if all tests passed
  def get_first_failed_test(test_cases_and_results_of_type)
    test_cases_and_results_of_type.each do |test_case, test_result|
      return [[test_case, test_result]].to_h if test_result && !test_result.passed?
    end
    nil
  end
end