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

5 6 7
import 'dart:async';
import 'dart:convert';

8
import 'package:args/command_runner.dart';
9 10
import 'package:file/file.dart';
import 'package:file/memory.dart';
11 12 13 14
import 'package:flutter_tools/src/artifacts.dart';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/base/platform.dart';
import 'package:flutter_tools/src/base/terminal.dart';
15
import 'package:flutter_tools/src/cache.dart';
16
import 'package:flutter_tools/src/commands/analyze.dart';
17
import 'package:flutter_tools/src/commands/analyze_base.dart';
18
import 'package:flutter_tools/src/dart/analysis.dart';
19
import 'package:flutter_tools/src/project_validator.dart';
20

21
import '../../src/common.dart';
22 23
import '../../src/context.dart';
import '../../src/test_flutter_command_runner.dart';
24

25
const String _kFlutterRoot = '/data/flutter';
26
const int SIGABRT = -6;
27

28
void main() {
29 30 31 32 33 34
  testWithoutContext('analyze generate correct errors message', () async {
    expect(
      AnalyzeBase.generateErrorsMessage(
        issueCount: 0,
        seconds: '0.1',
      ),
35
      'No issues found! (ran in 0.1s)',
36 37 38 39 40 41 42 43 44
    );

    expect(
      AnalyzeBase.generateErrorsMessage(
        issueCount: 3,
        issueDiff: 2,
        files: 1,
        seconds: '0.1',
      ),
45
      '3 issues found. (2 new) • analyzed 1 file (ran in 0.1s)',
46 47 48
    );
  });

49
  group('analyze command', () {
50 51 52 53 54 55 56
    late FileSystem fileSystem;
    late Platform platform;
    late BufferLogger logger;
    late FakeProcessManager processManager;
    late Terminal terminal;
    late AnalyzeCommand command;
    late CommandRunner<void> runner;
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74

    setUpAll(() {
      Cache.disableLocking();
    });

    setUp(() {
      fileSystem = MemoryFileSystem.test();
      platform = FakePlatform();
      logger = BufferLogger.test();
      processManager = FakeProcessManager.empty();
      terminal = Terminal.test();
      command = AnalyzeCommand(
        artifacts: Artifacts.test(),
        fileSystem: fileSystem,
        logger: logger,
        platform: platform,
        processManager: processManager,
        terminal: terminal,
75
        allProjectValidators: <ProjectValidator>[],
76
        suppressAnalytics: true,
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
      );
      runner = createTestCommandRunner(command);

      // Setup repo roots
      const String homePath = '/home/user/flutter';
      Cache.flutterRoot = homePath;
      for (final String dir in <String>['dev', 'examples', 'packages']) {
        fileSystem.directory(homePath).childDirectory(dir).createSync(recursive: true);
      }
    });

    testUsingContext('SIGABRT throws Exception', () async {
      const String stderr = 'Something bad happened!';
      processManager.addCommands(
        <FakeCommand>[
          const FakeCommand(
            // artifact paths are from Artifacts.test() and stable
            command: <String>[
95
              'Artifact.engineDartSdkPath/bin/dart',
96
              '--disable-dart-dev',
97
              'Artifact.engineDartSdkPath/bin/snapshots/analysis_server.dart.snapshot',
98 99 100
              '--disable-server-feature-completion',
              '--disable-server-feature-search',
              '--sdk',
101
              'Artifact.engineDartSdkPath',
102
              '--suppress-analytics',
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
            ],
            exitCode: SIGABRT,
            stderr: stderr,
          ),
        ],
      );
      await expectLater(
        runner.run(<String>['analyze']),
        throwsA(
          isA<Exception>().having(
            (Exception e) => e.toString(),
            'description',
            contains('analysis server exited with code $SIGABRT and output:\n[stderr] $stderr'),
          ),
        ),
      );
    },
    overrides: <Type, Generator>{
      FileSystem: () => fileSystem,
      ProcessManager: () => processManager,
    });
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157

    testUsingContext('--flutter-repo analyzes everything in the flutterRoot', () async {
      final StreamController<List<int>> streamController = StreamController<List<int>>();
      final IOSink sink = IOSink(streamController.sink);
      processManager.addCommands(
        <FakeCommand>[
          FakeCommand(
            // artifact paths are from Artifacts.test() and stable
            command: const <String>[
              'Artifact.engineDartSdkPath/bin/dart',
              '--disable-dart-dev',
              'Artifact.engineDartSdkPath/bin/snapshots/analysis_server.dart.snapshot',
              '--disable-server-feature-completion',
              '--disable-server-feature-search',
              '--sdk',
              'Artifact.engineDartSdkPath',
              '--suppress-analytics',
            ],
            stdin: sink,
            stdout: '{"event":"server.status","params":{"analysis":{"isAnalyzing":false}}}',
          ),
        ],
      );
      await runner.run(<String>['analyze', '--flutter-repo']);
      final Map<String, Object?> setAnalysisRootsCommand = jsonDecode(await streamController.stream.transform(utf8.decoder).elementAt(2)) as Map<String, Object?>;
      expect(setAnalysisRootsCommand['method'], 'analysis.setAnalysisRoots');
      final Map<String, Object?> params = setAnalysisRootsCommand['params']! as Map<String, Object?>;
      expect(params['included'], <String?>[Cache.flutterRoot]);
      expect(params['excluded'], isEmpty);
    },
    overrides: <Type, Generator>{
      FileSystem: () => fileSystem,
      ProcessManager: () => processManager,
    });
158 159
  });

160 161 162 163 164
  testWithoutContext('analyze inRepo', () {
    final FileSystem fileSystem = MemoryFileSystem.test();
    fileSystem.directory(_kFlutterRoot).createSync(recursive: true);
    final Directory tempDir = fileSystem.systemTempDirectory
      .createTempSync('flutter_analysis_test.');
165
    Cache.flutterRoot = _kFlutterRoot;
166

167 168 169
    // Absolute paths
    expect(inRepo(<String>[tempDir.path], fileSystem), isFalse);
    expect(inRepo(<String>[fileSystem.path.join(tempDir.path, 'foo')], fileSystem), isFalse);
170 171
    expect(inRepo(<String>[Cache.flutterRoot!], fileSystem), isTrue);
    expect(inRepo(<String>[fileSystem.path.join(Cache.flutterRoot!, 'foo')], fileSystem), isTrue);
172 173 174 175 176 177 178 179 180 181 182 183

    // Relative paths
    fileSystem.currentDirectory = Cache.flutterRoot;
    expect(inRepo(<String>['.'], fileSystem), isTrue);
    expect(inRepo(<String>['foo'], fileSystem), isTrue);
    fileSystem.currentDirectory = tempDir.path;
    expect(inRepo(<String>['.'], fileSystem), isFalse);
    expect(inRepo(<String>['foo'], fileSystem), isFalse);

    // Ensure no exceptions
    inRepo(null, fileSystem);
    inRepo(<String>[], fileSystem);
184
  });
185 186 187 188 189 190 191 192 193 194

  testWithoutContext('AnalysisError from json write correct', () {
    final Map<String, dynamic> json = <String, dynamic>{
      'severity': 'INFO',
      'type': 'TODO',
      'location': <String, dynamic>{
        'file': '/Users/.../lib/test.dart',
        'offset': 362,
        'length': 72,
        'startLine': 15,
195
        'startColumn': 4,
196 197
      },
      'message': 'Prefer final for variable declarations if they are not reassigned.',
198
      'code': 'var foo = 123;',
199
      'hasFix': false,
200 201 202 203
    };
    expect(WrittenError.fromJson(json).toString(),
        '[info] Prefer final for variable declarations if they are not reassigned (/Users/.../lib/test.dart:15:4)');
  });
204
}
205

206
bool inRepo(List<String>? fileList, FileSystem fileSystem) {
207 208 209
  if (fileList == null || fileList.isEmpty) {
    fileList = <String>[fileSystem.path.current];
  }
210
  final String root = fileSystem.path.normalize(fileSystem.path.absolute(Cache.flutterRoot!));
211 212 213 214 215 216 217 218
  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;
219
}