Merge pull request ishepard#122 from ishepard/fix-projectname-multiple-repos

ishepard · web-flow · commit 11fff735d2bf · 2020-05-14T15:05:02.000+02:00
Fix commit.project_name when multiple repos are given as parameters
diff --git a/pydriller/repository_mining.py b/pydriller/repository_mining.py
@@ -164,7 +164,14 @@ def traverse_commits(self) -> Generator[Commit, None, None]:
                 path_repo = self._clone_remote_repos(self._clone_folder(), path_repo)
 
             git_repo = GitRepository(path_repo, self._conf)
+            # saving the GitRepository object for further use
             self._conf.set_value("git_repo", git_repo)
+
+            # when multiple repos are given in input, this variable will serve as a reminder
+            # of which one we are currently analyzing
+            self._conf.set_value('path_to_repo', path_repo)
+
+            # checking that the filters are set correctly
             self._conf.sanity_check_filters()
 
             logger.info('Analyzing git repository in %s', git_repo.path)
diff --git a/pydriller/utils/conf.py b/pydriller/utils/conf.py
@@ -59,8 +59,7 @@ def _sanity_check_repos(path_to_repo):
         @param path_to_repo: path to the repo as provided by the user.
         @return:
         """
-        if not isinstance(path_to_repo, str) and \
-                not isinstance(path_to_repo, list):
+        if not isinstance(path_to_repo, str) and not isinstance(path_to_repo, list):
             raise Exception("The path to the repo has to be of type 'string' or 'list of strings'!")
 
     def _check_only_one_from_commit(self):
diff --git a/tests/test_commit.py b/tests/test_commit.py
@@ -11,7 +11,6 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
 from pydriller.git_repository import GitRepository
 from pathlib import Path
 import pytest
diff --git a/tests/test_repository_mining.py b/tests/test_repository_mining.py
@@ -234,3 +234,22 @@ def test_clone_repo_to_not_existing():
     with pytest.raises(Exception):
         list(RepositoryMining("https://github.com/ishepard/pydriller",
                               clone_repo_to="NOTEXISTINGDIR").traverse_commits())
+
+
+def test_projectname_multiple_repos():
+    repos = [
+        'test-repos/files_in_directories',
+        'test-repos/files_in_directories',
+        'test-repos/files_in_directories'
+    ]
+    for commit in RepositoryMining(path_to_repo=repos).traverse_commits():
+        assert commit.project_name == 'files_in_directories'
+
+
+def test_projectname_multiple_repos_remote():
+    repos = [
+        'https://github.com/ishepard/pydriller',
+        'test-repos/pydriller'
+    ]
+    for commit in RepositoryMining(path_to_repo=repos).traverse_commits():
+        assert commit.project_name == 'pydriller'
