# frozen_string_literal: true
# Represents a Java Programming Question test report.
#
# Due to JUnit lacking the features to append meta data onto testcases,
# Java evaluation uses TestNG go get around this.
# This is used to parse TestNG's xml report.
class Course::Assessment::Java::JavaProgrammingTestCaseReport <
  Course::Assessment::ProgrammingTestCaseReport
  class TestSuite
    # Creates a new test suite. This represents a \<testsuite> element.
    #
    # @param [Nokogiri::XML::Element] suite
    def initialize(suite)
      @suite = suite
    end

    # The name of the test suite.
    #
    # @return [String]
    def name
      @suite['name']
    end

    # The identifier for the test suite.
    #
    # @return [String]
    def identifier
      name
    end

    # The duration for running the test suite.
    #
    # @return [Float|nil] The duration for the test suite, nil if the duration was not recorded.
    def duration
      @duration ||= begin
        duration = @suite['duration-ms']
        duration ? duration.to_f / 1000 : nil
      end
    end

    # Gets the test cases found in this test suite.
    #
    # @return [Enumerable<Course::Assessment::JavaProgrammingTestCaseReport::TestCase>]
    def test_cases
      @suite.search('./test/class/test-method').map do |test_case|
        TestCase.new(self, test_case)
      end
    end
  end

  class TestCase
    attr_reader :test_suite

    # Creates a new test case. This represents a \<testcase> element.
    #
    # @param [Course::Assessment::JavaProgrammingTestCaseReport::TestSuite] test_suite The suite this
    #   test case belongs to.
    # @param [Nokogiri::XML::Element] test_case
    def initialize(test_suite, test_case)
      @test_suite = test_suite
      @test_case = test_case
    end

    # The name of the class.
    #
    # @return [String]
    def class_name
      @test_case['classname']
    end

    # The name of the test case.
    #
    # @return [String]
    def name
      @test_case['name']
    end

    # The duration for running the test case.
    #
    # @return [Float|nil] The duration for the test case, nil if not recorded.
    def duration
      @duration ||= begin
        duration = @test_case['duration-ms']
        duration ? duration.to_f / 1000 : nil
      end
    end

    # The identifier for this test case. This attempts to be unique, but it might not be.
    #
    # @return [String]
    def identifier
      class_name = self.class_name ? self.class_name + '/' : ''
      "#{@test_suite.identifier}/#{class_name}#{name.underscore}"
    end

    # The test expression
    #
    # @return [String]
    def expression
      @expression ||= get_test_case_metadata('expression')
    end

    # The expected value from running the test expression
    #
    # @return [String]
    def expected
      @expected ||= get_test_case_metadata('expected')
    end

    # A hint to help the student pass the test case
    #
    # @return [String]
    def hint
      @hint ||= get_test_case_metadata('hint')
    end

    # The output from the function under test.
    # Needs to be initialized by the test code.
    #
    # @return [String]
    def output
      @output ||= get_test_case_metadata('output')
    end

    # If there's a failure, return the failure type and failure message.
    # This encompasses both test failures and test errors
    #
    # @return [String|nil] A combined string with the failure type and failure message,
    # nil if no failure.
    def failure_message
      return nil unless failed?
      # Checks if it is an assertion failure
      if @test_case.search('exception/message').any?
        failure_body = @test_case.search('exception/message').children[1].nil? ?
          '' : @test_case.search('exception/message').children[1].text
        "#{failure_type}: #{failure_body}"
      else
        failure_type
      end
    end

    # If there's a failure, return the contents of the failure tag.
    # This contains the full traceback.
    #
    # @return [String|nil] Full traceback of failure, nil if there's no failure.
    def failure_contents
      return nil unless failed?
      @test_case.search('exception/full-stacktrace').children[1].nil? ?
        '' : @test_case.search('exception/full-stacktrace').children[1].text
    end

    # If there's a failure, return the failure type attribute.
    #
    # @return [String|nil] The type attribute, nil if there's no failure.
    def failure_type
      return nil unless failed?
      @test_case.search('exception')[0]['class']
    end

    # Checks if the test case was skipped.
    #
    # @return [Boolean]
    def skipped?
      status == 'SKIP'
    end

    # Checks if the test case has failed.
    #
    # @return [Boolean]
    def failed?
      status == 'FAIL'
    end

    # Checks if the test case has passed.
    #
    # @return [Boolean]
    def passed?
      status == 'PASS'
    end

    # Checks the status of the test case
    # Can either be 'PASS','FAIL' or 'SKIP'
    #
    # @return [String]
    def status
      @test_case['status']
    end

    # Combines the different strings above into a hash
    #
    # @return [Hash]
    def messages
      # prune empty and nil values
      # error_contents and failure_contents are only being stored and not displayed on the interface
      @messages ||= {
        'error': nil,
        'error_contents': nil,
        'hint': hint,
        'failure': failure_message,
        'failure_contents': failure_contents,
        'output': output
      }.reject! { |_, v| v.blank? }
    end

    private

    # Looks for the metadata attribute value in the test case XML.
    # This can be stored either as attributes of the test case XML tag
    # or as attributes of a child meta tag.
    #
    # @param [String] attribute_name The name of the attribute to retrieve.
    # @return [String]
    def get_test_case_metadata(attribute_name)
      attribute = @test_case.search("./attributes/attribute[@name=#{attribute_name.inspect}]")
      if attribute.present? && attribute.children[1]
        attribute.children[1].text
      else
        ''
      end
    end
  end

  # Parses a test case report.
  #
  # @param [String] report The report XML to parse.
  def initialize(report)
    @report = Nokogiri::XML::Document.parse(report)
  end

  # Gets the set of test suites found in this report.
  #
  # @return [Enumerable<Course::Assessment::JavaProgrammingTestCaseReport::TestSuite>]
  def test_suites
    @report.search('./testng-results/suite').map do |suite|
      TestSuite.new(suite)
    end
  end

  # Gets the set of test cases in this report.
  #
  # @return [Enumerable<Course::Assessment::JavaProgrammingTestCaseReport::TestCase>]
  def test_cases
    test_suites.map(&:test_cases).tap(&:flatten!).select { |test_case| valid_test_method(test_case) }
  end

  private

  # Checks if a test-method has a public, evaluation or private in its name
  #
  # @return [Boolean]
  def valid_test_method(test_case)
    test_case.name =~ /public/i || test_case.name =~ /evaluation/i || test_case.name =~ /private/i
  end
end
