Initial release (#1)

jazzsequence · web-flow · commit cd391a8134aa · 2023-10-12T13:26:30.000-06:00
* add composer scripts

* quote wp_tests_dir and wp_core_dir

* fix linting

* require phpcs

* add lint workflow

* add autotag action

* update the up-to-date message

* drop closing brace to new line

* update readme

* add codeowners

* add a test that runs the plugin to validate the files were copied

* remove --prefer-dist from composer init

* use github.head_ref

* allow the wpunit-helpers plugin

* allow the plugin the right way

* use verbose output so we can see what's going on when we require

* run a ls to ensure we got a bin/

* remove verbose debug and test for a bin directory

* rename job to test

* explicitly add exit 1 if any of the files aren't found
and remove the -e which we don't need if we're explicitly exiting

* subshell the or

* remove $
diff --git a/.github/workflows/autotag.yml b/.github/workflows/autotag.yml
@@ -0,0 +1,15 @@
+name: Tag and Release
+on:
+ push:
+  branches:
+    - main
+permissions:
+  contents: write
+jobs:
+  tag-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pantheon-systems/action-autotag@v0
+        with:
+          gh-token: ${{ github.token }}   
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,11 @@
+name: Lint
+on: [pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: composer install
+      - name: Lint
+        run: composer lint
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,22 @@
+name: Test Plugin
+on: [pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup barebones project
+        run: |
+          mkdir test_proj && cd test_proj
+          composer init --name test/test --no-interaction --type=library --stability=dev
+          composer config repositories.wpunit-helpers '{"type": "vcs", "url": "https://github.com/pantheon-systems/wpunit-helpers.git"}'
+          composer config allow-plugins.pantheon-systems/wpunit-helpers true
+          composer require --dev pantheon-systems/wpunit-helpers:dev-${{ github.head_ref }}
+      - name: Validate that bin files were copied
+        run: |
+          cd ${{ github.workspace }}/test_proj
+          test -d bin || (echo "❌ bin directory not found" >&2 && exit 1)
+          test -f bin/install-wp-tests.sh || (echo "❌ bin/install-wp-tests.sh not found" >&2 && exit 1)
+          test -f bin/install-local-tests.sh || (echo "❌ bin/install-local-tests.sh not found" >&2 && exit 1)
+          test -f bin/phpunit-test.sh || (echo "❌ bin/phpunit-test.sh not found" >&2 && exit 1)
+          echo "✅ All bin files found"
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1 @@
+* @pantheon-systems/cms-platform
diff --git a/README.md b/README.md
@@ -1,2 +1,58 @@
-# wpunit-helpers
+# WPUnit Helpers
+[![Lint](https://github.com/pantheon-systems/wpunit-helpers/actions/workflows/lint.yml/badge.svg)](https://github.com/pantheon-systems/wpunit-helpers/actions/workflows/lint.yml) ![GitHub](https://img.shields.io/github/license/pantheon-systems/wpunit-helpers) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/pantheon-systems/wpunit-helpers) [![Unofficial Support](https://img.shields.io/badge/Pantheon-Unofficial%20Support-yellow?logo=pantheon&color=FFDC28)](https://docs.pantheon.io/oss-support-levels#unofficial-support)
+
 Unified scripts for installing and running automated WP Unit Tests.
+
+## What is this?
+
+This is a set of scripts that can be used in a WordPress plugin or theme repository to run automated tests using the WP Unit Test Framework built on top of PHPUnit. The Composer plugin will install these scripts into the dependent project's `bin` directory, allowing you to add helper scripts to your `composer.json`.
+
+## What's included?
+
+* `install-wp-tests.sh` - The _de facto_ standard script for installing the WP Unit Test Framework.
+* `install-local-tests.sh` - A helper script for installing WP Unit Tests locally. See [Local Testing](#local-testing) for more information.
+* `phpunit-test.sh` - A helper script for running WP Unit Tests that is intended for use in CI.
+
+## Installation
+
+Use Composer to install this package as a development dependency:
+
+```bash
+composer require --dev pantheon-systems/wpunit-helpers
+```
+
+On installation, the Composer plugin will copy the scripts into the `bin` directory of the dependent project. You can then add the scripts to your `composer.json`:
+
+```json
+{
+	"scripts": {
+		"phpunit": "phpunit --do-not-cache-result",
+		"test": "@phpunit",
+		"test:install": "bin/install-local-tests.sh --no-db",
+		"test:install:withdb": "bin/install-local-tests.sh"
+	}
+}
+```
+
+## Local Testing
+The `install-local-tests.sh` script is highly configurable to allow for a variety of local environment setups. Any parameter that could be passed into `install-wp-tests.sh` is set up as an optional flag in `install-local-tests.sh`. By default, the script with no flags will assume that a new database should be created as `root` with no password.
+
+### Flags
+
+#### `--no-db`
+This flag will skip the database creation step. This is useful if you are using a local database that is already set up.
+
+#### `--dbname`
+This flag will set the name of the database to be created. The default value is `wordpress_test`.
+
+#### `--dbuser`
+This flag will set the username of the database user to be created. The default value is `root`.
+
+#### `--dbpass`
+This flag will set the password of the database user to be created. The default value is an empty string.
+
+#### `--dbhost`
+This flag will set the host of the database to be created. The default value is `127.0.0.1`.
+
+#### `--wpversion`
+This flag will set the version of WordPress to be installed. The default value is `latest`. Using `nightly` here will use the latest nightly build of WordPress.
diff --git a/bin/phpunit-test.sh b/bin/phpunit-test.sh
@@ -7,7 +7,7 @@ DIRNAME=$(dirname "$0")
 bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 latest
 echo "Running PHPUnit on Single Site"
 composer phpunit
-rm -rf $WP_TESTS_DIR $WP_CORE_DIR
+rm -rf "$WP_TESTS_DIR" "$WP_CORE_DIR"
 
 bash "${DIRNAME}/install-wp-tests.sh" wordpress_test root root 127.0.0.1 nightly true
 echo "Running PHPUnit on Single Site (Nightly WordPress)"
diff --git a/composer.json b/composer.json
@@ -10,15 +10,29 @@
         }
     ],
     "minimum-stability": "dev",
+    "prefer-stable": true,
     "require": {
         "composer-plugin-api": "^2.3"
     },
+    "require-dev": {
+        "squizlabs/php_codesniffer": "^3.7"
+    },
     "autoload": {
         "psr-4": {
             "Pantheon\\WPUnitHelpers\\": "src/"
         }
     },
     "extra": {
         "class": "Pantheon\\WPUnitHelpers\\Plugin"
+    },
+    "scripts": {
+        "shellcheck": "find bin/ -name \"*.sh\" | grep -v \"install-wp-tests.sh\" | xargs shellcheck",
+        "phpcs": "phpcs --standard=PSR2 src/",
+        "phplint": "find src/ -name '*.php' -exec php -l {} \\;",
+        "lint": [
+            "@shellcheck",
+            "@phpcs",
+            "@phplint"
+        ]
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/src/Plugin.php b/src/Plugin.php
@@ -35,11 +35,11 @@ public static function getSubscribedEvents()
             'post-install-cmd' => ['copyBinDirectory'],
             'post-update-cmd' => ['copyBinDirectory'],
         );
-    } 
+    }
 
     public function copyBinDirectory()
-    {   
-        $io = $this->io;     
+    {
+        $io = $this->io;
         $vendorDir = $this->composer->getConfig()->get('vendor-dir');
         $binDir = $vendorDir . '/pantheon-systems/wpunit-helpers/bin';
         $targetDir = dirname($vendorDir) . '/bin';
@@ -82,12 +82,14 @@ public function copyBinDirectory()
             \"phpunit\": \"phpunit --do-not-cache-result\",
             \"test\": \"@phpunit\",
             \"test:install\": \"bin/install-local-tests.sh --no-db\",
-            \"test:install:withdb\": \"bin/install-local-tests.sh\"}";
+            \"test:install:withdb\": \"bin/install-local-tests.sh\"
+        }";
     
         if (!$filesAreIdentical) {
-            $io->write("Done copying files into /bin. You can now add the following to your composer.json file: \n $composerIncludes");
+            $io->write("Done copying files into /bin.");
+            $io->write("You can now add the following to your composer.json file: \n $composerIncludes");
         } else {
-            $io->write("/bin files are already up to date");
+            $io->write("/bin files are up to date");
         }
     }
-}
+}
