Skip to content
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

Jump to bottom

Refactor options_test.dart #3586

Merged
merged 2 commits into from
Nov 22, 2023
Merged

Refactor options_test.dart #3586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
952b588
Refactor options_test.dart
srawlins Nov 17, 2023
4a9a3bb
Merge branch 'main' into refactor-options-test
srawlins Nov 22, 2023
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
55 changes: 50 additions & 5 deletions test/dartdoc_test_base.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
// BSD-style license that can be found in the LICENSE file.

import 'package:analyzer/file_system/memory_file_system.dart';
import 'package:dartdoc/src/dartdoc.dart';
import 'package:dartdoc/src/logging.dart';
import 'package:dartdoc/src/model/model.dart';
import 'package:dartdoc/src/package_config_provider.dart';
import 'package:dartdoc/src/package_meta.dart';
import 'package:meta/meta.dart';
import 'package:path/path.dart' as path;

import 'src/test_descriptor_utils.dart' as d;
import 'src/utils.dart';
Expand All @@ -25,7 +28,7 @@ abstract class DartdocTestBase {
late final PackageMetaProvider packageMetaProvider;
late final MemoryResourceProvider resourceProvider;
late final FakePackageConfigProvider packageConfigProvider;
late final String packagePath;
late String packagePath;

String get libraryName;

Expand All @@ -42,15 +45,20 @@ abstract class DartdocTestBase {

bool get skipUnreachableSdkLibraries => true;

late StringBuffer outBuffer;
late StringBuffer errBuffer;

@mustCallSuper
Future<void> setUp() async {
outBuffer = StringBuffer();
errBuffer = StringBuffer();
packageMetaProvider = testPackageMetaProvider;
resourceProvider =
packageMetaProvider.resourceProvider as MemoryResourceProvider;
await setUpPackage(libraryName);
await _setUpPackage();
}

Future<void> setUpPackage(String name) async {
Future<void> _setUpPackage() async {
var pubspec = d.buildPubspecText(sdkConstraint: sdkConstraint);
String? analysisOptions;
if (experiments.isNotEmpty) {
Expand All @@ -60,7 +68,7 @@ analyzer:
''';
}
packagePath = await d.createPackage(
name,
libraryName,
pubspec: pubspec,
analysisOptions: analysisOptions,
resourceProvider: resourceProvider,
Expand All @@ -69,7 +77,7 @@ analyzer:
packageConfigProvider =
getTestPackageConfigProvider(packageMetaProvider.defaultSdkDir.path);
packageConfigProvider.addPackageToConfigFor(
packagePath, name, Uri.file('$packagePath/'));
packagePath, libraryName, Uri.file('$packagePath/'));
}

Future<PackageGraph> _bootPackageFromFiles(Iterable<d.Descriptor> files,
Expand Down Expand Up @@ -158,4 +166,41 @@ $libraryContent
.libraries
.named(libraryName);
}

Future<Dartdoc> buildDartdoc({
List<String> excludeLibraries = const [],
List<String> additionalArguments = const [],
bool skipUnreachableSdkLibraries = true,
bool useJson = false,
}) async {
final dir = resourceProvider.getFolder(resourceProvider.pathContext
.absolute(resourceProvider.pathContext.normalize(packagePath)));
final context = await generatorContextFromArgv([
'--input',
dir.path,
'--output',
path.join(packagePath, 'doc'),
'--sdk-dir',
packageMetaProvider.defaultSdkDir.path,
'--exclude',
excludeLibraries.join(','),
'--allow-tools',
'--no-link-to-remote',
...additionalArguments,
], packageMetaProvider);
final packageBuilder = PubPackageBuilder(
context,
packageMetaProvider,
packageConfigProvider,
skipUnreachableSdkLibraries: skipUnreachableSdkLibraries,
);
startLogging(
isJson: useJson,
isQuiet: true,
showProgress: true,
outSink: outBuffer,
errSink: errBuffer,
);
return await Dartdoc.fromContext(context, packageBuilder);
}
}
Loading