test/get/path/relative_path_test.dart

// Copyright (c) 2013, 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.

@TestOn('vm')
library;

import 'dart:io';

import 'package:pub/src/lock_file.dart';
import 'package:pub/src/path.dart';
import 'package:pub/src/source/path.dart';
import 'package:pub/src/system_cache.dart';
import 'package:test/test.dart';
import 'package:yaml/yaml.dart';

import '../../descriptor.dart' as d;
import '../../test_pub.dart';

void main() {
  test('can use relative path', () async {
    await d.dir('foo', [
      d.libDir('foo'),
      d.libPubspec('foo', '0.0.1'),
    ]).create();

    await d.dir(appPath, [
      d.appPubspec(
        dependencies: {
          'foo': {'path': '../foo'},
        },
      ),
    ]).create();

    await pubGet();

    await d.appPackageConfigFile([
      d.packageConfigEntry(name: 'foo', path: '../foo'),
    ]).validate();
  });

  test('path is relative to containing pubspec', () async {
    await d.dir('relative', [
      d.dir('foo', [
        d.libDir('foo'),
        d.libPubspec(
          'foo',
          '0.0.1',
          deps: {
            'bar': {'path': '../bar'},
          },
        ),
      ]),
      d.dir('bar', [d.libDir('bar'), d.libPubspec('bar', '0.0.1')]),
    ]).create();

    await d.dir(appPath, [
      d.appPubspec(
        dependencies: {
          'foo': {'path': '../relative/foo'},
        },
      ),
    ]).create();

    await pubGet();

    await d.appPackageConfigFile([
      d.packageConfigEntry(name: 'foo', path: '../relative/foo'),
      d.packageConfigEntry(name: 'bar', path: '../relative/bar'),
    ]).validate();
  });

  test(
    'path is relative to containing pubspec when using --directory',
    () async {
      await d.dir('relative', [
        d.dir('foo', [
          d.libDir('foo'),
          d.libPubspec(
            'foo',
            '0.0.1',
            deps: {
              'bar': {'path': '../bar'},
            },
          ),
        ]),
        d.dir('bar', [d.libDir('bar'), d.libPubspec('bar', '0.0.1')]),
      ]).create();

      await d.dir(appPath, [
        d.appPubspec(
          dependencies: {
            'foo': {'path': '../relative/foo'},
          },
        ),
      ]).create();

      await pubGet(
        args: ['--directory', appPath],
        workingDirectory: d.sandbox,
        output: contains('Changed 2 dependencies in `myapp`!'),
      );

      await d.appPackageConfigFile([
        d.packageConfigEntry(name: 'foo', path: '../relative/foo'),
        d.packageConfigEntry(name: 'bar', path: '../relative/bar'),
      ]).validate();
    },
  );

  test('relative path preserved in the lockfile', () async {
    await d.dir('foo', [
      d.libDir('foo'),
      d.libPubspec('foo', '0.0.1'),
    ]).create();

    await d.dir(appPath, [
      d.appPubspec(
        dependencies: {
          'foo': {'path': '../foo'},
        },
      ),
    ]).create();

    await pubGet();

    final lockfilePath = p.join(d.sandbox, appPath, 'pubspec.lock');
    final lockfileJson = loadYaml(File(lockfilePath).readAsStringSync());
    expect(
      dig<String>(lockfileJson, ['packages', 'foo', 'description', 'path']),
      '../foo',
      reason: 'Should use `/` as separator on all platforms',
    );
    final lockfile = LockFile.load(lockfilePath, SystemCache().sources);
    final description =
        lockfile.packages['foo']!.description.description as PathDescription;

    expect(description.relative, isTrue);
    expect(description.path, p.join(d.sandbox, 'foo'));
  });
}