# coding: utf-8

# Copyright (C) 1994-2021 Altair Engineering, Inc.
# For more information, contact Altair at www.altair.com.
#
# This file is part of both the OpenPBS software ("OpenPBS")
# and the PBS Professional ("PBS Pro") software.
#
# Open Source License Information:
#
# OpenPBS is free software. You can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the
# Free Software Foundation, either version 3 of the License, or (at your
# option) any later version.
#
# OpenPBS 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 Affero General Public
# License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# Commercial License Information:
#
# PBS Pro is commercially licensed software that shares a common core with
# the OpenPBS software.  For a copy of the commercial license terms and
# conditions, go to: (http://www.pbspro.com/agreement.html) or contact the
# Altair Legal Department.
#
# Altair's dual-license business model allows companies, individuals, and
# organizations to create proprietary derivative works of OpenPBS and
# distribute them - whether embedded or bundled with other software -
# under a commercial license agreement.
#
# Use of Altair's trademarks, including but not limited to "PBS™",
# "OpenPBS®", "PBS Professional®", and "PBS Pro™" and Altair's logos is
# subject to Altair's trademark licensing policies.


from tests.functional import *
import os


class TestQsubOptionsArguments(TestFunctional):
    """
    validate qsub submission with a script and executable.
    note: The no-arg test is an interactive job, which is tested in
    SmokeTest.test_interactive_job
    """
    fn = None

    def setUp(self):
        TestFunctional.setUp(self)
        script = '/bin/hostname'
        self.fn = self.du.create_temp_file(body=script)
        self.qsub_cmd = os.path.join(
            self.server.pbs_conf['PBS_EXEC'], 'bin', 'qsub')
        self.jobdir_root = "/tmp"
        self.jobdir = []
        self.remove_jobdir = False

    def tearDown(self):
        TestFunctional.tearDown(self)
        if self.remove_jobdir:
            for mom in self.moms.values():
                for d in self.jobdir:
                    if d.startswith(self.jobdir_root):
                        self.logger.info('%s:remove jobdir %s' % (
                                         mom.hostname, d))
                        self.du.rm(hostname=mom.shortname, sudo=True,
                                   path=d, recursive=True, force=True)
            self.remove_jobdir = False

    def validate_error(self, err):
        ret_msg = 'qsub: Failed to save job/resv, '\
            'refer server logs for details'
        # PBS returns 15161 error code when it fails to save the job in db
        # but in PTL_CLI mode it returns modulo of the error code.

        # PTL_API and PTL_CLI mode returns 15161 and 57 error code respectively
        if err.rc == 15161 or err.rc == 15161 % 256:
            self.assertFalse(err.msg[0], ret_msg)
        else:
            self.fail(
                "ERROR in submitting a job with future time: %s" %
                err.msg[0])

    def jobdir_shared_body(self, location):
        """
        Test submission of job with sandbox=PRIVATE,
        and moms have $jobdir_root set to shared.
        """
        self.remove_jobdir = True
        momA = self.moms.values()[0]
        momB = self.moms.values()[1]

        loglevel = {'$logevent': 4095}
        momB.add_config(loglevel)
        c = {'$jobdir_root': '%s shared' % location}
        for mom in [momA, momB]:
            mom.add_config(c)
            mom.restart()

        a = {'Resource_List.select': '2:ncpus=1',
             'Resource_List.place': 'scatter',
             ATTR_sandbox: 'PRIVATE',
             }
        j = Job(TEST_USER, attrs=a)
        j.set_sleep_time(30)
        jid = self.server.submit(j)
        self.server.expect(JOB, {'job_state': 'R'}, id=jid)
        attribs = self.server.status(JOB, id=jid)
        jobdir = attribs[0]['jobdir']
        self.jobdir.append(jobdir)
        relpath = os.path.join(
            self.server.pbs_conf['PBS_EXEC'], 'bin', 'pbs_release_nodes')

        rel_cmd = [relpath, '-j', jid, momB.shortname]
        ret = self.server.du.run_cmd(self.server.hostname, cmd=rel_cmd,
                                     runas=TEST_USER)
        self.assertEqual(ret['rc'], 0)
        # sister mom has preserved the file
        errmsg = "sister mom deleted jobdir %s" % jobdir
        rc = self.du.isdir(hostname=momB.shortname, path=jobdir,
                           sudo=True)
        self.assertTrue(rc, errmsg)
        msg = "shared jobdir %s to be removed by primary mom" % jobdir
        momB.log_match(msg)
        self.server.expect(JOB, 'job_state', op=UNSET, id=jid)
        # primary mom has deleted the file
        errmsg = "MS mom preserved jobdir %s" % jobdir
        rc = self.du.isdir(hostname=momA.shortname, path=jobdir,
                           sudo=True)
        self.assertFalse(rc, errmsg)

    def test_qsub_with_script_with_long_TMPDIR(self):
        """
        submit a job with a script and with long path in TMPDIR
        """
        longpath = '%s/aaaaaaaaaa/bbbbbbbbbb/cccccccccc/eeeeeeeeee/\
ffffffffff/gggggggggg/hhhhhhhhhh/iiiiiiiiii/jj/afdj/hlppoo/jkloiytupoo/\
bhtiusabsdlg' % (os.environ['HOME'])
        os.environ['TMPDIR'] = longpath
        if not os.path.exists(longpath):
            os.makedirs(longpath)
        cmd = [self.qsub_cmd, self.fn]
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        self.assertEqual(rv['rc'], 0, 'qsub failed')

    def test_qsub_with_script_executable(self):
        """
        submit a job with a script and executable
        """
        cmd = [self.qsub_cmd, self.fn, '--', self.mom.sleep_cmd, '10']
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        failed = rv['rc'] == 2 and rv['err'][0].split(' ')[0] == 'usage:'
        self.assertTrue(failed, 'qsub should have failed, but did not fail')

    def test_qsub_with_script_dashes(self):
        """
        submit a job with a script and dashes
        """
        cmd = [self.qsub_cmd, self.fn, '--']
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        failed = rv['rc'] == 2 and rv['err'][0].split(' ')[0] == 'usage:'
        self.assertTrue(failed, 'qsub should have failed, but did not fail')

    def test_qsub_with_dashes(self):
        """
        submit a job with only dashes
        """
        cmd = [self.qsub_cmd, '--']
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        failed = rv['rc'] == 2 and rv['err'][0].split(' ')[0] == 'usage:'
        self.assertTrue(failed, 'qsub should have failed, but did not fail')

    def test_qsub_with_script(self):
        """
        submit a job with only a script
        """
        cmd = [self.qsub_cmd, self.fn]
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        self.assertEqual(rv['rc'], 0, 'qsub failed')

    def test_qsub_with_executable(self):
        """
        submit a job with only an executable
        """
        cmd = [self.qsub_cmd, '--', self.mom.sleep_cmd, '10']
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        self.assertEqual(rv['rc'], 0, 'qsub failed')

    def test_qsub_with_option_executable(self):
        """
        submit a job with an option and executable
        """
        cmd = [self.qsub_cmd, '-V', '--', self.mom.sleep_cmd, '10']
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        self.assertEqual(rv['rc'], 0, 'qsub failed')

    def test_qsub_with_option_script(self):
        """
        submit a job with an option and script
        """
        cmd = [self.qsub_cmd, '-V', self.fn]
        rv = self.du.run_cmd(self.server.hostname, cmd=cmd)
        self.assertEqual(rv['rc'], 0, 'qsub failed')

    def test_qsub_with_option_a(self):
        """
        Test submission of job with execution time(future and past)
        """
        self.server.manager(MGR_CMD_SET, NODE,
                            {'resources_available.ncpus': 2},
                            self.mom.shortname)
        present_tm = int(time.time())
        # submit a job with future time and should start whenever time hits
        future_tm = time.strftime(
            "%Y%m%d%H%M", time.localtime(
                present_tm + 120))
        j1 = Job(TEST_USER, {ATTR_a: future_tm})
        try:
            jid_1 = self.server.submit(j1)
        except PbsSubmitError as e:
            self.validate_error(e)
        self.server.expect(JOB, {'job_state': 'W'}, id=jid_1)
        self.logger.info(
            'waiting for 90 seconds to run the job as it is a future job...')
        self.server.expect(JOB, {'job_state': 'R'}, id=jid_1, offset=90,
                           interval=2)

        # submit a job with past time and should start right away
        past_tm = time.strftime(
            "%Y%m%d%H%M", time.localtime(
                present_tm - 3600))
        j2 = Job(TEST_USER, {ATTR_a: past_tm})
        try:
            jid_2 = self.server.submit(j2)
        except PbsSubmitError as e:
            self.validate_error(e)
        self.server.expect(JOB, {'job_state': 'R'}, id=jid_2)

    @requirements(num_moms=2)
    def test_qsub_sandbox_private_jobdir_shared(self):
        """
        Test submission of job with sandbox=PRIVATE,
        and moms have $jobdir_root set to shared.
        """
        self.jobdir_shared_body(self.jobdir_root)

    @requirements(num_moms=2)
    def test_qsub_sandbox_private_jobdir_default_shared(self):
        """
        Test submission of job with sandbox=PRIVATE,
        and moms have $jobdir_root set to shared,
        with location set to PBS_USER_HOME.
        """
        self.jobdir_shared_body("PBS_USER_HOME")

    @runOnlyOnLinux
    def test_qsub_with_options_o_e_with_colon(self):
        """
        Test submission of job with output and error
        paths with a colon
        """
        self.server.manager(MGR_CMD_SET, SERVER,
                            {'job_history_enable': 'true'})
        tmp_dir = self.du.create_temp_dir(asuser=TEST_USER)
        err_file = os.path.join(tmp_dir, 'err:or_file')
        out_file = os.path.join(tmp_dir, 'out:put_file')
        a = {ATTR_e: err_file, ATTR_o: out_file}
        j = Job(TEST_USER, attrs=a)
        j.set_sleep_time(1)
        jid = self.server.submit(j)
        self.server.expect(JOB, {'job_state': 'F'}, extend='x', id=jid)
        self.assertTrue(os.path.isfile(err_file),
                        "The error file was not found")
        self.assertTrue(os.path.isfile(out_file),
                        "The output file was not found")