protocol_discovery_test.dart 8.69 KB
Newer Older
1

2 3 4 5 6 7
// Copyright 2016 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.

import 'dart:async';

8
import 'package:flutter_tools/src/device.dart';
9
import 'package:flutter_tools/src/protocol_discovery.dart';
10

11
import 'src/common.dart';
12
import 'src/context.dart';
13 14
import 'src/mocks.dart';

15
void main() {
16
  group('service_protocol discovery', () {
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
    MockDeviceLogReader logReader;
    ProtocolDiscovery discoverer;

    group('no port forwarding', () {
      /// Performs test set-up functionality that must be performed as part of
      /// the `test()` pass and not part of the `setUp()` pass.
      ///
      /// This exists to make sure we're not creating an error that tries to
      /// cross an error-zone boundary. Our use of `testUsingContext()` runs the
      /// test code inside an error zone, but the `setUp()` code is not run in
      /// any zone. This creates the potential for errors that try to cross
      /// error-zone boundaries, which are considered uncaught.
      ///
      /// This also exists for cases where our initialization requires access to
      /// a `Context` object, which is only set up inside the zone.
      ///
      /// Note that these issues do not pertain to real code and are a test-only
      /// concern, since in real code, the zone is set-up in `main()`.
      ///
      /// See also: [runZoned]
      void initialize() {
        logReader = new MockDeviceLogReader();
        discoverer = new ProtocolDiscovery.observatory(logReader);
      }

      tearDown(() {
        discoverer.cancel();
        logReader.dispose();
      });

      testUsingContext('returns non-null uri future', () async {
        initialize();
        expect(discoverer.uri, isNotNull);
      });

      testUsingContext('discovers uri if logs already produced output', () async {
        initialize();
        logReader.addLine('HELLO WORLD');
        logReader.addLine('Observatory listening on http://127.0.0.1:9999');
        final Uri uri = await discoverer.uri;
        expect(uri.port, 9999);
        expect('$uri', 'http://127.0.0.1:9999');
      });

      testUsingContext('discovers uri if logs not yet produced output', () async {
        initialize();
        final Future<Uri> uriFuture = discoverer.uri;
        logReader.addLine('Observatory listening on http://127.0.0.1:3333');
        final Uri uri = await uriFuture;
        expect(uri.port, 3333);
        expect('$uri', 'http://127.0.0.1:3333');
      });

70
      testUsingContext('discovers uri with Ascii Esc code', () async {
71
        initialize();
72
        logReader.addLine('Observatory listening on http://127.0.0.1:3333\x1b[');
73 74 75 76 77
        final Uri uri = await discoverer.uri;
        expect(uri.port, 3333);
        expect('$uri', 'http://127.0.0.1:3333');
      });

78 79 80 81 82 83 84 85 86 87 88 89 90 91
      testUsingContext('uri throws if logs produce bad line', () async {
        initialize();
        Timer.run(() {
          logReader.addLine('Observatory listening on http://127.0.0.1:apple');
        });
        expect(discoverer.uri, throwsA(isFormatException));
      });

      testUsingContext('uri waits for correct log line', () async {
        initialize();
        final Future<Uri> uriFuture = discoverer.uri;
        logReader.addLine('Observatory not listening...');
        final Uri timeoutUri = Uri.parse('http://timeout');
        final Uri actualUri = await uriFuture.timeout(
92 93 94
          const Duration(milliseconds: 100),
          onTimeout: () => timeoutUri,
        );
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
        expect(actualUri, timeoutUri);
      });

      testUsingContext('discovers uri if log line contains Android prefix', () async {
        initialize();
        logReader.addLine('I/flutter : Observatory listening on http://127.0.0.1:52584');
        final Uri uri = await discoverer.uri;
        expect(uri.port, 52584);
        expect('$uri', 'http://127.0.0.1:52584');
      });

      testUsingContext('discovers uri if log line contains auth key', () async {
        initialize();
        final Future<Uri> uriFuture = discoverer.uri;
        logReader.addLine('I/flutter : Observatory listening on http://127.0.0.1:54804/PTwjm8Ii8qg=/');
        final Uri uri = await uriFuture;
        expect(uri.port, 54804);
        expect('$uri', 'http://127.0.0.1:54804/PTwjm8Ii8qg=/');
      });

      testUsingContext('discovers uri if log line contains non-localhost', () async {
        initialize();
        final Future<Uri> uriFuture = discoverer.uri;
118
        logReader.addLine('I/flutter : Observatory listening on http://127.0.0.1:54804/PTwjm8Ii8qg=/');
119 120
        final Uri uri = await uriFuture;
        expect(uri.port, 54804);
121
        expect('$uri', 'http://127.0.0.1:54804/PTwjm8Ii8qg=/');
122
      });
123
    });
124

125 126 127 128
    group('port forwarding', () {
      testUsingContext('default port', () async {
        final MockDeviceLogReader logReader = new MockDeviceLogReader();
        final ProtocolDiscovery discoverer = new ProtocolDiscovery.observatory(
129 130 131
          logReader,
          portForwarder: new MockPortForwarder(99),
        );
132 133 134 135 136

        // Get next port future.
        final Future<Uri> nextUri = discoverer.uri;
        logReader.addLine('I/flutter : Observatory listening on http://127.0.0.1:54804/PTwjm8Ii8qg=/');
        final Uri uri = await nextUri;
137 138
        expect(uri.port, 99);
        expect('$uri', 'http://127.0.0.1:99/PTwjm8Ii8qg=/');
139

140
        await discoverer.cancel();
141 142 143 144 145 146
        logReader.dispose();
      });

      testUsingContext('specified port', () async {
        final MockDeviceLogReader logReader = new MockDeviceLogReader();
        final ProtocolDiscovery discoverer = new ProtocolDiscovery.observatory(
147 148 149 150
          logReader,
          portForwarder: new MockPortForwarder(99),
          hostPort: 1243,
        );
151 152 153 154 155 156 157 158

        // Get next port future.
        final Future<Uri> nextUri = discoverer.uri;
        logReader.addLine('I/flutter : Observatory listening on http://127.0.0.1:54804/PTwjm8Ii8qg=/');
        final Uri uri = await nextUri;
        expect(uri.port, 1243);
        expect('$uri', 'http://127.0.0.1:1243/PTwjm8Ii8qg=/');

159
        await discoverer.cancel();
160 161 162
        logReader.dispose();
      });

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
      testUsingContext('specified port zero', () async {
        final MockDeviceLogReader logReader = new MockDeviceLogReader();
        final ProtocolDiscovery discoverer = new ProtocolDiscovery.observatory(
          logReader,
          portForwarder: new MockPortForwarder(99),
          hostPort: 0,
        );

        // Get next port future.
        final Future<Uri> nextUri = discoverer.uri;
        logReader.addLine('I/flutter : Observatory listening on http://127.0.0.1:54804/PTwjm8Ii8qg=/');
        final Uri uri = await nextUri;
        expect(uri.port, 99);
        expect('$uri', 'http://127.0.0.1:99/PTwjm8Ii8qg=/');

178
        await discoverer.cancel();
179 180 181
        logReader.dispose();
      });

182 183 184
      testUsingContext('ipv6', () async {
        final MockDeviceLogReader logReader = new MockDeviceLogReader();
        final ProtocolDiscovery discoverer = new ProtocolDiscovery.observatory(
185 186 187 188 189
          logReader,
          portForwarder: new MockPortForwarder(99),
          hostPort: 54777,
          ipv6: true,
        );
190

191 192 193 194 195 196 197
        // Get next port future.
        final Future<Uri> nextUri = discoverer.uri;
        logReader.addLine('I/flutter : Observatory listening on http://127.0.0.1:54804/PTwjm8Ii8qg=/');
        final Uri uri = await nextUri;
        expect(uri.port, 54777);
        expect('$uri', 'http://[::1]:54777/PTwjm8Ii8qg=/');

198
        await discoverer.cancel();
199 200
        logReader.dispose();
      });
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217

      testUsingContext('ipv6 with Ascii Escape code', () async {
        final MockDeviceLogReader logReader = new MockDeviceLogReader();
        final ProtocolDiscovery discoverer = new ProtocolDiscovery.observatory(
          logReader,
          portForwarder: new MockPortForwarder(99),
          hostPort: 54777,
          ipv6: true,
        );

        // Get next port future.
        final Future<Uri> nextUri = discoverer.uri;
        logReader.addLine('I/flutter : Observatory listening on http://[::1]:54777/PTwjm8Ii8qg=/\x1b[');
        final Uri uri = await nextUri;
        expect(uri.port, 54777);
        expect('$uri', 'http://[::1]:54777/PTwjm8Ii8qg=/');

218
        await discoverer.cancel();
219 220
        logReader.dispose();
      });
221
    });
222 223
  });
}
224 225 226 227 228 229

class MockPortForwarder extends DevicePortForwarder {
  final int availablePort;
  MockPortForwarder([this.availablePort]);

  @override
230 231
  Future<int> forward(int devicePort, {int hostPort}) async {
    hostPort ??= 0;
232
    if (hostPort == 0) {
233
      return availablePort;
234
    }
235 236
    return hostPort;
  }
237 238 239 240 241 242 243 244 245

  @override
  List<ForwardedPort> get forwardedPorts => throw 'not implemented';

  @override
  Future<Null> unforward(ForwardedPort forwardedPort) {
    throw 'not implemented';
  }
}