dockerise app, 1.1.3 build scripts

This commit is contained in:
Henry Oswald 2018-05-23 11:01:07 +01:00
parent 0fec876f99
commit 4936e00b73
12 changed files with 234 additions and 47 deletions

View file

@ -0,0 +1,9 @@
node_modules/*
gitrev
.git
.gitignore
.npm
.nvmrc
nodemon.json
app.js
**/js/*

View file

@ -0,0 +1,22 @@
FROM node:6.14.1 as app
WORKDIR /app
#wildcard as some files may not be in all repos
COPY package*.json npm-shrink*.json /app/
RUN npm install --quiet
COPY . /app
RUN npm run compile:all
FROM node:6.14.1
COPY --from=app /app /app
WORKDIR /app
USER node
CMD ["node","app.js"]

View file

@ -1,58 +1,42 @@
String cron_string = BRANCH_NAME == "master" ? "@daily" : ""
pipeline { pipeline {
agent any
agent {
docker {
image 'node:6.14.1'
args "-v /var/lib/jenkins/.npm:/tmp/.npm"
}
}
environment {
HOME = "/tmp"
}
triggers { triggers {
pollSCM('* * * * *') pollSCM('* * * * *')
cron('@daily') cron(cron_string)
} }
stages { stages {
stage('Set up') { stage('Build') {
steps { steps {
// we need to disable logallrefupdates, else git clones during the npm install will require git to lookup the user id sh 'make build'
// which does not exist in the container's /etc/passwd file, causing the clone to fail.
sh 'git config --global core.logallrefupdates false'
} }
} }
stage('Install') {
stage('Unit Tests') {
steps { steps {
sh 'rm -fr node_modules' sh 'DOCKER_COMPOSE_FLAGS="-f docker-compose.ci.yml" make test_unit'
sh 'npm install'
sh 'npm rebuild'
sh 'npm install --quiet grunt-cli'
} }
} }
stage('Compile') {
stage('Acceptance Tests') {
steps { steps {
sh 'node_modules/.bin/grunt install' sh 'DOCKER_COMPOSE_FLAGS="-f docker-compose.ci.yml" make test_acceptance'
} }
} }
stage('Test') {
stage('Package and publish build') {
steps { steps {
sh 'NODE_ENV=development node_modules/.bin/grunt test:unit' sh 'make publish'
} }
} }
stage('Package') {
steps { stage('Publish build number') {
sh 'echo ${BUILD_NUMBER} > build_number.txt'
sh 'touch build.tar.gz' // Avoid tar warning about files changing during read
sh 'tar -czf build.tar.gz --exclude=build.tar.gz --exclude-vcs .'
}
}
stage('Publish') {
steps { steps {
sh 'echo ${BRANCH_NAME}-${BUILD_NUMBER} > build_number.txt'
withAWS(credentials:'S3_CI_BUILDS_AWS_KEYS', region:"${S3_REGION_BUILD_ARTEFACTS}") { withAWS(credentials:'S3_CI_BUILDS_AWS_KEYS', region:"${S3_REGION_BUILD_ARTEFACTS}") {
s3Upload(file:'build.tar.gz', bucket:"${S3_BUCKET_BUILD_ARTEFACTS}", path:"${JOB_NAME}/${BUILD_NUMBER}.tar.gz")
// The deployment process uses this file to figure out the latest build // The deployment process uses this file to figure out the latest build
s3Upload(file:'build_number.txt', bucket:"${S3_BUCKET_BUILD_ARTEFACTS}", path:"${JOB_NAME}/latest") s3Upload(file:'build_number.txt', bucket:"${S3_BUCKET_BUILD_ARTEFACTS}", path:"${JOB_NAME}/latest")
} }
@ -61,6 +45,10 @@ pipeline {
} }
post { post {
always {
sh 'DOCKER_COMPOSE_FLAGS="-f docker-compose.ci.yml" make test_clean'
}
failure { failure {
mail(from: "${EMAIL_ALERT_FROM}", mail(from: "${EMAIL_ALERT_FROM}",
to: "${EMAIL_ALERT_TO}", to: "${EMAIL_ALERT_TO}",

View file

@ -0,0 +1,42 @@
# This file was auto-generated, do not edit it directly.
# Instead run bin/update_build_scripts from
# https://github.com/sharelatex/sharelatex-dev-environment
# Version: 1.1.3
BUILD_NUMBER ?= local
BRANCH_NAME ?= $(shell git rev-parse --abbrev-ref HEAD)
PROJECT_NAME = contacts
DOCKER_COMPOSE_FLAGS ?= -f docker-compose.yml
DOCKER_COMPOSE := BUILD_NUMBER=$(BUILD_NUMBER) \
BRANCH_NAME=$(BRANCH_NAME) \
PROJECT_NAME=$(PROJECT_NAME) \
MOCHA_GREP=${MOCHA_GREP} \
docker-compose ${DOCKER_COMPOSE_FLAGS}
clean:
rm -f app.js
rm -rf app/js
rm -rf test/unit/js
rm -rf test/acceptance/js
test: test_unit test_acceptance
test_unit:
@[ ! -d test/unit ] && echo "contacts has no unit tests" || $(DOCKER_COMPOSE) run --rm test_unit
test_acceptance: test_clean test_acceptance_pre_run # clear the database before each acceptance test run
@[ ! -d test/acceptance ] && echo "contacts has no acceptance tests" || $(DOCKER_COMPOSE) run --rm test_acceptance
test_clean:
$(DOCKER_COMPOSE) down -v -t 0
test_acceptance_pre_run:
@[ ! -f test/acceptance/scripts/pre-run ] && echo "contacts has no pre acceptance tests task" || $(DOCKER_COMPOSE) run --rm test_acceptance test/acceptance/scripts/pre-run
build:
docker build --pull --tag gcr.io/csh-gcdm-test/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER) .
publish:
docker push gcr.io/csh-gcdm-test/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
.PHONY: clean test test_unit test_acceptance test_clean build publish

View file

@ -30,6 +30,11 @@ app.use (error, req, res, next) ->
port = Settings.internal.contacts.port port = Settings.internal.contacts.port
host = Settings.internal.contacts.host host = Settings.internal.contacts.host
if !module.parent # Called directly
app.listen port, host, (error) -> app.listen port, host, (error) ->
throw error if error? throw error if error?
logger.info "contacts starting up, listening on #{host}:#{port}" logger.info "contacts starting up, listening on #{host}:#{port}"
module.exports = app

View file

@ -0,0 +1,32 @@
# This file was auto-generated, do not edit it directly.
# Instead run bin/update_build_scripts from
# https://github.com/sharelatex/sharelatex-dev-environment
# Version: 1.1.3
version: "2"
services:
test_unit:
image: gcr.io/csh-gcdm-test/$PROJECT_NAME:$BRANCH_NAME-$BUILD_NUMBER
user: node
command: npm run test:unit:_run
test_acceptance:
build: .
image: gcr.io/csh-gcdm-test/$PROJECT_NAME:$BRANCH_NAME-$BUILD_NUMBER
environment:
REDIS_HOST: redis
MONGO_HOST: mongo
POSTGRES_HOST: postgres
depends_on:
- mongo
- redis
user: node
command: npm run test:acceptance:_run
redis:
image: redis
mongo:
image: mongo:3.4

View file

@ -0,0 +1,39 @@
# This file was auto-generated, do not edit it directly.
# Instead run bin/update_build_scripts from
# https://github.com/sharelatex/sharelatex-dev-environment
# Version: 1.1.3
version: "2"
services:
test_unit:
build: .
volumes:
- .:/app
working_dir: /app
environment:
MOCHA_GREP: ${MOCHA_GREP}
command: npm run test:unit
user: node
test_acceptance:
build: .
volumes:
- .:/app
working_dir: /app
environment:
REDIS_HOST: redis
MONGO_HOST: mongo
POSTGRES_HOST: postgres
MOCHA_GREP: ${MOCHA_GREP}
user: node
depends_on:
- mongo
- redis
command: npm run test:acceptance
redis:
image: redis
mongo:
image: mongo:3.4

View file

@ -0,0 +1,19 @@
{
"ignore": [
".git",
"node_modules/"
],
"verbose": true,
"legacyWatch": true,
"execMap": {
"js": "npm run start"
},
"watch": [
"app/coffee/",
"app.coffee",
"config/"
],
"ext": "coffee"
}

View file

@ -8,8 +8,16 @@
"url": "https://github.com/sharelatex/contacts-sharelatex.git" "url": "https://github.com/sharelatex/contacts-sharelatex.git"
}, },
"scripts": { "scripts": {
"compile:app": "coffee -o app/js -c app/coffee && coffee -c app.coffee", "compile:app": "([ -e app/coffee ] && coffee $COFFEE_OPTIONS -o app/js -c app/coffee || echo 'No CoffeeScript folder to compile') && ( [ -e app.coffee ] && coffee $COFFEE_OPTIONS -c app.coffee || echo 'No CoffeeScript app to compile')",
"start": "npm run compile:app && node app.js" "start": "npm run compile:app && node $NODE_APP_OPTIONS app.js",
"test:acceptance:_run": "mocha --recursive --reporter spec --timeout 15000 --exit $@ test/acceptance/js",
"test:acceptance": "npm run compile:app && npm run compile:acceptance_tests && npm run test:acceptance:_run -- --grep=$MOCHA_GREP",
"test:unit:_run": "mocha --recursive --reporter spec $@ test/unit/js",
"test:unit": "npm run compile:app && npm run compile:unit_tests && npm run test:unit:_run -- --grep=$MOCHA_GREP",
"compile:unit_tests": "[ ! -e test/unit/coffee ] && echo 'No unit tests to compile' || coffee -o test/unit/js -c test/unit/coffee",
"compile:acceptance_tests": "[ ! -e test/acceptance/coffee ] && echo 'No acceptance tests to compile' || coffee -o test/acceptance/js -c test/acceptance/coffee",
"compile:all": "npm run compile:app && npm run compile:unit_tests && npm run compile:acceptance_tests",
"nodemon": "nodemon --config nodemon.json"
}, },
"dependencies": { "dependencies": {
"async": "~0.8.0", "async": "~0.8.0",
@ -33,6 +41,7 @@
"grunt-execute": "~0.2.1", "grunt-execute": "~0.2.1",
"grunt-forever": "~0.4.4", "grunt-forever": "~0.4.4",
"grunt-mocha-test": "~0.10.2", "grunt-mocha-test": "~0.10.2",
"mocha": "^4.0.1",
"grunt-shell": "~0.7.0", "grunt-shell": "~0.7.0",
"sandboxed-module": "~0.3.0", "sandboxed-module": "~0.3.0",
"sinon": "~1.5.2", "sinon": "~1.5.2",

View file

@ -0,0 +1,20 @@
app = require('../../../app')
require("logger-sharelatex").logger.level("error")
module.exports =
running: false
initing: false
callbacks: []
ensureRunning: (callback = (error) ->) ->
if @running
return callback()
else if @initing
@callbacks.push callback
else
@initing = true
@callbacks.push callback
app.listen 3036, "localhost", (error) =>
throw error if error?
@running = true
for callback in @callbacks
callback()

View file

@ -5,13 +5,14 @@ expect = chai.expect
ObjectId = require("mongojs").ObjectId ObjectId = require("mongojs").ObjectId
request = require "request" request = require "request"
async = require "async" async = require "async"
ContactsApp = require "./ContactsApp"
HOST = "http://localhost:3036" HOST = "http://localhost:3036"
describe "Getting Contacts", -> describe "Getting Contacts", ->
describe "with no contacts", -> describe "with no contacts", ->
beforeEach -> beforeEach (done)->
@user_id = ObjectId().toString() @user_id = ObjectId().toString()
ContactsApp.ensureRunning done
it "should return an empty array", (done) -> it "should return an empty array", (done) ->
request { request {
@ -41,6 +42,7 @@ describe "Getting Contacts", ->
async.series [ async.series [
# 2 is preferred since touched twice, then 3 since most recent, then 1 # 2 is preferred since touched twice, then 3 since most recent, then 1
(cb) => ContactsApp.ensureRunning cb
(cb) => touchContact @user_id, @contact_id_1, cb (cb) => touchContact @user_id, @contact_id_1, cb
(cb) => touchContact @user_id, @contact_id_2, cb (cb) => touchContact @user_id, @contact_id_2, cb
(cb) => touchContact @user_id, @contact_id_2, cb (cb) => touchContact @user_id, @contact_id_2, cb