Merge pull request #1 from erizocosmico/feature/driver

Implement typescript native driver

Author: Miguel Molina

.travis.yml

@@ -0,0 +1,18 @@
+language: go
+
+go:
+  - 1.8
+
+services:
+  - docker
+
+before_script:
+  - go get -v github.com/bblfsh/sdk/...
+  - bblfsh-sdk prepare-build .
+  - go get -v -t ./...
+
+script:
+  - make test
+
+after_success:
+  - make push

Dockerfile

@@ -0,0 +1,12 @@
+# Dockerfile represents the container being use to run the driver, should be
+# small as possible containing strictly only the tools required to run the
+# driver.
+
+# The prefered base image is the lastest stable Alpine image, if alpine doesn't
+# meet the requirements you can switch the from to the latest stable slim
+# version of Debian (eg.: `debian:jessie-slim`). If the excution environment
+# is equals to the build environment the build image can be use as FROM:
+#   bblfsh/<language>-driver-build
+FROM bblfsh/typescript-driver-build
+
+CMD /opt/driver/bin/driver

Dockerfile.build

@@ -0,0 +1,27 @@
+# Dockerfile.build represents the build environment of the driver, used during
+# the development phase to test and in CI to build and test.
+
+# The prefered base image is the lastest stable Alpine image, if alpine doesn't
+# meet the requirements you can switch the from to the latest stable slim
+# version of Debian (eg.: `debian:jessie-slim`).
+FROM node:7-alpine
+
+# To avoid files written in the volume by root or foreign users, we create a
+# container local user with the same UID of the user executing the build.
+# The following commands are defined to use in busybox based distributions,
+# if you are using a standard distributions, replace the `adduser` command with:
+#   `useradd --uid ${BUILD_UID} --home /opt/driver ${BUILD_USER}`
+RUN mkdir -p /opt/driver/src && \
+    adduser ${BUILD_USER} -u ${BUILD_UID} -D -h /opt/driver/src
+
+
+# As minimal build tools you need: make, curl and git, install using the same
+# command the specific tools required to build the driver.
+RUN apk add --no-cache make git curl ca-certificates
+RUN apk add
+
+RUN npm install -g yarn
+
+# The volume with the full source code is mounted at `/opt/driver/src` so, we
+# set the workdir to this path.
+WORKDIR /opt/driver/src

Dockerfile.build.tpl

@@ -0,0 +1,25 @@
+# Dockerfile.build represents the build environment of the driver, used during
+# the development phase to test and in CI to build and test.
+
+# The prefered base image is the lastest stable Alpine image, if alpine doesn't
+# meet the requirements you can switch the from to the latest stable slim
+# version of Debian (eg.: `debian:jessie-slim`).
+FROM alpine:3.5
+
+# To avoid files written in the volume by root or foreign users, we create a
+# container local user with the same UID of the user executing the build.
+# The following commands are defined to use in busybox based distributions,
+# if you are using a standard distributions, replace the `adduser` command with:
+#   `useradd --uid ${BUILD_UID} --home /opt/driver ${BUILD_USER}`
+RUN mkdir -p /opt/driver/src && \
+    adduser ${BUILD_USER} -u ${BUILD_UID} -D -h /opt/driver/src
+
+
+# As minimal build tools you need: make, curl and git, install using the same
+# command the specific tools required to build the driver.
+RUN apk add --no-cache make git curl ca-certificates
+
+
+# The volume with the full source code is mounted at `/opt/driver/src` so, we
+# set the workdir to this path.
+WORKDIR /opt/driver/src

Dockerfile.tpl

@@ -0,0 +1,12 @@
+# Dockerfile represents the container being use to run the driver, should be
+# small as possible containing strictly only the tools required to run the
+# driver.
+
+# The prefered base image is the lastest stable Alpine image, if alpine doesn't
+# meet the requirements you can switch the from to the latest stable slim
+# version of Debian (eg.: `debian:jessie-slim`). If the excution environment
+# is equals to the build environment the build image can be use as FROM:
+#   bblfsh/<language>-driver-build
+FROM alpine:3.5
+
+CMD /opt/driver/bin/driver

Makefile

@@ -0,0 +1,13 @@
+include .sdk/Makefile
+
+test-native:
+	cd native; \
+	echo "yarn test"
+
+build-native:
+	cd native; \
+	yarn install; \
+	cp *.js $(BUILD_PATH); \
+	mv node_modules $(BUILD_PATH); \
+	mv $(BUILD_PATH)/index.js $(BUILD_PATH)/native; \
+	chmod +x $(BUILD_PATH)/native

README.md

@@ -0,0 +1,27 @@
+# typescript-driver  ![Driver Status](https://img.shields.io/badge/status-pre--alpha-d6ae86.svg) [![Build Status](https://travis-ci.org/bblfsh/typescript-driver.svg?branch=master)](https://travis-ci.org/bblfsh/typescript-driver) ![Native Version](https://img.shields.io/badge/typescript%20version-2.2.1-aa93ea.svg) ![Go Version](https://img.shields.io/badge/go%20version-1.8-63afbf.svg)
+
+typescript driver for [babelfish](https://github.com/bblfsh/server).
+
+
+Development Environment
+-----------------------
+
+Requirements:
+- `docker`
+- [`bblfsh-sdk`](https://github.com/bblfsh/sdk) _(go get -u github.com/bblfsh/sdk/...)_
+
+To initialize the build system execute: `bblfsh-sdk prepare-build`, at the root of the project. This will install the SDK at `.sdk` for this driver.
+
+To execute the tests just execute `make test`, this will execute the test over the native and the go components of the driver. Use `make test-native` to run the test only over the native component or `make test-driver` to run the test just over the go component.
+
+The build is done executing `make build`. To evaluate the result, a docker container, execute:
+`docker run -it bblfsh/typescript-driver:dev-<commit[:6]>`
+
+
+License
+-------
+
+GPLv3, see [LICENSE](LICENSE)
+
+
+

driver/main.go

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/bblfsh/sdk"
+
+	_ "github.com/bblfsh/typescript-driver/driver/normalizer"
+)
+
+var version string
+var build string
+
+func main() {
+	fmt.Printf("version: %s\nbuild: %s\n", version, build)
+
+	_, err := os.Stat(sdk.NativeBin)
+	if err == nil {
+		fmt.Println("native: ok")
+		return
+	}
+
+	fmt.Printf("native: %s\n", err)
+}

driver/normalizer/normalizer.go

@@ -0,0 +1 @@
+package normalizer

driver/normalizer/normalizer_test.go

@@ -0,0 +1,23 @@
+package normalizer
+
+import (
+	"os/exec"
+	"testing"
+	"time"
+
+	"github.com/bblfsh/sdk"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNativeBinary(t *testing.T) {
+	r := require.New(t)
+
+	cmd := exec.Command(sdk.NativeBinTest)
+	err := cmd.Start()
+	r.Nil(err)
+
+	time.Sleep(time.Second)
+	err = cmd.Process.Kill()
+	r.Nil(err)
+}

manifest.toml

@@ -0,0 +1,30 @@
+# Manifest contains metadata about the driver. To learn about the different
+# values in this manifest refer to:
+#   https://github.com/bblfsh/sdk/blob/master/manifest/manifest.go
+
+language = "typescript"
+
+# status describes the current development status of the driver, the valid
+# values for status are: `planning`, `pre-alpha`, `alpha`, `beta`, `stable`,
+# `mature` or `inactive`.
+status = "pre-alpha"
+
+# documentation block is use to render the README.md file.
+[documentation]
+description  = """
+typescript driver for [babelfish](https://github.com/bblfsh/server).
+"""
+
+[runtime]
+# os defines in with distribution the runtime is executed (and the build
+# system). The valid values are `alpine` and `debian`. Alpine is preferred
+# since is a micro-distribution, but sometimes is hard or impossible to use
+# due to be based on musl and not it libc.
+os = "alpine"
+
+# go_version describes the version being use to build the driver Go code.
+go_version = "1.8"
+
+# native_version describes the version or versions being use to build and
+# execute the native code, you should define at least one. (eg.: "1.8").
+native_version = ["2.2.1"]

native/Dockerfile

@@ -0,0 +1,10 @@
+FROM node:6.10-alpine
+
+RUN mkdir -p /opt/node
+ADD . /opt/node
+
+WORKDIR /opt/node
+RUN yarn install
+
+CMD node /opt/node/src/index.js
+

native/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "typescript-driver",
+  "version": "1.0.0",
+  "description": "TypeScript babelfish driver",
+  "main": "src/index.js",
+  "repository": "https://github.com/bblfsh/typescript-driver",
+  "author": "Miguel Molina <[email protected]>",
+  "license": "GPLv3",
+  "dependencies": {
+    "typescript": "^2.2.1"
+  },
+  "ava": {
+    "files": ["test/*.js"]
+  },
+  "scripts": {
+    "start": "node src/index.js",
+    "test": "ava -v"
+  },
+  "devDependencies": {
+    "ava": "^0.18.2"
+  }
+}

native/src/index.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+'use strict';
+
+const { processRequest } = require('./parse');
+const readline = require('readline');
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+  terminal: false
+});
+
+rl.on('line', l => console.log(processRequest(l)));