Warden doctor, environment infomation gathering command

[hardyjohnson]

New Warden command: doctor

Description

I have recently spent time going through various bug reports across the wardenenv landscape and it got me thinking that it might be useful to build a command similar to the brew doctor command which when run would output system, warden and environment information relevant to filing a bug report.

Many bug reports require multiple back and forth between a dev and a user in order to understand how the user's environments is configured.

I made a demo script I may open a PR for later after some cleanup and gathering of feedback.

Currently I see something like the output below, where we can ask that this be run and its output attached to bug reports.

Good things to have from the environment (OS/version, Docker or container runner and version, wardenenv images, tags and architecture, environments and loaded configuration, mutagen sync status, etc.).

Let me know what you think. What additional information would you like to see as a developer?

In progress

• Formatting
• Cross platform support
• Scrub paths

Future Enhancements

• Show related .ssh/config entries for any of the project services / hosts

Example output

./bin/warden doctor                                                                                                                                   
macOS
15.3.2

Docker version 28.0.1, build 068a01e
Docker Compose version v2.33.1-desktop.1

Warden version: in-dev

Warden image, tag and architecture:

wardenenv/varnish:7.6:arm64
wardenenv/nginx:1.16:arm64
wardenenv/opensearch:2.12:arm64
wardenenv/dnsmasq:latest:arm64
wardenenv/php-fpm:8.3-magento2-xdebug3:arm64
wardenenv/php-fpm:8.3-magento2:arm64
wardenenv/mariadb:10.6:arm64
wardenenv/redis:7.2:arm64
wardenenv/rabbitmq:3.13:arm64

"acdemo - running(8)"
[
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/networks.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/php-fpm.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/php-fpm.darwin.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/nginx.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/nginx.darwin.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/db.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/magento2/db.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/opensearch.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/varnish.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/rabbitmq.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/includes/redis.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/magento2/magento2.base.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/environments/magento2/magento2.darwin.yml",
  "/Users/exampleuser/code/adobecommerce/.warden/warden-env.yml"
]
"websitetools - exited(1)"
[
  "/Users/exampleuser/code/website-tools/sites/website.tools/docker-compose.yml"
]
"warden - running(4)"
[
  "/opt/homebrew/Cellar/warden/0.15.0/docker/docker-compose.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/docker/docker-compose.mailpit.yml",
  "/opt/homebrew/Cellar/warden/0.15.0/docker/docker-compose.dnsmasq.yml"
]

Found the following running environments:
    acdemo a magento2 project
       Project Directory: /Users/exampleuser/code/adobecommerce
       Project URL: https://app.acdemo.test

--------------------------------------------------------------------------------
Identifier: sync_mHAc5cut85L7E4imVwEz6r4mkplUlEWuwXta13k4dwN
Alpha:
	URL: /Users/exampleuser/code/adobecommerce/src
	Connected: Yes
	Synchronizable contents:
		36526 directories
		86621 files (607 MB)
		0 symbolic links
Beta:
	URL: docker://1f3e8f51013170a3114221af4d5e3836394e566b0d171886441b8923db8065d7/var/www/html
	Connected: Yes
	Synchronizable contents:
		36526 directories
		86621 files (607 MB)
		0 symbolic links
Status: Watching for changes

[ihor-sviziev]

@hardyjohnson, it would be really useful.
Since you provided some output, maybe you can contribute the command to the warden as a pull request?

[navarr]

@ihor-sviziev It's under review! #858