Improve consistency of "END" comments in test suite

As in the recent roughly corresponding change inside git/, this
does not add new END comments (and actually removes some), but
instead focuses on making the existing ones more consistent in
style, mainly adjusting capitalization (turning "end" to "END").

Author: EliahKagan

test/performance/lib.py

@@ -45,7 +45,7 @@ def setUp(self):
                 k_env_git_repo,
             )
             repo_path = osp.dirname(__file__)
-        # end set some repo path
+        # END set some repo path
         self.gitrorepo = Repo(repo_path, odbt=GitCmdObjectDB, search_parent_directories=True)
         self.puregitrorepo = Repo(repo_path, odbt=GitDB, search_parent_directories=True)
 

test/test_base.py

@@ -142,5 +142,5 @@ def test_add_unicode(self, rw_repo):
         else:
             # On POSIX, we can just add Unicode files without problems.
             rw_repo.git.add(rw_repo.working_dir)
-        # end
+
         rw_repo.index.commit("message")

test/test_config.py

@@ -190,13 +190,9 @@ def test_config_include(self, rw_dir):
         def write_test_value(cw, value):
             cw.set_value(value, "value", value)
 
-        # end
-
         def check_test_value(cr, value):
             assert cr.get_value(value, "value") == value
 
-        # end
-
         # PREPARE CONFIG FILE A
         fpa = osp.join(rw_dir, "a")
         with GitConfigParser(fpa, read_only=False) as cw:
@@ -225,7 +221,7 @@ def check_test_value(cr, value):
         with GitConfigParser(fpa, read_only=True) as cr:
             for tv in ("a", "b", "c"):
                 check_test_value(cr, tv)
-            # end for each test to verify
+            # END for each test to verify
             assert len(cr.items("include")) == 8, "Expected all include sections to be merged"
 
         # Test writable config writers - assure write-back doesn't involve includes.

test/test_diff.py

@@ -223,7 +223,7 @@ def test_diff_index(self):
         for dr in res:
             self.assertTrue(dr.diff.startswith(b"@@"), dr)
             self.assertIsNotNone(str(dr), "Diff to string conversion should be possible")
-        # end for each diff
+        # END for each diff
 
         dr = res[3]
         assert dr.diff.endswith(b"+Binary files a/rps and b/rps differ\n")

test/test_docs.py

@@ -146,8 +146,6 @@ def update(self, op_code, cur_count, max_count=None, message=""):
                     message or "NO MESSAGE",
                 )
 
-        # end
-
         self.assertEqual(len(cloned_repo.remotes), 1)  # We have been cloned, so should be one remote.
         self.assertEqual(len(bare_repo.remotes), 0)  # This one was just initialized.
         origin = bare_repo.create_remote("origin", url=cloned_repo.working_tree_dir)

test/test_index.py

@@ -635,7 +635,7 @@ def mixed_iterator():
                 )
 
                 os.remove(link_file)
-            # end for each target
+            # END for each target
         # END real symlink test
 
         # Add fake symlink and assure it checks-our as symlink.

test/test_remote.py

@@ -518,8 +518,7 @@ def test_base(self, rw_repo, remote_repo):
             if branch.name != "master":
                 branch.delete(remote_repo, branch, force=True)
                 num_deleted += 1
-            # end
-        # end for each branch
+        # END for each branch
         self.assertGreater(num_deleted, 0)
         self.assertEqual(
             len(rw_repo.remotes.origin.fetch(prune=True)),

test/test_repo.py

@@ -790,7 +790,7 @@ def test_untracked_files(self, rwrepo):
 
             repo_add(untracked_files)
             self.assertEqual(len(rwrepo.untracked_files), (num_recently_untracked - len(files)))
-        # end for each run
+        # END for each run
 
     def test_config_reader(self):
         reader = self.rorepo.config_reader()  # All config files.
@@ -1165,8 +1165,8 @@ def last_commit(repo, rev, path):
             for repo_type in (GitCmdObjectDB, GitDB):
                 repo = Repo(self.rorepo.working_tree_dir, odbt=repo_type)
                 last_commit(repo, "master", "test/test_base.py")
-            # end for each repository type
-        # end for each iteration
+            # END for each repository type
+        # END for each iteration
 
     def test_remote_method(self):
         self.assertRaises(ValueError, self.rorepo.remote, "foo-blue")
@@ -1227,7 +1227,7 @@ def test_merge_base(self):
             res = repo.merge_base(c1, c2, c3, **{kw: True})
             self.assertIsInstance(res, list)
             self.assertEqual(len(res), 1)
-        # end for each keyword signalling all merge-bases to be returned
+        # END for each keyword signalling all merge-bases to be returned
 
         # Test for no merge base - can't do as we have.
         self.assertRaises(GitCommandError, repo.merge_base, c1, "ffffff")

test/test_submodule.py

@@ -704,7 +704,7 @@ def test_first_submodule(self, rwrepo):
             sm = rwrepo.create_submodule(sm_name, sm_path, rwrepo.git_dir, no_checkout=True)
             assert sm.exists() and sm.module_exists()
             rwrepo.index.commit("Added submodule " + sm_name)
-        # end for each submodule path to add
+        # END for each submodule path to add
 
         self.assertRaises(ValueError, rwrepo.create_submodule, "fail", osp.expanduser("~"))
         self.assertRaises(
@@ -731,7 +731,7 @@ def test_add_empty_repo(self, rwdir):
                 url=empty_repo_dir,
                 no_checkout=checkout_mode and True or False,
             )
-        # end for each checkout mode
+        # END for each checkout mode
 
     @with_rw_directory
     @_patch_git_config("protocol.file.allow", "always")
@@ -783,8 +783,8 @@ def test_git_submodules_and_add_sm_with_new_commit(self, rwdir):
             for init in (False, True):
                 sm.update(init=init)
                 sm2.update(init=init)
-            # end for each init state
-        # end for each iteration
+            # END for each init state
+        # END for each iteration
 
         sm.move(sm.path + "_moved")
         sm2.move(sm2.path + "_moved")
@@ -839,7 +839,7 @@ def assert_exists(sm, value=True):
             assert sm.exists() == value
             assert sm.module_exists() == value
 
-        # end
+        # END def assert_exists
 
         # As git is backwards compatible itself, it would still recognize what we do here... unless we really
         # muss it up. That's the only reason why the test is still here...
@@ -854,7 +854,7 @@ def assert_exists(sm, value=True):
             assert osp.isfile(module_repo_path)
             assert sm.module().has_separate_working_tree()
             assert find_submodule_git_dir(module_repo_path) is not None, "module pointed to by .git file must be valid"
-        # end verify submodule 'style'
+        # END verify submodule 'style'
 
         # Test move.
         new_sm_path = join_path_native("submodules", "one")
@@ -911,7 +911,7 @@ def assert_exists(sm, value=True):
             sm.remove(dry_run=dry_run, force=True)
             assert_exists(sm, value=dry_run)
             assert osp.isdir(sm_module_path) == dry_run
-        # end for each dry-run mode
+        # END for each dry-run mode
 
     @with_rw_directory
     def test_ignore_non_submodule_file(self, rwdir):
@@ -974,7 +974,6 @@ def test_rename(self, rwdir):
         sm_mod = sm.module()
         if osp.isfile(osp.join(sm_mod.working_tree_dir, ".git")) == sm._need_gitfile_submodules(parent.git):
             assert sm_mod.git_dir.endswith(join_path_native(".git", "modules", new_sm_name))
-        # end
 
     @with_rw_directory
     def test_branch_renames(self, rw_dir):