Flutter安全报告插件danger_plugin_golden

Flutter安全报告插件danger_plugin_golden_reporter的使用

此插件用于报告创建和修改的黄金结果。

使用方法

首先，在pubspec.yaml文件中添加此插件：

dev_dependencies:
  danger_core:
  danger_plugin_golden_reporter:

接下来，在dangerfile.dart文件中导入此插件，并调用DangerPluginGoldenReporter.report方法，传入黄金结果路径。以下是一个完整的示例：

import 'dart:io';

import 'package:danger_core/danger_core.dart';
import 'package:danger_plugin_golden_reporter/danger_plugin_golden_reporter.dart';

void main() {
  // 调用report方法并传入黄金结果路径
  DangerPluginGoldenReporter.report('test/goldens');
}

更多关于Flutter安全报告插件danger_plugin_golden_reporter的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

sinazl 1楼作者

更多关于Flutter安全报告插件danger_plugin_golden_reporter的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

danger_plugin_golden_reporter 是一个用于 Flutter 项目的 Danger 插件，主要用于在代码审查过程中自动生成和比较 Golden 测试的截图。Golden 测试是 Flutter 中的一种视觉回归测试，用于确保 UI 在不同情况下保持一致。

以下是如何使用 danger_plugin_golden_reporter 的步骤：

1. 安装 Danger

首先，你需要在你的项目中安装 Danger。Danger 是一个用于自动化代码审查的工具，通常与 CI/CD 系统集成。

# 使用 Bundler 安装 Danger
gem install danger

或者在你的 Gemfile 中添加：

gem 'danger'

然后运行 bundle install。

2. 在项目中配置 Danger

在项目的根目录下创建一个 Dangerfile 文件，并配置 Danger。

# Dangerfile

# 引入 danger_plugin_golden_reporter
danger.import_plugin('danger_plugin_golden_reporter')

# 配置 Golden 测试报告
danger.golden_reporter.report_golden_tests

3. 安装 `danger_plugin_golden_reporter` 插件

你可以通过以下命令安装 danger_plugin_golden_reporter 插件：

gem install danger_plugin_golden_reporter

或者在你的 Gemfile 中添加：

gem 'danger_plugin_golden_reporter'

然后运行 bundle install。

4. 运行 Golden 测试

确保你的项目中已经设置了 Golden 测试。通常，Golden 测试会生成一些截图，并将其与预先保存的基准截图进行比较。

在 Flutter 中，你可以使用 flutter test --update-goldens 来更新 Golden 测试的基准截图。

5. 在 CI/CD 中集成 Danger

在你的 CI/CD 配置文件中（如 .travis.yml 或 .github/workflows/ci.yml），添加运行 Danger 的步骤。

例如，在 GitHub Actions 中：

name: CI

on: [pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 2.7
      - name: Install dependencies
        run: bundle install
      - name: Run Danger
        run: bundle exec danger

6. 查看报告

当你提交 Pull Request 时，Danger 会自动运行，并在 PR 的评论中生成 Golden 测试的报告。报告中会显示哪些 Golden 测试失败，以及相关的截图差异。

7. 处理失败的 Golden 测试

如果 Golden 测试失败，你需要检查生成的截图与基准截图之间的差异。如果差异是预期的，你可以更新基准截图并重新运行测试。

flutter test --update-goldens

然后提交更新后的基准截图，并重新推送更改。

8. 自定义配置

你可以根据需要自定义 danger_plugin_golden_reporter 的配置，例如指定截图保存的路径、忽略某些文件等。

# Dangerfile

danger.golden_reporter.report_golden_tests(
  golden_directory: 'test/goldens',
  ignore_files: ['test/goldens/ignored.png']
)

Flutter安全报告插件danger_plugin_golden_reporter的使用