Validate if current path is a Git Repository

Author: jsilverdev

lib/constants/constants.dart

@@ -15,6 +15,8 @@ const String GIT_REMOTE_HARD_RESET = '''
   git reset --hard origin/{1}
 ''';
 
+const String GIT_TOP_LEVEL_PATH = "git rev-parse --show-toplevel";
+
 const GIT_SSL_VERIFY_FALSE = "http.sslVerify=false";
 
 const TXT_FILENAME = "properties_file.txt";

lib/exceptions/exceptions.dart

@@ -17,9 +17,17 @@ class ExecutableNotFoundInPathException extends AppException {
 class ConfigPropertyMissingException extends AppException {
   const ConfigPropertyMissingException({
     required final String property,
-  }) : super('The config property "$property" is not defined');
+  }) : super('"$property" property is not defined int the .env file');
 }
 
-abstract class YamlException extends AppException {
-  YamlException(super._message);
+class InvalidValidGitPathException extends AppException {
+  const InvalidValidGitPathException({
+    required final String path
+  }) : super('"$path" path is and invalid git repository');
+}
+
+class IncorrectTopLevelGitPathException extends AppException {
+  const IncorrectTopLevelGitPathException({
+    required final String path
+  }) : super('"$path" path is not in the top level of the git repository');
 }

lib/services/repo_service.dart

@@ -3,8 +3,10 @@ import 'package:process_run/process_run.dart';
 import '../config/app_config.dart';
 import '../constants/constants.dart' as constants;
 import '../config/logger.dart';
+import '../exceptions/exceptions.dart';
 import '../utils/string_utils.dart';
 import 'shell_service.dart';
+import 'package:path/path.dart' as path;
 
 class RepoService {
   final AppConfig _appConfig;
@@ -36,14 +38,28 @@ class RepoService {
     );
   }
 
+  Future<void> _validateCurrentPathIsGitRepo() async {
+    try {
+      final res = await _shellService.runScript(constants.GIT_TOP_LEVEL_PATH);
+      if (!path.equals(_appConfig.gitRepoPath, res.outLines.first)) {
+        throw IncorrectTopLevelGitPathException(
+          path: _appConfig.gitRepoPath,
+        );
+      }
+    } on ShellException {
+      throw InvalidValidGitPathException(
+          path: _appConfig.gitRepoPath,
+      );
+    }
+  }
+
   Future<void> setup() async {
     log.i("Checking properties for: ${_appConfig.gitRepoPath}");
     _shellService.moveShellTo(_appConfig.gitRepoPath);
 
-    log.i("Checking if {} is installed".format([constants.GIT]));
     _shellService.checkExecutable(constants.GIT);
 
-    //TODO: Validate if is a git folder
+    await _validateCurrentPathIsGitRepo();
 
     if (_appConfig.gitBranch == "") {
       log.w("You don't define an specific branch, using current branch");

test/services/repo_service_test.dart

@@ -4,7 +4,9 @@ import 'package:config_props_extractor/constants/constants.dart';
 import 'package:config_props_extractor/exceptions/exceptions.dart';
 import 'package:config_props_extractor/services/repo_service.dart';
 import 'package:config_props_extractor/services/shell_service.dart';
+import 'package:config_props_extractor/utils/string_utils.dart';
 import 'package:mocktail/mocktail.dart';
+import 'package:process_run/process_run.dart';
 import 'package:test/test.dart';
 
 import '../helpers/mocks.dart';
@@ -50,9 +52,18 @@ void main() {
       );
       when(() => mockAppConfig.gitForceRemote).thenReturn(gitForceRemote);
       when(() => mockAppConfig.gitSSLEnabled).thenReturn(true);
-      when(() => mockShellService.runScript(any())).thenAnswer(
+      when(() => mockShellService.runScript(GIT_BRANCH_SHOW_CURRENT)).thenAnswer(
         (_) async => [ProcessResult(pid, exitCode, branch, stderr)],
       );
+      when(() => mockShellService.runScript(GIT_CHECKOUT.format([branch]))).thenAnswer(
+        (_) async => [],
+      );
+      when(() => mockShellService.runScript(GIT_REMOTE_HARD_RESET.format([branch, ""]))).thenAnswer(
+        (_) async => [],
+      );
+      when(() => mockShellService.runScript(GIT_TOP_LEVEL_PATH)).thenAnswer(
+        (_) async => [ProcessResult(pid, exitCode, path, stderr)],
+      );
 
       // act
       await repoService.setup();
@@ -70,7 +81,7 @@ void main() {
       () async => await testSetup(
         isBranchDefined: true,
         gitForceRemote: true,
-        runScriptTimes: 1,
+        runScriptTimes: 2,
       ),
     );
 
@@ -79,7 +90,7 @@ void main() {
       () async => testSetup(
         isBranchDefined: true,
         gitForceRemote: true,
-        runScriptTimes: 1,
+        runScriptTimes: 2,
       ),
     );
 
@@ -88,7 +99,7 @@ void main() {
       () async => testSetup(
         isBranchDefined: false,
         gitForceRemote: false,
-        runScriptTimes: 2,
+        runScriptTimes: 3,
       ),
     );
 
@@ -123,6 +134,36 @@ void main() {
         throwsA(isA<ExecutableNotFoundInPathException>()),
       );
     });
+
+
+    test("The path is invalid git repository", () {
+      // arrange
+      when(() => mockAppConfig.gitRepoPath).thenReturn("/path/to/sub/folder");
+      when(() => mockShellService.runScript(GIT_TOP_LEVEL_PATH)).thenAnswer(
+        (_) async => [ProcessResult(pid, exitCode, "/path/to/sub", stderr)],
+      );
+
+      expect(
+        // act
+        () => repoService.setup(),
+        // assert
+        throwsA(isA<IncorrectTopLevelGitPathException>()),
+      );
+    });
+
+    test("The path is not in the top-level of the git repository", () {
+      // arrange
+      when(() => mockAppConfig.gitRepoPath).thenReturn("/path/to/folder");
+      when(() => mockShellService.runScript(GIT_TOP_LEVEL_PATH))
+      .thenAnswer((_) async => throw ShellException("exception", null));
+
+      expect(
+        // act
+        () => repoService.setup(),
+        // assert
+        throwsA(isA<InvalidValidGitPathException>()),
+      );
+    });
   });
 
   test(