DAG-2284 Support burn_in equivalent for tasks generation (#55)

Author: MikhailShchatko

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.7.0 - 2022-12-16
+* Add support for burn_in_tasks generation.
+
 ## 0.6.7 - 2022-11-18
 * Switch to using evergreen test stats from S3.
 

Cargo.lock

@@ -2,7 +2,7 @@
 name = "mongo-task-generator"
 description = "Dynamically split evergreen tasks into subtasks for testing the mongodb/mongo project."
 license = "Apache-2.0"
-version = "0.6.7"
+version = "0.7.0"
 repository = "https://github.com/mongodb/mongo-task-generator"
 authors = ["Decision Automation Group <[email protected]>"]
 edition = "2018"

Cargo.toml

@@ -157,12 +157,14 @@ of the task definition. When this tag is present, both the extra setup steps and
 of multiversion sub-tasks will be preformed. In order to only perform the extra setup steps
 the `"no_version_combinations"` tag should also be included.
 
-### Burn in tests and burn in tags
+### Burn in tests, burn in tags and burn in tasks
 
 Newly added or modified tests might become flaky. In order to avoid that, those tests can be run
 continuously multiple times in a row to see if the results are consistent. This process is called
 burn-in.
 
+#### Burn in tests
+
 `burn_in_tests_gen` task is used to generate burn-in tasks on the same buildvariant the task is
 added to. The [example](https://github.com/mongodb/mongo/blob/81c41bdfdc56f05973fae70e80e80919f18f50c9/etc/evergreen_yml_components/definitions.yml#L3252-L3256)
 of task configuration:
@@ -175,6 +177,8 @@ of task configuration:
   - func: "generate resmoke tasks"
 ```
 
+#### Burn in tags
+
 `burn_in_tags_gen` task is used to generate separate burn-in buildvariants. This way we can burn-in
 on the requested buildvariant as well as the other, additional buildvariants to ensure there is no
 difference between them.
@@ -200,6 +204,29 @@ burn_in_tag_compile_distro: rhel80-large
 burn_in_tag_compile_task_group_name: compile_and_archive_dist_test_TG
 ```
 
+#### Burn in tasks
+
+`burn_in_tasks_gen` task is used to generate several copies of the task. The example of task
+configuration:
+
+```yaml
+- <<: *gen_burn_in_task_template
+  name: burn_in_tasks_gen
+  tags: []
+  commands:
+  - func: "generate resmoke tasks"
+```
+
+`burn_in_task_name` buildvariant expansion is used to configure which task to burn-in. The
+example of `burn_in_task_name` buildvariant expansion:
+
+```yaml
+burn_in_task_name: replica_sets_jscore_passthrough
+```
+
+WARNING! Task splitting is not supported for burn-in tasks. Large unsplitted `_gen` tasks may
+run too long and hit execution timeouts.
+
 Burn-in related tasks are generated when `--burn-in` is passed.
 
 ## Working with generated tasks

docs/generating_tasks.md

@@ -39,6 +39,8 @@ pub const GENERATOR_TASKS: &str = "generator_tasks";
 pub const BURN_IN_TESTS: &str = "burn_in_tests_gen";
 /// Name of burn_in_tags task.
 pub const BURN_IN_TAGS: &str = "burn_in_tags_gen";
+/// Name of burn_in_tasks task.
+pub const BURN_IN_TASKS: &str = "burn_in_tasks_gen";
 
 // Vars
 /// Variable that indicates a task is a fuzzer.
@@ -94,6 +96,8 @@ pub const BURN_IN_TAG_BUILD_VARIANTS: &str = "burn_in_tag_buildvariants";
 pub const BURN_IN_TAG_COMPILE_TASK_GROUP_NAME: &str = "burn_in_tag_compile_task_group_name";
 /// Name of build variant to determine the timeouts for.
 pub const BURN_IN_BYPASS: &str = "burn_in_bypass";
+/// List of tasks to burn in.
+pub const BURN_IN_TASK_NAME: &str = "burn_in_task_name";
 
 // Task Tags
 /// Tag to include multiversion setup is required.