Skip to content

Commit e9a3cbf

Browse files
GaryQianGaryQian
authored
Migrate abandon (#102789)
1 parent febc6a1 commit e9a3cbf

File tree

4 files changed

+296
-4
lines changed

4 files changed

+296
-4
lines changed

‎packages/flutter_tools/lib/src/commands/migrate.dart

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,33 @@ import '../base/platform.dart';
1010
import '../base/terminal.dart';
1111
import '../migrate/migrate_utils.dart';
1212
import '../runner/flutter_command.dart';
13+
import 'migrate_abandon.dart';
1314
import 'migrate_status.dart';
1415

1516
/// Base command for the migration tool.
1617
class MigrateCommand extends FlutterCommand {
1718
MigrateCommand({
18-
bool verbose = false,
19+
required bool verbose,
1920
required this.logger,
20-
// TODO(garyq): Add parameter in as they are needed for subcommands.
2121
required FileSystem fileSystem,
22+
required Terminal terminal,
2223
required Platform platform,
2324
required ProcessManager processManager,
2425
}) {
25-
// TODO(garyq): Add each subcommand back in as they land.
2626
addSubcommand(MigrateStatusCommand(
2727
verbose: verbose,
2828
logger: logger,
2929
fileSystem: fileSystem,
3030
platform: platform,
3131
processManager: processManager
3232
));
33+
addSubcommand(MigrateAbandonCommand(
34+
logger: logger,
35+
fileSystem: fileSystem,
36+
terminal: terminal,
37+
platform: platform,
38+
processManager: processManager
39+
));
3340
}
3441

3542
final Logger logger;

‎packages/flutter_tools/lib/src/commands/migrate_abandon.dart

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
// Copyright 2014 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
import 'package:process/process.dart';
6+
7+
import '../base/file_system.dart';
8+
import '../base/logger.dart';
9+
import '../base/platform.dart';
10+
import '../base/terminal.dart';
11+
import '../migrate/migrate_utils.dart';
12+
import '../project.dart';
13+
import '../runner/flutter_command.dart';
14+
import 'migrate.dart';
15+
16+
/// Abandons the existing migration by deleting the migrate working directory.
17+
class MigrateAbandonCommand extends FlutterCommand {
18+
MigrateAbandonCommand({
19+
required this.logger,
20+
required this.fileSystem,
21+
required this.terminal,
22+
required Platform platform,
23+
required ProcessManager processManager,
24+
}) : migrateUtils = MigrateUtils(
25+
logger: logger,
26+
fileSystem: fileSystem,
27+
platform: platform,
28+
processManager: processManager,
29+
) {
30+
requiresPubspecYaml();
31+
argParser.addOption(
32+
'staging-directory',
33+
help: 'Specifies the custom migration working directory used to stage '
34+
'and edit proposed changes. This path can be absolute or relative '
35+
'to the flutter project root. This defaults to '
36+
'`$kDefaultMigrateStagingDirectoryName`',
37+
valueHelp: 'path',
38+
);
39+
argParser.addOption(
40+
'project-directory',
41+
help: 'The root directory of the flutter project. This defaults to the '
42+
'current working directory if omitted.',
43+
valueHelp: 'path',
44+
);
45+
argParser.addFlag(
46+
'force',
47+
abbr: 'f',
48+
help: 'Delete the migrate working directory without asking for confirmation.',
49+
);
50+
}
51+
52+
final Logger logger;
53+
54+
final FileSystem fileSystem;
55+
56+
final Terminal terminal;
57+
58+
final MigrateUtils migrateUtils;
59+
60+
@override
61+
final String name = 'abandon';
62+
63+
@override
64+
final String description = 'Deletes the current active migration working directory.';
65+
66+
@override
67+
String get category => FlutterCommandCategory.project;
68+
69+
@override
70+
Future<Set<DevelopmentArtifact>> get requiredArtifacts async => const <DevelopmentArtifact>{};
71+
72+
@override
73+
Future<FlutterCommandResult> runCommand() async {
74+
final String? projectDirectory = stringArg('project-directory');
75+
final FlutterProjectFactory flutterProjectFactory = FlutterProjectFactory(logger: logger, fileSystem: fileSystem);
76+
final FlutterProject project = projectDirectory == null
77+
? FlutterProject.current()
78+
: flutterProjectFactory.fromDirectory(fileSystem.directory(projectDirectory));
79+
Directory stagingDirectory = project.directory.childDirectory(kDefaultMigrateStagingDirectoryName);
80+
final String? customStagingDirectoryPath = stringArg('staging-directory');
81+
if (customStagingDirectoryPath != null) {
82+
if (fileSystem.path.isAbsolute(customStagingDirectoryPath)) {
83+
stagingDirectory = fileSystem.directory(customStagingDirectoryPath);
84+
} else {
85+
stagingDirectory = project.directory.childDirectory(customStagingDirectoryPath);
86+
}
87+
if (!stagingDirectory.existsSync()) {
88+
logger.printError('Provided staging directory `$customStagingDirectoryPath` '
89+
'does not exist or is not valid.');
90+
return const FlutterCommandResult(ExitStatus.fail);
91+
}
92+
}
93+
if (!stagingDirectory.existsSync()) {
94+
logger.printStatus('No migration in progress. Start a new migration with:');
95+
printCommandText('flutter migrate start', logger);
96+
return const FlutterCommandResult(ExitStatus.fail);
97+
}
98+
99+
logger.printStatus('\nAbandoning the existing migration will delete the '
100+
'migration staging directory at ${stagingDirectory.path}');
101+
final bool force = boolArg('force') ?? false;
102+
if (!force) {
103+
String selection = 'y';
104+
terminal.usesTerminalUi = true;
105+
try {
106+
selection = await terminal.promptForCharInput(
107+
<String>['y', 'n'],
108+
logger: logger,
109+
prompt: 'Are you sure you wish to continue with abandoning? (y)es, (N)o',
110+
defaultChoiceIndex: 1,
111+
);
112+
} on StateError catch(e) {
113+
logger.printError(
114+
e.message,
115+
indent: 0,
116+
);
117+
}
118+
if (selection != 'y') {
119+
return const FlutterCommandResult(ExitStatus.success);
120+
}
121+
}
122+
123+
try {
124+
stagingDirectory.deleteSync(recursive: true);
125+
} on FileSystemException catch (e) {
126+
logger.printError('Deletion failed with: $e');
127+
logger.printError('Please manually delete the staging directory at `${stagingDirectory.path}`');
128+
}
129+
130+
logger.printStatus('\nAbandon complete. Start a new migration with:');
131+
printCommandText('flutter migrate start', logger);
132+
return const FlutterCommandResult(ExitStatus.success);
133+
}
134+
}

‎packages/flutter_tools/test/commands.shard/permeable/migrate_abandon_test.dart

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
// Copyright 2014 The Flutter Authors. All rights reserved.
2+
// Use of this source code is governed by a BSD-style license that can be
3+
// found in the LICENSE file.
4+
5+
// @dart = 2.8
6+
7+
import 'package:flutter_tools/src/base/file_system.dart';
8+
import 'package:flutter_tools/src/base/logger.dart';
9+
import 'package:flutter_tools/src/base/platform.dart';
10+
import 'package:flutter_tools/src/base/terminal.dart';
11+
import 'package:flutter_tools/src/cache.dart';
12+
import 'package:flutter_tools/src/commands/migrate.dart';
13+
import 'package:flutter_tools/src/globals.dart' as globals;
14+
import 'package:flutter_tools/src/migrate/migrate_utils.dart';
15+
16+
import '../../src/common.dart';
17+
import '../../src/context.dart';
18+
import '../../src/test_flutter_command_runner.dart';
19+
20+
void main() {
21+
FileSystem fileSystem;
22+
BufferLogger logger;
23+
Platform platform;
24+
Terminal terminal;
25+
ProcessManager processManager;
26+
Directory appDir;
27+
28+
setUp(() {
29+
fileSystem = globals.localFileSystem;
30+
appDir = fileSystem.systemTempDirectory.createTempSync('apptestdir');
31+
logger = BufferLogger.test();
32+
platform = FakePlatform();
33+
terminal = Terminal.test();
34+
processManager = globals.processManager;
35+
});
36+
37+
setUpAll(() {
38+
Cache.disableLocking();
39+
});
40+
41+
tearDown(() async {
42+
tryToDelete(appDir);
43+
});
44+
45+
testUsingContext('abandon deletes staging directory', () async {
46+
final MigrateCommand command = MigrateCommand(
47+
verbose: true,
48+
logger: logger,
49+
fileSystem: fileSystem,
50+
terminal: terminal,
51+
platform: platform,
52+
processManager: processManager,
53+
);
54+
final Directory stagingDir = appDir.childDirectory(kDefaultMigrateStagingDirectoryName);
55+
appDir.childFile('lib/main.dart').createSync(recursive: true);
56+
final File pubspecOriginal = appDir.childFile('pubspec.yaml');
57+
pubspecOriginal.createSync();
58+
pubspecOriginal.writeAsStringSync('''
59+
name: originalname
60+
description: A new Flutter project.
61+
version: 1.0.0+1
62+
environment:
63+
sdk: '>=2.18.0-58.0.dev <3.0.0'
64+
dependencies:
65+
flutter:
66+
sdk: flutter
67+
dev_dependencies:
68+
flutter_test:
69+
sdk: flutter
70+
flutter:
71+
uses-material-design: true''', flush: true);
72+
73+
expect(stagingDir.existsSync(), false);
74+
await createTestCommandRunner(command).run(
75+
<String>[
76+
'migrate',
77+
'abandon',
78+
'--staging-directory=${stagingDir.path}',
79+
'--project-directory=${appDir.path}',
80+
]
81+
);
82+
expect(logger.errorText, contains('Provided staging directory'));
83+
expect(logger.errorText, contains('migrate_staging_dir` does not exist or is not valid.'));
84+
85+
logger.clear();
86+
await createTestCommandRunner(command).run(
87+
<String>[
88+
'migrate',
89+
'abandon',
90+
'--project-directory=${appDir.path}',
91+
]
92+
);
93+
expect(logger.statusText, contains('No migration in progress. Start a new migration with:'));
94+
95+
final File pubspecModified = stagingDir.childFile('pubspec.yaml');
96+
pubspecModified.createSync(recursive: true);
97+
pubspecModified.writeAsStringSync('''
98+
name: newname
99+
description: new description of the test project
100+
version: 1.0.0+1
101+
environment:
102+
sdk: '>=2.18.0-58.0.dev <3.0.0'
103+
dependencies:
104+
flutter:
105+
sdk: flutter
106+
dev_dependencies:
107+
flutter_test:
108+
sdk: flutter
109+
flutter:
110+
uses-material-design: false
111+
EXTRALINE''', flush: true);
112+
113+
final File addedFile = stagingDir.childFile('added.file');
114+
addedFile.createSync(recursive: true);
115+
addedFile.writeAsStringSync('new file contents');
116+
117+
final File manifestFile = stagingDir.childFile('.migrate_manifest');
118+
manifestFile.createSync(recursive: true);
119+
manifestFile.writeAsStringSync('''
120+
merged_files:
121+
- pubspec.yaml
122+
conflict_files:
123+
added_files:
124+
- added.file
125+
deleted_files:
126+
''');
127+
128+
expect(appDir.childFile('lib/main.dart').existsSync(), true);
129+
130+
expect(stagingDir.existsSync(), true);
131+
logger.clear();
132+
await createTestCommandRunner(command).run(
133+
<String>[
134+
'migrate',
135+
'abandon',
136+
'--staging-directory=${stagingDir.path}',
137+
'--project-directory=${appDir.path}',
138+
'--force',
139+
]
140+
);
141+
expect(logger.statusText, contains('Abandon complete. Start a new migration with:'));
142+
expect(stagingDir.existsSync(), false);
143+
}, overrides: <Type, Generator>{
144+
FileSystem: () => fileSystem,
145+
ProcessManager: () => processManager,
146+
Platform: () => platform,
147+
});
148+
}

‎packages/flutter_tools/test/commands.shard/permeable/migrate_status_test.dart

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import 'package:flutter_tools/src/base/file_system.dart';
88
import 'package:flutter_tools/src/base/logger.dart';
99
import 'package:flutter_tools/src/base/platform.dart';
10+
import 'package:flutter_tools/src/base/terminal.dart';
1011
import 'package:flutter_tools/src/cache.dart';
1112
import 'package:flutter_tools/src/commands/migrate.dart';
1213
import 'package:flutter_tools/src/globals.dart' as globals;
@@ -20,7 +21,7 @@ void main() {
2021
FileSystem fileSystem;
2122
BufferLogger logger;
2223
Platform platform;
23-
// TODO(garyq): Add terminal back in when other subcommands land.
24+
Terminal terminal;
2425
ProcessManager processManager;
2526
Directory appDir;
2627

@@ -29,6 +30,7 @@ void main() {
2930
appDir = fileSystem.systemTempDirectory.createTempSync('apptestdir');
3031
logger = BufferLogger.test();
3132
platform = FakePlatform();
33+
terminal = Terminal.test();
3234
processManager = globals.processManager;
3335
});
3436

@@ -45,6 +47,7 @@ void main() {
4547
verbose: true,
4648
logger: logger,
4749
fileSystem: fileSystem,
50+
terminal: terminal,
4851
platform: platform,
4952
processManager: processManager,
5053
);

0 commit comments

Comments
 (0)