Skip to content

Commit ec7142f

Browse files
authored
[infra] Add dart_apitool check to ci.dart (dart-lang#3082)
1 parent 6b1dfa7 commit ec7142f

2 files changed

Lines changed: 65 additions & 3 deletions

File tree

‎.github/workflows/native.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ jobs:
7474
- run: dart pub get
7575

7676
- name: Run pub get, analysis, formatting, generators, tests, and examples.
77-
run: dart tool/ci.dart --all
77+
run: dart tool/ci.dart --all --no-apitool
7878

7979
- name: Upload coverage
8080
uses: coverallsapp/github-action@5cbfd81b66ca5d10c19b062c04de0199c215fb6e

‎tool/ci.dart‎

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ ArgParser makeArgParser() {
5555
..addFlag(
5656
'fast',
5757
negatable: false,
58-
help: 'Skip hooks_runner and native_toolchain_c.',
58+
help: 'Skip slow integration tests and apitool.',
5959
);
6060
for (final task in tasks) {
6161
parser.addFlag(task.name, help: task.helpMessage);
@@ -110,7 +110,7 @@ class PubTask extends Task {
110110
name: 'pub',
111111
helpMessage:
112112
'Run `dart pub get` on the root and non-workspace packages.\n'
113-
'Run `dart pub global activate coverage`.',
113+
'Run `dart pub global activate coverage` and `dart_apitool`.',
114114
);
115115

116116
@override
@@ -343,13 +343,74 @@ class CoverageTask extends Task {
343343
}
344344
}
345345

346+
/// Checks for leaked symbols in the public API using `dart_apitool`.
347+
class ApiToolTask extends Task {
348+
const ApiToolTask()
349+
: super(
350+
name: 'apitool',
351+
helpMessage: 'Run `dart_apitool` to check for leaked symbols.',
352+
);
353+
354+
@override
355+
bool shouldRun(ArgResults argResults) {
356+
if (argResults['fast'] as bool && !argResults.wasParsed(name)) {
357+
return false;
358+
}
359+
return super.shouldRun(argResults);
360+
}
361+
362+
@override
363+
Future<void> run({
364+
required List<String> packages,
365+
required ArgResults argResults,
366+
}) async {
367+
if (pubTask.shouldRun(argResults)) {
368+
// Pull in https://github.com/bmw-tech/dart_apitool/pull/252.
369+
await _runProcess('dart', [
370+
'pub',
371+
'global',
372+
'activate',
373+
'--source',
374+
'git',
375+
'https://github.com/bmw-tech/dart_apitool.git',
376+
'--git-ref',
377+
'906fa0f3dca24d81d1c26ee71c884ecbb6234ecf',
378+
]);
379+
}
380+
await _runMaybeParallel([
381+
for (final package in packages)
382+
() async {
383+
final outputFileName = '${package.replaceAll('/', '_')}_api.json';
384+
await _runProcess('dart', [
385+
'pub',
386+
'global',
387+
'run',
388+
'dart_apitool:main',
389+
'extract',
390+
'--input',
391+
package,
392+
'--set-exit-on-missing-export',
393+
'--output',
394+
outputFileName,
395+
]);
396+
// Clean up the temporary file.
397+
final apiJson = File.fromUri(repositoryRoot.resolve(outputFileName));
398+
if (apiJson.existsSync()) {
399+
apiJson.deleteSync();
400+
}
401+
},
402+
], argResults);
403+
}
404+
}
405+
346406
const pubTask = PubTask();
347407
const analyzeTask = AnalyzeTask();
348408
const formatTask = FormatTask();
349409
const generateTask = GenerateTask();
350410
const testTask = TestTask();
351411
const exampleTask = ExampleTask();
352412
const coverageTask = CoverageTask();
413+
const apiToolTask = ApiToolTask();
353414

354415
// The order of tasks is intentional.
355416
final tasks = [
@@ -360,6 +421,7 @@ final tasks = [
360421
testTask,
361422
exampleTask,
362423
coverageTask,
424+
apiToolTask,
363425
];
364426

365427
final Uri repositoryRoot = Platform.script.resolve('../');

0 commit comments

Comments
 (0)