Skip to content

Commit

Permalink
[TASK] Introduce Build/Scripts/runTests.sh (#1262)
Browse files Browse the repository at this point in the history
Following the scheme provided by @sbuerk

This change introduces `Build/Scripts/runTests.sh`
execution wrapper in line with current TYPO3
Core implementation.

We introduce cgl and linting tests for code includes. And apply cgl.
  • Loading branch information
linawolf authored May 25, 2024
1 parent 9cb8858 commit 7181c3f
Show file tree
Hide file tree
Showing 11 changed files with 588 additions and 73 deletions.
45 changes: 45 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: tests

on:
push:
pull_request:

jobs:
lint:
name: Linting
runs-on: ubuntu-latest
strategy:
matrix:
php:
- '8.2'
- '8.3'
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Lint PHP
run: Build/Scripts/runTests.sh -p ${{ matrix.php }} -s lint

quality:
name: Quality
runs-on: ubuntu-latest
env:
php: '8.2'
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install testing system
run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerUpdate

- name: Composer validate
run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerValidate

- name: Composer normalize
run: Build/Scripts/runTests.sh -p ${{ env.php }} -s composerNormalize -n

- name: CGL
run: Build/Scripts/runTests.sh -n -p ${{ env.php }} -s cgl -n

- name: Lint YAML
run: Build/Scripts/runTests.sh -p ${{ env.php }} -s yamlLint
1 change: 1 addition & 0 deletions Build/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
testing-docker/.env
76 changes: 76 additions & 0 deletions Build/.php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?php

declare(strict_types=1);

use PhpCsFixer\Config;
use PhpCsFixer\Finder;

return (new Config())
->setFinder(
(new Finder())
->in(__DIR__.'/../Documentation')
)
->setRiskyAllowed(true)
->setRules([
'@DoctrineAnnotation' => true,
// @todo: Switch to @PER-CS2.0 once php-cs-fixer's todo list is done: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/7247
'@PER-CS1.0' => true,
'array_indentation' => true,
'array_syntax' => ['syntax' => 'short'],
'cast_spaces' => ['space' => 'none'],
// @todo: Can be dropped once we enable @PER-CS2.0
'concat_space' => ['spacing' => 'one'],
'declare_equal_normalize' => ['space' => 'none'],
'declare_parentheses' => true,
'dir_constant' => true,
// @todo: Can be dropped once we enable @PER-CS2.0
'function_declaration' => [
'closure_fn_spacing' => 'none',
],
'function_to_constant' => ['functions' => ['get_called_class', 'get_class', 'get_class_this', 'php_sapi_name', 'phpversion', 'pi']],
'type_declaration_spaces' => true,
'global_namespace_import' => ['import_classes' => false, 'import_constants' => false, 'import_functions' => false],
'list_syntax' => ['syntax' => 'short'],
// @todo: Can be dropped once we enable @PER-CS2.0
'method_argument_space' => true,
'modernize_strpos' => true,
'modernize_types_casting' => true,
'native_function_casing' => true,
'no_alias_functions' => true,
'no_blank_lines_after_phpdoc' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_extra_blank_lines' => true,
'no_leading_namespace_whitespace' => true,
'no_null_property_initialization' => true,
'no_short_bool_cast' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_superfluous_elseif' => true,
'no_trailing_comma_in_singleline' => true,
'no_unneeded_control_parentheses' => true,
'no_unused_imports' => true,
'no_useless_nullsafe_operator' => true,
'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
'php_unit_construct' => ['assertions' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame']],
'php_unit_mock_short_will_return' => true,
'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
'phpdoc_no_access' => true,
'phpdoc_no_empty_return' => true,
'phpdoc_no_package' => true,
'phpdoc_scalar' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
'return_type_declaration' => ['space_before' => 'none'],
'single_quote' => true,
'single_space_around_construct' => true,
'single_line_comment_style' => ['comment_types' => ['hash']],
// @todo: Can be dropped once we enable @PER-CS2.0
'single_line_empty_body' => true,
'trailing_comma_in_multiline' => ['elements' => ['arguments', 'arrays', 'match', 'parameters']],
'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],

// We need this for documentation!
'no_useless_else' => false, // We want to preserve else with comments only
]);
Loading

0 comments on commit 7181c3f

Please sign in to comment.