added HIPPOFACTS and tests

Signed-off-by: Matt Butcher <matt.butcher@microsoft.com>

Author: technosophos

HIPPOFACTS

@@ -0,0 +1,9 @@
+[bindle]
+name = "fileserver"
+version = "0.1.0"
+description = "Provides static file serving"
+
+[[handler]]
+route = "/static/..."
+name = "fileserver.gr.wasm"
+files = ["README.md", "LICENSE.txt"]

Makefile

@@ -1,6 +1,7 @@
 # These are for both `run` (implicit) and `test` (explicit)
 PATH_INFO ?= /static/fileserver.gr
 X_MATCHED_ROUTE ?= /static/...
+BINDLE_SERVER_URL ?= http://localhost:8080/v1
 
 .PHONY: run
 run:
@@ -11,9 +12,18 @@ run:
 build:
 	grain compile fileserver.gr
 
+.PHONY: test-unit
+test-unit:
+	grain tests.gr
+	
 .PHONY: test
 test:build
+test: test-unit
 test:
 	wasmtime --dir . --env PATH_INFO=${PATH_INFO} \
 	--env X_MATCHED_ROUTE=${X_MATCHED_ROUTE} \
-	fileserver.gr.wasm
+	fileserver.gr.wasm > /dev/null
+
+.PHONY: push
+push:
+	hippofactory -s ${BINDLE_SERVER_URL} .

README.md

@@ -31,6 +31,34 @@ $ make test
 
 ## Running in Wagi
 
+You have two options for running in Wagi:
+
+1. Use [hippofactory](https://github.com/deislabs/hippofactory) to build and push a bindle, then use `wagi -b $YOUR_BINDLE`
+2. Write a `modules.toml` file and use `wagi -c modules.toml`.
+
+### Using `hippofactory`
+
+Edit the `HIPPOFACTS` file to taste.
+
+To use `hippofactory`, you can just run this command from the repo root:
+
+```console
+$ hippofactory -s http://localhost:8080/v1 .
+pushed: fileserver/0.1.0-technosophos-2021.06.03.17.25.54.484
+```
+
+Then run it in Wagi like this:
+
+```console
+$ wagi -b fileserver/0.1.0-technosophos-2021.06.03.17.25.54.484 --bindle-server http://localhost:8080/v1
+[2021-06-03T23:26:54Z INFO  wagi] => Starting server on 127.0.0.1:3000
+[2021-06-03T23:26:54Z DEBUG wagi::runtime::bindle] loaded 1 modules from the default group (parcels that do not have conditions.memberOf set)
+[2021-06-03T23:26:54Z DEBUG wagi::runtime] module cache miss. Loading module parcel:fileserver/0.1.0-technosophos-2021.06.03.17.25.54.484#110f6f54401b80d9d80dae9257969468a5a70248dba8d96ce74b9bc5bc104fdd from remote.
+[2021-06-03T23:26:54Z INFO  wagi::runtime] (load_routes) instantiation time for module parcel:fileserver/0.1.0-technosophos-2021.06.03.17.25.54.484#110f6f54401b80d9d80dae9257969468a5a70248dba8d96ce74b9bc5bc104fdd: 107.802106ms
+```
+
+### Using `modules.toml`
+
 Here is an example `modules.toml` for [Wagi](https://github.com/deislabs/wagi):
 
 ```toml
@@ -42,28 +70,50 @@ volumes = {"/" = "/path/to/fileserver"}
 
 The above configures Wagi to map the path `/static/...` to the `fileserver.gr.wasm` module. Then it serves all of the files in this project.
 
+### Testing the Static Fileserver with `curl`
+
+This step is the same whether you use Bindle or a `modules.toml`.
+
 Assuming you have Wagi running on `http://localhost:3000`, you can then run this command:
 
 ```console
-$ curl -v localhost:3000/static/fileserver.gr
+$ curl -v localhost:3000/static/LICENSE.txt
 *   Trying 127.0.0.1...
 * TCP_NODELAY set
 * Connected to localhost (127.0.0.1) port 3000 (#0)
-> GET /static/fileserver.gr HTTP/1.1
+> GET /static/LICENSE.txt HTTP/1.1
 > Host: localhost:3000
 > User-Agent: curl/7.64.1
 > Accept: */*
-> 
+>
 < HTTP/1.1 200 OK
 < content-type: text/plain
-< content-length: 1522
-< date: Thu, 03 Jun 2021 16:44:05 GMT
-< 
-// This is a simple Wagi static file server.
-
-import Env from "./env"
-import Map from "map"
-// The rest of the source of fileserver.gr
+< content-length: 1104
+< date: Fri, 04 Jun 2021 00:16:14 GMT
+<
+The MIT License (MIT)
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE
+* Connection #0 to host localhost left intact
+* Closing connection 0
 ```
 
 The fileserver took `/static/filserver.gr`, removed the `/static/` part from the front, and then loaded `fileserver.gr` from the directory mounted in the `modules.toml`. Note that any subdirectories are also served. So `/static/foo/bar` would translate to the path `foo/bar` inside of the WebAssembly module (which in the example above would fully resolve to "/path/to/fileserver/foo/bar").

env.gr

@@ -7,7 +7,7 @@ import Option from "option"
 // Split an environment variable at the first equals sign.
 // @param item: An environment variable pair, separated by an equals sign (=).
 // @return (String, String) A tuple key/value pair.
-let splitEnvVar = (item) => {
+export let splitEnvVar = (item) => {
     let offsetOpt = String.indexOf("=", item)
 
     // For now, fail if the env var is malformed.

fileserver.gr

@@ -7,7 +7,7 @@ import File from "sys/file"
 import String from "string"
 
 let serve = (path) => {
-    File.fdWrite(File.stderr, "Loading file ")
+    File.fdWrite(File.stderr, "Fileserver: Loading file ")
     File.fdWrite(File.stderr, path)
     File.fdWrite(File.stderr, "\n")
 

mediatype.gr

@@ -0,0 +1,113 @@
+import String from "string"
+import Array from "array"
+import Option from "option"
+import Map from "map"
+import {lastIndexOf, reverse} from "./stringutil"
+
+let default_mt = "application/octet-stream"
+let mut mediatypes = Map.make()
+
+// Text formats
+Map.set("txt", "text/plain", mediatypes)
+Map.set("md", "text/plain", mediatypes)
+Map.set("mdown", "text/plain", mediatypes)
+Map.set("htm", "text/html", mediatypes)
+Map.set("html", "text/html", mediatypes)
+Map.set("xhtml", "application/xhtml+xml", mediatypes)
+Map.set("xml", "application/xml", mediatypes)
+Map.set("css", "text/css", mediatypes)
+Map.set("ics", "text/calendar", mediatypes)
+
+// Serialization formats
+Map.set("json", "application/json", mediatypes)
+Map.set("jsonld", "application/ld+json", mediatypes)
+Map.set("toml", "application/toml", mediatypes)
+Map.set("yaml", "application/yaml", mediatypes)
+
+// Applications
+// According to MSDN, prefered is text/javascript
+Map.set("js", "text/javascript", mediatypes)
+Map.set("mjs", "text/javascript", mediatypes)
+Map.set("wasm", "application/wasm", mediatypes)
+Map.set("csv", "text/csv", mediatypes)
+Map.set("sh", "application/x-sh", mediatypes)
+
+// Images
+Map.set("apng", "image/apng", mediatypes)
+Map.set("avif", "image/avif", mediatypes)
+Map.set("png", "image/png", mediatypes)
+Map.set("png", "image/png", mediatypes)
+Map.set("jpg", "image/jpeg", mediatypes)
+Map.set("jpeg", "image/jpeg", mediatypes)
+Map.set("pjpeg", "image/jpeg", mediatypes)
+Map.set("pjp", "image/jpeg", mediatypes)
+Map.set("jfif", "image/jpeg", mediatypes)
+Map.set("gif", "image/gif", mediatypes)
+Map.set("tif", "image/tiff", mediatypes)
+Map.set("tiff", "image/tiff", mediatypes)
+Map.set("webp", "image/webp", mediatypes)
+Map.set("svg", "image/svg+xml", mediatypes)
+Map.set("bmp", "image/bmp", mediatypes)
+Map.set("ico", "image/vnd.microsoft.icon", mediatypes)
+
+// Audio/Video
+Map.set("aac", "audio/aac", mediatypes)
+Map.set("avi", "video/x-msvideo", mediatypes)
+Map.set("wav", "audio/wave", mediatypes)
+Map.set("webm", "video/webm", mediatypes)
+Map.set("mp3", "audio/mpeg", mediatypes)
+Map.set("mp4", "video/mp4", mediatypes)
+Map.set("mpeg", "video/mpeg", mediatypes)
+Map.set("oga", "audio/ogg", mediatypes)
+Map.set("ogv", "video/ogg", mediatypes)
+Map.set("ogx", "application/ogg", mediatypes)
+Map.set("ts", "video/mp2t", mediatypes)
+
+// Compressed
+Map.set("bz2", "application/x-bzip2", mediatypes)
+Map.set("tbz", "application/x-bzip2", mediatypes)
+Map.set("tbz2", "application/x-bzip2", mediatypes)
+Map.set("gz", "application/gzip", mediatypes)
+Map.set("rar", "application/vnd.rar", mediatypes)
+Map.set("tar", "text/x-tar", mediatypes)
+Map.set("tgz", "application/gzip", mediatypes)
+Map.set("jar", "application/java-archive", mediatypes)
+Map.set("mpkg", "application/vnd.apple.installer+xml", mediatypes)
+Map.set("zip", "application/zip", mediatypes)
+Map.set("7z", "application/x-7z-compressed", mediatypes)
+
+// Binary
+Map.set("azw", "application/vnd.amazon.ebook", mediatypes)
+Map.set("bin", "application/octet-stream", mediatypes)
+Map.set("doc", "application/msword", mediatypes)
+Map.set("docx", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", mediatypes)
+Map.set("epub", "application/epub+zip", mediatypes)
+Map.set("odp", "application/vnd.oasis.opendocument.presentation", mediatypes)
+Map.set("ods", "application/vnd.oasis.opendocument.spreadsheet", mediatypes)
+Map.set("odt", "application/vnd.oasis.opendocument.text", mediatypes)
+Map.set("pdf", "application/pdf", mediatypes)
+Map.set("ppt", "application/vnd.ms-powerpoint", mediatypes)
+Map.set("pptx", "application/vnd.openxmlformats-officedocument.presentationml.presentation", mediatypes)
+Map.set("rtf", "application/rtf", mediatypes)
+Map.set("vsd", "application/vnd.visio", mediatypes)
+Map.set("xls", "application/vnd.ms-excel", mediatypes)
+Map.set("xlsx", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", mediatypes)
+
+// Fonts
+Map.set("eot", "application/vnd.ms-fontobject", mediatypes)
+Map.set("otf", "font/otf", mediatypes)
+Map.set("ttf", "font/ttf", mediatypes)
+Map.set("woff", "font/woff", mediatypes)
+Map.set("woff2", "font/woff2", mediatypes)
+
+// Guess the media type of this file
+// @param filename: The name of the file
+export let guess = (filename: String) => {
+    match (lastIndexOf(".", filename)) {
+        Some(extOffset) => {
+            let ext = String.slice(extOffset + 1, String.length(filename), filename)
+            Option.unwrapWithDefault(default_mt, Map.get(ext, mediatypes))
+        },
+        None => default_mt
+    }
+}

stringutil.gr

@@ -0,0 +1,25 @@
+import String from "string"
+import Array from "array"
+
+// Return a String that is the reverse of the given String.
+export let reverse = (str: String) => {
+    let chars = String.explode(str)
+    let clen = Array.length(chars)
+    let rev = Array.init(clen, (index) => {
+        let last = clen - index - 1
+        chars[last]
+    })
+    String.implode(rev)
+}
+
+// Get the index of the last appearance of needle in the haystack.
+// @param needle: The string to search for
+// @param haystack: The string to be searched
+export let lastIndexOf = (needle: String, haystack: String) => {
+    let rev = reverse(haystack)
+    let i = String.indexOf(needle, rev)
+    match (i) {
+        Some(offset) => Some(String.length(haystack) - 1 - offset),
+        None => None,   
+    }
+}

tests.gr

@@ -0,0 +1,40 @@
+import Env from "./env"
+import Util from "./stringutil"
+import String from "string"
+import Process from "sys/process"
+import File from "sys/file"
+
+let mut totalErr = 0
+
+let check = (a, b, msg: String) => {
+    match (a == b) {
+        true => Ok(String.concat("✅ PASS\t\t", msg)),
+        _  => {
+            totalErr += 1
+            Err(String.concat("⛔️ FAIL\t\t", msg))
+        }
+    }
+}
+
+let expect = (a, b, msg: String) => {
+    match (check(a, b, msg)) {
+        Ok(yay) => print(yay),
+        Err(e) => print(e)
+    }
+}
+
+let report = () => {
+    if (totalErr > 0) {
+        File.fdWrite(File.stderr, "❌ Total failed tests: ")
+        File.fdWrite(File.stderr, toString(totalErr))
+        File.fdWrite(File.stderr, "❌\n")
+        Process.exit(1)
+    }
+}
+
+expect(("a", "b"), Env.splitEnvVar("a=b"), "Env.splitEnvVar should parse")
+expect("gfedcba", Util.reverse("abcdefg"), "Util.reverse should reverse string")
+expect(Some(5), Util.lastIndexOf("..", "aaaa.."), "UtillastIndexOf should find Some")
+expect(None, Util.lastIndexOf("??", "aaaa.."), "Util.lastIndexOf should find None")
+
+report()