pkg/analysis_server/test/integration/analysis/overrides_test.dart

// Copyright (c) 2014, 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:analysis_server/protocol/protocol_generated.dart';
import 'package:test/test.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';

import '../support/integration_tests.dart';

void main() {
  defineReflectiveSuite(() {
    defineReflectiveTests(OverridesTest);
  });
}

@reflectiveTest
class OverridesTest extends AbstractAnalysisServerIntegrationTest {
  Future<void> test_overrides() async {
    var pathname = sourcePath('test.dart');
    var text = r'''
abstract class Interface1 {
  method0();
  method1();
  method2();
  method3();
}

abstract class Interface2 {
  method0();
  method1();
  method4();
  method5();
}

abstract class Base {
  method0();
  method2();
  method4();
  method6();
}

class Target extends Base implements Interface1, Interface2 {
  method0() {}
  method1() {}
  method2() {}
  method3() {}
  method4() {}
  method5() {}
  method6() {}
  method7() {}
}
''';
    writeFile(pathname, text);
    await standardAnalysisSetup();
    await sendAnalysisSetSubscriptions({
      AnalysisService.OVERRIDES: [pathname],
    });

    var params = await onAnalysisOverrides.first;
    expect(params.file, equals(pathname));
    var overrides = params.overrides;

    var targetOffset = text.indexOf('Target');

    Override? findOverride(String methodName) {
      var methodOffset = text.indexOf(methodName, targetOffset);
      for (var override in overrides) {
        if (override.offset == methodOffset) {
          return override;
        }
      }
      return null;
    }

    void checkOverrides(
      String methodName,
      bool expectedOverridesBase,
      List<String> expectedOverridesInterfaces,
    ) {
      var override = findOverride(methodName);

      if (!expectedOverridesBase && expectedOverridesInterfaces.isEmpty) {
        // This method overrides nothing, so it should not appear in the
        // overrides list.
        expect(override, isNull);
        return;
      } else {
        override!;
      }

      expect(override.length, equals(methodName.length));
      var superclassMember = override.superclassMember;
      if (expectedOverridesBase) {
        superclassMember!;
        expect(superclassMember.element.name, equals(methodName));
        expect(superclassMember.className, equals('Base'));
      } else {
        expect(superclassMember, isNull);
      }
      var interfaceMembers = override.interfaceMembers;
      if (expectedOverridesInterfaces.isNotEmpty) {
        interfaceMembers!;
        var actualOverridesInterfaces = <String>{};
        for (var overriddenMember in interfaceMembers) {
          expect(overriddenMember.element.name, equals(methodName));
          var className = overriddenMember.className;
          var wasAdded = actualOverridesInterfaces.add(className);
          expect(wasAdded, isTrue);
        }
        expect(
          actualOverridesInterfaces,
          equals(expectedOverridesInterfaces.toSet()),
        );
      } else {
        expect(interfaceMembers, isNull);
      }
    }

    checkOverrides('method0', true, ['Interface1', 'Interface2']);
    checkOverrides('method1', false, ['Interface1', 'Interface2']);
    checkOverrides('method2', true, ['Interface1']);
    checkOverrides('method3', false, ['Interface1']);
    checkOverrides('method4', true, ['Interface2']);
    checkOverrides('method5', false, ['Interface2']);
    checkOverrides('method6', true, []);
    checkOverrides('method7', false, []);
  }
}