pkg/linter/test/rules/directives_ordering_test.dart

// Copyright (c) 2023, 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:linter/src/rules/directives_ordering.dart';
import 'package:test/test.dart';
import 'package:test_reflective_loader/test_reflective_loader.dart';

import '../rule_test_support.dart';

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

  group('compareDirectives', () {
    void checkSection(List<String> correctlyOrderedImports) {
      for (int i = 0; i < correctlyOrderedImports.length; i++) {
        var a = correctlyOrderedImports[i];
        expect(
          compareDirectives(a, a),
          0,
          reason: '"$a" sorts the same as itself',
        );

        for (int j = i + 1; j < correctlyOrderedImports.length; j++) {
          var b = correctlyOrderedImports[j];
          expect(
            compareDirectives(a, b),
            lessThan(0),
            reason: '"$a" sorts before "$b"',
          );
          expect(
            compareDirectives(b, a),
            greaterThan(0),
            reason: '"$b" sorts after "$a"',
          );
        }
      }
    }

    test('dart: imports', () {
      checkSection(const ['dart:aaa', 'dart:bbb']);
    });

    test('package: imports', () {
      checkSection(const [
        'package:aa/bb.dart',
        'package:aaa/aaa.dart',
        'package:aaa/ccc.dart',
        'package:bbb/bbb.dart',
      ]);
    });

    test('relative imports', () {
      checkSection(const [
        '/foo5.dart',
        '../../foo4.dart',
        '../foo2/a.dart',
        '../foo3.dart',
        './foo2.dart',
        'a.dart',
        'aaa/aaa.dart',
        'bbb/bbb.dart',
        'foo1.dart',
      ]);
    });
  });
}

@reflectiveTest
class DirectivesOrderingTest extends LintRuleTest {
  @override
  bool get addFlutterPackageDep => true;

  @override
  bool get addJsPackageDep => true;

  @override
  bool get addMetaPackageDep => true;

  @override
  String get lintRule => LintNames.directives_ordering;

  test_dartDirectivesGoFirst_docImports() async {
    newFile('$testPackageLibPath/a.dart', '');
    await assertDiagnostics(
      r'''
/// @docImport 'dart:math';
/// @docImport 'a.dart';
/// @docImport 'dart:html';
/// @docImport 'dart:isolate';
library;
''',
      [lint(61, 19), lint(89, 22)],
    );
  }

  test_dartDirectivesGoFirst_exports() async {
    newFile('$testPackageLibPath/a.dart', '');
    await assertDiagnostics(
      r'''
export 'dart:math';
export 'a.dart';
export 'dart:html';
export 'dart:isolate';
// ignore_for_file: unused_import
''',
      [lint(37, 19), lint(57, 22)],
    );
  }

  test_dartDirectivesGoFirst_imports() async {
    newFile('$testPackageLibPath/a.dart', '');
    await assertDiagnostics(
      r'''
import 'dart:math';
import 'a.dart';
import 'dart:html';
import 'dart:isolate';
// ignore_for_file: unused_import
''',
      [lint(37, 19), lint(57, 22)],
    );
  }

  test_importsGoBeforeExports() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    newFile('$testPackageLibPath/c.dart', '');
    await assertDiagnostics(
      r'''
import 'a.dart';

export 'a.dart';

import 'b.dart';

export 'b.dart';

import 'c.dart';

export 'c.dart';
// ignore_for_file: unused_import
''',
      [lint(18, 16), lint(54, 16)],
    );
  }

  test_multipleSchemaImportsSortedByPath() async {
    newFile('$testPackageLibPath/a.dart', '');
    await assertNoDiagnostics(r'''
// From analysis_server/test/services/correction/organize_directives_test.dart
// test named `sort`.
library lib;

import 'dart:aaa';
import 'dart:bbb';

import 'package:aaa/aaa.dart';
import 'package:bbb/bbb.dart';

import 'http://aaa.com';
import 'http://bbb.com';

import 'aaa/aaa.dart';
import 'bbb/bbb.dart';

export 'dart:aaa';
export 'dart:bbb';

export 'package:aaa/aaa.dart';
export 'package:bbb/bbb.dart';

export 'http://aaa.com';
export 'http://bbb.com';

export 'aaa/aaa.dart';
export 'bbb/bbb.dart';

part 'aaa/aaa.dart';
part 'bbb/bbb.dart';

main() {}

// ignore_for_file: unused_import, uri_does_not_exist
''');
  }

  test_packageDirectivesGoBeforeRelative_docImports() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    await assertDiagnostics(
      r'''
/// @docImport 'dart:math';
/// @docImport 'package:js/js.dart';
/// @docImport 'a.dart';
/// @docImport 'package:meta/meta.dart';
/// @docImport 'b.dart';
library;
''',
      [lint(98, 32)],
    );
  }

  test_packageDirectivesGoBeforeRelative_exports() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    await assertDiagnostics(
      r'''
export 'dart:math';
export 'a.dart';
export 'package:js/js.dart';
export 'package:meta/meta.dart';
export 'b.dart';
// ignore_for_file: unused_import
''',
      [lint(37, 28), lint(66, 32)],
    );
  }

  test_packageDirectivesGoBeforeRelative_imports() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    await assertDiagnostics(
      r'''
import 'dart:math';
import 'package:js/js.dart';
import 'a.dart';
import 'package:meta/meta.dart';
import 'b.dart';
// ignore_for_file: unused_import
''',
      [lint(66, 32)],
    );
  }

  test_packageImportsSortedByPath() async {
    newFile('$testPackageLibPath/a.dart', '');
    await assertNoDiagnostics(r'''
// From analysis_server/test/services/correction/organize_directives_test.dart
// test named `sort_imports_packageAndPath`.

library lib;

import 'package:product.ui/entity.dart';
import 'package:product.ui.api/entity1.dart';
import 'package:product.ui.api/entity2.dart';
import 'package:product.ui.api.aaa/manager2.dart';
import 'package:product.ui.api.bbb/manager1.dart';
import 'package:product2.client/entity.dart';

// ignore_for_file: unused_import, uri_does_not_exist
''');
  }

  test_partOrder_sorted() async {
    newFile('$testPackageLibPath/a.dart', r'''
part of 'test.dart';
''');
    newFile('$testPackageLibPath/b.dart', r'''
part of 'test.dart';
''');

    await assertNoDiagnostics(r'''
part 'a.dart';
part 'b.dart';
''');
  }

  test_partOrder_unsorted() async {
    newFile('$testPackageLibPath/a.dart', r'''
part of 'test.dart';
''');
    newFile('$testPackageLibPath/b.dart', r'''
part of 'test.dart';
''');

    // Because parts can contain augmentations, whose order of
    // application matters, we do *not* want to enforce part sorting.
    // See: https://github.com/dart-lang/linter/issues/4945
    await assertNoDiagnostics(r'''
part 'b.dart';
part 'a.dart';
''');
  }

  test_reportOneNodeOnlyOnce() async {
    newFile('$testPackageLibPath/a.dart', '');
    await assertDiagnostics(
      r'''
import 'package:meta/meta.dart';
import 'a.dart';
import 'package:js/js.dart';
// ignore_for_file: unused_import
''',
      [lint(50, 28)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_dartSchema_docImport() async {
    await assertDiagnostics(
      r'''
/// @docImport 'dart:html';
/// @docImport 'dart:isolate';
/// @docImport 'dart:convert';
/// @docImport 'dart:math';
library;
''',
      [lint(67, 22)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_dartSchema_export() async {
    await assertDiagnostics(
      r'''
export 'dart:isolate';
export 'dart:convert';
export 'dart:math';
''',
      [lint(23, 22)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_dartSchema_import() async {
    await assertDiagnostics(
      r'''
import 'dart:html';
import 'dart:isolate';
import 'dart:convert';
import 'dart:math';
// ignore_for_file: unused_import
''',
      [lint(43, 22)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_dotInRelativePath_import() async {
    await assertDiagnostics(
      r'''
import './foo1.dart';
import '../../foo2.dart';
import '../foo3.dart';
import 'foo4.dart';
// ignore_for_file: unused_import, uri_does_not_exist
''',
      [lint(22, 25)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_dotInRelativePath_import_ok() async {
    await assertNoDiagnostics(r'''
import '/foo5.dart';
import '../../foo4.dart';
import '../foo3.dart';
import './foo2.dart';
import 'foo1.dart';
// ignore_for_file: unused_import, uri_does_not_exist
''');
  }

  test_sortDirectiveSectionsAlphabetically_packageSchema_export() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    newFile('$testPackageLibPath/c.dart', '');
    await assertDiagnostics(
      r'''
export 'package:js/js.dart';
export 'package:meta/meta.dart';
export 'package:flutter/widgets.dart';

export 'package:test/a.dart';
export 'package:test/c.dart';
export 'package:test/b.dart';
''',
      [lint(62, 38), lint(162, 29)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_packageSchema_import() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    newFile('$testPackageLibPath/c.dart', '');
    await assertDiagnostics(
      r'''
import 'package:js/js.dart';
import 'package:meta/meta.dart';
import 'package:flutter/widgets.dart';

import 'package:test/a.dart';
import 'package:test/c.dart';
import 'package:test/b.dart';
// ignore_for_file: unused_import
''',
      [lint(62, 38), lint(162, 29)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_relativePath_export() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    newFile('$testPackageLibPath/c.dart', '');
    newFile('$testPackageLibPath/d.dart', '');
    await assertDiagnostics(
      r'''
export 'd.dart';
export 'a.dart';
export 'b.dart';
export 'c.dart';
''',
      [lint(17, 16)],
    );
  }

  test_sortDirectiveSectionsAlphabetically_relativePath_import() async {
    newFile('$testPackageLibPath/a.dart', '');
    newFile('$testPackageLibPath/b.dart', '');
    newFile('$testPackageLibPath/c.dart', '');
    newFile('$testPackageLibPath/d.dart', '');
    await assertDiagnostics(
      r'''
import 'd.dart';
import 'd.dart';
import 'c.dart';
import 'c.dart';
import 'b.dart';
import 'b.dart';
import 'a.dart';
import 'a.dart';
// ignore_for_file: duplicate_import, unused_import
''',
      [lint(34, 16), lint(68, 16), lint(102, 16)],
    );
  }
}