blob: 2c3b96ad36d8629b8446da0262ca5cc2a393fa45 [file] [log] [blame]
// Copyright 2021 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'package:cocoon_service/src/model/ci_yaml/ci_yaml.dart';
import 'package:cocoon_service/src/model/proto/internal/scheduler.pb.dart';
import 'package:cocoon_service/src/service/config.dart';
import 'package:test/test.dart';
import 'package:yaml/yaml.dart';
void main() {
group('scheduler config', () {
test('constructs graph with one target', () {
final YamlMap? singleTargetConfig = loadYaml('''
enabled_branches:
- master
targets:
- name: A
builder: builderA
drone_dimensions:
- os=Linux
properties:
test: abc
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(singleTargetConfig);
final SchedulerConfig schedulerConfig = CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config;
expect(schedulerConfig.enabledBranches, <String>['master']);
expect(schedulerConfig.targets.length, 1);
final Target target = schedulerConfig.targets.first;
expect(target.bringup, false);
expect(target.name, 'A');
expect(target.properties, <String, String>{
'test': 'abc',
});
expect(target.scheduler, SchedulerSystem.cocoon);
expect(target.testbed, 'linux-vm');
expect(target.timeout, 30);
expect(target.droneDimensions, ['os=Linux']);
});
test('throws exception when non-existent scheduler is given', () {
final YamlMap? targetWithNonexistentScheduler = loadYaml('''
enabled_branches:
- master
targets:
- name: A
scheduler: dashatar
''') as YamlMap?;
expect(
() {
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()
..mergeFromProto3Json(targetWithNonexistentScheduler);
CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config;
},
throwsA(isA<FormatException>()),
);
});
test('constructs graph with dependency chain', () {
final YamlMap? dependentTargetConfig = loadYaml('''
enabled_branches:
- master
targets:
- name: A
- name: B
dependencies:
- A
properties:
dependencies: >-
[
{"dependency": "android_sdk", "version": "version:31v8"},
{"dependency": "certs", "version": "version:9563bb"},
{"dependency": "chrome_and_driver", "version": "version:96.2"},
{"dependency": "open_jdk", "version": "11"}
]
- name: C
dependencies:
- B
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(dependentTargetConfig);
final SchedulerConfig schedulerConfig = CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config;
expect(schedulerConfig.targets.length, 3);
final Target a = schedulerConfig.targets.first;
final Target b = schedulerConfig.targets[1];
final Target c = schedulerConfig.targets[2];
expect(a.name, 'A');
expect(b.name, 'B');
expect(b.dependencies, <String>['A']);
expect(c.name, 'C');
expect(c.dependencies, <String>['B']);
});
test('constructs graph with parent with two dependents', () {
final YamlMap? twoDependentTargetConfig = loadYaml('''
enabled_branches:
- master
targets:
- name: A
- name: B1
dependencies:
- A
- name: B2
dependencies:
- A
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(twoDependentTargetConfig);
final SchedulerConfig schedulerConfig = CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config;
expect(schedulerConfig.targets.length, 3);
final Target a = schedulerConfig.targets.first;
final Target b1 = schedulerConfig.targets[1];
final Target b2 = schedulerConfig.targets[2];
expect(a.name, 'A');
expect(b1.name, 'B1');
expect(b1.dependencies, <String>['A']);
expect(b2.name, 'B2');
expect(b2.dependencies, <String>['A']);
});
test('fails when there are cyclic targets', () {
final YamlMap? configWithCycle = loadYaml('''
enabled_branches:
- master
targets:
- name: A
dependencies:
- B
- name: B
dependencies:
- A
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(configWithCycle);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config,
throwsA(
isA<FormatException>().having(
(FormatException e) => e.toString(),
'message',
contains('ERROR: A depends on B which does not exist'),
),
),
);
});
test('fails when there are duplicate targets', () {
final YamlMap? configWithDuplicateTargets = loadYaml('''
enabled_branches:
- master
targets:
- name: A
- name: A
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()
..mergeFromProto3Json(configWithDuplicateTargets);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config,
throwsA(
isA<FormatException>().having(
(FormatException e) => e.toString(),
'message',
contains('ERROR: A already exists in graph'),
),
),
);
});
test('fails when there are multiple dependencies', () {
final YamlMap? configWithMultipleDependencies = loadYaml('''
enabled_branches:
- master
targets:
- name: A
- name: B
- name: C
dependencies:
- A
- B
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()
..mergeFromProto3Json(configWithMultipleDependencies);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config,
throwsA(
isA<FormatException>().having(
(FormatException e) => e.toString(),
'message',
contains('ERROR: C has multiple dependencies which is not supported. Use only one dependency'),
),
),
);
});
test('fails when dependency does not exist', () {
final YamlMap? configWithMissingTarget = loadYaml('''
enabled_branches:
- master
targets:
- name: A
dependencies:
- B
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(configWithMissingTarget);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
).config,
throwsA(
isA<FormatException>().having(
(FormatException e) => e.toString(),
'message',
contains('ERROR: A depends on B which does not exist'),
),
),
);
});
});
group('validate scheduler config and compared with tip of tree targets', () {
late CiYaml? totConfig;
setUp(() {
final YamlMap? totYaml = loadYaml('''
enabled_branches:
- master
targets:
- name: A
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(totYaml);
totConfig = CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
validate: true,
);
});
test('succeed when no new builders compared with tip of tree builders', () {
final YamlMap? currentYaml = loadYaml('''
enabled_branches:
- master
targets:
- name: A
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(currentYaml);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
totConfig: totConfig,
validate: true,
),
returnsNormally,
);
});
test('succeed when new builder is marked with bringup:true ', () {
final YamlMap? currentYaml = loadYaml('''
enabled_branches:
- master
targets:
- name: A
- name: B
bringup: true
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(currentYaml);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
totConfig: totConfig,
validate: true,
),
returnsNormally,
);
});
test('fails when new builder is missing bringup:true ', () {
final YamlMap? currentYaml = loadYaml('''
enabled_branches:
- master
targets:
- name: A
- name: B
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(currentYaml);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
totConfig: totConfig,
validate: true,
),
throwsA(
isA<FormatException>().having(
(FormatException e) => e.toString(),
'message',
contains('ERROR: B is a new builder added. it needs to be marked bringup: true'),
),
),
);
});
test('fails when new builder has bringup set to false ', () {
final YamlMap? currentYaml = loadYaml('''
enabled_branches:
- master
targets:
- name: A
- name: B
bringup: false
''') as YamlMap?;
final SchedulerConfig unCheckedSchedulerConfig = SchedulerConfig()..mergeFromProto3Json(currentYaml);
expect(
() => CiYaml(
slug: Config.flutterSlug,
branch: Config.defaultBranch(Config.flutterSlug),
config: unCheckedSchedulerConfig,
totConfig: totConfig,
validate: true,
),
throwsA(
isA<FormatException>().having(
(FormatException e) => e.toString(),
'message',
contains('ERROR: B is a new builder added. it needs to be marked bringup: true'),
),
),
);
});
});
}