Skip to content

Commit

Permalink
Update dependencies and refactored some tests for code quality enhanc…
Browse files Browse the repository at this point in the history
…ement (#185)

Reorganized dependencies and removed unused files for overall code optimization. Some enhancements to tests were made to improve quality assurance. Also incorporated rector checks and license checks via Github Actions workflows to ensure code integrity.
  • Loading branch information
Spomky authored Apr 23, 2024
1 parent 934f1dc commit 1b4fabf
Show file tree
Hide file tree
Showing 27 changed files with 519 additions and 374 deletions.
7 changes: 1 addition & 6 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,12 @@
/tests export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/castor.php export-ignore
/CODE_OF_CONDUCT.md export-ignore
/ecs.php export-ignore
/infection.json.dist export-ignore
/link export-ignore
/Makefile export-ignore
/phpstan.neon export-ignore
/phpstan-baseline.neon export-ignore
/phpunit.xml.dist export-ignore
/rector.php export-ignore
/bin export-ignore
/babel.config.js export-ignore
/jest.config.js export-ignore
/rollup.config.js export-ignore
/tsconfig.json export-ignore
32 changes: 0 additions & 32 deletions .github/workflows/coding-standards.yml

This file was deleted.

18 changes: 0 additions & 18 deletions .github/workflows/exported_files.yml

This file was deleted.

30 changes: 30 additions & 0 deletions .github/workflows/infection.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "Infection"

on:
push:
branches:
- "*.x"

jobs:
mutation_testing:
name: "0️⃣ Mutation Testing"
runs-on: "ubuntu-latest"
steps:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "8.3"
extensions: "json, mbstring, sockets, gd, curl, imagick"
tools: castor

- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Install dependencies"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "highest"
composer-options: "--optimize-autoloader"

- name: "Execute Infection"
run: "castor infect"
221 changes: 221 additions & 0 deletions .github/workflows/integrate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
name: "Integrate"

on:
push:
branches:
- "*.x"
pull_request: null

jobs:
byte_level:
name: "0️⃣ Byte-level"
runs-on: "ubuntu-latest"
steps:
- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Check file permissions"
run: |
test "$(find . -type f -not -path './.git/*' -executable)" == ""
- name: "Find non-printable ASCII characters"
run: |
! LC_ALL=C.UTF-8 find . -type f -name "*.php" -print0 | xargs -0 -- grep -PHn "[^ -~]"
syntax_errors:
name: "1️⃣ Syntax errors"
runs-on: "ubuntu-latest"
steps:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "8.3"
extensions: "json, mbstring, sockets, gd, curl, imagick"
tools: castor

- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Fetch Git base reference"
run: "git fetch --depth=1 origin ${GITHUB_BASE_REF}"

- name: "Validate Composer configuration"
run: "castor validate"

- name: "Install dependencies"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "${{ matrix.dependencies }}"
composer-options: "--optimize-autoloader"

- name: "Cache dependencies"
uses: "actions/cache@v4"
id: "cache"
with:
path: "composer-cache"
key: "${{ runner.os }}-${{ hashFiles('**/composer.json') }}"

- name: "Check source code for syntax errors"
run: "castor lint"

unit_tests:
name: "2️⃣ Unit and functional tests"
needs:
- "byte_level"
- "syntax_errors"
strategy:
matrix:
operating-system:
- "ubuntu-latest"
php-version:
- "8.2"
- "8.3"
dependencies:
- "highest"
runs-on: ${{ matrix.operating-system }}
steps:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "${{ matrix.php-version }}"
extensions: "json, mbstring, sockets, gd, curl, imagick"
tools: castor
coverage: "xdebug"

- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Install dependencies"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "${{ matrix.dependencies }}"
composer-options: "--optimize-autoloader"

- name: "Execute unit tests"
run: "castor test --coverage-text"

static_analysis:
name: "3️⃣ Static Analysis"
needs:
- "byte_level"
- "syntax_errors"
runs-on: "ubuntu-latest"
steps:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "8.3"
extensions: "json, mbstring, sockets, gd, curl, imagick"
tools: castor

- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Install dependencies"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "highest"
composer-options: "--optimize-autoloader"

- name: "Execute static analysis"
run: "castor stan"

coding_standards:
name: "4️⃣ Coding Standards"
needs:
- "byte_level"
- "syntax_errors"
runs-on: "ubuntu-latest"
steps:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "8.3"
extensions: "json, mbstring, sockets, gd, curl, imagick"
tools: castor

- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Install dependencies"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "highest"
composer-options: "--optimize-autoloader"

- name: "Check adherence to EditorConfig"
uses: "greut/eclint-action@v0"

- name: "Check coding style"
run: "castor cs"

check_licenses:
name: "5️⃣ Check licenses"
needs:
- "byte_level"
- "syntax_errors"
runs-on: "ubuntu-latest"
steps:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "8.3"
extensions: "json, mbstring, sockets, gd, curl, imagick"
tools: castor

- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Install dependencies"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "highest"
composer-options: "--optimize-autoloader"

- name: "Check coding style"
run: "castor check-licenses"

rector_checkstyle:
name: "6️⃣ Rector Checkstyle"
needs:
- "byte_level"
- "syntax_errors"
runs-on: "ubuntu-latest"
steps:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "8.3"
extensions: "json, mbstring, sockets, gd, curl, imagick"
tools: castor
coverage: "xdebug"

- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Install dependencies"
uses: "ramsey/composer-install@v3"
with:
dependency-versions: "highest"
composer-options: "--optimize-autoloader"

- name: "Execute Rector"
run: "castor rector"

exported_files:
name: "7️⃣ Exported files"
needs:
- "byte_level"
- "syntax_errors"
runs-on: "ubuntu-20.04"
steps:
- name: "Checkout code"
uses: "actions/checkout@v4"

- name: "Check exported files"
run: |
EXPECTED="LICENSE,README.md,RELEASES.md,SECURITY.md,composer.json"
CURRENT="$(git archive HEAD | tar --list --exclude="src" --exclude="src/*" --exclude="assets" --exclude="assets/*" --exclude="templates" --exclude="templates/*" | paste -s -d ",")"
echo "CURRENT =${CURRENT}"
echo "EXPECTED=${EXPECTED}"
test "${CURRENT}" == "${EXPECTED}"
29 changes: 0 additions & 29 deletions .github/workflows/rector_checkstyle.yaml

This file was deleted.

32 changes: 0 additions & 32 deletions .github/workflows/static-analyze.yml

This file was deleted.

Loading

0 comments on commit 1b4fabf

Please sign in to comment.