tests/compiler/dart2js/equivalence/id_equivalence_helper.dart - sdk.git - Git at Google

 // Copyright (c) 2017, 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 'dart:async';
 import 'dart:io';

 import 'package:compiler/src/common.dart';
 import 'package:compiler/src/common_elements.dart';
 import 'package:compiler/src/compiler.dart';
 import 'package:compiler/src/elements/entities.dart';
 import 'package:expect/expect.dart';

 import '../annotated_code_helper.dart';
 import '../memory_compiler.dart';
 import '../equivalence/id_equivalence.dart';
 import '../kernel/compiler_helper.dart';

 /// Function that compiles [code] with [options] and returns the [Compiler] object.
 typedef Future<Compiler> CompileFunction(
     AnnotatedCode code, Uri mainUri, List<String> options);

 /// Function that computes a data mapping for [member].
 ///
 /// Fills [actualMap] with the data and [sourceSpanMap] with the source spans
 /// for the data origin.
 typedef void ComputeMemberDataFunction(
     Compiler compiler, MemberEntity member, Map<Id, ActualData> actualMap,
     {bool verbose});

 const String stopAfterTypeInference = 'stopAfterTypeInference';

 /// Compile [code] from .dart sources.
 Future<Compiler> compileFromSource(
     AnnotatedCode code, Uri mainUri, List<String> options) async {
   Compiler compiler = compilerFor(
       memorySourceFiles: {'main.dart': code.sourceCode}, options: options);
   compiler.stopAfterTypeInference = options.contains(stopAfterTypeInference);
   await compiler.run(mainUri);
   return compiler;
 }

 /// Compile [code] from .dill sources.
 Future<Compiler> compileFromDill(
     AnnotatedCode code, Uri mainUri, List<String> options) async {
   Compiler compiler = await compileWithDill(
       entryPoint: mainUri,
       memorySourceFiles: {'main.dart': code.sourceCode},
       options: options,
       beforeRun: (Compiler compiler) {
         compiler.stopAfterTypeInference =
             options.contains(stopAfterTypeInference);
       });
   return compiler;
 }

 /// Compute expected and actual data for all members defined in [annotatedCode].
 ///
 /// Actual data is computed using [computeMemberData] and [code] is compiled
 /// using [compileFunction].
 Future<IdData> computeData(
     String annotatedCode,
     ComputeMemberDataFunction computeMemberData,
     CompileFunction compileFunction,
     {List<String> options: const <String>[],
     bool verbose: false}) async {
   AnnotatedCode code =
       new AnnotatedCode.fromText(annotatedCode, commentStart, commentEnd);
   Map<Id, IdValue> expectedMap = computeExpectedMap(code);
   Map<Id, ActualData> actualMap = <Id, ActualData>{};
   Uri mainUri = Uri.parse('memory:main.dart');
   Compiler compiler = await compileFunction(code, mainUri, options);
   ElementEnvironment elementEnvironment =
       compiler.backendClosedWorldForTesting.elementEnvironment;
   LibraryEntity mainLibrary = elementEnvironment.mainLibrary;
   elementEnvironment.forEachClass(mainLibrary, (ClassEntity cls) {
     elementEnvironment.forEachConstructor(cls, (ConstructorEntity constructor) {
       computeMemberData(compiler, constructor, actualMap, verbose: verbose);
     });
     elementEnvironment.forEachClassMember(cls,
         (ClassEntity declarer, MemberEntity member) {
       if (cls == declarer) {
         computeMemberData(compiler, member, actualMap, verbose: verbose);
       }
     });
   });
   elementEnvironment.forEachLibraryMember(mainLibrary, (MemberEntity member) {
     computeMemberData(compiler, member, actualMap, verbose: verbose);
   });
   return new IdData(
       code, compiler, elementEnvironment, mainUri, expectedMap, actualMap);
 }

 /// Data collected by [computeData].
 class IdData {
   final AnnotatedCode code;
   final Compiler compiler;
   final ElementEnvironment elementEnvironment;
   final Uri mainUri;
   final Map<Id, IdValue> expectedMap;
   final Map<Id, ActualData> actualMap;

   IdData(this.code, this.compiler, this.elementEnvironment, this.mainUri,
       this.expectedMap, this.actualMap);

   String withAnnotations(Map<int, List<String>> annotations) {
     StringBuffer sb = new StringBuffer();
     int end = 0;
     for (int offset in annotations.keys.toList()..sort()) {
       if (offset > end) {
         sb.write(code.sourceCode.substring(end, offset));
       }
       for (String annotation in annotations[offset]) {
         sb.write('/* ');
         sb.write(annotation);
         sb.write(' */');
       }
       end = offset;
     }
     if (end < code.sourceCode.length) {
       sb.write(code.sourceCode.substring(end));
     }
     return sb.toString();
   }

   String get actualCode {
     Map<int, List<String>> annotations = <int, List<String>>{};
     actualMap.forEach((Id id, ActualData data) {
       annotations
           .putIfAbsent(data.sourceSpan.begin, () => [])
           .add('${data.value}');
     });
     return withAnnotations(annotations);
   }

   String get diffCode {
     Map<int, List<String>> annotations = <int, List<String>>{};
     actualMap.forEach((Id id, ActualData data) {
       IdValue value = expectedMap[id];
       if (data.value != value || value == null && data.value.value != '') {
         String expected = value?.toString() ?? '';
         int offset = getOffsetFromId(id);
         annotations
             .putIfAbsent(offset, () => [])
             .add('${expected} | ${data.value}');
       }
     });
     expectedMap.forEach((Id id, IdValue expected) {
       if (!actualMap.containsKey(id)) {
         int offset = getOffsetFromId(id);
         annotations.putIfAbsent(offset, () => []).add('${expected} | ---');
       }
     });
     return withAnnotations(annotations);
   }

   String computeDiffCodeFor(IdData other) {
     Map<int, List<String>> annotations = <int, List<String>>{};
     actualMap.forEach((Id id, ActualData data1) {
       ActualData data2 = other.actualMap[id];
       if (data1.value != data2?.value) {
         annotations
             .putIfAbsent(data1.sourceSpan.begin, () => [])
             .add('${data1.value} | ${data2?.value ?? '---'}');
       }
     });
     other.actualMap.forEach((Id id, ActualData data2) {
       if (!actualMap.containsKey(id)) {
         int offset = compiler.reporter
             .spanFromSpannable(
                 computeSpannable(elementEnvironment, mainUri, id))
             .begin;
         annotations.putIfAbsent(offset, () => []).add('--- | ${data2.value}');
       }
     });
     return withAnnotations(annotations);
   }

   int getOffsetFromId(Id id) {
     return compiler.reporter
         .spanFromSpannable(computeSpannable(elementEnvironment, mainUri, id))
         .begin;
   }
 }

 /// Check code for all test files int [data] using [computeFromAst] and
 /// [computeFromKernel] from the respective front ends. If [skipForKernel]
 /// contains the name of the test file it isn't tested for kernel.
 Future checkTests(Directory dataDir, ComputeMemberDataFunction computeFromAst,
     ComputeMemberDataFunction computeFromKernel,
     {List<String> skipForKernel: const <String>[],
     List<String> options: const <String>[],
     List<String> args: const <String>[]}) async {
   args = args.toList();
   bool verbose = args.remove('-v');
   await for (FileSystemEntity entity in dataDir.list()) {
     String name = entity.uri.pathSegments.last;
     if (args.isNotEmpty && !args.contains(name)) continue;
     print('----------------------------------------------------------------');
     print('Checking ${entity.uri}');
     print('----------------------------------------------------------------');
     String annotatedCode = await new File.fromUri(entity.uri).readAsString();
     print('--from ast------------------------------------------------------');
     await checkCode(annotatedCode, computeFromAst, compileFromSource,
         options: options, verbose: verbose);
     if (skipForKernel.contains(name)) {
       print('--skipped for kernel------------------------------------------');
       continue;
     }
     print('--from kernel---------------------------------------------------');
     await checkCode(annotatedCode, computeFromKernel, compileFromDill,
         options: options, verbose: verbose);
   }
 }

 /// Compiles the [annotatedCode] with the provided [options] and calls
 /// [computeMemberData] for each member. The result is checked against the
 /// expected data derived from [annotatedCode].
 Future checkCode(
     String annotatedCode,
     ComputeMemberDataFunction computeMemberData,
     CompileFunction compileFunction,
     {List<String> options: const <String>[],
     bool verbose: false}) async {
   IdData data = await computeData(
       annotatedCode, computeMemberData, compileFunction,
       options: options, verbose: verbose);

   data.actualMap.forEach((Id id, ActualData actualData) {
     IdValue actual = actualData.value;
     if (!data.expectedMap.containsKey(id)) {
       if (actual.value != '') {
         reportHere(
             data.compiler.reporter,
             actualData.sourceSpan,
             'Id $id = ${actual} for ${actualData.object} '
             '(${actualData.object.runtimeType}) '
             'not expected in ${data.expectedMap.keys}');
         print('--annotations diff--------------------------------------------');
         print(data.diffCode);
         print('--------------------------------------------------------------');
       }
       Expect.equals('', actual.value);
     } else {
       IdValue expected = data.expectedMap[id];
       if (actual != expected) {
         reportHere(
             data.compiler.reporter,
             actualData.sourceSpan,
             'Object: ${actualData.object} (${actualData.object.runtimeType}), '
             'expected: ${expected}, actual: ${actual}');
         print('--annotations diff--------------------------------------------');
         print(data.diffCode);
         print('--------------------------------------------------------------');
       }
       Expect.equals(expected, actual);
     }
   });

   Set<Id> missingIds = new Set<Id>();
   data.expectedMap.forEach((Id id, IdValue expected) {
     if (!data.actualMap.containsKey(id)) {
       missingIds.add(id);
       reportHere(
           data.compiler.reporter,
           computeSpannable(data.elementEnvironment, data.mainUri, id),
           'Expected $expected for id $id missing in ${data.actualMap.keys}');
     }
   });
   if (missingIds.isNotEmpty) {
     print('--annotations diff--------------------------------------------');
     print(data.diffCode);
     print('--------------------------------------------------------------');
   }
   Expect.isTrue(missingIds.isEmpty, "Ids not found: ${missingIds}.");
 }

 /// Compute a [Spannable] from an [id] in the library [mainUri].
 Spannable computeSpannable(
     ElementEnvironment elementEnvironment, Uri mainUri, Id id) {
   if (id is NodeId) {
     return new SourceSpan(mainUri, id.value, id.value + 1);
   } else if (id is ElementId) {
     LibraryEntity library = elementEnvironment.lookupLibrary(mainUri);
     if (id.className != null) {
       ClassEntity cls =
           elementEnvironment.lookupClass(library, id.className, required: true);
       if (cls == null) {
         throw new ArgumentError("No class '${id.className}' in $mainUri.");
       }
       MemberEntity member =
           elementEnvironment.lookupClassMember(cls, id.memberName);
       if (member == null) {
         ConstructorEntity constructor =
             elementEnvironment.lookupConstructor(cls, id.memberName);
         if (constructor == null) {
           throw new ArgumentError(
               "No class member '${id.memberName}' in $cls.");
         }
         return constructor;
       }
       return member;
     } else {
       MemberEntity member =
           elementEnvironment.lookupLibraryMember(library, id.memberName);
       if (member == null) {
         throw new ArgumentError("No member '${id.memberName}' in $mainUri.");
       }
       return member;
     }
   }
   throw new UnsupportedError('Unsupported id $id.');
 }

 /// Compute the expectancy map from [code].
 Map<Id, IdValue> computeExpectedMap(AnnotatedCode code) {
   Map<Id, IdValue> map = <Id, IdValue>{};
   for (Annotation annotation in code.annotations) {
     IdValue idValue = IdValue.decode(annotation.offset, annotation.text);
     Expect.isFalse(map.containsKey(idValue.id),
         "Duplicate annotations for ${idValue.id}.");
     map[idValue.id] = idValue;
   }
   return map;
 }
	// Copyright (c) 2017, 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 'dart:async';
	import 'dart:io';

	import 'package:compiler/src/common.dart';
	import 'package:compiler/src/common_elements.dart';
	import 'package:compiler/src/compiler.dart';
	import 'package:compiler/src/elements/entities.dart';
	import 'package:expect/expect.dart';

	import '../annotated_code_helper.dart';
	import '../memory_compiler.dart';
	import '../equivalence/id_equivalence.dart';
	import '../kernel/compiler_helper.dart';

	/// Function that compiles [code] with [options] and returns the [Compiler] object.
	typedef Future<Compiler> CompileFunction(
	AnnotatedCode code, Uri mainUri, List<String> options);

	/// Function that computes a data mapping for [member].
	///
	/// Fills [actualMap] with the data and [sourceSpanMap] with the source spans
	/// for the data origin.
	typedef void ComputeMemberDataFunction(
	Compiler compiler, MemberEntity member, Map<Id, ActualData> actualMap,
	{bool verbose});

	const String stopAfterTypeInference = 'stopAfterTypeInference';

	/// Compile [code] from .dart sources.
	Future<Compiler> compileFromSource(
	AnnotatedCode code, Uri mainUri, List<String> options) async {
	Compiler compiler = compilerFor(
	memorySourceFiles: {'main.dart': code.sourceCode}, options: options);
	compiler.stopAfterTypeInference = options.contains(stopAfterTypeInference);
	await compiler.run(mainUri);
	return compiler;
	}

	/// Compile [code] from .dill sources.
	Future<Compiler> compileFromDill(
	AnnotatedCode code, Uri mainUri, List<String> options) async {
	Compiler compiler = await compileWithDill(
	entryPoint: mainUri,
	memorySourceFiles: {'main.dart': code.sourceCode},
	options: options,
	beforeRun: (Compiler compiler) {
	compiler.stopAfterTypeInference =
	options.contains(stopAfterTypeInference);
	});
	return compiler;
	}

	/// Compute expected and actual data for all members defined in [annotatedCode].
	///
	/// Actual data is computed using [computeMemberData] and [code] is compiled
	/// using [compileFunction].
	Future<IdData> computeData(
	String annotatedCode,
	ComputeMemberDataFunction computeMemberData,
	CompileFunction compileFunction,
	{List<String> options: const <String>[],
	bool verbose: false}) async {
	AnnotatedCode code =
	new AnnotatedCode.fromText(annotatedCode, commentStart, commentEnd);
	Map<Id, IdValue> expectedMap = computeExpectedMap(code);
	Map<Id, ActualData> actualMap = <Id, ActualData>{};
	Uri mainUri = Uri.parse('memory:main.dart');
	Compiler compiler = await compileFunction(code, mainUri, options);
	ElementEnvironment elementEnvironment =
	compiler.backendClosedWorldForTesting.elementEnvironment;
	LibraryEntity mainLibrary = elementEnvironment.mainLibrary;
	elementEnvironment.forEachClass(mainLibrary, (ClassEntity cls) {
	elementEnvironment.forEachConstructor(cls, (ConstructorEntity constructor) {
	computeMemberData(compiler, constructor, actualMap, verbose: verbose);
	});
	elementEnvironment.forEachClassMember(cls,
	(ClassEntity declarer, MemberEntity member) {
	if (cls == declarer) {
	computeMemberData(compiler, member, actualMap, verbose: verbose);
	}
	});
	});
	elementEnvironment.forEachLibraryMember(mainLibrary, (MemberEntity member) {
	computeMemberData(compiler, member, actualMap, verbose: verbose);
	});
	return new IdData(
	code, compiler, elementEnvironment, mainUri, expectedMap, actualMap);
	}

	/// Data collected by [computeData].
	class IdData {
	final AnnotatedCode code;
	final Compiler compiler;
	final ElementEnvironment elementEnvironment;
	final Uri mainUri;
	final Map<Id, IdValue> expectedMap;
	final Map<Id, ActualData> actualMap;

	IdData(this.code, this.compiler, this.elementEnvironment, this.mainUri,
	this.expectedMap, this.actualMap);

	String withAnnotations(Map<int, List<String>> annotations) {
	StringBuffer sb = new StringBuffer();
	int end = 0;
	for (int offset in annotations.keys.toList()..sort()) {
	if (offset > end) {
	sb.write(code.sourceCode.substring(end, offset));
	}
	for (String annotation in annotations[offset]) {
	sb.write('/* ');
	sb.write(annotation);
	sb.write(' */');
	}
	end = offset;
	}
	if (end < code.sourceCode.length) {
	sb.write(code.sourceCode.substring(end));
	}
	return sb.toString();
	}

	String get actualCode {
	Map<int, List<String>> annotations = <int, List<String>>{};
	actualMap.forEach((Id id, ActualData data) {
	annotations
	.putIfAbsent(data.sourceSpan.begin, () => [])
	.add('${data.value}');
	});
	return withAnnotations(annotations);
	}

	String get diffCode {
	Map<int, List<String>> annotations = <int, List<String>>{};
	actualMap.forEach((Id id, ActualData data) {
	IdValue value = expectedMap[id];
	if (data.value != value \|\| value == null && data.value.value != '') {
	String expected = value?.toString() ?? '';
	int offset = getOffsetFromId(id);
	annotations
	.putIfAbsent(offset, () => [])
	.add('${expected} \| ${data.value}');
	}
	});
	expectedMap.forEach((Id id, IdValue expected) {
	if (!actualMap.containsKey(id)) {
	int offset = getOffsetFromId(id);
	annotations.putIfAbsent(offset, () => []).add('${expected} \| ---');
	}
	});
	return withAnnotations(annotations);
	}

	String computeDiffCodeFor(IdData other) {
	Map<int, List<String>> annotations = <int, List<String>>{};
	actualMap.forEach((Id id, ActualData data1) {
	ActualData data2 = other.actualMap[id];
	if (data1.value != data2?.value) {
	annotations
	.putIfAbsent(data1.sourceSpan.begin, () => [])
	.add('${data1.value} \| ${data2?.value ?? '---'}');
	}
	});
	other.actualMap.forEach((Id id, ActualData data2) {
	if (!actualMap.containsKey(id)) {
	int offset = compiler.reporter
	.spanFromSpannable(
	computeSpannable(elementEnvironment, mainUri, id))
	.begin;
	annotations.putIfAbsent(offset, () => []).add('--- \| ${data2.value}');
	}
	});
	return withAnnotations(annotations);
	}

	int getOffsetFromId(Id id) {
	return compiler.reporter
	.spanFromSpannable(computeSpannable(elementEnvironment, mainUri, id))
	.begin;
	}
	}

	/// Check code for all test files int [data] using [computeFromAst] and
	/// [computeFromKernel] from the respective front ends. If [skipForKernel]
	/// contains the name of the test file it isn't tested for kernel.
	Future checkTests(Directory dataDir, ComputeMemberDataFunction computeFromAst,
	ComputeMemberDataFunction computeFromKernel,
	{List<String> skipForKernel: const <String>[],
	List<String> options: const <String>[],
	List<String> args: const <String>[]}) async {
	args = args.toList();
	bool verbose = args.remove('-v');
	await for (FileSystemEntity entity in dataDir.list()) {
	String name = entity.uri.pathSegments.last;
	if (args.isNotEmpty && !args.contains(name)) continue;
	print('----------------------------------------------------------------');
	print('Checking ${entity.uri}');
	print('----------------------------------------------------------------');
	String annotatedCode = await new File.fromUri(entity.uri).readAsString();
	print('--from ast------------------------------------------------------');
	await checkCode(annotatedCode, computeFromAst, compileFromSource,
	options: options, verbose: verbose);
	if (skipForKernel.contains(name)) {
	print('--skipped for kernel------------------------------------------');
	continue;
	}
	print('--from kernel---------------------------------------------------');
	await checkCode(annotatedCode, computeFromKernel, compileFromDill,
	options: options, verbose: verbose);
	}
	}

	/// Compiles the [annotatedCode] with the provided [options] and calls
	/// [computeMemberData] for each member. The result is checked against the
	/// expected data derived from [annotatedCode].
	Future checkCode(
	String annotatedCode,
	ComputeMemberDataFunction computeMemberData,
	CompileFunction compileFunction,
	{List<String> options: const <String>[],
	bool verbose: false}) async {
	IdData data = await computeData(
	annotatedCode, computeMemberData, compileFunction,
	options: options, verbose: verbose);

	data.actualMap.forEach((Id id, ActualData actualData) {
	IdValue actual = actualData.value;
	if (!data.expectedMap.containsKey(id)) {
	if (actual.value != '') {
	reportHere(
	data.compiler.reporter,
	actualData.sourceSpan,
	'Id $id = ${actual} for ${actualData.object} '
	'(${actualData.object.runtimeType}) '
	'not expected in ${data.expectedMap.keys}');
	print('--annotations diff--------------------------------------------');
	print(data.diffCode);
	print('--------------------------------------------------------------');
	}
	Expect.equals('', actual.value);
	} else {
	IdValue expected = data.expectedMap[id];
	if (actual != expected) {
	reportHere(
	data.compiler.reporter,
	actualData.sourceSpan,
	'Object: ${actualData.object} (${actualData.object.runtimeType}), '
	'expected: ${expected}, actual: ${actual}');
	print('--annotations diff--------------------------------------------');
	print(data.diffCode);
	print('--------------------------------------------------------------');
	}
	Expect.equals(expected, actual);
	}
	});

	Set<Id> missingIds = new Set<Id>();
	data.expectedMap.forEach((Id id, IdValue expected) {
	if (!data.actualMap.containsKey(id)) {
	missingIds.add(id);
	reportHere(
	data.compiler.reporter,
	computeSpannable(data.elementEnvironment, data.mainUri, id),
	'Expected $expected for id $id missing in ${data.actualMap.keys}');
	}
	});
	if (missingIds.isNotEmpty) {
	print('--annotations diff--------------------------------------------');
	print(data.diffCode);
	print('--------------------------------------------------------------');
	}
	Expect.isTrue(missingIds.isEmpty, "Ids not found: ${missingIds}.");
	}

	/// Compute a [Spannable] from an [id] in the library [mainUri].
	Spannable computeSpannable(
	ElementEnvironment elementEnvironment, Uri mainUri, Id id) {
	if (id is NodeId) {
	return new SourceSpan(mainUri, id.value, id.value + 1);
	} else if (id is ElementId) {
	LibraryEntity library = elementEnvironment.lookupLibrary(mainUri);
	if (id.className != null) {
	ClassEntity cls =
	elementEnvironment.lookupClass(library, id.className, required: true);
	if (cls == null) {
	throw new ArgumentError("No class '${id.className}' in $mainUri.");
	}
	MemberEntity member =
	elementEnvironment.lookupClassMember(cls, id.memberName);
	if (member == null) {
	ConstructorEntity constructor =
	elementEnvironment.lookupConstructor(cls, id.memberName);
	if (constructor == null) {
	throw new ArgumentError(
	"No class member '${id.memberName}' in $cls.");
	}
	return constructor;
	}
	return member;
	} else {
	MemberEntity member =
	elementEnvironment.lookupLibraryMember(library, id.memberName);
	if (member == null) {
	throw new ArgumentError("No member '${id.memberName}' in $mainUri.");
	}
	return member;
	}
	}
	throw new UnsupportedError('Unsupported id $id.');
	}

	/// Compute the expectancy map from [code].
	Map<Id, IdValue> computeExpectedMap(AnnotatedCode code) {
	Map<Id, IdValue> map = <Id, IdValue>{};
	for (Annotation annotation in code.annotations) {
	IdValue idValue = IdValue.decode(annotation.offset, annotation.text);
	Expect.isFalse(map.containsKey(idValue.id),
	"Duplicate annotations for ${idValue.id}.");
	map[idValue.id] = idValue;
	}
	return map;
	}