🐛 Make sure staged changes are applied to clones (#59)

<!--
Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors.
All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->
### Description

Make sure staged changes are applied to clones


### Test Coverage

<!--
Please put an `x` in the correct box e.g. `[x]` to indicate the testing
coverage of this change.
-->

- [x]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

Author: acabarbaye

continuous_delivery_scripts/utils/git_helpers.py

@@ -601,6 +601,19 @@ def uncommitted_changes(self) -> List[Path]:
 
         return [Path(self.root).joinpath(line.strip().split(" ")[-1]) for line in status.splitlines()]
 
+    @property
+    def uncommitted_staged_changes(self) -> List[Path]:
+        """Gets list of uncommitted staged changes.
+
+        Returns:
+             list of uncommitted staged changes
+        """
+        staged = self.repo.git.diff(staged=True, name_only=True)
+        if not staged:
+            return []
+
+        return [Path(self.root).joinpath(line.strip()) for line in staged.splitlines()]
+
     @staticmethod
     def _apply_modifications(destination: Path, modified_file: Path) -> None:
         logger.info(f"Applying change in {modified_file} to {destination}")
@@ -627,6 +640,8 @@ def apply_uncommitted_changes(self, other_repo: "GitWrapper") -> None:
                 GitWrapper._apply_modifications(destination, f)
             else:
                 GitWrapper._apply_deletions(destination)
+        for f in self.uncommitted_staged_changes:
+            other_repo.add(f.relative_to(self.root))
 
     def get_corresponding_path(self, path_in_initial_repo: Path) -> Path:
         """Gets the path in current repository corresponding to path in initial repository.

news/20221221183120.bugfix

@@ -0,0 +1 @@
+`[git]` :bug: make sure any staged changes are also applied to repository clones

tests/git_helper/test_git_helpers.py

@@ -38,6 +38,35 @@ def test_git_clone_independent(self):
             self.assertEqual(git.get_remote_url(), clone.get_remote_url())
             self.assertNotEqual(git.root, clone.root)
 
+    def test_git_clone_roll_over_changes(self):
+        """Ensures staged changes in original repository are applied in clone."""
+        with ProjectTempClone(desired_branch_name="main") as origin:
+            test_file = Path(origin.root).joinpath(f"file-test-{uuid4()}.txt")
+            test_file.touch()
+
+            uncommitted_changes = origin.uncommitted_changes
+            staged_changes = origin.uncommitted_staged_changes
+            self.assertTrue(origin.is_dirty())
+            self.assertTrue(test_file in uncommitted_changes)
+            self.assertFalse(test_file in staged_changes)
+            origin.add(test_file)
+            uncommitted_changes = origin.uncommitted_changes
+            staged_changes = origin.uncommitted_staged_changes
+            self.assertTrue(origin.is_dirty())
+            self.assertTrue(test_file in uncommitted_changes)
+            self.assertTrue(test_file in staged_changes)
+
+            with GitTempClone(repository_to_clone=origin, desired_branch_name="main") as clone:
+                self.assertNotEqual(origin.root, clone.root)
+                self.assertTrue(clone.is_dirty())
+                uncommitted_changes = clone.uncommitted_changes
+                staged_changes = clone.uncommitted_staged_changes
+                cloned_test_file = clone.root.joinpath(test_file.relative_to(origin.root))
+                self.assertIsNotNone(uncommitted_changes)
+                self.assertIsNotNone(staged_changes)
+                self.assertTrue(cloned_test_file in uncommitted_changes)
+                self.assertTrue(cloned_test_file in staged_changes)
+
     def test_git_branch_actions(self):
         """Test basic git branch actions on the clone."""
         with ProjectTempClone(desired_branch_name="main") as clone: