add common makefile, make it possible to run tests and build package without installing global libs, enhance travis build file to also run php tests, add dev docs

fix indention

fix copyright

exclude gulpfile from appstore build

also generate coverage when phpunit exsits in path

remove breaking codecov from test

run codecov after success, use previous make package

run test suite instead of build

try without sudo

another try without sudo

switch from mariadb to mysql

mysql server seems to be present out of the box

1 files changed, 168 insertions, 31 deletions

diff --git a/Makefile b/Makefile
index 0331949f..9f39e857 100644
--- a/Makefile
+++ b/Makefile
@@ -1,38 +1,175 @@
-# Makefile for building the project
+# This file is licensed under the Affero General Public License version 3 or
+# later. See the COPYING file.
+# @author Bernhard Posselt <dev@bernhard-posselt.com>
+# @copyright Bernhard Posselt 2016
 
-app_name=contacts
-project_dir=$(CURDIR)/../$(app_name)
-build_dir=$(CURDIR)/build/artifacts
-appstore_dir=$(build_dir)/appstore
-source_dir=$(build_dir)/source
-package_name=$(app_name)
+# Generic Makefile for building and packaging an ownCloud app which uses npm and
+# Composer.
+#
+# Dependencies:
+# * make
+# * which
+# * curl: used if phpunit and composer are not installed to fetch them from the web
+# * tar: for building the archive
+# * npm: for building and testing everything JS
+#
+# If no composer.json is in the app root directory, the Composer step
+# will be skipped. The same goes for the package.json which can be located in
+# the app root or the js/ directory.
+#
+# The npm command by launches the npm build script:
+#
+#    npm run build
+#
+# The npm test command launches the npm test script:
+#
+#    npm run test
+#
+# The idea behind this is to be completely testing and build tool agnostic. All
+# build tools and additional package managers should be installed locally in
+# your project, since this won't pollute people's global namespace.
+#
+# The following npm scripts in your package.json install and update the bower
+# and npm dependencies and use gulp as build system (notice how everything is
+# run from the node_modules folder):
+#
+#    "scripts": {
+#        "test": "node node_modules/gulp-cli/bin/gulp.js karma",
+#        "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
+#        "build": "node node_modules/gulp-cli/bin/gulp.js"
+#    },
 
-all: appstore
+app_name=$(notdir $(CURDIR))
+project_directory=$(CURDIR)/../$(app_name)
+build_tools_directory=$(CURDIR)/build/tools
+source_build_directory=$(CURDIR)/build/artifacts/source
+source_package_name=$(source_build_directory)/$(app_name)
+appstore_build_directory=$(CURDIR)/build/artifacts/appstore
+appstore_package_name=$(appstore_build_directory)/$(app_name)
+npm=$(shell which npm 2> /dev/null)
+composer=$(shell which composer 2> /dev/null)
 
+all: build
+
+# Fetches the PHP and JS dependencies and compiles the JS. If no composer.json
+# is present, the composer step is skipped, if no package.json or js/package.json
+# is present, the npm step is skipped
+.PHONY: build
+build:
+ifneq (,$(wildcard $(CURDIR)/composer.json))
+	make composer
+endif
+ifneq (,$(wildcard $(CURDIR)/package.json))
+	make npm
+endif
+ifneq (,$(wildcard $(CURDIR)/js/package.json))
+	make npm
+endif
+
+# Installs and updates the composer dependencies. If composer is not installed
+# a copy is fetched from the web
+.PHONY: composer
+composer:
+ifeq (, $(composer))
+	@echo "No composer command available, downloading a copy from the web"
+	mkdir -p $(build_tools_directory)
+	curl -sS https://getcomposer.org/installer | php
+	mv composer.phar $(build_tools_directory)
+	php $(build_tools_directory)/composer.phar install --prefer-dist
+	php $(build_tools_directory)/composer.phar update --prefer-dist
+else
+	composer install --prefer-dist
+	composer update --prefer-dist
+endif
+
+# Installs npm dependencies
+.PHONY: npm
+npm:
+ifeq (,$(wildcard $(CURDIR)/package.json))
+	cd js && $(npm) run build
+else
+	npm run build
+endif
+
+# Removes the appstore build
+.PHONY: clean
 clean:
-	rm -rf $(build_dir)
+	rm -rf ./build
 
-appstore: appstore_package
+# Same as clean but also removes dependencies installed by composer, bower and
+# npm
+.PHONY: distclean
+distclean: clean
+	rm -rf vendor
+	rm -rf node_modules
+	rm -rf js/vendor
+	rm -rf js/node_modules
 
-appstore_package: clean
-	mkdir -p $(appstore_dir)
-	tar cvzf $(appstore_dir)/$(package_name).tar.gz \
+# Builds the source and appstore package
+.PHONY: dist
+dist:
+	make source
+	make appstore
+
+# Builds the source package
+.PHONY: source
+source:
+	make build
+	rm -rf $(source_build_directory)
+	mkdir -p $(source_build_directory)
+	tar cvzf $(source_package_name).tar.gz ../$(app_name) \
+	--exclude-vcs \
+	--exclude="../$(app_name)/build" \
+	--exclude="../$(app_name)/js/node_modules" \
+	--exclude="../$(app_name)/node_modules" \
+	--exclude="../$(app_name)/*.log" \
+	--exclude="../$(app_name)/js/*.log" \
+
+# Builds the source package for the app store, ignores php and js tests
+.PHONY: appstore
+appstore:
+	make build
+	rm -rf $(appstore_build_directory)
+	mkdir -p $(appstore_build_directory)
+	tar cvzf $(appstore_package_name).tar.gz \
 	--exclude-vcs \
-	$(project_dir)/appinfo \
-	$(project_dir)/controller \
-	$(project_dir)/css \
-	$(project_dir)/img \
-	$(project_dir)/l10n \
-	$(project_dir)/templates \
-	$(project_dir)/js/public \
-	$(project_dir)/js/dav/dav.js \
-	$(project_dir)/js/vendor/angular/angular.js \
-	$(project_dir)/js/vendor/angular-route/angular-route.js \
-	$(project_dir)/js/vendor/angular-cache/dist/angular-cache.js \
-	$(project_dir)/js/vendor/angular-uuid4/angular-uuid4.js \
-	$(project_dir)/js/vendor/vcard/src/vcard.js \
-	$(project_dir)/js/vendor/angular-bootstrap/ui-bootstrap.min.js \
-	$(project_dir)/js/vendor/angular-bootstrap/ui-bootstrap-tpls.min.js \
-	$(project_dir)/js/vendor/angular-sanitize/angular-sanitize.js \
-	$(project_dir)/js/vendor/ui-select/dist/select.js \
-	$(project_dir)/js/vendor/jquery-timepicker/jquery.ui.timepicker.js
+	$(project_directory)/appinfo \
+	$(project_directory)/controller \
+	$(project_directory)/css \
+	$(project_directory)/img \
+	$(project_directory)/l10n \
+	$(project_directory)/templates \
+	$(project_directory)/js/public \
+	$(project_directory)/js/dav/dav.js \
+	$(project_directory)/js/vendor/angular/angular.js \
+	$(project_directory)/js/vendor/angular-route/angular-route.js \
+	$(project_directory)/js/vendor/angular-cache/dist/angular-cache.js \
+	$(project_directory)/js/vendor/angular-uuid4/angular-uuid4.js \
+	$(project_directory)/js/vendor/vcard/src/vcard.js \
+	$(project_directory)/js/vendor/angular-bootstrap/ui-bootstrap.min.js \
+	$(project_directory)/js/vendor/angular-bootstrap/ui-bootstrap-tpls.min.js \
+	$(project_directory)/js/vendor/angular-sanitize/angular-sanitize.js \
+	$(project_directory)/js/vendor/ui-select/dist/select.js \
+	$(project_directory)/js/vendor/jquery-timepicker/jquery.ui.timepicker.js
+
+# Command for running JS and PHP tests. Works for package.json files in the js/
+# and root directory. If phpunit is not installed systemwide, a copy is fetched
+# from the internet
+.PHONY: test
+test:
+ifneq (,$(wildcard $(CURDIR)/js/package.json))
+	cd js && $(npm) run test
+endif
+ifneq (,$(wildcard $(CURDIR)/package.json))
+	$(npm) run test
+endif
+ifeq (, $(shell which phpunit 2> /dev/null))
+	@echo "No phpunit command available, downloading a copy from the web"
+	mkdir -p $(build_tools_directory)
+	curl -sSL https://phar.phpunit.de/phpunit.phar -o $(build_tools_directory)/phpunit.phar
+	php $(build_tools_directory)/phpunit.phar -c phpunit.xml --coverage-clover build/php-unit.clover
+	php $(build_tools_directory)/phpunit.phar -c phpunit.integration.xml --coverage-clover build/php-integration.clover
+else
+	phpunit -c phpunit.xml --coverage-clover build/php-unit.clover
+	phpunit -c phpunit.integration.xml --coverage-clover build/php-unit.clover
+endif