feat: Add Makefile for constistent sample interface (GoogleCloudPlatform#8863)

muncus · web-flow · commit ef36b96f7132 · 2023-11-21T09:52:44.000-08:00
* feat: Add Makefile for constistent sample interface

* rename env var to match proposal, add maven flags from CI

* use GOOGLE_CLOUD_PROJECT as backup for project id source

* add a note about ADCs for usage
diff --git a/Makefile b/Makefile
@@ -0,0 +1,47 @@
+# Makefile for running typical developer workflow actions.
+# To run actions in a subdirectory of the repo:
+#   make lint build dir=translate/snippets
+# Note: testing requires Application Default Credentials.
+# For details about ADC, see https://cloud.google.com/docs/authentication/application-default-credentials
+
+INTERFACE_ACTIONS="build test lint"
+
+.ONESHELL: #ease subdirectory work by using the same subshell for all commands
+.-PHONY: *
+
+# Default to current dir if not specified.
+dir ?= $(shell pwd)
+
+
+# GOOGLE_SAMPLES_PROJECT takes precedence over GOOGLE_CLOUD_PROJECT
+PROJECT_ID = ${GOOGLE_SAMPLES_PROJECT}
+PROJECT_ID ?= ${GOOGLE_CLOUD_PROJECT}
+# export our project ID as GOOGLE_CLOUD_PROJECT in the action environment
+override GOOGLE_CLOUD_PROJECT := ${PROJECT_ID}
+export GOOGLE_CLOUD_PROJECT
+
+build:
+	cd ${dir}
+	mvn compile
+
+test: check-env build
+	cd ${dir}
+	mvn --quiet --batch-mode --fail-at-end clean verify \
+    -Dfile.encoding="UTF-8" \
+    -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn \
+    -Dmaven.test.redirectTestOutputToFile=true \
+    -Dbigtable.projectID="${GOOGLE_CLOUD_PROJECT}" \
+    -Dbigtable.instanceID=instance
+
+lint:
+	cd ${dir}
+	mvn -P lint checkstyle:check
+
+check-env:
+ifndef PROJECT_ID
+	$(error At least one of the following env vars must be set: GOOGLE_SAMPLES_PROJECT, GOOGLE_CLOUD_PROJECT.)
+endif
+
+list-actions:
+	@ echo ${INTERFACE_ACTIONS}
+
