Merge pull request #20 from UCEAP/reorg-scripts

Consolidate command line scripts

Author: kurowski

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "editor.insertSpaces": false
+}

Dockerfile

@@ -4,6 +4,11 @@ FROM mcr.microsoft.com/devcontainers/php:8.3
 RUN sed -i 's/^UMASK\s*022/UMASK 002/' /etc/login.defs
 RUN usermod -aG www-data vscode
 
+# Add glow for formatting command usage output (and because it's just nice)
+RUN mkdir -p /etc/apt/keyrings \
+    && curl -fsSL https://repo.charm.sh/apt/gpg.key | gpg --dearmor -o /etc/apt/keyrings/charm.gpg \
+    && echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | tee /etc/apt/sources.list.d/charm.list
+
 # Install MariaDB and Redis and PHP (incl Apache) and Cypress dependencies
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && apt-get install -y libpng-dev libzip-dev libicu-dev \
@@ -14,7 +19,7 @@ RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && docker-php-ext-enable redis zip \
     && apt-get install -y mariadb-client redis-tools \
     && apt-get install -y npm libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2 libxtst6 xauth xvfb \
-    && apt-get install -y dnsutils pv \
+    && apt-get install -y dnsutils glow pv \
     && apt-get clean -y && rm -rf /var/lib/apt/lists/*
 
 # Configure PHP, make memory_limit and upload_max_filesize match Pantheon
@@ -34,12 +39,6 @@ RUN sed -i 's/Listen\s*80$/# Listen 80/' /etc/apache2/ports.conf
 RUN curl -L https://github.com/pantheon-systems/terminus/releases/latest/download/terminus.phar --output /usr/local/bin/terminus
 RUN chmod +x /usr/local/bin/terminus
 
-# Copy devcontainer scripts
-COPY uceap-drupal-dev-* /usr/local/bin/
-RUN mkdir -p /usr/local/etc/uceap-dev
-COPY example.drush.yml /usr/local/etc/uceap-dev
-COPY vscode-*.json /usr/local/etc/uceap-dev
-
 # Install atuin
 #
 # # The recommended way to install atuin is to use cargo, but that takes *forever*:
@@ -52,3 +51,6 @@ RUN curl -sL $(curl -s https://api.github.com/repos/atuinsh/atuin/releases/lates
 
 # Our base image has an ancient version of gh cli in apt, so we download the latest version instead
 RUN curl -sL $(curl -s https://api.github.com/repos/cli/cli/releases/latest | jq -r '.assets[] | select(.name | endswith("_linux_'`uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`'.tar.gz")) | .browser_download_url') | tar zx --no-same-owner --wildcards --absolute-names --transform 's,[^/]*,/usr/local,' '*/gh'
+
+# Copy our scripts and template files
+COPY local /usr/local/

README.md

@@ -2,38 +2,38 @@ A docker image supporting [GitHub Codespaces](https://github.com/features/codesp
 
 Refer to the UCEAP Software Engineering Playbook for more information on how to [setup your development environment](https://itse-playbook.uceap.work/fundamentals/setup-your-development-environment/).
 
-## Personalization
-
-Devcontainers support dotfiles!
-
-See the [GitHub documentation](https://docs.github.com/en/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles) for more info, and check out [Brandt's personal dotfiles](https://github.com/kurowski/dotfiles) for an example.
-
-Visual Studio Code users should also look into the settings available in the Dev Containers extension, such as [Default Extensions](vscode://settings/dev.containers.defaultExtensions) to automatically install your favorite extensions in devcontainers.
 
-## Quality of life
+## Helper script
 
-This image includes several scripts that integrate with the devcontainer lifecycle, but these can also be used independently:
+This image includes a helper script that provides several commands to support features offered by this container. There are three main types of commands:
 
-* `/usr/local/bin/uceap-drupal-dev-on-create`
-* `/usr/local/bin/uceap-drupal-dev-post-create`
-* `/usr/local/bin/uceap-drupal-dev-post-start`
-* `/usr/local/bin/uceap-drupal-dev-update-content`
+- __deploy-*__: perform deployments to various environments
+- __devcontainer-*__: implementations of devcontainer lifecycle hooks
+- _all others_: functionality to support the local developer experience
 
-It also includes one that doesn't fit into the devcontainer lifecycle, but performs similar tasks:
+To see a list of available commands, run `uceap` in the terminal. You can also run `uceap help <command>` to see more information about a specific command.
 
-* `/usr/local/bin/uceap-drupal-dev-refresh-content`
+## Tips and tricks
 
-I frequently invoke `uceap-drupal-dev-refresh-content` to reset my local environment after switching branches. It runs `composer install` and invokes `db-rebuild.sh` with a fresh copy of the latest snapshot of the dev environment database and files. With zsh completions installed, it's as easy as `dev-re<TAB>`.
+I frequently invoke `uceap refresh-content` to reset my local environment after switching branches. It runs `composer install` and invokes `db-rebuild.sh` with a fresh copy of the latest snapshot of the dev environment database and files. With shell completions installed, it's as easy as `uce<TAB>r<TAB>`.
 
 > 👉 When working on a PR that adds update hooks or makes config changes, it's generally a good idea to make sure it applies cleanly to a database matching the QA environment. To do this, switch to the `qa` branch, run refresh-content, switch back to your branch, and run the deploy command (e.g. `drush md` for the portal):
 > ``` zsh
 > git checkout qa
-> uceap-drupal-dev-refresh-content
+> uceap refresh-content
 > git checkout -
 > composer install
 > drush $DRUSH_TASK
 > ```
 
-Sometimes a process can die or port forwarding can fail. `uceap-drupal-dev-post-start` runs a few commands that should get things working again. (Again, zsh shell completion makes this `post-s<TAB>`).
+Sometimes a process can die or port forwarding can fail. `uceap devcontainer-post-start` runs a few commands that should get things working again. (Again, shell completion makes this `uce<TAB>sta<TAB>`).
+
+Using devcontainers facilitates treating local environments as ephemeral: they're quick and easy to set up. Treat them as safe to destroy because you can always create a new one (or multiple new ones, to suit your needs). One thing you might miss is your shell history. Check out [Atuin](https://atuin.sh/) to sync your shell history across environments. `Control-R` has never looked so good 😎
 
-Using devcontainers faciliates treating local environments as ephemeral: they're quick and easy to setup. Treat them as safe to destroy because you can always create a new one (or multiple new ones, to suit your needs). One thing you might miss is your shell history. Check out [Atuin](https://atuin.sh/) to sync your shell history across environments. `Control-R` has never looked so good 😎
+## Personalization
+
+Devcontainers support dotfiles!
+
+See the [GitHub documentation](https://docs.github.com/en/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles) for more info, and check out [Brandt's personal dotfiles](https://github.com/kurowski/dotfiles) for an example.
+
+Visual Studio Code users should also look into the settings available in the Dev Containers extension, such as [Default Extensions](vscode://settings/dev.containers.defaultExtensions) to automatically install your favorite extensions in devcontainers.

local/bin/uceap

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# we often use this script in CI pipelines, so we treat every error as fatal
+set -eo pipefail
+
+parent_dir=$(dirname "$0}")/..
+. $parent_dir/etc/uceap.sh
+
+uceap "$@"

local/bin/uceap-drupal-dev-on-create

@@ -0,0 +1,2 @@
+#!/bin/bash
+uceap devcontainer-on-create

local/bin/uceap-drupal-dev-post-create

@@ -0,0 +1,2 @@
+#!/bin/bash
+uceap devcontainer-post-create

local/bin/uceap-drupal-dev-post-start

@@ -0,0 +1,2 @@
+#!/bin/bash
+uceap devcontainer-post-start

local/bin/uceap-drupal-dev-refresh-content

@@ -0,0 +1,2 @@
+#!/bin/bash
+uceap devcontainer-refresh-content

local/bin/uceap-drupal-dev-update-content

@@ -0,0 +1,2 @@
+#!/bin/bash
+uceap devcontainer-update-content

local/etc/uceap.d/_assert_terminus_vars.sh

@@ -0,0 +1,16 @@
+function _assert_terminus_vars() {
+	if [ -z "$TERMINUS_ENV" ]; then
+		echo "TERMINUS_ENV environment variable is not set."
+		exit 1
+	fi
+
+	if [ -z "$TERMINUS_SITE" ]; then
+		echo "TERMINUS_SITE environment variable is not set."
+		exit 1
+	fi
+
+	if [ -z "$DRUSH_TASK" ]; then
+		echo "DRUSH_TASK environment variable is not set."
+		exit 1
+	fi
+}