pkgs/native_toolchain_c/test/clinker/objects_helper.dart

// Copyright (c) 2025, 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:io';

import 'package:code_assets/code_assets.dart';
import 'package:hooks/hooks.dart';
import 'package:native_toolchain_c/native_toolchain_c.dart';
import 'package:test/test.dart';

import '../helpers.dart';
import 'build_testfiles.dart';

void runObjectsTests(
  OS targetOS,
  List<Architecture> architectures, {
  int? androidTargetNdkApi, // Must be specified iff targetOS is OS.android.
  int? macOSTargetVersion, // Must be specified iff targetOS is OS.macos.
  int? iOSTargetVersion, // Must be specified iff targetOS is OS.iOS.
  IOSSdk? iOSTargetSdk, // Must be specified iff targetOS is OS.iOS.
}) {
  if (targetOS == OS.android) {
    ArgumentError.checkNotNull(androidTargetNdkApi, 'androidTargetNdkApi');
  }
  if (targetOS == OS.macOS) {
    ArgumentError.checkNotNull(macOSTargetVersion, 'macOSTargetVersion');
  }
  if (targetOS == OS.iOS) {
    ArgumentError.checkNotNull(iOSTargetVersion, 'iOSTargetVersion');
    ArgumentError.checkNotNull(iOSTargetSdk, 'iOSTargetSdk');
  }

  const name = 'mylibname';

  for (final architecture in architectures) {
    test('link two objects for $architecture', () async {
      final tempUri = await tempDirForTest();
      final tempUri2 = await tempDirForTest();

      final uri = await buildTestArchive(
        tempUri,
        tempUri2,
        targetOS,
        architecture,
        androidTargetNdkApi: androidTargetNdkApi,
        macOSTargetVersion: macOSTargetVersion,
        iOSTargetVersion: iOSTargetVersion,
        iOSTargetSdk: iOSTargetSdk,
      );

      final linkInputBuilder = LinkInputBuilder()
        ..setupShared(
          packageName: 'testpackage',
          packageRoot: tempUri,
          outputFile: tempUri.resolve('output.json'),
          outputDirectoryShared: tempUri2,
        )
        ..setupLink(assets: [], recordedUsesFile: null, assetsFromLinking: [])
        ..addExtension(
          CodeAssetExtension(
            targetOS: targetOS,
            targetArchitecture: architecture,
            linkModePreference: LinkModePreference.dynamic,
            cCompiler: cCompiler,
            android: androidTargetNdkApi != null
                ? AndroidCodeConfig(targetNdkApi: androidTargetNdkApi)
                : null,
            macOS: macOSTargetVersion != null
                ? MacOSCodeConfig(targetVersion: macOSTargetVersion)
                : null,
            iOS: iOSTargetVersion != null && iOSTargetSdk != null
                ? IOSCodeConfig(
                    targetSdk: iOSTargetSdk,
                    targetVersion: iOSTargetVersion,
                  )
                : null,
          ),
        );

      final linkInput = linkInputBuilder.build();
      final linkOutput = LinkOutputBuilder();

      printOnFailure(linkInput.config.code.cCompiler.toString());
      printOnFailure(Platform.environment.keys.toList().toString());
      await CLinker.library(
        name: name,
        assetName: '',
        linkerOptions: LinkerOptions.manual(gcSections: false),
        sources: [uri.toFilePath()],
      ).run(input: linkInput, output: linkOutput, logger: logger);

      final codeAssets = LinkOutput(linkOutput.json).assets.code;
      expect(codeAssets, hasLength(1));
      final asset = codeAssets.first;
      expect(asset, isA<CodeAsset>());
      final symbols = await readSymbols(asset, targetOS);
      expect(
        symbols,
        stringContainsInOrder(['my_func', 'my_other_func']),
        skip: symbols == null ? 'tool to extract symbols unavailable' : false,
      );
    });
  }
}