Merge pull request #15 from dpordomingo/master

Add CI, docs and fix integration tests

Author: dpordomingo

.dockerignore

@@ -0,0 +1,3 @@
+/node_modules
+/vendor
+/repos

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+All activities under source{d} projects are governed by the [source{d} code of conduct](https://github.com/src-d/guide/blob/master/.github/CODE_OF_CONDUCT.md).

.github/DCO

@@ -0,0 +1,36 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.

.github/screenshot.png

@@ -0,0 +1,52 @@
+language: go
+
+services:
+  - docker
+
+go:
+  - "1.10.x"
+
+before_install:
+  - . $HOME/.nvm/nvm.sh
+  - nvm install 8
+  - nvm use 8
+  - npm install -g yarn
+
+install:
+  - make dependencies
+
+stages:
+  - name: validate and build
+  - name: release to github
+    if: tag IS present
+  - name: push to dockerhub
+    if: tag IS present
+
+jobs:
+  include:
+    # validate and build
+    - stage: validate and build
+      script:
+        - make test
+        - make lint
+        - make coverage
+        - make validate-commit
+    - script:
+        - make packages
+    # release to github
+    - stage: release to github
+      script:
+        - make packages
+      deploy:
+        provider: releases
+        api_key: $GITHUB_TOKEN
+        file_glob: true
+        file: build/*.tar.gz
+        skip_cleanup: true
+        on:
+          all_branches: true
+    # push to dockerhub
+    - stage: push to dockerhub
+      script:
+        - PKG_OS=linux make build
+        - DOCKER_PUSH_LATEST=true make docker-push

.travis.yml

@@ -0,0 +1,7 @@
+FROM alpine:3.7
+ADD ./build/bin /bin
+
+RUN apk --update upgrade && \
+    apk add --no-cache ca-certificates
+
+ENTRYPOINT ["/bin/gitbase-playground"]

Dockerfile

@@ -0,0 +1,114 @@
+# Package configuration
+PROJECT := gitbase-playground
+COMMANDS := cmd/gitbase-playground
+DOCKER_ORG := src-d
+DEPENDENCIES := \
+	github.com/golang/dep/cmd/dep \
+	github.com/jteeuwen/go-bindata \
+	github.com/golang/lint/golint
+GO_LINTABLE_PACKAGES := $(shell go list ./... | grep -v '/vendor/')
+GO_BUILD_ENV := CGO_ENABLED=0
+
+# Tools
+GODEP := dep
+GOLINT := golint
+GOVET := go vet
+BINDATA := go-bindata
+DIFF := diff
+
+# Default rule
+all:
+
+# Including ci Makefile
+CI_REPOSITORY ?= https://github.com/dpordomingo/ci.git
+CI_BRANCH ?= v1
+CI_PATH ?= $(shell pwd)/.ci
+MAKEFILE := $(CI_PATH)/Makefile.main
+$(MAKEFILE):
+	@git clone --quiet --depth 1 -b $(CI_BRANCH) $(CI_REPOSITORY) $(CI_PATH);
+-include $(MAKEFILE)
+
+# Makefile.main::dependencies -> Makefile.main::$(DEPENDENCIES) -> this::dependencies
+# The `exit` is needed to prevent running `Makefile.main::dependencies` commands.
+dependencies: | front-dependencies back-dependencies exit
+
+# Makefile.main::test -> this::test
+test: front-test
+
+# this::build -> Makefile.main::build -> Makefile.main::$(COMMANDS)
+# The @echo forces this prerequisites to be run before `Makefile.main::build` ones.
+build: front-build back-build
+	@echo
+
+coverage: | test-coverage codecov
+
+lint: back-lint front-lint
+
+validate-commit: | \
+	back-dependencies \
+	back-ensure-assets-proxy \
+	front-fix-lint-errors \
+	no-changes-in-commit
+
+exit:
+	exit 0;
+
+
+## Compiles the assets, and serve the tool through its API
+
+serve: | front-build back-start
+
+
+# Backend
+
+assets := ./server/assets/asset.go
+assets_back := $(assets).bak
+
+back-dependencies:
+	$(GODEP) ensure
+
+back-build: back-bindata
+
+back-bindata:
+	$(BINDATA) \
+		-pkg assets \
+		-o $(assets) \
+		build/public/*
+
+back-lint: $(GO_LINTABLE_PACKAGES)
+$(GO_LINTABLE_PACKAGES):
+	$(GOLINT) $@
+	$(GOVET) $@
+
+back-start:
+	GITBASEPG_ENV=dev go run cmd/gitbase-playground/main.go
+
+back-ensure-assets-proxy:
+	$(DIFF) $(assets) $(assets_back) || exit 1
+
+go-test-integration-packages := ./server/handler
+go-test-integration-flags := -v -args -test.integration.gitbase -test.integration.bblfshd
+back-test-integration:
+	go test $(go-test-integration-packages) $(go-test-integration-flags)
+
+
+# Frontend
+
+front-dependencies:
+	echo 'SKIP. no frontend dependencies to install'
+
+front-test:
+	echo 'SKIP. no frontend tests to run'
+
+front-lint:
+	echo 'SKIP. no frontend linters to run'
+
+front-build:
+	mkdir -p build/public
+	cp public/index.html build/public/index.html
+	cp public/secondary.html build/public/secondary.html
+
+front-fix-lint-errors:
+	echo 'SKIP. no fixable code'
+
+

Makefile

@@ -1,49 +1,61 @@
-## Development
+[![Build Status](https://travis-ci.org/src-d/gitbase-playground.svg)](https://travis-ci.org/src-d/gitbase-playground)
+[![codecov.io](https://codecov.io/github/src-d/gitbase-playground/coverage.svg)](https://codecov.io/github/src-d/gitbase-playground)
+![unstable](https://svg-badge.appspot.com/badge/stability/unstable?a)
 
-### Dependencies
+# Gitbase Playground
 
-Launch [bblfshd](https://github.com/bblfsh/bblfshd) and install the drivers. More info in the [bblfshd documentation](https://doc.bblf.sh/user/getting-started.html).
+Web application to query git repositories using SQL. Powered by [gitbase](https://github.com/src-d/gitbase).
 
-```bash
-docker run -d --name bblfshd --privileged -p 9432:9432 -v /var/lib/bblfshd:/var/lib/bblfshd bblfsh/bblfshd
-docker exec -it bblfshd bblfshctl driver install --all
-```
+![Screenshot](.github/screenshot.png?raw=true)
 
-Install [gitbase](https://github.com/src-d/gitbase), populate a repository directory, and start it.
 
-```bash
-go get github.com/src-d/gitbase/...
-cd $GOPATH/src/github.com/src-d/gitbase
-make dependencies
-mkdir repos
-git clone https://github.com/src-d/gitbase-playground.git repos/gitbase-playground
-go run cli/gitbase/main.go server -v --git=repos
-```
+# Usage
 
-### Build
+## Dependencies
 
-```bash
-go build -o gitbase-playground cmd/server/main.go
-```
+The playground will run the queries against a [gitbase](https://github.com/src-d/gitbase) server, and will request UASTs to a [bblfsh](https://doc.bblf.sh/) server; both should be accessible for the playground; you can check its default [configuration values](docs/CONTRIBUTING.md#configuration).
 
-### Run
 
-Use `GITBASEPG_ENV=dev` for extra logs information.
+## Run the Playground
 
-Development:
+You can run the app from a docker image, a released binary or installing and building the project.
 
-```bash
-GITBASEPG_ENV=dev go run cmd/server/main.go
-```
+Once the server is running –with its default values–, it will be accessible through: http://localhost:8080
 
-Built binary:
+Read [more about how to run bblfsh and gitbase dependencies](docs/quickstart.md).
+
+### Run with Docker
 
 ```bash
-GITBASEPG_ENV=dev ./gitbase-playground
+$ docker run -d
+    --publish 8080:8080
+    --link gitbase
+    --env GITBASEPG_ENV=dev
+    --env GITBASEPG_DB_CONNECTION="gitbase@tcp(gitbase:3306)/none?maxAllowedPacket=4194304"
+    --name gitbasePlayground
+    src-d/gitbase-playground:latest
 ```
 
-### Run the Tests
+
+### Run the Binary
+
+Download a binary from our [releases section](https://github.com/src-d/gitbase-playground/releases), and run it:
 
 ```bash
-go test -v server/handler/*
+$ /download/path/gitbase-playground
 ```
+
+
+# Contribute
+
+[Contributions](https://github.com/src-d/gitbase-playground/issues) are more than welcome, if you are interested please take a look to our [Contributing Guidelines](docs/CONTRIBUTING.md). You have more information on how to run it locally for [development purposes here](docs/CONTRIBUTING.md#development).
+
+
+# Code of Conduct
+
+All activities under source{d} projects are governed by the [source{d} code of conduct](https://github.com/src-d/guide/blob/master/.github/CODE_OF_CONDUCT.md).
+
+
+## License
+
+GPL v3.0, see [LICENSE](LICENSE)

README.md

@@ -27,7 +27,7 @@ type appConfig struct {
 	Host      string `envconfig:"HOST" default:"0.0.0.0"`
 	Port      int    `envconfig:"PORT" default:"8080"`
 	ServerURL string `envconfig:"SERVER_URL"`
-	DBConn    string `envconfig:"DB_CONNECTION" default:"root@tcp(localhost:3306)/none?maxAllowedPacket=4194304"`
+	DBConn    string `envconfig:"DB_CONNECTION" default:"gitbase@tcp(localhost:3306)/none?maxAllowedPacket=4194304"`
 }
 
 func main() {