// Copyright 2014 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. // @dart = 2.8 import 'package:file/file.dart'; import 'package:file/memory.dart'; import 'package:flutter_tools/src/cache.dart'; import 'package:flutter_tools/src/commands/analyze_base.dart'; import 'package:flutter_tools/src/dart/analysis.dart'; import '../../src/common.dart'; const String _kFlutterRoot = '/data/flutter'; void main() { testWithoutContext('analyze generate correct DartDoc message', () async { expect(AnalyzeBase.generateDartDocMessage(0), 'all public member have documentation'); expect(AnalyzeBase.generateDartDocMessage(1), 'one public member lacks documentation'); expect(AnalyzeBase.generateDartDocMessage(2), '2 public members lack documentation'); }); testWithoutContext('analyze generate correct errors message', () async { expect( AnalyzeBase.generateErrorsMessage( issueCount: 0, seconds: '0.1', undocumentedMembers: 1, dartDocMessage: 'one public member lacks documentation', ), 'No issues found! (ran in 0.1s; one public member lacks documentation)', ); expect( AnalyzeBase.generateErrorsMessage( issueCount: 3, issueDiff: 2, files: 1, seconds: '0.1', undocumentedMembers: 1, dartDocMessage: 'one public member lacks documentation', ), '3 issues found. (2 new) • analyzed 1 file (ran in 0.1s; one public member lacks documentation)', ); }); testWithoutContext('analyze inRepo', () { final FileSystem fileSystem = MemoryFileSystem.test(); fileSystem.directory(_kFlutterRoot).createSync(recursive: true); final Directory tempDir = fileSystem.systemTempDirectory .createTempSync('flutter_analysis_test.'); Cache.flutterRoot = _kFlutterRoot; // Absolute paths expect(inRepo([tempDir.path], fileSystem), isFalse); expect(inRepo([fileSystem.path.join(tempDir.path, 'foo')], fileSystem), isFalse); expect(inRepo([Cache.flutterRoot], fileSystem), isTrue); expect(inRepo([fileSystem.path.join(Cache.flutterRoot, 'foo')], fileSystem), isTrue); // Relative paths fileSystem.currentDirectory = Cache.flutterRoot; expect(inRepo(['.'], fileSystem), isTrue); expect(inRepo(['foo'], fileSystem), isTrue); fileSystem.currentDirectory = tempDir.path; expect(inRepo(['.'], fileSystem), isFalse); expect(inRepo(['foo'], fileSystem), isFalse); // Ensure no exceptions inRepo(null, fileSystem); inRepo([], fileSystem); }); testWithoutContext('AnalysisError from json write correct', () { final Map json = { 'severity': 'INFO', 'type': 'TODO', 'location': { 'file': '/Users/.../lib/test.dart', 'offset': 362, 'length': 72, 'startLine': 15, 'startColumn': 4, }, 'message': 'Prefer final for variable declarations if they are not reassigned.', 'hasFix': false, }; expect(WrittenError.fromJson(json).toString(), '[info] Prefer final for variable declarations if they are not reassigned (/Users/.../lib/test.dart:15:4)'); }); } bool inRepo(List fileList, FileSystem fileSystem) { if (fileList == null || fileList.isEmpty) { fileList = [fileSystem.path.current]; } final String root = fileSystem.path.normalize(fileSystem.path.absolute(Cache.flutterRoot)); final String prefix = root + fileSystem.path.separator; for (String file in fileList) { file = fileSystem.path.normalize(fileSystem.path.absolute(file)); if (file == root || file.startsWith(prefix)) { return true; } } return false; }