Documentation v6 and Snippet Tests

.ci/doc/config.yml

@@ -0,0 +1,47 @@
+---
+
+snippets:
+  mount: /mnt
+  path: doc/**/snippets/*.test.yml
+  templates: /mnt/.ci/doc/templates
+
+runners:
+  default: node
+
+  node:
+    service: doc-runner-node
+    path: /var/snippets/node
+    lint:
+      global: true
+      cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }}
+      before: timeout -t 600 ash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done'
+    run:
+      cmd: node {{ snippet.source }}
+      before: timeout -t 600 ash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done'
+
+  web:
+    service: doc-runner-web
+    path: /var/snippets/web
+    lint:
+      global: true
+      cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }}/*.html
+      before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done'
+    run:
+      cmd: node puppeteer.js {{ snippet.dir }}/{{ snippet.source }}
+      before: timeout 600 bash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done'
+
+  webpack:
+    service: doc-runner-webpack
+    path: /var/snippets/webpack
+    lint:
+      global: true
+      cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }}
+      before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done'
+    build:
+      cmd: node webpackBuild.js {{ snippet.dir }}/{{ snippet.source }}
+      before: timeout 600 bash -c 'until stat /tmp/runner_is_ready; do sleep 1; done'
+    run:
+      cmd: node puppeteer.js /tmp/{{ snippet.name }}/index.html
+      before: timeout 600 bash -c 'until curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done'
+
+

.ci/doc/docker-compose.yml

@@ -0,0 +1,138 @@
+version: '3'
+
+services:
+  kuzzle:
+    image: kuzzleio/kuzzle
+    ports:
+      - '7512:7512'
+    cap_add:
+      - SYS_PTRACE
+    depends_on:
+      - redis
+      - elasticsearch
+    container_name: kuzzle
+    environment:
+      - kuzzle_services__db__client__host=http://elasticsearch:9200
+      - kuzzle_services__internalCache__node__host=redis
+      - kuzzle_services__memoryStorage__node__host=redis
+      - NODE_ENV=production
+
+  redis:
+    image: redis:3.2
+
+  elasticsearch:
+    image: kuzzleio/elasticsearch:5.6.10
+    ulimits:
+      nofile: 65536
+    environment:
+      - cluster.name=kuzzle
+      - 'ES_JAVA_OPTS=-Xms256m -Xmx256m'
+
+  doc-tests:
+    image: kuzzleio/snippets-tests
+    privileged: true
+    ports:
+      - '9229:9229'
+    depends_on:
+      - kuzzle
+      - doc-runner-node
+      - doc-runner-web
+      - doc-runner-webpack
+    volumes:
+      - ../..:/mnt
+      - /var/run/docker.sock:/var/run/docker.sock
+      - snippets:/var/snippets
+    environment:
+      - CONFIG_FILE=/mnt/.ci/doc/config.yml
+
+  doc-runner-node:
+    image: node:10-alpine
+    volumes:
+      - ../..:/mnt
+      - snippets:/var/snippets
+    command: >
+      ash -c '
+        mkdir -p /var/snippets/node;
+        apk add --no-cache curl;
+        npm install -g eslint;
+        cd /var/snippets/node;
+        npm install \
+          bluebird \
+          /mnt/ \
+          eslint \
+          eslint-plugin-html \
+          eslint-plugin-import \
+          eslint-plugin-node \
+          eslint-plugin-promise \
+          eslint-plugin-standard;
+        touch /tmp/runner_ready_to_lint;
+        touch /tmp/runner_is_ready;
+        tail -f /dev/null
+      '
+
+  doc-runner-web:
+    image: buildkite/puppeteer:latest
+    command: >
+      bash -c '
+        mkdir -p /var/snippets/web;
+        apt-get update;
+        apt-get install -y curl;
+        npm install -g \
+          eslint;
+        cd /mnt;
+        npm install;
+        cd /var/snippets/web;
+        cp /mnt/.ci/doc/puppeteer.js /var/snippets/web/;
+        npm install \
+          /mnt/ \
+          puppeteer \
+          eslint \
+          eslint-plugin-html \
+          eslint-plugin-import \
+          eslint-plugin-node \
+          eslint-plugin-promise \
+          eslint-plugin-standard;
+        touch /tmp/runner_ready_to_lint;
+        touch /tmp/runner_is_ready;
+        tail -f /dev/null
+      '
+    volumes:
+      - ../..:/mnt
+      - snippets:/var/snippets
+
+  doc-runner-webpack:
+    image: buildkite/puppeteer:latest
+    command: >
+      bash -c '
+        mkdir -p /var/snippets/webpack;
+        apt-get update;
+        apt-get install -y curl;
+        npm install -g \
+          eslint;
+        cd /var/snippets/webpack;
+        cp /mnt/.ci/doc/puppeteer.js /var/snippets/webpack/;
+        cp /mnt/.ci/doc/webpackBuild.js /var/snippets/webpack/;
+        npm install \
+          /mnt/ \
+          babel-loader \
+          @babel/core \
+          puppeteer \
+          html-webpack-plugin \
+          webpack \
+          webpack-cli \
+          eslint \
+          eslint-plugin-html \
+          eslint-plugin-import \
+          eslint-plugin-node \
+          eslint-plugin-promise \
+          eslint-plugin-standard;
+        touch /tmp/runner_ready_to_lint;
+        touch /tmp/runner_is_ready;
+        tail -f /dev/null
+      '
+    volumes:
+      - ../..:/mnt
+      - snippets:/var/snippets
+
+volumes:
+  snippets: