File: common.scm

package info (click to toggle)
guile-ssh 0.18.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,996 kB
  • sloc: ansic: 4,821; lisp: 4,171; makefile: 310; sh: 259
file content (751 lines) | stat: -rw-r--r-- 28,868 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
;;; common.scm -- Heper procedures and macros for tests.

;; Copyright (C) 2015-2024 Artyom V. Poptsov <poptsov.artyom@gmail.com>
;;
;; This file is a part of Guile-SSH.
;;
;; Guile-SSH 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 3 of the
;; License, or (at your option) any later version.
;;
;; Guile-SSH 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 Guile-SSH.  If not, see <http://www.gnu.org/licenses/>.

(define-module (tests common)
  #:use-module (srfi srfi-64)
  #:use-module (srfi srfi-26)
  #:use-module (ice-9 rdelim)
  #:use-module (ice-9 format)
  #:use-module (ice-9 regex)
  #:use-module (ice-9 popen)
  #:use-module (ice-9 threads)
  #:use-module (ssh session)
  #:use-module (ssh channel)
  #:use-module (ssh server)
  #:use-module (ssh auth)
  #:use-module (ssh log)
  #:use-module (ssh message)
  #:use-module (ssh version)
  #:export (;; Variables
            %topdir
            %topbuilddir
            %knownhosts
            %config
            %addr
            %rsakey
            %rsakey-pub
            %dsakey
            %dsakey-pub
            %ecdsakey
            %ecdsakey-pub
            %ecdsakey-encrypted
            %rsakey-encrypted
            %dsakey-encrypted

            ;; Procedures
            sanitize-string
            get-unused-port
            set-port!
            test-begin-with-log
            test-assert-with-log
            test-error-with-log
            test-error-with-log/=
            test-error-with-log/match
            test-equal-with-log
            start-session-loop
            make-session-for-test
            make-server-for-test
            make-libssh-log-printer
            call-with-connected-session
            call-with-connected-session/shell
            start-server-loop
            start-server/dt-test
            start-server/dist-test
            start-server/exec
            run-client-test
            run-server-test
            setup-test-suite-logging!
            setup-test-logging!
            format-log/scm
            poll))


(define %topdir (getenv "abs_top_srcdir"))
(define %topbuilddir (getenv "abs_top_builddir"))
(define %guile (getenv "GUILE"))
(define %addr   "127.0.0.1")
(define *port*  12400)


;; Keys
(define %rsakey       (format #f "~a/tests/keys/rsakey"       %topdir))
(define %rsakey-pub   (format #f "~a/tests/keys/rsakey.pub"   %topdir))
(define %dsakey       (format #f "~a/tests/keys/dsakey"       %topdir))
(define %dsakey-pub   (format #f "~a/tests/keys/dsakey.pub"   %topdir))
(define %ecdsakey     (format #f "~a/tests/keys/ecdsakey"     %topdir))
(define %ecdsakey-pub (format #f "~a/tests/keys/ecdsakey.pub" %topdir))

(define %ecdsakey-encrypted (format #f "~a/tests/keys/encrypted-ecdsa-key" %topdir))
(define %rsakey-encrypted   (format #f "~a/tests/keys/encrypted-rsa-key" %topdir))
(define %dsakey-encrypted   (format #f "~a/tests/keys/encrypted-dsa-key" %topdir))


(define (format-log/scm level proc-name message . args)
  "Format a log MESSAGE, append \"[SCM]\" to a PROC-NAME."
  (apply format-log level (string-append "[SCM] " proc-name)  message args))


(define %knownhosts (format #f "~a/tests/knownhosts"
                            (getenv "abs_top_builddir")))

(define %config (format #f "~a/tests/config" %topdir))



(define (sanitize-string string)
  "Replace all problematic chars in a STRING with '-'"
  (string-map (lambda (char)
                (case char
                  ((#\, #\space #\! #\/)
                   #\-)
                  (else
                   char)))
              string))


;; Pass the test case NAME as the userdata to the libssh log
(define-syntax test-assert-with-log
  (syntax-rules ()
    ((_ name body ...)
     (test-assert name
       (begin
         (setup-test-logging! name)
         (set-log-userdata! name)
         body ...)))))

;; Ensure that the specific ERROR is raised during the test, check the error
;; with HANDLER.
(define-syntax test-error-with-log/handler
  (syntax-rules ()
    ((_ name expr handler)
     (test-assert-with-log name
       (catch #t
         (lambda () expr #f)
         handler)))))

;; Ensure that the specific ERROR is raised during the test and the error is
;; raised with the specified MESSAGE.
(define-syntax-rule (test-error-with-log/= name error expected-message expr)
  (test-error-with-log/handler name expr
                               (lambda (key . args)
                                 (if (equal? key error)
                                     (let* ((message (cadr args))
                                            (result  (string=? message
                                                               expected-message)))
                                       (unless result
                                         (format-log/scm 'nolog name
                                                         (string-append
                                                          "Messages do not match: "
                                                          "expected \"~a\", got \"~a\"")
                                                         result expected-message))
                                       result)
                                     (begin
                                       (format-log/scm 'nolog name
                                                       (string-append
                                                        "Errors do not match: "
                                                        "expected '~a', got '~a' (args: ~a)")
                                                       error key args)
                                       #f)))))

(define-syntax-rule (test-error-with-log/match name error expected-message expr)
  (test-error-with-log/handler
   name
   expr
   (lambda (key . args)
     (if (equal? key error)
         (let* ((message (cadr args))
                (result  (string-match expected-message message)))
           (unless result
             (format-log/scm 'nolog name
                             (string-append
                              "Messages do not match: "
                              "expected \"~a\", got \"~a\"")
                             result expected-message))
           result)
         (begin
           (format-log/scm 'nolog name
                           (string-append
                            "Errors do not match: "
                            "expected '~a', got '~a' (args: ~a)")
                           error key args)
           #f)))))

;; Ensure that the specific ERROR is raised during the test.
(define-syntax test-error-with-log
  (syntax-rules ()
    ((_ name error expr)
     (test-error-with-log/handler name expr
                                  (lambda (key . args)
                                    (let ((result (equal? key error)))
                                      (unless result
                                        (format-log/scm 'nolog name
                                                        (string-append
                                                         "Errors do not match: "
                                                         "expected ~a, got ~a (args: ~a)")
                                                        error key args))
                                      result))))
    ((_ name expr)
     (test-error-with-log/handler name expr (const #t)))))

(define-syntax test-equal-with-log
  (syntax-rules ()
    ((_ name expected body ...)
     (test-equal name
       expected
       (begin
         (setup-test-logging! name)
         (set-log-userdata! name)
         body ...)))))


(define (start-session-loop session body)
  (let session-loop ((msg         (server-message-get session))
                     (msg-counter 0))
    (format-log/scm 'nolog "start-session-loop"
                    "message: ~a" msg)
    (when msg
      (format-log/scm 'nolog "start-session-loop"
                      "message being handled: ~a" msg)
      (body msg)
      (format-log/scm 'nolog "start-session-loop"
                      "message handled: ~a" msg))
    (if (connected? session)
        (begin
          (format-log/scm 'nolog "start-session-loop"
                          "message counter: ~a" msg-counter)
          (session-loop (server-message-get session) (1+ msg-counter)))
        (format-log/scm 'nolog "start-session-loop"
                        "disconnected; message counter: ~a" msg-counter))))

(define (make-session-for-test)
  "Make a session with predefined parameters for a test."
  (format-log/scm 'nolog "make-session-for-test"
                  "host: ~a; port: ~a" %addr *port*)
  (make-session
   #:host    %addr
   #:port    *port*
   #:timeout 10        ;seconds
   #:user    "bob"
   #:knownhosts %knownhosts
   #:log-verbosity 'functions))

(define mtx (make-mutex 'allow-external-unlock))
(define (make-server-for-test)
  "Make a server with predefined parameters for a test."
  (lock-mutex mtx)
  (dynamic-wind
    (const #f)
    (lambda ()
      ;; FIXME: This hack is aimed to give every server its own unique
      ;; port to listen to.  Clients will pick up new port number
      ;; automatically through global `port' symbol as well.
      (set! *port* (get-unused-port))

      (format-log/scm 'nolog "make-server-for-test"
                      "bindaddr: ~a; bindport: ~a" %addr *port*)

      (let ((s (make-server
                #:bindaddr %addr
                #:bindport *port*
                #:rsakey   %rsakey
                #:dsakey   (and (dsa-support?) %dsakey)
                #:log-verbosity 'functions)))
        (format-log/scm 'nolog "make-server-for-test"
                        "***** bindaddr: ~a; bindport: ~a" %addr *port*)
        (server-listen s)
        s))
    (lambda ()
      (unlock-mutex mtx))))

(define (call-with-connected-session proc)
  "Call the one-argument procedure PROC with a freshly created and connected
SSH session object, return the result of the procedure call.  The session is
disconnected when the PROC is finished."
  (let ((session (make-session-for-test)))
    (format-log/scm 'nolog
                    "call-with-connected-session"
                    "session: ~a" session)
    (dynamic-wind
      (lambda ()
        (format-log/scm 'nolog
                        "call-with-connected-session"
                        "~a" "connecting...")
        (let ((result (connect! session)))
          (format-log/scm 'nolog
                          "call-with-connected-session"
                          "result: ~a" result)
          (unless (equal? result 'ok)
            (format-log/scm 'nolog "call-with-connected-session"
                            "ERROR: Could not connect to a server: ~a" result)
            (error "Could not connect to a server" session result))))
      (lambda () (proc session))
      (lambda () (disconnect! session)))))

(define (call-with-connected-session/shell proc)
  "Make a session for a shell test."
  (call-with-connected-session
   (lambda (session)
     (format-log/scm 'nolog "call-with-connected-session/shell"
                     "session: ~a" session)
     (let ((auth-result (authenticate-server session)))
       (format-log/scm 'nolog "call-with-connected-session/shell"
                       "server auth result: ~a" auth-result))
     (let ((auth-result (userauth-none! session)))
       (format-log/scm 'nolog "call-with-connected-session/shell"
                       "client auth result: ~a" auth-result))
     (proc session))))


;;; Port helpers.

(define (port-in-use? port-number)
  "Return #t if a port with a PORT-NUMBER isn't used, #f otherwise."
  (let ((sock (socket PF_INET SOCK_STREAM 0)))
    (catch #t
      (lambda ()
        (bind sock AF_INET INADDR_LOOPBACK port-number)
        (close sock)
        #f)
      (lambda args
        (close sock)
        #t))))

(define get-unused-port
  (let ((port-num   (+ 10000 (random 2345 (random-state-from-platform))))
        (mtx        (make-mutex 'allow-external-unlock))
        (used-ports '()))
    (lambda ()
      "Get an unused port number."
      (lock-mutex mtx)
      (let loop ((num port-num))
        (if (or (port-in-use? num)
                (member num used-ports))
            (loop (1+ num))
            (begin
              (format-log/scm 'nolog "get-unused-port" "port chosen: ~a" num)
              (set! used-ports (cons num used-ports))
              (set! port-num (+ num 1))
              (unlock-mutex mtx)
              num))))))

(define (set-port! port)
  (set! *port* port))


;;;

(define (poll port proc)
  "Poll a PORT, call a PROC when data is available."
  (format-log/scm 'nolog "poll" "Polling ~a ..." port)
  (let p ((ready? (char-ready? port))
          (n      1))
    (if ready?
        (begin
          (format-log/scm 'nolog "poll" "Polling ~a ... done in ~a tries" port n)
          (proc port))
        (if (not (port-closed? port))
            (p (char-ready? port)
               (+ n 1))
            (error "Port is closed" port)))))


;;; Test Servers

(define (start-server-loop server proc)
  "Start a SERVER loop, call PROC on incoming sessions."

  (define (state:init)
    (format-log/scm 'nolog "start-server-loop [state:init]"
                    "server: ~a" server)
    (catch #t
      (lambda ()
        (server-listen server)
        (state:accept))
      (lambda (key . args)
        (format-log/scm 'nolog "start-server-loop"
                        "ERROR: ~a: ~a" key args)
        (state:init))))

  (define (state:accept)
    (format-log/scm 'nolog "start-server-loop [state:accept]"
                    "server: ~a" server)
    (let ((session (server-accept server)))
      (format-log/scm 'nolog "start-server-loop [state:accept]"
                      "session: ~a" session)
      (server-handle-key-exchange session)
      (format-log/scm 'nolog "start-server-loop [state:accept]"
                      "~a" "key exchange handled")
      (proc session)
      (state:accept)))

  (state:init))


(define (start-server/dt-test server rwproc)
  (start-server-loop server
    (lambda (session)
      (start-session-loop session
        (lambda (msg)
          (case (car (message-get-type msg))
            ((request-channel-open)
             (let ((channel (message-channel-request-open-reply-accept msg)))
               (poll channel rwproc)))
            (else
             (message-reply-success msg))))))))


(define %guile-version-string "\
GNU Guile 2.2.3
Copyright (C) 1995-2017 Free Software Foundation, Inc.

Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'.
This program is free software, and you are welcome to redistribute it
under certain conditions; type `,show c' for details.

Enter `,help' for help.
scheme@(guile-user)> ")

(define (start-server/exec server body)
  "Start SERVER for a command execution test."
  (define *channel* #f)

  (define (state:message-handle-exec message session)
      (format-log/scm 'nolog "start-server/exec" "state:message-handle-exec: message: ~A" message)
    (let ((command (exec-req:cmd (message-get-req message))))
      (format-log/scm 'nolog "start-server/exec" "command: ~S" command)
      (cond
       ((or (string=? command "'ping'") (string=? command "ping"))
        (message-reply-success message)
        (channel-request-send-exit-status *channel* 0)
        (write-line "pong" *channel*)
        (catch #t
          (lambda ()
            (channel-send-eof *channel*))
          (lambda args
            (format-log/scm 'nolog "start-server/exec" "ERROR: ~a" args))))
       ((or (string=? command "'uname'") (string=? command "uname"))
        ;; For exit status testing
        (body session message *channel*))
       ((string=? command "exit status") ; For exit status testing
        (message-reply-success message)
        (channel-request-send-exit-status *channel* 0))
       ((string=? command "cat /proc/loadavg")
        (message-reply-success message)
        (write-line "0.01 0.05 0.10 4/1927 242011" *channel*)
        (channel-request-send-exit-status *channel* 0)
        (channel-send-eof *channel*))
       ((string=? command "which guile > /dev/null && guile --version")
        (write-line %guile-version-string *channel*)
        (message-reply-success message)
        (channel-request-send-exit-status *channel* 0)
        (catch #t
          (lambda ()
            (channel-send-eof *channel*))
          (lambda args
            (format-log/scm 'nolog "start-server/exec" "ERROR: ~a" args))))

       ;; "pgrep"
       ((string-match "pgrep.*process-1.*" command)
        (format-log/scm 'nolog "start-server/exec" "pgrep command: ~a" command)
        (write-line 12345 *channel*)
        (message-reply-success message)
        (channel-request-send-exit-status *channel* 0)
        (channel-send-eof *channel*))

       ((or (string=? command "'guile -q'") (string=? command "'guile' '-q'"))
        (message-reply-success message)
        (display %guile-version-string *channel*)
        (body session message *channel*))
       (else
        (message-reply-success message)
        (write-line command *channel*)
        (channel-request-send-exit-status *channel* 0)
        (catch #t
          (lambda ()
            (channel-send-eof *channel*))
          (lambda args
            (format-log/scm 'nolog "start-server/exec" "ERROR: ~a" args)))))))

  (define (state:handle-tcpip-forward message)
    (let* ((proc (lambda (session message user-data)
                   (let ((type (message-get-type message))
                         (req  (message-get-req  message)))
                     (format (current-error-port) "global req: type: ~a~%"
                             type)
                     (case (cadr type)
                       ((global-request-tcpip-forward)
                        (let ((pnum (global-req:port req)))
                          (format (current-error-port) "global req: port: ~a~%"
                                  pnum)
                          (message-reply-success message
                                                 pnum)))
                       ((global-request-cancel-tcpip-forward)
                        (message-reply-success message 1))))))
           (callbacks `((user-data               . #f)
                        (global-request-callback . ,proc))))
      (session-set! (message-get-session message) 'callbacks callbacks)
      (message-reply-success message 1)))

  (define (state:process-message message)
    (format-log/scm 'nolog "start-server/exec"
                    "message: ~a" message)
    (let ((message-type (message-get-type message)))
      (format-log/scm 'nolog "start-server/exec"
                      "message-type: ~a" message-type)
      (case (car message-type)
        ((request-channel-open)
         (set! *channel* (message-channel-request-open-reply-accept message))
         (case (cadr message-type)
           ((channel-direct-tcpip)
            (write-line (read-line *channel*) *channel*))))
        ((request-channel)
         (state:message-handle-request-channel message message-type))
        ((request-global)
         (state:handle-tcpip-forward message))
        (else
         (message-reply-success message)))))

  (define (state:message-handle-request-channel message message-type)
    (let ((subtype (cadr message-type)))
      (format-log/scm 'nolog "start-server/exec"
                      "message-subtype: ~a" subtype)
      (case subtype
        ((channel-request-exec)
         (state:message-handle-exec message (message-get-session message)))
        (else
         (message-reply-success message)))))

  (define (state:init)
    (start-server-loop server
      (lambda (session)
        (format-log/scm 'nolog "start-server/exec"
                        "session: ~a" session)
        (start-session-loop session state:process-message))))

  (state:init))

(define (start-server/dist-test server)
  (server-listen server)
  (let ((session (server-accept server)))

    (server-handle-key-exchange session)

    (let* ((proc (lambda (session message user-data)
                   (let ((type (message-get-type message))
                         (req  (message-get-req  message)))
                     (format (current-error-port) "global req: type: ~a~%"
                             type)
                     (case (cadr type)
                       ((global-request-tcpip-forward)
                        (let ((pnum (global-req:port req)))
                          (format (current-error-port) "global req: port: ~a~%"
                                  pnum)
                          (message-reply-success message
                                                 pnum)))
                       ((global-request-cancel-tcpip-forward)
                        (message-reply-success message 1))))))
           (callbacks `((user-data               . #f)
                        (global-request-callback . ,proc))))
      (session-set! session 'callbacks callbacks))

    (start-session-loop session
                        (lambda (msg type)
                          (message-reply-success msg)))))


;;; Tests

(define (multifork . procs)
  "Execute each procedure from PROCS list in a separate process.  The last
procedure from PROCS is executed in the main process; return the result of the
main procedure."
  (format-log/scm 'nolog "multifork" "procs 1: ~a~%" procs)
  (let* ((len      (length procs))
         (mainproc (car (list-tail procs (- len 1))))
         (procs    (list-head procs (- len 1)))
         (pids     (map (lambda (proc)
                          (let ((pid (primitive-fork)))
                            (if (zero? pid)
                                (dynamic-wind
                                  (lambda ()
                                    (format-log/scm 'nolog
                                                    "multifork"
                                                    "Running proc ...~%"))
                                  proc
                                  (lambda ()
                                    ;; This handler makes sure the child
                                    ;; process exits when PROC exit, be it a
                                    ;; non-local exit or a normal return.
                                    (format-log/scm 'nolog "multifork"
                                                    "Exiting ...~%")
                                    (primitive-exit 0)))
                                (begin
                                  (format-log/scm 'nolog "multifork" "PID: ~a~%" pid)
                                  pid))))
                        procs)))
    (format-log/scm 'nolog "multifork" "mainproc: ~a~%" mainproc)
    (format-log/scm 'nolog "multifork" "PIDs: ~a~%" pids)
    (dynamic-wind
      (const #f)
      (lambda () (mainproc pids))
      (lambda ()
        (format-log/scm 'nolog "multifork" "killing spawned processes ~a ...~%" pids)
        (catch #t
          (lambda () (for-each (cut kill <> SIGTERM) pids))
          (lambda args
            (format-log/scm 'nolog "multifork"
                            "ERROR: Could not kill process ~a: ~a~%" pids args)))
        (format-log/scm 'nolog "multifork" "waiting for processes status ~a ...~%" pids)
        (catch #t
          (lambda () (for-each waitpid pids))
          (lambda args
            (format-log/scm 'nolog "multifork"
                            "ERROR: Could not wait for PIDS ~a: ~a" pids args)))))))


;;   "Run a SERVER-PROC in newly created process.  The server passed to a
;; SERVER-PROC as an argument.  CLIENT-PROC is expected to be a thunk that should
;; be executed in the parent process.  The procedure returns a result of
;; CLIENT-PROC call."
(define-syntax-rule (run-client-test server-proc client-proc)
  (let ((test-suite-name (car (test-runner-group-stack (test-runner-current))))
        (test-name (test-runner-test-name (test-runner-current))))
    (format-log/scm 'nolog "run-client-test" "Making a server ...")
    (let ((port (get-unused-port)))
      (set-port! port)
      (format-log/scm 'nolog "run-client-test" "Spawning processes ...")
      (multifork
       ;; server
       (lambda ()
         (execle %guile
                 (environ)
                 %guile
                 "-L" (format #f "~a/" %topdir)
                 "-L" (format #f "~a/modules/" %topdir)
                 "-e" "main"
                 "-s" (format #f "~a/tests/common/test-server.scm" %topdir)
                 test-suite-name
                 test-name
                 (number->string port)
                 (format #f "~S" (quote server-proc)))
         (format-log/scm 'nolog "run-client-test" "Could not spawn process!")
         (exit 1))
       ;; client
       (lambda (pids)
         (format-log/scm 'nolog "run-client-test"
                         "PIDs: ~a" pids)
         ;; Wait for synchronization.
         (let ((run-file (format #f
                                 "~a/~a-server.run"
                                 test-suite-name
                                 (sanitize-string test-name))))
           (let loop ((tries 100))
             (if (zero? tries)
                 (begin
                   (format-log/scm 'nolog "run-client-test"
                                   "Client process failed: ~a"
                                   (car pids))
                   (exit 1))
                 (unless (file-exists? run-file)
                   (format-log/scm 'nolog
                                   "run-client-test"
                                   "wait: ~a ..."
                                   tries)
                   (usleep (round (/ 1000000 tries)))
                   (loop (- tries 1)))))
           (delete-file run-file))

         (client-proc))))))


(define (run-server-test client-proc server-proc)
  "Run a CLIENT-PROC in newly created process.  A session is passed to a
CLIENT-PROC as an argument.  SERVER-PROC is called with a server as an
argument.  The procedure returns a result of SERVER-PROC call."
  (let ((server  (make-server-for-test))
        (session (make-session-for-test)))
    (multifork
     ;; server
     (lambda ()
       (dynamic-wind
         (const #f)
         (lambda ()
           (client-proc session))
         (lambda ()
           (primitive-exit 1))))
     ;; client
     (lambda (pids)
       (server-proc server)))))


;;; Logging

(define (make-libssh-log-printer log-file)
  "Make a libssh log printer with output to a LOG-FILE.  Return the log
printer."
  (let ((p (open-output-file log-file)))
    (lambda (priority function message userdata)
      (format p "[~a, \"~a\", ~a]: ~a~%"
              (strftime "%Y-%m-%dT%H:%M:%S%z" (localtime (current-time)))
              userdata
              priority
              message))))

(define (setup-libssh-logging! log-file)
  "Setup libssh logging for a test suite with output to a LOG-FILE."
  (let ((log-printer (make-libssh-log-printer log-file)))
    (set-logging-callback! log-printer)))

(define (setup-error-logging! log-file)
  "Setup error logging for a test suite with output to a LOG-FILE."
  (set-current-error-port (open-output-file log-file)))

(define (setup-test-suite-logging! test-name)
  "Setup error logging for a TEST-SUITE."
  (let ((libssh-log-file (string-append test-name "/0-libssh.log"))
        (errors-log-file (string-append test-name "/0-errors.log")))
    (unless (file-exists? test-name)
      (mkdir test-name))
    (setup-libssh-logging! libssh-log-file)
    (setup-error-logging! errors-log-file)))

(define (setup-test-logging! test-name)
  (let* ((test-suite-name (car (test-runner-group-stack (test-runner-current))))
         (libssh-log-file (format #f
                                  "~a/~a-libssh.log"
                                  test-suite-name
                                  (sanitize-string test-name)))
        (errors-log-file (format #f
                                 "~a/~a-errors.log"
                                 test-suite-name
                                 (sanitize-string test-name))))

    (unless (file-exists? test-suite-name)
      (mkdir test-suite-name))

    (setup-libssh-logging! libssh-log-file)
    (setup-error-logging! errors-log-file)))

(define (test-begin-with-log test-name)
  (set-log-verbosity! 'functions)
  (setup-test-suite-logging! test-name)
  (test-begin test-name))


;;; common.scm ends here