Set default PHP_CodeSniffer configuration by fredden · Pull Request #38115 · magento/magento2

fredden · 2023-10-24T11:59:19Z

Description

When running vendor/bin/phpcs (or vendor/bin/phpcbf) without any arguments, and error is shown. When running vendor/bin/phpcs on a specific file, the "wrong" standard is applied. This pull request sets the "correct" defaults for PHP_CodeSniffer so that both of these scenarios work as expected - ie, that they scan the expected files with the Magento2Framework standard.

See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file

Manual testing scenarios

Run vendor/bin/phpcs without any arguments.
Run vendor/bin/phpcs app/bootstrap.php
- Compare with vendor/bin/phpcs --standard=Magento2Framework app/bootstrap.php

Contribution checklist

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] Set default PHP_CodeSniffer configuration #38122: Set default PHP_CodeSniffer configuration

m2-assistant · 2023-10-24T11:59:23Z

Hi @fredden. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

magento-automated-testing · 2023-10-24T11:59:56Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-Bravo · 2023-10-25T11:07:42Z

@magento create issue

.phpcs.xml.dist

magento-automated-testing · 2023-12-08T16:45:32Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

engcom-November · 2024-09-20T08:46:21Z

Hello @fredden,

Thanks for the collaboration & contribution!

✔️ QA Passed

Steps to reproduce:

Run vendor/bin/phpcs without any arguments.
Run vendor/bin/phpcs app/bootstrap.php
Compare with vendor/bin/phpcs --standard=Magento2Framework app/bootstrap.php

Before: ✖️

Both commends gave different outputs.

After: ✔️

Both commends gave same outputs.

Thank you.

engcom-November · 2024-09-20T08:47:06Z

@magento run all tests

engcom-November · 2024-09-20T14:54:36Z

Since builds are failed moving this to Extended testing.

engcom-November · 2024-09-23T06:39:08Z

@magento run Functional Tests B2B, Functional Tests EE

engcom-November · 2024-09-23T11:12:30Z

There are no repeating failures in Functional tests B2B.

Functional Tests B2B:
Run 1:

Run 2:

Hence moving this to Merge in progress.

engcom-Dash · 2024-12-10T10:33:04Z

Moving it back to ET to analyze the build result, as the build URL was not attached in the #38115 (comment) about flaky tests

engcom-Dash · 2024-12-10T10:33:36Z

@magento run all tests

engcom-Dash · 2024-12-10T12:55:09Z

@magento run all tests

engcom-Dash · 2024-12-11T06:17:15Z

@magento run Unit Tests, Functional Tests EE, Functional Tests CE, Functional Tests B2B

engcom-Dash · 2024-12-11T11:02:46Z

The functional test failures for B2B, CE, and EE in the last two builds are either inconsistent or related to known issues, and there are open JIRAs for them. The unit test failures are also flaky and have been observed in other PRs (here) as well. These failures are neither related to this PR nor caused by any changes in this PR. Hence moving it to Merge in Progress.
Unit Test:
Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/0e806052ff9302b2d74059bd890d35c9/Unit/console-error-logs.html

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/a84040b212d51836b23ad044924f89a4/Unit/console-error-logs.html

Functional Tests EE
Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/d5e826d36803883cc40e799555cced92/Functional/allure-report-ee/index.html#categories/762df7c18f05a4693d997cb40603bbc2/ac5db74b53237258/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/d635d13184e6c2ba9b4425573992895c/Functional/allure-report-ee/index.html#categories/4efb00f37310b8ab45095ac65ad97358/1f474ed7dcf21e3f/

Known Issue:
AdminCreateUserRoleWithLimitedPermissionTest: ACQE-6591

Functional Tests CE
Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/b806ad224b1ac638b0d8f8326b5e13c1/Functional/allure-report-ce/index.html#categories/762df7c18f05a4693d997cb40603bbc2/7a5e70861312605f/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/c5a43da38f5fbe9cf561bbd1c4e2a4fc/Functional/allure-report-ce/index.html#categories/8fb3a91ba5aaf9de24cc8a92edc82b5d

Known Issue:
AdminCreateUserRoleWithLimitedPermissionTest: ACQE-6591

Functional Tests B2B
Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/d5231f0eda1376cb03ede8225f500665/Functional/allure-report-b2b/index.html#categories/762df7c18f05a4693d997cb40603bbc2/653563e26bf25f60/

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/dea32b43808aa614aa4f775d04d20f79/Functional/allure-report-b2b/index.html#categories/8fb3a91ba5aaf9de24cc8a92edc82b5d

Known Issue:
AdminCreateUserRoleWithLimitedPermissionTest: ACQE-6591

engcom-Charlie · 2025-07-03T07:23:04Z

@magento run all tests

engcom-Charlie · 2025-09-11T12:27:37Z

We are getting static test failures, when we are merging this PR into mainline(2.4-develop). For now moving it to Extended Testing to analyze and work on the failure

engcom-Charlie · 2026-04-08T07:50:11Z

@magento run all tests

Set default PHP_CodeSniffer configuration/standard

b0735d3

m2-github-services added Partner: Youwe partners-contribution Pull Request is created by Magento Partner labels Oct 24, 2023

m2-assistant bot mentioned this pull request Oct 25, 2023

[Issue] Set default PHP_CodeSniffer configuration #38122

Open

5 tasks

engcom-Bravo added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Oct 25, 2023

m2-community-project bot added the Progress: pending review label Oct 25, 2023

ihor-sviziev reviewed Dec 8, 2023

View reviewed changes

.phpcs.xml.dist Show resolved Hide resolved

m2-community-project bot assigned ihor-sviziev Dec 8, 2023

m2-community-project bot added Progress: review and removed Progress: pending review labels Dec 8, 2023

fredden added 2 commits December 8, 2023 16:28

Merge remote-tracking branch 'upstream/2.4-develop' into phpcs-default

934cf69

Remove unused ruleset.xml file

519ebb2

fredden requested a review from ihor-sviziev July 14, 2024 09:15

ihor-sviziev approved these changes Jul 15, 2024

View reviewed changes

m2-community-project bot added Progress: ready for testing and removed Progress: review labels Jul 15, 2024

engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Jul 15, 2024

engcom-November self-assigned this Sep 19, 2024

engcom-November added Progress: testing in progress and removed Progress: ready for testing labels Sep 19, 2024

engcom-Dash self-assigned this Sep 19, 2024

m2-community-project bot added Progress: ready for testing and removed Progress: testing in progress labels Sep 19, 2024

Merge branch '2.4-develop' into phpcs-default

02ed1f7

engcom-Dash removed their assignment Sep 19, 2024

engcom-November removed the Progress: ready for testing label Sep 19, 2024

engcom-November added the Progress: testing in progress label Sep 19, 2024

engcom-November added Progress: extended testing and removed Progress: testing in progress labels Sep 20, 2024

engcom-November added Progress: accept and removed Progress: extended testing labels Sep 23, 2024

Merge branch '2.4-develop' into phpcs-default

505cf1b

Merge branch '2.4-develop' into phpcs-default

475bdf6

Priyakshic added the Project: Community Picked PRs upvoted by the community label Feb 12, 2025

Merge branch '2.4-develop' into phpcs-default

701b54f

engcom-Charlie moved this from Merge in Progress to Extended testing (optional) in Community Dashboard Sep 11, 2025

fredden and others added 2 commits February 13, 2026 19:23

Merge remote-tracking branch 'upstream/2.4-develop' into phpcs-default

1988eec

Merge branch '2.4-develop' into phpcs-default

d71a65d

engcom-Charlie self-assigned this Apr 8, 2026

Merge branch '2.4-develop' into phpcs-default

3a67f4b

Conversation

fredden commented Oct 24, 2023 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Manual testing scenarios

Contribution checklist

Resolved issues:

Uh oh!

m2-assistant bot commented Oct 24, 2023

Uh oh!

magento-automated-testing bot commented Oct 24, 2023

Uh oh!

engcom-Bravo commented Oct 25, 2023

Uh oh!

Uh oh!

magento-automated-testing bot commented Dec 8, 2023

Uh oh!

engcom-November commented Sep 20, 2024

✔️ QA Passed

Before: ✖️

After: ✔️

Uh oh!

engcom-November commented Sep 20, 2024

Uh oh!

engcom-November commented Sep 20, 2024

Uh oh!

engcom-November commented Sep 23, 2024

Uh oh!

engcom-November commented Sep 23, 2024

Uh oh!

engcom-Dash commented Dec 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Dash commented Dec 10, 2024

Uh oh!

engcom-Dash commented Dec 10, 2024

Uh oh!

engcom-Dash commented Dec 11, 2024

Uh oh!

engcom-Dash commented Dec 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Charlie commented Jul 3, 2025

Uh oh!

engcom-Charlie commented Sep 11, 2025

Uh oh!

engcom-Charlie commented Apr 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

fredden commented Oct 24, 2023 •

edited by m2-assistant bot

Loading

engcom-Dash commented Dec 10, 2024 •

edited

Loading

engcom-Dash commented Dec 11, 2024 •

edited

Loading