Sam Rawlins
bd700772ff
Work towards https://github.com/dart-lang/sdk/issues/55660 Change-Id: Iae062d95e5cf3b94b540496242b3627268ac2612 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/428844 Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Paul Berry <paulberry@google.com>
606 lines
21 KiB
Dart
606 lines
21 KiB
Dart
// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file
|
|
// for details. 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:analyzer/diagnostic/diagnostic.dart';
|
|
import 'package:analyzer/error/error.dart';
|
|
import 'package:analyzer/utilities/package_config_file_builder.dart';
|
|
import 'package:analyzer_testing/utilities/utilities.dart';
|
|
import 'package:test/test.dart';
|
|
import 'package:test_reflective_loader/test_reflective_loader.dart';
|
|
|
|
import '../tool/messages/error_code_documentation_info.dart';
|
|
import '../tool/messages/error_code_info.dart';
|
|
import 'src/dart/resolution/context_collection_resolution.dart';
|
|
|
|
main() {
|
|
defineReflectiveSuite(() {
|
|
defineReflectiveTests(VerifyDiagnosticsTest);
|
|
});
|
|
}
|
|
|
|
/// A class used to validate diagnostic documentation.
|
|
class DocumentationValidator {
|
|
/// The sequence used to mark the start of an error range.
|
|
static const String errorRangeStart = '[!';
|
|
|
|
/// The sequence used to mark the end of an error range.
|
|
static const String errorRangeEnd = '!]';
|
|
|
|
/// A list of the diagnostic codes that are not being verified. These should
|
|
/// ony include docs that cannot be verified because of missing support in the
|
|
/// verifier.
|
|
static const List<String> unverifiedDocs = [
|
|
// Needs to be able to specify two expected diagnostics.
|
|
'CompileTimeErrorCode.AMBIGUOUS_IMPORT',
|
|
// Produces two diagnostics when it should only produce one.
|
|
'CompileTimeErrorCode.BUILT_IN_IDENTIFIER_AS_TYPE',
|
|
// TODO(kallentu): This is always reported with
|
|
// `ARGUMENT_TYPE_NOT_ASSIGNABLE` or is reported as
|
|
// `CONST_EVAL_THROWS_EXCEPTION` in const constructor evaluation.
|
|
'CompileTimeErrorCode.CONST_CONSTRUCTOR_PARAM_TYPE_MISMATCH',
|
|
// Produces two diagnostics when it should only produce one.
|
|
'CompileTimeErrorCode.CONST_DEFERRED_CLASS',
|
|
// The mock SDK doesn't define any internal libraries.
|
|
'CompileTimeErrorCode.EXPORT_INTERNAL_LIBRARY',
|
|
// Also reports CompileTimeErrorCode.SUBTYPE_OF_BASE_OR_FINAL_IS_NOT_BASE_FINAL_OR_SEALED
|
|
'CompileTimeErrorCode.EXTENDS_DISALLOWED_CLASS',
|
|
// The following codes produce two diagnostics because they illustrate a
|
|
// cycle.
|
|
'CompileTimeErrorCode.EXTENSION_TYPE_IMPLEMENTS_ITSELF',
|
|
'CompileTimeErrorCode.EXTENSION_TYPE_REPRESENTATION_DEPENDS_ON_ITSELF',
|
|
// Not reported with `getter-setter-error` feature enabled.
|
|
'CompileTimeErrorCode.GETTER_NOT_SUBTYPE_SETTER_TYPES',
|
|
// Has code in the example section that needs to be skipped (because it's
|
|
// part of the explanatory text not part of the example), but there's
|
|
// currently no way to do that.
|
|
'CompileTimeErrorCode.INVALID_IMPLEMENTATION_OVERRIDE',
|
|
// Produces two diagnostics when it should only produce one. We could get
|
|
// rid of the invalid error by adding a declaration of a top-level variable
|
|
// (such as `JSBool b;`), but that would complicate the example.
|
|
'CompileTimeErrorCode.IMPORT_INTERNAL_LIBRARY',
|
|
// Produces two diagnostics when it should only produce one.
|
|
'CompileTimeErrorCode.INVALID_URI',
|
|
// No example, by design.
|
|
'CompileTimeErrorCode.MISSING_DART_LIBRARY',
|
|
// Produces two diagnostics when it should only produce one.
|
|
'CompileTimeErrorCode.NON_SYNC_FACTORY',
|
|
// Need a way to make auxiliary files that (a) are not included in the
|
|
// generated docs or (b) can be made persistent for fixes.
|
|
'CompileTimeErrorCode.PART_OF_NON_PART',
|
|
// Produces multiple diagnostics when it should only produce one.
|
|
'CompileTimeErrorCode.PREFIX_COLLIDES_WITH_TOP_LEVEL_MEMBER',
|
|
// Produces two diagnostic out of necessity.
|
|
'CompileTimeErrorCode.RECURSIVE_COMPILE_TIME_CONSTANT',
|
|
// Produces two diagnostic out of necessity.
|
|
'CompileTimeErrorCode.RECURSIVE_CONSTRUCTOR_REDIRECT',
|
|
// Produces two diagnostic out of necessity.
|
|
'CompileTimeErrorCode.RECURSIVE_INTERFACE_INHERITANCE',
|
|
// Produces two diagnostics out of necessity.
|
|
'CompileTimeErrorCode.REFERENCED_BEFORE_DECLARATION',
|
|
// Produces two diagnostic out of necessity.
|
|
'CompileTimeErrorCode.TOP_LEVEL_CYCLE',
|
|
// Produces two diagnostic out of necessity.
|
|
'CompileTimeErrorCode.TYPE_ALIAS_CANNOT_REFERENCE_ITSELF',
|
|
// Produces two diagnostic out of necessity.
|
|
'CompileTimeErrorCode.TYPE_PARAMETER_SUPERTYPE_OF_ITS_BOUND',
|
|
// Produces the diagnostic HintCode.UNUSED_LOCAL_VARIABLE when it shouldn't.
|
|
'CompileTimeErrorCode.UNDEFINED_IDENTIFIER_AWAIT',
|
|
// Produces multiple diagnostic because of poor recovery.
|
|
'CompileTimeErrorCode.YIELD_EACH_IN_NON_GENERATOR',
|
|
|
|
// This is not reported after 2.12, and the examples don't compile after 3.0.
|
|
'FfiCode.FIELD_INITIALIZER_IN_STRUCT',
|
|
// This is not reported after 2.12, and the examples don't compile after 3.0.
|
|
'FfiCode.FIELD_IN_STRUCT_WITH_INITIALIZER',
|
|
|
|
// This no longer works in 3.0.
|
|
'HintCode.DEPRECATED_COLON_FOR_DEFAULT_VALUE',
|
|
// The code has been replaced but is not yet removed.
|
|
'HintCode.DEPRECATED_MEMBER_USE',
|
|
|
|
// Need a way to specify the existance of files whose content is irrelevant.
|
|
'LintCode.always_use_package_imports',
|
|
// Missing support for example files outside of `lib`.
|
|
'LintCode.avoid_relative_lib_imports',
|
|
// The example isn't being recognized as a flutter app. We might need to
|
|
// build a pubspec.yaml when analyzing flutter code.
|
|
'LintCode.avoid_web_libraries_in_flutter',
|
|
// Produces a CompileTimeErrorCode.BODY_MIGHT_COMPLETE_NORMALLY.
|
|
'LintCode.control_flow_in_finally',
|
|
// Missing support for creating an indirect dependency on a package.
|
|
'LintCode.depend_on_referenced_packages',
|
|
// Missing support for specifying the name of the test file.
|
|
'LintCode.file_names',
|
|
// Produces an unused import diagnostic.
|
|
'LintCode.implementation_imports',
|
|
// Doesn't produce a lint for the second example, even though the analyzer
|
|
// does when the example is pasted into a file.
|
|
'LintCode.prefer_inlined_adds_single',
|
|
// No mock 'test' package, no good library annotations in 'meta'.
|
|
'LintCode.library_annotations',
|
|
// Produces an unused import diagnostic.
|
|
'LintCode.library_prefixes',
|
|
// Produces an unused element diagnostic.
|
|
'LintCode.library_private_types_in_public_api',
|
|
// Missing support for YAML files.
|
|
'LintCode.package_names',
|
|
// The lint does nothing.
|
|
'LintCode.package_prefixed_library_names',
|
|
// Need a way to specify the existance of files whose content is irrelevant.
|
|
'LintCode.prefer_relative_imports',
|
|
// The test file is in a basic workspace, so it can't have public API. I
|
|
// think we'd need to add a `pubspec.yaml` file to the example.
|
|
'LintCode.public_member_api_docs',
|
|
// Missing support for YAML files.
|
|
'LintCode.secure_pubspec_urls',
|
|
// The test framework doesn't yet support lints in non-dart files.
|
|
'LintCode.sort_pub_dependencies',
|
|
// Doesn't produce a lint for the first example, even though the analyzer
|
|
// does when the example is pasted into a file.
|
|
'LintCode.unnecessary_lambdas',
|
|
// Produces an unused_field warning.
|
|
'LintCode.use_setters_to_change_properties',
|
|
// Extra warning.
|
|
'LintCode.recursive_getters',
|
|
|
|
// Has `language=2.9`
|
|
'CompileTimeErrorCode.EXTENSION_DECLARES_INSTANCE_FIELD',
|
|
|
|
//
|
|
// The following can't currently be verified because the examples aren't
|
|
// Dart code.
|
|
//
|
|
'PubspecWarningCode.ASSET_DOES_NOT_EXIST',
|
|
'PubspecWarningCode.ASSET_DIRECTORY_DOES_NOT_EXIST',
|
|
'PubspecWarningCode.ASSET_FIELD_NOT_LIST',
|
|
'PubspecWarningCode.ASSET_MISSING_PATH',
|
|
'PubspecWarningCode.ASSET_NOT_STRING',
|
|
'PubspecWarningCode.ASSET_NOT_STRING_OR_MAP',
|
|
'PubspecWarningCode.ASSET_PATH_NOT_STRING',
|
|
'PubspecWarningCode.DEPENDENCIES_FIELD_NOT_MAP',
|
|
'PubspecWarningCode.DEPRECATED_FIELD',
|
|
'PubspecWarningCode.FLUTTER_FIELD_NOT_MAP',
|
|
'PubspecWarningCode.INVALID_DEPENDENCY',
|
|
'PubspecWarningCode.INVALID_PLATFORMS_FIELD',
|
|
'PubspecWarningCode.MISSING_NAME',
|
|
'PubspecWarningCode.MISSING_DEPENDENCY',
|
|
'PubspecWarningCode.NAME_NOT_STRING',
|
|
'PubspecWarningCode.PATH_DOES_NOT_EXIST',
|
|
'PubspecWarningCode.PATH_NOT_POSIX',
|
|
'PubspecWarningCode.PATH_PUBSPEC_DOES_NOT_EXIST',
|
|
'PubspecWarningCode.PLATFORM_VALUE_DISALLOWED',
|
|
'PubspecWarningCode.UNKNOWN_PLATFORM',
|
|
'PubspecWarningCode.UNNECESSARY_DEV_DEPENDENCY',
|
|
'PubspecWarningCode.WORKSPACE_FIELD_NOT_LIST',
|
|
'PubspecWarningCode.WORKSPACE_VALUE_NOT_STRING',
|
|
'PubspecWarningCode.WORKSPACE_VALUE_NOT_SUBDIRECTORY',
|
|
|
|
// Produces two diagnostics out of necessity.
|
|
'StaticWarningCode.DEAD_NULL_AWARE_EXPRESSION',
|
|
|
|
// Reports CompileTimeErrorCode.FINAL_CLASS_EXTENDED_OUTSIDE_OF_LIBRARY
|
|
'WarningCode.DEPRECATED_EXTENDS_FUNCTION',
|
|
// Produces more than one error range by design.
|
|
// TODO(srawlins): update verification to allow for multiple highlight ranges.
|
|
'WarningCode.TEXT_DIRECTION_CODE_POINT_IN_COMMENT',
|
|
// Produces more than one error range by design.
|
|
'WarningCode.TEXT_DIRECTION_CODE_POINT_IN_LITERAL',
|
|
// Produces two diagnostics out of necessity.
|
|
'WarningCode.UNNECESSARY_NULL_COMPARISON_NEVER_NULL_FALSE',
|
|
];
|
|
|
|
/// The buffer to which validation errors are written.
|
|
final StringBuffer buffer = StringBuffer();
|
|
|
|
/// The name of the variable currently being verified.
|
|
late String variableName;
|
|
|
|
/// The name of the error code currently being verified.
|
|
late String codeName;
|
|
|
|
/// A flag indicating whether the [variableName] has already been written to
|
|
/// the buffer.
|
|
bool hasWrittenVariableName = false;
|
|
|
|
/// Initialize a newly created documentation validator.
|
|
DocumentationValidator();
|
|
|
|
/// Validate the documentation.
|
|
Future<void> validate() async {
|
|
for (var classEntry in analyzerMessages.entries) {
|
|
var errorClass = classEntry.key;
|
|
await _validateMessages(errorClass, classEntry.value);
|
|
}
|
|
for (var classEntry in lintMessages.entries) {
|
|
var errorClass = classEntry.key;
|
|
await _validateMessages(errorClass, classEntry.value);
|
|
}
|
|
ErrorClassInfo? errorClassIncludingCfeMessages;
|
|
for (var errorClass in errorClasses) {
|
|
if (errorClass.includeCfeMessages) {
|
|
if (errorClassIncludingCfeMessages != null) {
|
|
fail(
|
|
'Multiple error classes include CFE messages: '
|
|
'${errorClassIncludingCfeMessages.name} and ${errorClass.name}',
|
|
);
|
|
}
|
|
errorClassIncludingCfeMessages = errorClass;
|
|
await _validateMessages(
|
|
errorClass.name,
|
|
cfeToAnalyzerErrorCodeTables.analyzerCodeToInfo,
|
|
);
|
|
}
|
|
}
|
|
if (buffer.isNotEmpty) {
|
|
fail(buffer.toString());
|
|
}
|
|
}
|
|
|
|
_SnippetData _extractSnippetData(
|
|
String snippet,
|
|
bool errorRequired,
|
|
Map<String, String> auxiliaryFiles,
|
|
List<String> experiments,
|
|
String? languageVersion,
|
|
) {
|
|
int rangeStart = snippet.indexOf(errorRangeStart);
|
|
if (rangeStart < 0) {
|
|
if (errorRequired) {
|
|
_reportProblem('No error range in example');
|
|
}
|
|
return _SnippetData(
|
|
snippet,
|
|
-1,
|
|
0,
|
|
auxiliaryFiles,
|
|
experiments,
|
|
languageVersion,
|
|
);
|
|
}
|
|
int rangeEnd = snippet.indexOf(errorRangeEnd, rangeStart + 1);
|
|
if (rangeEnd < 0) {
|
|
_reportProblem('No end of error range in example');
|
|
return _SnippetData(
|
|
snippet,
|
|
-1,
|
|
0,
|
|
auxiliaryFiles,
|
|
experiments,
|
|
languageVersion,
|
|
);
|
|
} else if (snippet.indexOf(errorRangeStart, rangeEnd) > 0) {
|
|
_reportProblem('More than one error range in example');
|
|
}
|
|
String content;
|
|
try {
|
|
content =
|
|
snippet.substring(0, rangeStart) +
|
|
snippet.substring(rangeStart + errorRangeStart.length, rangeEnd) +
|
|
snippet.substring(rangeEnd + errorRangeEnd.length);
|
|
} on RangeError catch (exception) {
|
|
_reportProblem(exception.message.toString());
|
|
content = '';
|
|
}
|
|
return _SnippetData(
|
|
content,
|
|
rangeStart,
|
|
rangeEnd - rangeStart - 2,
|
|
auxiliaryFiles,
|
|
experiments,
|
|
languageVersion,
|
|
);
|
|
}
|
|
|
|
/// Extract the snippets of Dart code from [documentationParts] that are
|
|
/// tagged as belonging to the given [blockSection].
|
|
List<_SnippetData> _extractSnippets(
|
|
List<ErrorCodeDocumentationPart> documentationParts,
|
|
BlockSection blockSection,
|
|
) {
|
|
var snippets = <_SnippetData>[];
|
|
var auxiliaryFiles = <String, String>{};
|
|
for (var documentationPart in documentationParts) {
|
|
if (documentationPart is ErrorCodeDocumentationBlock) {
|
|
if (documentationPart.containingSection != blockSection) {
|
|
continue;
|
|
}
|
|
var uri = documentationPart.uri;
|
|
if (uri != null) {
|
|
auxiliaryFiles[uri] = documentationPart.text;
|
|
} else {
|
|
if (documentationPart.fileType == 'dart') {
|
|
snippets.add(
|
|
_extractSnippetData(
|
|
documentationPart.text,
|
|
blockSection == BlockSection.examples,
|
|
auxiliaryFiles,
|
|
documentationPart.experiments,
|
|
documentationPart.languageVersion,
|
|
),
|
|
);
|
|
}
|
|
auxiliaryFiles = <String, String>{};
|
|
}
|
|
}
|
|
}
|
|
return snippets;
|
|
}
|
|
|
|
/// Report a problem with the current error code.
|
|
void _reportProblem(
|
|
String problem, {
|
|
List<Diagnostic> diagnostics = const [],
|
|
}) {
|
|
if (!hasWrittenVariableName) {
|
|
buffer.writeln(' $variableName');
|
|
hasWrittenVariableName = true;
|
|
}
|
|
buffer.writeln(' $problem');
|
|
for (Diagnostic diagnostic in diagnostics) {
|
|
buffer.write(' ');
|
|
buffer.write(diagnostic.errorCode);
|
|
buffer.write(' (');
|
|
buffer.write(diagnostic.offset);
|
|
buffer.write(', ');
|
|
buffer.write(diagnostic.length);
|
|
buffer.write(') ');
|
|
buffer.writeln(diagnostic.message);
|
|
}
|
|
}
|
|
|
|
/// Extract documentation from the given [messages], which are error messages
|
|
/// destined for the class [className].
|
|
Future<void> _validateMessages(
|
|
String className,
|
|
Map<String, ErrorCodeInfo> messages,
|
|
) async {
|
|
for (var errorEntry in messages.entries) {
|
|
var errorName = errorEntry.key;
|
|
var errorCodeInfo = errorEntry.value;
|
|
|
|
// If the error code is no longer generated,
|
|
// the corresponding code snippets won't report it.
|
|
if (errorCodeInfo.isRemoved) {
|
|
continue;
|
|
}
|
|
var docs = parseErrorCodeDocumentation(
|
|
'$className.$errorName',
|
|
errorCodeInfo.documentation,
|
|
);
|
|
if (docs != null) {
|
|
codeName = errorCodeInfo.sharedName ?? errorName;
|
|
variableName = '$className.$errorName';
|
|
if (unverifiedDocs.contains(variableName)) {
|
|
continue;
|
|
}
|
|
hasWrittenVariableName = false;
|
|
|
|
List<_SnippetData> exampleSnippets = _extractSnippets(
|
|
docs,
|
|
BlockSection.examples,
|
|
);
|
|
_SnippetData? firstExample;
|
|
if (exampleSnippets.isEmpty) {
|
|
_reportProblem('No example.');
|
|
} else {
|
|
firstExample = exampleSnippets[0];
|
|
}
|
|
for (int i = 0; i < exampleSnippets.length; i++) {
|
|
_SnippetData snippet = exampleSnippets[i];
|
|
if (className == 'LintCode') {
|
|
snippet.lintCode = codeName;
|
|
}
|
|
await _validateSnippet('example', i, snippet);
|
|
}
|
|
|
|
List<_SnippetData> fixesSnippets = _extractSnippets(
|
|
docs,
|
|
BlockSection.commonFixes,
|
|
);
|
|
for (int i = 0; i < fixesSnippets.length; i++) {
|
|
_SnippetData snippet = fixesSnippets[i];
|
|
if (firstExample != null) {
|
|
snippet.auxiliaryFiles.addAll(firstExample.auxiliaryFiles);
|
|
}
|
|
if (className == 'LintCode') {
|
|
snippet.lintCode = codeName;
|
|
}
|
|
await _validateSnippet('fixes', i, snippet);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Resolve the [snippet]. If the snippet's offset is less than zero, then
|
|
/// verify that no diagnostics are reported. If the offset is greater than or
|
|
/// equal to zero, verify that one error whose name matches the current code
|
|
/// is reported at that offset with the expected length.
|
|
Future<void> _validateSnippet(
|
|
String section,
|
|
int index,
|
|
_SnippetData snippet,
|
|
) async {
|
|
_SnippetTest test = _SnippetTest(snippet);
|
|
test.setUp();
|
|
await test.resolveTestFile();
|
|
List<Diagnostic> diagnostics = test.result.errors;
|
|
int errorCount = diagnostics.length;
|
|
if (snippet.offset < 0) {
|
|
if (errorCount > 0) {
|
|
_reportProblem(
|
|
'Expected no errors but found $errorCount ($section $index):',
|
|
diagnostics: diagnostics,
|
|
);
|
|
}
|
|
} else {
|
|
if (errorCount == 0) {
|
|
_reportProblem('Expected one error but found none ($section $index).');
|
|
} else if (errorCount == 1) {
|
|
Diagnostic diagnostic = diagnostics[0];
|
|
if (diagnostic.errorCode.name != codeName) {
|
|
_reportProblem(
|
|
'Expected an error with code $codeName, '
|
|
'found ${diagnostic.errorCode} ($section $index).',
|
|
);
|
|
}
|
|
if (diagnostic.offset != snippet.offset) {
|
|
_reportProblem(
|
|
'Expected an error at ${snippet.offset}, '
|
|
'found ${diagnostic.offset} ($section $index).',
|
|
);
|
|
}
|
|
if (diagnostic.length != snippet.length) {
|
|
_reportProblem(
|
|
'Expected an error of length ${snippet.length}, '
|
|
'found ${diagnostic.length} ($section $index).',
|
|
);
|
|
}
|
|
} else {
|
|
_reportProblem(
|
|
'Expected one error but found $errorCount ($section $index):',
|
|
diagnostics: diagnostics,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Validate the documentation associated with the declarations of the error
|
|
/// codes.
|
|
@reflectiveTest
|
|
class VerifyDiagnosticsTest {
|
|
@TestTimeout(Timeout.factor(4))
|
|
test_diagnostics() async {
|
|
//
|
|
// Validate that the input to the generator is correct.
|
|
//
|
|
DocumentationValidator validator = DocumentationValidator();
|
|
await validator.validate();
|
|
}
|
|
|
|
test_published() {
|
|
// Verify that if _any_ error code is marked as having published docs then
|
|
// _all_ codes with the same name are also marked that way.
|
|
var nameToCodeMap = <String, List<DiagnosticCode>>{};
|
|
var nameToPublishedMap = <String, bool>{};
|
|
for (var code in errorCodeValues) {
|
|
var name = code.name;
|
|
nameToCodeMap.putIfAbsent(name, () => []).add(code);
|
|
nameToPublishedMap[name] =
|
|
(nameToPublishedMap[name] ?? false) || code.hasPublishedDocs;
|
|
}
|
|
var unpublished = <DiagnosticCode>[];
|
|
for (var entry in nameToCodeMap.entries) {
|
|
var name = entry.key;
|
|
if (nameToPublishedMap[name]!) {
|
|
for (var code in entry.value) {
|
|
if (!code.hasPublishedDocs) {
|
|
unpublished.add(code);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (unpublished.isNotEmpty) {
|
|
var buffer = StringBuffer();
|
|
buffer.write(
|
|
"The following error codes have published docs but aren't "
|
|
"marked as such:",
|
|
);
|
|
for (var code in unpublished) {
|
|
buffer.writeln();
|
|
buffer.write('- ${code.runtimeType}.${code.uniqueName}');
|
|
}
|
|
fail(buffer.toString());
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A data holder used to return multiple values when extracting an error range
|
|
/// from a snippet.
|
|
class _SnippetData {
|
|
final String content;
|
|
final int offset;
|
|
final int length;
|
|
final Map<String, String> auxiliaryFiles;
|
|
final List<String> experiments;
|
|
final String? languageVersion;
|
|
String? lintCode;
|
|
|
|
_SnippetData(
|
|
this.content,
|
|
this.offset,
|
|
this.length,
|
|
this.auxiliaryFiles,
|
|
this.experiments,
|
|
this.languageVersion,
|
|
);
|
|
}
|
|
|
|
/// A test class that creates an environment suitable for analyzing the
|
|
/// snippets.
|
|
class _SnippetTest extends PubPackageResolutionTest {
|
|
/// The snippet being tested.
|
|
final _SnippetData snippet;
|
|
|
|
/// Initialize a newly created test to test the given [snippet].
|
|
_SnippetTest(this.snippet) {
|
|
writeTestPackageAnalysisOptionsFile(
|
|
analysisOptionsContent(experiments: snippet.experiments),
|
|
);
|
|
}
|
|
|
|
@override
|
|
String? get testPackageLanguageVersion {
|
|
return snippet.languageVersion;
|
|
}
|
|
|
|
@override
|
|
String get testPackageRootPath => '$workspaceRootPath/docTest';
|
|
|
|
@override
|
|
void setUp() {
|
|
super.setUp();
|
|
_createAnalysisOptionsFile();
|
|
_createAuxiliaryFiles(snippet.auxiliaryFiles);
|
|
addTestFile(snippet.content);
|
|
}
|
|
|
|
void _createAnalysisOptionsFile() {
|
|
var lintCode = snippet.lintCode;
|
|
if (lintCode != null) {
|
|
writeTestPackageAnalysisOptionsFile(
|
|
analysisOptionsContent(
|
|
rules: [lintCode],
|
|
experiments: snippet.experiments,
|
|
),
|
|
);
|
|
}
|
|
}
|
|
|
|
void _createAuxiliaryFiles(Map<String, String> auxiliaryFiles) {
|
|
var packageConfigBuilder = PackageConfigFileBuilder();
|
|
for (String uriStr in auxiliaryFiles.keys) {
|
|
if (uriStr.startsWith('package:')) {
|
|
Uri uri = Uri.parse(uriStr);
|
|
|
|
String packageName = uri.pathSegments[0];
|
|
String packageRootPath = '/packages/$packageName';
|
|
packageConfigBuilder.add(name: packageName, rootPath: packageRootPath);
|
|
|
|
String pathInLib = uri.pathSegments.skip(1).join('/');
|
|
newFile('$packageRootPath/lib/$pathInLib', auxiliaryFiles[uriStr]!);
|
|
} else {
|
|
newFile('$testPackageRootPath/$uriStr', auxiliaryFiles[uriStr]!);
|
|
}
|
|
}
|
|
writeTestPackageConfig(
|
|
packageConfigBuilder,
|
|
angularMeta: true,
|
|
ffi: true,
|
|
flutter: true,
|
|
meta: true,
|
|
);
|
|
}
|
|
}
|