## $Id: test_utils.py 17511 2023-07-23 21:55:42Z henrik $
##
## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##
import grok
from hurry.workflow.interfaces import IWorkflowState
from zope.component import getUtility, createObject
from waeup.kofa.students.studylevel import StudentStudyLevel
from waeup.kofa.students.tests.test_browser import StudentsFullSetup
from waeup.kofa.students.interfaces import IStudentsUtils
from waeup.kofa.students.studylevel import StudentStudyLevel
from waeup.aaue.testing import FunctionalLayer

class StudentsUtilsTests(StudentsFullSetup):

    layer = FunctionalLayer

    def test_get_returning_data(self):
        # Student is in level 100, session 2004 with verdict A
        utils = getUtility(IStudentsUtils)
        self.assertEqual(utils.getReturningData(self.student),(2005, 200))
        self.student['studycourse'].current_verdict = 'C'
        self.assertEqual(utils.getReturningData(self.student),(2005, 110))
        self.student['studycourse'].current_verdict = 'NER'
        self.assertEqual(utils.getReturningData(self.student),(2005, 100))
        return

    def test_no_clearance_ac_code_created(self):
        payment = createObject('waeup.StudentOnlinePayment')
        payment.p_category = 'clearance'
        self.student['payments']['any_id'] = payment
        payment.approveStudentPayment()
        # No activation code created.
        self.assertEqual(payment.ac, None)

    def test_set_payment_details(self):
        self.app['configuration']['2004'].gown_fee = 150.0
        self.app['configuration']['2004'].transfer_fee = 90.0
        self.app['configuration']['2004'].booking_fee = 150.0
        self.app['configuration']['2004'].maint_fee = 180.0
        #self.app['configuration']['2004'].clearance_fee_pg = 1234.0
        #self.app['configuration']['2004'].clearance_fee_fp = 3456.0
        #self.student['studycourse'].certificate.school_fee_1 = 6666.0
        #self.student['studycourse'].certificate.school_fee_2 = 7777.0
        #self.student['studycourse'].certificate.school_fee_3 = 8888.0
        self.student['studycourse'].certificate.study_mode = 'special_pg_ft'
        self.student.nationality = u'NG'
        self.student.lga = 'ebonyi_ukaba'
        utils = getUtility(IStudentsUtils)

        configuration = createObject('waeup.SessionConfiguration')
        configuration.academic_session = 2005
        self.app['configuration'].addSessionConfiguration(configuration)

        error, payment = utils.setPaymentDetails('schoolfee',self.student)
        self.assertEqual(payment, None)
        self.assertEqual(error, u'Wrong state.')
        IWorkflowState(self.student).setState('cleared')
        # School fee can be set.
        error, payment = utils.setPaymentDetails('schoolfee',self.student)
        self.assertEqual(payment.p_level, 100)
        self.assertEqual(payment.p_session, 2004)
        self.assertEqual(payment.amount_auth, 204000.0) # tuition plus penalty
        self.assertEqual(payment.p_item, u'CERT1')
        self.assertEqual(error, None)
        # Add penalty fee ...
        # ... for cleared
        self.app['configuration']['2004'].penalty_pg = 99.0
        # ... for returning
        self.app['configuration']['2005'].penalty_pg = 88.0
        self.student.lga = 'edo_afuze'
        error, payment = utils.setPaymentDetails('schoolfee',self.student)
        self.assertEqual(payment.amount_auth, 184099.0)
        IWorkflowState(self.student).setState('returning')
        error, payment = utils.setPaymentDetails('schoolfee',self.student)
        self.assertEqual(error, u'Personal data form is not properly filled.')
        self.student.father_name = u'Rudolf'
        #error, payment = utils.setPaymentDetails('schoolfee_incl',self.student)
        #self.assertEqual(error, 'No additional fees required.')
        error, payment = utils.setPaymentDetails('schoolfee_incl',self.student)
        self.assertEqual(payment.p_level, 200)
        self.assertEqual(payment.p_session, 2005)
        self.assertEqual(payment.amount_auth, 240588.0)
        self.assertEqual(payment.p_item, u'CERT1')
        self.assertEqual(error, None)

        self.student['studycourse'].current_session = 2004
        self.student['studycourse'].entry_session = 2004
        error, payment = utils.setPaymentDetails('clearance',self.student)
        self.assertEqual(error, 'Acceptance Fee payments not allowed.')
        IWorkflowState(self.student).setState('cleared')
        error, payment = utils.setPaymentDetails('clearance_incl',self.student)
        self.assertEqual(error, 'No additional fees required.')
        error, payment = utils.setPaymentDetails('clearance',self.student)
        self.assertEqual(payment.p_level, 100)
        self.assertEqual(payment.p_session, 2004)
        self.assertEqual(payment.amount_auth, 14000.0)
        self.assertEqual(payment.p_item, u'CERT1')
        self.assertEqual(error, None)

        self.student['studycourse'].current_session = 2004
        error, payment = utils.setPaymentDetails('clearance',self.student, 2004, 100)
        self.assertEqual(error, 'This is not a previous session.')
        error, payment = utils.setPaymentDetails('schoolfee',self.student, 2004, 100)
        self.assertEqual(payment.p_level, 100)
        self.assertEqual(payment.p_session, 2004)
        self.assertEqual(payment.amount_auth, 184099.0)
        self.assertEqual(payment.p_item, u'CERT1')
        self.assertEqual(error, None)
        return

    def test_maxCreditsExceeded(self):
        # non-final-year student
        students_utils = getUtility(IStudentsUtils)
        studylevel = grok.Container()
        studylevel.total_credits = 30
        studylevel.level = 100
        self.student['studycourse']['100'] = studylevel
        course = grok.Model()
        course.credits = 18
        warning = students_utils.warnCreditsOOR(studylevel, course)
        self.assertEqual(warning, None)
        course.credits = 19
        warning = students_utils.warnCreditsOOR(studylevel, course)
        self.assertEqual(warning, 'Maximum credits exceeded.')
        return

    def test_setMatricNumber(self):
        IWorkflowState(self.student).setState('school fee paid')
        site = grok.getSite()
        utils = getUtility(IStudentsUtils)
        site['configuration'].next_matric_integer = 1
        site['configuration'].next_matric_integer_2 = 1
        site['configuration'].next_matric_integer_3 = 1
        site['configuration'].next_matric_integer_4 = 1
        self.student.matric_number = None
        #msg, mnumber = utils.setMatricNumber(self.student)
        #self.assertEqual(msg, 'Matriculation number cannot be set.')
        #payment = createObject('waeup.StudentOnlinePayment')
        #payment.p_category = u'concessional'
        #payment.p_id = u'anyid'
        #payment.p_state = u'paid'
        #self.student['payments']['anykey'] = payment
        # Regular ft students have a matric number without leading constant.
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(self.student.matric_number, 'fac1/dep1/04/00001')
        self.assertEqual(msg, None)
        # Part time have an extended matric number with leading 'PTP'
        # and a different counter which is next_matric_integer.
        self.student.matric_number = None
        self.student['studycourse'].certificate.study_mode = 'ug_pt'
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(self.student.matric_number, 'PTP/fac1/dep1/04/00001')
        self.assertEqual(site['configuration'].next_matric_integer, 2)
        # DSH have an extended matric number with leading 'DSH'
        # and same counter as PTP.
        self.student.matric_number = None
        self.student['studycourse'].certificate.study_mode = 'ug_dsh'
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(self.student.matric_number, 'DSH/fac1/dep1/04/00002')
        self.assertEqual(site['configuration'].next_matric_integer, 3)
        # Students in faculty FBM get an extended matric number with leading 'CMS'
        # and the regular counter which is next_matric_integer_2.
        self.app['faculties']['fac1'].code = 'FBM'
        self.student['studycourse'].certificate.study_mode = 'ug_ft'
        self.student.matric_number = None
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(self.student.matric_number, 'CMS/FBM/dep1/04/00002')
        self.assertEqual(site['configuration'].next_matric_integer_2, 3)
        # PG Students get an extended matric number with leading 'AAU/SPS'
        # and the pg  counter which is next_matric_integer_3.
        self.app['faculties']['fac1'].code = 'ABC'
        self.student['studycourse'].certificate.study_mode = 'special_pg_ft'
        self.student.matric_number = None
        self.certificate.degree = 'AGRB'
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(self.student.matric_number, 'AAU/SPS/ABC/dep1/04/AGRB/00001')
        self.assertEqual(site['configuration'].next_matric_integer_3, 2)
        self.student.matric_number = None
        # students in IOE don't have a department
        self.app['faculties']['fac1'].code = 'IOE'
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(self.student.matric_number, 'AAU/SPS/IOE/04/AGRB/00002')
        # Diploma Students get a matric number with leading 'IOS'
        # and the dp counter which is next_matric_integer_3.
        self.student['studycourse'].certificate.study_mode = 'dp_ft'
        self.student.matric_number = None
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(self.student.matric_number, 'IOE/DIP/04/00001')
        self.assertEqual(site['configuration'].next_matric_integer_4, 2)
        # Foundation programme students don't get matric number.
        self.student.matric_number = None
        self.student['studycourse'].certificate.study_mode = 'found'
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(msg, 'Matriculation number cannot be set.')
        self.assertEqual(mnumber, None)
        # Certificate must be set.
        self.student.matric_number = None
        self.student['studycourse'].certificate = None
        msg, mnumber = utils.setMatricNumber(self.student)
        self.assertEqual(msg, 'No certificate assigned.')
        return

    def test_getClassFromCGPA(self):
        site = grok.getSite()
        utils = getUtility(IStudentsUtils)
        gpaclass, gpaboundary = utils.getClassFromCGPA(4.6, self.student)
        self.assertEqual(gpaclass, 5)
        self.assertEqual(gpaboundary, '1st Class Honours')
        self.certificate.study_mode = 'dp_ft'
        gpaclass, gpaboundary = utils.getClassFromCGPA(4.6, self.student)
        self.assertEqual(gpaclass, 4)
        self.assertEqual(gpaboundary, 'Distinction')
        studylevel = StudentStudyLevel()
        studylevel.level = 520
        self.student['studycourse'].addStudentStudyLevel(self.certificate,
            studylevel)
        gpaclass, gpaboundary = utils.getClassFromCGPA(4.6, self.student)
        self.assertEqual(gpaclass, 1)
        self.assertEqual(gpaboundary, 'Pass')
