channel_test.dart 9.12 KB
Newer Older
1 2 3 4
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'dart:async';
6
import 'dart:io' hide File;
7

8
import 'package:args/command_runner.dart';
9 10
import 'package:file/memory.dart';
import 'package:flutter_tools/src/base/file_system.dart';
11
import 'package:flutter_tools/src/cache.dart';
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
      expect(testLogger.statusText, contains('Flutter channels:'));
38 39 40 41 42 43 44 45
    }

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

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

    testUsingContext('removes duplicates', () async {
49 50 51
      final Process process = createMockProcess(
          stdout: 'origin/dev\n'
                  'origin/beta\n'
52
                  'origin/stable\n'
53
                  'upstream/dev\n'
54 55
                  'upstream/beta\n'
                  'upstream/stable\n');
56 57
      when(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
58
        workingDirectory: anyNamed('workingDirectory'),
59
        environment: anyNamed('environment'),
60
      )).thenAnswer((_) => Future<Process>.value(process));
61

62
      final ChannelCommand command = ChannelCommand();
63
      final CommandRunner<void> runner = createTestCommandRunner(command);
64 65
      await runner.run(<String>['channel']);

66 67 68 69 70
      verify(mockProcessManager.start(
        <String>['git', 'branch', '-r'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).called(1);
71 72 73 74 75 76 77 78 79 80

      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

81
      expect(rows, <String>['dev', 'beta', 'stable']);
82
    }, overrides: <Type, Generator>{
83 84 85 86 87 88 89 90
      ProcessManager: () => mockProcessManager,
    });

    testUsingContext('can switch channels', () async {
      when(mockProcessManager.start(
        <String>['git', 'fetch'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
91
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
92 93 94 95
      when(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
96
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
97 98 99 100
      when(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
101
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
102

103
      final ChannelCommand command = ChannelCommand();
104
      final CommandRunner<void> runner = createTestCommandRunner(command);
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
      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, contains("Switching to flutter channel 'beta'..."));
      expect(testLogger.errorText, hasLength(0));
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 158

      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);
159
    }, overrides: <Type, Generator>{
160
      FileSystem: () => MemoryFileSystem(),
161
      ProcessManager: () => mockProcessManager,
162 163 164 165 166 167 168 169 170
    });

    // 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'),
171
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
172 173 174 175
      when(mockProcessManager.start(
        <String>['git', 'show-ref', '--verify', '--quiet', 'refs/heads/beta'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
176
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
177 178 179 180
      when(mockProcessManager.start(
        <String>['git', 'checkout', 'beta', '--'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
181
      )).thenAnswer((_) => Future<Process>.value(createMockProcess()));
182 183

      final File versionCheckFile = Cache.instance.getStampFileFor(
184
        VersionCheckStamp.flutterVersionCheckStampFile,
185 186 187 188 189 190 191 192 193 194 195 196
      );

      /// 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"
        }
      ''');

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 217 218 219 220
      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>{
221
      FileSystem: () => MemoryFileSystem(),
222
      ProcessManager: () => mockProcessManager,
223
    });
224 225
  });
}
226 227 228

class MockProcessManager extends Mock implements ProcessManager {}

229
class MockProcess extends Mock implements Process {}