"

jv:libgdbs - GNU Debugger Interface Library

Copyright (C) 2015-now Jan Vrany

Copyright (C) 2020-2021 LabWare

Copyright (C) 2023 LabWare

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License. 

This library 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

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

"

"{ Package: 'jv:libgdbs/tests' }"

"{ NameSpace: Smalltalk }"

GDBDebuggerTestCase subclass:#GDBDebuggerTestsR

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	category:'GDB-Tests'

!

!GDBDebuggerTestsR class methodsFor:'documentation'!

copyright

"

jv:libgdbs - GNU Debugger Interface Library

Copyright (C) 2015-now Jan Vrany

Copyright (C) 2020-2021 LabWare

Copyright (C) 2023 LabWare

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License. 

This library 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

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library; if not, write to the Free Software

Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

"

!

documentation

"

    Tests for GDBDebugger API. 

    # Custom Debugger Setup

    By default, this tests spawns a default, locally run

    debugger for each test (see GDBDebugger >> new). To customize

    the debugger setup, set GDBDebuggerTestsR >> debuggerSetupBlock

    returning a GDBDebugger instance with all the necessary setup 

    done. For example, to use externally run GDB over TCP socket:

     * First, run 'GDB/MI server' (don't confuse with `gdbservver`!!)

       run (in terminal):

           socat TCP4-LISTEN:1234,FORK EXEC:'gdb -i mi2'

     *

    [author:]

        Jan Vrany <jan.vrany@fit.cvut.cz>

    [instance variables:]

    [class variables:]

    [see also:]

"

! !

!GDBDebuggerTestsR class methodsFor:'accessing'!

resources

    ^ Array with: GDBDebuggeesResource

    "Created: / 28-02-2015 / 00:45:00 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!GDBDebuggerTestsR methodsFor:'tests - basic'!

test_02

    | inferior1 thread1 frame1 frame2  seqNo1 seqNo2 |

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    debugger send: 'b factorial'.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger inferiors size == 1.

    inferior1 := debugger inferiors anElement.

    "/ Windows (starting with Windows 10) introduced a new

    "/ multi-threaded program loader so it can load .dll

    "/ faster, supposedly. Therefore there may be couple other

    "/ threads. Hence in windows, only assert that there is

    "/ at least on thread.

    OperatingSystem isMSWINDOWSlike ifTrue:[

        self assert: inferior1 threads notEmpty.

    ] ifFalse:[ 

        self assert: inferior1 threads size == 1

    ].

    thread1 := inferior1 threads anElement.

    self assert: thread1 stack size == 2.

    self assert: thread1 status isStopped.

    frame1 := thread1 stack first.

    frame2 := thread1 stack second.

    self assert: frame1 variables size == 1.

    self assert: frame1 variables first name = 'i'.

    self assert: frame1 variables first value = '5'.

    self assert: frame2 variables size == 4.

    self assert: frame2 variables first name = 'argc'.

    self assert: frame2 variables second name = 'argv'.

    self assert: frame2 variables third name = 'i'.

    self assert: frame2 variables fourth name = 'f'.

    seqNo1 := debugger currentInferiorStateSequnceNumber.

    debugger send: 'd'.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    self assert: thread1 isDead.

    seqNo2 := debugger currentInferiorStateSequnceNumber.

    self assert: seqNo1 ~~ seqNo2.

    debugger send: 'quit' andWait: false.

    "Created: / 28-02-2015 / 00:55:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 19-01-2018 / 09:23:24 / jv"

    "Modified: / 18-10-2018 / 10:54:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_03

    | inferior1 thread1 |

    self skipIf: OperatingSystem isMSWINDOWSlike  description: 'Skipped since we cannot interact with inferor on Windows (no TTY support)'.

    debugger executable: GDBDebuggeesResource current binaryPressAnyKey.

    debugger send: (GDBMI_exec_run new).

    self assert: debugger inferiors size == 1.

    inferior1 := debugger inferiors anElement.

    self assert: inferior1 threads size == 1.

    thread1 := inferior1 threads anElement.

    self assert: thread1 isRunning.

    debugger send: (GDBMI_exec_interrupt new arguments: #('--all')) andWaitFor: GDBStoppedEvent.

    self assert: thread1 isRunning not.

    debugger inferiorStdin nextPutLine:'X'.  

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    debugger send: 'quit' andWait: false

    "Created: / 08-03-2015 / 07:42:10 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 12-01-2018 / 14:53:19 / jv"

    "Modified: / 18-10-2018 / 10:55:00 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_basic_01

    | timeToExit eventPumpProcess |

    timeToExit := 0.

    eventPumpProcess := (debugger instVarNamed: #connection) instVarNamed: #eventPumpProcess.

    self assert: debugger isConnected.

    self assert: eventPumpProcess isDead not.

    debugger send: (GDBMI_gdb_exit new) andWait: false.      

    [ debugger isConnected and:[timeToExit < 2000] ] whileTrue:[

        Logger trace:'Still connected...'.

        timeToExit := timeToExit + 200.

    ].

    self assert: timeToExit < 2000.

    self assert: debugger isConnected not.

    self assert: eventPumpProcess isDead.

    "Created: / 24-06-2014 / 09:06:32 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 12-01-2018 / 15:29:08 / jv"

    "Modified: / 18-10-2018 / 10:55:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 26-03-2021 / 15:04:21 / Jan Vrany <jan.vrany@labware.com>"

!

test_breakpoints_01a

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'b factorial'.

    self assert: debugger breakpoints size == 1.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints first hasMultipleLocations not.

    self assert: debugger breakpoints first func = 'factorial'.

    debugger send: 'del'.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'quit' andWait: false.

    "Created: / 07-07-2017 / 12:25:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 26-03-2019 / 11:09:40 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_breakpoints_01b

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'b factorial'.

    self assert: debugger breakpoints size == 1.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints first func = 'factorial'.

    debugger send: 'dis ', debugger breakpoints anElement number printString.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints anElement enabled == false.

    debugger send: (GDBMI_break_enable arguments: { debugger breakpoints anElement number printString }).

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints anElement enabled == true.

    debugger send: (GDBMI_break_disable arguments: { debugger breakpoints anElement number printString }).

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints anElement enabled == false.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    debugger send: 'quit' andWait: false.

    "Created: / 07-07-2017 / 12:27:12 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (format): / 18-10-2018 / 10:55:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 22-05-2021 / 16:30:40 / Jan Vrany <jan.vrany@labware.com>"

!

test_breakpoints_01c

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'b factorial'.

    self assert: debugger breakpoints size == 1.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints first func = 'factorial'.

    debugger breakpoints anElement enabled: false.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints anElement enabled == false.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    debugger send: 'quit' andWait: false.

    "Created: / 07-07-2017 / 12:34:48 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 18-10-2018 / 10:55:30 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_breakpoints_02

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'b main'.

    self assert: debugger breakpoints size == 1.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger breakpoints size == 1.

    debugger send: 'del'.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'quit' andWait: false.

    "Created: / 07-07-2017 / 11:53:53 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 12-01-2018 / 22:04:46 / jv"

    "Modified: / 18-10-2018 / 10:55:36 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_breakpoints_03a

    self skipIf: OperatingSystem isMSWINDOWSlike  description: 'Skipped since we don;t have separate console TTY (no TTY support)'.

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    self assert: debugger breakpoints isEmpty.

    debugger consoleInput nextPutLine: 'b factorial'.

    Delay waitForSeconds: 1.  

    self assert: debugger breakpoints size == 1.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints first func = 'factorial'.

    debugger consoleInput nextPutLine: 'del 1'.

    Delay waitForSeconds: 1.  

    self assert: debugger breakpoints isEmpty.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'quit' andWait: false.

    "Created: / 10-07-2017 / 22:05:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 12-01-2018 / 14:57:37 / jv"

    "Modified: / 18-10-2018 / 10:55:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_breakpoints_04a

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'b factorial'.

    self assert: debugger breakpoints size == 1.

    debugger breakpoints first script: 'printf "factorial\n"

disable ', debugger breakpoints first number asString.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger breakpoints size == 1.

    "/ We need to wait a until breakpoint-modifed

    "/ event is received.

    self assert: debugger breakpoints first enabled == false.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    debugger send: 'quit' andWait: false.

    "Created: / 11-07-2017 / 20:35:20 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 18-10-2018 / 10:55:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_breakpoints_05a

    "

    This tests breakpoints with multiple locations. Due to a bug in

    GDB (up to 8.1), this test fails with stock GDB.

    Patches has been sent to GDB, see:

        * https://sourceware.org/ml/gdb/2018-05/msg00024.html

        * https://sourceware.org/ml/gdb-patches/2018-05/msg00836.html

    Meanwhile, this test is skipped.

    "    

    self skipIf: true description: 'Known to fail due to a bug in GDB'.

    debugger executable: GDBDebuggeesResource current binaryBreakpoints1.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'b add'.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints first hasMultipleLocations.

    self assert: debugger breakpoints first locations size > 1.

    self assert: debugger breakpoints first enabled.

    self assert: debugger breakpoints first locations first enabled.

    debugger send: 'dis 1'.

    debugger send: 'dis 1.1'.

    self assert: debugger breakpoints first enabled not.

    self assert: debugger breakpoints first locations first enabled not.

    debugger send: 'en 1'.

    debugger send: 'en 1.1'.

    self assert: debugger breakpoints first enabled.

    self assert: debugger breakpoints first locations first enabled.

    debugger breakpoints first enabled: false.

    debugger breakpoints first locations first enabled: false.    

    self assert: debugger breakpoints first enabled not.

    self assert: debugger breakpoints first locations first enabled not.    

    debugger breakpoints first enabled: true.

    debugger breakpoints first locations first enabled: true.    

    self assert: debugger breakpoints first enabled.

    self assert: debugger breakpoints first locations first enabled.    

    debugger send: 'del 1'.

    self assert: debugger breakpoints size == 0.

    debugger send: 'quit' andWait: false.

    "Created: / 18-05-2018 / 10:52:10 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 26-03-2019 / 11:09:21 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_breakpoints_06a

    debugger executable: GDBDebuggeesResource current binaryFactorial1.

    self assert: debugger breakpoints isEmpty.

    debugger send: (GDBMI_break_insert arguments:{'factorial'}).

    self assert: debugger breakpoints size == 1.

    debugger send: 'r' andWaitFor: GDBStoppedEvent.

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints first hasMultipleLocations not.

    self assert: debugger breakpoints first func = 'factorial'.

    debugger send: (GDBMI_break_delete arguments:{'1'}).

    self assert: debugger breakpoints isEmpty.

    debugger send: 'c' andWaitFor: GDBThreadGroupExitedEvent.

    self assert: debugger breakpoints isEmpty.

    debugger send: 'quit' andWait: false.

    "Created: / 21-05-2021 / 22:07:08 / Jan Vrany <jan.vrany@labware.com>"

!

test_breakpoints_06b

    debugger executable: GDBDebuggeesResource current binaryBreakpoints1.

    self assert: debugger breakpoints isEmpty.

    debugger send: (GDBMI_break_insert arguments:{'add'}).

    self assert: debugger breakpoints size == 1.

    self assert: debugger breakpoints first hasMultipleLocations.

    self assert: debugger breakpoints first locations size > 1.

    self assert: debugger breakpoints first enabled.

    self assert: debugger breakpoints first locations first enabled.                      

    debugger send: (GDBMI_break_delete arguments:{'1'}).

    self assert: debugger breakpoints isEmpty.

    debugger send: 'quit' andWait: false.

    "Created: / 22-05-2021 / 15:55:24 / Jan Vrany <jan.vrany@labware.com>"

!

test_commands

    self assert: (debugger hasCommand: GDBMI_info_gdb_mi_command ).

    self assert: (debugger hasCommand: GDBMI_info_gdb_mi_command new operation).

    self deny: (debugger hasCommand: '-bogus').

    "Created: / 29-12-2018 / 23:13:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

test_directories

    | directories current |

    directories := debugger directories.

    self assert: directories isArray.

    self assert: directories notEmpty.

    "/ GDB uses cygwin paths, so convert Windows path to Cygwin paths

    "/ on Windows.

    OperatingSystem isMSWINDOWSlike ifTrue:[ 

        current := Filename currentDirectory cygName

    ] ifFalse:[ 

        current := Filename currentDirectory pathName

    ].

    debugger send: ('set directories %1' bindWith: current).

    directories := debugger directories.