获取帮助

问问题应该选择哪个渠道？

如果您对 Mongo Task Generator 有任何疑问，请通过 Slack 上的 #server-testing 频道或通过电子邮件发送给我们 [email protected]。

我如何请求对 Mongo Task Generator 进行更改/报告错误？

在 Jira 中创建 DAG 票据。

我在票据或问题中应该包括哪些内容？

请尽可能提供更多信息。这可以帮助避免长时间的信息收集线程。

请包括以下内容

• 请求动机：为什么要进行这项更改？（这有助于我们了解请求的优先级和紧急性）
• 背景：是否有任何背景信息我们应该了解这个请求？
• 描述：您希望调查或更改什么？

依赖项

该项目旨在在Linux上运行。它已在Ubuntu 18.04上进行测试。

需要evergreen CLI。

安装

工具可以从github releases页面下载。它目前基于Ubuntu 18.04，应该适用于最近的x86 Linux发行版。

可以使用类似wget或curl的工具自动化安装。

wget https://github.com/mongodb/mongo-task-generator/releases/download/v0.1.0/mongo-task-generator

使用

要在mongodb仓库的根目录下生成任务信息，请运行mongo-task-generator命令。生成的配置将创建在generated_resmoke_config目录中。该目录中的evergreen_config.json文件应作为generate.tasks命令调用的部分传递给evergreen。

mongo-task-generator

USAGE:
    mongo-task-generator --evg-project-file <EVG_PROJECT_FILE> --expansion-file <EXPANSION_FILE> --evg-auth-file <EVG_AUTH_FILE>

OPTIONS:
        --evg-auth-file <EVG_AUTH_FILE>
            File with information on how to authenticate against the evergreen API

        --evg-project-file <EVG_PROJECT_FILE>
            File containing evergreen project configuration

        --expansion-file <EXPANSION_FILE>
            File containing expansions that impact task generation

    -h, --help
            Print help information

文档

有关任务生成工作的详细信息，请参阅生成任务。

贡献者指南

高级架构

任务生成流程图

graph TD
    A[Read Evergreen Project Config] -->B(For each task in each build variant)
    B --> C{task is generated?}
    C --> |No| B
    C -->|Yes| D{task is fuzzer?}
    D -->|Yes| E[Generate Fuzzer based on task definition]
    E --> B
    D -->|No| F[Lookup task runtime history from Evergreen]
    F --> G{valid history obtained?}
    G --> |Yes| H[Split task by test runtimes]
    G --> |No| I[Split task by counts]
    H --> J[Generate resmoke suite config]
    I --> J
    J --> |generated task definitions|B
    B --> |done|K[For each Build Variant]
    K --> L[Create task specs and display tasks in Build Variant]
    L --> M[Create shrub config]
    M --> N[Write shrub config to disk]
    N --> O([End])

设置本地开发环境

请确保已安装Rust开发环境。请参阅此处的说明。

从仓库的根目录运行cargo build来构建项目。

linting/formatting

cargo fmt
cargo clippy

运行测试

cargo test

版本控制

该项目使用semver进行版本控制。

请在CHANGELOG.md中包含每个新版本添加的描述。

代码审查

该项目使用Evergreen Commit Queue。添加包含evergreen merge的PR评论以触发合并。

部署

部署通过github actions完成。可以通过git标签触发部署。要创建部署，请将您希望部署的提交标记为git标签，并将标签推送到远程仓库。

git标签应格式如下：“v”后跟要部署的3位数版本号。例如，“v0.1.0”。

git tag v0.1.0
git push origin --tags

标记的版本将部署到项目的发布页。

资源

• Evergreen generate.tasks 文档
• Evergreen 测试统计文档