README

[已废弃] MediaCT 测试套件

此包已被废弃且不会获得任何支持。我们已用youwe 测试套件替换。

此包作为MediaCT几个测试包的父包。

安装

composer require mediact/testing-suite --dev

使用方法

可以通过GrumPHP命令运行测试套件。

vendor/bin/grumphp run

测试套件也通过git提交钩子自动在每次git提交时运行。

组件

以下组件是测试套件的一部分。

编码风格验证（PHPCS）

使用PHPCS验证编码风格，并使用MediaCT 编码标准。

在测试套件的安装过程中，会在仓库根目录添加一个名为phpcs.xml的文件，该文件引用了编码标准。要调整编码标准，可以编辑并提交此文件。

根据项目的composer类型，将使用其他标准

magento-module: MediaCT 编码标准 Magento1
magento2-module: MediaCT 编码标准 Magento2
magento-project: MediaCT 编码标准 Magento1
magento2-project: MediaCT 编码标准 Magento2

覆盖类型

可以在composer.json的config节点中通过添加testing-suite-type到配置来覆盖项目的类型。这将允许使用不同类型的标准。此节点的允许值包括

magento1
magento2
default

配置如下

{
  "config": {
    "mediact-testing-suite": {
      "type": "magento2"
    }
  }
}

这有助于在app/code文件夹中开发时，强制测试套件自动选择正确的标准。

编码复杂性验证（PHPMD）

使用PHPMD验证代码的复杂性。在测试套件的安装过程中添加了一个名为phpmd.xml的文件。

静态代码分析（PHPStan）

使用PHPStan执行静态代码分析。在测试套件的安装过程中添加了一个名为phpstan.neon的文件。

单元测试（PHPUnit）

单元测试使用PHPUnit执行。在安装测试套件期间会添加一个名为phpunit.xml的文件。

单元测试预期位于名为tests的目录中。代码预期位于名为src的目录中。

Bitbucket Pipelines

当项目托管在Bitbucket上时，将安装一个Pipelines脚本。脚本支持一个回调，该回调在执行composer install之前被调用。此回调可以用来向composer添加凭据。要启用回调，请转到Bitbucket设置 > 管道 > 环境变量并添加一个名为COMPOSER_PRE_INSTALL_CALLBACK的环境变量。

添加对repo.example.com的基本身份验证的示例

composer config --global http-basic.repo.example.com $YOUR_USER $YOUR_PASSWORD

ESLint

使用ESLint执行对Magento 1和Magento 2项目的JavaScript代码检查。在存储库的根目录中添加了两个文件.eslintrc.json和.eslintignore，这些文件包含编码标准和排除分析的文件。

还添加了一个名为package.json的第三个文件，其中包含所需的npm模块。安装后运行npm install以启用ESLint。

npm install

与PHPStorm集成

在PHPStorm环境中安装测试套件时，它会自动配置PHPStorm使用正确的编码风格。

要启用PHPStorm中的PHPCS和PHPMD检查，需要配置正确的二进制文件。这是一个PHPStorm的全局设置，因此测试套件不能配置。

获取正确二进制文件的建议方法是全局安装MediaCT编码标准。

composer global require mediact/coding-standard

该软件包将被安装在composer的主目录中。可以使用以下命令找到此目录的位置

composer global config home

打开PHPStorm并转到设置 > 语言 & 框架 > PHP > 代码检查。

对于开发环境，选择“本地”并填写到<composer_home_directory>/vendor/bin/phpcs的完整路径。

然后转到设置 > 语言 & 框架 > PHP > 代码质量工具 > Mess Detector。

对于开发环境，选择“本地”并填写到<composer_home_directory>/vendor/bin/phpmd的完整路径。

经过这些调整后，在PHPStorm中输入时将验证编码风格和复杂性。

要启用ESLint，请打开PHPStorm并转到设置 > 语言 & 框架 > Javascript > 代码质量工具 > ESLint。

通过勾选启用来启用ESLint。然后设置Node解释器为项目，将配置文件设置为自动搜索。

mediact / testing-suite

维护者

详细信息