fingerprint_test.dart 7.33 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7 8
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:convert' show json;

import 'package:file/memory.dart';
import 'package:flutter_tools/src/base/fingerprint.dart';
9
import 'package:flutter_tools/src/base/logger.dart';
10
import 'package:flutter_tools/src/base/utils.dart';
11

12
import '../../src/common.dart';
13

14 15
void main() {
  group('Fingerprinter', () {
16
    late MemoryFileSystem fileSystem;
17 18

    setUp(() {
19
      fileSystem = MemoryFileSystem.test();
20 21
    });

22
    testWithoutContext('creates fingerprint with specified properties and files', () {
23
      fileSystem.file('a.dart').createSync();
24

25
      final Fingerprinter fingerprinter = Fingerprinter(
26 27
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart'],
28 29
        fileSystem: fileSystem,
        logger: BufferLogger.test(),
30
      );
31
      final Fingerprint fingerprint = fingerprinter.buildFingerprint();
32 33
      expect(fingerprint, Fingerprint.fromBuildInputs(const <String>['a.dart'], fileSystem));
    });
34

35
    testWithoutContext('creates fingerprint with file checksums', () {
36
      fileSystem.file('a.dart').createSync();
37

38
      final Fingerprinter fingerprinter = Fingerprinter(
39
        fingerprintPath: 'out.fingerprint',
40
        paths: <String>['a.dart'],
41 42
        fileSystem: fileSystem,
        logger: BufferLogger.test(),
43
      );
44
      final Fingerprint fingerprint = fingerprinter.buildFingerprint();
45 46
      expect(fingerprint, Fingerprint.fromBuildInputs(const <String>['a.dart'], fileSystem));
    });
47

48
    testWithoutContext('fingerprint does not match if not present', () {
49 50
      fileSystem.file('a.dart').createSync();
      fileSystem.file('b.dart').createSync();
51

52
      final Fingerprinter fingerprinter = Fingerprinter(
53 54
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
55 56
        fileSystem: fileSystem,
        logger: BufferLogger.test(),
57
      );
58
      expect(fingerprinter.doesFingerprintMatch(), isFalse);
59 60
    });
    testWithoutContext('fingerprint does match if identical', () {
61 62
      fileSystem.file('a.dart').createSync();
      fileSystem.file('b.dart').createSync();
63

64
      final Fingerprinter fingerprinter = Fingerprinter(
65 66
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
67 68
        fileSystem: fileSystem,
        logger: BufferLogger.test(),
69
      );
70 71
      fingerprinter.writeFingerprint();
      expect(fingerprinter.doesFingerprintMatch(), isTrue);
72
    });
73

74
    testWithoutContext('fails to write fingerprint if inputs are missing', () {
75
      final Fingerprinter fingerprinter = Fingerprinter(
76 77
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart'],
78 79
        fileSystem: fileSystem,
        logger: BufferLogger.test(),
80
      );
81
      fingerprinter.writeFingerprint();
82
      expect(fileSystem.file('out.fingerprint').existsSync(), isFalse);
83 84
    });

85
  group('Fingerprint', () {
86
    group('fromBuildInputs', () {
87
      late MemoryFileSystem fileSystem;
88 89

      setUp(() {
90
        fileSystem = MemoryFileSystem.test();
91 92
      });

93
      testWithoutContext('throws if any input file does not exist', () {
94
        fileSystem.file('a.dart').createSync();
95
        expect(
96
          () => Fingerprint.fromBuildInputs(const <String>['a.dart', 'b.dart'], fileSystem),
97
          throwsException,
98
        );
99
      });
100

101
      testWithoutContext('populates checksums for valid files', () {
102 103
        fileSystem.file('a.dart').writeAsStringSync('This is a');
        fileSystem.file('b.dart').writeAsStringSync('This is b');
104
        final Fingerprint fingerprint = Fingerprint.fromBuildInputs(const <String>['a.dart', 'b.dart'], fileSystem);
105

106 107
        final Map<String, dynamic>? jsonObject = castStringKeyedMap(json.decode(fingerprint.toJson()));
        expect(jsonObject!['files'], hasLength(2));
108 109
        expect(jsonObject['files']['a.dart'], '8a21a15fad560b799f6731d436c1b698');
        expect(jsonObject['files']['b.dart'], '6f144e08b58cd0925328610fad7ac07c');
110
      });
111 112 113
    });

    group('fromJson', () {
114
      testWithoutContext('throws if JSON is invalid', () {
115
        expect(() => Fingerprint.fromJson('<xml></xml>'), throwsA(anything));
116 117
      });

118
      testWithoutContext('creates fingerprint from valid JSON', () {
119 120 121 122 123 124
        final String jsonString = json.encode(<String, dynamic>{
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        });
125
        final Fingerprint fingerprint = Fingerprint.fromJson(jsonString);
126
        final Map<String, dynamic>? content = castStringKeyedMap(json.decode(fingerprint.toJson()));
127
        expect(content, hasLength(1));
128
        expect(content!['files'], hasLength(2));
129 130 131
        expect(content['files']['a.dart'], '8a21a15fad560b799f6731d436c1b698');
        expect(content['files']['b.dart'], '6f144e08b58cd0925328610fad7ac07c');
      });
132 133 134
      testWithoutContext('treats missing properties and files entries as if empty', () {
        final String jsonString = json.encode(<String, dynamic>{});
        expect(Fingerprint.fromJson(jsonString), Fingerprint.fromBuildInputs(const <String>[], fileSystem));
135 136 137 138
      });
    });

    group('operator ==', () {
139
      testWithoutContext('reports not equal if file checksums do not match', () {
140 141 142 143 144 145
        final Map<String, dynamic> a = <String, dynamic>{
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        };
146
        final Map<String, dynamic> b = Map<String, dynamic>.of(a);
147 148 149 150
        b['files'] = <String, dynamic>{
          'a.dart': '8a21a15fad560b799f6731d436c1b698',
          'b.dart': '6f144e08b58cd0925328610fad7ac07d',
        };
151
        expect(Fingerprint.fromJson(json.encode(a)) == Fingerprint.fromJson(json.encode(b)), isFalse);
152 153
      });

154
      testWithoutContext('reports not equal if file paths do not match', () {
155 156 157 158 159 160
        final Map<String, dynamic> a = <String, dynamic>{
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        };
161
        final Map<String, dynamic> b = Map<String, dynamic>.of(a);
162 163 164 165
        b['files'] = <String, dynamic>{
          'a.dart': '8a21a15fad560b799f6731d436c1b698',
          'c.dart': '6f144e08b58cd0925328610fad7ac07d',
        };
166
        expect(Fingerprint.fromJson(json.encode(a)) == Fingerprint.fromJson(json.encode(b)), isFalse);
167 168
      });

169
      testWithoutContext('reports equal if properties and file checksums match', () {
170 171 172 173 174 175
        final Map<String, dynamic> a = <String, dynamic>{
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        };
176
        expect(Fingerprint.fromJson(json.encode(a)) == Fingerprint.fromJson(json.encode(a)), isTrue);
177 178 179
      });
    });
    group('hashCode', () {
180 181 182
      testWithoutContext('is consistent with equals, even if map entries are reordered', () {
        final Fingerprint a = Fingerprint.fromJson('{"properties":{"a":"A","b":"B"},"files":{}}');
        final Fingerprint b = Fingerprint.fromJson('{"properties":{"b":"B","a":"A"},"files":{}}');
183 184 185 186 187
        expect(a, b);
        expect(a.hashCode, b.hashCode);
      });
    });
  });
188
});
189
}