pkgs/ffigen/test/native_objc_test/nullable_test.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.

// Objective C support is only available on mac.
@TestOn('mac-os')
import 'dart:ffi';
import 'dart:io';

import 'package:objective_c/objective_c.dart';
import 'package:path/path.dart' as path;
import 'package:test/test.dart';

import '../test_utils.dart';
import 'nullable_bindings.dart';
import 'util.dart';

void main() {
  late NullableInterface nullableInterface;
  late NSObject obj;
  group('Nullability', () {
    setUpAll(() {
      // TODO(https://github.com/dart-lang/native/issues/1068): Remove this.
      DynamicLibrary.open(
        path.join(
          packagePathForTests,
          '..',
          'objective_c',
          'test',
          'objective_c.dylib',
        ),
      );
      final dylib = File(
        path.join(
          packagePathForTests,
          'test',
          'native_objc_test',
          'objc_test.dylib',
        ),
      );
      verifySetupFile(dylib);
      DynamicLibrary.open(dylib.absolute.path);
      nullableInterface = NullableInterface();
      obj = NSObject();
      generateBindingsForCoverage('nullable');
    });

    group('Nullable property', () {
      test('Not null', () {
        nullableInterface.nullableObjectProperty = obj;
        expect(nullableInterface.nullableObjectProperty, obj);
      });
      test('Null', () {
        nullableInterface.nullableObjectProperty = null;
        expect(nullableInterface.nullableObjectProperty, null);
      });
    });

    group('Nullable return', () {
      test('Not null', () {
        expect(NullableInterface.returnNil(false), isA<NSObject>());
      });
      test('Null', () {
        expect(NullableInterface.returnNil(true), null);
      });
    });

    group('Nullable arguments', () {
      test('Not null', () {
        expect(NullableInterface.isNullWithNullableNSObjectArg(obj), false);
      });
      test('Null', () {
        expect(NullableInterface.isNullWithNullableNSObjectArg(null), true);
      });
    });

    group('Not-nullable arguments', () {
      test('Not null', () {
        expect(
          NullableInterface.isNullWithNotNullableNSObjectPtrArg(obj),
          false,
        );
      });

      test('Explicit non null', () {
        expect(
          NullableInterface.isNullWithExplicitNonNullableNSObjectPtrArg(obj),
          false,
        );
      });
    });

    test('Nullable typealias', () {
      // Regression test for https://github.com/dart-lang/native/issues/1701
      expect(NullableInterface.returnNullableAlias(true), isNull);
      expect(
        NullableInterface.returnNullableAlias(false)?.toDartString(),
        "Hi",
      );
    });

    test('Multiple nullable args', () {
      final x = NSObject();
      final y = NSObject();
      final z = NSObject();

      expect(NullableInterface.multipleNullableArgs(x, y: y, z: z), x);
      expect(NullableInterface.multipleNullableArgs(null, y: y, z: z), y);
      expect(NullableInterface.multipleNullableArgs(null, y: null, z: z), z);
      expect(
        NullableInterface.multipleNullableArgs(null, y: null, z: null),
        null,
      );

      // Nullable named args are optional.
      expect(NullableInterface.multipleNullableArgs(null, z: z), z);
      expect(NullableInterface.multipleNullableArgs(null, y: y), y);
      expect(NullableInterface.multipleNullableArgs(null), null);
    });
  });
}