Makefile - monorail-avm99963 - Gitiles

 # Copyright 2016 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style
 # license that can be found in the LICENSE file or at
 # https://developers.google.com/open-source/licenses/bsd

 # Makefile to simplify some common AppEngine actions.
 # Use 'make help' for a list of commands.

 DEVID = monorail-dev
 STAGEID= monorail-staging
 PRODID= avm99963-bugs

 GAE_PY?= python gae.py
 DEV_APPSERVER_FLAGS?= --watcher_ignore_re="(.*/lib|.*/node_modules|.*/third_party|.*/venv)"

 WEBPACK_PATH := ./node_modules/webpack-cli/bin/cli.js

 TARDIR ?= "/workspace"

 FRONTEND_MODULES?= default
 BACKEND_MODULES?= besearch latency-insensitive api

 BRANCH_NAME := $(shell git rev-parse --abbrev-ref HEAD)

 PY_DIRS = api,businesslogic,features,framework,project,proto,search,services,sitewide,testing,tracker

 _VERSION ?= $(shell ../../../infra/luci/appengine/components/tools/calculate_version.py)

 SPIN = $(shell command -v spin 2> /dev/null)

 default: help

 check:
 ifndef NPM_VERSION
 	$(error npm not found. Install from nodejs.org or see README)
 endif

 help:
 	@echo "Available commands:"
 	@sed -n '/^[a-zA-Z0-9_.]*:/s/:.*//p' <Makefile

 # Run "eval `../../go/env.py`" before running the following prpc_proto commands
 prpc_proto_v0:
 	touch ../../ENV/lib/python2.7/site-packages/google/__init__.py
 	PYTHONPATH=../../ENV/lib/python2.7/site-packages \
 	PATH=../../luci/appengine/components/tools:$(PATH) \
 	../../cipd/protoc \
 	--python_out=. --prpc-python_out=. api/api_proto/*.proto
 	cd ../../go/src/infra/monorailv2 && \
 	cproto -proto-path ../../../../appengine/monorail/ ../../../../appengine/monorail/api/api_proto/
 prpc_proto_v3:
 	touch ../../ENV/lib/python2.7/site-packages/google/__init__.py
 	PYTHONPATH=../../ENV/lib/python2.7/site-packages \
 	PATH=../../luci/appengine/components/tools:$(PATH) \
 	../../cipd/protoc \
 	--python_out=. --prpc-python_out=. api/v3/api_proto/*.proto
 	cd ../../go/src/infra/monorailv2 && \
 	cproto -proto-path ../../../../appengine/monorail/ ../../../../appengine/monorail/api/v3/api_proto/

 business_proto:
 	touch ../../ENV/lib/python2.7/site-packages/google/__init__.py
 	PYTHONPATH=../../ENV/lib/python2.7/site-packages \
 	PATH=../../luci/appengine/components/tools:$(PATH) \
 	../../cipd/protoc \
 	--python_out=. --prpc-python_out=. proto/*.proto

 test:
 	../../test.py test appengine/monorail

 test_no_coverage:
 	../../test.py test appengine/monorail --no-coverage

 coverage:
 	@echo "Running tests + HTML coverage report in ~/monorail-coverage:"
 	../../test.py test appengine/monorail --html-report ~/monorail-coverage --coveragerc appengine/monorail/.coveragerc

 # Shows coverage on the tests themselves, helps illuminate when we have test
 # methods that aren't used.
 test_coverage:
 	@echo "Running tests + HTML coverage report (for tests) in ~/monorail-test-coverage:"
 	../../test.py test appengine/monorail --html-report ~/monorail-test-coverage --coveragerc appengine/monorail/.testcoveragerc

 # Commands for running locally using dev_appserver.
 # devserver requires an application ID (-A) to be specified.
 # We are using `-A monorail-staging` because ml spam code is set up
 # to impersonate monorail-staging in the local environment.
 serve: config_local
 	@echo "---[Starting SDK AppEngine Server]---"
 	$(GAE_PY) devserver -A monorail-staging -- $(DEV_APPSERVER_FLAGS)& $(WEBPACK_PATH) --watch

 serve_email: config_local
 	@echo "---[Starting SDK AppEngine Server]---"
 	$(GAE_PY) devserver -A monorail-staging -- $(DEV_APPSERVER_FLAGS) --enable_sendmail=True& $(WEBPACK_PATH) --watch

 # The _remote commands expose the app on 0.0.0.0, so that it is externally
 # accessible by hostname:port, rather than just localhost:port.
 serve_remote: config_local
 	@echo "---[Starting SDK AppEngine Server]---"
 	$(GAE_PY) devserver -A monorail-staging -o -- $(DEV_APPSERVER_FLAGS)& $(WEBPACK_PATH) --watch

 serve_remote_email: config_local
 	@echo "---[Starting SDK AppEngine Server]---"
 	$(GAE_PY) devserver -A monorail-staging -o -- $(DEV_APPSERVER_FLAGS) --enable_sendmail=True& $(WEBPACK_PATH) --watch

 run: serve

 deps: node_deps
 	rm -f static/dist/*

 build_js:
 	$(WEBPACK_PATH) --mode=production

 clean_deps:
 	rm -rf node_modules

 node_deps:
 	npm ci --no-save

 dev_deps:
 	python -m pip install --no-deps -r requirements.dev.txt

 karma:
 	npx karma start --debug --coverage

 karma_debug:
 	npx karma start --debug

 pylint:
 	pylint -f parseable *py {$(PY_DIRS)}{/,/test/}*py

 py3lint:
 	pylint --py3k *py {$(PY_DIRS)}{/,/test/}*py

 config: config_prod_cloud config_staging_cloud config_dev_cloud

 # Service yaml files used by gae.py are expected to be named module-<service-name>.yaml
 config_prod:
 	m4 -DPROD < app.yaml.m4 > app.yaml

 # Generate yaml files used by spinnaker.
 config_prod_cloud:
 	m4 -DPROD < app.yaml.m4 > app.prod.yaml

 config_staging:
 	m4 -DSTAGING < app.yaml.m4 > app.yaml

 config_staging_cloud:
 	m4 -DSTAGING < app.yaml.m4 > app.staging.yaml

 config_dev:
 	m4 -DDEV < app.yaml.m4 > app.yaml

 config_dev_cloud:
 	m4 -DDEV < app.yaml.m4 > app.yaml

 config_local:
 	m4 app.yaml.m4 > app.yaml

 deploy_dev: clean_deps deps build_js config_dev
 	$(eval BRANCH_NAME := $(shell git rev-parse --abbrev-ref HEAD))
 	@echo "---[Dev $(DEVID)]---"
 	$(GAE_PY) upload --tag $(BRANCH_NAME) -A $(DEVID) $(FRONTEND_MODULES)

 deploy_cloud_dev: clean_deps deps build_js config
 	$(eval GCB_DIR:= $(shell mktemp -d -p /tmp monorail_XXXXX))
 	rsync -aLK . $(GCB_DIR)  # Dereferences symlinks before snapshotting.
 	cd $(GCB_DIR) && tar cf ${_VERSION}.tar .
 	gsutil cp $(GCB_DIR)/${_VERSION}.tar gs://chrome-infra-builds/monorail/dev
 	rm -rf $(GCB_DIR)


 deploy:
 ifeq ($(SPIN),)
 	$(error "please install spin go/chops-install-spin")
 endif
 	$(SPIN) pipeline execute --name "Deploy Monorail" --application monorail
 	@echo "Follow progress here: https://spinnaker-1.endpoints.chrome-infra-spinnaker.cloud.goog/#/applications/monorail/executions"

 external_deps: clean_deps deps build_js config

 package_release:
 	rsync -aLK . $(TARDIR)/package


 lsbuilds:
 	gcloud builds list --filter="tags='monorail'"

 # AppEngine apps can be tested locally and in non-default versions upload to
 # the main app-id, but it is still sometimes useful to have a completely
 # separate app-id.  E.g., for testing inbound email, load testing, or using
 # throwaway databases.
 deploy_staging: clean_deps deps build_js config_staging
 	@echo "---[Staging $(STAGEID)]---"
 	$(GAE_PY) upload -A $(STAGEID) $(FRONTEND_MODULES)

 # This is our production server that users actually use.
 deploy_prod: clean_deps deps build_js config_prod
 	@echo "---[Deploying prod instance $(PRODID)]---"
 	$(GAE_PY) upload -A $(PRODID) $(FRONTEND_MODULES)

 # Note that we do not provide a command-line way to make the newly-uploaded
 # version the default version. This is for two reasons: a) You should be using
 # your browser to confirm that the new version works anyway, so just use the
 # console interface to make it the default; and b) If you really want to use
 # the command line you can use gae.py directly.
	# Copyright 2016 The Chromium Authors. All rights reserved.
	# Use of this source code is governed by a BSD-style
	# license that can be found in the LICENSE file or at
	# https://developers.google.com/open-source/licenses/bsd

	# Makefile to simplify some common AppEngine actions.
	# Use 'make help' for a list of commands.

	DEVID = monorail-dev
	STAGEID= monorail-staging
	PRODID= avm99963-bugs

	GAE_PY?= python gae.py
	DEV_APPSERVER_FLAGS?= --watcher_ignore_re="(./lib\|./node_modules\|./third_party\|./venv)"

	WEBPACK_PATH := ./node_modules/webpack-cli/bin/cli.js

	TARDIR ?= "/workspace"

	FRONTEND_MODULES?= default
	BACKEND_MODULES?= besearch latency-insensitive api

	BRANCH_NAME := $(shell git rev-parse --abbrev-ref HEAD)

	PY_DIRS = api,businesslogic,features,framework,project,proto,search,services,sitewide,testing,tracker

	_VERSION ?= $(shell ../../../infra/luci/appengine/components/tools/calculate_version.py)

	SPIN = $(shell command -v spin 2> /dev/null)

	default: help

	check:
	ifndef NPM_VERSION
	$(error npm not found. Install from nodejs.org or see README)
	endif

	help:
	@echo "Available commands:"
	@sed -n '/^[a-zA-Z0-9_.]:/s/:.//p' <Makefile

	# Run "eval `../../go/env.py`" before running the following prpc_proto commands
	prpc_proto_v0:
	touch ../../ENV/lib/python2.7/site-packages/google/__init__.py
	PYTHONPATH=../../ENV/lib/python2.7/site-packages \
	PATH=../../luci/appengine/components/tools:$(PATH) \
	../../cipd/protoc \
	--python_out=. --prpc-python_out=. api/api_proto/*.proto
	cd ../../go/src/infra/monorailv2 && \
	cproto -proto-path ../../../../appengine/monorail/ ../../../../appengine/monorail/api/api_proto/
	prpc_proto_v3:
	touch ../../ENV/lib/python2.7/site-packages/google/__init__.py
	PYTHONPATH=../../ENV/lib/python2.7/site-packages \
	PATH=../../luci/appengine/components/tools:$(PATH) \
	../../cipd/protoc \
	--python_out=. --prpc-python_out=. api/v3/api_proto/*.proto
	cd ../../go/src/infra/monorailv2 && \
	cproto -proto-path ../../../../appengine/monorail/ ../../../../appengine/monorail/api/v3/api_proto/

	business_proto:
	touch ../../ENV/lib/python2.7/site-packages/google/__init__.py
	PYTHONPATH=../../ENV/lib/python2.7/site-packages \
	PATH=../../luci/appengine/components/tools:$(PATH) \
	../../cipd/protoc \
	--python_out=. --prpc-python_out=. proto/*.proto

	test:
	../../test.py test appengine/monorail

	test_no_coverage:
	../../test.py test appengine/monorail --no-coverage

	coverage:
	@echo "Running tests + HTML coverage report in ~/monorail-coverage:"
	../../test.py test appengine/monorail --html-report ~/monorail-coverage --coveragerc appengine/monorail/.coveragerc

	# Shows coverage on the tests themselves, helps illuminate when we have test
	# methods that aren't used.
	test_coverage:
	@echo "Running tests + HTML coverage report (for tests) in ~/monorail-test-coverage:"
	../../test.py test appengine/monorail --html-report ~/monorail-test-coverage --coveragerc appengine/monorail/.testcoveragerc

	# Commands for running locally using dev_appserver.
	# devserver requires an application ID (-A) to be specified.
	# We are using `-A monorail-staging` because ml spam code is set up
	# to impersonate monorail-staging in the local environment.
	serve: config_local
	@echo "---[Starting SDK AppEngine Server]---"
	$(GAE_PY) devserver -A monorail-staging -- $(DEV_APPSERVER_FLAGS)& $(WEBPACK_PATH) --watch

	serve_email: config_local
	@echo "---[Starting SDK AppEngine Server]---"
	$(GAE_PY) devserver -A monorail-staging -- $(DEV_APPSERVER_FLAGS) --enable_sendmail=True& $(WEBPACK_PATH) --watch

	# The _remote commands expose the app on 0.0.0.0, so that it is externally
	# accessible by hostname:port, rather than just localhost:port.
	serve_remote: config_local
	@echo "---[Starting SDK AppEngine Server]---"
	$(GAE_PY) devserver -A monorail-staging -o -- $(DEV_APPSERVER_FLAGS)& $(WEBPACK_PATH) --watch

	serve_remote_email: config_local
	@echo "---[Starting SDK AppEngine Server]---"
	$(GAE_PY) devserver -A monorail-staging -o -- $(DEV_APPSERVER_FLAGS) --enable_sendmail=True& $(WEBPACK_PATH) --watch

	run: serve

	deps: node_deps
	rm -f static/dist/*

	build_js:
	$(WEBPACK_PATH) --mode=production

	clean_deps:
	rm -rf node_modules

	node_deps:
	npm ci --no-save

	dev_deps:
	python -m pip install --no-deps -r requirements.dev.txt

	karma:
	npx karma start --debug --coverage

	karma_debug:
	npx karma start --debug

	pylint:
	pylint -f parseable py {$(PY_DIRS)}{/,/test/}py

	py3lint:
	pylint --py3k py {$(PY_DIRS)}{/,/test/}py

	config: config_prod_cloud config_staging_cloud config_dev_cloud

	# Service yaml files used by gae.py are expected to be named module-<service-name>.yaml
	config_prod:
	m4 -DPROD < app.yaml.m4 > app.yaml

	# Generate yaml files used by spinnaker.
	config_prod_cloud:
	m4 -DPROD < app.yaml.m4 > app.prod.yaml

	config_staging:
	m4 -DSTAGING < app.yaml.m4 > app.yaml

	config_staging_cloud:
	m4 -DSTAGING < app.yaml.m4 > app.staging.yaml

	config_dev:
	m4 -DDEV < app.yaml.m4 > app.yaml

	config_dev_cloud:
	m4 -DDEV < app.yaml.m4 > app.yaml

	config_local:
	m4 app.yaml.m4 > app.yaml

	deploy_dev: clean_deps deps build_js config_dev
	$(eval BRANCH_NAME := $(shell git rev-parse --abbrev-ref HEAD))
	@echo "---[Dev $(DEVID)]---"
	$(GAE_PY) upload --tag $(BRANCH_NAME) -A $(DEVID) $(FRONTEND_MODULES)

	deploy_cloud_dev: clean_deps deps build_js config
	$(eval GCB_DIR:= $(shell mktemp -d -p /tmp monorail_XXXXX))
	rsync -aLK . $(GCB_DIR) # Dereferences symlinks before snapshotting.
	cd $(GCB_DIR) && tar cf ${_VERSION}.tar .
	gsutil cp $(GCB_DIR)/${_VERSION}.tar gs://chrome-infra-builds/monorail/dev
	rm -rf $(GCB_DIR)


	deploy:
	ifeq ($(SPIN),)
	$(error "please install spin go/chops-install-spin")
	endif
	$(SPIN) pipeline execute --name "Deploy Monorail" --application monorail
	@echo "Follow progress here: https://spinnaker-1.endpoints.chrome-infra-spinnaker.cloud.goog/#/applications/monorail/executions"

	external_deps: clean_deps deps build_js config

	package_release:
	rsync -aLK . $(TARDIR)/package



	lsbuilds:
	gcloud builds list --filter="tags='monorail'"

	# AppEngine apps can be tested locally and in non-default versions upload to
	# the main app-id, but it is still sometimes useful to have a completely
	# separate app-id. E.g., for testing inbound email, load testing, or using
	# throwaway databases.
	deploy_staging: clean_deps deps build_js config_staging
	@echo "---[Staging $(STAGEID)]---"
	$(GAE_PY) upload -A $(STAGEID) $(FRONTEND_MODULES)

	# This is our production server that users actually use.
	deploy_prod: clean_deps deps build_js config_prod
	@echo "---[Deploying prod instance $(PRODID)]---"
	$(GAE_PY) upload -A $(PRODID) $(FRONTEND_MODULES)

	# Note that we do not provide a command-line way to make the newly-uploaded
	# version the default version. This is for two reasons: a) You should be using
	# your browser to confirm that the new version works anyway, so just use the
	# console interface to make it the default; and b) If you really want to use
	# the command line you can use gae.py directly.