#!/usr/bin/env python
#
# MIT License
#
# Copyright The SCons Foundation
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"""
Verify that we handle keyboard interrupts (CTRL-C) correctly.
"""

import TestSCons

test = TestSCons.TestSCons()

test.write('toto.c', r"""
void foo()
{}
""")

test.write('SConstruct', r"""
import os
import sys
import signal

if 'killpg' not in dir(os) or 'setpgrp' not in dir(os) or sys.platform == 'cygwin':
    # The platform does not support process group. Therefore, we
    # directly invoked the SIGINT handler to simulate a
    # KeyboardInterrupt. This hack is necessary because there is no
    # easy way to get access to the current Job/Taskmaster object.
    #
    # Note that this way of performing the test is not as good as
    # using killpg because the Taskmaster is stopped synchronously. In
    # addition, the SCons subprocesses (or forked children before the
    # exec() of the subprocess) are never killed. This therefore
    # exercise less SCons functionality.
    #
    # FIXME: There seems to be a bug on Cygwin where the compiler
    # process hangs after sending the SIGINT signal to the process
    # group. It is probably a bug in cygwin1.dll, or maybe in the
    # Python 'C' code or the Python subprocess module. We therefore do
    # not use 'killpg' on Cygwin.
    def explode(env, target, source):
        handler = signal.getsignal(signal.SIGINT)
        handler(signal.SIGINT, None)
        return 0
else:
    # The platform does support process group so we use killpg to send
    # a SIGINT to everyone.

    # Make sure that SCons is a process group leader.
    os.setpgrp()

    def explode(env, target, source):
        os.killpg(0, signal.SIGINT)


all = []

for i in range(40):
    all.extend(Object(f'toto{i:05}', 'toto.c'))

all.extend(Command('broken', 'toto.c', explode))

Default(Alias('all', all))
"""
)

interruptedStr = """\
.*\
scons: building terminated because of errors\\.
.*\
scons: writing .sconsign file\\.
.*\
"""

def runtest(arguments):
    test.run(arguments='-c')
    test.run(
        arguments=arguments,
        status=2,
        stdout=interruptedStr,
        stderr='.*scons: Build interrupted\\.',
        match=TestSCons.match_re_dotall,
    )


for i in range(2):
    runtest('-j1')
    runtest('-j4')
    runtest('-j8')
    runtest('-j16')
    runtest('-j32')
    runtest('-j64')

    runtest('-j1 --random')
    runtest('-j4 --random')
    runtest('-j8 --random')
    runtest('-j16 --random')
    runtest('-j32 --random')
    runtest('-j64 --random')

test.pass_test()

# Local Variables:
# tab-width:4
# indent-tabs-mode:nil
# End:
# vim: set expandtab tabstop=4 shiftwidth=4:
