1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// 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:file/memory.dart';
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/flutter_project_metadata.dart';
import 'package:flutter_tools/src/project.dart';
import '../src/common.dart';
void main() {
late FileSystem fileSystem;
late BufferLogger logger;
late File metadataFile;
setUp(() {
fileSystem = MemoryFileSystem.test();
logger = BufferLogger.test();
metadataFile = fileSystem.file('.metadata');
});
testWithoutContext('project metadata fields are empty when file does not exist', () {
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, isNull);
expect(projectMetadata.versionChannel, isNull);
expect(projectMetadata.versionRevision, isNull);
expect(logger.traceText, contains('No .metadata file found at .metadata'));
});
testWithoutContext('project metadata fields are empty when file is empty', () {
metadataFile.createSync();
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, isNull);
expect(projectMetadata.versionChannel, isNull);
expect(projectMetadata.versionRevision, isNull);
expect(logger.traceText, contains('.metadata file at .metadata was empty or malformed.'));
});
testWithoutContext('project metadata fields are empty when file is not valid yaml', () {
metadataFile.writeAsStringSync(' channel: @something');
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, isNull);
expect(projectMetadata.versionChannel, isNull);
expect(projectMetadata.versionRevision, isNull);
expect(logger.traceText, contains('.metadata file at .metadata was empty or malformed.'));
});
testWithoutContext('projectType is populated when version is null', () {
metadataFile
..createSync()
..writeAsStringSync('''
version:
project_type: plugin
''');
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, FlutterProjectType.plugin);
expect(projectMetadata.versionChannel, isNull);
expect(projectMetadata.versionRevision, isNull);
expect(logger.traceText, contains('The value of key `version` in .metadata was expected to be YamlMap but was Null'));
});
testWithoutContext('projectType is populated when version is malformed', () {
metadataFile
..createSync()
..writeAsStringSync('''
version: STRING INSTEAD OF MAP
project_type: plugin
''');
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, FlutterProjectType.plugin);
expect(projectMetadata.versionChannel, isNull);
expect(projectMetadata.versionRevision, isNull);
expect(logger.traceText, contains('The value of key `version` in .metadata was expected to be YamlMap but was String'));
});
testWithoutContext('version is populated when projectType is malformed', () {
metadataFile
..createSync()
..writeAsStringSync('''
version:
revision: b59b226a49391949247e3d6122e34bb001049ae4
channel: stable
project_type: {}
''');
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, isNull);
expect(projectMetadata.versionChannel, 'stable');
expect(projectMetadata.versionRevision, 'b59b226a49391949247e3d6122e34bb001049ae4');
expect(logger.traceText, contains('The value of key `project_type` in .metadata was expected to be String but was YamlMap'));
});
testWithoutContext('migrate config is populated when version is malformed', () {
metadataFile
..createSync()
..writeAsStringSync('''
version: STRING INSTEAD OF MAP
project_type: {}
migration:
platforms:
- platform: root
create_revision: abcdefg
base_revision: baserevision
unmanaged_files:
- 'file1'
''');
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, isNull);
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.root]?.createRevision, 'abcdefg');
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.root]?.baseRevision, 'baserevision');
expect(projectMetadata.migrateConfig.unmanagedFiles[0], 'file1');
expect(logger.traceText, contains('The value of key `version` in .metadata was expected to be YamlMap but was String'));
expect(logger.traceText, contains('The value of key `project_type` in .metadata was expected to be String but was YamlMap'));
});
testWithoutContext('migrate config is populated when unmanaged_files is malformed', () {
metadataFile
..createSync()
..writeAsStringSync('''
version:
revision: b59b226a49391949247e3d6122e34bb001049ae4
channel: stable
project_type: app
migration:
platforms:
- platform: root
create_revision: abcdefg
base_revision: baserevision
unmanaged_files: {}
''');
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, FlutterProjectType.app);
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.root]?.createRevision, 'abcdefg');
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.root]?.baseRevision, 'baserevision');
// Tool uses default unamanged files list when malformed.
expect(projectMetadata.migrateConfig.unmanagedFiles[0], 'lib/main.dart');
expect(logger.traceText, contains('The value of key `unmanaged_files` in .metadata was expected to be YamlList but was YamlMap'));
});
testWithoutContext('platforms is populated with a malformed entry', () {
metadataFile
..createSync()
..writeAsStringSync('''
version:
revision: b59b226a49391949247e3d6122e34bb001049ae4
channel: stable
project_type: app
migration:
platforms:
- platform: root
create_revision: abcdefg
base_revision: baserevision
- platform: android
base_revision: baserevision
- platform: ios
create_revision: abcdefg
base_revision: baserevision
unmanaged_files:
- 'file1'
''');
final FlutterProjectMetadata projectMetadata = FlutterProjectMetadata(metadataFile, logger);
expect(projectMetadata.projectType, FlutterProjectType.app);
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.root]?.createRevision, 'abcdefg');
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.root]?.baseRevision, 'baserevision');
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.ios]?.createRevision, 'abcdefg');
expect(projectMetadata.migrateConfig.platformConfigs[SupportedPlatform.ios]?.baseRevision, 'baserevision');
expect(projectMetadata.migrateConfig.platformConfigs.containsKey(SupportedPlatform.android), false);
expect(projectMetadata.migrateConfig.unmanagedFiles[0], 'file1');
expect(logger.traceText, contains('The key `create_revision` was not found'));
});
}