sdk/pkg/analysis_server/test/support/configuration_files.dart

// Copyright (c) 2024, 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/file_system/file_system.dart';
import 'package:analyzer/src/dart/analysis/experiments.dart';
import 'package:analyzer/src/util/file_paths.dart' as file_paths;
import 'package:analyzer_testing/mock_packages/mock_packages.dart';
import 'package:analyzer_testing/package_config_file_builder.dart';
import 'package:analyzer_testing/utilities/extensions/resource_provider.dart';

/// A mixin adding functionality to write `.dart_tool/package_config.json`
/// files along with mock packages to a [ResourceProvider].
mixin ConfigurationFilesMixin on MockPackagesMixin {
  /// Adds the 'flutter_localizations' package to the package config file for
  /// the package-under-test.
  ///
  /// This allows `package:flutter_localizations/flutter_localizations.dart`
  /// imports to resolve.
  bool get addFlutterLocalizationsPackageDep => false;

  /// Adds the 'flutter_test' package to the package config file for the
  /// package-under-test.
  ///
  /// This allows `package:flutter_test/flutter_test.dart` imports to resolve.
  bool get addFlutterTestPackageDep => false;

  /// Adds the 'vector_math' package to the package config file for the
  /// package-under-test.
  ///
  /// This allows `package:vector_math/vector_math_64.dart` imports to resolve.
  bool get addVectorMathPackageDep => false;

  String get dartSdkPath;

  /// The Dart language version of the test package being used for testing.
  String get testPackageLanguageVersion => _latestLanguageVersion;

  /// The path to the test package being used for testing.
  String get testPackageRootPath;

  String get _latestLanguageVersion =>
      '${ExperimentStatus.currentVersion.major}.'
      '${ExperimentStatus.currentVersion.minor}';

  /// Writes a package_config.json for the package at [projectFolderPath]. If
  /// [packageName] is not supplied, the last segment of [projectFolderPath] is
  /// used.
  void writePackageConfig(
    String projectFolderPath, {
    // The name of this package. If not provided, the last segment of the path
    // will be used.
    String? packageName,
    PackageConfigFileBuilder? config,
    String? languageVersion,
    bool flutter = false,
    bool meta = false,
  }) {
    projectFolderPath = resourceProvider.convertPath(projectFolderPath);

    if (config == null) {
      config = PackageConfigFileBuilder();
    } else {
      config = config.copy();
    }

    // Add this package to its own config.
    config.add(
      name: packageName ?? pathContext.basename(projectFolderPath),
      rootFolder: resourceProvider.getFolder(projectFolderPath),
      languageVersion: languageVersion ?? testPackageLanguageVersion,
    );

    if (meta || flutter) {
      var libFolder = addMeta();
      config.add(name: 'meta', rootFolder: libFolder.parent);
    }

    if (flutter) {
      var skyEnginePath = addSkyEngine(sdkPath: dartSdkPath).parent.path;
      config.add(
        name: 'sky_engine',
        rootFolder: resourceProvider.getFolder(skyEnginePath),
      );

      var flutterLibFolder = addFlutter();
      config.add(name: 'flutter', rootFolder: flutterLibFolder.parent);
    }

    if (addFlutterTestPackageDep) {
      var flutterTestRootPath = resourceProvider.convertPath(
        '$packagesRootPath/flutter_test',
      );

      var flutterTestRoot = resourceProvider.getFolder(flutterTestRootPath);
      var libFolder = flutterTestRoot.getFolder('lib')..create();
      libFolder.getFile('flutter_test.dart').writeAsStringSync(r'''
void test(Object description, dynamic Function() body) {}

void group(Object description, void Function() body) {}

void main() {
  // Because this file is called 'flutter_test.dart' and is inside the 'test'
  // folder, it will be considered a test suite. To avoid it failing the bots
  // with "Invoked Dart programs must have a 'main' function defined", provide
  // an empty main function.
}

''');
      config.add(name: 'flutter_test', rootFolder: flutterTestRoot);
    }

    if (addVectorMathPackageDep) {
      var libFolder = addVectorMath();
      config.add(name: 'vector_math', rootFolder: libFolder.parent);
    }

    var content = config.toContent();

    var projectFolder = resourceProvider.getFolder(projectFolderPath);
    var dartToolFolder = projectFolder.getFolder(file_paths.dotDartTool)
      ..create();
    dartToolFolder
        .getFile(file_paths.packageConfigJson)
        .writeAsStringSync(content);
  }

  /// Writes a package_config.json for the package under test (considered
  /// 'package:test') that lives in [testPackageRootPath].
  void writeTestPackageConfig({
    PackageConfigFileBuilder? config,
    String? languageVersion,
    bool flutter = false,
    bool meta = false,
  }) {
    writePackageConfig(
      testPackageRootPath,
      config: config,
      languageVersion: languageVersion,
      packageName: 'test',
      flutter: flutter,
      meta: meta,
    );
  }
}