fingerprint_test.dart 18.4 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
// 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';
8
import 'package:platform/platform.dart';
9
import 'package:flutter_tools/src/base/utils.dart';
10 11 12 13
import 'package:flutter_tools/src/build_info.dart';
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/base/fingerprint.dart';
import 'package:flutter_tools/src/version.dart';
14
import 'package:flutter_tools/src/globals.dart' as globals;
15 16
import 'package:mockito/mockito.dart';

17 18
import '../../src/common.dart';
import '../../src/context.dart';
19 20 21 22 23 24 25 26 27

void main() {
  group('Fingerprinter', () {
    const String kVersion = '123456abcdef';

    MemoryFileSystem fs;
    MockFlutterVersion mockVersion;

    setUp(() {
28 29
      fs = MemoryFileSystem();
      mockVersion = MockFlutterVersion();
30 31 32 33 34
      when(mockVersion.frameworkRevision).thenReturn(kVersion);
    });

    final Map<Type, Generator> contextOverrides = <Type, Generator>{
      FileSystem: () => fs,
35
      ProcessManager: () => FakeProcessManager.any(),
36 37
    };

38
    testUsingContext('throws when depfile is malformed', () {
39 40 41
      globals.fs.file('a.dart').createSync();
      globals.fs.file('b.dart').createSync();
      globals.fs.file('depfile').createSync();
42

43
      final Fingerprinter fingerprinter = Fingerprinter(
44 45 46 47 48 49 50 51
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart'],
        depfilePaths: <String>['depfile'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );
52
      expect(() => fingerprinter.buildFingerprint(), throwsA(anything));
53 54
    }, overrides: contextOverrides);

55
    testUsingContext('creates fingerprint with specified properties and files', () {
56
      globals.fs.file('a.dart').createSync();
57

58
      final Fingerprinter fingerprinter = Fingerprinter(
59 60 61 62 63 64 65
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart'],
        properties: <String, String>{
          'foo': 'bar',
          'wibble': 'wobble',
        },
      );
66
      final Fingerprint fingerprint = fingerprinter.buildFingerprint();
67
      expect(fingerprint, Fingerprint.fromBuildInputs(<String, String>{
68 69 70 71 72
        'foo': 'bar',
        'wibble': 'wobble',
      }, <String>['a.dart']));
    }, overrides: contextOverrides);

73
    testUsingContext('creates fingerprint with file checksums', () {
74 75 76
      globals.fs.file('a.dart').createSync();
      globals.fs.file('b.dart').createSync();
      globals.fs.file('depfile').writeAsStringSync('depfile : b.dart');
77

78
      final Fingerprinter fingerprinter = Fingerprinter(
79
        fingerprintPath: 'out.fingerprint',
80 81
        paths: <String>['a.dart'],
        depfilePaths: <String>['depfile'],
82 83 84 85 86
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );
87
      final Fingerprint fingerprint = fingerprinter.buildFingerprint();
88
      expect(fingerprint, Fingerprint.fromBuildInputs(<String, String>{
89 90 91 92 93
        'bar': 'baz',
        'wobble': 'womble',
      }, <String>['a.dart', 'b.dart']));
    }, overrides: contextOverrides);

94
    testUsingContext('fingerprint does not match if not present', () {
95 96
      globals.fs.file('a.dart').createSync();
      globals.fs.file('b.dart').createSync();
97

98
      final Fingerprinter fingerprinter = Fingerprinter(
99 100 101 102 103 104 105
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );
106
      expect(fingerprinter.doesFingerprintMatch(), isFalse);
107 108
    }, overrides: contextOverrides);

109
    testUsingContext('fingerprint does match if different', () {
110 111
      globals.fs.file('a.dart').createSync();
      globals.fs.file('b.dart').createSync();
112

113
      final Fingerprinter fingerprinter1 = Fingerprinter(
114 115 116 117 118 119 120
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );
121
      fingerprinter1.writeFingerprint();
122

123
      final Fingerprinter fingerprinter2 = Fingerprinter(
124 125 126 127 128 129 130
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'elbmow',
        },
      );
131
      expect(fingerprinter2.doesFingerprintMatch(), isFalse);
132
    }, overrides: contextOverrides);
133

134
    testUsingContext('fingerprint does not match if depfile is malformed', () {
135 136 137
      globals.fs.file('a.dart').createSync();
      globals.fs.file('b.dart').createSync();
      globals.fs.file('depfile').writeAsStringSync('depfile : b.dart');
138 139

      // Write a valid fingerprint
140
      final Fingerprinter fingerprinter = Fingerprinter(
141 142 143 144 145 146 147 148
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
        depfilePaths: <String>['depfile'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );
149
      fingerprinter.writeFingerprint();
150 151

      // Write a corrupt depfile.
152
      globals.fs.file('depfile').writeAsStringSync('');
153
      final Fingerprinter badFingerprinter = Fingerprinter(
154 155 156 157 158 159 160 161 162
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
        depfilePaths: <String>['depfile'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );

163
      expect(badFingerprinter.doesFingerprintMatch(), isFalse);
164 165
    }, overrides: contextOverrides);

166
    testUsingContext('fingerprint does not match if previous fingerprint is malformed', () {
167 168 169
      globals.fs.file('a.dart').createSync();
      globals.fs.file('b.dart').createSync();
      globals.fs.file('out.fingerprint').writeAsStringSync('** not JSON **');
170

171
      final Fingerprinter fingerprinter = Fingerprinter(
172 173 174 175 176 177 178 179
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
        depfilePaths: <String>['depfile'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );
180
      expect(fingerprinter.doesFingerprintMatch(), isFalse);
181
    }, overrides: contextOverrides);
182

183
    testUsingContext('fingerprint does match if identical', () {
184 185
      globals.fs.file('a.dart').createSync();
      globals.fs.file('b.dart').createSync();
186

187
      final Fingerprinter fingerprinter = Fingerprinter(
188 189 190 191 192 193 194
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart', 'b.dart'],
        properties: <String, String>{
          'bar': 'baz',
          'wobble': 'womble',
        },
      );
195 196
      fingerprinter.writeFingerprint();
      expect(fingerprinter.doesFingerprintMatch(), isTrue);
197
    }, overrides: contextOverrides);
198

199
    testUsingContext('fails to write fingerprint if inputs are missing', () {
200
      final Fingerprinter fingerprinter = Fingerprinter(
201 202 203 204 205 206 207
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart'],
        properties: <String, String>{
          'foo': 'bar',
          'wibble': 'wobble',
        },
      );
208
      fingerprinter.writeFingerprint();
209
      expect(globals.fs.file('out.fingerprint').existsSync(), isFalse);
210 211
    }, overrides: contextOverrides);

212
    testUsingContext('applies path filter to inputs paths', () {
213 214 215
      globals.fs.file('a.dart').createSync();
      globals.fs.file('ab.dart').createSync();
      globals.fs.file('depfile').writeAsStringSync('depfile : ab.dart c.dart');
216

217
      final Fingerprinter fingerprinter = Fingerprinter(
218 219 220 221 222 223 224 225 226
        fingerprintPath: 'out.fingerprint',
        paths: <String>['a.dart'],
        depfilePaths: <String>['depfile'],
        properties: <String, String>{
          'foo': 'bar',
          'wibble': 'wobble',
        },
        pathFilter: (String path) => path.startsWith('a'),
      );
227
      fingerprinter.writeFingerprint();
228
      expect(globals.fs.file('out.fingerprint').existsSync(), isTrue);
229
    }, overrides: contextOverrides);
230 231 232 233 234 235 236
  });

  group('Fingerprint', () {
    MockFlutterVersion mockVersion;
    const String kVersion = '123456abcdef';

    setUp(() {
237
      mockVersion = MockFlutterVersion();
238 239 240 241 242 243 244
      when(mockVersion.frameworkRevision).thenReturn(kVersion);
    });

    group('fromBuildInputs', () {
      MemoryFileSystem fs;

      setUp(() {
245
        fs = MemoryFileSystem();
246 247
      });

248
      testUsingContext('throws if any input file does not exist', () {
249
        globals.fs.file('a.dart').createSync();
250
        expect(
251
          () => Fingerprint.fromBuildInputs(<String, String>{}, <String>['a.dart', 'b.dart']),
252
          throwsArgumentError,
253
        );
254 255
      }, overrides: <Type, Generator>{
        FileSystem: () => fs,
256
        ProcessManager: () => FakeProcessManager.any(),
257
      });
258

259
      testUsingContext('populates checksums for valid files', () {
260 261
        globals.fs.file('a.dart').writeAsStringSync('This is a');
        globals.fs.file('b.dart').writeAsStringSync('This is b');
262
        final Fingerprint fingerprint = Fingerprint.fromBuildInputs(<String, String>{}, <String>['a.dart', 'b.dart']);
263

264
        final Map<String, dynamic> jsonObject = castStringKeyedMap(json.decode(fingerprint.toJson()));
265 266 267
        expect(jsonObject['files'], hasLength(2));
        expect(jsonObject['files']['a.dart'], '8a21a15fad560b799f6731d436c1b698');
        expect(jsonObject['files']['b.dart'], '6f144e08b58cd0925328610fad7ac07c');
268 269
      }, overrides: <Type, Generator>{
        FileSystem: () => fs,
270
        ProcessManager: () => FakeProcessManager.any(),
271
      });
272 273

      testUsingContext('includes framework version', () {
274
        final Fingerprint fingerprint = Fingerprint.fromBuildInputs(<String, String>{}, <String>[]);
275

276
        final Map<String, dynamic> jsonObject = castStringKeyedMap(json.decode(fingerprint.toJson()));
277
        expect(jsonObject['version'], mockVersion.frameworkRevision);
278
      }, overrides: <Type, Generator>{FlutterVersion: () => mockVersion});
279 280

      testUsingContext('includes provided properties', () {
281
        final Fingerprint fingerprint = Fingerprint.fromBuildInputs(<String, String>{'a': 'A', 'b': 'B'}, <String>[]);
282

283
        final Map<String, dynamic> jsonObject = castStringKeyedMap(json.decode(fingerprint.toJson()));
284 285 286
        expect(jsonObject['properties'], hasLength(2));
        expect(jsonObject['properties']['a'], 'A');
        expect(jsonObject['properties']['b'], 'B');
287
      }, overrides: <Type, Generator>{FlutterVersion: () => mockVersion});
288 289 290
    });

    group('fromJson', () {
291
      testUsingContext('throws if JSON is invalid', () {
292
        expect(() => Fingerprint.fromJson('<xml></xml>'), throwsA(anything));
293 294 295 296
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

297
      testUsingContext('creates fingerprint from valid JSON', () {
298 299 300 301 302 303 304 305 306 307 308 309
        final String jsonString = json.encode(<String, dynamic>{
          'version': kVersion,
          'properties': <String, String>{
            'buildMode': BuildMode.release.toString(),
            'targetPlatform': TargetPlatform.ios.toString(),
            'entryPoint': 'a.dart',
          },
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        });
310
        final Fingerprint fingerprint = Fingerprint.fromJson(jsonString);
311
        final Map<String, dynamic> content = castStringKeyedMap(json.decode(fingerprint.toJson()));
312 313 314 315 316 317 318 319 320 321 322 323 324
        expect(content, hasLength(3));
        expect(content['version'], mockVersion.frameworkRevision);
        expect(content['properties'], hasLength(3));
        expect(content['properties']['buildMode'], BuildMode.release.toString());
        expect(content['properties']['targetPlatform'], TargetPlatform.ios.toString());
        expect(content['properties']['entryPoint'], 'a.dart');
        expect(content['files'], hasLength(2));
        expect(content['files']['a.dart'], '8a21a15fad560b799f6731d436c1b698');
        expect(content['files']['b.dart'], '6f144e08b58cd0925328610fad7ac07c');
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

325
      testUsingContext('throws ArgumentError for unknown versions', () {
326 327
        final String jsonString = json.encode(<String, dynamic>{
          'version': 'bad',
328 329
          'properties': <String, String>{},
          'files': <String, String>{},
330
        });
331
        expect(() => Fingerprint.fromJson(jsonString), throwsArgumentError);
332 333 334 335
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

336
      testUsingContext('throws ArgumentError if version is not present', () {
337
        final String jsonString = json.encode(<String, dynamic>{
338 339
          'properties': <String, String>{},
          'files': <String, String>{},
340
        });
341
        expect(() => Fingerprint.fromJson(jsonString), throwsArgumentError);
342 343 344 345
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

346
      testUsingContext('treats missing properties and files entries as if empty', () {
347 348 349
        final String jsonString = json.encode(<String, dynamic>{
          'version': kVersion,
        });
350
        expect(Fingerprint.fromJson(jsonString), Fingerprint.fromBuildInputs(<String, String>{}, <String>[]));
351 352 353 354 355 356
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });
    });

    group('operator ==', () {
357
      testUsingContext('reports not equal if properties do not match', () {
358 359 360 361 362 363 364
        final Map<String, dynamic> a = <String, dynamic>{
          'version': kVersion,
          'properties': <String, String>{
            'buildMode': BuildMode.debug.toString(),
          },
          'files': <String, dynamic>{},
        };
365
        final Map<String, dynamic> b = Map<String, dynamic>.from(a);
366 367 368
        b['properties'] = <String, String>{
          'buildMode': BuildMode.release.toString(),
        };
369
        expect(Fingerprint.fromJson(json.encode(a)) == Fingerprint.fromJson(json.encode(b)), isFalse);
370 371 372 373
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

374
      testUsingContext('reports not equal if file checksums do not match', () {
375 376 377 378 379 380 381 382
        final Map<String, dynamic> a = <String, dynamic>{
          'version': kVersion,
          'properties': <String, String>{},
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        };
383
        final Map<String, dynamic> b = Map<String, dynamic>.from(a);
384 385 386 387
        b['files'] = <String, dynamic>{
          'a.dart': '8a21a15fad560b799f6731d436c1b698',
          'b.dart': '6f144e08b58cd0925328610fad7ac07d',
        };
388
        expect(Fingerprint.fromJson(json.encode(a)) == Fingerprint.fromJson(json.encode(b)), isFalse);
389 390 391 392
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

393
      testUsingContext('reports not equal if file paths do not match', () {
394 395 396 397 398 399 400 401
        final Map<String, dynamic> a = <String, dynamic>{
          'version': kVersion,
          'properties': <String, String>{},
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        };
402
        final Map<String, dynamic> b = Map<String, dynamic>.from(a);
403 404 405 406
        b['files'] = <String, dynamic>{
          'a.dart': '8a21a15fad560b799f6731d436c1b698',
          'c.dart': '6f144e08b58cd0925328610fad7ac07d',
        };
407
        expect(Fingerprint.fromJson(json.encode(a)) == Fingerprint.fromJson(json.encode(b)), isFalse);
408 409 410 411
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

412
      testUsingContext('reports equal if properties and file checksums match', () {
413 414 415 416 417 418 419 420 421 422 423 424
        final Map<String, dynamic> a = <String, dynamic>{
          'version': kVersion,
          'properties': <String, String>{
            'buildMode': BuildMode.debug.toString(),
            'targetPlatform': TargetPlatform.ios.toString(),
            'entryPoint': 'a.dart',
          },
          'files': <String, dynamic>{
            'a.dart': '8a21a15fad560b799f6731d436c1b698',
            'b.dart': '6f144e08b58cd0925328610fad7ac07c',
          },
        };
425
        expect(Fingerprint.fromJson(json.encode(a)) == Fingerprint.fromJson(json.encode(a)), isTrue);
426 427 428 429 430
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });
    });
    group('hashCode', () {
431
      testUsingContext('is consistent with equals, even if map entries are reordered', () {
432 433
        final Fingerprint a = Fingerprint.fromJson('{"version":"$kVersion","properties":{"a":"A","b":"B"},"files":{}}');
        final Fingerprint b = Fingerprint.fromJson('{"version":"$kVersion","properties":{"b":"B","a":"A"},"files":{}}');
434 435 436 437 438 439 440 441 442 443 444 445 446
        expect(a, b);
        expect(a.hashCode, b.hashCode);
      }, overrides: <Type, Generator>{
        FlutterVersion: () => mockVersion,
      });

    });
  });

  group('readDepfile', () {
    MemoryFileSystem fs;

    setUp(() {
447
      fs = MemoryFileSystem();
448 449
    });

450 451
    final Map<Type, Generator> contextOverrides = <Type, Generator>{
      FileSystem: () => fs,
452
      ProcessManager: () => FakeProcessManager.any(),
453
    };
454

455
    testUsingContext('returns one file if only one is listed', () {
456
      globals.fs.file('a.d').writeAsStringSync('snapshot.d: /foo/a.dart');
457
      expect(readDepfile('a.d'), unorderedEquals(<String>['/foo/a.dart']));
458 459
    }, overrides: contextOverrides);

460
    testUsingContext('returns multiple files', () {
461
      globals.fs.file('a.d').writeAsStringSync('snapshot.d: /foo/a.dart /foo/b.dart');
462
      expect(readDepfile('a.d'), unorderedEquals(<String>[
463 464 465 466 467
        '/foo/a.dart',
        '/foo/b.dart',
      ]));
    }, overrides: contextOverrides);

468
    testUsingContext('trims extra spaces between files', () {
469
      globals.fs.file('a.d').writeAsStringSync('snapshot.d: /foo/a.dart    /foo/b.dart  /foo/c.dart');
470
      expect(readDepfile('a.d'), unorderedEquals(<String>[
471 472 473 474 475 476
        '/foo/a.dart',
        '/foo/b.dart',
        '/foo/c.dart',
      ]));
    }, overrides: contextOverrides);

477
    testUsingContext('returns files with spaces and backslashes', () {
478
      globals.fs.file('a.d').writeAsStringSync(r'snapshot.d: /foo/a\ a.dart /foo/b\\b.dart /foo/c\\ c.dart');
479
      expect(readDepfile('a.d'), unorderedEquals(<String>[
480 481 482 483 484 485 486
        r'/foo/a a.dart',
        r'/foo/b\b.dart',
        r'/foo/c\ c.dart',
      ]));
    }, overrides: contextOverrides);
  });
}
487 488 489 490 491

class MockPlatform extends Mock implements Platform {
  @override
  Map<String, String> environment = <String, String>{};
}