Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
1908 lines (1795 sloc) 66.4 KB
;;; elnode-tests.el --- tests for Elnode -*- lexical-binding: t -*-
;;; Code:
(require 'elnode-testsupport)
(require 'elnode-wiki)
(require 'elnode-proxy)
(require 'kv)
(require 'mail-parse)
(require 'noflet)
(require 'rx)
(ert-deftest elnode/case ()
"Show that elnode/case works."
(should
(equal
'(10 "blah")
(list
(let ((v 1))
(elnode/case v
(1 10)
(t 11)))
;; Shows the else case
(let ((v 2))
(elnode/case v
(1 10)
(t "blah")))))))
(ert-deftest elnode--posq ()
(equal
(list
(elnode--posq 10 '(1 2 3 4 5 10 20 70))
(elnode--posq 2 '(1 2 3 4 5 10 20 70))
(elnode--posq 100 '(1 2 3 4 5 10 20 70)))
'(5 1 nil)))
(ert-deftest elnode-msg ()
(should
(equal
(list
;; Checks we get a status
(let ((elnode--do-error-logging :status))
(let (received)
(noflet ((elnode-log-buffer-log (text buf &optional filename)
(setq received text)))
(elnode-msg :status "hello")
received)))
;; Checks we don't
(let ((elnode--do-error-logging :warning))
(let (received)
(noflet ((elnode-log-buffer-log (text buf &optional filename)
(setq received text)))
(elnode-msg :status "hello")
received)))
;; And now without a level set
(let ((elnode--do-error-logging nil))
(let (received)
(noflet ((elnode-log-buffer-log (text buf &optional filename)
(setq received text)))
(elnode-msg :status "hello")
received))))
'("hello" nil nil))))
(ert-deftest elnode-join ()
"Test the path joining."
(should
(equal "/la/la/file"
(elnode-join "/la" "la" "file")))
(should
(equal "/la/la/file/"
(elnode-join "/la" "la" "file/")))
(should
(equal "/la/la/file/"
(elnode-join "/la" "la/file/" ""))))
(ert-deftest elnode-url-encode-path ()
"Test the path encoding."
(should
(equal
"/path/the%20path"
(elnode-url-encode-path "/path/the path")))
(should
(equal
"/path/the%20path/"
(elnode-url-encode-path "/path/the path/")))
(should
(equal
"/path/the%20%27path%27"
(elnode-url-encode-path "/path/the 'path'"))))
(defun elnode--log-buffer-read-text (buffer)
"Turn the buffer into a list of text.
Strips off the date format from each text line. Primarily this
is just a test helper."
(let* ((log-line-regex "[0-9]\\{14\\}: \\(.*\\)")
(lines
(split-string
(with-current-buffer buffer
(buffer-substring (point-min) (point-max)))
"\n")))
(loop for line in lines
if (string-match log-line-regex line)
collect (match-string 1 line))))
(ert-deftest elnode-log-buffer-log ()
"Test the log buffer stuff."
(noflet ((read-log (&optional buffer)
(with-current-buffer (or buffer (current-buffer))
(->> (split-string (buffer-string) "\n")
(-filter (lambda (s) (> (length s) 0)))
(-map
(lambda (str)
(string-match "^[^ ]+ \\(.*\\)" str)
(match-string 1 str)))))))
(let ((tf (make-temp-file "logbufferlog")))
(with-temp-buffer
(elnode-log-buffer-log "test it" (current-buffer) tf)
(should
(equal
(marker-position elnode-log-buffer-position-written)
(point-max)))
(elnode-log-buffer-log "test again" (current-buffer) tf)
(should
(equal '("test it" "test again")
(read-log))))
;; Test that we can read it back from the file.
(let* ((log-buf (find-file-noselect tf)))
(should
(equal
'("test it" "test again")
(read-log log-buf)))))))
(ert-deftest elnode-log-buffer-log-truncates ()
"Test the log buffer gets truncated stuff."
(let ((log-line-regex "[0-9]\\{14\\}: \\(.*\\)")
(tf (make-temp-file "logbufferlog"))
(elnode-log-buffer-max-size 8))
(with-temp-buffer
(elnode-log-buffer-log "test it" (current-buffer) tf)
(elnode-log-buffer-log "test again" (current-buffer) tf)
(elnode-log-buffer-log "test three" (current-buffer) tf)
(elnode-log-buffer-log "test four" (current-buffer) tf)
(elnode-log-buffer-log "test five" (current-buffer) tf)
(elnode-log-buffer-log "test six" (current-buffer) tf)
(elnode-log-buffer-log "test seven" (current-buffer) tf)
(elnode-log-buffer-log "test eight" (current-buffer) tf)
(elnode-log-buffer-log "test nine" (current-buffer) tf)
(elnode-log-buffer-log "test ten" (current-buffer) tf)
(should
(equal
8
(length
(loop for i in
(split-string
(buffer-substring
(point-min)
(point-max))
"\n")
if (not (equal i ""))
collect i)))))))
(ert-deftest elnode-test-logs-dont-log ()
"Test the logs don't log when we turn stuff off."
(let ((elnode-log-files-directory nil))
;; FIXME this is not a test. duh.
(elnode-error "test message!")))
(ert-deftest elnode-test-error-log ()
(let ((err-message "whoops!! something went wrong! %s" )
(err-include "some included value"))
(with-temp-buffer
(let ((test-log-buf (current-buffer)))
;; Setup a fake server log buffer
(noflet ((elnode--get-error-log-buffer ()
test-log-buf))
(elnode-error err-message err-include))
;; Assert the message sent to the log buffer is correctly formatted.
(should (string-match
(format
"^.*: %s\n$"
(apply 'format `(,err-message ,@(list err-include))))
(buffer-substring (point-min) (point-max))))))))
(ert-deftest elnode-test-error-log-list ()
(let ((err-message "whoops!! something went wrong! %s %s")
(err-include '("included value 1" "included value 2")))
(with-temp-buffer
(let ((test-log-buf (current-buffer)))
;; Setup a fake server log buffer
(noflet ((elnode--get-error-log-buffer ()
test-log-buf))
(elnode-error
err-message
"included value 1" "included value 2"))
;; Assert the message sent to the log buffer is correctly formatted.
(should (string-match
(format
"^.*: %s\n$"
(apply 'format `(,err-message ,@err-include)))
(buffer-substring (point-min) (point-max))))))))
(ert-deftest elnode-test-access-log ()
"Test the access logging."
(elnode-mock-con :httpcon
((:buffer
(elnode--http-make-hdr
'get "/"
'(host . "localhost")
'(user-agent . "test-agent")))
(:elnode-httpresponse-status 200)
(:elnode-bytes-written 2048))
(elnode/con-put :httpcon
:elnode-http-started (current-time)
:elnode-httpresponse-status 200
:elnode-bytes-written 2048)
(should
(equal
'done
(catch 'elnode-parse-http (elnode--http-parse :httpcon))))
(let* ((logname "ert-test")
(buffername (format "*%s-elnode-access*" logname))
(log-rx (rx
(and line-start
;; year - month - day
(= 4 (any "0-9")) "-" (= 2 (any "0-9")) "-" (= 2 (any "0-9")) "-"
;; hours - minutes - seconds
(= 2 (any "0-9")) ":" (= 2 (any "0-9")) ":" (= 2 (any "0-9")) ":"
(1+ " ") "200" ; status code
(1+ " ") "2048" ; size
(1+ " ") "GET" ; method
(1+ " ") "/" ; path
line-end))))
(noflet ((elnode--log-filename (log-name) (make-temp-file "elnode-access")))
(unwind-protect
(progn
(elnode-log-access logname :httpcon)
(should
(string-match
log-rx
(with-current-buffer buffername
(s-trim-right (buffer-string))))))
(kill-buffer buffername))))))
(ert-deftest elnode-deferring ()
"Testing the defer setup."
(let* ((result :not-done)
(handler (lambda (httpcon)
(message "here!")
(setq result :done)))
(elnode--deferred (list)))
(with-elnode-mock-con :httpcon
;; The queue starts empty
(should (equal 0 (length elnode--deferred)))
;; Then we add to it...
(elnode--deferred-add :httpcon handler)
(should (equal 1 (length elnode--deferred)))
;; Then we process it...
(noflet ((process-status (proc) 'open))
(elnode--deferred-processor))
;; ... that should have emptied it out...
(should (eq result :done))
(should (equal 0 (length elnode--deferred)))
;; Now we add a handler that defers...
(elnode--deferred-add :httpcon
(lambda (httpcon)
(elnode-defer-now handler)))
(should (equal 1 (length elnode--deferred)))
;; Now we process...
(noflet ((process-status (proc) 'open))
(elnode--deferred-processor))
;; ... should still have the deferred handler in it...
(should (equal 1 (length elnode--deferred)))
;; ... process again ...
(noflet ((process-status (proc) 'open))
(elnode--deferred-processor))
(should (equal 0 (length elnode--deferred))))))
(ert-deftest elnode--http-parse-status-line-rx ()
"Prove different status lines."
(assert (string-match-p elnode--http-status-line-rx "GET / HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "POST / HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "POST /abc HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "DELETE /abc HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "PUT /abc HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/09283 HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/09283?abc HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/09283?abc=1234 HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc?abc=123 HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/?abc=123 HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/09283?x=1 HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/09283?x=1&a=1 HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/09283;def HTTP/1.1"))
(assert (string-match-p elnode--http-status-line-rx "GET /abc/09283;def?a=1 HTTP/1.1")))
(ert-deftest elnode--http-parse-header ()
"Pass an HTTP header."
(let ((content "some content"))
(with-temp-buffer
(insert
(format "POST /blah HTTP/1.1\r
Content-type: application/form-www-data\r
Content-length: %s\r
User-Agent: ert-test\r
X-test-Header: somevalue\r
\r
%s" (length content) content))
(destructuring-bind (status header-alist)
(save-excursion
(goto-char (point-min))
(elnode--http-parse-header (current-buffer) (point-min)))
(should
(equal
(kva "content-type" header-alist)
"application/form-www-data"))
(should (equal "POST /blah HTTP/1.1" status))))))
(ert-deftest elnode--http-parse-header-non-main ()
"Pass a non-main HTTP header, eg: multipart."
(let ((content "some content"))
(with-temp-buffer
(insert
(format "POST /blah HTTP/1.1\r
Content-length: %s\r
User-Agent: ert-test\r
X-test-Header: somevalue\r
Content-Type: multipart/form-data; boundary=----------------------------96a411d2bf2a\r
\r
------------------------------96a411d2bf2a\r
Content-Disposition: form-data; name=\"file\"; filename=\"chat.css\"\r
Content-Type: application/octet-stream\r
\r
%s
----------------------------96a411d2bf2a--\r" (length content) content))
(save-excursion
(goto-char (point-min))
(elnode--http-parse-header (current-buffer) (point-min))
(destructuring-bind (status header-alist)
(elnode--http-parse-header (current-buffer) (point) t)
(should
(equal
(kva "content-type" header-alist)
"application/octet-stream"))
(should
(equal
status
"------------------------------96a411d2bf2a")))))))
(ert-deftest elnode--make-http-hdr ()
"Test the construction of headers"
(should
(equal
(elnode--http-make-hdr
'get "/"
'(host . "host1")
'(user-agent . "test-agent"))
"GET / HTTP/1.1\r
Host: host1\r
User-Agent: test-agent\r
\r
"))
(should
(equal
(elnode--http-make-hdr
'get "/"
'(host . "host2")
'(user-agent . "test-agent")
'(body . "my test data"))
"GET / HTTP/1.1\r
Host: host2\r
User-Agent: test-agent\r
\r
my test data")))
(ert-deftest elnode--http-parse-header-complete ()
"Test the HTTP parsing."
(elnode-mock-con :httpcon
((:buffer
(elnode--http-make-hdr
'get "/"
'(host . "localhost")
'(user-agent . "test-agent"))))
;; Parse the header
(should
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))
;; Now check the side effects
(should
(equal
(elnode/con-get :httpcon :elnode-http-header)
'(("host" . "localhost")
("user-agent" . "test-agent"))))))
(ert-deftest elnode--http-parse-header-incomplete ()
"Test the HTTP parsing of an incomplete header.
An HTTP request with an incomplete header is setup and tested,
then we finish the request (fill out the header) and then test
again."
(elnode-mock-con :httpcon
((:buffer
"GET / HTTP/1.1\r\nHost: localh"))
;; Now parse
(should
;; It fails with incomplete 'header signal
(equal 'header
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))
;; Now put the rest of the header in the buffer
(with-current-buffer (process-buffer :httpcon)
(goto-char (point-max))
(insert "ost\r\n\r\n"))
(should
;; Now it succeeds with the 'done signal
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))))
(ert-deftest elnode--http-parse-header-incomplete-lcase-host-keyword ()
"Test the HTTP parsing of an incomplete header.
An HTTP request with an incomplete header and the keyword host
spelt with a leading lowercase h is setup and tested,
then we finish the request (fill out the header) and then test
again."
(elnode-mock-con :httpcon
((:buffer
"GET / HTTP/1.1\r\nhost: localh"))
;; Now parse
(should
;; It fails with incomplete 'header signal
(equal 'header
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))
;; Now put the rest of the header in the buffer
(with-current-buffer (process-buffer :httpcon)
(goto-char (point-max))
(insert "ost\r\n\r\n"))
(should
;; Now it succeeds with the 'done signal
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))))
(ert-deftest elnode--http-parse-body-incomplete ()
"Tests the HTTP parsing of an incomplete body.
An HTTP request with an incomplete body is setup and tested, then
we finish the request (fill out the content to content-length)
and then test again."
(let ((hdr
(elnode--http-make-hdr
'get "/"
'(host . "localhost")
'(user-agent . "test-agent")
`(content-length . ,(format "%d" (length "this is not finished")))
'(body . "this is not fin"))))
(fakir-mock-process :httpcon
((:buffer hdr))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
;; Now parse
(should
(equal 'content
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))
;; Now put the rest of the text in the buffer
(with-current-buffer (process-buffer :httpcon)
(goto-char (point-max))
(insert "ished"))
;; And test again
(should
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse :httpcon)))))))
(ert-deftest elnode-http-start ()
"Test starting a response.
Especially tests the mix of header setting techniques."
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode-http-header-set :httpcon "Content-Type" "text/html")
(elnode-http-header-set :httpcon "Accept" "application/javascript")
(elnode-http-start :httpcon 200 '("Content-Type" . "text/plain"))
;; Test that we have the correct text in the fake process buffer
(with-current-buffer (fakir-get-output-buffer)
(goto-char (point-min))
(should
(re-search-forward "^Content-Type: text/html\r\n" nil t))
(goto-char (point-min))
(should
(re-search-forward "^Accept: application/javascript\r\n" nil t)))))
(ert-deftest elnode--auth-entry->dispatch-table ()
"Test the construction of dispatch tables."
(let ((elnode--defined-authentication-schemes
(make-hash-table :test 'equal)))
(elnode-defauth :test-scheme1)
(let ((tbl (elnode--auth-entry->dispatch-table :test-scheme1)))
(should
(and
(equal (caar tbl) "^/login/$")
(functionp (cdr (car tbl))))))
(elnode-defauth :test-scheme2 :redirect "/testauth/")
(let ((tbl (elnode--auth-entry->dispatch-table :test-scheme2)))
(should
(and
(equal (caar tbl) "^/testauth/$")
(functionp (cdr (car tbl))))))))
(defun elnode-test-handler (httpcon)
"A simple handler for testing `elnode-test-call'.
The text spat out is tested, so is the status."
(elnode-http-start
httpcon 200
'("Content-Type" . "text/html")
'("User-Agent" . "elnode-test"))
(let ((params (elnode-http-params httpcon)))
(elnode-http-return
httpcon
(format
"<html><body><h1>Hello World</h1>%s</body></html>"
(if params
(format "<div>%S</div>" params)
"")))))
(ert-deftest elnode--dispatch-proc ()
"Test the dispatch mechanism."
;; Normal dispatch
(let (result)
(should
(equal
:login
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode--dispatch-proc
:httpcon "/login/"
'(("^/a/$" (lambda (httpcon) (setq result :ha0)))
("^/b/$" (lambda (httpcon) (setq result :ha1)))
("^/login/$" (lambda (httpcon) (setq result :login)))))))))
;; Providing an extra table to dispatch from auth
(let (result
(elnode--defined-authentication-schemes
(make-hash-table :test 'equal)))
(elnode-defauth :test-scheme1
:sender
(lambda (httpcon target redirect)
(setq result :login)))
(should
(equal
:login
(fakir-mock-process :httpcon
((:elnode-http-method "GET")
(:elnode-http-params '(("redirect" . "/a/"))))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-method "GET"
:elnode-http-params '(("redirect" . "/a/")))
(elnode--dispatch-proc
:httpcon
"/login/"
'(("^/a/$" (lambda (httpcon) (setq result :ha0)))
("^/b/$" (lambda (httpcon) (setq result :ha1))))
:extra-table (elnode--auth-entry->dispatch-table :test-scheme1)))))
;; ... as well as stuff in the main table
(should
(equal
:ha1
(fakir-mock-process :httpcon
((:elnode-http-method "GET")
(:elnode-http-params '(("redirect" . "/b/"))))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-method "GET"
:elnode-http-params '(("redirect" . "/b/")))
(elnode--dispatch-proc
:httpcon
"/b/"
'(("^/a/$" (lambda (httpcon) (setq result :ha0)))
("^/b/$" (lambda (httpcon) (setq result :ha1))))
:extra-table (elnode--auth-entry->dispatch-table :test-scheme1)))))))
(ert-deftest elnode-test-call-simple ()
"Simple test of calling a handler.
This tests the basics of mocked server, it goes through the
filter so it's very useful for working stuff out."
(with-elnode-mock-server
(lambda (httpcon)
(elnode-http-start httpcon 200 '("Content-Type" . "text/plain"))
(elnode-http-return httpcon "that's it"))
(let ((response (elnode-test-call "/test/test.something")))
(should-elnode-response response
:status-code 200
:header-name "Content-Type"
:header-value "text/plain"
:body-match ".*that's it"))))
(ert-deftest elnode--make-test-call ()
"Test the HTTP request construction."
(should
(equal
"GET / HTTP/1.1\r\n\r\n"
(elnode--make-test-call
"/" "GET"
'()
nil)))
(should
(equal
"GET /?a=1&b=hello HTTP/1.1\r\n\r\n"
(elnode--make-test-call
"/" "GET"
'((a . 1)(b . "hello"))
nil)))
(should
(equal
"POST / HTTP/1.1\r
Content-Type: application/x-www-form-urlencoded\r
Content-Length: 11\r
\r
a=1&b=hello"
(elnode--make-test-call
"/" "POST"
'((a . 1)(b . "hello"))
nil)))
;; The content type always comes before any other headers
(should
(equal
"POST / HTTP/1.1\r
Content-Type: application/x-www-form-urlencoded\r
Content-Length: 11\r
User-Agent: elnode-test\r
\r
a=1&b=hello"
(elnode--make-test-call
"/" "POST"
'((a . 1)(b . "hello"))
'(("User-agent" . "elnode-test"))))))
(ert-deftest elnode-test-call-assert ()
"Test that we can assert things about elnode test responses."
(with-elnode-mock-server
;; Test dispatcher
(lambda (httpcon)
(elnode-hostpath-dispatcher
httpcon
'(("[^/]*//test/.*" . elnode-test-handler)))) t
(should-elnode-response
(elnode-test-call "/test/test.something")
:status-code 200
:header-name "Content-Type"
:header-value "text/html"
:body-match ".*<h1>Hello World</h1>")
;; Success with multiple headers
(should-elnode-response
(elnode-test-call "/test/test.something"
:method "POST"
:parameters '(("a" . 1)))
:status-code 200
:header-list '(("Content-Type" . "text/html")
("User-Agent" . "elnode-test"))
:body-match ".*<div>((\"a\" . \"1\"))</div>")
;; Success with multiple header regexes
(should-elnode-response
(elnode-test-call "/test/test.something"
:method "POST"
:parameters '(("a" . 1)))
:status-code 200
:header-list-match '(("Content-Type" . "text/html")
("User-Agent" . "elnode-.*"))
:body-match ".*<div>((\"a\" . \"1\"))</div>")
;; With params
(should-elnode-response
(elnode-test-call "/test/test.something"
:method "POST"
:parameters '(("a" . 1)))
:status-code 200
:header-name "Content-Type"
:header-value "text/html"
:body-match ".*<div>((\"a\" . \"1\"))</div>")))
(ert-deftest elnode-test-call-cookie-store ()
"Test the cookie store."
;; Test with empty cookie store
(with-elnode-mock-server
(lambda (httpcon)
(elnode-http-start
httpcon 200
'("Content-Type" . "text/html")
(elnode-http-cookie-make
"mycookie" 101
:expiry "Mon, Feb 27 2012 22:10:21 GMT"))
(elnode-http-return httpcon "<h1>HA!</h1>")) t
;; Let-bind empty cookie store
(let ((elnode--cookie-store (make-hash-table :test 'equal)))
(elnode-test-call "/anything")
(should
(equal
(kvhash->alist elnode--cookie-store)
'(("mycookie" . "101"))))))
;; Test merging cookie store
(with-elnode-mock-server
(lambda (httpcon)
(elnode-http-start
httpcon 200
'("Content-Type" . "text/html")
(elnode-http-cookie-make
"mycookie" 101
:expiry "Mon, Feb 27 2012 22:10:21 GMT"))
(elnode-http-return httpcon "<h1>HA!</h1>")) t
(let ((elnode--cookie-store
(kvalist->hash '(("a" . "1")("b" . "hello!")))))
(elnode-test-call "/anything")
(should
(equal
(kvalist-sort (kvhash->alist elnode--cookie-store) 'string-lessp)
'(("a" . "1")
("b" . "hello!")
("mycookie" . "101")))))))
(ert-deftest elnode-http-header ()
"Test that we have headers."
(fakir-mock-process
:httpcon
((:buffer
(elnode--http-make-hdr
'get "/"
'(host . "localhost")
'(user-agent . "test-agent")
'(if-modified-since . "Mon, Feb 27 2012 22:10:21 GMT")
`(content-length . ,(format "%d" (length "this is finished")))
'(body . "this is finished"))))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
;; Now parse
(should
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))
(should
(equal "test-agent"
(elnode-http-header :httpcon "user-agent")))
(should
(equal "test-agent"
(elnode-http-header :httpcon 'user-agent)))
(should
(equal "test-agent"
(elnode-http-header :httpcon 'User-Agent)))
(should
(equal '(20299 65357)
(elnode-http-header :httpcon 'if-modified-since :time)))
;; FIXME - add a test for bad time encoding
(should
(equal "Mon, Feb 27 2012 22:10:21 GMT"
(elnode-http-header :httpcon 'if-modified-since)))))
(ert-deftest elnode-test-cookies ()
"Test that we can get all the cookies."
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms
'((cookie . "csrf=213u2132%20321412nsfnwlv; username=nicferrier")))
(should
(equal
(elnode-http-cookies :httpcon)
'(("csrf" . "213u2132 321412nsfnwlv")
("username" . "nicferrier")))))
;; Now with empty header
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-http-header '(("Content-type" . "text/xml")))
(should-not (elnode-http-cookies :httpcon))))
(ert-deftest elnode-test-cookie ()
"Test the cookie retrieval"
;; First test no cookie header
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms '((referer . "http://somehost.example/com")))
(should-not (elnode-http-cookie :httpcon "username")))
;; Now do we have a cookie?
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms
'((cookie . "csrf=213u21321321412nsfnwlv; username=nicferrier")))
(should
(equal
(elnode-http-cookie :httpcon "username")
'("username" . "nicferrier")))
(should
(equal
"nicferrier"
(elnode-http-cookie :httpcon "username" t)))))
(ert-deftest elnode-test-cookie-list ()
"Test that a cookie list property is set on the connection.
Cookie lists are good fake up values for higher abstraction
testing code so we specifically test that they work."
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-http-cookie-list '(("name" . "value")))
(should
(equal
'("name" . "value")
(elnode-http-cookie :httpcon "name"))))
;; Not sure about what the property should contain here...
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms
'((cookie . "name=value; other=hello%20world")))
(elnode-http-cookie :httpcon "name")
(should
(equal
'(("name" . "value")
("other" . "hello world"))
(elnode/con-get :httpcon :elnode-http-cookie-list)))))
(ert-deftest elnode-http-cookie-make ()
"Test the cookie header maker."
;; Expiry using a string date
(should
(equal
'("Set-Cookie" . "mycookie=101; Expires=Mon, Feb 27 2012 22:10:21 GMT;")
(elnode-http-cookie-make
"mycookie" 101
:expiry "Mon, Feb 27 2012 22:10:21 GMT"))))
(ert-deftest elnode--response-header-to-cookie-store ()
"Test increasing the cookie store."
(should
(equal
(kvhash->alist
(let ((elnode--cookie-store (make-hash-table :test 'equal)))
(elnode--response-header-to-cookie-store
'(("Cookie" . "a=10; b=20")
("Content-Type" . "text/html")
("Set-Cookie"
. "mycookie=101; Expires=Mon, Feb 27 2012 22:10:21 GMT;")))))
'(("mycookie" . "101"))))
(should
(equal
(kvalist-sort
(kvhash->alist
(let ((elnode--cookie-store
(kvalist->hash '(("a" . "20")
("b" . "this is it!")))))
(elnode--response-header-to-cookie-store
'(("Cookie" . "a=10; b=20")
("Content-Type" . "text/html")
("Set-Cookie"
. "mycookie=101; Expires=Mon, Feb 27 2012 22:10:21 GMT;")))))
'string-lessp)
'(("a" . "20")
("b" . "this is it!")
("mycookie" . "101")))))
(ert-deftest elnode--cookie-store-to-header-value ()
(let ((elnode--cookie-store
(kvalist->hash
'(("a" . "10")
("b" . "hello world!")
("mycookie" . "101")))))
(should
(equal
(elnode--cookie-store-to-header-value)
"a=10; b=hello%20world%21; mycookie=101")))
(let ((elnode--cookie-store (make-hash-table :test 'equal)))
(should-not
(elnode--cookie-store-to-header-value))))
(ert-deftest elnode-test-http-get-params ()
"Test that the params are ok if they are on the status line.
Sets `:elnode-http-params' to nil to trigger `elnode-http-params'
parsing. That checks the `:elnode-http-method' and for GET it
returns the parsed `:elnode-http-query'."
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-params nil
:elnode-http-method "GET"
:elnode-http-query "a=10")
(should (equal "10" (elnode-http-param :httpcon "a"))))
;; Test some more complex params
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-params nil
:elnode-http-method "GET"
:elnode-http-query "a=10&b=lah+dee+dah&c+a=blah+blah")
(should (equal "lah dee dah" (elnode-http-param :httpcon "b")))
(should (equal "lah dee dah" (elnode-http-param :httpcon 'b)))
(should (equal "blah blah" (elnode-http-param :httpcon "c a"))))
;; Test the filtering
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-params nil
:elnode-http-method "GET"
:elnode-http-query "a=10&b=lah+dee+dah&d=blah+blah")
(should (equal "lah dee dah" (elnode-http-param :httpcon "b")))
(should (equal "lah dee dah" (elnode-http-param :httpcon 'b)))
(should (equal '(("a" . "10")("b" . "lah dee dah"))
(elnode-http-params :httpcon "a" "b")))
(should (equal '(("a" . "10")("b" . "lah dee dah"))
(elnode-http-params :httpcon 'a "b")))))
(ert-deftest elnode-test-http-post-params ()
"Test that the params are ok if they are in the body.
Does a full http parse of a dummy buffer."
(let ((httpcon :httpcon))
(let ((post-body "a=10&b=20&c=this+is+finished"))
(fakir-mock-process
:httpcon
((:buffer
(elnode--http-make-hdr
'post "/"
'(host . "localhost")
'(user-agent . "test-agent")
`(content-length . ,(format "%d" (length post-body)))
`(body . ,post-body))))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
;; Now parse
(should
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse httpcon))))
;; Now test some params
(should (equal "10" (elnode-http-param httpcon "a")))
(should (equal "20" (elnode-http-param httpcon "b")))
(should (equal "this is finished" (elnode-http-param httpcon "c")))))
;; Test get of params that aren't there
(fakir-mock-process
:httpcon
((:buffer
(elnode--http-make-hdr
'post "/"
'(host . "localhost")
'(user-agent . "test-agent")
`(content-length . "0")
`(body . ""))))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
;; Now parse
(should
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse httpcon))))
(should-not (elnode-http-param httpcon "a"))
(should-not (elnode-http-param httpcon "b"))
(should-not (elnode-http-param httpcon "c")))))
(ert-deftest elnode-test-http-post ()
"A simpler test of just the POST body parsing.
This doesn't parse the whole body, just the POST content. It
does have a BASE64 string in it though."
(let* ((data (concat
"data:image/png;base64,"
(base64-encode-string "hello there")))
(params (format "a=%s&d=a+line%%3d+of+text&c=3"
(url-hexify-string data))))
(fakir-mock-process :httpcon
((:buffer params))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-header-end 1)
(should
(equal
(elnode--http-post-to-alist :httpcon)
`(("a" . "hello there") ; doesn't test the :mime-type property
("d" . "a line= of text")
("c" . "3")))))))
(ert-deftest elnode-test-http-post-empty-params ()
"Test that the params are ok if they are just empty in the body."
(let ((post-body ""))
(fakir-mock-process
:httpcon
((:buffer
(elnode--http-make-hdr
'post "/"
'(host . "localhost")
'(user-agent . "test-agent")
`(content-length . ,(format "%d" (length post-body)))
`(body . ,post-body))))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
;; Now parse
(should
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))
;; Now test some params
(should-not (elnode-http-param :httpcon "a")))))
(defun elnode--test-multipart-example (&optional boundary)
"Get an example Multipart body in BUFFER."
;; This is from the W3C example -
;; http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2
(let ((bound (or boundary "AaB03x")))
(format
"Content-Type: multipart/form-data; boundary=%s\r
\r
--%s\r
Content-Disposition: form-data; name=\"submit-name\"\r
\r
Larry\r
--%s\r
Content-Disposition: form-data; name=\"files\"; filename=\"file1.txt\"\r
Content-Type: text/plain\r
\r
... contents of file1.txt ...\r
--%s--\r
" bound bound bound bound)))
(ert-deftest elnode-test-multipart-parser ()
"Simple test of multipart parsing."
(with-temp-buffer
(insert "TEST\r\n")
(insert (elnode--test-multipart-example))
;; Now read the buffer as a header
(goto-char (point-min))
;; And then test
(let* ((buffer (current-buffer))
(hdr (elnode--http-parse-header (current-buffer) (point)))
(hdr-end-pt (with-current-buffer buffer (point)))
(parsed-cont-type
(mail-header-parse-content-type
(kva "content-type" (cadr hdr))))
(boundary (kva 'boundary (cdr parsed-cont-type)))
(params
(elnode--http-mp-decode buffer hdr-end-pt boundary)))
(should (equal (kva "submit-name" params) "Larry"))
(should (equal (kva "files" params) "... contents of file1.txt ..."))
(should (equal (get-text-property
0 :elnode-filename (kva "files" params))
"file1.txt")))))
(ert-deftest elnode-test-http-multipart-post ()
"Test that a multipart POST params are ok."
(let* ((boundary "96a411d2bf2a")
(post-body (elnode--test-multipart-example boundary)))
(fakir-mock-process
:httpcon
((:buffer
(elnode--http-make-hdr
'post "/"
'(host . "localhost")
'(user-agent . "test-agent")
`(content-type .
,(format
"multipart/form-data; boundary=%s"
boundary))
`(content-length . ,(format "%d" (length post-body)))
`(body . ,post-body))))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
;; Now parse
(should
(equal 'done
(catch 'elnode-parse-http
(elnode--http-parse :httpcon))))
;; Now test some params
(should
(equal
(elnode-http-param :httpcon "submit-name")
"Larry"))
(should
(equal
(elnode-http-param :httpcon "files")
"... contents of file1.txt ..."))
(should
(equal
(get-text-property
0 :elnode-filename
(elnode-http-param :httpcon "files"))
"file1.txt")))))
(ert-deftest elnode--http-result-header ()
"Test that we can make result headers."
(let ((l '((content-type . "text/html"))))
(should
(equal
(elnode--http-result-header l)
"Transfer-Encoding: chunked\r
Content-Type: text/html\r
")))
(let ((l '()))
(should
(equal
(elnode--http-result-header l)
"Transfer-Encoding: chunked\r
"))))
(ert-deftest elnode-http-header-set ()
"Test the premature setting of HTTP headers."
(fakir-mock-process
:httpcon
()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(should
(equal nil
(elnode/con-get :httpcon :elnode-headers-to-set)))
(elnode-http-header-set :httpcon "Content-Type" "text/html")
(elnode-http-header-set
:httpcon
(elnode-http-cookie-make "mycookie" "value"))
(should
(equal '(("Content-Type" . "text/html")
("Set-Cookie" . "mycookie=value;"))
(elnode/con-get :httpcon :elnode-headers-to-set)))))
(ert-deftest elnode--format-response ()
"Test response formatting."
;; Test standard 200 response
(should
(equal
"<h1>Ok.</h1>\r\n"
(elnode--format-response 200)))
;; Test a response we don't have a mapping for
(should
(equal
"<h1>Error.</h1>\r\n"
(elnode--format-response 531)))
(let ((elnode-default-response-table '((404 . "We didn't find that!"))))
(should
(equal
"<h1>We didn't find that!</h1>\r\n"
(elnode--format-response 404)))))
(ert-deftest elnode-send-json ()
"Test sending JSON."
(let ((sent-data ""))
(should
(equal
["a string in a list"]
(json-read-from-string
(noflet ((elnode-http-return (con data)
(setq sent-data data)))
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode-send-json :httpcon (list "a string in a list")))
sent-data))))))
(defconst elnode--buffer-template-example
"<!doctype html>
<head>
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<title><!##E title E##!></title>
<meta name='viewport' content='width=device-width'>
<link rel='stylesheet' href='/talk/stuff/css/style.css'/>
<link rel='stylesheet' href='/talk/stuff/css/basic.css'/>
</head>
<body>
<a href='<!##E username E##!>'><!##E username E##!></a>
<div id='header'>
<ul>
<li><a href='javascript:;'>talk to a friend</a></li>
<li><a href='/about/'>about</a></li>
<li><a href='/blog/'>blog</a></li>
</ul>
<!##E name-html E##!>
</div>
</body>
</html>"
"Example template source for `elnode--buffer-template' tests.")
(ert-deftest elnode--buffer-template ()
"Test the buffer templating."
(let ((result
(with-temp-buffer
(insert elnode--buffer-template-example)
(elnode--buffer-template
(current-buffer)
'(("title" . "My webpage")
("username" . "nicferrier")
("name-html" . "<div>you are talking to Caroline</div>"))))))
(should
(string-match ".*<title>My webpage</title>.*" result))
(should
(string-match ".*<a href='nicferrier'>nicferrier</a>.*" result))
(should
(string-match ".*<div>you are talking to Caroline</div>.*" result))))
(ert-deftest elnode-http-pathinfo ()
"Test the pathinfo calling."
(fakir-mock-process
:httpcon
((:elnode-http-pathinfo "/test/somepath"))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-http-pathinfo "/test/somepath")
(should
(equal
"/test/somepath"
(elnode-http-pathinfo :httpcon)))))
(ert-deftest elnode--mapper-find ()
"Test the mapper find function."
(fakir-mock-process
:httpcon
((:nothing))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(should
(equal
(elnode--mapper-find
:httpcon
"localhost//wiki/somefile.creole"
'(("[^/]+//wiki/\\(.*\\)" . elnode-wikiserver)
("[^/]+//.*" . elnode-webserver)))
'elnode-wikiserver))
(should (equal (elnode-http-mapping :httpcon t) 2))
(should
(equal
(elnode-http-mapping :httpcon)
"localhost//wiki/somefile.creole"))
(should
(equal
(elnode-http-mapping :httpcon 0)
"localhost//wiki/somefile.creole"))
(should
(equal
(elnode-http-mapping :httpcon 1)
"somefile.creole"))
(should
(equal
(elnode--mapper-find
:httpcon
"anyhost//wiki/somefile.creole"
'(("[^/]+//wiki/\\(.*\\)" . elnode-wikiserver)
("[^/]+//.*" . elnode-webserver)))
'elnode-wikiserver))))
(ert-deftest elnode--strip-leading-slash ()
"Test slash stripping.
That sounds more fun than it is."
(should
(equal "blah"
(elnode--strip-leading-slash "/blah")))
(should
(equal "blah"
(elnode--strip-leading-slash "blah")))
(should
(equal "blah/"
(elnode--strip-leading-slash "/blah/")))
(should
(equal "blah/"
(elnode--strip-leading-slash "blah/"))))
(ert-deftest elnode-get-targetfile ()
"Test the target file resolution stuff."
(fakir-mock-process :httpcon
((:elnode-http-pathinfo "/wiki/index.creole"))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-http-pathinfo "/wiki/index.creole")
(should
(equal
'elnode-wikiserver
(elnode--mapper-find
:httpcon
"localhost//wiki/index.creole"
'(("[^/]+//wiki/\\(.*\\)" . elnode-wikiserver)
("[^/]+//\\(.*\\)" . elnode-webserver)))))
(fakir-mock-file (fakir-file
:filename "index.creole"
:directory "/home/elnode/wiki")
(should
(equal
(elnode-get-targetfile :httpcon "/home/elnode/wiki")
"/home/elnode/wiki/index.creole"))))
;; Now alter the mapping to NOT declare the mapped part...
(fakir-mock-process :httpcon
((:elnode-http-pathinfo "/blah/thing.txt"))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-http-pathinfo "/blah/thing.txt")
;; ... the mapper-find should still work...
(should
(equal
'elnode-webserver
(elnode--mapper-find :httpcon
"localhost//blah/thing.txt"
'(("[^/]+//.*" . elnode-webserver)))))
;; ... but now there is no mapping so it only maps because of path-info
(fakir-mock-file (fakir-file
:filename "thing.txt"
:directory "/home/elnode/www/blah")
(should
(equal
(elnode-get-targetfile :httpcon "/home/elnode/www")
"/home/elnode/www/blah/thing.txt"))))
;; Test without a mapping
(fakir-mock-process :httpcon
((:elnode-http-pathinfo "/index.creole"))
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-http-pathinfo "/index.creole")
(fakir-mock-file (fakir-file
:filename "index.creole"
:directory "/home/elnode/wiki")
(should
(equal
(elnode-get-targetfile :httpcon "/home/elnode/wiki")
"/home/elnode/wiki/index.creole")))))
;; This stuff is replaced by the new rle stuff
;; (ert-deftest elnode-worker-elisp ()
;; "Test the `elnode-worker-elisp' macro.
;;
;; Runs some lisp in a child Emacs and tests that it outputs the
;; right thing."
;; (let* ((bufname (generate-new-buffer-name "elnode-worker-elisp-test"))
;; (buf (get-buffer-create bufname)))
;; (elnode-wait-for-exit
;; ;; Nice simple bit of elisp to run in the child
;; (elnode-worker-elisp
;; buf
;; ((a 10)
;; (b 20))
;; (setq x a)
;; (princ x)))
;; (should
;; (equal
;; "10"
;; (let ((output
;; (with-current-buffer buf
;; (buffer-substring (point-min) (point-max)))))
;; (kill-buffer buf)
;; output)))))
(ert-deftest elnode-method ()
"A quick test for `elnode-method'."
(let ((httpcon :fake)
method)
(noflet ((elnode-http-method (http-con) "GET"))
(elnode-method httpcon
(GET
(setq method "GET"))
(POST
(set method "POST")))
(should (equal method "GET")))))
(ert-deftest elnode--under-docroot-p ()
"Test that the docroot protection works."
(let ((fakir--home-root "/home/elnode"))
(fakir-mock-file (fakir-file
:filename "index.creole"
:directory "/home/elnode/wiki")
(should
(elnode--under-docroot-p
"/home/elnode/wiki/index.creole"
"~/wiki"))
(should
(elnode--under-docroot-p
"/home/elnode/wiki/index.creole"
"/home/elnode/wiki"))
(should-not
(elnode--under-docroot-p
"/home/elnode/wiki/blah/index.creole"
"/home/elnode/wiki"))
(should-not
(elnode--under-docroot-p
"/home/elnode/wiki/blah.creole"
"/home/elnode/wiki"))
(should-not
(elnode--under-docroot-p
"/home/elnode/wikiroot/blah.creole"
"/home/elnode/wiki"))
(should-not
(elnode--under-docroot-p
"/home/elnode/wiki/blah.creole"
"/home/elnode/wikiroot")))))
(ert-deftest elnode-cached-p ()
"Is a resource cached?"
(fakir-mock-file (fakir-file
:filename "page.creole"
:directory "/home/elnode/wiki"
:mtime "Mon, Feb 27 2012 22:10:21 GMT")
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms
'((if-modified-since . "Mon, Feb 27 2012 22:10:24 GMT")))
(should
(elnode-cached-p :httpcon "/home/elnode/wiki/page.creole")))
;; Test the case where there is no header
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms '((user-agent . "Elnode test client")))
(should-not
(elnode-cached-p :httpcon "/home/elnode/wiki/page.creole")))))
(ert-deftest elnode-docroot-for ()
"Test the docroot protection macro."
(let ((httpcon :fake))
(noflet ((process-status (proc) 'open)
(elnode-send-404 (httpcon) (throw :test 404))
(send-200 (httpcon) (throw :test 200))
(elnode-send-status (httpcon status &optional msg)
(throw :test status)))
;; Test straight through
(should
(equal
200
(catch :test
(fakir-mock-process :fake ()
(set-process-plist :fake (list (make-hash-table :test 'eq)))
(elnode/con-put :fake
:elnode-http-pathinfo "/wiki/test.creole"
:elnode-http-mapping ["/wiki/test.creole" "test.creole"])
(fakir-mock-file
(fakir-file
:filename "test.creole"
:directory "/home/elnode/wikiroot")
(elnode-docroot-for "/home/elnode/wikiroot"
with target-path
on httpcon
do
(send-200 httpcon)))))))
;; Non-existant path
(should
(equal
404
(catch :test
(fakir-mock-process :fake ()
(set-process-plist :fake (list (make-hash-table :test 'eq)))
(elnode/con-put :fake
:elnode-http-pathinfo "/wiki/test.creole"
:elnode-http-mapping ["/wiki/test.creole" "test.creole"])
(fakir-mock-file
(fakir-file
:filename "test.creole"
:directory "/home/elnode/wikiroot")
(elnode-docroot-for "/home/elnode/wikifiles"
with target-path
on httpcon
do
(send-200 httpcon)))))))
;; Test the cached check
(should
(equal
304
(catch :test
(fakir-mock-process :fake ()
(set-process-plist :fake (list (make-hash-table :test 'eq)))
(elnode/con-put :fake
:elnode-http-pathinfo "/wiki/test.creole"
:elnode-http-mapping ["/wiki/test.creole" "test.creole"]
:elnode-http-header-syms '((if-modified-since
. "Mon, Feb 27 2012 22:10:24 GMT")))
(fakir-mock-file
(fakir-file
:filename "test.creole"
:directory "/home/elnode/wikiroot"
:mtime "Mon, Feb 27 2012 22:10:20 GMT")
(elnode-docroot-for "/home/elnode/wikiroot"
with target-path
on httpcon
do
(send-200 httpcon))))))))))
(ert-deftest elnode-webserver ()
(noflet ((my-dispatch (httpcon)
(elnode-hostpath-dispatcher
httpcon '(("[^/]*/\\(.*\\)" . elnode-webserver)))))
(with-elnode-mock-server 'my-dispatch
;; Now the actual test
(fakir-mock-file
(fakir-file
:filename "blah.html"
:directory elnode-webserver-docroot-default
:content "<html>Fake HTML file</html>")
(unwind-protect
;; Ensure the webserver uses Emacs to open files so fakir can
;; override it.
(let* ((elnode-webserver-visit-file t)
;; Turn off logging
(elnode--do-error-logging nil)
(elnode--do-access-logging-on-dispatch nil)
;; Make the served root the default
(elnode-webserver-docroot elnode-webserver-docroot-default))
(should-elnode-response
(elnode-test-call "/blah.html")
:status-code 200
:body-match "<html>Fake HTML file</html>"))
;; Now kill the buffer that was opened to serve the file.
(if (get-buffer "blah.html")
(kill-buffer "blah.html")))))))
(ert-deftest elnode-client-with-stdout ()
"Test the stdout macro.
Test that we get the right chunked encoding stuff going on."
(fakir-mock-process :fake ((:elnode-http-started t))
(set-process-plist :fake (list (make-hash-table :test 'eq)))
(elnode/con-put :fake :elnode-http-started t)
(noflet ((process-status (proc) 'open))
(with-stdout-to-elnode :fake (princ "hello!")))
(should
(equal
(let ((str "hello!"))
(format "%d\r\n%s\r\n0\r\n\r\n" (length str) str))
(with-current-buffer (fakir-get-output-buffer) (buffer-string))))))
(defvar elnode-test-wrapped-handler-counter 0)
(defvar elnode-test-wrapping-handler-counter 0)
;; Elnode auth tests
(defun elnode--auth-init-user-db (user-alist &optional db)
"Initialize the auth database.
USER-ALIST is an assoc list of username and passwords.
Optionally allow the database to be specified with DB (the
default is `elnode-auth-db')."
(loop for pair in user-alist
do
(db-put
(car pair)
`(("username" . ,(car pair))
("token" . ,(elnode-auth-make-hash (car pair) (cdr pair))))
(or db elnode-auth-db))))
(ert-deftest elnode-auth-user-p ()
"Check the authentication check.
This tests the authentication database check."
(let* ((elnode-auth-db (db-make '(db-hash)))
;; auth test
(auth-test
(lambda (username)
(elnode-auth-default-test username elnode-auth-db))))
;; The only time we really need clear text passwords is when
;; faking records for test
(elnode--auth-init-user-db '(("nferrier" . "password")
("someuser" . "secret")))
(should
(elnode-auth-user-p "someuser" "secret" :auth-test auth-test))))
(ert-deftest elnode-auth-check-p ()
"Test basic login.
Tess that we can login a user and then assert that they are
authenticated."
(let* ((elnode-loggedin-db (make-hash-table :test 'equal))
(elnode-auth-db (db-make '(db-hash)))
;; Make an auth-test function
(auth-test
(lambda (username)
(elnode-auth-default-test username elnode-auth-db))))
(elnode--auth-init-user-db '(("nferrier" . "password") ("someuser" "secret")))
;; Test a failure
(should
(equal "an error occured!"
(condition-case credentials
(elnode-auth-login
"nferrier" "secret"
:auth-test auth-test)
(elnode-auth
"an error occured!"))))
;; Now test
(let ((hash (elnode-auth-login
"nferrier" "password" :auth-test auth-test)))
(should (elnode-auth-check-p "nferrier" hash)))))
(ert-deftest elnode-auth-cookie-value ()
(let* ((elnode-loggedin-db (make-hash-table :test 'equal)))
(fakir-mock-process :httpcon ()
(noflet ((elnode-auth-get-cookie-value (httpcon :cookie-name cookie-name)
(cons "nic" "blah")))
(with-elnode-auth :httpcon 'marmalade-auth
;; Nil first...
(should-not (elnode-auth-cookie-check :httpcon :cookie-name "blah"))
;;; ... then the username
(should
(equal (elnode-auth-cookie-check :httpcon :cookie-name "blah")
"nic")))))))
(ert-deftest elnode-auth-cookie-check-p ()
"Check that a cookie can be used for auth."
(let* ((elnode-loggedin-db (make-hash-table :test 'equal))
(elnode-auth-db (db-make '(db-hash)))
;; auth-test function
(auth-test
(lambda (username)
(elnode-auth-default-test username elnode-auth-db))))
;; Fake the db data
(elnode--auth-init-user-db '(("nferrier" . "password") ("someuser" "secret")))
;; Now test
(let ((hash (elnode-auth-login "nferrier" "password" :auth-test auth-test)))
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms
`((cookie . ,(concat "elnode-auth=nferrier::" hash))))
(should (elnode-auth-cookie-check-p :httpcon))))
;; Test what happens without a cookie
(let ((hash (elnode-auth-login
"nferrier" "password" :auth-test auth-test)))
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon
:elnode-http-header-syms
`((referer . "http://somehost.example.com")))
;; The error should signal the cookie name
(should-equal
(condition-case token
(elnode-auth-cookie-check-p :httpcon)
(elnode-auth-token (cdr token)))
"elnode-auth")))))
(ert-deftest elnode-auth-login-sender ()
"Low levelish test of the login page sender."
(fakir-mock-process :httpcon ()
(set-process-plist :httpcon (list (make-hash-table :test 'eq)))
(elnode/con-put :httpcon :elnode-http-started (current-time))
(noflet ((process-status (proc) 'open))
(elnode-auth-login-sender :httpcon "/login/" "/myapp/loggedin"))
(with-current-buffer (fakir-get-output-buffer)
(buffer-string)
(goto-char (point-min))
(should (re-search-forward
"<form method='POST' action='/login/'>" nil 't))
(should (re-search-forward
"<input type='hidden' name='redirect' value='/myapp/loggedin'/>"
nil 't)))))
(defmacro elnode--auth-state (handler &rest body)
"A bunch of authentication state wrapped around BODY."
(declare (debug (sexp &rest form))
(indent 1))
`(noflet ((get-result (response)
(cadr (split-string (plist-get response :result-string) "\r\n\r\n"))))
(let* ((elnode-auth-db (db-make '(db-hash))))
(elnode--auth-init-user-db '(("nferrier" . "password") ("someuser" . "secret")))
(let* ((elnode--defined-authentication-schemes (make-hash-table :test 'equal))
(token (elnode-auth-make-hash "nferrier" "password"))
(auth-hash (progn
(elnode-defauth :if-auth-test :cookie-name "if-auth")
(elnode-auth-login
"nferrier" "password"
:auth-test (lambda (username) token)))))
(with-elnode-mock-server ,handler
(progn ,@body))))))
(ert-deftest elnode-if-auth ()
"Basic auth test testing."
(elnode--auth-state
(lambda (httpcon)
(elnode-http-start httpcon 200 '(Content-type . "text/plain"))
(let
((httpconv httpcon)
(scheme-list
(gethash :if-auth-test elnode--defined-authentication-schemes)))
(if (eq :cookie (plist-get scheme-list :test))
(condition-case token
(let*
((cookie
(plist-get scheme-list :cookie-name))
(username
(elnode-auth-cookie-check httpconv :cookie-name cookie)))
(elnode/con-put httpconv :auth-username username)
(elnode-http-return httpcon "done"))
(elnode-auth-token
(progn
(elnode-http-return httpcon "bad"))))
;; Else ...
(error 'elnode-not-a-cookie))))
;; need one call without a cookie
(should
(assert-elnode-response
(let ((headers `(("Cookie" . ,(concat "if-auth=nferrier::" auth-hash)))))
(elnode-test-call "/" :headers headers))
:body-match ".*\r\n4\r\ndone\r\n0\r\n\r\n"))
(should
(assert-elnode-response
(let ((headers `(("Cookie" . ,(concat "if-auth=someuser::" auth-hash)))))
(elnode-test-call "/" :headers headers))
:body-match ".*\r\n3\r\nbad\r\n0\r\n\r\n"))
(should
(assert-elnode-response
(let ((headers `(("User-Agent" . "blah"))))
(elnode-test-call "/" :headers headers))
:body-match ".*\r\n3\r\nbad\r\n0\r\n\r\n"))))
(ert-deftest elnode-with-auth ()
"Test protection of code with authentication.
This tests that the auth protection macro does its job, including
the wrapping of a specified handler with the login sender."
(elnode--auth-state
(lambda (httpcon)
(with-elnode-auth httpcon :if-auth-test
(elnode-http-start httpcon 200 '(Content-type . "text/plain"))
(elnode-http-return httpcon "done")))
(should
(assert-elnode-response
(let ((headers `(("User-Agent" . "blah"))))
(elnode-test-call "/" :headers headers))
:header-list '(("Location" . "/login/"))))
(should
(assert-elnode-response
(let ((headers `(("Cookie" . ,(concat "if-auth=nferrier::" auth-hash)))))
(elnode-test-call "/" :headers headers))
:body-match ".*\r\n4\r\ndone\r\n0\r\n\r\n"))))
(ert-deftest elnode-server-info ()
"Test server meta data."
(let* ((port (elnode-find-free-service))
(server-info
(unwind-protect
(let (the-end)
(elnode-start
(lambda (httpcon)
(elnode-send-json httpcon (elnode-server-info httpcon)))
:port port)
(web-http-get
(lambda (con header data)
(setq the-end (json-read-from-string data)))
:port port)
(while (not the-end) (sit-for 1))
the-end)
(elnode-stop port))))
(should (equal server-info (format "127.0.0.1:%s" port)))))
;; Wiki tests
(ert-deftest elnode-wiki--setup ()
"Test the wiki setup function."
;; Test that it's not called if we can't find the source file
(let (called)
(noflet ((make-directory (dirname &optional parents)
(setq called t))
;; We fake buffer-file-name so that the wiki-index-source
;; will not be found
(buffer-file-name ()
"/tmp/elnode/elnode-wiki.el"))
(elnode-wiki--setup)
(should-not called)))
;; Test that when called we're going to copy things right
(let (make-dir
copy-file
;; Ensure the configurable wikiroot is set to the default
(elnode-wikiserver-wikiroot elnode-wikiserver-wikiroot-default))
(noflet ((make-directory (dirname &optional parents)
(setq make-dir (list dirname parents)))
(dired-copy-file (from to ok-flag)
(setq copy-file (list from to ok-flag)))
;; Mock the source filename environment
(buffer-file-name ()
"/tmp/elnode--wiki-setup-test/elnode-wiki.el")
(file-exists-p (filename)
(equal
filename
"/tmp/elnode--wiki-setup-test/default-wiki-index.creole")))
(elnode-wiki--setup)
(should
(equal
(list
;; This is the dir we should make
'("/home/nferrier/.emacs.d/elnode/wiki/" t)
;; This is the copy file spec
'("/tmp/elnode--wiki-setup-test/default-wiki-index.creole"
"/home/nferrier/.emacs.d/elnode/wiki/index.creole"
nil))
;; So this is the directory that make-directory will create
;; and the copy-file spec
(list make-dir copy-file))))))
(ert-deftest elnode-wiki-page ()
"Full stack Wiki test."
(with-elnode-mock-server
;; The dispatcher function
(lambda (httpcon)
(let ((elnode-wikiserver-wikiroot "/home/elnode/wiki"))
(elnode-hostpath-dispatcher
httpcon
'(("[^/]*//wiki/\\(.*\\)" . elnode-wikiserver))))) t
(fakir-mock-file
(fakir-file
:filename "test.creole"
:directory "/home/elnode/wiki"
:content "= Hello World =\nthis is a creole wiki file!\n")
(let* ((elnode--do-error-logging nil)
(elnode--do-access-logging-on-dispatch nil))
(should-elnode-response
(elnode-test-call "/wiki/test.creole")
:status-code 200
:body-match ".*<h1>Hello World</h1>.*")))))
;;; Some new testing constructs
(ert-deftest elnode-fake-params ()
"Testing faking the parameters."
(should
(equal
(elnode-fake-params :httpcon '(("a" . "10"))
(elnode-http-param :httpcon "a"))
"10"))
;; And with a file property
(should
(equal
(elnode-fake-params
:httpcon '(("a" "10" :elnode-filename "file"))
(get-text-property
0 :elnode-filename
(elnode-http-param :httpcon "a")))
"file")))
(ert-deftest elnode-server-info ()
"Test the server info stuff."
(noflet ((fake-server-ip ()
(let (remote)
(elnode-start
(lambda (httpcon)
(setq
remote (elnode-server-info httpcon))
(elnode-send-400 httpcon))
:port 5999)
(web-http-get
(lambda (httpc hdr data) (elnode-stop 5999))
:url "http://localhost:5999")
(sleep-for 1)
remote)))
(should (equal (fake-server-ip) "127.0.0.1:5999"))))
(ert-deftest elnode-proxy-post ()
"Test making a proxy-call back to the server."
(noflet ((proxy-post ()
(let (remote)
(elnode-start
(lambda (httpcon)
(if (equal
(elnode-http-pathinfo httpcon)
"/ping/")
(elnode-send-status httpcon 201)
;; Else send the internal call
(elnode-proxy-post
httpcon "/ping/"
:callback (lambda (httpc hdr data)
(setq remote data)))
(elnode-send-status httpcon 200)))
:port 5999)
(web-http-get
(lambda (httpc hdr data) (elnode-stop 5999))
:url "http://localhost:5999")
(sleep-for 1)
remote)))
(should (equal (proxy-post) "<h1>Created</h1>\r\n"))))
(ert-deftest elnode-make-proxy ()
"Test the proxy stuff."
(let* ((html '("<html><h1>hello!</h1>"
"<a id=\"100\"><h2>world!</h2>"
"</html>"))
(hdr (kvacons :status-code "200"
:status "Ok"
:content-type "text/html"
:content-length (format "%d" (length html))))
(hdr-hash (kvalist->hash hdr)))
(noflet ((web-http-call (method callback
:mode mode
:url url
:extra-headers headers)
;; Serve element after element of the html list
(dolist (data html)
(funcall callback :httpcon hdr-hash data))
(funcall callback :httpcon hdr-hash :done))
(elnode-http-method (httpcon) "GET")
(elnode-http-pathinfo (httpcon) "/test/one")
(elnode-http-params (httpcon) '(("x" . "1")))
(elnode-get-remote-ipaddr (httpcon) "127.0.0.1:8000")
(elnode-http-header (httpcon name) nil))
(let* ((proxy-handler (elnode-make-proxy "http://some/place"))
(result
(elnode-sink :httpcon
(fakir-mock-proc-properties :httpcon
(funcall proxy-handler :httpcon)))))
;; Test that the result is the same as the doc that the web call served
(should (equal result (s-join "" html)))
;; FIXME - we should probably also check that the
;; :elnode-child-process property has been added to the
;; :httpcon
(should
(equal
(get-text-property 0 :content-type result)
"text/html"))))))
(provide 'elnode-tests)
;;; elnode-tests.el ends here