Skip to content

Winter v1.3 Support #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jaxwilko wants to merge 25 commits into
base: main
Choose a base branch
from
Open

Winter v1.3 Support #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
19be060
Added support for php-parser v5
jaxwilko Jul 25, 2025
d9a0d6f
Added bump to php-parser in composer.json
jaxwilko Jul 25, 2025
8229df8
Added fix for risky tests
jaxwilko Jul 25, 2025
c70490e
Added debug code to test github action
jaxwilko Jul 25, 2025
048d352
Added removed debug
jaxwilko Jul 25, 2025
1b4d6da
Update unit-tests.yaml
LukeTowers Jul 26, 2025
f92b546
Update unit-tests.yaml
LukeTowers Jul 26, 2025
77933b2
Update .github/workflows/unit-tests.yaml
LukeTowers Jul 26, 2025
979c9b6
Update unit-tests.yaml
LukeTowers Jul 26, 2025
58c9220
Update unit-tests.yaml
LukeTowers Jul 26, 2025
0e77fdd
Update unit-tests.yaml
LukeTowers Jul 26, 2025
cf51955
Update unit-tests.yaml
LukeTowers Jul 26, 2025
300bd5d
Update unit-tests.yaml
LukeTowers Jul 26, 2025
ecaf82e
Update unit-tests.yaml
LukeTowers Jul 26, 2025
363d8f6
Update unit-tests.yaml
LukeTowers Jul 26, 2025
bdb70f9
Update unit-tests.yaml
LukeTowers Jul 26, 2025
c3bc14d
Update phpunit.xml
LukeTowers Jul 26, 2025
7d0d2a3
Update BuilderPluginTestCase.php
LukeTowers Jul 26, 2025
96848fe
Update ModelModelTest.php
LukeTowers Jul 26, 2025
363acf8
Update ModelFileParserTest.php
LukeTowers Jul 26, 2025
f8b2298
Update MigrationFileParserTest.php
LukeTowers Jul 26, 2025
8d44928
Update FilesystemGeneratorTest.php
LukeTowers Jul 26, 2025
6f9f7f9
Update unit-tests.yaml
LukeTowers Jul 26, 2025
757b990
v2.2.0
LukeTowers Jul 26, 2025
5ab5b8b
Merge branch 'main' into wip/1.3
LukeTowers Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 17 additions & 61 deletions .github/workflows/unit-tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,77 +3,33 @@ name: Unit Tests
on:
push:
branches:
- main
- 'main'
pull_request:

concurrency:
group: tests-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
phpUnitTests:
runs-on: ubuntu-latest
name: PHP ${{ matrix.phpVersions }}
name: ${{ matrix.operatingSystem }} / PHP ${{ matrix.phpVersion }}
runs-on: ${{ matrix.operatingSystem }}
env:
GITHUB_TOKEN: ${{ secrets.COMPOSER_PUBLIC_TOKEN }}
strategy:
max-parallel: 4
matrix:
phpVersions: ['8.1', '8.2', '8.3', '8.4']
operatingSystem: [ubuntu-latest, windows-latest]
phpVersion: ['8.2', '8.3', '8.4']
fail-fast: false
env:
phpExtensions: mbstring, intl, gd, xml, sqlite
cacheKey: ext-cache-v2
winterCmsRelease: develop
steps:
- name: Checkout changes
uses: actions/checkout@v4
with:
path: builder-plugin

- name: Setup cache environment
id: extcache
uses: shivammathur/cache-extensions@v1
with:
php-version: ${{ matrix.phpVersions }}
extensions: ${{ env.phpExtensions }}
key: ${{ env.cacheKey }}

- name: Cache extensions
uses: actions/cache@v4
- name: Setup Winter
uses: wintercms/setup-winter-action@v1
with:
path: ${{ steps.extcache.outputs.dir }}
key: ${{ steps.extcache.outputs.key }}
restore-keys: ${{ steps.extcache.outputs.key }}

- name: Install PHP and extensions
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.phpVersions }}
extensions: ${{ env.phpExtensions }}
tools: composer:v2
coverage: none

- name: Install Winter CMS
run: |
wget https://github.com/wintercms/winter/archive/${{ env.winterCmsRelease }}.zip
unzip ${{ env.winterCmsRelease }}.zip
rm ${{ env.winterCmsRelease }}.zip
shopt -s dotglob
mv winter-${{ env.winterCmsRelease }}/* ./
rmdir winter-${{ env.winterCmsRelease }}
shopt -u dotglob
cp config/cms.php config/testing/cms.php
mkdir -p plugins/winter
mv builder-plugin plugins/winter/builder

- name: Get Composer cache directory
id: composercache
run: echo "::set-output name=dir::$(composer config cache-files-dir)"

- name: Cache dependencies
uses: actions/cache@v4
with:
path: ${{ steps.composercache.outputs.dir }}
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
restore-keys: ${{ runner.os }}-composer-

- name: Install Composer dependencies
run: composer install --no-interaction --no-progress
php-version: ${{ matrix.phpVersion }}
winter-ref: wip/1.3
plugin-author: winter
plugin-name: builder

- name: Run unit tests
run: php artisan winter:test -p Winter.Builder -- --testdox
18 changes: 2 additions & 16 deletions classes/PhpSourceParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
namespace Winter\Builder\Classes;

use PhpParser\Error;
use PhpParser\Lexer\Emulative;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\CloningVisitor;
use PhpParser\NodeVisitor\NameResolver;
Expand Down Expand Up @@ -41,11 +40,6 @@ abstract class PhpSourceParser
*/
protected \PhpParser\NodeTraverser $traverser;

/**
* The lexer used to manipulate code.
*/
protected \PhpParser\Lexer\Emulative $lexer;

/**
* The path to the parsed file, if loaded from a file.
*/
Expand All @@ -58,15 +52,7 @@ abstract class PhpSourceParser
*/
public function __construct(string $source, string $file = null)
{
$this->lexer = new Emulative([
'usedAttributes' => [
'comments',
'startLine', 'endLine',
'startTokenPos', 'endTokenPos',
],
]);

$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7, $this->lexer);
$parser = (new ParserFactory())->createForHostVersion();

try {
$this->originalAst = $parser->parse($source);
Expand All @@ -78,7 +64,7 @@ public function __construct(string $source, string $file = null)
);
}

$this->originalTokens = $this->lexer->getTokens();
$this->originalTokens = $parser->getTokens();
$this->traverser = new NodeTraverser;
$this->traverser->addVisitor(new CloningVisitor);
$this->traverser->addVisitor(new NameResolver(null, [
Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"require": {
"php": ">=7.0",
"composer/installers": "~1.0",
"nikic/php-parser": "^4.13.2"
"nikic/php-parser": "^5.5"
},
"require-dev": {
"phpunit/phpunit": "~4.0"
Expand Down
6 changes: 0 additions & 6 deletions phpunit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
>
<testsuites>
Expand Down
16 changes: 5 additions & 11 deletions tests/BuilderPluginTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
<?php namespace Winter\Builder\Tests;
<?php

if (class_exists('System\Tests\Bootstrap\PluginTestCase')) {
class BaseTestCase extends \System\Tests\Bootstrap\PluginTestCase
{
}
} else {
class BaseTestCase extends \PluginTestCase
{
}
}
namespace Winter\Builder\Tests;

use System\Tests\Bootstrap\PluginTestCase;

abstract class BuilderPluginTestCase extends BaseTestCase
abstract class BuilderPluginTestCase extends PluginTestCase
{
protected $refreshPlugins = [
'Winter.Builder',
Expand Down
8 changes: 6 additions & 2 deletions tests/unit/classes/FilesystemGeneratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?php namespace Winter\Builder\Tests\Unit\Classes;
<?php

namespace Winter\Builder\Tests\Unit\Classes;

use File;
use Winter\Builder\Classes\FilesystemGenerator;
use Winter\Builder\Tests\BuilderPluginTestCase;
use Winter\Storm\Support\Facades\File;

class FilesystemGeneratorTest extends BuilderPluginTestCase
{
Expand All @@ -15,6 +17,8 @@ public function setUp(): void

public function tearDown(): void
{
parent::tearDown();

$this->cleanUp();
}
Comment on lines 18 to 23
Copy link

@coderabbitai coderabbitai bot Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Find tearDown() patterns in test files across the repository
rg -n -B2 -A5 'function tearDown' --type=php --glob '*Test.php'

Repository: wintercms/wn-builder-plugin

Length of output: 1142

🏁 Script executed:

#!/bin/bash
# Also search for variations in naming
fd -e php -path '*Test*' | head -20 | xargs rg -l 'tearDown' 2>/dev/null | head -10

Repository: wintercms/wn-builder-plugin

Length of output: 341

🏁 Script executed:

#!/bin/bash
# Look at the parent class to understand what it does in tearDown
rg -n 'class FilesystemGeneratorTest' --type=php -A 1

Repository: wintercms/wn-builder-plugin

Length of output: 231

🏁 Script executed:

#!/bin/bash
# Find the cleanUp method in the test file to understand dependencies
rg -n 'function cleanUp' --type=php -A 10

Repository: wintercms/wn-builder-plugin

Length of output: 539

🏁 Script executed:

#!/bin/bash
# Find the parent class BuilderPluginTestCase
fd -type f -name '*.php' | xargs grep -l 'class BuilderPluginTestCase'

Repository: wintercms/wn-builder-plugin

Length of output: 243

🏁 Script executed:

#!/bin/bash
# Search for BuilderPluginTestCase and its tearDown method
rg -n 'class BuilderPluginTestCase' -A 30 --type=php

Repository: wintercms/wn-builder-plugin

Length of output: 408

🏁 Script executed:

#!/bin/bash
# Look for where BuilderPluginTestCase is defined and check parent tearDown
rg -n 'tearDown' tests/ --type=php -B 2 -A 8 | head -60

Repository: wintercms/wn-builder-plugin

Length of output: 1878

🏁 Script executed:

#!/bin/bash
# Find PluginTestCase definition
find . -name '*.php' -type f | xargs grep -l 'class PluginTestCase' 2>/dev/null

Repository: wintercms/wn-builder-plugin

Length of output: 55

🏁 Script executed:

#!/bin/bash
# Check if it's in vendor or external packages
rg 'class PluginTestCase' -A 15

Repository: wintercms/wn-builder-plugin

Length of output: 53

🏁 Script executed:

#!/bin/bash
# Check composer dependencies to understand where PluginTestCase comes from
cat composer.json | jq '.require' 2>/dev/null || cat composer.json | grep -A 20 '"require"'

Repository: wintercms/wn-builder-plugin

Length of output: 154

🏁 Script executed:

#!/bin/bash
# Check the setUp method in FilesystemGeneratorTest to verify the pattern
rg -n 'function setUp' -A 5 tests/unit/classes/FilesystemGeneratorTest.php

Repository: wintercms/wn-builder-plugin

Length of output: 186

🏁 Script executed:

#!/bin/bash
# Check setUp in ModelModelTest too for comparison
rg -n 'function setUp' -A 5 tests/unit/classes/ModelModelTest.php

Repository: wintercms/wn-builder-plugin

Length of output: 53

🏁 Script executed:

#!/bin/bash
# Search for any documentation or comments about tearDown ordering in the codebase
rg -i 'teardown.*parent\|parent.*teardown' -B 2 -A 2

Repository: wintercms/wn-builder-plugin

Length of output: 53

Reorder cleanUp() before parent::tearDown() to ensure proper cleanup.

The setUp() method calls parent::setUp() first and then cleanUp(). The tearDown() method should mirror this in reverse order: cleanup first, then parent. Currently, calling parent::tearDown() before cleanUp() risks tearing down the application container before the File facade is used by File::deleteDirectory(), potentially causing the cleanup to silently fail and leave test artifacts on disk.

Proposed fix 
     public function tearDown(): void
     {
-        parent::tearDown();
-
         $this->cleanUp();
+
+        parent::tearDown();
     }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
public function tearDown(): void
{
parent::tearDown();
$this->cleanUp();
}
public function tearDown(): void
{
$this->cleanUp();
parent::tearDown();
}
🤖 Prompt for AI Agents 
In `@tests/unit/classes/FilesystemGeneratorTest.php` around lines 18 - 23, The
tearDown() order is wrong: call your cleanup before tearing down the test parent
to avoid using Laravel features after the container is destroyed. In the
FilesystemGeneratorTest class, move the $this->cleanUp() call to run before
parent::tearDown() (mirror the setUp() order), ensuring cleanup logic that uses
File::deleteDirectory() executes while the application/container is still
available.


Expand Down
25 changes: 6 additions & 19 deletions tests/unit/classes/MigrationFileParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@

namespace Winter\Builder\Tests\Unit\Classes;

use PHPUnit\Framework\Attributes\CoversClass;
use Winter\Builder\Classes\MigrationFileParser;
use Winter\Builder\Tests\BuilderPluginTestCase;

/**
* @covers \Winter\Builder\Classes\MigrationFileParser
*/
#[CoversClass(MigrationFileParser::class)]
class MigrationFileParserTest extends BuilderPluginTestCase
{
/**
* @testdox can determine if a file is a migration class definition.
*/
public function testIsMigration()
public function test_it_can_determine_if_file_is_class_migration()
{
$firstMigration = MigrationFileParser::fromFile(
__DIR__ . '/../../fixtures/pluginfixture/updates/create_simple_model_table.php'
Expand All @@ -30,10 +26,7 @@ public function testIsMigration()
$this->assertFalse($notAMigration->isMigration());
}

/**
* @testdox can determine if a file is an anonymous class definition.
*/
public function testIsAnonymous()
public function test_it_can_determine_if_file_is_anonymous_migration()
{
$firstMigration = MigrationFileParser::fromFile(
__DIR__ . '/../../fixtures/pluginfixture/updates/create_simple_model_table.php'
Expand All @@ -50,10 +43,7 @@ public function testIsAnonymous()
$this->assertTrue($notAMigration->isAnonymous());
}

/**
* @testdox can get the namespace of a class.
*/
public function testGetNamespace()
public function test_it_can_get_namespace_of_class()
{
$firstMigration = MigrationFileParser::fromFile(
__DIR__ . '/../../fixtures/pluginfixture/updates/create_simple_model_table.php'
Expand All @@ -70,10 +60,7 @@ public function testGetNamespace()
$this->assertNull($notAMigration->getNamespace());
}

/**
* @testdox can get the class name of a class.
*/
public function testGetClassName()
public function test_it_can_get_class_name_of_class()
{
$firstMigration = MigrationFileParser::fromFile(
__DIR__ . '/../../fixtures/pluginfixture/updates/create_simple_model_table.php'
Expand Down
29 changes: 6 additions & 23 deletions tests/unit/classes/ModelFileParserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,10 @@
use Winter\Builder\Classes\ModelFileParser;
use Winter\Builder\Tests\BuilderPluginTestCase;

/**
* @covers \Winter\Builder\Classes\ModelFileParser
*/
#[\PHPUnit\Framework\Attributes\CoversClass(ModelFileParser::class)]
class ModelFileParserTest extends BuilderPluginTestCase
{
/**
* @testdox can get information for the model from the parser.
*/
public function testExtractModelInfoFromSource()
public function test_it_can_get_information_for_model_from_parser()
{
$parser = ModelFileParser::fromFile(__DIR__ . '/../../fixtures/pluginfixture/models/SimpleModel.php');
$modelInfo = $parser->extractModelInfoFromSource();
Expand All @@ -23,21 +18,15 @@ public function testExtractModelInfoFromSource()
$this->assertEquals('plugin_fixture_simple_model', $modelInfo['table']);
}

/**
* @testdox can generate and provide the source code of a given model from the parser.
*/
public function testGetSource()
public function test_it_can_generate_and_provide_source_of_given_model_from_parser()
{
$parser = ModelFileParser::fromFile(__DIR__ . '/../../fixtures/pluginfixture/models/SimpleModel.php');
$source = $parser->getSource();

$this->assertEquals(file_get_contents(__DIR__ . '/../../fixtures/pluginfixture/models/SimpleModel.php'), $source);
}

/**
* @testdox can get the value of the $jsonable property from a model.
*/
public function testGetJsonable()
public function test_it_can_get_value_of_jsonable_from_model()
{
$parser = ModelFileParser::fromFile(__DIR__ . '/../../fixtures/pluginfixture/models/SimpleModel.php');
$jsonable = $parser->getJsonable();
Expand All @@ -50,10 +39,7 @@ public function testGetJsonable()
], $jsonable);
}

/**
* @testdox can set the value of the $jsonable property in a model.
*/
public function testSetJsonable()
public function test_it_can_set_value_of_jsonable_in_model()
{
$parser = ModelFileParser::fromFile(__DIR__ . '/../../fixtures/pluginfixture/models/ArrayDataModel.php');
$parser->setJsonable([
Expand All @@ -65,10 +51,7 @@ public function testSetJsonable()
$this->assertStringContainsString('public $jsonable = [\'field_1\', \'field_2\'];', $source);
}

/**
* @testdox can inject the $jsonable property in a model that does not contain it.
*/
public function testSetJsonableAddProperty()
public function test_it_can_inject_jsonable_property_in_model_without_it()
{
$parser = ModelFileParser::fromFile(__DIR__ . '/../../fixtures/pluginfixture/models/SimpleModel.php');
$parser->setJsonable([
Expand Down
27 changes: 10 additions & 17 deletions tests/unit/classes/ModelModelTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
<?php namespace Winter\Builder\Tests\Unit\Classes;
<?php

namespace Winter\Builder\Tests\Unit\Classes;

use SystemException;
use Winter\Builder\Classes\ModelModel;
use Winter\Builder\Classes\PluginCode;
use Winter\Builder\Tests\BuilderPluginTestCase;
use Winter\Storm\Exception\SystemException;

/**
* @covers \Winter\Builder\Classes\ModelModel
*/
#[\PHPUnit\Framework\Attributes\CoversClass(ModelModel::class)]
class ModelModelTest extends BuilderPluginTestCase
{
public function tearDown(): void
{
parent::tearDown();

// Ensure cleanup for testGetModelFields
@unlink(__DIR__.'/../../../models/MyMock.php');
}

/**
* @testdox validates valid model class names
*/
public function testValidateValidModelClassNames()
public function test_it_validates_model_class_names()
{
$unQualifiedClassName = 'MyClassName';
$this->assertTrue(ModelModel::validateModelClassName($unQualifiedClassName));
Expand All @@ -34,10 +33,7 @@ public function testValidateValidModelClassNames()
$this->assertTrue(ModelModel::validateModelClassName($qualifiedClassNameStartingWithLowerCase));
}

/**
* @testdox does not validate invalid model class names
*/
public function testInvalidateInvalidModelClassNames()
public function test_it_does_not_validate_invalid_model_class_names()
{
$unQualifiedClassName = 'myClassName'; // starts with lower case
$this->assertFalse(ModelModel::validateModelClassName($unQualifiedClassName));
Expand All @@ -49,10 +45,7 @@ public function testInvalidateInvalidModelClassNames()
$this->assertFalse(ModelModel::validateModelClassName($fullyQualifiedClassName));
}

/**
* @testdox can extract the model fields from a given model
*/
public function testGetModelFields()
public function test_it_can_extract_model_fields_from_model()
{
// Invalid Class Name
try {
Expand Down
1 change: 1 addition & 0 deletions updates/version.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@
- "Fixed an issue where migration files stored within subdirectories could not be read or saved."
- "The permissions data table is now scrollable and will stretch to full height."
"2.1.1": "Fix issue when creating new plugins"
"2.2.0": "Support Winter v1.3+"