generate_synthetic_packages_test.dart 9.83 KB
Newer Older
1 2 3 4
// 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.

5 6
import 'dart:async';

7 8 9 10 11 12
import 'package:file/memory.dart';
import 'package:flutter_tools/src/artifacts.dart';
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/build_system/build_system.dart';
import 'package:flutter_tools/src/build_system/targets/localizations.dart';
13
import 'package:flutter_tools/src/dart/generate_synthetic_packages.dart';
14 15 16

import '../../src/common.dart';
import '../../src/fake_process_manager.dart';
17
import '../../src/test_build_system.dart';
18 19

void main() {
20
  testWithoutContext('calls buildSystem.build with blank l10n.yaml file', () async {
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
    // Project directory setup for gen_l10n logic
    final MemoryFileSystem fileSystem = MemoryFileSystem.test();

    // Add generate:true to pubspec.yaml.
    final File pubspecFile = fileSystem.file('pubspec.yaml')..createSync();
    final String content = pubspecFile.readAsStringSync().replaceFirst(
      '\nflutter:\n',
      '\nflutter:\n  generate: true\n',
    );
    pubspecFile.writeAsStringSync(content);

    // Create an l10n.yaml file
    fileSystem.file('l10n.yaml').createSync();

    final BufferLogger mockBufferLogger = BufferLogger.test();
36
    final Artifacts artifacts = Artifacts.test();
37 38 39 40
    final Environment environment = Environment.test(
      fileSystem.currentDirectory,
      fileSystem: fileSystem,
      logger: mockBufferLogger,
41
      artifacts: artifacts,
42
      processManager: FakeProcessManager.any(),
43
    );
44 45
    final Completer<void> completer = Completer<void>();
    final BuildResult exception = BuildResult(success: false, exceptions: <String, ExceptionMeasurement>{
46
      'hello': ExceptionMeasurement('hello', const FormatException('illegal character in input string'), StackTrace.current),
47 48 49 50 51 52
    });
    final TestBuildSystem buildSystem = TestBuildSystem.all(exception, (Target target, Environment environment) {
      expect(target, const GenerateLocalizationsTarget());
      expect(environment, environment);
      completer.complete();
    });
53

54
    await expectLater(
55 56 57 58
      () => generateLocalizationsSyntheticPackage(
        environment: environment,
        buildSystem: buildSystem,
      ),
59 60 61 62 63
      throwsToolExit(message:
        'Generating synthetic localizations package failed with 1 error:'
        '\n\n'
        'FormatException: illegal character in input string',
      ),
64
    );
65
    await completer.future;
66 67
  });

68
  testWithoutContext('calls buildSystem.build with l10n.yaml synthetic-package: true', () async {
69 70 71 72 73 74 75 76 77 78 79 80 81 82
    // Project directory setup for gen_l10n logic
    final MemoryFileSystem fileSystem = MemoryFileSystem.test();

    // Add generate:true to pubspec.yaml.
    final File pubspecFile = fileSystem.file('pubspec.yaml')..createSync();
    final String content = pubspecFile.readAsStringSync().replaceFirst(
      '\nflutter:\n',
      '\nflutter:\n  generate: true\n',
    );
    pubspecFile.writeAsStringSync(content);

    // Create an l10n.yaml file
    fileSystem.file('l10n.yaml').writeAsStringSync('synthetic-package: true');

83
    final FakeProcessManager fakeProcessManager = FakeProcessManager.any();
84
    final BufferLogger mockBufferLogger = BufferLogger.test();
85
    final Artifacts artifacts = Artifacts.test();
86 87 88 89
    final Environment environment = Environment.test(
      fileSystem.currentDirectory,
      fileSystem: fileSystem,
      logger: mockBufferLogger,
90
      artifacts: artifacts,
91
      processManager: fakeProcessManager,
92
    );
93 94
    final Completer<void> completer = Completer<void>();
    final BuildResult exception = BuildResult(success: false, exceptions: <String, ExceptionMeasurement>{
95
      'hello': ExceptionMeasurement('hello', const FormatException('illegal character in input string'), StackTrace.current),
96 97 98 99 100 101
    });
    final TestBuildSystem buildSystem = TestBuildSystem.all(exception, (Target target, Environment environment) {
      expect(target, const GenerateLocalizationsTarget());
      expect(environment, environment);
      completer.complete();
    });
102

103
    await expectLater(
104 105 106 107
      () => generateLocalizationsSyntheticPackage(
        environment: environment,
        buildSystem: buildSystem,
      ),
108 109 110 111 112
      throwsToolExit(message:
        'Generating synthetic localizations package failed with 1 error:'
        '\n\n'
        'FormatException: illegal character in input string',
      ),
113
    );
114
    await completer.future;
115 116
  });

117
  testWithoutContext('calls buildSystem.build with l10n.yaml synthetic-package: null', () async {
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    // Project directory setup for gen_l10n logic
    final MemoryFileSystem fileSystem = MemoryFileSystem.test();

    // Add generate:true to pubspec.yaml.
    final File pubspecFile = fileSystem.file('pubspec.yaml')..createSync();
    final String content = pubspecFile.readAsStringSync().replaceFirst(
      '\nflutter:\n',
      '\nflutter:\n  generate: true\n',
    );
    pubspecFile.writeAsStringSync(content);

    // Create an l10n.yaml file
    fileSystem.file('l10n.yaml').writeAsStringSync('synthetic-package: null');

    final BufferLogger mockBufferLogger = BufferLogger.test();
    final Environment environment = Environment.test(
      fileSystem.currentDirectory,
      fileSystem: fileSystem,
      logger: mockBufferLogger,
137
      artifacts: Artifacts.test(),
138
      processManager: FakeProcessManager.any(),
139
    );
140 141
    final Completer<void> completer = Completer<void>();
    final BuildResult exception = BuildResult(success: false, exceptions: <String, ExceptionMeasurement>{
142
      'hello': ExceptionMeasurement('hello', const FormatException('illegal character in input string'), StackTrace.current),
143 144 145 146 147 148
    });
    final TestBuildSystem buildSystem = TestBuildSystem.all(exception, (Target target, Environment environment) {
      expect(target, const GenerateLocalizationsTarget());
      expect(environment, environment);
      completer.complete();
    });
149

150
    await expectLater(
151 152 153 154
      () => generateLocalizationsSyntheticPackage(
        environment: environment,
        buildSystem: buildSystem,
      ),
155 156 157 158 159
      throwsToolExit(message:
        'Generating synthetic localizations package failed with 1 error:'
        '\n\n'
        'FormatException: illegal character in input string',
      ),
160
    );
161
    await completer.future;
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  });

  testWithoutContext('does not call buildSystem.build when l10n.yaml is not present', () async {
    // Project directory setup for gen_l10n logic
    final MemoryFileSystem fileSystem = MemoryFileSystem.test();

    // Add generate:true to pubspec.yaml.
    final File pubspecFile = fileSystem.file('pubspec.yaml')..createSync();
    final String content = pubspecFile.readAsStringSync().replaceFirst(
      '\nflutter:\n',
      '\nflutter:\n  generate: true\n',
    );
    pubspecFile.writeAsStringSync(content);

    final BufferLogger mockBufferLogger = BufferLogger.test();
    final Environment environment = Environment.test(
      fileSystem.currentDirectory,
      fileSystem: fileSystem,
      logger: mockBufferLogger,
181
      artifacts: Artifacts.test(),
182
      processManager: FakeProcessManager.any(),
183
    );
184 185
    // Will throw if build is called.
    final TestBuildSystem buildSystem = TestBuildSystem.all(null);
186 187 188 189 190 191 192

    await generateLocalizationsSyntheticPackage(
      environment: environment,
      buildSystem: buildSystem,
    );
  });

193
  testWithoutContext('does not call buildSystem.build with incorrect l10n.yaml format', () async {
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    // Project directory setup for gen_l10n logic
    final MemoryFileSystem fileSystem = MemoryFileSystem.test();

    // Add generate:true to pubspec.yaml.
    final File pubspecFile = fileSystem.file('pubspec.yaml')..createSync();
    final String content = pubspecFile.readAsStringSync().replaceFirst(
      '\nflutter:\n',
      '\nflutter:\n  generate: true\n',
    );
    pubspecFile.writeAsStringSync(content);

    // Create an l10n.yaml file
    fileSystem.file('l10n.yaml').writeAsStringSync('helloWorld');

    final BufferLogger mockBufferLogger = BufferLogger.test();
    final Environment environment = Environment.test(
      fileSystem.currentDirectory,
      fileSystem: fileSystem,
      logger: mockBufferLogger,
213
      artifacts: Artifacts.test(),
214
      processManager: FakeProcessManager.any(),
215
    );
216 217
    // Will throw if build is called.
    final TestBuildSystem buildSystem = TestBuildSystem.all(null);
218

219
    await expectLater(
220 221 222 223 224 225 226 227
      () => generateLocalizationsSyntheticPackage(
        environment: environment,
        buildSystem: buildSystem,
      ),
      throwsToolExit(message: 'to contain a map, instead was helloWorld'),
    );
  });

228
  testWithoutContext('does not call buildSystem.build with non-bool "synthetic-package" value', () async {
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    // Project directory setup for gen_l10n logic
    final MemoryFileSystem fileSystem = MemoryFileSystem.test();

    // Add generate:true to pubspec.yaml.
    final File pubspecFile = fileSystem.file('pubspec.yaml')..createSync();
    final String content = pubspecFile.readAsStringSync().replaceFirst(
      '\nflutter:\n',
      '\nflutter:\n  generate: true\n',
    );
    pubspecFile.writeAsStringSync(content);

    // Create an l10n.yaml file
    fileSystem.file('l10n.yaml').writeAsStringSync('synthetic-package: nonBoolValue');

    final BufferLogger mockBufferLogger = BufferLogger.test();
    final Environment environment = Environment.test(
      fileSystem.currentDirectory,
      fileSystem: fileSystem,
      logger: mockBufferLogger,
248
      artifacts: Artifacts.test(),
249
      processManager: FakeProcessManager.any(),
250
    );
251 252
    // Will throw if build is called.
    final TestBuildSystem buildSystem = TestBuildSystem.all(null);
253

254
    await expectLater(
255 256 257 258 259 260 261 262
      () => generateLocalizationsSyntheticPackage(
        environment: environment,
        buildSystem: buildSystem,
      ),
      throwsToolExit(message: 'to have a bool value, instead was "nonBoolValue"'),
    );
  });
}