fix(shorebird_cli): make android manifest and shorebird version valid…

…ation more robust (#273)
shorebirdtech · Apr 8, 2023 · 7e121b0 · 7e121b0
1 parent 2dc180b
commit 7e121b0
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 10 deletions.
diff --git a/packages/shorebird_cli/lib/src/validators/android_internet_permission_validator.dart b/packages/shorebird_cli/lib/src/validators/android_internet_permission_validator.dart
@@ -26,15 +26,38 @@ class AndroidInternetPermissionValidator extends Validator {
         'src',
       ),
     );
-    final manifestsWithoutInternetPermission = androidSrcDir
+
+    if (!androidSrcDir.existsSync()) {
+      return [
+        const ValidationIssue(
+          severity: ValidationIssueSeverity.error,
+          message: 'No Android project found',
+        ),
+      ];
+    }
+
+    final manifestFiles = androidSrcDir
         .listSync()
         .whereType<Directory>()
-        .where((dir) {
-          return dir.listSync().whereType<File>().any(
-                (file) => p.basename(file.path) == 'AndroidManifest.xml',
-              );
-        })
-        .map((e) => p.join(e.path, manifestFileName))
+        .where(
+          (dir) => dir
+              .listSync()
+              .whereType<File>()
+              .any((file) => p.basename(file.path) == 'AndroidManifest.xml'),
+        )
+        .map((e) => p.join(e.path, manifestFileName));
+
+    if (manifestFiles.isEmpty) {
+      return [
+        ValidationIssue(
+          severity: ValidationIssueSeverity.error,
+          message:
+              'No AndroidManifest.xml files found in ${androidSrcDir.path}',
+        ),
+      ];
+    }
+
+    final manifestsWithoutInternetPermission = manifestFiles
         .where((manifest) => !_androidManifestHasInternetPermission(manifest));
 
     if (manifestsWithoutInternetPermission.isNotEmpty) {

diff --git a/packages/shorebird_cli/lib/src/validators/shorebird_version_validator.dart b/packages/shorebird_cli/lib/src/validators/shorebird_version_validator.dart
@@ -18,9 +18,20 @@ class ShorebirdVersionValidator extends Validator {
   @override
   Future<List<ValidationIssue>> validate() async {
     final workingDirectory = p.dirname(Platform.script.toFilePath());
-    final isShorebirdUpToDate = await isShorebirdVersionCurrent(
-      workingDirectory: workingDirectory,
-    );
+    final bool isShorebirdUpToDate;
+
+    try {
+      isShorebirdUpToDate = await isShorebirdVersionCurrent(
+        workingDirectory: workingDirectory,
+      );
+    } on ProcessException catch (e) {
+      return [
+        ValidationIssue(
+          severity: ValidationIssueSeverity.error,
+          message: 'Failed to get shorebird version. Error: ${e.message}',
+        ),
+      ];
+    }
 
     if (!isShorebirdUpToDate) {
       return [

diff --git a/packages/shorebird_cli/test/src/validators/android_internet_permission_validator_test.dart b/packages/shorebird_cli/test/src/validators/android_internet_permission_validator_test.dart
@@ -65,6 +65,33 @@ void main() {
       },
     );
 
+    test('returns an error if no android project is found', () async {
+      final results = await AndroidInternetPermissionValidator().validate();
+
+      expect(results, hasLength(1));
+      expect(results.first.severity, ValidationIssueSeverity.error);
+      expect(results.first.message, 'No Android project found');
+    });
+
+    test('returns an error if no AndroidManifest.xml files are found',
+        () async {
+      final tempDirectory = createTempDir();
+      Directory(p.join(tempDirectory.path, 'android', 'app', 'src', 'debug'))
+          .createSync(recursive: true);
+
+      final results = await IOOverrides.runZoned(
+        () => AndroidInternetPermissionValidator().validate(),
+        getCurrentDirectory: () => tempDirectory,
+      );
+
+      expect(results, hasLength(1));
+      expect(results.first.severity, ValidationIssueSeverity.error);
+      expect(
+        results.first.message,
+        startsWith('No AndroidManifest.xml files found in'),
+      );
+    });
+
     test(
       'returns separate errors for all AndroidManifest.xml files without the '
       'INTERNET permission',

diff --git a/packages/shorebird_cli/test/src/validators/shorebird_version_validator_test.dart b/packages/shorebird_cli/test/src/validators/shorebird_version_validator_test.dart
@@ -87,5 +87,29 @@ void main() {
         contains('A new version of shorebird is available!'),
       );
     });
+
+    test(
+      'returns an error on failure to retrieve shorebird version',
+      () async {
+        when(
+          () => fetchLatestVersionResult.stdout,
+        ).thenThrow(
+          const ProcessException(
+            'git',
+            ['--rev'],
+            'Some error',
+          ),
+        );
+
+        final results = await validator.validate();
+
+        expect(results, hasLength(1));
+        expect(results.first.severity, ValidationIssueSeverity.error);
+        expect(
+          results.first.message,
+          'Failed to get shorebird version. Error: Some error',
+        );
+      },
+    );
   });
 }