✅ Move tests to Pest

Author: retlehs

.github/workflows/test.yml

@@ -28,13 +28,15 @@ jobs:
       - name: Install composer dependencies
         run: composer install --optimize-autoloader
 
+      - name: Execute the Composer lint script
+        run: composer run-script lint
+
       - name: Build prefixed vendor
         run: composer run build
 
       - name: Install wp-playground CLI
         run: npm install -g @wp-playground/cli
 
-
       - name: Start wp-playground with blueprint
         run: |
           echo "Starting wp-playground server in background..."
@@ -61,72 +63,8 @@ jobs:
           # Wait for WordPress to be ready
           sleep 10
 
-      - name: Test single post markdown output
-        run: |
-          echo "Testing single post with ?format=markdown"
-
-          # Check if server is responding
-          echo "Checking server status..."
-          curl -v "http://localhost:9400/" || echo "Server not responding"
-
-          echo "Testing markdown endpoint..."
-          response=$(curl -s "http://localhost:9400/hello-world/?format=markdown")
-          echo "Response received: $response"
-
-          if [[ "$response" == *"# Hello world"* ]] && [[ "$response" == *"WordPress"* ]]; then
-            echo "✅ Single post markdown query parameter test passed"
-          else
-            echo "❌ Single post markdown query parameter test failed"
-            exit 1
-          fi
-
-      - name: Test single post with Accept header
-        run: |
-          echo "Testing single post with Accept: text/markdown header"
-          response=$(curl -s -H "Accept: text/markdown" "http://localhost:9400/hello-world/")
-
-          if [[ "$response" == *"# Hello world"* ]] && [[ "$response" == *"WordPress"* ]]; then
-            echo "✅ Single post Accept header test passed"
-          else
-            echo "❌ Single post Accept header test failed"
-            exit 1
-          fi
-
-      - name: Test main feed markdown
-        run: |
-          echo "Testing main feed with ?format=markdown"
-          response=$(curl -s "http://localhost:9400/feed/?format=markdown")
-
-          if [[ "$response" == *"Markdown Feed"* ]] && [[ "$response" == *"Hello world"* ]]; then
-            echo "✅ Main feed markdown test passed"
-          else
-            echo "❌ Main feed markdown test failed"
-            exit 1
-          fi
-
-      - name: Test dedicated markdown feed
-        run: |
-          echo "Testing dedicated /feed/markdown/ endpoint"
-          response=$(curl -s "http://localhost:9400/feed/markdown/")
-
-          if [[ "$response" == *"Markdown Feed"* ]] && [[ "$response" == *"Hello world"* ]]; then
-            echo "✅ Dedicated markdown feed test passed"
-          else
-            echo "❌ Dedicated markdown feed test failed"
-            exit 1
-          fi
-
-      - name: Test content type headers
-        run: |
-          echo "Testing Content-Type headers"
-          content_type=$(curl -s -I "http://localhost:9400/hello-world/?format=markdown" | grep -i "content-type")
-
-          if [[ "$content_type" == *"text/markdown"* ]]; then
-            echo "✅ Content-Type header test passed"
-          else
-            echo "❌ Content-Type header test failed"
-            exit 1
-          fi
+      - name: Run Pest tests
+        run: composer run test
 
       - name: Cleanup
         if: always()

README.md

@@ -6,6 +6,20 @@ A WordPress plugin that returns post content in Markdown format when requested w
 
 PHP 8.1+
 
+## Installation
+
+### via Composer
+
+```bash
+composer require roots/post-content-to-markdown
+```
+
+### Manual
+
+1. Download the [latest release](https://github.com/roots/post-content-to-markdown/releases)
+2. Place in `wp-content/plugins/post-content-to-markdown/`
+3. Activate via wp-admin or WP-CLI
+
 ## Usage
 
 ### Accept headers (ideal for LLMs)
@@ -107,22 +121,6 @@ The plugin automatically adds a `<atom:link>` element to your site's RSS feed, a
 <atom:link href="https://example.com/feed/markdown/" rel="alternate" type="text/markdown" />
 ```
 
-## Installation
-
-### via Composer
-
-```bash
-composer require roots/post-content-to-markdown
-```
-
-### Manual
-
-1. Download the [latest release](https://github.com/roots/post-content-to-markdown/releases)
-2. Place in `wp-content/plugins/post-content-to-markdown/`
-3. Activate via wp-admin or WP-CLI
-
-**Note:** After activation, you may need to flush rewrite rules by visiting Settings → Permalinks and clicking "Save Changes" if the `/feed/markdown/` endpoint doesn't work immediately.
-
 ## Filters
 
 The plugin provides several filters for customization:

composer.json

@@ -12,12 +12,22 @@
         }
     ],
     "scripts": {
-        "build": "vendor/bin/php-scoper add-prefix --force && cd vendor_prefixed && composer dump-autoload"
+        "build": "vendor/bin/php-scoper add-prefix --force && cd vendor_prefixed && composer dump-autoload",
+        "lint": "vendor/bin/pint",
+        "test": "vendor/bin/pest"
     },
     "require": {
+        "php": "^8.1",
         "league/html-to-markdown": "^5.1"
     },
     "require-dev": {
-        "humbug/php-scoper": "0.18.7"
+        "humbug/php-scoper": "0.18.7",
+        "laravel/pint": "^1.20",
+        "pestphp/pest": "^2.36"
+    },
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     }
 }

package.json

@@ -0,0 +1,7 @@
+{
+  "name": "post-content-to-markdown",
+  "private": true,
+  "scripts": {
+    "playground": "npx @wp-playground/cli server --mount=\"$(pwd):/wordpress/wp-content/plugins/post-content-to-markdown\" --blueprint=blueprint.json"
+  }
+}

phpunit.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Feature">
+            <directory>tests/Feature</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory>.</directory>
+        </include>
+        <exclude>
+            <directory>vendor</directory>
+            <directory>vendor_prefixed</directory>
+            <directory>tests</directory>
+        </exclude>
+    </source>
+</phpunit>

post-content-to-markdown.php

@@ -5,6 +5,7 @@
  * Description: Serve post content as Markdown via Accept headers or query parameters.
  * Version: 1.2.0
  * Author: roots.io
+ * Requires PHP: 8.1
  */
 
 namespace PostContentToMarkdown;

tests/Feature/MarkdownOutputTest.php

@@ -0,0 +1,50 @@
+<?php
+
+test('wordpress site loads', function () {
+    $response = makeRequest('/');
+
+    expect($response['body'])->not->toBeEmpty();
+});
+
+test('single post returns markdown with query parameter', function () {
+    $response = makeRequest('/hello-world/?format=markdown');
+
+    expect($response['body'])
+        ->toContain('# Hello world')
+        ->toContain('WordPress');
+});
+
+test('single post returns markdown with Accept header', function () {
+    $response = makeRequest('/hello-world/', [
+        'Accept' => 'text/markdown',
+    ]);
+
+    expect($response['body'])
+        ->toContain('# Hello world')
+        ->toContain('WordPress');
+});
+
+test('main feed returns markdown with query parameter', function () {
+    $response = makeRequest('/feed/?format=markdown');
+
+    expect($response['body'])
+        ->toContain('Markdown Feed')
+        ->toContain('Hello world');
+});
+
+test('dedicated markdown feed endpoint works', function () {
+    $response = makeRequest('/feed/markdown/');
+
+    expect($response['body'])
+        ->toContain('Markdown Feed')
+        ->toContain('Hello world');
+});
+
+test('content type header is set to text/markdown', function () {
+    $response = makeRequest('/hello-world/?format=markdown');
+
+    expect($response['headers'])
+        ->toHaveKey('content-type')
+        ->and($response['headers']['content-type'])
+        ->toContain('text/markdown');
+});

tests/Pest.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Make an HTTP request to the WordPress Playground instance
+ */
+function makeRequest(string $path, array $headers = []): array
+{
+    $url = 'http://localhost:9400'.$path;
+
+    $context_options = [
+        'http' => [
+            'method' => 'GET',
+            'header' => implode("\r\n", array_map(
+                fn ($key, $value) => "$key: $value",
+                array_keys($headers),
+                array_values($headers)
+            )),
+            'ignore_errors' => true,
+        ],
+    ];
+
+    $context = stream_context_create($context_options);
+    $response = @file_get_contents($url, false, $context);
+
+    // Parse response headers
+    $responseHeaders = [];
+    if (isset($http_response_header)) {
+        foreach ($http_response_header as $header) {
+            if (str_contains($header, ':')) {
+                [$key, $value] = explode(':', $header, 2);
+                $responseHeaders[strtolower(trim($key))] = trim($value);
+            }
+        }
+    }
+
+    return [
+        'body' => $response !== false ? $response : '',
+        'headers' => $responseHeaders,
+    ];
+}