pkg/analyzer/test/src/summary/elements_base.dart

// Copyright (c) 2022, 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/dart/analysis/results.dart';
import 'package:analyzer/file_system/file_system.dart';
import 'package:analyzer/src/dart/analysis/results.dart';
import 'package:analyzer/src/dart/element/element.dart';
import 'package:test/test.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';

import '../../util/diff.dart';
import '../dart/resolution/context_collection_resolution.dart';
import '../dart/resolution/node_text_expectations.dart';
import 'element_text.dart';

/// A base for testing building elements.
@reflectiveTest
abstract class ElementsBaseTest extends PubPackageResolutionTest {
  final ElementTextConfiguration configuration = ElementTextConfiguration();

  /// We need to test both cases - when we keep linking libraries (happens for
  /// new or invalidated libraries), and when we load libraries from bytes
  /// (happens internally in Blaze or when we have cached summaries).
  bool get keepLinkingLibraries;

  Future<LibraryElementImpl> buildFileLibrary(File file) async {
    var analysisContext = contextFor(file);
    var analysisSession = analysisContext.currentSession;

    var uri = analysisSession.uriConverter.pathToUri(file.path);
    var uriStr = uri.toString();
    var libraryResult = await analysisSession.getLibraryByUri(uriStr);

    if (keepLinkingLibraries) {
      return libraryResult.element;
    } else {
      analysisContext.changeFile(file.path);
      await analysisContext.applyPendingFileChanges();
      // Ask again, should be read from bytes.
      return testContextLibrary(uriStr);
    }
  }

  Future<LibraryElementImpl> buildLibrary(String text) async {
    var file = newFileWithLanguageFeatureDirective(testFile.path, text);
    return await buildFileLibrary(file);
  }

  void checkElementText(LibraryElementImpl library, String expected) {
    var actual = getLibraryText(library: library, configuration: configuration);
    if (actual != expected) {
      NodeTextExpectationsCollector.add(actual);
      if (NodeTextExpectationsCollector.shouldPrintFailureDetails) {
        printPrettyDiff(expected, actual);
      }
      fail('See the difference above.');
    }
  }

  ElementImpl getConstructorElementOfReference(
    InstanceElementImpl parent,
    String key,
  ) {
    var reference = parent.reference.getOrCreateConstructor(key);
    var elementFactory = parent.library.session.elementFactory;
    return elementFactory.elementOfReference3(reference);
  }

  ElementImpl getFieldElementOfReference(
    InstanceElementImpl parent,
    String key,
  ) {
    var reference = parent.reference.getOrCreateField(key);
    var elementFactory = parent.library.session.elementFactory;
    return elementFactory.elementOfReference3(reference);
  }

  ElementImpl getGetterElementOfReference(
    InstanceElementImpl parent,
    String key,
  ) {
    var reference = parent.reference.getOrCreateGetter(key);
    var elementFactory = parent.library.session.elementFactory;
    return elementFactory.elementOfReference3(reference);
  }

  ElementImpl getMethodElementOfReference(
    InstanceElementImpl parent,
    String key,
  ) {
    var reference = parent.reference.getOrCreateMethod(key);
    var elementFactory = parent.library.session.elementFactory;
    return elementFactory.elementOfReference3(reference);
  }

  ElementImpl getSetterElementOfReference(
    InstanceElementImpl parent,
    String key,
  ) {
    var reference = parent.reference.getOrCreateSetter(key);
    var elementFactory = parent.library.session.elementFactory;
    return elementFactory.elementOfReference3(reference);
  }

  Future<LibraryElementImpl> testContextLibrary(String uriStr) async {
    var analysisContext = contextFor(testFile);
    var analysisSession = analysisContext.currentSession;
    var libraryResult = await analysisSession.getLibraryByUri(uriStr);
    return libraryResult.element;
  }
}

extension on SomeLibraryElementResult {
  LibraryElementImpl get element {
    return (this as LibraryElementResultImpl).element;
  }
}