Skip to content

Refactor shared code in tests and tools. #2308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 18, 2020
Merged

Refactor shared code in tests and tools. #2308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/src/warnings.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ class PackageWarningOptions {
}

class PackageWarningCounter {
final countedWarnings = <Element, Set<Tuple2<PackageWarning, String>>>{};
final Map<Element, Set<Tuple2<PackageWarning, String>>> countedWarnings = {};
final _items = <Jsonable>[];
final _displayedWarningCounts = <PackageWarning, int>{};
final PackageGraph packageGraph;
Expand Down
1 change: 1 addition & 0 deletions test/dartdoc_integration_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import 'package:dartdoc/dartdoc.dart';
import 'package:path/path.dart' as path;
import 'package:test/test.dart';

import '../tool/subprocess_launcher.dart';
import 'src/utils.dart';

Uri get _currentFileUri =>
Expand Down
92 changes: 54 additions & 38 deletions test/dartdoc_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,35 @@ import 'package:test/test.dart';

import 'src/utils.dart';

final Directory _testPackageDir = Directory('testing/test_package');

final _testPackageBadDir = Directory('testing/test_package_bad');
final _testPackageMinimumDir = Directory('testing/test_package_minimum');
final _testSkyEnginePackage = Directory('testing/sky_engine');
final _testPackageWithNoReadme = Directory('testing/test_package_small');
final _testPackageIncludeExclude =
Directory('testing/test_package_include_exclude');
final _testPackageImportExportError =
Directory('testing/test_package_import_export_error');
final _testPackageOptions = Directory('testing/test_package_options');
final _testPackageOptionsImporter =
Directory('testing/test_package_options_importer');
final _testPackageCustomTemplates =
Directory('testing/test_package_custom_templates');

/// Convenience factory to build a [DartdocGeneratorOptionContext] and associate
/// it with a [DartdocOptionSet] based on the current working directory and/or
/// the '--input' flag.
Future<DartdocGeneratorOptionContext> _generatorContextFromArgv(
List<String> argv) async {
var optionSet = await DartdocOptionSet.fromOptionGenerators('dartdoc', [
() => createDartdocOptions(pubPackageMetaProvider),
createGeneratorOptions,
]);
optionSet.parseArguments(argv);
return DartdocGeneratorOptionContext(optionSet, null);
}

class DartdocLoggingOptionContext extends DartdocGeneratorOptionContext
with LoggingContext {
DartdocLoggingOptionContext(DartdocOptionSet optionSet, Directory dir)
Expand All @@ -28,7 +57,6 @@ void main() {
Directory tempDir;

setUpAll(() async {
tempDir = Directory.systemTemp.createTempSync('dartdoc.test.');
var optionSet = await DartdocOptionSet.fromOptionGenerators(
'dartdoc', [createLoggingOptions]);
optionSet.parseArguments([]);
Expand All @@ -45,7 +73,7 @@ void main() {

Future<Dartdoc> buildDartdoc(
List<String> argv, Directory packageRoot, Directory tempDir) async {
var context = await generatorContextFromArgv(argv
var context = await _generatorContextFromArgv(argv
..addAll(['--input', packageRoot.path, '--output', tempDir.path]));
return await Dartdoc.fromContext(
context,
Expand All @@ -61,15 +89,11 @@ void main() {

setUpAll(() async {
tempDir = Directory.systemTemp.createTempSync('dartdoc.test.');
dartdoc = await buildDartdoc([], testPackageOptions, tempDir);
dartdoc = await buildDartdoc([], _testPackageOptions, tempDir);
results = await dartdoc.generateDocsBase();
p = results.packageGraph;
});

tearDownAll(() async {
tempDir.deleteSync(recursive: true);
});

test('generator parameters', () async {
var favicon =
File(path.joinAll([tempDir.path, 'static-assets', 'favicon.png']));
Expand Down Expand Up @@ -126,16 +150,12 @@ void main() {
setUpAll(() async {
tempDir = Directory.systemTemp.createTempSync('dartdoc.test.');
results = await (await buildDartdoc(
['--link-to-remote'], testPackageOptionsImporter, tempDir))
['--link-to-remote'], _testPackageOptionsImporter, tempDir))
.generateDocsBase();
testPackageOptions = results.packageGraph.packages
.firstWhere((Package p) => p.name == 'test_package_options');
});

tearDownAll(() async {
tempDir.deleteSync(recursive: true);
});

test('linkToUrl', () async {
var main = testPackageOptions.allLibraries
.firstWhere((Library l) => l.name == 'main');
Expand All @@ -161,7 +181,7 @@ void main() {

test('with broken reexport chain', () async {
var dartdoc =
await buildDartdoc([], testPackageImportExportError, tempDir);
await buildDartdoc([], _testPackageImportExportError, tempDir);
var results = await dartdoc.generateDocsBase();
var p = results.packageGraph;
var unresolvedExportWarnings = p
Expand All @@ -179,7 +199,7 @@ void main() {
group('include/exclude parameters', () {
test('with config file', () async {
var dartdoc =
await buildDartdoc([], testPackageIncludeExclude, tempDir);
await buildDartdoc([], _testPackageIncludeExclude, tempDir);
var results = await dartdoc.generateDocs();
var p = results.packageGraph;
expect(p.localPublicLibraries.map((l) => l.name),
Expand All @@ -188,16 +208,16 @@ void main() {

test('with include command line argument', () async {
var dartdoc = await buildDartdoc(['--include', 'another_included'],
testPackageIncludeExclude, tempDir);
_testPackageIncludeExclude, tempDir);
var results = await dartdoc.generateDocs();
var p = results.packageGraph;
expect(p.localPublicLibraries.length, equals(1));
expect(p.localPublicLibraries.first.name, equals('another_included'));
});

test('with exclude command line argument', () async {
var dartdoc = await buildDartdoc(
['--exclude', 'more_included'], testPackageIncludeExclude, tempDir);
var dartdoc = await buildDartdoc(['--exclude', 'more_included'],
_testPackageIncludeExclude, tempDir);
var results = await dartdoc.generateDocs();
var p = results.packageGraph;
expect(p.localPublicLibraries.length, equals(1));
Expand All @@ -207,14 +227,14 @@ void main() {
});

test('package without version produces valid semver in docs', () async {
var dartdoc = await buildDartdoc([], testPackageMinimumDir, tempDir);
var dartdoc = await buildDartdoc([], _testPackageMinimumDir, tempDir);
var results = await dartdoc.generateDocs();
var p = results.packageGraph;
expect(p.defaultPackage.version, equals('0.0.0-unknown'));
});

test('basic interlinking test', () async {
var dartdoc = await buildDartdoc([], testPackageDir, tempDir);
var dartdoc = await buildDartdoc([], _testPackageDir, tempDir);
var results = await dartdoc.generateDocs();
var p = results.packageGraph;
var meta = p.publicPackages.firstWhere((p) => p.name == 'meta');
Expand Down Expand Up @@ -243,15 +263,11 @@ void main() {

setUpAll(() async {
tempDir = Directory.systemTemp.createTempSync('dartdoc.test.');
dartdoc = await buildDartdoc([], testPackageDir, tempDir);
dartdoc = await buildDartdoc([], _testPackageDir, tempDir);
results = await dartdoc.generateDocs();
});

tearDownAll(() async {
tempDir.deleteSync(recursive: true);
});

test('generate docs for ${path.basename(testPackageDir.path)} works',
test('generate docs for ${path.basename(_testPackageDir.path)} works',
() async {
expect(results.packageGraph, isNotNull);
var packageGraph = results.packageGraph;
Expand All @@ -278,9 +294,9 @@ void main() {
});
});

test('generate docs for ${path.basename(testPackageBadDir.path)} fails',
test('generate docs for ${path.basename(_testPackageBadDir.path)} fails',
() async {
var dartdoc = await buildDartdoc([], testPackageBadDir, tempDir);
var dartdoc = await buildDartdoc([], _testPackageBadDir, tempDir);

try {
await dartdoc.generateDocs();
Expand All @@ -293,7 +309,7 @@ void main() {
'from analysis_options');

test('generate docs for a package that does not have a readme', () async {
var dartdoc = await buildDartdoc([], testPackageWithNoReadme, tempDir);
var dartdoc = await buildDartdoc([], _testPackageWithNoReadme, tempDir);

var results = await dartdoc.generateDocs();
expect(results.packageGraph, isNotNull);
Expand All @@ -307,7 +323,7 @@ void main() {

test('generate docs including a single library', () async {
var dartdoc =
await buildDartdoc(['--include', 'fake'], testPackageDir, tempDir);
await buildDartdoc(['--include', 'fake'], _testPackageDir, tempDir);

var results = await dartdoc.generateDocs();
expect(results.packageGraph, isNotNull);
Expand All @@ -321,7 +337,7 @@ void main() {

test('generate docs excluding a single library', () async {
var dartdoc =
await buildDartdoc(['--exclude', 'fake'], testPackageDir, tempDir);
await buildDartdoc(['--exclude', 'fake'], _testPackageDir, tempDir);

var results = await dartdoc.generateDocs();
expect(results.packageGraph, isNotNull);
Expand All @@ -338,7 +354,7 @@ void main() {
});

test('generate docs for package with embedder yaml', () async {
var dartdoc = await buildDartdoc([], testSkyEnginePackage, tempDir);
var dartdoc = await buildDartdoc([], _testSkyEnginePackage, tempDir);

var results = await dartdoc.generateDocs();
expect(results.packageGraph, isNotNull);
Expand Down Expand Up @@ -370,9 +386,9 @@ void main() {

test('generate docs with custom templates', () async {
var templatesDir =
path.join(testPackageCustomTemplates.path, 'templates');
path.join(_testPackageCustomTemplates.path, 'templates');
var dartdoc = await buildDartdoc(['--templates-dir', templatesDir],
testPackageCustomTemplates, tempDir);
_testPackageCustomTemplates, tempDir);

var results = await dartdoc.generateDocs();
expect(results.packageGraph, isNotNull);
Expand All @@ -390,7 +406,7 @@ void main() {
var templatesDir = path.join(path.current, 'test/templates');
try {
await buildDartdoc(['--templates-dir', templatesDir],
testPackageCustomTemplates, tempDir);
_testPackageCustomTemplates, tempDir);
fail('dartdoc should fail with missing required template');
} catch (e) {
expect(e is DartdocFailure, isTrue);
Expand All @@ -403,7 +419,7 @@ void main() {
var badPath = path.join(tempDir.path, 'BAD');
try {
await buildDartdoc(
['--templates-dir', badPath], testPackageCustomTemplates, tempDir);
['--templates-dir', badPath], _testPackageCustomTemplates, tempDir);
fail('dartdoc should fail with bad templatesDir path');
} catch (e) {
expect(e is DartdocFailure, isTrue);
Expand All @@ -412,15 +428,15 @@ void main() {

test('generating markdown docs does not crash', () async {
var dartdoc =
await buildDartdoc(['--format', 'md'], testPackageDir, tempDir);
await buildDartdoc(['--format', 'md'], _testPackageDir, tempDir);
await dartdoc.generateDocsBase();
});

test('rel canonical prefix does not include base href', () async {
// ignore: omit_local_variable_types
final String prefix = 'foo.bar/baz';
var dartdoc = await buildDartdoc(
['--rel-canonical-prefix', prefix], testPackageDir, tempDir);
['--rel-canonical-prefix', prefix], _testPackageDir, tempDir);
await dartdoc.generateDocsBase();

// Verify files at different levels have correct <link> content.
Expand All @@ -438,7 +454,7 @@ void main() {

test('generate docs with bad output format', () async {
try {
await buildDartdoc(['--format', 'bad'], testPackageDir, tempDir);
await buildDartdoc(['--format', 'bad'], _testPackageDir, tempDir);
fail('dartdoc should fail with bad output format');
} catch (e) {
expect(e is DartdocFailure, isTrue);
Expand Down
5 changes: 3 additions & 2 deletions test/html_generator_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,12 @@ void main() {
PackageGraph packageGraph;
Directory tempOutput;
FileWriter writer;
var testPackageDuplicateDir = Directory('testing/test_package_duplicate');

setUp(() async {
generator = await _initGeneratorForTest();
packageGraph = await utils
.bootBasicPackage(utils.testPackageDuplicateDir.path, []);
packageGraph =
await utils.bootBasicPackage(testPackageDuplicateDir.path, []);
tempOutput = await Directory.systemTemp.createTemp('doc_test_temp');
writer = DartdocFileWriter(tempOutput.path);
});
Expand Down
Loading