// 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 'dart:convert'; import 'dart:io'; import 'package:file/file.dart'; import 'package:file/memory.dart'; import 'package:path/path.dart' as path; import '../../localization/gen_l10n.dart'; import '../../localization/gen_l10n_types.dart'; import '../../localization/localizations_utils.dart'; import '../common.dart'; final String defaultL10nPathString = path.join('lib', 'l10n'); const String defaultTemplateArbFileName = 'app_en.arb'; const String defaultOutputFileString = 'output-localization-file.dart'; const String defaultClassNameString = 'AppLocalizations'; const String singleMessageArbFileString = ''' { "title": "Title", "@title": { "description": "Title for the application" } }'''; const String twoMessageArbFileString = ''' { "title": "Title", "@title": { "description": "Title for the application" }, "subtitle": "Subtitle", "@subtitle": { "description": "Subtitle for the application" } }'''; const String esArbFileName = 'app_es.arb'; const String singleEsMessageArbFileString = ''' { "title": "Título" }'''; const String singleZhMessageArbFileString = ''' { "title": "标题" }'''; 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; setUp(() { fs = MemoryFileSystem( style: Platform.isWindows ? FileSystemStyle.windows : FileSystemStyle.posix ); precacheLanguageAndRegionTags(); }); group('Setters', () { test('setInputDirectory fails if the directory does not exist', () { final LocalizationsGenerator generator = LocalizationsGenerator(fs); try { generator.setInputDirectory('lib'); } on FileSystemException catch (e) { expect(e.message, contains('Make sure that the correct path was provided')); return; } fail( 'LocalizationsGenerator.setInputDirectory should fail if the ' 'directory does not exist.' ); }); test('setInputDirectory fails if input string is null', () { _standardFlutterDirectoryL10nSetup(fs); final LocalizationsGenerator generator = LocalizationsGenerator(fs); try { generator.setInputDirectory(null); } on L10nException catch (e) { expect(e.message, contains('cannot be null')); return; } fail( 'LocalizationsGenerator.setInputDirectory should fail if the ' 'input string is null.' ); }); test('setOutputDirectory fails if output string is null', () { _standardFlutterDirectoryL10nSetup(fs); final LocalizationsGenerator generator = LocalizationsGenerator(fs); try { generator.setOutputDirectory(null); } on L10nException catch (e) { expect(e.message, contains('cannot be null')); return; } fail( 'LocalizationsGenerator.setOutputDirectory should fail if the ' 'input string is null.' ); }); test('setTemplateArbFile fails if inputDirectory is null', () { final LocalizationsGenerator generator = LocalizationsGenerator(fs); try { generator.setTemplateArbFile(defaultTemplateArbFileName); } on L10nException catch (e) { expect(e.message, contains('cannot be null')); return; } fail( 'LocalizationsGenerator.setTemplateArbFile should fail if the ' 'inputDirectory is not specified.' ); }); 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( 'LocalizationsGenerator.setTemplateArbFile should fail if the ' 'templateArbFileName passed in is null.' ); }); 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( 'LocalizationsGenerator.setTemplateArbFile should fail if the ' 'input string is null.' ); }); test('setBaseOutputFile fails if input string is null', () { _standardFlutterDirectoryL10nSetup(fs); final LocalizationsGenerator generator = LocalizationsGenerator(fs); try { generator.setBaseOutputFile(null); } on L10nException catch (e) { expect(e.message, contains('cannot be null')); return; } fail( 'LocalizationsGenerator.setBaseOutputFile should fail if the ' 'input string is null.' ); }); 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( 'LocalizationsGenerator.className should fail if the ' 'input string is null.' ); }); group('className should only take valid Dart class names', () { LocalizationsGenerator generator; setUp(() { _standardFlutterDirectoryL10nSetup(fs); generator = LocalizationsGenerator(fs); try { generator.setInputDirectory(defaultL10nPathString); generator.setOutputDirectory(defaultL10nPathString); generator.setTemplateArbFile(defaultTemplateArbFileName); generator.setBaseOutputFile(defaultOutputFileString); } 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) { expect(e.message, contains('is not a valid public Dart class name')); return; } fail( 'LocalizationsGenerator.className should fail if the ' 'input string is not a valid Dart class name.' ); }); test('fails on non-alphanumeric symbols', () { try { generator.className = 'TestClass@123'; } on L10nException catch (e) { expect(e.message, contains('is not a valid public Dart class name')); return; } fail( 'LocalizationsGenerator.className should fail if the ' 'input string is not a valid public Dart class name.' ); }); test('fails on camel-case', () { try { generator.className = 'camelCaseClassName'; } on L10nException catch (e) { expect(e.message, contains('is not a valid public Dart class name')); return; } fail( 'LocalizationsGenerator.className should fail if the ' 'input string is not a valid public Dart class name.' ); }); test('fails when starting with a number', () { try { generator.className = '123ClassName'; } on L10nException catch (e) { expect(e.message, contains('is not a valid public Dart class name')); return; } fail( 'LocalizationsGenerator.className should fail if the ' 'input string is not a valid public Dart class name.' ); }); }); }); test('correctly adds a headerString when it is set', () { _standardFlutterDirectoryL10nSetup(fs); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, 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'); }); 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ) ..loadResources() ..writeOutputFiles() ..outputUnimplementedMessages(path.join('lib', 'l10n', 'unimplemented_message_translations.json')); } on L10nException catch (e) { fail('Generating output should not fail: \n${e.message}'); } final File unimplementedOutputFile = fs.file( path.join('lib', 'l10n', 'unimplemented_message_translations.json'), ); 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')); }); test('uses inputPathString as outputPathString when the outputPathString is null', () { _standardFlutterDirectoryL10nSetup(fs); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator ..initialize( inputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ) ..loadResources() ..writeOutputFiles(); } on L10nException catch (e) { fail('Generating output should not fail: \n${e.message}'); } 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', () { final Directory l10nDirectory = fs.currentDirectory .childDirectory('lib') .childDirectory('l10n') ..createSync(recursive: true); // Create the directory 'lib/l10n/output'. l10nDirectory.childDirectory('output'); l10nDirectory .childFile(defaultTemplateArbFileName) .writeAsStringSync(singleMessageArbFileString); l10nDirectory .childFile(esArbFileName) .writeAsStringSync(singleEsMessageArbFileString); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator ..initialize( inputPathString: defaultL10nPathString, outputPathString: path.join('lib', 'l10n', 'output'), templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ) ..loadResources() ..writeOutputFiles(); } on L10nException catch (e) { fail('Generating output should not fail: \n${e.message}'); } 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', () { _standardFlutterDirectoryL10nSetup(fs); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator ..initialize( inputPathString: defaultL10nPathString, outputPathString: path.join('lib', 'l10n', 'output'), templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ) ..loadResources() ..writeOutputFiles(); } on L10nException catch (e) { fail('Generating output should not fail: \n${e.message}'); } 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('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, inputsAndOutputsListPath: defaultL10nPathString, ) ..loadResources() ..writeOutputFiles(); } on L10nException catch (e) { fail('Generating output should not fail: \n${e.message}'); } final File inputsAndOutputsList = fs .directory('lib') .childDirectory('l10n') .childFile('gen_l10n_inputs_and_outputs.json'); expect(inputsAndOutputsList.existsSync(), isTrue); final Map jsonResult = json.decode(inputsAndOutputsList.readAsStringSync()) as Map; expect(jsonResult.containsKey('inputs'), isTrue); final List inputList = jsonResult['inputs'] as List; 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 outputList = jsonResult['outputs'] as List; expect(outputList, contains(fs.path.absolute('lib', 'l10n', 'output-localization-file.dart'))); expect(outputList, contains(fs.path.absolute('lib', 'l10n', 'output-localization-file_en.dart'))); expect(outputList, contains(fs.path.absolute('lib', 'l10n', 'output-localization-file_es.dart'))); }); 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, 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'); }); test('setting useDefferedLoading to null should fail', () { _standardFlutterDirectoryL10nSetup(fs); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, 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'); }); group('loadResources', () { test('correctly initializes supportedLocales and supportedLanguageCodes properties', () { _standardFlutterDirectoryL10nSetup(fs); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); } on L10nException catch (e) { fail('Setting language and locales should not fail: \n${e.message}'); } expect(generator.supportedLocales.contains(LocaleInfo.fromString('en')), true); expect(generator.supportedLocales.contains(LocaleInfo.fromString('es')), true); }); 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); l10nDirectory.childFile('app_en.arb') .writeAsStringSync(singleMessageArbFileString); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); } on L10nException catch (e) { fail('Setting language and locales should not fail: \n${e.message}'); } expect(generator.supportedLocales.first, LocaleInfo.fromString('en')); expect(generator.supportedLocales.elementAt(1), LocaleInfo.fromString('es')); expect(generator.supportedLocales.elementAt(2), LocaleInfo.fromString('zh')); }); test('adds preferred locales to the top of supportedLocales and supportedLanguageCodes', () { final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true); l10nDirectory.childFile('app_en.arb') .writeAsStringSync(singleMessageArbFileString); l10nDirectory.childFile('app_es.arb') .writeAsStringSync(singleEsMessageArbFileString); l10nDirectory.childFile('app_zh.arb') .writeAsStringSync(singleZhMessageArbFileString); const String preferredSupportedLocaleString = '["zh", "es"]'; LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, preferredSupportedLocaleString: preferredSupportedLocaleString, ); generator.loadResources(); } on L10nException catch (e) { fail('Setting language and locales should not fail: \n${e.message}'); } expect(generator.supportedLocales.first, LocaleInfo.fromString('zh')); expect(generator.supportedLocales.elementAt(1), LocaleInfo.fromString('es')); expect(generator.supportedLocales.elementAt(2), LocaleInfo.fromString('en')); }); test( 'throws an error attempting to add preferred locales ' 'with incorrect runtime type', () { final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true); l10nDirectory.childFile('app_en.arb') .writeAsStringSync(singleMessageArbFileString); l10nDirectory.childFile('app_es.arb') .writeAsStringSync(singleEsMessageArbFileString); l10nDirectory.childFile('app_zh.arb') .writeAsStringSync(singleZhMessageArbFileString); const String preferredSupportedLocaleString = '[44, "en"]'; LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, preferredSupportedLocaleString: preferredSupportedLocaleString, ); generator.loadResources(); } on L10nException catch (e) { expect( e.message, contains('Incorrect runtime type'), ); return; } fail( 'Should fail since an incorrect runtime type was used ' 'in the preferredSupportedLocales list.' ); }, ); 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); l10nDirectory.childFile('app_en.arb') .writeAsStringSync(singleMessageArbFileString); l10nDirectory.childFile('app_es.arb') .writeAsStringSync(singleEsMessageArbFileString); l10nDirectory.childFile('app_zh.arb') .writeAsStringSync(singleZhMessageArbFileString); const String preferredSupportedLocaleString = '["am", "es"]'; LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, preferredSupportedLocaleString: preferredSupportedLocaleString, ); generator.loadResources(); } 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.' ); }, ); 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); l10nDirectory.childFile('app_en.arb') .writeAsStringSync(singleMessageArbFileString); LocalizationsGenerator generator; try { generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); } on L10nException catch (e) { fail('Setting language and locales should not fail: \n${e.message}'); } expect(generator.arbPathStrings.first, path.join('lib', 'l10n', 'app_en.arb')); expect(generator.arbPathStrings.elementAt(1), path.join('lib', 'l10n', 'app_es.arb')); expect(generator.arbPathStrings.elementAt(2), path.join('lib', 'l10n', 'app_zh.arb')); }); test('correctly parses @@locale property in arb file', () { const String arbFileWithEnLocale = ''' { "@@locale": "en", "title": "Title", "@title": { "description": "Title for the application" } }'''; const String arbFileWithZhLocale = ''' { "@@locale": "zh", "title": "标题", "@title": { "description": "Title for the application" } }'''; 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: 'first_file.arb', outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); } on L10nException catch (e) { fail('Setting language and locales should not fail: \n${e.message}'); } expect(generator.supportedLocales.contains(LocaleInfo.fromString('en')), true); expect(generator.supportedLocales.contains(LocaleInfo.fromString('zh')), true); }); test('correctly prioritizes @@locale property in arb file over filename', () { const String arbFileWithEnLocale = ''' { "@@locale": "en", "title": "Stocks", "@title": { "description": "Title for the Stocks application" } }'''; const String arbFileWithZhLocale = ''' { "@@locale": "zh", "title": "标题", "@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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: 'app_es.arb', outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); } on L10nException catch (e) { fail('Setting language and locales should not fail: \n${e.message}'); } // @@locale property should hold higher priority expect(generator.supportedLocales.contains(LocaleInfo.fromString('en')), true); expect(generator.supportedLocales.contains(LocaleInfo.fromString('zh')), true); // filename should not be used since @@locale is specified expect(generator.supportedLocales.contains(LocaleInfo.fromString('es')), false); expect(generator.supportedLocales.contains(LocaleInfo.fromString('am')), false); }); test("throws when arb file's locale could not be determined", () { fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true) ..childFile('app.arb') .writeAsStringSync(singleMessageArbFileString); try { final LocalizationsGenerator generator = LocalizationsGenerator(fs); generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: 'app.arb', outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); } 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', () { const String secondMessageArbFileString = ''' { "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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: 'app_en.arb', outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); } on L10nException catch (e) { expect(e.message, contains("Multiple arb files with the same 'en' locale detected")); return; } fail( 'Since en locale is specified twice, setting languages and locales ' 'should fail' ); }); 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, 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.' ); }); }); group('writeOutputFiles', () { 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } on Exception catch (e) { fail('Generating output files should not fail: $e'); } expect(fs.isFileSync(path.join('lib', 'l10n', 'output-localization-file_en.dart')), true); expect(fs.isFileSync(path.join('lib', 'l10n', 'output-localization-file_en_US.dart')), false); final String englishLocalizationsFile = fs.file( path.join('lib', 'l10n', 'output-localization-file_en.dart') ).readAsStringSync(); expect(englishLocalizationsFile, contains('class AppLocalizationsEnCa extends AppLocalizationsEn')); expect(englishLocalizationsFile, contains('class AppLocalizationsEn extends AppLocalizations')); }); 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); const String preferredSupportedLocaleString = '["zh"]'; final LocalizationsGenerator generator = LocalizationsGenerator(fs); try { generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, preferredSupportedLocaleString: preferredSupportedLocaleString, ); generator.loadResources(); generator.writeOutputFiles(); } on Exception catch (e) { fail('Generating output files should not fail: $e'); } final String localizationsFile = fs.file( path.join('lib', 'l10n', defaultOutputFileString), ).readAsStringSync(); expect(localizationsFile, contains( ''' import 'output-localization-file_en.dart'; import 'output-localization-file_es.dart'; import 'output-localization-file_zh.dart'; ''')); }); test('imports are deferred and loaded when useDeferredImports are set', () { fs.currentDirectory.childDirectory('lib').childDirectory('l10n')..createSync(recursive: true) ..childFile(defaultTemplateArbFileName).writeAsStringSync(singleMessageArbFileString); final LocalizationsGenerator generator = LocalizationsGenerator(fs); try { generator.initialize( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, useDeferredLoading: true, ); generator.loadResources(); generator.writeOutputFiles(); } on Exception catch (e) { fail('Generating output files should not fail: $e'); } final String localizationsFile = fs.file( path.join('lib', 'l10n', defaultOutputFileString), ).readAsStringSync(); expect(localizationsFile, contains( ''' import 'output-localization-file_en.dart' deferred as output-localization-file_en; ''')); expect(localizationsFile, contains('output-localization-file_en.loadLibrary()')); }); group('DateTime tests', () { test('throws an exception when improperly formatted date is passed in', () { const String singleDateMessageArbFileString = ''' { "@@locale": "en", "springBegins": "Spring begins on {springStartDate}", "@springBegins": { "description": "The first day of spring", "placeholders": { "springStartDate": { "type": "DateTime", "format": "asdf" } } } }'''; 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } 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; } fail('Improper date formatting should throw an exception'); }); test('throws an exception when no format attribute is passed in', () { const String singleDateMessageArbFileString = ''' { "springBegins": "Spring begins on {springStartDate}", "@springBegins": { "description": "The first day of spring", "placeholders": { "springStartDate": { "type": "DateTime" } } } }'''; 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } on L10nException catch (e) { expect(e.message, contains('the "format" attribute needs to be set')); return; } fail('Improper date formatting should throw an exception'); }); test('throws an exception when improperly formatted number is passed in', () { const String singleDateMessageArbFileString = ''' { "courseCompletion": "You have completed {progress} of the course.", "@courseCompletion": { "description": "The amount of progress the student has made in their class.", "placeholders": { "progress": { "type": "double", "format": "asdf" } } } }'''; 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } 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; } fail('Improper date formatting should throw an exception'); }); }); group('plural messages', () { test('should throw attempting to generate a plural message without placeholders', () { const String pluralMessageWithoutPlaceholdersAttribute = ''' { "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." } }'''; final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true); l10nDirectory.childFile(defaultTemplateArbFileName) .writeAsStringSync(pluralMessageWithoutPlaceholdersAttribute); 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('Check to see if the plural message is in the proper ICU syntax format')); return; } fail('Generating class methods without placeholders should not succeed'); }); test('should throw attempting to generate a plural message with an empty placeholders map', () { const String pluralMessageWithEmptyPlaceholdersMap = ''' { "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": {} } }'''; final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true); l10nDirectory.childFile(defaultTemplateArbFileName) .writeAsStringSync(pluralMessageWithEmptyPlaceholdersMap); 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('Check to see if the plural message is in the proper ICU syntax format')); return; } fail('Generating class methods without placeholders should not succeed'); }); test('should throw attempting to generate a plural message with no resource attributes', () { const String pluralMessageWithoutResourceAttributes = ''' { "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}}" }'''; final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true); l10nDirectory.childFile(defaultTemplateArbFileName) .writeAsStringSync(pluralMessageWithoutResourceAttributes); 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('Resource attribute "@helloWorlds" was not found')); return; } fail('Generating plural class method without resource attributes should not succeed'); }); test('should throw attempting to generate a plural message with incorrect format for placeholders', () { const String pluralMessageWithIncorrectPlaceholderFormat = ''' { "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." } }'''; final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true); l10nDirectory.childFile(defaultTemplateArbFileName) .writeAsStringSync(pluralMessageWithIncorrectPlaceholderFormat); 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('is not properly formatted')); expect(e.message, contains('Ensure that it is a map with string valued keys')); return; } fail('Generating class methods with incorrect placeholder format should not succeed'); }); }); test( 'should throw with descriptive error message when failing to parse the ' 'arb file', () { const String arbFileWithTrailingComma = ''' { "title": "Stocks", "@title": { "description": "Title for the Stocks application" }, }'''; final Directory l10nDirectory = fs.currentDirectory.childDirectory('lib').childDirectory('l10n') ..createSync(recursive: true); l10nDirectory.childFile(defaultTemplateArbFileName) .writeAsStringSync(arbFileWithTrailingComma); 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; } fail( 'should fail with an L10nException due to a trailing comma in the ' 'arb file.' ); }, ); test('should throw when resource is missing resource attribute', () { const String arbFileWithMissingResourceAttribute = ''' { "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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } 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', () { const String nonAlphaNumericArbFile = ''' { "title!!": "Stocks", "@title!!": { "description": "Title for the Stocks application" } }'''; 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } on L10nException catch (e) { expect(e.message, contains('Invalid ARB resource name')); return; } fail('should fail due to non-alphanumeric character.'); }); test('must start with lowercase character', () { const String nonAlphaNumericArbFile = ''' { "Title": "Stocks", "@Title": { "description": "Title for the Stocks application" } }'''; 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } on L10nException catch (e) { expect(e.message, contains('Invalid ARB resource name')); return; } fail('should fail since key starts with a non-lowercase.'); }); test('cannot start with a number', () { const String nonAlphaNumericArbFile = ''' { "123title": "Stocks", "@123title": { "description": "Title for the Stocks application" } }'''; 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( inputPathString: defaultL10nPathString, outputPathString: defaultL10nPathString, templateArbFileName: defaultTemplateArbFileName, outputFileString: defaultOutputFileString, classNameString: defaultClassNameString, ); generator.loadResources(); generator.writeOutputFiles(); } on L10nException catch (e) { expect(e.message, contains('Invalid ARB resource name')); return; } fail('should fail since key starts with a number.'); }); }); }); }