2016-11-16 10:34:17 -05:00
|
|
|
;;; GNU Guix --- Functional package management for GNU
|
2023-05-17 06:00:36 -04:00
|
|
|
;;; Copyright © 2014-2017, 2019, 2023 Ludovic Courtès <ludo@gnu.org>
|
2021-02-20 16:04:59 -05:00
|
|
|
;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be>
|
2016-11-16 10:34:17 -05:00
|
|
|
;;;
|
|
|
|
;;; This file is part of GNU Guix.
|
|
|
|
;;;
|
|
|
|
;;; GNU Guix 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.
|
|
|
|
;;;
|
|
|
|
;;; GNU Guix 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 GNU Guix. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
(define-module (guix tests http)
|
|
|
|
#:use-module (ice-9 threads)
|
|
|
|
#:use-module (web server)
|
|
|
|
#:use-module (web server http)
|
2023-05-17 06:00:36 -04:00
|
|
|
#:use-module (web request)
|
2016-11-16 10:34:17 -05:00
|
|
|
#:use-module (web response)
|
2023-05-17 06:00:36 -04:00
|
|
|
#:use-module (web uri)
|
|
|
|
#:use-module (srfi srfi-1)
|
2021-02-20 16:04:59 -05:00
|
|
|
#:use-module (srfi srfi-11)
|
tests: 'with-http-server' accepts multiple responses.
* guix/tests/http.scm (call-with-http-server): Replace 'code' and 'data'
parameters with 'responses+data'. Compute RESPONSES as a function of
that. Remove #:headers parameter.
[http-write]: Quit only when RESPONSES is empty.
[server-body]: Get the response and data from RESPONSES, and set it to
point to the rest.
(with-http-server): Adjust accordingly.
* tests/derivations.scm ("'download' built-in builder")
("'download' built-in builder, invalid hash")
("'download' built-in builder, not found")
("'download' built-in builder, check mode"): Adjust to new
'with-http-server' interface.
* tests/lint.scm ("home-page: 200")
("home-page: 200 but short length")
("home-page: 404", "home-page: 301, invalid"):
("home-page: 301 -> 200", "home-page: 301 -> 404")
("source: 200", "source: 200 but short length")
("source: 404", "source: 404 and 200")
("source: 301 -> 200", "source: 301 -> 404"):
("github-url", github-url): Likewise.
* tests/swh.scm (with-json-result)
("lookup-origin, not found"): Likewise.
2019-08-29 10:01:32 -04:00
|
|
|
#:use-module (ice-9 match)
|
2016-11-16 10:34:17 -05:00
|
|
|
#:export (with-http-server
|
|
|
|
call-with-http-server
|
|
|
|
%http-server-port
|
|
|
|
%local-url))
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
;;;
|
|
|
|
;;; Code to spawn a Web server for testing purposes.
|
|
|
|
;;;
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
|
(define %http-server-port
|
|
|
|
;; TCP port to use for the stub HTTP server.
|
2021-02-20 16:04:59 -05:00
|
|
|
;; If 0, the OS will automatically choose
|
|
|
|
;; a port.
|
|
|
|
(make-parameter 0))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
2017-10-12 17:19:09 -04:00
|
|
|
(define (open-http-server-socket)
|
2021-02-20 16:04:59 -05:00
|
|
|
"Return a listening socket for the web server and the port
|
|
|
|
actually listened at (in case %http-server-port was 0)."
|
2017-10-12 17:19:09 -04:00
|
|
|
(catch 'system-error
|
|
|
|
(lambda ()
|
|
|
|
(let ((sock (socket PF_INET SOCK_STREAM 0)))
|
|
|
|
(setsockopt sock SOL_SOCKET SO_REUSEADDR 1)
|
|
|
|
(bind sock
|
|
|
|
(make-socket-address AF_INET INADDR_LOOPBACK
|
|
|
|
(%http-server-port)))
|
2021-02-20 16:04:59 -05:00
|
|
|
(values sock
|
|
|
|
(sockaddr:port (getsockname sock)))))
|
2017-10-12 17:19:09 -04:00
|
|
|
(lambda args
|
|
|
|
(let ((err (system-error-errno args)))
|
|
|
|
(format (current-error-port)
|
|
|
|
"warning: cannot run Web server for tests: ~a~%"
|
|
|
|
(strerror err))
|
2021-02-20 16:04:59 -05:00
|
|
|
(values #f #f)))))
|
2017-10-12 17:19:09 -04:00
|
|
|
|
2023-05-17 06:00:36 -04:00
|
|
|
(define* (%local-url #:optional (port (%http-server-port))
|
|
|
|
#:key (path "/foo/bar"))
|
2021-02-20 16:04:59 -05:00
|
|
|
(when (= port 0)
|
|
|
|
(error "no web server is running!"))
|
2016-11-16 10:34:17 -05:00
|
|
|
;; URL to use for 'home-page' tests.
|
2019-12-07 09:10:39 -05:00
|
|
|
(string-append "http://localhost:" (number->string port)
|
2023-05-17 06:00:36 -04:00
|
|
|
path))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
tests: 'with-http-server' accepts multiple responses.
* guix/tests/http.scm (call-with-http-server): Replace 'code' and 'data'
parameters with 'responses+data'. Compute RESPONSES as a function of
that. Remove #:headers parameter.
[http-write]: Quit only when RESPONSES is empty.
[server-body]: Get the response and data from RESPONSES, and set it to
point to the rest.
(with-http-server): Adjust accordingly.
* tests/derivations.scm ("'download' built-in builder")
("'download' built-in builder, invalid hash")
("'download' built-in builder, not found")
("'download' built-in builder, check mode"): Adjust to new
'with-http-server' interface.
* tests/lint.scm ("home-page: 200")
("home-page: 200 but short length")
("home-page: 404", "home-page: 301, invalid"):
("home-page: 301 -> 200", "home-page: 301 -> 404")
("source: 200", "source: 200 but short length")
("source: 404", "source: 404 and 200")
("source: 301 -> 200", "source: 301 -> 404"):
("github-url", github-url): Likewise.
* tests/swh.scm (with-json-result)
("lookup-origin, not found"): Likewise.
2019-08-29 10:01:32 -04:00
|
|
|
(define* (call-with-http-server responses+data thunk)
|
|
|
|
"Call THUNK with an HTTP server running and returning RESPONSES+DATA on HTTP
|
2019-12-07 09:10:39 -05:00
|
|
|
requests. Each element of RESPONSES+DATA must be a tuple containing a
|
2021-02-20 16:04:59 -05:00
|
|
|
response and a string, or an HTTP response code and a string.
|
|
|
|
|
|
|
|
%http-server-port will be set to the port listened at
|
|
|
|
The port listened at will be set for the dynamic extent of THUNK."
|
tests: 'with-http-server' accepts multiple responses.
* guix/tests/http.scm (call-with-http-server): Replace 'code' and 'data'
parameters with 'responses+data'. Compute RESPONSES as a function of
that. Remove #:headers parameter.
[http-write]: Quit only when RESPONSES is empty.
[server-body]: Get the response and data from RESPONSES, and set it to
point to the rest.
(with-http-server): Adjust accordingly.
* tests/derivations.scm ("'download' built-in builder")
("'download' built-in builder, invalid hash")
("'download' built-in builder, not found")
("'download' built-in builder, check mode"): Adjust to new
'with-http-server' interface.
* tests/lint.scm ("home-page: 200")
("home-page: 200 but short length")
("home-page: 404", "home-page: 301, invalid"):
("home-page: 301 -> 200", "home-page: 301 -> 404")
("source: 200", "source: 200 but short length")
("source: 404", "source: 404 and 200")
("source: 301 -> 200", "source: 301 -> 404"):
("github-url", github-url): Likewise.
* tests/swh.scm (with-json-result)
("lookup-origin, not found"): Likewise.
2019-08-29 10:01:32 -04:00
|
|
|
(define responses
|
|
|
|
(map (match-lambda
|
|
|
|
(((? response? response) data)
|
|
|
|
(list response data))
|
|
|
|
(((? integer? code) data)
|
|
|
|
(list (build-response #:code code
|
|
|
|
#:reason-phrase "Such is life")
|
2023-05-17 06:00:36 -04:00
|
|
|
data))
|
|
|
|
(((? string? path) (? integer? code) data)
|
|
|
|
(list path
|
|
|
|
(build-response #:code code
|
|
|
|
#:headers
|
|
|
|
(if (string? data)
|
|
|
|
'()
|
|
|
|
'((content-type ;binary data
|
|
|
|
. (application/octet-stream
|
|
|
|
(charset
|
|
|
|
. "ISO-8859-1")))))
|
|
|
|
#:reason-phrase "Such is life")
|
tests: 'with-http-server' accepts multiple responses.
* guix/tests/http.scm (call-with-http-server): Replace 'code' and 'data'
parameters with 'responses+data'. Compute RESPONSES as a function of
that. Remove #:headers parameter.
[http-write]: Quit only when RESPONSES is empty.
[server-body]: Get the response and data from RESPONSES, and set it to
point to the rest.
(with-http-server): Adjust accordingly.
* tests/derivations.scm ("'download' built-in builder")
("'download' built-in builder, invalid hash")
("'download' built-in builder, not found")
("'download' built-in builder, check mode"): Adjust to new
'with-http-server' interface.
* tests/lint.scm ("home-page: 200")
("home-page: 200 but short length")
("home-page: 404", "home-page: 301, invalid"):
("home-page: 301 -> 200", "home-page: 301 -> 404")
("source: 200", "source: 200 but short length")
("source: 404", "source: 404 and 200")
("source: 301 -> 200", "source: 301 -> 404"):
("github-url", github-url): Likewise.
* tests/swh.scm (with-json-result)
("lookup-origin, not found"): Likewise.
2019-08-29 10:01:32 -04:00
|
|
|
data)))
|
|
|
|
responses+data))
|
|
|
|
|
2017-10-12 17:19:09 -04:00
|
|
|
(define (http-write server client response body)
|
|
|
|
"Write RESPONSE."
|
|
|
|
(let* ((response (write-response response client))
|
|
|
|
(port (response-port response)))
|
|
|
|
(cond
|
|
|
|
((not body)) ;pass
|
|
|
|
(else
|
|
|
|
(write-response-body response body)))
|
|
|
|
(close-port port)
|
tests: 'with-http-server' accepts multiple responses.
* guix/tests/http.scm (call-with-http-server): Replace 'code' and 'data'
parameters with 'responses+data'. Compute RESPONSES as a function of
that. Remove #:headers parameter.
[http-write]: Quit only when RESPONSES is empty.
[server-body]: Get the response and data from RESPONSES, and set it to
point to the rest.
(with-http-server): Adjust accordingly.
* tests/derivations.scm ("'download' built-in builder")
("'download' built-in builder, invalid hash")
("'download' built-in builder, not found")
("'download' built-in builder, check mode"): Adjust to new
'with-http-server' interface.
* tests/lint.scm ("home-page: 200")
("home-page: 200 but short length")
("home-page: 404", "home-page: 301, invalid"):
("home-page: 301 -> 200", "home-page: 301 -> 404")
("source: 200", "source: 200 but short length")
("source: 404", "source: 404 and 200")
("source: 301 -> 200", "source: 301 -> 404"):
("github-url", github-url): Likewise.
* tests/swh.scm (with-json-result)
("lookup-origin, not found"): Likewise.
2019-08-29 10:01:32 -04:00
|
|
|
(when (null? responses)
|
|
|
|
(quit #t)) ;exit the server thread
|
2017-10-12 17:19:09 -04:00
|
|
|
(values)))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
2017-10-12 17:19:09 -04:00
|
|
|
;; Mutex and condition variable to synchronize with the HTTP server.
|
|
|
|
(define %http-server-lock (make-mutex))
|
|
|
|
(define %http-server-ready (make-condition-variable))
|
2021-02-20 16:04:59 -05:00
|
|
|
(define %http-real-server-port #f)
|
2016-11-16 10:34:17 -05:00
|
|
|
|
2017-10-12 17:19:09 -04:00
|
|
|
(define (http-open . args)
|
|
|
|
"Start listening for HTTP requests and signal %HTTP-SERVER-READY."
|
|
|
|
(with-mutex %http-server-lock
|
|
|
|
(let ((result (apply (@@ (web server http) http-open) args)))
|
|
|
|
(signal-condition-variable %http-server-ready)
|
|
|
|
result)))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
2017-10-12 17:19:09 -04:00
|
|
|
(define-server-impl stub-http-server
|
|
|
|
;; Stripped-down version of Guile's built-in HTTP server.
|
|
|
|
http-open
|
|
|
|
(@@ (web server http) http-read)
|
|
|
|
http-write
|
|
|
|
(@@ (web server http) http-close))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
2023-05-17 06:00:36 -04:00
|
|
|
(define bad-request
|
|
|
|
(build-response #:code 400 #:reason-phrase "Unexpected request"))
|
|
|
|
|
2016-11-16 10:34:17 -05:00
|
|
|
(define (server-body)
|
|
|
|
(define (handle request body)
|
tests: 'with-http-server' accepts multiple responses.
* guix/tests/http.scm (call-with-http-server): Replace 'code' and 'data'
parameters with 'responses+data'. Compute RESPONSES as a function of
that. Remove #:headers parameter.
[http-write]: Quit only when RESPONSES is empty.
[server-body]: Get the response and data from RESPONSES, and set it to
point to the rest.
(with-http-server): Adjust accordingly.
* tests/derivations.scm ("'download' built-in builder")
("'download' built-in builder, invalid hash")
("'download' built-in builder, not found")
("'download' built-in builder, check mode"): Adjust to new
'with-http-server' interface.
* tests/lint.scm ("home-page: 200")
("home-page: 200 but short length")
("home-page: 404", "home-page: 301, invalid"):
("home-page: 301 -> 200", "home-page: 301 -> 404")
("source: 200", "source: 200 but short length")
("source: 404", "source: 404 and 200")
("source: 301 -> 200", "source: 301 -> 404"):
("github-url", github-url): Likewise.
* tests/swh.scm (with-json-result)
("lookup-origin, not found"): Likewise.
2019-08-29 10:01:32 -04:00
|
|
|
(match responses
|
|
|
|
(((response data) rest ...)
|
|
|
|
(set! responses rest)
|
2023-05-17 06:00:36 -04:00
|
|
|
(values response data))
|
|
|
|
((((? string?) response data) ...)
|
|
|
|
(let ((path (uri-path (request-uri request))))
|
|
|
|
(match (assoc path responses)
|
|
|
|
(#f (values bad-request ""))
|
|
|
|
((_ response data)
|
|
|
|
(if (eq? 'GET (request-method request))
|
|
|
|
;; Note: Use 'assoc-remove!' to remove only the first entry
|
|
|
|
;; with PATH as its key. That way, RESPONSES can contain
|
|
|
|
;; the same path several times.
|
|
|
|
(let ((rest (assoc-remove! responses path)))
|
|
|
|
(set! responses rest)
|
|
|
|
(values response data))
|
|
|
|
(values bad-request ""))))))))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
2021-02-20 16:04:59 -05:00
|
|
|
(let-values (((socket port) (open-http-server-socket)))
|
|
|
|
(set! %http-real-server-port port)
|
2017-10-12 17:19:09 -04:00
|
|
|
(catch 'quit
|
|
|
|
(lambda ()
|
2023-05-17 06:00:36 -04:00
|
|
|
;; Let HANDLE refer to '%http-server-port' if needed.
|
|
|
|
(parameterize ((%http-server-port %http-real-server-port))
|
|
|
|
(run-server handle stub-http-server
|
|
|
|
`(#:socket ,socket))))
|
2017-10-12 17:19:09 -04:00
|
|
|
(lambda _
|
|
|
|
(close-port socket)))))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
|
|
|
(with-mutex %http-server-lock
|
|
|
|
(let ((server (make-thread server-body)))
|
|
|
|
(wait-condition-variable %http-server-ready %http-server-lock)
|
|
|
|
;; Normally SERVER exits automatically once it has received a request.
|
2021-02-20 16:04:59 -05:00
|
|
|
(parameterize ((%http-server-port %http-real-server-port))
|
|
|
|
(thunk)))))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
2017-10-12 17:19:09 -04:00
|
|
|
(define-syntax with-http-server
|
|
|
|
(syntax-rules ()
|
tests: 'with-http-server' accepts multiple responses.
* guix/tests/http.scm (call-with-http-server): Replace 'code' and 'data'
parameters with 'responses+data'. Compute RESPONSES as a function of
that. Remove #:headers parameter.
[http-write]: Quit only when RESPONSES is empty.
[server-body]: Get the response and data from RESPONSES, and set it to
point to the rest.
(with-http-server): Adjust accordingly.
* tests/derivations.scm ("'download' built-in builder")
("'download' built-in builder, invalid hash")
("'download' built-in builder, not found")
("'download' built-in builder, check mode"): Adjust to new
'with-http-server' interface.
* tests/lint.scm ("home-page: 200")
("home-page: 200 but short length")
("home-page: 404", "home-page: 301, invalid"):
("home-page: 301 -> 200", "home-page: 301 -> 404")
("source: 200", "source: 200 but short length")
("source: 404", "source: 404 and 200")
("source: 301 -> 200", "source: 301 -> 404"):
("github-url", github-url): Likewise.
* tests/swh.scm (with-json-result)
("lookup-origin, not found"): Likewise.
2019-08-29 10:01:32 -04:00
|
|
|
((_ responses+data body ...)
|
|
|
|
(call-with-http-server responses+data (lambda () body ...)))))
|
2016-11-16 10:34:17 -05:00
|
|
|
|
|
|
|
;;; http.scm ends here
|