Repair Git state comment formatting

The _uptodate() function already invokes _format_comments() on the
comments passed, avoid duplicate invocations of _format_comments()
which caused the joined string result from being joined with dots a
second time, effectively placing a dot after every character in the
resulting comment output.

Also amend the test suite to cover these output conditions.

Signed-off-by: Georg Pfuetzenreuter <mail@georg-pfuetzenreuter.net>

Author: tacerus

changelog/67944.fixed.md

@@ -0,0 +1 @@
+Repair Git state comment formatting

salt/states/git.py

@@ -949,9 +949,7 @@ def latest(
                         target,
                         force_reset,
                     )
-                    return _uptodate(
-                        ret, target, _format_comments(comments), local_changes
-                    )
+                    return _uptodate(ret, target, comments, local_changes)
 
             if (
                 remote_rev_type == "sha1"
@@ -1181,7 +1179,7 @@ def latest(
                             # user of the actions taken.
                             ret["comment"] = _format_comments(actions)
                             return ret
-                        return _uptodate(ret, target, _format_comments(actions))
+                        return _uptodate(ret, target, actions)
 
                 # The fetch_url for the desired remote does not match the
                 # specified URL (or the remote does not exist), so set the
@@ -1291,7 +1289,7 @@ def latest(
                         if not revs_match and not update_head and formatted_actions:
                             ret["comment"] = formatted_actions
                             return ret
-                        return _uptodate(ret, target, _format_comments(actions))
+                        return _uptodate(ret, target, actions)
 
                 if not upstream and desired_upstream:
                     upstream_action = "Tracking branch was set to {}".format(
@@ -1685,7 +1683,7 @@ def latest(
             ret["comment"] = _format_comments(comments)
             ret["changes"]["revision"] = {"old": local_rev, "new": new_rev}
         else:
-            return _uptodate(ret, target, _format_comments(comments))
+            return _uptodate(ret, target, comments)
     else:
         if os.path.isdir(target):
             target_contents = os.listdir(target)

tests/integration/states/test_git.py

@@ -295,6 +295,17 @@ def test_latest_with_local_changes(self, target):
             "git.latest", name=TEST_REPO, target=target, force_reset=True
         )
         self.assertSaltTrueReturn(ret)
+        ret = ret[next(iter(ret))]
+        # beginning of comment
+        self.assertEqual(
+            f"Repository {target} is up-to-date\n",
+            ret["comment"][0 : 26 + len(target)],
+        )
+        self.assertIn("Uncommitted changes were discarded.", ret["comment"])
+        # ending of comment
+        self.assertEqual(
+            "Repository was hard-reset to remote HEAD (bbefe81).", ret["comment"][-51:]
+        )
 
         # Make sure that we no longer have uncommitted changes
         self.assertFalse(self.run_function("git.diff", [target, "HEAD"]))