Merge pull request #23 from eapearson/master

Build and deployment improvements

.travis.yml

@@ -4,10 +4,10 @@ node_js:
   - "0.12"
   # NB this should be 4.2, which is the LTS for node; they are working on it.
   - "4.1"
-cache:
-  directories:
-  - bower_components
-  - node_modules
+#cache:
+#  directories:
+#  - bower_components
+#  - node_modules
 branches:
     only:
         - master
@@ -18,9 +18,10 @@ branches:
 #    - develop
 #    - staging
 #    - master
-before_install:
-  - npm install -g bower
-  - npm install -g grunt-cli
+#before_install:
+#  - npm install -g bower
+#  - npm install -g grunt-cli
 install:
-  - make
-script: grunt test-travis
+    - make init
+    - make build config=ci
+script: make test-travis

Gruntfile.js

@@ -246,8 +246,39 @@ module.exports = function (grunt) {
             dev: {
                 name: 'dev'
             }
+        },
+        clean: {
+            build: {
+                src: [
+                    'build/build'
+                ]
+            },
+            dist: {
+                src: [
+                    'build/dist'
+                ]
+            },
+            test: {
+                src: [
+                    'build/build-test-coverage'
+                ]
+            },
+            temp: {
+                src: [
+                    'build/temp'
+                ]
+            },
+            deps: {
+                src: [
+                    'node_modules', 'bower_components'
+                ]
+            }
         }
     });
+
+    grunt.registerTask('clean-all', [
+        'clean:build', 'clean:dist', 'clean:test', 'clean:deps', 'clean:temp'
+    ]);
 
     // Does a single, local, unit test run.
     grunt.registerTask('test', [

Makefile

@@ -21,6 +21,8 @@ DISTLIB			= $(TOPDIR)/build
 DOCSLIB			= $(TOPDIR)/docs
 DEPLOY_CFG		= deploy-$(TARGET).cfg
 KB_TOP			= /kb
+GRUNT		        = ./node_modules/.bin/grunt
+KARMA			= ./node_modules/.bin/karma
 
 # Standard 'all' target = just do the standard build
 all: init build
@@ -41,18 +43,17 @@ run: init build start preview
 init:
 	npm install
 	cd tools/server; npm install
-	grunt init
+	$(GRUNT) init
 
-# Perform the build.
-# The actual build step is done by grunt. This also sets up the 
-# configuration in the build target. That configuration mainly
-# deals with filling out templated URL targets based on deployment
-# location (prod vs. next vs. CI vs. local)
-#@ grunt build-dist --target $(TARGET)
-#  --deploy-config $(TARGET)
-# @ node tools/process_config.js $(DEPLOY_CFG)
+# Perform the build. Build scnearios are supported through the config option
+# which is passed in like "make build config=ci"
 build:	
-	cd mutations; node build build
+	cd mutations; node build $(config)
+
+# The deploy step will copy the files according to the instructions in the deploy
+# config. See mutations/deploy.js for details.
+#deploy:	
+#	cd mutations; node build deploy; node deploy
 
 # Set up a development environment. 
 # Installs tools into kbase-ui/dev. These tools are ignored by git,
@@ -63,7 +64,7 @@ devinit:
 
 
 start:
-	cd tools/server; node server start  $(target) &
+	cd tools/server; node server start $(target) &
 
 stop: 
 	cd tools/server; node server stop 
@@ -72,29 +73,24 @@ stop:
 preview:
 	cd tools/server; node server preview
 
-dist: 
-	cd mutations; node build deploy
-
-# The deploy step will copy the files according to the instructions in the deploy
-# config. See mutations/deploy.js for details.
-deploy:	
-	cd mutations; node build deploy; node deploy
 
 # Tests are managed by grunt, but this also mimics the workflow.
 #init build
 test:
-	karma start test/karma.conf.js
+	$(KARMA) start test/karma.conf.js
 
+test-travis:
+	$(GRUNT) test-travis	
 
-# Cleans up build artifacts without removing required libraries
-# that get installed through Bower or NPM.
+# Clean slate
 clean:
-	@ grunt clean-dist
+	$(GRUNT) clean-all
+
+clean-temp:
+	$(GRUNT) clean:temp
 
-# Cleans out all required libraries and packages.
-reqs-clean: clean
-	@ rm -rf node_modules/
-	@ rm -rf bower_components/
+# If you need more clean refinement, please see Gruntfile.js, in which you will
+# find clean tasks for each major build artifact.
 
 # Eventually, if docs need to be built, the process will go here.
 docs: init

README.md

@@ -81,7 +81,7 @@ For more complete instructions (which in turn have links to technical guides), p
 
 - [Prerequisites](docs/prerequisites.md)
 - [Installation](docs/installation.md)
-- [Deployment](docs/deployment.md)
+- [Deployment](docs/quick-deploy.md)
 
 ## Development
 

bower.json

@@ -47,5 +47,5 @@
         "postal": "1.0.7"
     },
     "devDependencies": {},
-    "license": "SEE LICENSE IN LICENSE.md"
+    "license": "SEE LICENSE IN LICENSE"
 }

config/README.md

@@ -1,3 +1,8 @@
 # Configuration
 
-This directory contains files necessary to configure 
+This directory contains files necessary to configure kbase ui builds:
+
+- ```builds``` - one file per named configuration set.
+- ```deploy``` - classic KBase deploy configuration: service urls, target dirs, per KBase deploy environment.
+- ```ui``` - ui build configurations
+- ```bowerInstall``` - master file for importing bower packages into kbase module space.

config/build.yml → config/builds/build.yml

@@ -5,9 +5,9 @@ targets:
     deploy: ci
 build:
     dist: false
-    temp: ../mutantfiles
+    temp: ../temp
 bower:
     offline: false
-debug: true
+debug: false
 server:
     port: 8080

config/builds/ci.yml

@@ -0,0 +1,13 @@
+## Global Build Config
+---
+targets:
+    ui: prod
+    deploy: ci
+build:
+    dist: true
+    temp: temp
+bower:
+    offline: false
+debug: false
+server:
+    port: 8080

config/builds/dev.yml

@@ -0,0 +1,13 @@
+## Global Build Config
+---
+targets:
+    ui: prod
+    deploy: ci
+build:
+    dist: false
+    temp: temp
+bower:
+    offline: false
+debug: false
+server:
+    port: 8080

config/builds/next.yml

@@ -0,0 +1,13 @@
+## Global Build Config
+---
+targets:
+    ui: prod
+    deploy: next
+build:
+    dist: true
+    temp: temp
+bower:
+    offline: false
+debug: false
+server:
+    port: 8080

config/deploy.yml → config/builds/prod.yml

@@ -5,7 +5,7 @@ targets:
     deploy: prod
 build:
     dist: true
-    temp: ../mutantfiles
+    temp: temp
 bower:
     offline: false
 debug: false

config/deploy/deploy-ci.cfg

@@ -20,4 +20,5 @@ ujs_url=https://ci.kbase.us/services/userandjobstate
 ws_url=https://ci.kbase.us/services/ws
 narrative_url=https://narrative-ci.kbase.us
 catalog_url=https://ci.kbase.us/services/catalog
-taxon_url=https://ci.kbase.us/services/data/taxon
+taxon_api_url=https://ci.kbase.us/services/data/taxon
+assembly_api_url=https://ci.kbase.us/services/data/assembly

config/deploy/deploy-next.cfg

@@ -20,4 +20,5 @@ ujs_url=https://next.kbase.us/services/userandjobstate
 ws_url=https://next.kbase.us/services/ws
 narrative_url=https://narrative-next.kbase.us
 catalog_url=https://next.kbase.us/services/catalog
-taxon_url=https://next.kbase.us/services/data/taxon
+taxon_api_url=https://next.kbase.us/services/data/taxon
+assembly_api_url=https://next.kbase.us/services/data/assembly

config/deploy/deploy-prod.cfg

@@ -20,4 +20,5 @@ ujs_url=https://kbase.us/services/userandjobstate
 ws_url=https://kbase.us/services/ws
 narrative_url=https://narrative.kbase.us
 catalog_url=https://kbase.us/services/catalog
-taxon_url=https://kbase.us/services/data/taxon
+taxon_api_url=https://kbase.us/services/data/taxon
+assembly_api_url=https://kbase.us/services/data/assembly

config/deploy/templates/service.yml

@@ -58,4 +58,10 @@ services:
         name: Narrative User Interface    
     catalog:
         url: <%= catalog_url %>
-        name: Catalog
+        name: Catalog
+    taxon_api:
+        url: <%= taxon_api_url %>
+        name: Taxon API
+    assembly_api:
+        url: <%= assembly_api_url %>
+        name: Assembly API        

deploy.sh

@@ -1 +1,4 @@
-cp -pr dist/client/* /kb/deployment/services/kbase-ui
+DEPLOY_DEST=/kb/deployment/services/kbase-ui
+rm -rf $DEPLOY_DEST
+mkdir -p $DEPLOY_DEST
+cp -pr build/dist/client/* $DEPLOY_DEST

docs/configuration.md.md

@@ -0,0 +1,3 @@
+# Configuration
+
+

docs/notes.md

@@ -0,0 +1,8 @@
+# Notes
+
+Various notes:
+
+## Vagrant
+
+
+   config.vm.network "private_network", type: "dhcp"