Add project-specific bootstrap
Bug: b/287529705
Change-Id: I716fa5cfc56e4c9636af5779e82ac0ce1dbe9716
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/152192
Reviewed-by: Darren Krahn <dkrahn@google.com>
Reviewed-by: Taylor Cramer <cramertj@google.com>
Commit-Queue: Rob Mohr <mohrr@google.com>
diff --git a/.gitignore b/.gitignore
index a9837dd..7b8bdd7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,4 @@
compile_commands.json
out
build_overrides/pigweed_environment.gni
+environment
diff --git a/activate.sh b/activate.sh
deleted file mode 100755
index 2cfc4c2..0000000
--- a/activate.sh
+++ /dev/null
@@ -1,20 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may not
-# use this file except in compliance with the License. You may obtain a copy of
-# the License at
-#
-# https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations under
-# the License.
-
-# Reactivates an environment previously bootstrapped.
-#
-# Usage: source activate.sh
-
-# Activate the pigweed environment.
-. third_party/pigweed/src/activate.sh
diff --git a/activate.sh b/activate.sh
new file mode 120000
index 0000000..eba5389
--- /dev/null
+++ b/activate.sh
@@ -0,0 +1 @@
+bootstrap.sh
\ No newline at end of file
diff --git a/banner.txt b/banner.txt
new file mode 100644
index 0000000..cda6557
--- /dev/null
+++ b/banner.txt
@@ -0,0 +1,2 @@
+ [0m[33m █▀█ █▀█ █▀▀ █▄░█ ▄ █▀▄ █░▄▀▀ █▀▀ [0m █▀███ █████
+ [0m[33m █▄█ █▀▀░██▄ █░▀█ ▀ █▄▀ █ ▀▄▄ ██▄░[0m ███▄█ ██▄██
diff --git a/bootstrap.sh b/bootstrap.sh
old mode 100755
new mode 100644
index 181daec..53a4a63
--- a/bootstrap.sh
+++ b/bootstrap.sh
@@ -12,27 +12,125 @@
# License for the specific language governing permissions and limitations under
# the License.
-# Sets up an environment ready to build and run tests. For example, 'pw watch'
-# should work in this environment.
+# This script must be sourced, not executed.
#
-# Usage: source bootstrap.sh
+# Create a new environment:
+#
+# source bootstrap.sh
+#
+# Activate an existing environment:
+#
+# source activate.sh
-# Update submodules, initializing if necessary. This will pin all submodules to
-# the committed revision so don't run this with uncommitted changes in a
-# submodule. By convention, submodules are pinned to an upstream revision and
-# any changes should be submitted upstream. Local changes to submodules are not
-# carried long term, but patches waiting to land upstream may be applied
-# manually.
-git submodule update --init
+_bootstrap_abspath () {
+ $(command -v python3 || command -v python2 || command -v python) -c "import os.path; print(os.path.abspath('$@'))"
+}
-# Bootstrap the pigweed environment.
-. third_party/pigweed/src/bootstrap.sh
+# Shell: bash.
+if test -n "$BASH"; then
+ _BOOTSTRAP_PATH="$(_bootstrap_abspath "$BASH_SOURCE")"
+# Shell: zsh.
+elif test -n "$ZSH_NAME"; then
+ _BOOTSTRAP_PATH="$(_bootstrap_abspath "${(%):-%N}")"
+# Shell: dash.
+elif test ${0##*/} = dash; then
+ _BOOTSTRAP_PATH="$(_bootstrap_abspath \
+ "$(lsof -p $$ -Fn0 | tail -1 | sed 's#^[^/]*##;')")"
+# If everything else fails, try $0. It could work.
+else
+ _BOOTSTRAP_PATH="$(_bootstrap_abspath "$0")"
+fi
-# Copy the pigweed environment config with a path fixup.
-sed s/environment/third_party\\\/pigweed\\\/src\\\/environment/g \
- < third_party/pigweed/src/build_overrides/pigweed_environment.gni \
- > build_overrides/pigweed_environment.gni
-gn format build_overrides/pigweed_environment.gni
+# Check if this file is being executed or sourced.
+_pw_sourced=0
+if [ -n "$SWARMING_BOT_ID" ]; then
+ # If set we're running on swarming and don't need this check.
+ _pw_sourced=1
+elif [ -n "$ZSH_EVAL_CONTEXT" ]; then
+ case $ZSH_EVAL_CONTEXT in *:file) _pw_sourced=1;; esac
+elif [ -n "$KSH_VERSION" ]; then
+ [ "$(cd $(dirname -- $0) && pwd -P)/$(basename -- $0)" != \
+ "$(cd $(dirname -- ${.sh.file}) && pwd -P)/$(basename -- ${.sh.file})" ] \
+ && _pw_sourced=1
+elif [ -n "$BASH_VERSION" ]; then
+ (return 0 2>/dev/null) && _pw_sourced=1
+else # All other shells: examine $0 for known shell binary filenames
+ # Detects `sh` and `dash`; add additional shell filenames as needed.
+ case ${0##*/} in sh|dash) _pw_sourced=1;; esac
+fi
-# Setup the build.
-gn gen --export-compile-commands out
+# Downstream projects need to set something other than PW_ROOT here, like
+# YOUR_PROJECT_ROOT. Please also set PW_PROJECT_ROOT and PW_ROOT before
+# invoking pw_bootstrap or pw_activate.
+######### BEGIN PROJECT-SPECIFIC CODE #########
+OPEN_DICE_ROOT="$(_bootstrap_abspath "$(dirname "$_BOOTSTRAP_PATH")")"
+export OPEN_DICE_ROOT
+PW_PROJECT_ROOT="$OPEN_DICE_ROOT"
+PW_ROOT="$OPEN_DICE_ROOT/third_party/pigweed/src"
+
+# Set your project's banner and color.
+PW_BRANDING_BANNER="$OPEN_DICE_ROOT/banner.txt"
+export PW_BRANDING_BANNER
+PW_BRANDING_BANNER_COLOR=magenta
+export PW_BRANDING_BANNER_COLOR
+
+open_dice_banner() {
+ cat "$PW_BRANDING_BANNER"
+ echo
+}
+
+PW_BANNER_FUNC="open_dice_banner"
+########## END PROJECT-SPECIFIC CODE ##########
+export PW_BANNER_FUNC
+export PW_PROJECT_ROOT
+export PW_ROOT
+
+_util_sh="$PW_ROOT/pw_env_setup/util.sh"
+
+# Double-check that the Pigweed submodule has been checked out.
+if [ ! -e "$_util_sh" ]; then
+ echo "Error: $_util_sh not found."
+ echo "Did you forget to initialize the git submodules?"
+ echo "To setup the git submodules run:"
+ echo " git submodule update --init"
+ return
+fi
+
+. "$_util_sh"
+
+pw_deactivate
+pw_eval_sourced "$_pw_sourced"
+pw_check_root "$PW_ROOT"
+_PW_ACTUAL_ENVIRONMENT_ROOT="$(pw_get_env_root)"
+export _PW_ACTUAL_ENVIRONMENT_ROOT
+SETUP_SH="$_PW_ACTUAL_ENVIRONMENT_ROOT/activate.sh"
+
+# Run full bootstrap when invoked as bootstrap, or env file is missing/empty.
+if [ "$(basename "$_BOOTSTRAP_PATH")" = "bootstrap.sh" ] || \
+ [ ! -f "$SETUP_SH" ] || \
+ [ ! -s "$SETUP_SH" ]; then
+# This is where pw_bootstrap is called. Most small projects will include
+# --use-pigweed-defaults.
+######### BEGIN PROJECT-SPECIFIC CODE #########
+ pw_bootstrap --shell-file "$SETUP_SH" --install-dir "$_PW_ACTUAL_ENVIRONMENT_ROOT" --config-file "$PW_PROJECT_ROOT/pigweed.json"
+########## END PROJECT-SPECIFIC CODE ##########
+ pw_finalize bootstrap "$SETUP_SH"
+else
+ pw_activate
+ pw_finalize activate "$SETUP_SH"
+fi
+
+if [ "$_PW_ENV_SETUP_STATUS" -eq 0 ]; then
+# This is where any additional checks about the environment should go.
+######### BEGIN PROJECT-SPECIFIC CODE #########
+ echo -n
+########## END PROJECT-SPECIFIC CODE ##########
+fi
+
+unset _pw_sourced
+unset _BOOTSTRAP_PATH
+unset SETUP_SH
+unset _bootstrap_abspath
+unset _util_sh
+
+pw_cleanup
diff --git a/pigweed.json b/pigweed.json
new file mode 100644
index 0000000..afb6cad
--- /dev/null
+++ b/pigweed.json
@@ -0,0 +1,33 @@
+{
+ "pw": {
+ "pw_cli": {
+ "plugins": {
+ "presubmit": {
+ "module": "open_dice_tools.presubmit",
+ "function": "main"
+ }
+ }
+ },
+ "pw_presubmit": {
+ "format": {
+ "python_formatter": "black",
+ "exclude": [
+ "third_party/.*/src"
+ ]
+ }
+ },
+ "pw_env_setup": {
+ "root_variable": "OPEN_DICE_ROOT",
+ "cipd_package_files": [
+ "third_party/pigweed/src/pw_env_setup/py/pw_env_setup/cipd_setup/default.json"
+ ],
+ "virtualenv": {
+ "gn_root": ".",
+ "gn_targets": [
+ ":python.install"
+ ]
+ },
+ "gni_file": "build_overrides/pigweed_environment.gni"
+ }
+ }
+}
