mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
9c7a9e779f
## How we determine the channel name Historically, we used the current branch's upstream to figure out the current channel name. I have no idea why. I traced it back to https://github.com/flutter/flutter/pull/446/files where @abarth implement this and I reviewed that PR and left no comment on it at the time. I think this is confusing. You can be on a branch and it tells you that your channel is different. That seems weird. This PR changes the logic to uses the current branch as the channel name. ## How we display channels The main reason this PR exists is to add channel descriptions to the `flutter channel` list: ``` ianh@burmese:~/dev/flutter/packages/flutter_tools$ flutter channel Flutter channels: master (tip of tree, for contributors) main (tip of tree, follows master channel) beta (updated monthly, recommended for experienced users) stable (updated quarterly, for new users and for production app releases) * foo_bar Currently not on an official channel. ianh@burmese:~/dev/flutter/packages/flutter_tools$ ``` ## Other changes I made a few other changes while I was at it: * If you're not on an official channel, we used to imply `--show-all`, but now we don't, we just show the official channels plus yours. This avoids flooding the screen in the case the user is on a weird channel and just wants to know what channel they're on. * I made the tool more consistent about how it handles unofficial branches. Now it's always `[user branch]`. * I slightly adjusted how unknown versions are rendered so it's clearer the version is unknown rather than just having the word "Unknown" floating in the output without context. * Simplified some of the code. * Made some of the tests more strict (checking all output rather than just some aspects of it). * Changed the MockFlutterVersion to implement the FlutterVersion API more strictly. * I made sure we escape the output to `.metadata` to avoid potential injection bugs (previously we just inlined the version and channel name verbatim with no escaping, which is super sketchy). * Tweaked the help text for the `downgrade` command to be clearer. * Removed some misleading text in some error messages. * Made the `.metadata` generator consistent with the template file. * Removed some obsolete code to do with the `dev` branch. ## Reviewer notes I'm worried that there are implications to some of these changes that I am not aware of, so please don't assume I know what I'm doing when reviewing this code. :-)
405 lines
14 KiB
Dart
405 lines
14 KiB
Dart
// 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.
|
|
|
|
import 'package:flutter_tools/src/base/config.dart';
|
|
import 'package:flutter_tools/src/base/platform.dart';
|
|
import 'package:flutter_tools/src/features.dart';
|
|
import 'package:flutter_tools/src/flutter_features.dart';
|
|
|
|
import '../src/common.dart';
|
|
import '../src/fakes.dart';
|
|
|
|
void main() {
|
|
group('Features', () {
|
|
late Config testConfig;
|
|
late FakePlatform platform;
|
|
late FlutterFeatureFlags featureFlags;
|
|
|
|
setUp(() {
|
|
testConfig = Config.test();
|
|
platform = FakePlatform(environment: <String, String>{});
|
|
|
|
for (final Feature feature in allConfigurableFeatures) {
|
|
testConfig.setValue(feature.configSetting!, false);
|
|
}
|
|
|
|
featureFlags = FlutterFeatureFlags(
|
|
flutterVersion: FakeFlutterVersion(),
|
|
config: testConfig,
|
|
platform: platform,
|
|
);
|
|
});
|
|
|
|
FeatureFlags createFlags(String channel) {
|
|
return FlutterFeatureFlags(
|
|
flutterVersion: FakeFlutterVersion(branch: channel),
|
|
config: testConfig,
|
|
platform: platform,
|
|
);
|
|
}
|
|
|
|
testWithoutContext('setting has safe defaults', () {
|
|
const FeatureChannelSetting featureSetting = FeatureChannelSetting();
|
|
|
|
expect(featureSetting.available, false);
|
|
expect(featureSetting.enabledByDefault, false);
|
|
});
|
|
|
|
testWithoutContext('has safe defaults', () {
|
|
const Feature feature = Feature(name: 'example');
|
|
|
|
expect(feature.name, 'example');
|
|
expect(feature.environmentOverride, null);
|
|
expect(feature.configSetting, null);
|
|
});
|
|
|
|
testWithoutContext('retrieves the correct setting for each branch', () {
|
|
const FeatureChannelSetting masterSetting = FeatureChannelSetting(available: true);
|
|
const FeatureChannelSetting betaSetting = FeatureChannelSetting(available: true);
|
|
const FeatureChannelSetting stableSetting = FeatureChannelSetting(available: true);
|
|
const Feature feature = Feature(
|
|
name: 'example',
|
|
master: masterSetting,
|
|
beta: betaSetting,
|
|
stable: stableSetting,
|
|
);
|
|
|
|
expect(feature.getSettingForChannel('master'), masterSetting);
|
|
expect(feature.getSettingForChannel('beta'), betaSetting);
|
|
expect(feature.getSettingForChannel('stable'), stableSetting);
|
|
expect(feature.getSettingForChannel('unknown'), masterSetting);
|
|
});
|
|
|
|
testWithoutContext('env variables are only enabled with "true" string', () {
|
|
platform.environment = <String, String>{'FLUTTER_WEB': 'hello'};
|
|
|
|
expect(featureFlags.isWebEnabled, false);
|
|
|
|
platform.environment = <String, String>{'FLUTTER_WEB': 'true'};
|
|
|
|
expect(featureFlags.isWebEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter web wasm only enable on master', () {
|
|
expect(flutterWebWasm.getSettingForChannel('master').enabledByDefault, isTrue);
|
|
expect(flutterWebWasm.getSettingForChannel('beta').enabledByDefault, isFalse);
|
|
expect(flutterWebWasm.getSettingForChannel('stable').enabledByDefault, isFalse);
|
|
});
|
|
|
|
testWithoutContext('Flutter web help string', () {
|
|
expect(flutterWebFeature.generateHelpMessage(),
|
|
'Enable or disable Flutter for web.');
|
|
});
|
|
|
|
testWithoutContext('Flutter macOS desktop help string', () {
|
|
expect(flutterMacOSDesktopFeature.generateHelpMessage(),
|
|
'Enable or disable support for desktop on macOS.');
|
|
});
|
|
|
|
testWithoutContext('Flutter Linux desktop help string', () {
|
|
expect(flutterLinuxDesktopFeature.generateHelpMessage(),
|
|
'Enable or disable support for desktop on Linux.');
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop help string', () {
|
|
expect(flutterWindowsDesktopFeature.generateHelpMessage(),
|
|
'Enable or disable support for desktop on Windows.');
|
|
});
|
|
|
|
testWithoutContext('help string on multiple channels', () {
|
|
const Feature testWithoutContextFeature = Feature(
|
|
name: 'example',
|
|
master: FeatureChannelSetting(available: true),
|
|
beta: FeatureChannelSetting(available: true),
|
|
stable: FeatureChannelSetting(available: true),
|
|
configSetting: 'foo',
|
|
);
|
|
|
|
expect(testWithoutContextFeature.generateHelpMessage(), 'Enable or disable example.');
|
|
});
|
|
|
|
/// Flutter Web
|
|
|
|
testWithoutContext('Flutter web off by default on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
|
|
expect(featureFlags.isWebEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter web enabled with config on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
testConfig.setValue('enable-web', true);
|
|
|
|
expect(featureFlags.isWebEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter web enabled with environment variable on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
platform.environment = <String, String>{'FLUTTER_WEB': 'true'};
|
|
|
|
expect(featureFlags.isWebEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter web off by default on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
|
|
expect(featureFlags.isWebEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter web enabled with config on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
testConfig.setValue('enable-web', true);
|
|
|
|
expect(featureFlags.isWebEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter web not enabled with environment variable on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
platform.environment = <String, String>{'FLUTTER_WEB': 'true'};
|
|
|
|
expect(featureFlags.isWebEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter web on by default on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
testConfig.removeValue('enable-web');
|
|
|
|
expect(featureFlags.isWebEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter web enabled with config on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
testConfig.setValue('enable-web', true);
|
|
|
|
expect(featureFlags.isWebEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter web not enabled with environment variable on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
platform.environment = <String, String>{'FLUTTER_WEB': 'enabled'};
|
|
|
|
expect(featureFlags.isWebEnabled, false);
|
|
});
|
|
|
|
/// Flutter macOS desktop.
|
|
|
|
testWithoutContext('Flutter macos desktop off by default on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
|
|
expect(featureFlags.isMacOSEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop enabled with config on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
testConfig.setValue('enable-macos-desktop', true);
|
|
|
|
expect(featureFlags.isMacOSEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop enabled with environment variable on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
platform.environment = <String, String>{'FLUTTER_MACOS': 'true'};
|
|
|
|
expect(featureFlags.isMacOSEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop off by default on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
|
|
expect(featureFlags.isMacOSEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop enabled with config on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
testConfig.setValue('enable-macos-desktop', true);
|
|
|
|
expect(featureFlags.isMacOSEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop enabled with environment variable on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
platform.environment = <String, String>{'FLUTTER_MACOS': 'true'};
|
|
|
|
expect(featureFlags.isMacOSEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop off by default on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
|
|
expect(featureFlags.isMacOSEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop enabled with config on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
testConfig.setValue('enable-macos-desktop', true);
|
|
|
|
expect(featureFlags.isMacOSEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter macos desktop enabled with environment variable on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
platform.environment = <String, String>{'FLUTTER_MACOS': 'true'};
|
|
|
|
expect(featureFlags.isMacOSEnabled, true);
|
|
});
|
|
|
|
/// Flutter Linux Desktop
|
|
testWithoutContext('Flutter linux desktop off by default on master', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
|
|
expect(featureFlags.isLinuxEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop enabled with config on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
testConfig.setValue('enable-linux-desktop', true);
|
|
|
|
expect(featureFlags.isLinuxEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop enabled with environment variable on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
platform.environment = <String, String>{'FLUTTER_LINUX': 'true'};
|
|
|
|
expect(featureFlags.isLinuxEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop off by default on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
|
|
expect(featureFlags.isLinuxEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop enabled with config on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
testConfig.setValue('enable-linux-desktop', true);
|
|
|
|
expect(featureFlags.isLinuxEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop enabled with environment variable on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
platform.environment = <String, String>{'FLUTTER_LINUX': 'true'};
|
|
|
|
expect(featureFlags.isLinuxEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop off by default on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
|
|
expect(featureFlags.isLinuxEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop enabled with config on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
testConfig.setValue('enable-linux-desktop', true);
|
|
|
|
expect(featureFlags.isLinuxEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter linux desktop enabled with environment variable on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
platform.environment = <String, String>{'FLUTTER_LINUX': 'true'};
|
|
|
|
expect(featureFlags.isLinuxEnabled, true);
|
|
});
|
|
|
|
/// Flutter Windows desktop.
|
|
testWithoutContext('Flutter Windows desktop off by default on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
|
|
expect(featureFlags.isWindowsEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop enabled with config on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
testConfig.setValue('enable-windows-desktop', true);
|
|
|
|
expect(featureFlags.isWindowsEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop enabled with environment variable on master', () {
|
|
final FeatureFlags featureFlags = createFlags('master');
|
|
platform.environment = <String, String>{'FLUTTER_WINDOWS': 'true'};
|
|
|
|
expect(featureFlags.isWindowsEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop off by default on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
|
|
expect(featureFlags.isWindowsEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop enabled with config on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
testConfig.setValue('enable-windows-desktop', true);
|
|
|
|
expect(featureFlags.isWindowsEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop enabled with environment variable on beta', () {
|
|
final FeatureFlags featureFlags = createFlags('beta');
|
|
platform.environment = <String, String>{'FLUTTER_WINDOWS': 'true'};
|
|
|
|
expect(featureFlags.isWindowsEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop off by default on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
|
|
expect(featureFlags.isWindowsEnabled, false);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop enabled with config on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
testConfig.setValue('enable-windows-desktop', true);
|
|
|
|
expect(featureFlags.isWindowsEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Flutter Windows desktop enabled with environment variable on stable', () {
|
|
final FeatureFlags featureFlags = createFlags('stable');
|
|
platform.environment = <String, String>{'FLUTTER_WINDOWS': 'true'};
|
|
|
|
expect(featureFlags.isWindowsEnabled, true);
|
|
});
|
|
|
|
for (final Feature feature in <Feature>[
|
|
flutterWindowsDesktopFeature,
|
|
flutterMacOSDesktopFeature,
|
|
flutterLinuxDesktopFeature,
|
|
]) {
|
|
test('${feature.name} available and enabled by default on master', () {
|
|
expect(feature.master.enabledByDefault, true);
|
|
expect(feature.master.available, true);
|
|
});
|
|
test('${feature.name} available and enabled by default on beta', () {
|
|
expect(feature.beta.enabledByDefault, true);
|
|
expect(feature.beta.available, true);
|
|
});
|
|
test('${feature.name} available and enabled by default on stable', () {
|
|
expect(feature.stable.enabledByDefault, true);
|
|
expect(feature.stable.available, true);
|
|
});
|
|
}
|
|
|
|
// Custom devices on all channels
|
|
for (final String channel in <String>['master', 'beta', 'stable']) {
|
|
testWithoutContext('Custom devices are enabled with flag on $channel', () {
|
|
final FeatureFlags featureFlags = createFlags(channel);
|
|
testConfig.setValue('enable-custom-devices', true);
|
|
expect(featureFlags.areCustomDevicesEnabled, true);
|
|
});
|
|
|
|
testWithoutContext('Custom devices are enabled with environment variable on $channel', () {
|
|
final FeatureFlags featureFlags = createFlags(channel);
|
|
platform.environment = <String, String>{'FLUTTER_CUSTOM_DEVICES': 'true'};
|
|
expect(featureFlags.areCustomDevicesEnabled, true);
|
|
});
|
|
}
|
|
|
|
});
|
|
}
|