2017-01-15 22:26:04 +00:00
|
|
|
# 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 2017
|
|
|
|
|
# @author Georg Ehrke <oc.list@georgehrke.com>
|
|
|
|
|
# @copyright Georg Ehrke 2017
|
|
|
|
|
# @author Raimund Schlüßler
|
2018-08-19 20:33:26 +00:00
|
|
|
# @copyright 2018 Raimund Schlüßler <raimund.schluessler@mailbox.org>
|
2016-03-14 16:20:22 +00:00
|
|
|
|
2017-10-15 11:41:00 +00:00
|
|
|
# Generic Makefile for building and packaging a Nextcloud app which uses npm and
|
2017-01-15 22:26:04 +00:00
|
|
|
# Composer.
|
|
|
|
|
#
|
|
|
|
|
# Dependencies:
|
|
|
|
|
# * make
|
|
|
|
|
# * which
|
|
|
|
|
# * curl: used if phpunit and composer are not installed to fetch them from the web
|
|
|
|
|
# * tar: for building the archive
|
2017-10-15 11:41:00 +00:00
|
|
|
# * npm: for building and testing everything JS
|
2017-01-15 22:26:04 +00:00
|
|
|
#
|
|
|
|
|
# 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.
|
|
|
|
|
#
|
2017-10-15 11:41:00 +00:00
|
|
|
# The npm command by launches the npm build script:
|
2017-01-15 22:26:04 +00:00
|
|
|
#
|
2017-10-15 11:41:00 +00:00
|
|
|
# npm run build
|
2017-01-15 22:26:04 +00:00
|
|
|
#
|
2017-10-15 11:41:00 +00:00
|
|
|
# The npm test command launches the npm test script:
|
2017-01-15 22:26:04 +00:00
|
|
|
#
|
2017-10-15 11:41:00 +00:00
|
|
|
# npm run test
|
2017-01-15 22:26:04 +00:00
|
|
|
#
|
|
|
|
|
# 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.
|
|
|
|
|
#
|
2017-10-15 11:41:00 +00:00
|
|
|
# The following npm scripts in your package.json install and update the
|
|
|
|
|
# npm dependencies and use gulp as build system (notice how everything is
|
2017-01-15 22:26:04 +00:00
|
|
|
# run from the node_modules folder):
|
|
|
|
|
#
|
|
|
|
|
# "scripts": {
|
|
|
|
|
# "test": "node node_modules/gulp-cli/bin/gulp.js karma",
|
2017-10-15 11:41:00 +00:00
|
|
|
# "prebuild": "npm install && npm upgrade",
|
2017-01-15 22:26:04 +00:00
|
|
|
# "build": "node node_modules/gulp-cli/bin/gulp.js"
|
|
|
|
|
# },
|
2016-03-14 16:20:22 +00:00
|
|
|
|
2017-01-15 22:26:04 +00:00
|
|
|
app_name=$(notdir $(CURDIR))
|
|
|
|
|
build_tools_directory=$(CURDIR)/build/tools
|
|
|
|
|
source_build_directory=$(CURDIR)/build/source/tasks
|
|
|
|
|
source_artifact_directory=$(CURDIR)/build/artifacts/source
|
|
|
|
|
source_package_name=$(source_artifact_directory)/$(app_name)
|
|
|
|
|
appstore_build_directory=$(CURDIR)/build/appstore/tasks
|
|
|
|
|
appstore_artifact_directory=$(CURDIR)/build/artifacts/appstore
|
|
|
|
|
appstore_package_name=$(appstore_artifact_directory)/$(app_name)
|
2017-10-15 11:41:00 +00:00
|
|
|
npm=$(shell which npm 2> /dev/null)
|
2017-01-15 22:26:04 +00:00
|
|
|
gcp=$(shell which gcp 2> /dev/null)
|
|
|
|
|
|
|
|
|
|
ifeq (, $(gcp))
|
|
|
|
|
copy_command=cp
|
|
|
|
|
else
|
|
|
|
|
copy_command=gcp
|
|
|
|
|
endif
|
|
|
|
|
|
|
|
|
|
# code signing
|
|
|
|
|
# assumes the following:
|
|
|
|
|
# * the app is inside the nextcloud/apps folder
|
|
|
|
|
# * the private key is located in ~/.nextcloud/tasks.key
|
|
|
|
|
# * the certificate is located in ~/.nextcloud/tasks.crt
|
|
|
|
|
occ=$(CURDIR)/../../occ
|
|
|
|
|
configdir=$(CURDIR)/../../config
|
|
|
|
|
private_key=$(HOME)/.nextcloud/$(app_name).key
|
|
|
|
|
certificate=$(HOME)/.nextcloud/$(app_name).crt
|
|
|
|
|
sign=php -f $(occ) integrity:sign-app --privateKey="$(private_key)" --certificate="$(certificate)"
|
|
|
|
|
sign_skip_msg="Skipping signing, either no key and certificate found in $(private_key) and $(certificate) or occ can not be found at $(occ)"
|
|
|
|
|
ifneq (,$(wildcard $(private_key)))
|
|
|
|
|
ifneq (,$(wildcard $(certificate)))
|
|
|
|
|
ifneq (,$(wildcard $(occ)))
|
|
|
|
|
CAN_SIGN=true
|
|
|
|
|
endif
|
|
|
|
|
endif
|
|
|
|
|
endif
|
|
|
|
|
|
|
|
|
|
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
|
2017-10-15 11:41:00 +00:00
|
|
|
# is present, the npm step is skipped
|
2017-01-15 22:26:04 +00:00
|
|
|
.PHONY: build
|
|
|
|
|
build:
|
2017-10-15 11:41:00 +00:00
|
|
|
make npm
|
2017-01-15 22:26:04 +00:00
|
|
|
|
2017-10-15 11:41:00 +00:00
|
|
|
# Installs npm dependencies
|
|
|
|
|
.PHONY: npm
|
|
|
|
|
npm:
|
2018-08-07 19:35:10 +00:00
|
|
|
$(npm) run build
|
2017-01-15 22:26:04 +00:00
|
|
|
|
|
|
|
|
# Removes the appstore build
|
|
|
|
|
.PHONY: clean
|
2016-03-14 16:20:22 +00:00
|
|
|
clean:
|
2017-01-15 22:26:04 +00:00
|
|
|
rm -rf ./build
|
|
|
|
|
|
2017-10-15 11:41:00 +00:00
|
|
|
# Same as clean but also removes dependencies installed by npm
|
2017-01-15 22:26:04 +00:00
|
|
|
.PHONY: distclean
|
|
|
|
|
distclean: clean
|
|
|
|
|
rm -rf vendor
|
|
|
|
|
rm -rf node_modules
|
|
|
|
|
rm -rf js/vendor
|
|
|
|
|
rm -rf js/node_modules
|
|
|
|
|
|
|
|
|
|
# Builds the source and appstore package
|
|
|
|
|
.PHONY: dist
|
|
|
|
|
dist:
|
|
|
|
|
make source
|
|
|
|
|
make appstore
|
|
|
|
|
|
2018-01-27 22:08:15 +00:00
|
|
|
# Run make and make dist in a Docker container
|
|
|
|
|
.PHONY: docker-dist
|
|
|
|
|
docker-dist:
|
|
|
|
|
docker run --rm -it -v $(CURDIR):/tasks -w /tasks node make docker-target
|
|
|
|
|
|
|
|
|
|
# Command used inside Docker container; do not invoke directly
|
|
|
|
|
.PHONY: docker-target
|
|
|
|
|
docker-target:
|
|
|
|
|
which rsync zip openssl || (apt-get update && apt-get install -y rsync zip openssl)
|
|
|
|
|
make
|
|
|
|
|
make dist
|
|
|
|
|
|
2017-01-15 22:26:04 +00:00
|
|
|
# Builds the source package
|
|
|
|
|
.PHONY: source
|
|
|
|
|
source:
|
|
|
|
|
rm -rf $(source_build_directory) $(source_artifact_directory)
|
|
|
|
|
mkdir -p $(source_build_directory) $(source_artifact_directory)
|
|
|
|
|
rsync -rv . $(source_build_directory) \
|
|
|
|
|
--exclude=/.git/ \
|
|
|
|
|
--exclude=/.idea/ \
|
|
|
|
|
--exclude=/build/ \
|
|
|
|
|
--exclude=/js/node_modules/ \
|
2018-08-07 19:35:10 +00:00
|
|
|
--exclude=/node_modules/ \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=*.log
|
|
|
|
|
ifdef CAN_SIGN
|
|
|
|
|
$(sign) --path "$(source_build_directory)"
|
|
|
|
|
else
|
|
|
|
|
@echo $(sign_skip_msg)
|
|
|
|
|
endif
|
|
|
|
|
tar -cvzf $(source_package_name).tar.gz -C $(source_build_directory)/../ $(app_name)
|
2016-07-26 21:36:15 +00:00
|
|
|
|
2017-01-15 22:26:04 +00:00
|
|
|
# Builds the source package for the app store, ignores php and js tests
|
|
|
|
|
.PHONY: appstore
|
|
|
|
|
appstore:
|
|
|
|
|
rm -rf $(appstore_build_directory) $(appstore_artifact_directory)
|
|
|
|
|
mkdir -p $(appstore_build_directory) $(appstore_artifact_directory)
|
|
|
|
|
rsync -av . $(appstore_build_directory) \
|
|
|
|
|
--exclude=/tests \
|
|
|
|
|
--exclude=/.git \
|
|
|
|
|
--exclude=/.idea \
|
|
|
|
|
--exclude=/.editorconfig \
|
|
|
|
|
--exclude=/.gitattributes \
|
|
|
|
|
--exclude=/.gitignore \
|
|
|
|
|
--exclude=/.scrutinizer.yml \
|
|
|
|
|
--exclude=/.travis.yml \
|
2018-02-12 16:51:43 +00:00
|
|
|
--exclude=/.tx \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/build.xml \
|
|
|
|
|
--exclude=/CONTRIBUTING.md \
|
|
|
|
|
--exclude=/tasks.sublime-project \
|
|
|
|
|
--exclude=/tasks.sublime-workspace \
|
|
|
|
|
--exclude=/issue_template.md \
|
|
|
|
|
--exclude=/Makefile \
|
|
|
|
|
--exclude=/phpunit.xml \
|
|
|
|
|
--exclude=/README.md \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/CHANGELOG.md \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/build \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/css/src \
|
|
|
|
|
--exclude=/img/src \
|
2018-08-07 19:35:10 +00:00
|
|
|
--exclude=/.jshintrc \
|
|
|
|
|
--exclude=/.stylelintrc \
|
|
|
|
|
--exclude=/gulpfile.js \
|
|
|
|
|
--exclude=/node_modules \
|
|
|
|
|
--exclude=/package.json \
|
|
|
|
|
--exclude=/package-lock.json \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/js/README.md \
|
|
|
|
|
--exclude=/js/README.mkdir \
|
|
|
|
|
--exclude=/js/app \
|
|
|
|
|
--exclude=/js/config \
|
|
|
|
|
--exclude=/js/vendor/**/.bower.json \
|
|
|
|
|
--exclude=/js/vendor/**/.npmignore \
|
|
|
|
|
--exclude=/js/vendor/**/bower.json \
|
|
|
|
|
--exclude=/js/vendor/**/Gruntfile.js \
|
|
|
|
|
--exclude=/js/vendor/**/package.json \
|
|
|
|
|
--exclude=/js/vendor/**/*.md \
|
|
|
|
|
--exclude=/js/vendor/**/karma.conf.js \
|
|
|
|
|
--exclude=/js/vendor/**/*.map \
|
|
|
|
|
--exclude=/js/vendor/angular-mocks \
|
|
|
|
|
--exclude=/js/vendor/angular/angular.js \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/js/vendor/angular/angular.min.js.gzip \
|
|
|
|
|
--exclude=/js/vendor/angular/angular-csp.css \
|
|
|
|
|
--exclude=/js/vendor/angular/index.js \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/js/vendor/angular-animate/angular-animate.js \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/js/vendor/angular-animate/index.js \
|
|
|
|
|
--exclude=/js/vendor/angular-drag-and-drop-lists/angular-drag-and-drop-lists.js \
|
|
|
|
|
--exclude=/js/vendor/angular-drag-and-drop-lists/demo \
|
|
|
|
|
--exclude=/js/vendor/angular-drag-and-drop-lists/test \
|
|
|
|
|
--exclude=/js/vendor/angular-drag-and-drop-lists/LICENSE \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/js/vendor/angular-route/angular-route.js \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/js/vendor/angular-route/index.js \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/js/vendor/angular-sanitize/angular-sanitize.js \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/js/vendor/angular-sanitize/index.js \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/js/vendor/angular-ui-select/dist/select.js \
|
|
|
|
|
--exclude=/js/vendor/angular-ui-select/dist/select.css \
|
|
|
|
|
--exclude=/js/vendor/angular-ui-select/docs \
|
|
|
|
|
--exclude=/js/vendor/angular-ui-select/composer.json \
|
|
|
|
|
--exclude=/js/vendor/angular-ui-select/deploy-docs.sh \
|
|
|
|
|
--exclude=/js/vendor/ical.js/build/benchmark \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/js/vendor/ical.js/build/ical.js \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/js/vendor/ical.js/lib \
|
|
|
|
|
--exclude=/js/vendor/ical.js/samples \
|
|
|
|
|
--exclude=/js/vendor/ical.js/sandbox \
|
|
|
|
|
--exclude=/js/vendor/ical.js/tasks \
|
|
|
|
|
--exclude=/js/vendor/ical.js/test-agent \
|
|
|
|
|
--exclude=/js/vendor/ical.js/test-agent-server.js \
|
|
|
|
|
--exclude=/js/vendor/ical.js/test-agent-coverage.json \
|
2017-10-15 17:47:54 +00:00
|
|
|
--exclude=/js/vendor/jstimezonedetect/dist/jstz.js \
|
|
|
|
|
--exclude=/js/vendor/jstimezonedetect/LICENCE.txt \
|
|
|
|
|
--exclude=/js/vendor/ui-select/dist/select.js \
|
|
|
|
|
--exclude=/js/vendor/ui-select/dist/select.css \
|
|
|
|
|
--exclude=/js/vendor/ui-select/docs \
|
|
|
|
|
--exclude=/js/vendor/ui-select/src \
|
|
|
|
|
--exclude=/js/vendor/ui-select/test \
|
|
|
|
|
--exclude=/js/vendor/ui-select/composer.json \
|
|
|
|
|
--exclude=/js/vendor/ui-select/deploy-docs.sh \
|
|
|
|
|
--exclude=/js/vendor/ui-select/*.js \
|
|
|
|
|
--exclude=/js/vendor/ui-select/LICENSE \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/i18n \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/include \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/legacy_1.2.6 \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/tests \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/index.html \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/jquery.ui.timepicker.css \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/GPL-LICENSE.txt \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/MIT-LICENSE.txt \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/README.md \
|
|
|
|
|
--exclude=/js/vendor_legacy/jquery-timepicker/timepicker.png \
|
2017-01-15 22:26:04 +00:00
|
|
|
--exclude=/screenshots \
|
|
|
|
|
--exclude=/timezones/INFO.md
|
|
|
|
|
ifdef CAN_SIGN
|
|
|
|
|
mv $(configdir)/config.php $(configdir)/config-2.php
|
|
|
|
|
$(sign) --path="$(appstore_build_directory)"
|
|
|
|
|
mv $(configdir)/config-2.php $(configdir)/config.php
|
|
|
|
|
else
|
|
|
|
|
@echo $(sign_skip_msg)
|
|
|
|
|
endif
|
|
|
|
|
cd $(appstore_build_directory)/../; \
|
|
|
|
|
zip -r $(appstore_package_name).zip $(app_name)
|
|
|
|
|
tar -czf $(appstore_package_name).tar.gz -C $(appstore_build_directory)/../ $(app_name)
|
2018-01-27 22:08:04 +00:00
|
|
|
ifdef CAN_SIGN
|
2017-01-15 22:26:04 +00:00
|
|
|
openssl dgst -sha512 -sign $(private_key) $(appstore_package_name).tar.gz | openssl base64 -out $(appstore_artifact_directory)/$(app_name).sha512
|
2018-01-27 22:08:04 +00:00
|
|
|
endif
|
2016-07-26 21:36:15 +00:00
|
|
|
|
2016-03-14 16:20:22 +00:00
|
|
|
|
2017-01-15 22:26:04 +00:00
|
|
|
# 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:
|
2017-10-15 11:41:00 +00:00
|
|
|
cd js && $(npm) run test
|
2017-01-15 22:26:04 +00:00
|
|
|
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
|
