Add unit tests, .travis.yml, prevent leaky globals, and update docs

Author: aw

.gitmodules

@@ -2,3 +2,6 @@
 	path = vendor/neon
 	url = https://github.com/aw/neon-unofficial-mirror.git
 	ignore = dirty
+[submodule "vendor/picolisp-unit"]
+	path = vendor/picolisp-unit
+	url = https://github.com/aw/picolisp-unit.git

.travis.yml

@@ -0,0 +1,14 @@
+language: bash
+
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -y build-essential zlibc make autoconf libtool clang libxml2-dev picolisp libcurl4-openssl-dev
+
+before_script:
+  - ./build.sh
+  - wget http://software-lab.de/picoLisp.tgz -O /tmp/picolisp.tgz
+  - cd /tmp; tar -xf /tmp/picolisp.tgz
+  - cd /tmp/picoLisp/src64 && make
+
+script:
+  - cd ${TRAVIS_BUILD_DIR} && /tmp/picoLisp/pil test.l

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.30.1.6 (2015-03-24)
+
+  * Add unit tests and automated testing with travis-ci
+  * Move MODULE_INFO to module.l
+  * Update README.md
+  * Prevent leaky namespace globals
+  * Add update.sh script
+
 ## 0.30.1.5 (2015-03-17)
 
   * Version bump because it's 3am. I should sleep.

README.md

@@ -1,6 +1,6 @@
 # HTTP(S) client for PicoLisp
 
-[![GitHub release](https://img.shields.io/github/release/aw/picolisp-https.svg)](https://github.com/aw/picolisp-https) [![Dependency](https://img.shields.io/badge/[deps] Neon-0.30.1-ff69b4.svg)](https://github.com/aw/neon-unofficial-mirror)
+[![GitHub release](https://img.shields.io/github/release/aw/picolisp-https.svg)](https://github.com/aw/picolisp-https) [![Build Status](https://travis-ci.org/aw/picolisp-https.svg?branch=master)](https://travis-ci.org/aw/picolisp-https) [![Dependency](https://img.shields.io/badge/[deps] Neon-0.30.1-ff69b4.svg)](https://github.com/aw/neon-unofficial-mirror)
 
 This library can be used to make HTTP and HTTPS requests in [PicoLisp](http://picolisp.com), with support for authentication.
 
@@ -12,9 +12,10 @@ Please read [EXPLAIN.md](EXPLAIN.md) to learn more about PicoLisp and this HTTPS
   2. [Getting Started](#getting-started)
   3. [Usage](#usage)
   4. [Examples](#examples)
-  5. [Alternatives](#alternatives)
-  6. [Contributing](#contributing)
-  7. [License](#license)
+  5. [Testing](#testing)
+  6. [Alternatives](#alternatives)
+  7. [Contributing](#contributing)
+  8. [License](#license)
 
 # Requirements
 
@@ -39,9 +40,15 @@ Once compiled, the shared library is symlinked as:
 
 The `https.l` file searches for `lib/libneon.so`, relative to its current directory.
 
+### Updating
+
+This library uses git submodules, type this keep everything updated:
+
+    ./update.sh
+
 # Usage
 
-All functions are publicly accessible and namespaced with `(symbols 'https)` (or the prefix: `https~`), but only the following are necessary:
+Only the following functions are exported publicly, and namespaced with `(symbols 'https)` (or the prefix: `https~`):
 
   * **(uriparse Url)** parses a sanitized URL into its separate parts
     - `Url` _String_: a URL string to be parsed (does not encode the URL)
@@ -64,6 +71,8 @@ All functions are publicly accessible and namespaced with `(symbols 'https)` (or
     - `Filename` _String_ or _Flag (optional)_: can be a full path to a filename to store the HTTP Body content, the flag `T` to generate a random filename and store in a tmp dir (`~/.pil/tmp`), or `NIL` to return the Body in the `Response` list
   * **(req Method Url Headers Filename Body)**: performs an HTTP requeste using the `Method` you provide. The arguments to `req` are the same as the convenience methods list above.
 
+> **Note:** These functions are not namespace [local symbols](http://software-lab.de/doc/refL.html#local), which means they would redefine symbols with the same name in the `'pico` namespace
+
 ### Notes
 
   * A successful result will return a list. Failures return `NIL` or throw an `'InternalError`.
@@ -262,6 +271,12 @@ s>^J")
 " . "text/html; charset=UTF-8")) )
 ```
 
+# Testing
+
+This library now comes with full [unit tests](https://github.com/aw/picolisp-unit). To run the tests, run:
+
+    ./test.l
+
 # Alternatives
 
 The following are alternatives written in pure PicoLisp. They are limited by pipe/read syscalls and shell exec commands.

https.l

@@ -1,14 +1,14 @@
+# https.l
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 Alexander Williams, Unscramble <[email protected]>
+
 (symbols 'https 'pico)
 
-[setq MODULE_INFO
-  '(("name"       "https")
-    ("version"    "0.30.1.5")
-    ("summary"    "HTTP(S) client for PicoLisp")
-    ("source"     "https://github.com/aw/picolisp-https.git")
-    ("author"     "Alexander Williams")
-    ("license"    "MIT")
-    ("copyright"  "(c) 2015 Alexander Williams, Unscramble <[email protected]>")
-    ("install"    "build.sh") ]
+(load (pack (car (file)) "local.l"))
+
+(load (pack (car (file)) "module.l"))
 
 (setq
   *Https              (pack (car (file)) "lib/libneon.so")

local.l

@@ -0,0 +1,24 @@
+# local.l
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2015 Alexander Williams, Unscramble <[email protected]>
+
+(local MODULE_INFO *Https *Buffer_size *Headers)
+(local *NE_FEATURE_SSL *NE_FEATURE_ZLIB *NE_FEATURE_IPV6 *NE_FEATURE_LFS *NE_FEATURE_SOCKS)
+(local *NE_FEATURE_TS_SSL *NE_FEATURE_I18N *NE_FEATURE_SSPI)
+(local *NE_ABUFSIZ *NE_OK *NE_ERROR *NE_LOOKUP *NE_AUTH *NE_PROXYAUTH *NE_CONNECT)
+(local *NE_TIMEOUT *NE_FAILED *NE_RETRY *NE_REDIRECT)
+
+# ffi
+(local ne-sock-init ne-version-string ne-has-support ne-get-error ne-uri-parse ne-uri-defaultport)
+(local ne-add-request-header ne-session-create ne-ssl-trust-default-ca ne-request-create)
+(local ne-begin-request ne-end-request ne-read-response-block ne-read-response-to-fd ne-set-request-body-buffer)
+(local ne-request-destroy ne-close-connection ne-session-destroy ne-get-status ne-response-header-iterate)
+(local ne-set-server-auth ne-forget-auth)
+
+# internal
+(local throw-error create-session-request create-session parse-uri get-port set-auth-credentials)
+(local do-auth del-auth-credentials set-headers set-request-body request-dispatch download-file random-filename random-id)
+(local process-body link-response-block pack-body parse-response get-headers end-request-session end-session)
+(local begin-request end-request)

module.l

@@ -0,0 +1,10 @@
+[de MODULE_INFO
+  ("name"       "https")
+  ("version"    "0.30.1.6")
+  ("summary"    "HTTP(S) client for PicoLisp")
+  ("source"     "https://github.com/aw/picolisp-https.git")
+  ("author"     "Alexander Williams")
+  ("license"    "MIT")
+  ("copyright"  "(c) 2015 Alexander Williams, Unscramble <[email protected]>")
+  ("install"    "build.sh")
+  ("update"     "update.sh") ]

test.l

@@ -0,0 +1,8 @@
+#!/usr/bin/env pil
+
+(load "vendor/picolisp-unit/unit.l")
+
+(chdir "test/"
+  (mapcar load (filter '((N) (sub? "test_" N)) (dir "."))) )
+
+(unit~report)

test/test_https.l

@@ -0,0 +1,77 @@
+(load "../https.l")
+
+(prinl "^J  Testing HTTP(S) client for PicoLisp^J")
+
+(symbols 'https)
+
+(setq
+  *My_tests_are_order_dependent NIL
+  *Https_output (req-get "https://google.com/404" NIL T)
+  *Donate_page  (req-get "http://software-lab.de/donate.html" NIL NIL)
+  *404_page     (req-head "https://google.com/404") )
+
+[de test-uriparse-success ()
+  (unit~assert-equal  '("http" "test.url" "user:pass" 443 "/test/file.txt" "question=answer" "section")
+                      (uriparse "http://user:[email protected]:443/test/file.txt?question=answer#section")
+                      "Successfully parse a valid URI" ]
+
+[de test-uriparse-fail ()
+  (unit~assert-throws 'InternalError
+                      '(HttpsError . "Unable to parse URI")
+                      '(uriparse "http://test.url/test/[test]")
+                      "Fail to parse an invalid URI" ]
+
+[de test-get-404 ()
+  (unit~assert-includes '("Code" . 404)
+                        *Https_output
+                        "Returns a 404 error page from HTTPS request" ]
+
+[de test-get-tempfile ()
+  (unit~assert-includes '("Filename")
+                        *Https_output
+                        "Downloads the body into a temporary filename" ]
+
+[de test-get-headers ()
+  (unit~assert-kind-of  'List
+                        (cdr (assoc "Headers" *Https_output))
+                        "Returns a list of HTTP Headers" ]
+
+[de test-get-body ()
+  (unit~assert-includes '("Body")
+                        *Donate_page
+                        "Returns the body as a result (not a file) from HTTP request" ]
+
+[de test-get-url ()
+  (unit~assert-equal  '("Url" . "http://software-lab.de/donate.html")
+                      (assoc "Url" *Donate_page)
+                      "Returns the URL of the donate page for PicoLisp" ]
+
+[de test-head-nobody ()
+  (unit~assert-nil  (cdr (assoc "Body" *404_page))
+                    "HEAD requests don't return a body" ]
+
+[de test-head ()
+  (unit~assert-includes '("Code" . 404)
+                        *404_page
+                        "HEAD requests work" ]
+
+[de test-post ()
+  (unit~assert-includes '("Body")
+                        (req-post
+                          "http://requestb.in/10l0pw01"
+                          '(("Content-Type" . "application/json"))
+                          NIL
+                          "{\"Hello\":\"World\"}" )
+                        "POST requests work" ]
+
+[unit~execute
+  '(test-uriparse-success)
+  '(test-uriparse-fail)
+  '(test-get-404)
+  '(test-get-tempfile)
+  '(test-get-headers)
+  '(test-get-body)
+  '(test-get-url)
+  '(test-head-nobody)
+  '(test-head)
+  '(test-post) ]

update.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+#
+# Copyright (c) 2015 Alexander Williams, Unscramble <[email protected]>
+# MIT License
+
+set -u
+set -e
+
+git pull
+./build.sh