|
| 1 | +import 'dart:io'; |
| 2 | + |
| 3 | +import 'package:args/args.dart'; |
| 4 | +import 'package:mason/mason.dart'; |
| 5 | +import 'package:mocktail/mocktail.dart'; |
| 6 | +import 'package:path/path.dart' as path; |
| 7 | +import 'package:test/test.dart'; |
| 8 | +import 'package:usage/usage.dart'; |
| 9 | +import 'package:very_good_cli/src/commands/commands.dart'; |
| 10 | + |
| 11 | +import '../../../../helpers/helpers.dart'; |
| 12 | + |
| 13 | +class MockAnalytics extends Mock implements Analytics {} |
| 14 | + |
| 15 | +class MockLogger extends Mock implements Logger {} |
| 16 | + |
| 17 | +class MockMasonGenerator extends Mock implements MasonGenerator {} |
| 18 | + |
| 19 | +class MockGeneratorHooks extends Mock implements GeneratorHooks {} |
| 20 | + |
| 21 | +class MockArgResults extends Mock implements ArgResults {} |
| 22 | + |
| 23 | +class FakeLogger extends Fake implements Logger {} |
| 24 | + |
| 25 | +class FakeDirectoryGeneratorTarget extends Fake |
| 26 | + implements DirectoryGeneratorTarget {} |
| 27 | + |
| 28 | +final expectedUsage = [ |
| 29 | + ''' |
| 30 | +Creates a new very good Flutter package in the specified directory. |
| 31 | +
|
| 32 | +Usage: very_good create flutter_package <project-name> [arguments] |
| 33 | +-h, --help Print this usage information. |
| 34 | +-o, --output-directory The desired output directory when creating a new project. |
| 35 | + --description The description for this new project. |
| 36 | + (defaults to "A Very Good Project created by Very Good CLI.") |
| 37 | + --publishable Whether the generated project is intended to be published. |
| 38 | +
|
| 39 | +Run "very_good help" to see global options.''', |
| 40 | +]; |
| 41 | + |
| 42 | +const pubspec = ''' |
| 43 | +name: example |
| 44 | +environment: |
| 45 | + sdk: ">=2.13.0 <3.0.0" |
| 46 | +'''; |
| 47 | + |
| 48 | +void main() { |
| 49 | + late Analytics analytics; |
| 50 | + late Logger logger; |
| 51 | + |
| 52 | + setUpAll(() { |
| 53 | + registerFallbackValue(FakeDirectoryGeneratorTarget()); |
| 54 | + registerFallbackValue(FakeLogger()); |
| 55 | + }); |
| 56 | + |
| 57 | + setUp(() { |
| 58 | + analytics = MockAnalytics(); |
| 59 | + when( |
| 60 | + () => analytics.sendEvent(any(), any(), label: any(named: 'label')), |
| 61 | + ).thenAnswer((_) async {}); |
| 62 | + when( |
| 63 | + () => analytics.waitForLastPing(timeout: any(named: 'timeout')), |
| 64 | + ).thenAnswer((_) async {}); |
| 65 | + |
| 66 | + logger = MockLogger(); |
| 67 | + |
| 68 | + final progress = MockProgress(); |
| 69 | + |
| 70 | + when(() => logger.progress(any())).thenReturn(progress); |
| 71 | + }); |
| 72 | + |
| 73 | + group('can be instantiated', () { |
| 74 | + test('with default options', () { |
| 75 | + final logger = Logger(); |
| 76 | + final command = CreateFlutterPackage( |
| 77 | + analytics: analytics, |
| 78 | + logger: logger, |
| 79 | + generatorFromBundle: null, |
| 80 | + generatorFromBrick: null, |
| 81 | + ); |
| 82 | + expect(command.name, equals('flutter_package')); |
| 83 | + expect( |
| 84 | + command.description, |
| 85 | + equals( |
| 86 | + 'Creates a new very good Flutter package in the specified directory.', |
| 87 | + ), |
| 88 | + ); |
| 89 | + expect(command.logger, equals(logger)); |
| 90 | + expect(command, isA<Publishable>()); |
| 91 | + }); |
| 92 | + }); |
| 93 | + |
| 94 | + group('create flutter_package', () { |
| 95 | + test( |
| 96 | + 'help', |
| 97 | + withRunner((commandRunner, logger, pubUpdater, printLogs) async { |
| 98 | + final result = |
| 99 | + await commandRunner.run(['create', 'flutter_package', '--help']); |
| 100 | + expect(printLogs, equals(expectedUsage)); |
| 101 | + expect(result, equals(ExitCode.success.code)); |
| 102 | + |
| 103 | + printLogs.clear(); |
| 104 | + |
| 105 | + final resultAbbr = |
| 106 | + await commandRunner.run(['create', 'flutter_pkg', '-h']); |
| 107 | + expect(printLogs, equals(expectedUsage)); |
| 108 | + expect(resultAbbr, equals(ExitCode.success.code)); |
| 109 | + }), |
| 110 | + ); |
| 111 | + |
| 112 | + group('running the command', () { |
| 113 | + final generatedFiles = |
| 114 | + List.filled(10, const GeneratedFile.created(path: '')); |
| 115 | + |
| 116 | + late GeneratorHooks hooks; |
| 117 | + late MasonGenerator generator; |
| 118 | + |
| 119 | + setUp(() { |
| 120 | + hooks = MockGeneratorHooks(); |
| 121 | + generator = MockMasonGenerator(); |
| 122 | + |
| 123 | + when(() => generator.hooks).thenReturn(hooks); |
| 124 | + when( |
| 125 | + () => hooks.preGen( |
| 126 | + vars: any(named: 'vars'), |
| 127 | + onVarsChanged: any(named: 'onVarsChanged'), |
| 128 | + ), |
| 129 | + ).thenAnswer((_) async {}); |
| 130 | + |
| 131 | + when( |
| 132 | + () => generator.generate( |
| 133 | + any(), |
| 134 | + vars: any(named: 'vars'), |
| 135 | + logger: any(named: 'logger'), |
| 136 | + ), |
| 137 | + ).thenAnswer((_) async { |
| 138 | + return generatedFiles; |
| 139 | + }); |
| 140 | + |
| 141 | + when(() => generator.id).thenReturn('generator_id'); |
| 142 | + when(() => generator.description).thenReturn('generator description'); |
| 143 | + when(() => generator.hooks).thenReturn(hooks); |
| 144 | + |
| 145 | + when( |
| 146 | + () => hooks.preGen( |
| 147 | + vars: any(named: 'vars'), |
| 148 | + onVarsChanged: any(named: 'onVarsChanged'), |
| 149 | + ), |
| 150 | + ).thenAnswer((_) async {}); |
| 151 | + when( |
| 152 | + () => generator.generate( |
| 153 | + any(), |
| 154 | + vars: any(named: 'vars'), |
| 155 | + logger: any(named: 'logger'), |
| 156 | + ), |
| 157 | + ).thenAnswer((_) async { |
| 158 | + final target = |
| 159 | + _.positionalArguments.first as DirectoryGeneratorTarget; |
| 160 | + File(path.join(target.dir.path, 'my_flutter_package', 'pubspec.yaml')) |
| 161 | + ..createSync(recursive: true) |
| 162 | + ..writeAsStringSync(pubspec); |
| 163 | + return generatedFiles; |
| 164 | + }); |
| 165 | + }); |
| 166 | + |
| 167 | + test('creates flutter package', () async { |
| 168 | + final tempDir = Directory.systemTemp.createTempSync(); |
| 169 | + addTearDown(() => tempDir.deleteSync(recursive: true)); |
| 170 | + final argResults = MockArgResults(); |
| 171 | + final command = CreateFlutterPackage( |
| 172 | + analytics: analytics, |
| 173 | + logger: logger, |
| 174 | + generatorFromBundle: (_) async => throw Exception('oops'), |
| 175 | + generatorFromBrick: (_) async => generator, |
| 176 | + )..argResultOverrides = argResults; |
| 177 | + when(() => argResults['output-directory'] as String?) |
| 178 | + .thenReturn(tempDir.path); |
| 179 | + when(() => argResults.rest).thenReturn(['my_flutter_package']); |
| 180 | + |
| 181 | + final result = await command.run(); |
| 182 | + |
| 183 | + expect(command.template.name, 'flutter_pkg'); |
| 184 | + expect(result, equals(ExitCode.success.code)); |
| 185 | + |
| 186 | + verify(() => logger.progress('Bootstrapping')).called(1); |
| 187 | + verify( |
| 188 | + () => hooks.preGen( |
| 189 | + vars: <String, dynamic>{ |
| 190 | + 'project_name': 'my_flutter_package', |
| 191 | + 'description': '', |
| 192 | + 'publishable': false, |
| 193 | + }, |
| 194 | + onVarsChanged: any(named: 'onVarsChanged'), |
| 195 | + ), |
| 196 | + ); |
| 197 | + verify( |
| 198 | + () => generator.generate( |
| 199 | + any(), |
| 200 | + vars: <String, dynamic>{ |
| 201 | + 'project_name': 'my_flutter_package', |
| 202 | + 'description': '', |
| 203 | + 'publishable': false, |
| 204 | + }, |
| 205 | + logger: logger, |
| 206 | + ), |
| 207 | + ).called(1); |
| 208 | + verify( |
| 209 | + () => logger.info('Created a Very Good Flutter Package! 🦄'), |
| 210 | + ).called(1); |
| 211 | + }); |
| 212 | + }); |
| 213 | + }); |
| 214 | +} |
0 commit comments