generate_localizations_test.dart 59.6 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
import 'dart:convert';
6 7 8 9
import 'dart:io';

import 'package:file/memory.dart';

10 11 12 13 14 15
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/globals.dart' as globals;
import 'package:flutter_tools/src/localizations/gen_l10n.dart';
import 'package:flutter_tools/src/localizations/gen_l10n_types.dart';
import 'package:flutter_tools/src/localizations/localizations_utils.dart';
16

17 18 19
import 'package:test_api/test_api.dart' hide TypeMatcher, isInstanceOf; // ignore: deprecated_member_use
// ignore: deprecated_member_use
export 'package:test_core/test_core.dart' hide TypeMatcher, isInstanceOf, test; // Defines a 'package:test' shim.
20

21 22
final String defaultL10nPathString = globals.fs.path.join('lib', 'l10n');
final String syntheticPackagePath = globals.fs.path.join('.dart_tool', 'flutter_gen', 'gen_l10n');
23
const String defaultTemplateArbFileName = 'app_en.arb';
24
const String defaultOutputFileString = 'output-localization-file.dart';
25
const String defaultClassNameString = 'AppLocalizations';
26 27
const String singleMessageArbFileString = '''
{
28
  "title": "Title",
29
  "@title": {
30
    "description": "Title for the application"
31 32
  }
}''';
33 34 35 36 37 38 39 40 41 42 43
const String twoMessageArbFileString = '''
{
  "title": "Title",
  "@title": {
    "description": "Title for the application"
  },
  "subtitle": "Subtitle",
  "@subtitle": {
    "description": "Subtitle for the application"
  }
}''';
44
const String esArbFileName = 'app_es.arb';
45 46
const String singleEsMessageArbFileString = '''
{
47 48
  "title": "Título"
}''';
49 50
const String singleZhMessageArbFileString = '''
{
51
  "title": "标题"
52 53 54 55 56 57 58 59 60 61 62 63 64 65
}''';

void _standardFlutterDirectoryL10nSetup(FileSystem fs) {
  final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
    ..createSync(recursive: true);
  l10nDirectory.childFile(defaultTemplateArbFileName)
    .writeAsStringSync(singleMessageArbFileString);
  l10nDirectory.childFile(esArbFileName)
    .writeAsStringSync(singleEsMessageArbFileString);
}

void main() {
  MemoryFileSystem fs;

66
  setUp(() {
67 68 69
    fs = MemoryFileSystem(
      style: Platform.isWindows ? FileSystemStyle.windows : FileSystemStyle.posix
    );
70
    precacheLanguageAndRegionTags();
71 72
  });

73
  group('Setters', () {
74
    test('setInputDirectory fails if the directory does not exist', () {
75 76
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
77
        generator.setInputDirectory('lib');
78
      } on L10nException catch (e) {
79 80 81 82 83
        expect(e.message, contains('Make sure that the correct path was provided'));
        return;
      }

      fail(
84
        'LocalizationsGenerator.setInputDirectory should fail if the '
85 86 87 88
        'directory does not exist.'
      );
    });

89
    test('setInputDirectory fails if input string is null', () {
90 91 92
      _standardFlutterDirectoryL10nSetup(fs);
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
93
        generator.setInputDirectory(null);
94 95 96 97 98 99
      } on L10nException catch (e) {
        expect(e.message, contains('cannot be null'));
        return;
      }

      fail(
100 101
        'LocalizationsGenerator.setInputDirectory should fail if the '
        'input string is null.'
102 103 104
      );
    });

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    test(
      'setOutputDirectory fails if output string is null while not using the '
      'synthetic package option',
      () {
        _standardFlutterDirectoryL10nSetup(fs);
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.setOutputDirectory(
            outputPathString: null,
            useSyntheticPackage: false,
          );
        } on L10nException catch (e) {
          expect(e.message, contains('cannot be null'));
          return;
        }
120

121 122 123 124 125 126
        fail(
          'LocalizationsGenerator.setOutputDirectory should fail if the '
          'input string is null.'
        );
      },
    );
127 128

    test('setTemplateArbFile fails if inputDirectory is null', () {
129 130 131 132 133 134 135 136 137
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.setTemplateArbFile(defaultTemplateArbFileName);
      } on L10nException catch (e) {
        expect(e.message, contains('cannot be null'));
        return;
      }

      fail(
138 139
        'LocalizationsGenerator.setTemplateArbFile should fail if the '
        'inputDirectory is not specified.'
140 141 142 143 144 145 146 147 148 149 150 151 152 153
      );
    });

    test('setTemplateArbFile fails if templateArbFileName is null', () {
      _standardFlutterDirectoryL10nSetup(fs);
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.setTemplateArbFile(null);
      } on L10nException catch (e) {
        expect(e.message, contains('cannot be null'));
        return;
      }

      fail(
154 155
        'LocalizationsGenerator.setTemplateArbFile should fail if the '
        'templateArbFileName passed in is null.'
156 157 158 159 160 161 162 163 164 165 166 167 168 169
      );
    });

    test('setTemplateArbFile fails if input string is null', () {
      _standardFlutterDirectoryL10nSetup(fs);
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.setTemplateArbFile(null);
      } on L10nException catch (e) {
        expect(e.message, contains('cannot be null'));
        return;
      }

      fail(
170 171
        'LocalizationsGenerator.setTemplateArbFile should fail if the '
        'input string is null.'
172 173 174
      );
    });

175
    test('setBaseOutputFile fails if input string is null', () {
176 177 178
      _standardFlutterDirectoryL10nSetup(fs);
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
179
        generator.setBaseOutputFile(null);
180 181 182 183 184 185
      } on L10nException catch (e) {
        expect(e.message, contains('cannot be null'));
        return;
      }

      fail(
186 187
        'LocalizationsGenerator.setBaseOutputFile should fail if the '
        'input string is null.'
188 189 190 191 192 193 194 195 196 197 198 199 200 201
      );
    });

    test('setting className fails if input string is null', () {
      _standardFlutterDirectoryL10nSetup(fs);
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.className = null;
      } on L10nException catch (e) {
        expect(e.message, contains('cannot be null'));
        return;
      }

      fail(
202 203
        'LocalizationsGenerator.className should fail if the '
        'input string is null.'
204 205 206
      );
    });

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
    test('sets absolute path of the target Flutter project', () {
      // Set up project directory.
      final Directory l10nDirectory = fs.currentDirectory
        .childDirectory('absolute')
        .childDirectory('path')
        .childDirectory('to')
        .childDirectory('flutter_project')
        .childDirectory('lib')
        .childDirectory('l10n')
        ..createSync(recursive: true);
      l10nDirectory.childFile(defaultTemplateArbFileName)
        .writeAsStringSync(singleMessageArbFileString);
      l10nDirectory.childFile(esArbFileName)
        .writeAsStringSync(singleEsMessageArbFileString);

      // Run localizations generator in specified absolute path.
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
224
      final String flutterProjectPath = fs.path.join('absolute', 'path', 'to', 'flutter_project');
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
      try {
        generator.initialize(
          projectPathString: flutterProjectPath,
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
        generator.loadResources();
        generator.writeOutputFiles();
      } on L10nException catch (e) {
        throw TestFailure('Unexpected failure during test setup: ${e.message}');
      } on Exception catch (e) {
        throw TestFailure('Unexpected failure during test setup: $e');
      }

      // Output files should be generated in the provided absolute path.
      expect(
244
        fs.isFileSync(fs.path.join(
245
          flutterProjectPath,
246 247 248
          '.dart_tool',
          'flutter_gen',
          'gen_l10n',
249 250 251 252 253
          'output-localization-file_en.dart',
        )),
        true,
      );
      expect(
254
        fs.isFileSync(fs.path.join(
255
          flutterProjectPath,
256 257 258
          '.dart_tool',
          'flutter_gen',
          'gen_l10n',
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
          'output-localization-file_es.dart',
        )),
        true,
      );
    });

    test('throws error when directory at absolute path does not exist', () {
      // Set up project directory.
      final Directory l10nDirectory = fs.currentDirectory
        .childDirectory('lib')
        .childDirectory('l10n')
        ..createSync(recursive: true);
      l10nDirectory.childFile(defaultTemplateArbFileName)
        .writeAsStringSync(singleMessageArbFileString);
      l10nDirectory.childFile(esArbFileName)
        .writeAsStringSync(singleEsMessageArbFileString);

      // Project path should be intentionally a directory that does not exist.
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.initialize(
          projectPathString: 'absolute/path/to/flutter_project',
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
      } on L10nException catch (e) {
        expect(e.message, contains('Directory does not exist'));
        return;
      }

      fail(
        'An exception should be thrown when the directory '
        'specified in projectPathString does not exist.'
      );
    });

298
    group('className should only take valid Dart class names', () {
299 300 301 302 303
      LocalizationsGenerator generator;
      setUp(() {
        _standardFlutterDirectoryL10nSetup(fs);
        generator = LocalizationsGenerator(fs);
        try {
304
          generator.setInputDirectory(defaultL10nPathString);
305
          generator.setOutputDirectory();
306
          generator.setTemplateArbFile(defaultTemplateArbFileName);
307
          generator.setBaseOutputFile(defaultOutputFileString);
308 309 310 311 312 313 314 315 316
        } on L10nException catch (e) {
          throw TestFailure('Unexpected failure during test setup: ${e.message}');
        }
      });

      test('fails on string with spaces', () {
        try {
          generator.className = 'String with spaces';
        } on L10nException catch (e) {
317
          expect(e.message, contains('is not a valid public Dart class name'));
318 319 320
          return;
        }
        fail(
321 322
          'LocalizationsGenerator.className should fail if the '
          'input string is not a valid Dart class name.'
323 324 325 326 327 328 329
        );
      });

      test('fails on non-alphanumeric symbols', () {
        try {
          generator.className = 'TestClass@123';
        } on L10nException catch (e) {
330
          expect(e.message, contains('is not a valid public Dart class name'));
331 332 333
          return;
        }
        fail(
334 335
          'LocalizationsGenerator.className should fail if the '
          'input string is not a valid public Dart class name.'
336 337 338 339 340 341 342
        );
      });

      test('fails on camel-case', () {
        try {
          generator.className = 'camelCaseClassName';
        } on L10nException catch (e) {
343
          expect(e.message, contains('is not a valid public Dart class name'));
344 345 346
          return;
        }
        fail(
347 348
          'LocalizationsGenerator.className should fail if the '
          'input string is not a valid public Dart class name.'
349 350 351 352 353 354 355
        );
      });

      test('fails when starting with a number', () {
        try {
          generator.className = '123ClassName';
        } on L10nException catch (e) {
356
          expect(e.message, contains('is not a valid public Dart class name'));
357 358 359
          return;
        }
        fail(
360 361
          'LocalizationsGenerator.className should fail if the '
          'input string is not a valid public Dart class name.'
362 363 364 365 366
        );
      });
    });
  });

367 368 369 370 371 372 373
  test('correctly adds a headerString when it is set', () {
    _standardFlutterDirectoryL10nSetup(fs);

    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator.initialize(
374 375
        inputPathString: defaultL10nPathString,
        outputPathString: defaultL10nPathString,
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
        templateArbFileName: defaultTemplateArbFileName,
        outputFileString: defaultOutputFileString,
        classNameString: defaultClassNameString,
        headerString: '/// Sample header',
      );
    } on L10nException catch (e) {
      fail('Setting a header through a String should not fail: \n${e.message}');
    }

    expect(generator.header, '/// Sample header');
  });

  test('correctly adds a headerFile when it is set', () {
    fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
      ..createSync(recursive: true)
      ..childFile(defaultTemplateArbFileName).writeAsStringSync(singleMessageArbFileString)
      ..childFile(esArbFileName).writeAsStringSync(singleEsMessageArbFileString)
      ..childFile('header.txt').writeAsStringSync('/// Sample header in a text file');

    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator.initialize(
399 400
        inputPathString: defaultL10nPathString,
        outputPathString: defaultL10nPathString,
401 402 403 404 405 406 407 408 409 410 411 412
        templateArbFileName: defaultTemplateArbFileName,
        outputFileString: defaultOutputFileString,
        classNameString: defaultClassNameString,
        headerFile: 'header.txt',
      );
    } on L10nException catch (e) {
      fail('Setting a header through a file should not fail: \n${e.message}');
    }

    expect(generator.header, '/// Sample header in a text file');
  });

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
  test('sets templateArbFileName with more than one underscore correctly', () {
    final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
      ..createSync(recursive: true);
    l10nDirectory.childFile('app_localizations_en.arb')
      .writeAsStringSync(singleMessageArbFileString);
    l10nDirectory.childFile('app_localizations_es.arb')
      .writeAsStringSync(singleEsMessageArbFileString);
    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator
        ..initialize(
          inputPathString: defaultL10nPathString,
          templateArbFileName: 'app_localizations_en.arb',
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        )
        ..loadResources()
        ..writeOutputFiles();
    } on L10nException catch (e) {
      fail('Generating output should not fail: \n${e.message}');
    }

436
    final Directory outputDirectory = fs.directory(syntheticPackagePath);
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
    expect(outputDirectory.childFile('output-localization-file.dart').existsSync(), isTrue);
    expect(outputDirectory.childFile('output-localization-file_en.dart').existsSync(), isTrue);
    expect(outputDirectory.childFile('output-localization-file_es.dart').existsSync(), isTrue);
  });

  test('filenames with invalid locales should not be recognized', () {
    final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
      ..createSync(recursive: true);
    l10nDirectory.childFile('app_localizations_en.arb')
      .writeAsStringSync(singleMessageArbFileString);
    l10nDirectory.childFile('app_localizations_en_CA_foo.arb')
      .writeAsStringSync(singleMessageArbFileString);
    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator
        ..initialize(
          inputPathString: defaultL10nPathString,
          templateArbFileName: 'app_localizations_en.arb',
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        )
        ..loadResources();
    } on L10nException catch (e) {
      expect(e.message, contains('The following .arb file\'s locale could not be determined'));
      return;
    }

    fail('Using app_en_CA_foo.arb should fail as it is not a valid locale.');
  });

468 469 470 471 472 473 474 475 476 477 478
  test('correctly creates an unimplemented messages file', () {
    fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
      ..createSync(recursive: true)
      ..childFile(defaultTemplateArbFileName).writeAsStringSync(twoMessageArbFileString)
      ..childFile(esArbFileName).writeAsStringSync(singleEsMessageArbFileString);

    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator
        ..initialize(
479 480
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
481 482 483 484 485
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        )
        ..loadResources()
486
        ..writeOutputFiles()
487 488 489 490
        ..outputUnimplementedMessages(
          fs.path.join('lib', 'l10n', 'unimplemented_message_translations.json'),
          BufferLogger.test(),
        );
491 492 493 494 495
    } on L10nException catch (e) {
      fail('Generating output should not fail: \n${e.message}');
    }

    final File unimplementedOutputFile = fs.file(
496
      fs.path.join('lib', 'l10n', 'unimplemented_message_translations.json'),
497 498 499 500 501 502 503 504 505 506 507 508
    );
    final String unimplementedOutputString = unimplementedOutputFile.readAsStringSync();
    try {
      // Since ARB file is essentially JSON, decoding it should not fail.
      json.decode(unimplementedOutputString);
    } on Exception {
      fail('Parsing arb file should not fail');
    }
    expect(unimplementedOutputString, contains('es'));
    expect(unimplementedOutputString, contains('subtitle'));
  });

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
  test(
    'uses inputPathString as outputPathString when the outputPathString is '
    'null while not using the synthetic package option',
    () {
      _standardFlutterDirectoryL10nSetup(fs);
      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator
          ..initialize(
            inputPathString: defaultL10nPathString,
            // outputPathString is intentionally not defined
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
            useSyntheticPackage: false,
          )
          ..loadResources()
          ..writeOutputFiles();
      } on L10nException catch (e) {
        fail('Generating output should not fail: \n${e.message}');
      }
531

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
      final Directory outputDirectory = fs.directory('lib').childDirectory('l10n');
      expect(outputDirectory.childFile('output-localization-file.dart').existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file_en.dart').existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file_es.dart').existsSync(), isTrue);
    },
  );

  test(
    'correctly generates output files in non-default output directory if it '
    'already exists while not using the synthetic package option',
    () {
      final Directory l10nDirectory = fs.currentDirectory
        .childDirectory('lib')
        .childDirectory('l10n')
        ..createSync(recursive: true);
      // Create the directory 'lib/l10n/output'.
      l10nDirectory.childDirectory('output');
549

550 551 552 553 554 555
      l10nDirectory
        .childFile(defaultTemplateArbFileName)
        .writeAsStringSync(singleMessageArbFileString);
      l10nDirectory
        .childFile(esArbFileName)
        .writeAsStringSync(singleEsMessageArbFileString);
556

557 558 559 560 561 562
      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator
          ..initialize(
            inputPathString: defaultL10nPathString,
563
            outputPathString: fs.path.join('lib', 'l10n', 'output'),
564 565 566 567 568 569 570 571 572 573
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
            useSyntheticPackage: false,
          )
          ..loadResources()
          ..writeOutputFiles();
      } on L10nException catch (e) {
        fail('Generating output should not fail: \n${e.message}');
      }
574

575 576 577 578 579 580 581 582 583 584 585 586 587
      final Directory outputDirectory = fs.directory('lib').childDirectory('l10n').childDirectory('output');
      expect(outputDirectory.existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file.dart').existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file_en.dart').existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file_es.dart').existsSync(), isTrue);
    },
  );

  test(
    'correctly creates output directory if it does not exist and writes files '
    'in it while not using the synthetic package option',
    () {
      _standardFlutterDirectoryL10nSetup(fs);
588

589 590 591 592 593 594
      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator
          ..initialize(
            inputPathString: defaultL10nPathString,
595
            outputPathString: fs.path.join('lib', 'l10n', 'output'),
596 597 598 599 600 601 602 603 604 605
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
            useSyntheticPackage: false,
          )
          ..loadResources()
          ..writeOutputFiles();
      } on L10nException catch (e) {
        fail('Generating output should not fail: \n${e.message}');
      }
606

607 608 609 610 611 612 613
      final Directory outputDirectory = fs.directory('lib').childDirectory('l10n').childDirectory('output');
      expect(outputDirectory.existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file.dart').existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file_en.dart').existsSync(), isTrue);
      expect(outputDirectory.childFile('output-localization-file_es.dart').existsSync(), isTrue);
    },
  );
614

615 616 617 618 619 620 621 622 623 624 625 626
  test('creates list of inputs and outputs when file path is specified', () {
    _standardFlutterDirectoryL10nSetup(fs);

    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator
        ..initialize(
          inputPathString: defaultL10nPathString,
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
627
          inputsAndOutputsListPath: syntheticPackagePath,
628 629 630 631 632 633 634
        )
        ..loadResources()
        ..writeOutputFiles();
    } on L10nException catch (e) {
      fail('Generating output should not fail: \n${e.message}');
    }

635
    final File inputsAndOutputsList = fs.file(
636
      fs.path.join(syntheticPackagePath, 'gen_l10n_inputs_and_outputs.json'),
637
    );
638 639 640 641 642 643 644 645 646 647
    expect(inputsAndOutputsList.existsSync(), isTrue);

    final Map<String, dynamic> jsonResult = json.decode(inputsAndOutputsList.readAsStringSync()) as Map<String, dynamic>;
    expect(jsonResult.containsKey('inputs'), isTrue);
    final List<dynamic> inputList = jsonResult['inputs'] as List<dynamic>;
    expect(inputList, contains(fs.path.absolute('lib', 'l10n', 'app_en.arb')));
    expect(inputList, contains(fs.path.absolute('lib', 'l10n', 'app_es.arb')));

    expect(jsonResult.containsKey('outputs'), isTrue);
    final List<dynamic> outputList = jsonResult['outputs'] as List<dynamic>;
648 649 650
    expect(outputList, contains(fs.path.absolute(syntheticPackagePath, 'output-localization-file.dart')));
    expect(outputList, contains(fs.path.absolute(syntheticPackagePath, 'output-localization-file_en.dart')));
    expect(outputList, contains(fs.path.absolute(syntheticPackagePath, 'output-localization-file_es.dart')));
651 652
  });

653 654 655 656 657 658 659 660 661 662 663
  test('setting both a headerString and a headerFile should fail', () {
    fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
      ..createSync(recursive: true)
      ..childFile(defaultTemplateArbFileName).writeAsStringSync(singleMessageArbFileString)
      ..childFile(esArbFileName).writeAsStringSync(singleEsMessageArbFileString)
      ..childFile('header.txt').writeAsStringSync('/// Sample header in a text file');

    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator.initialize(
664 665
        inputPathString: defaultL10nPathString,
        outputPathString: defaultL10nPathString,
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
        templateArbFileName: defaultTemplateArbFileName,
        outputFileString: defaultOutputFileString,
        classNameString: defaultClassNameString,
        headerString: '/// Sample header for localizations file.',
        headerFile: 'header.txt',
      );
    } on L10nException catch (e) {
      expect(e.message, contains('Cannot accept both header and header file arguments'));
      return;
    }

    fail('Setting both headerFile and headerString should fail');
  });

  test('setting a headerFile that does not exist should fail', () {
    final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
      ..createSync(recursive: true);
    l10nDirectory.childFile(defaultTemplateArbFileName)
      .writeAsStringSync(singleMessageArbFileString);
    l10nDirectory.childFile(esArbFileName)
      .writeAsStringSync(singleEsMessageArbFileString);
    l10nDirectory.childFile('header.txt')
      .writeAsStringSync('/// Sample header in a text file');

    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator.initialize(
694 695
        inputPathString: defaultL10nPathString,
        outputPathString: defaultL10nPathString,
696 697 698 699 700 701 702 703 704 705 706 707 708
        templateArbFileName: defaultTemplateArbFileName,
        outputFileString: defaultOutputFileString,
        classNameString: defaultClassNameString,
        headerFile: 'header.tx', // Intentionally spelled incorrectly
      );
    } on L10nException catch (e) {
      expect(e.message, contains('Failed to read header file'));
      return;
    }

    fail('Setting headerFile that does not exist should fail');
  });

709 710 711 712 713 714 715
  test('setting useDefferedLoading to null should fail', () {
    _standardFlutterDirectoryL10nSetup(fs);

    LocalizationsGenerator generator;
    try {
      generator = LocalizationsGenerator(fs);
      generator.initialize(
716 717
        inputPathString: defaultL10nPathString,
        outputPathString: defaultL10nPathString,
718 719 720 721 722 723 724 725 726 727 728 729 730 731
        templateArbFileName: defaultTemplateArbFileName,
        outputFileString: defaultOutputFileString,
        classNameString: defaultClassNameString,
        headerString: '/// Sample header',
        useDeferredLoading: null,
      );
    } on L10nException catch (e) {
      expect(e.message, contains('useDeferredLoading argument cannot be null.'));
      return;
    }

    fail('Setting useDefferedLoading to null should fail');
  });

732
  group('loadResources', () {
733 734 735 736 737 738 739
    test('correctly initializes supportedLocales and supportedLanguageCodes properties', () {
      _standardFlutterDirectoryL10nSetup(fs);

      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator.initialize(
740 741
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
742 743 744 745
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
746
        generator.loadResources();
747
      } on L10nException catch (e) {
748
        fail('Setting language and locales should not fail: \n${e.message}');
749 750
      }

751
      expect(generator.supportedLocales.contains(LocaleInfo.fromString('en')), true);
752 753 754
      expect(generator.supportedLocales.contains(LocaleInfo.fromString('es')), true);
    });

755 756 757 758 759 760 761 762
    test('correctly sorts supportedLocales and supportedLanguageCodes alphabetically', () {
      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
      // Write files in non-alphabetical order so that read performs in that order
      l10nDirectory.childFile('app_zh.arb')
        .writeAsStringSync(singleZhMessageArbFileString);
      l10nDirectory.childFile('app_es.arb')
        .writeAsStringSync(singleEsMessageArbFileString);
763
      l10nDirectory.childFile('app_en.arb')
764 765 766 767 768 769
        .writeAsStringSync(singleMessageArbFileString);

      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator.initialize(
770 771
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
772 773 774 775
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
776
        generator.loadResources();
777
      } on L10nException catch (e) {
778
        fail('Setting language and locales should not fail: \n${e.message}');
779 780
      }

781
      expect(generator.supportedLocales.first, LocaleInfo.fromString('en'));
782 783 784 785
      expect(generator.supportedLocales.elementAt(1), LocaleInfo.fromString('es'));
      expect(generator.supportedLocales.elementAt(2), LocaleInfo.fromString('zh'));
    });

786 787 788
    test('adds preferred locales to the top of supportedLocales and supportedLanguageCodes', () {
      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
789
      l10nDirectory.childFile('app_en.arb')
790 791 792 793 794 795
        .writeAsStringSync(singleMessageArbFileString);
      l10nDirectory.childFile('app_es.arb')
        .writeAsStringSync(singleEsMessageArbFileString);
      l10nDirectory.childFile('app_zh.arb')
        .writeAsStringSync(singleZhMessageArbFileString);

796
      const List<String> preferredSupportedLocale = <String>['zh', 'es'];
797 798 799 800
      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator.initialize(
801 802
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
803 804 805
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
806
          preferredSupportedLocale: preferredSupportedLocale,
807
        );
808
        generator.loadResources();
809
      } on L10nException catch (e) {
810
        fail('Setting language and locales should not fail: \n${e.message}');
811 812 813 814
      }

      expect(generator.supportedLocales.first, LocaleInfo.fromString('zh'));
      expect(generator.supportedLocales.elementAt(1), LocaleInfo.fromString('es'));
815
      expect(generator.supportedLocales.elementAt(2), LocaleInfo.fromString('en'));
816 817 818 819 820 821 822 823 824
    });

    test(
      'throws an error attempting to add preferred locales '
      'when there is no corresponding arb file for that '
      'locale',
      () {
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
825
        l10nDirectory.childFile('app_en.arb')
826 827 828 829 830 831
          .writeAsStringSync(singleMessageArbFileString);
        l10nDirectory.childFile('app_es.arb')
          .writeAsStringSync(singleEsMessageArbFileString);
        l10nDirectory.childFile('app_zh.arb')
          .writeAsStringSync(singleZhMessageArbFileString);

832
        const List<String> preferredSupportedLocale = <String>['am', 'es'];
833 834 835 836
        LocalizationsGenerator generator;
        try {
          generator = LocalizationsGenerator(fs);
          generator.initialize(
837 838
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
839 840 841
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
842
            preferredSupportedLocale: preferredSupportedLocale,
843
          );
844
          generator.loadResources();
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
        } on L10nException catch (e) {
          expect(
            e.message,
            contains("The preferred supported locale, 'am', cannot be added."),
          );
          return;
        }

        fail(
          'Should fail since an unsupported locale was added '
          'to the preferredSupportedLocales list.'
        );
      },
    );

860 861 862 863 864 865 866 867
    test('correctly sorts arbPathString alphabetically', () {
      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
      // Write files in non-alphabetical order so that read performs in that order
      l10nDirectory.childFile('app_zh.arb')
        .writeAsStringSync(singleZhMessageArbFileString);
      l10nDirectory.childFile('app_es.arb')
        .writeAsStringSync(singleEsMessageArbFileString);
868
      l10nDirectory.childFile('app_en.arb')
869 870 871 872 873 874
        .writeAsStringSync(singleMessageArbFileString);

      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator.initialize(
875 876
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
877 878 879 880
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
881
        generator.loadResources();
882
      } on L10nException catch (e) {
883
        fail('Setting language and locales should not fail: \n${e.message}');
884 885
      }

886 887 888
      expect(generator.arbPathStrings.first, fs.path.join('lib', 'l10n', 'app_en.arb'));
      expect(generator.arbPathStrings.elementAt(1), fs.path.join('lib', 'l10n', 'app_es.arb'));
      expect(generator.arbPathStrings.elementAt(2), fs.path.join('lib', 'l10n', 'app_zh.arb'));
889 890
    });

891
    test('correctly parses @@locale property in arb file', () {
892 893
      const String arbFileWithEnLocale = '''
{
894
  "@@locale": "en",
895
  "title": "Title",
896
  "@title": {
897
    "description": "Title for the application"
898 899 900
  }
}''';

901 902
      const String arbFileWithZhLocale = '''
{
903
  "@@locale": "zh",
904
  "title": "标题",
905
  "@title": {
906
    "description": "Title for the application"
907 908 909 910 911 912 913 914 915 916 917 918 919 920
  }
}''';

      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
      l10nDirectory.childFile('first_file.arb')
        .writeAsStringSync(arbFileWithEnLocale);
      l10nDirectory.childFile('second_file.arb')
        .writeAsStringSync(arbFileWithZhLocale);

      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator.initialize(
921 922
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
923 924 925 926
          templateArbFileName: 'first_file.arb',
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
927
        generator.loadResources();
928
      } on L10nException catch (e) {
929
        fail('Setting language and locales should not fail: \n${e.message}');
930 931 932 933 934 935
      }

      expect(generator.supportedLocales.contains(LocaleInfo.fromString('en')), true);
      expect(generator.supportedLocales.contains(LocaleInfo.fromString('zh')), true);
    });

936
    test('correctly requires @@locale property in arb file to match the filename locale suffix', () {
937 938
      const String arbFileWithEnLocale = '''
{
939 940 941 942 943 944 945
  "@@locale": "en",
  "title": "Stocks",
  "@title": {
    "description": "Title for the Stocks application"
  }
}''';

946 947
      const String arbFileWithZhLocale = '''
{
948
  "@@locale": "zh",
949
  "title": "标题",
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
  "@title": {
    "description": "Title for the Stocks application"
  }
}''';

      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
      l10nDirectory.childFile('app_es.arb')
        .writeAsStringSync(arbFileWithEnLocale);
      l10nDirectory.childFile('app_am.arb')
        .writeAsStringSync(arbFileWithZhLocale);

      LocalizationsGenerator generator;
      try {
        generator = LocalizationsGenerator(fs);
        generator.initialize(
966 967
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
968 969 970 971
          templateArbFileName: 'app_es.arb',
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
972
        generator.loadResources();
973
      } on L10nException catch (e) {
974 975
        expect(e.message, contains('The locale specified in @@locale and the arb filename do not match.'));
        return;
976 977
      }

978 979 980 981
      fail(
        'An exception should occur if the @@locale and the filename extensions are '
        'defined but not matching.'
      );
982 983
    });

984
    test("throws when arb file's locale could not be determined", () {
985 986 987 988 989 990 991
      fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true)
        ..childFile('app.arb')
        .writeAsStringSync(singleMessageArbFileString);
      try {
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        generator.initialize(
992 993
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
994 995 996 997
          templateArbFileName: 'app.arb',
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
998
        generator.loadResources();
999 1000 1001 1002 1003 1004 1005 1006 1007 1008
      } on L10nException catch (e) {
        expect(e.message, contains('locale could not be determined'));
        return;
      }
      fail(
        'Since locale is not specified, setting languages and locales '
        'should fail'
      );
    });
    test('throws when the same locale is detected more than once', () {
1009 1010
      const String secondMessageArbFileString = '''
{
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
  "market": "MARKET",
  "@market": {
    "description": "Label for the Market tab"
  }
}''';

      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
      l10nDirectory.childFile('app_en.arb')
        .writeAsStringSync(singleMessageArbFileString);
      l10nDirectory.childFile('app2_en.arb')
        .writeAsStringSync(secondMessageArbFileString);

      try {
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        generator.initialize(
1027 1028
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
1029 1030 1031 1032
          templateArbFileName: 'app_en.arb',
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
1033
        generator.loadResources();
1034
      } on L10nException catch (e) {
1035
        expect(e.message, contains("Multiple arb files with the same 'en' locale detected"));
1036 1037 1038 1039 1040 1041 1042 1043
        return;
      }

      fail(
        'Since en locale is specified twice, setting languages and locales '
        'should fail'
      );
    });
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053

    test('throws when the base locale does not exist', () {
      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
      l10nDirectory.childFile('app_en_US.arb')
        .writeAsStringSync(singleMessageArbFileString);

      try {
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        generator.initialize(
1054 1055
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
          templateArbFileName: 'app_en_US.arb',
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
        generator.loadResources();
      } on L10nException catch (e) {
        expect(e.message, contains('Arb file for a fallback, en, does not exist'));
        return;
      }

      fail(
        'Since en_US.arb is specified, but en.arb is not, '
        'the tool should throw an error.'
      );
    });
1071 1072
  });

1073
  group('writeOutputFiles', () {
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
    test('should generate a file per language', () {
      const String singleEnCaMessageArbFileString = '''
{
  "title": "Canadian Title"
}''';
      fs.currentDirectory.childDirectory('lib').childDirectory('l10n')..createSync(recursive: true)
        ..childFile(defaultTemplateArbFileName).writeAsStringSync(singleMessageArbFileString)
        ..childFile('app_en_CA.arb').writeAsStringSync(singleEnCaMessageArbFileString);

      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.initialize(
1086 1087
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
1088 1089 1090 1091 1092
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
        generator.loadResources();
1093
        generator.writeOutputFiles();
1094 1095 1096 1097
      } on Exception catch (e) {
        fail('Generating output files should not fail: $e');
      }

1098 1099
      expect(fs.isFileSync(fs.path.join(syntheticPackagePath, 'output-localization-file_en.dart')), true);
      expect(fs.isFileSync(fs.path.join(syntheticPackagePath, 'output-localization-file_en_US.dart')), false);
1100 1101

      final String englishLocalizationsFile = fs.file(
1102
        fs.path.join(syntheticPackagePath, 'output-localization-file_en.dart')
1103 1104 1105 1106 1107
      ).readAsStringSync();
      expect(englishLocalizationsFile, contains('class AppLocalizationsEnCa extends AppLocalizationsEn'));
      expect(englishLocalizationsFile, contains('class AppLocalizationsEn extends AppLocalizations'));
    });

1108 1109 1110 1111 1112 1113
    test('language imports are sorted when preferredSupportedLocaleString is given', () {
      fs.currentDirectory.childDirectory('lib').childDirectory('l10n')..createSync(recursive: true)
        ..childFile(defaultTemplateArbFileName).writeAsStringSync(singleMessageArbFileString)
        ..childFile('app_zh.arb').writeAsStringSync(singleZhMessageArbFileString)
        ..childFile('app_es.arb').writeAsStringSync(singleEsMessageArbFileString);

1114
      const List<String> preferredSupportedLocale = <String>['zh'];
1115 1116 1117
      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.initialize(
1118 1119
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
1120 1121 1122
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
1123
          preferredSupportedLocale: preferredSupportedLocale,
1124 1125
        );
        generator.loadResources();
1126
        generator.writeOutputFiles();
1127 1128 1129 1130 1131
      } on Exception catch (e) {
        fail('Generating output files should not fail: $e');
      }

      final String localizationsFile = fs.file(
1132
        fs.path.join(syntheticPackagePath, defaultOutputFileString),
1133 1134 1135
      ).readAsStringSync();
      expect(localizationsFile, contains(
'''
1136 1137 1138
import 'output-localization-file_en.dart';
import 'output-localization-file_es.dart';
import 'output-localization-file_zh.dart';
1139 1140 1141
'''));
    });

1142
    test('imports are deferred and loaded when useDeferredImports are set', () {
1143 1144 1145 1146 1147 1148
      fs.currentDirectory.childDirectory('lib').childDirectory('l10n')..createSync(recursive: true)
        ..childFile(defaultTemplateArbFileName).writeAsStringSync(singleMessageArbFileString);

      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.initialize(
1149
          inputPathString: defaultL10nPathString,
1150 1151 1152 1153 1154 1155
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
          useDeferredLoading: true,
        );
        generator.loadResources();
1156
        generator.writeOutputFiles();
1157 1158 1159 1160 1161
      } on Exception catch (e) {
        fail('Generating output files should not fail: $e');
      }

      final String localizationsFile = fs.file(
1162
        fs.path.join(syntheticPackagePath, defaultOutputFileString),
1163 1164 1165
      ).readAsStringSync();
      expect(localizationsFile, contains(
'''
1166
import 'output-localization-file_en.dart' deferred as output-localization-file_en;
1167
'''));
1168
      expect(localizationsFile, contains('output-localization-file_en.loadLibrary()'));
1169 1170
    });

1171 1172
    group('DateTime tests', () {
      test('throws an exception when improperly formatted date is passed in', () {
1173 1174
        const String singleDateMessageArbFileString = '''
{
1175
  "@@locale": "en",
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
  "springBegins": "Spring begins on {springStartDate}",
  "@springBegins": {
      "description": "The first day of spring",
      "placeholders": {
          "springStartDate": {
              "type": "DateTime",
              "format": "asdf"
          }
      }
  }
}''';
1187 1188 1189 1190
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(singleDateMessageArbFileString);
1191

1192 1193 1194
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1195
            inputPathString: defaultL10nPathString,
1196 1197 1198 1199
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1200
          generator.loadResources();
1201
          generator.writeOutputFiles();
1202 1203 1204 1205 1206 1207
        } on L10nException catch (e) {
          expect(e.message, contains('asdf'));
          expect(e.message, contains('springStartDate'));
          expect(e.message, contains('does not have a corresponding DateFormat'));
          return;
        }
1208

1209 1210
        fail('Improper date formatting should throw an exception');
      });
1211

1212
      test('throws an exception when no format attribute is passed in', () {
1213 1214
        const String singleDateMessageArbFileString = '''
{
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
  "springBegins": "Spring begins on {springStartDate}",
  "@springBegins": {
      "description": "The first day of spring",
      "placeholders": {
          "springStartDate": {
              "type": "DateTime"
          }
      }
  }
}''';
1225 1226 1227 1228
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(singleDateMessageArbFileString);
1229

1230 1231 1232
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1233 1234
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1235 1236 1237 1238
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1239
          generator.loadResources();
1240
          generator.writeOutputFiles();
1241 1242 1243 1244
        } on L10nException catch (e) {
          expect(e.message, contains('the "format" attribute needs to be set'));
          return;
        }
1245

1246 1247
        fail('Improper date formatting should throw an exception');
      });
1248

1249
      test('throws an exception when improperly formatted number is passed in', () {
1250 1251
        const String singleDateMessageArbFileString = '''
{
1252 1253 1254 1255 1256
  "courseCompletion": "You have completed {progress} of the course.",
  "@courseCompletion": {
    "description": "The amount of progress the student has made in their class.",
    "placeholders": {
      "progress": {
1257
        "type": "double",
1258
        "format": "asdf"
1259
      }
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
    }
  }
}''';
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(singleDateMessageArbFileString);

        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1271 1272
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1273 1274 1275 1276
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1277
          generator.loadResources();
1278
          generator.writeOutputFiles();
1279 1280 1281 1282 1283 1284
        } on L10nException catch (e) {
          expect(e.message, contains('asdf'));
          expect(e.message, contains('progress'));
          expect(e.message, contains('does not have a corresponding NumberFormat'));
          return;
        }
1285

1286 1287
        fail('Improper date formatting should throw an exception');
      });
1288 1289
    });

1290
    group('plural messages', () {
1291
      test('should throw attempting to generate a plural message without placeholders', () {
1292 1293
        const String pluralMessageWithoutPlaceholdersAttribute = '''
{
1294 1295 1296 1297 1298 1299
  "helloWorlds": "{count,plural, =0{Hello}=1{Hello World}=2{Hello two worlds}few{Hello {count} worlds}many{Hello all {count} worlds}other{Hello other {count} worlds}}",
  "@helloWorlds": {
    "description": "Improperly formatted since it has no placeholder attribute."
  }
}''';

1300 1301 1302 1303
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(pluralMessageWithoutPlaceholdersAttribute);
1304

1305 1306 1307
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1308 1309
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1310 1311 1312 1313
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1314
          generator.loadResources();
1315
          generator.writeOutputFiles();
1316 1317 1318 1319 1320 1321
        } on L10nException catch (e) {
          expect(e.message, contains('Check to see if the plural message is in the proper ICU syntax format'));
          return;
        }
        fail('Generating class methods without placeholders should not succeed');
      });
1322

1323
      test('should throw attempting to generate a plural message with an empty placeholders map', () {
1324 1325
        const String pluralMessageWithEmptyPlaceholdersMap = '''
{
1326 1327 1328 1329 1330 1331 1332
  "helloWorlds": "{count,plural, =0{Hello}=1{Hello World}=2{Hello two worlds}few{Hello {count} worlds}many{Hello all {count} worlds}other{Hello other {count} worlds}}",
  "@helloWorlds": {
    "description": "Improperly formatted since it has no placeholder attribute.",
    "placeholders": {}
  }
}''';

1333 1334 1335 1336
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(pluralMessageWithEmptyPlaceholdersMap);
1337

1338 1339 1340
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1341 1342
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1343 1344 1345 1346
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1347
          generator.loadResources();
1348
          generator.writeOutputFiles();
1349 1350 1351 1352 1353 1354
        } on L10nException catch (e) {
          expect(e.message, contains('Check to see if the plural message is in the proper ICU syntax format'));
          return;
        }
        fail('Generating class methods without placeholders should not succeed');
      });
1355

1356
      test('should throw attempting to generate a plural message with no resource attributes', () {
1357 1358
        const String pluralMessageWithoutResourceAttributes = '''
{
1359 1360 1361
  "helloWorlds": "{count,plural, =0{Hello}=1{Hello World}=2{Hello two worlds}few{Hello {count} worlds}many{Hello all {count} worlds}other{Hello other {count} worlds}}"
}''';

1362 1363 1364 1365
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(pluralMessageWithoutResourceAttributes);
1366

1367 1368 1369
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1370 1371
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1372 1373 1374 1375
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1376
          generator.loadResources();
1377
          generator.writeOutputFiles();
1378
        } on L10nException catch (e) {
1379
          expect(e.message, contains('Resource attribute "@helloWorlds" was not found'));
1380 1381 1382 1383
          return;
        }
        fail('Generating plural class method without resource attributes should not succeed');
      });
1384

1385
      test('should throw attempting to generate a plural message with incorrect format for placeholders', () {
1386 1387
        const String pluralMessageWithIncorrectPlaceholderFormat = '''
{
1388 1389 1390 1391 1392 1393
  "helloWorlds": "{count,plural, =0{Hello}=1{Hello World}=2{Hello two worlds}few{Hello {count} worlds}many{Hello all {count} worlds}other{Hello other {count} worlds}}",
  "@helloWorlds": {
    "placeholders": "Incorrectly a string, should be a map."
  }
}''';

1394 1395 1396 1397
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(pluralMessageWithIncorrectPlaceholderFormat);
1398

1399 1400 1401
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1402 1403
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1404 1405 1406 1407
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1408
          generator.loadResources();
1409
          generator.writeOutputFiles();
1410 1411
        } on L10nException catch (e) {
          expect(e.message, contains('is not properly formatted'));
1412
          expect(e.message, contains('Ensure that it is a map with string valued keys'));
1413 1414 1415 1416
          return;
        }
        fail('Generating class methods with incorrect placeholder format should not succeed');
      });
1417 1418
    });

1419 1420 1421 1422 1423
    test(
      'should throw with descriptive error message when failing to parse the '
      'arb file',
      () {
        const String arbFileWithTrailingComma = '''
1424
{
1425 1426 1427 1428 1429
  "title": "Stocks",
  "@title": {
    "description": "Title for the Stocks application"
  },
}''';
1430 1431 1432 1433
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(arbFileWithTrailingComma);
1434

1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451
        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
          generator.loadResources();
          generator.writeOutputFiles();
        } on L10nException catch (e) {
          expect(e.message, contains('app_en.arb'));
          expect(e.message, contains('FormatException'));
          expect(e.message, contains('Unexpected character'));
          return;
        }
1452

1453 1454 1455 1456 1457 1458
        fail(
          'should fail with an L10nException due to a trailing comma in the '
          'arb file.'
        );
      },
    );
1459

1460
    test('should throw when resource is missing resource attribute', () {
1461 1462
      const String arbFileWithMissingResourceAttribute = '''
{
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
  "title": "Stocks"
}''';
      final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
        ..createSync(recursive: true);
      l10nDirectory.childFile(defaultTemplateArbFileName)
        .writeAsStringSync(arbFileWithMissingResourceAttribute);

      final LocalizationsGenerator generator = LocalizationsGenerator(fs);
      try {
        generator.initialize(
1473 1474
          inputPathString: defaultL10nPathString,
          outputPathString: defaultL10nPathString,
1475 1476 1477 1478
          templateArbFileName: defaultTemplateArbFileName,
          outputFileString: defaultOutputFileString,
          classNameString: defaultClassNameString,
        );
1479
        generator.loadResources();
1480
        generator.writeOutputFiles();
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
      } on L10nException catch (e) {
        expect(e.message, contains('Resource attribute "@title" was not found'));
        return;
      }

      fail(
        'should fail with a FormatException due to a trailing comma in the '
        'arb file.'
      );
    });

    group('checks for method/getter formatting', () {
      test('cannot contain non-alphanumeric symbols', () {
1494 1495
        const String nonAlphaNumericArbFile = '''
{
1496 1497 1498 1499 1500
  "title!!": "Stocks",
  "@title!!": {
    "description": "Title for the Stocks application"
  }
}''';
1501 1502 1503 1504 1505 1506 1507 1508
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(nonAlphaNumericArbFile);

        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1509 1510
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1511 1512 1513 1514
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1515
          generator.loadResources();
1516
          generator.writeOutputFiles();
1517
        } on L10nException catch (e) {
1518
          expect(e.message, contains('Invalid ARB resource name'));
1519 1520 1521 1522 1523 1524 1525
          return;
        }

        fail('should fail due to non-alphanumeric character.');
      });

      test('must start with lowercase character', () {
1526 1527
        const String nonAlphaNumericArbFile = '''
{
1528 1529 1530 1531 1532
  "Title": "Stocks",
  "@Title": {
    "description": "Title for the Stocks application"
  }
}''';
1533 1534 1535 1536 1537 1538 1539 1540
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(nonAlphaNumericArbFile);

        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1541 1542
            inputPathString: defaultL10nPathString,
            outputPathString: defaultL10nPathString,
1543 1544 1545 1546
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1547
          generator.loadResources();
1548
          generator.writeOutputFiles();
1549
        } on L10nException catch (e) {
1550
          expect(e.message, contains('Invalid ARB resource name'));
1551 1552 1553 1554 1555 1556 1557
          return;
        }

        fail('should fail since key starts with a non-lowercase.');
      });

      test('cannot start with a number', () {
1558 1559
        const String nonAlphaNumericArbFile = '''
{
1560 1561 1562 1563 1564
  "123title": "Stocks",
  "@123title": {
    "description": "Title for the Stocks application"
  }
}''';
1565 1566 1567 1568 1569 1570 1571 1572
        final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n')
          ..createSync(recursive: true);
        l10nDirectory.childFile(defaultTemplateArbFileName)
          .writeAsStringSync(nonAlphaNumericArbFile);

        final LocalizationsGenerator generator = LocalizationsGenerator(fs);
        try {
          generator.initialize(
1573
            inputPathString: defaultL10nPathString,
1574 1575 1576 1577
            templateArbFileName: defaultTemplateArbFileName,
            outputFileString: defaultOutputFileString,
            classNameString: defaultClassNameString,
          );
1578
          generator.loadResources();
1579
          generator.writeOutputFiles();
1580
        } on L10nException catch (e) {
1581
          expect(e.message, contains('Invalid ARB resource name'));
1582 1583 1584 1585 1586 1587 1588 1589
          return;
        }

        fail('should fail since key starts with a number.');
      });
    });
  });
}