test/lock_file_test.dart

// Copyright (c) 2012, 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:pub/src/lock_file.dart';
import 'package:pub/src/package_name.dart';
import 'package:pub/src/source.dart';
import 'package:pub/src/source_registry.dart';
import 'package:pub/src/system_cache.dart';
import 'package:pub_semver/pub_semver.dart';
import 'package:test/test.dart';
import 'package:yaml/yaml.dart';

class FakeSource extends Source {
  @override
  final String name = 'fake';

  @override
  BoundSource bind(SystemCache cache) =>
      throw UnsupportedError('Cannot download fake packages.');

  @override
  PackageRef parseRef(String name, description, {String containingPath}) {
    if (!description.endsWith(' desc')) throw FormatException('Bad');
    return PackageRef(name, this, description);
  }

  @override
  PackageId parseId(String name, Version version, description,
      {String containingPath}) {
    if (!description.endsWith(' desc')) throw FormatException('Bad');
    return PackageId(name, this, version, description);
  }

  @override
  bool descriptionsEqual(description1, description2) =>
      description1 == description2;

  @override
  int hashDescription(description) => description.hashCode;

  String packageName(String description) {
    // Strip off ' desc'.
    return description.substring(0, description.length - 5);
  }
}

void main() {
  var sources = SourceRegistry();
  var fakeSource = FakeSource();
  sources.register(fakeSource);

  group('LockFile', () {
    group('parse()', () {
      test('returns an empty lockfile if the contents are empty', () {
        var lockFile = LockFile.parse('', sources);
        expect(lockFile.packages.length, equals(0));
      });

      test('returns an empty lockfile if the contents are whitespace', () {
        var lockFile = LockFile.parse('  \t\n  ', sources);
        expect(lockFile.packages.length, equals(0));
      });

      test('parses a series of package descriptions', () {
        var lockFile = LockFile.parse('''
packages:
  bar:
    version: 1.2.3
    source: fake
    description: bar desc
  foo:
    version: 2.3.4
    source: fake
    description: foo desc
''', sources);

        expect(lockFile.packages.length, equals(2));

        var bar = lockFile.packages['bar'];
        expect(bar.name, equals('bar'));
        expect(bar.version, equals(Version(1, 2, 3)));
        expect(bar.source, equals(fakeSource));
        expect(bar.description, equals('bar desc'));

        var foo = lockFile.packages['foo'];
        expect(foo.name, equals('foo'));
        expect(foo.version, equals(Version(2, 3, 4)));
        expect(foo.source, equals(fakeSource));
        expect(foo.description, equals('foo desc'));
      });

      test('allows an unknown source', () {
        var lockFile = LockFile.parse('''
packages:
  foo:
    source: bad
    version: 1.2.3
    description: foo desc
''', sources);
        var foo = lockFile.packages['foo'];
        expect(foo.source, equals(sources['bad']));
      });

      test('allows an empty dependency map', () {
        var lockFile = LockFile.parse('''
packages:
''', sources);
        expect(lockFile.packages, isEmpty);
      });

      test('allows an old-style SDK constraint', () {
        var lockFile = LockFile.parse('sdk: ">=1.2.3 <4.0.0"', sources);
        expect(lockFile.sdkConstraints,
            containsPair('dart', VersionConstraint.parse('>=1.2.3 <4.0.0')));
        expect(lockFile.sdkConstraints, isNot(contains('flutter')));
        expect(lockFile.sdkConstraints, isNot(contains('fuchsia')));
      });

      test('allows new-style SDK constraints', () {
        var lockFile = LockFile.parse('''
sdks:
  dart: ">=1.2.3 <4.0.0"
  flutter: ^0.1.2
  fuchsia: ^5.6.7
''', sources);
        expect(lockFile.sdkConstraints,
            containsPair('dart', VersionConstraint.parse('>=1.2.3 <4.0.0')));
        expect(lockFile.sdkConstraints,
            containsPair('flutter', VersionConstraint.parse('^0.1.2')));
        expect(lockFile.sdkConstraints,
            containsPair('fuchsia', VersionConstraint.parse('^5.6.7')));
      });

      test('throws if the top level is not a map', () {
        expect(() {
          LockFile.parse('''
not a map
''', sources);
        }, throwsFormatException);
      });

      test("throws if the contents of 'packages' is not a map", () {
        expect(() {
          LockFile.parse('''
packages: not a map
''', sources);
        }, throwsFormatException);
      });

      test('throws if the version is missing', () {
        expect(() {
          LockFile.parse('''
packages:
  foo:
    source: fake
    description: foo desc
''', sources);
        }, throwsFormatException);
      });

      test('throws if the version is invalid', () {
        expect(() {
          LockFile.parse('''
packages:
  foo:
    version: vorpal
    source: fake
    description: foo desc
''', sources);
        }, throwsFormatException);
      });

      test('throws if the source is missing', () {
        expect(() {
          LockFile.parse('''
packages:
  foo:
    version: 1.2.3
    description: foo desc
''', sources);
        }, throwsFormatException);
      });

      test('throws if the description is missing', () {
        expect(() {
          LockFile.parse('''
packages:
  foo:
    version: 1.2.3
    source: fake
''', sources);
        }, throwsFormatException);
      });

      test('throws if the description is invalid', () {
        expect(() {
          LockFile.parse('''
packages:
  foo:
    version: 1.2.3
    source: fake
    description: foo desc is bad
''', sources);
        }, throwsFormatException);
      });

      test("throws if the old-style SDK constraint isn't a string", () {
        expect(
            () => LockFile.parse('sdk: 1.0', sources), throwsFormatException);
      });

      test('throws if the old-style SDK constraint is invalid', () {
        expect(
            () => LockFile.parse('sdk: oops', sources), throwsFormatException);
      });

      test("throws if the sdks field isn't a map", () {
        expect(
            () => LockFile.parse('sdks: oops', sources), throwsFormatException);
      });

      test("throws if an sdk constraint isn't a string", () {
        expect(() => LockFile.parse('sdks: {dart: 1.0}', sources),
            throwsFormatException);
        expect(() {
          LockFile.parse('sdks: {dart: 1.0.0, flutter: 1.0}', sources);
        }, throwsFormatException);
      });

      test('throws if an sdk constraint is invalid', () {
        expect(() => LockFile.parse('sdks: {dart: oops}', sources),
            throwsFormatException);
        expect(() {
          LockFile.parse('sdks: {dart: 1.0.0, flutter: oops}', sources);
        }, throwsFormatException);
      });

      test('ignores extra stuff in file', () {
        LockFile.parse('''
extra:
  some: stuff
packages:
  foo:
    bonus: not used
    version: 1.2.3
    source: fake
    description: foo desc
''', sources);
      });
    });

    test('serialize() dumps the lockfile to YAML', () {
      var lockfile = LockFile([
        PackageId('foo', fakeSource, Version.parse('1.2.3'), 'foo desc'),
        PackageId('bar', fakeSource, Version.parse('3.2.1'), 'bar desc')
      ], devDependencies: {
        'bar'
      });

      expect(
          loadYaml(lockfile.serialize(null)),
          equals({
            'sdks': {'dart': 'any'},
            'packages': {
              'foo': {
                'version': '1.2.3',
                'source': 'fake',
                'description': 'foo desc',
                'dependency': 'transitive'
              },
              'bar': {
                'version': '3.2.1',
                'source': 'fake',
                'description': 'bar desc',
                'dependency': 'direct dev'
              }
            }
          }));
    });
  });
}