channel_test.dart 15 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
import 'dart:io' hide File;
6

7
import 'package:args/command_runner.dart';
8 9
import 'package:file/memory.dart';
import 'package:flutter_tools/src/base/file_system.dart';
10
import 'package:flutter_tools/src/cache.dart';
11
import 'package:flutter_tools/src/globals.dart' as globals;
12
import 'package:flutter_tools/src/commands/channel.dart';
13
import 'package:flutter_tools/src/version.dart';
14 15
import 'package:mockito/mockito.dart';
import 'package:process/process.dart';
16

17 18
import '../src/common.dart';
import '../src/context.dart';
19
import '../src/mocks.dart';
20

21 22
void main() {
  group('channel', () {
23
    final MockProcessManager mockProcessManager = MockProcessManager();
24

25 26 27 28
    setUpAll(() {
      Cache.disableLocking();
    });

29
    Future<void> simpleChannelTest(List<String> args) async {
30
      final ChannelCommand command = ChannelCommand();
31
      final CommandRunner<void> runner = createTestCommandRunner(command);
32
      await runner.run(args);
33
      expect(testLogger.errorText, hasLength(0));
34 35 36
      // The bots may return an empty list of channels (network hiccup?)
      // and when run locally the list of branches might be different
      // so we check for the header text rather than any specific channel name.
37 38 39 40
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace('Flutter channels:'),
      );
41 42 43 44 45 46 47 48
    }

    testUsingContext('list', () async {
      await simpleChannelTest(<String>['channel']);
    });

    testUsingContext('verbose list', () async {
      await simpleChannelTest(<String>['channel', '-v']);
49
    });
50

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
    testUsingContext('sorted by stability', () async {
      final Process processAll = createMockProcess(
          stdout: 'origin/beta\n'
                  'origin/master\n'
                  'origin/dev\n'
                  'origin/stable\n');
      final Process processWithExtra = createMockProcess(
          stdout: 'origin/beta\n'
                  'origin/master\n'
                  'origin/dependabot/bundler\n'
                  'origin/dev\n'
                  'origin/v1.4.5-hotfixes\n'
                  'origin/stable\n');
      final Process processWithMissing = createMockProcess(
          stdout: 'origin/beta\n'
                  'origin/dependabot/bundler\n'
                  'origin/v1.4.5-hotfixes\n'
                  'origin/stable\n');

      final ChannelCommand command = ChannelCommand();
      final CommandRunner<void> runner = createTestCommandRunner(command);

      when(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(processAll));
      await runner.run(<String>['channel']);
      verify(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      expect(testLogger.errorText, hasLength(0));
      // format the status text for a simpler assertion.
      final Iterable<String> rows = testLogger.statusText
        .split('\n')
        .map((String line) => line.substring(2)); // remove '* ' or '  ' from output
89
      expect(rows, containsAllInOrder(kOfficialChannels));
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

      // clear buffer for next process
      testLogger.clear();

      when(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(processWithExtra));
      await runner.run(<String>['channel']);
      verify(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      expect(testLogger.errorText, hasLength(0));
      // format the status text for a simpler assertion.
      final Iterable<String> rows2 = testLogger.statusText
        .split('\n')
        .map((String line) => line.substring(2)); // remove '* ' or '  ' from output
110
      expect(rows2, containsAllInOrder(kOfficialChannels));
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129

      // clear buffer for next process
      testLogger.clear();

      when(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(processWithMissing));
      await runner.run(<String>['channel']);
      verify(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      expect(testLogger.errorText, hasLength(0));
      // check if available official channels are in order of stability
      int prev = -1;
      int next = -1;
130
      for (final String branch in kOfficialChannels) {
131 132 133 134 135 136 137 138 139 140 141
        next = testLogger.statusText.indexOf(branch);
        if (next != -1) {
          expect(prev < next, isTrue);
          prev = next;
        }
      }

    }, overrides: <Type, Generator>{
      ProcessManager: () => mockProcessManager,
    });

142
    testUsingContext('removes duplicates', () async {
143 144 145
      final Process process = createMockProcess(
          stdout: 'origin/dev\n'
                  'origin/beta\n'
146
                  'origin/stable\n'
147
                  'upstream/dev\n'
148 149
                  'upstream/beta\n'
                  'upstream/stable\n');
150 151
      when(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
152
        workingDirectory: anyNamed('workingDirectory'),
153
        environment: anyNamed('environment'),
154
      )).thenAnswer((_) => Future<Process>.value(process));
155

156
      final ChannelCommand command = ChannelCommand();
157
      final CommandRunner<void> runner = createTestCommandRunner(command);
158 159
      await runner.run(<String>['channel']);

160 161 162 163 164
      verify(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
165 166 167 168 169 170 171 172 173 174

      expect(testLogger.errorText, hasLength(0));

      // format the status text for a simpler assertion.
      final Iterable<String> rows = testLogger.statusText
        .split('\n')
        .map((String line) => line.trim())
        .where((String line) => line?.isNotEmpty == true)
        .skip(1); // remove `Flutter channels:` line

175
      expect(rows, <String>['dev', 'beta', 'stable']);
176
    }, overrides: <Type, Generator>{
177 178 179 180 181 182 183 184
      ProcessManager: () => mockProcessManager,
    });

    testUsingContext('can switch channels', () async {
      when(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
185
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
186 187 188 189
      when(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
190
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
191 192 193 194
      when(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
195
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
196

197
      final ChannelCommand command = ChannelCommand();
198
      final CommandRunner<void> runner = createTestCommandRunner(command);
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
      await runner.run(<String>['channel', 'beta']);

      verify(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);

217 218 219 220
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace("Switching to flutter channel 'beta'..."),
      );
221
      expect(testLogger.errorText, hasLength(0));
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255

      when(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
      when(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/stable'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
      when(mockProcessManager.start(
        <String>['git', 'checkout', 'stable', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));

      await runner.run(<String>['channel', 'stable']);

      verify(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/stable'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'checkout', 'stable', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
256
    }, overrides: <Type, Generator>{
257
      FileSystem: () => MemoryFileSystem.test(),
258
      ProcessManager: () => mockProcessManager,
259 260
    });

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    testUsingContext('switching channels prompts to run flutter upgrade', () async {
      when(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
      when(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
      when(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));

      final ChannelCommand command = ChannelCommand();
      final CommandRunner<void> runner = createTestCommandRunner(command);
      await runner.run(<String>['channel', 'beta']);

      verify(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);

298 299 300 301 302 303
      expect(
        testLogger.statusText,
        containsIgnoringWhitespace("Successfully switched to flutter channel 'beta'."),
      );
      expect(
        testLogger.statusText,
kwkr's avatar
kwkr committed
304 305
        containsIgnoringWhitespace(
          "To ensure that you're on the latest build "
306 307
          "from this channel, run 'flutter upgrade'"),
      );
308 309
      expect(testLogger.errorText, hasLength(0));
    }, overrides: <Type, Generator>{
310
      FileSystem: () => MemoryFileSystem.test(),
311 312 313
      ProcessManager: () => mockProcessManager,
    });

314 315 316 317 318 319 320
    // This verifies that bug https://github.com/flutter/flutter/issues/21134
    // doesn't return.
    testUsingContext('removes version stamp file when switching channels', () async {
      when(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
321
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
322 323 324 325
      when(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
326
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
327 328 329 330
      when(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
331
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
332

333
      final File versionCheckFile = globals.cache.getStampFileFor(
334
        VersionCheckStamp.flutterVersionCheckStampFile,
335 336 337 338 339 340 341 342 343 344 345 346
      );

      /// Create a bogus "leftover" version check file to make sure it gets
      /// removed when the channel changes. The content doesn't matter.
      versionCheckFile.createSync(recursive: true);
      versionCheckFile.writeAsStringSync('''
        {
          "lastTimeVersionWasChecked": "2151-08-29 10:17:30.763802",
          "lastKnownRemoteVersion": "2151-09-26 15:56:19.000Z"
        }
      ''');

347
      final ChannelCommand command = ChannelCommand();
348
      final CommandRunner<void> runner = createTestCommandRunner(command);
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
      await runner.run(<String>['channel', 'beta']);

      verify(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
      verify(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);

      expect(testLogger.statusText, isNot(contains('A new version of Flutter')));
      expect(testLogger.errorText, hasLength(0));
      expect(versionCheckFile.existsSync(), isFalse);
    }, overrides: <Type, Generator>{
371
      FileSystem: () => MemoryFileSystem.test(),
372
      ProcessManager: () => mockProcessManager,
373
    });
374 375
  });
}
376 377 378

class MockProcessManager extends Mock implements ProcessManager {}

379
class MockProcess extends Mock implements Process {}