test: add/modify tests for updateAnnotatedFile property

Author: aoisupersix

openapi-generator/test/builder_test.dart

@@ -263,6 +263,27 @@ class TestClassConfig extends OpenapiGeneratorConfig {}
         copy.deleteSync();
         expect(hasOutput, isTrue);
       });
+      test('skip updating annotated file', () async {
+        final annotatedFile = File(
+            '.${Platform.pathSeparator}test${Platform.pathSeparator}specs${Platform.pathSeparator}output-nextgen${Platform.pathSeparator}annotated_file.dart');
+        final annotetedFileContent = '\n';
+        await annotatedFile.writeAsString(annotetedFileContent, flush: true);
+
+        generatedOutput = await generate('''
+@Openapi(
+  inputSpecFile: '$specPath',
+  inputSpec: RemoteSpec(path: '$specPath'),
+  useNextGen: true,
+  cachePath: '${f.path}',
+  updateAnnotatedFile: false,
+)
+          ''', path: annotatedFile.path);
+        expect(
+            generatedOutput,
+            contains(
+                'Skipped updating annotated file step because flag was set.'));
+        expect(annotatedFile.readAsStringSync(), equals(annotetedFileContent));
+      });
       group('source gen', () {
         group('uses Flutter', () {
           group('with wrapper', () {

openapi-generator/test/generator_arguments_test.dart

@@ -19,6 +19,8 @@ void main() {
       test('shouldFetchDependencies',
           () => expect(args.shouldFetchDependencies, isTrue));
       test('skipValidation', () => expect(args.skipValidation, isFalse));
+      test('updateAnnotatedFile',
+          () => expect(args.updateAnnotatedFile, isTrue));
       test(
           'pubspecPath',
           () => expect(
@@ -168,6 +170,7 @@ void main() {
         expect(args.isRemote, isFalse);
         expect(args.generatorName, 'dart-dio');
         expect(args.shouldGenerateSources, isTrue);
+        expect(args.updateAnnotatedFile, isTrue);
         expect(args.additionalProperties?.useEnumExtension, isTrue);
         expect(args.additionalProperties?.pubAuthor, 'test author');
         expect(await args.jarArgs, [
@@ -218,6 +221,7 @@ void main() {
         expect(args.isRemote, isFalse);
         expect(args.generatorName, 'dart-dio');
         expect(args.shouldGenerateSources, isTrue);
+        expect(args.updateAnnotatedFile, isTrue);
         expect(args.additionalProperties?.useEnumExtension, isTrue);
         expect((args.additionalProperties as DioProperties?)?.nullableFields,
             isTrue);
@@ -269,6 +273,7 @@ void main() {
         expect(args.isRemote, isFalse);
         expect(args.generatorName, 'dart-dio');
         expect(args.shouldGenerateSources, isTrue);
+        expect(args.updateAnnotatedFile, isTrue);
         expect(args.additionalProperties?.useEnumExtension, isTrue);
         expect(
             (args.additionalProperties as DioAltProperties?)?.nullSafe, isTrue);
@@ -329,6 +334,7 @@ void main() {
             'https://petstore3.swagger.io/api/v3/openapi.json');
         expect(args.generatorName, 'dart-dio');
         expect(args.shouldGenerateSources, isTrue);
+        expect(args.updateAnnotatedFile, isTrue);
         expect(args.additionalProperties?.useEnumExtension, isTrue);
         expect(
             (args.additionalProperties as DioAltProperties?)?.nullSafe, isTrue);

openapi-generator/test/specs/dio_alt_properties_test_config.dart

@@ -22,5 +22,6 @@ import 'package:openapi_generator_annotations/openapi_generator_annotations.dart
       nullSafeArrayDefault: true),
   inlineSchemaNameMappings: {'200resp': 'OkResp'},
   projectPubspecPath: './test/specs/dart_pubspec.test.yaml',
+  updateAnnotatedFile: true,
 )
 class DioAltPropertiesTestConfig {}

openapi-generator/test/specs/dio_properties_test_config.dart

@@ -21,5 +21,6 @@ import 'package:openapi_generator_annotations/openapi_generator_annotations.dart
       nullableFields: true),
   inlineSchemaNameMappings: {'200resp': 'OkResp'},
   projectPubspecPath: './test/specs/dart_pubspec.test.yaml',
+  updateAnnotatedFile: true,
 )
 class DioPropertiesTestConfig {}

openapi-generator/test/specs/input_remote_properties_test_config.dart

@@ -23,5 +23,6 @@ import 'package:openapi_generator_annotations/openapi_generator_annotations.dart
       nullSafeArrayDefault: true),
   inlineSchemaNameMappings: {'200resp': 'OkResp'},
   projectPubspecPath: './test/specs/dart_pubspec.test.yaml',
+  updateAnnotatedFile: true,
 )
 class DioAltPropertiesTestConfig {}

openapi-generator/test/specs/test_config.dart

@@ -22,5 +22,6 @@ import 'package:openapi_generator_annotations/openapi_generator_annotations.dart
       legacyDiscriminatorBehavior: true),
   inlineSchemaNameMappings: {'200resp': 'OkResp'},
   projectPubspecPath: './test/specs/dart_pubspec.test.yaml',
+  updateAnnotatedFile: true,
 )
 class TestClassConfig {}

openapi-generator/test/test_annotations/test_configs.dart

@@ -13,6 +13,8 @@ const inputSpec = '';
 const runSourceGenOnOutput = true;
 
 const skipSpecValidation = false;
+
+const updateAnnotatedFile = true;
 ''')
 @Openapi(inputSpec: InputSpec(path: ''), generatorName: Generator.dio)
 class TestClassDefault {}
@@ -29,6 +31,8 @@ const inputSpec = '';
 const runSourceGenOnOutput = true;
 
 const skipSpecValidation = false;
+
+const updateAnnotatedFile = true;
 ''')
 @Openapi(
   inputSpec: InputSpec(path: ''),
@@ -49,6 +53,8 @@ const inputSpec = '';
 const runSourceGenOnOutput = true;
 
 const skipSpecValidation = false;
+
+const updateAnnotatedFile = true;
 ''')
 @Openapi(
   inputSpec: InputSpec(path: ''),

openapi-generator/test/test_annotations/test_generator.dart

@@ -48,6 +48,7 @@ class TestGenerator extends src_gen.GeneratorForAnnotation<Openapi> {
       SupportedFields(name: 'runSourceGenOnOutput', type: bool),
       SupportedFields(name: 'cachePath', type: String),
       SupportedFields(name: 'projectPubspecPath', type: String),
+      SupportedFields(name: 'updateAnnotatedFile', type: bool),
     ]..sort((a, b) => a.name.compareTo(b.name));
     for (final field in fields) {
       final v = annotation.read(field.name);