Skip to content

Set default PHP_CodeSniffer configuration#38115

Open
fredden wants to merge 11 commits into
magento:2.4-developfrom
fredden:phpcs-default
Open

Set default PHP_CodeSniffer configuration#38115
fredden wants to merge 11 commits into
magento:2.4-developfrom
fredden:phpcs-default

Conversation

@fredden

@fredden fredden commented Oct 24, 2023

Copy link
Copy Markdown
Member

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

  1. Run vendor/bin/phpcs without any arguments.
  2. 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:

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

@m2-assistant

m2-assistant Bot commented Oct 24, 2023

Copy link
Copy Markdown

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:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. 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.

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

Copy link
Copy Markdown

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

Copy link
Copy Markdown
Contributor

@magento create issue

@engcom-Bravo engcom-Bravo added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Oct 25, 2023
Comment thread .phpcs.xml.dist
@magento-automated-testing

Copy link
Copy Markdown

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.

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

Copy link
Copy Markdown
Contributor

There are no repeating failures in Functional tests B2B.

Functional Tests B2B:
Run 1:
image

Run 2:
image

Hence moving this to Merge in progress.

@engcom-Dash

engcom-Dash commented Dec 10, 2024

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor

@magento run all tests

@engcom-Dash

Copy link
Copy Markdown
Contributor

@magento run all tests

@engcom-Dash

Copy link
Copy Markdown
Contributor

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

@engcom-Dash

engcom-Dash commented Dec 11, 2024

Copy link
Copy Markdown
Contributor

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
image

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

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/
image

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/
image

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/
image

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
image

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/
image

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
image

Known Issue:
AdminCreateUserRoleWithLimitedPermissionTest: ACQE-6591

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

Copy link
Copy Markdown
Contributor

@magento run all tests

@engcom-Charlie

Copy link
Copy Markdown
Contributor

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

image

@engcom-Charlie engcom-Charlie moved this from Merge in Progress to Extended testing (optional) in Community Dashboard Sep 11, 2025
@engcom-Charlie engcom-Charlie self-assigned this Apr 8, 2026
@engcom-Charlie

Copy link
Copy Markdown
Contributor

@magento run all tests

@engcom-Charlie

Copy link
Copy Markdown
Contributor

@magento run all tests

@engcom-Charlie

Copy link
Copy Markdown
Contributor

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

@engcom-Charlie

Copy link
Copy Markdown
Contributor

Few of the Functional failures are not consistent in recent 2 builds. They are neither failing because of the PR nor part of the PR, consider to be flaky. The consistent failures are known issues also we have merged this PR into mainline PR(target to 2.4-develop ) and not getting mentioned static test failure hence moving this PR to Merge in Progress.

Functional B2B- Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/e876f4f753a16955c04095ee9e83c22c/Functional/allure-report-ee/index.html#categories
image

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/47a959232bd7becf1465aa9e795d89c4/Functional/allure-report-b2b/index.html#categories/a983aaae5f7d23e0a2cf6efd576061fa/4d0f2d629dc181d0/

image

Functional CE- Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/58e8d4d8404affc41271bb56266ef56e/Functional/allure-report-ce/index.html#categories

image

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

image

Functional EE- Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/d19859799501ffa060c01c791252b13f/Functional/allure-report-b2b/index.html#categories
image

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/38115/c6118510be8b255c3af4d1dae6c11715/Functional/allure-report-ee/index.html#categories
image

Known Issues:
ACQE-9671: TextInlineWidgetEditingSpecialCharacterTest
ACQE-9672: TextInlineImageEditingTest

@engcom-Charlie engcom-Charlie moved this from Extended testing (optional) to Merge in Progress in Community Dashboard Apr 10, 2026
@engcom-Charlie

engcom-Charlie commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

The static test failures are still coming when we merge this PR into mainline PR(2.4-develop). Moving it back to Extended Testing to analyze

image

@engcom-Charlie engcom-Charlie moved this to Extended testing (optional) in Community Dashboard Apr 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Partner: Youwe partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Project: Community Picked PRs upvoted by the community Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Projects

Status: Extended testing (optional)

Development

Successfully merging this pull request may close these issues.

[Issue] Set default PHP_CodeSniffer configuration

8 participants