improve coverage and unittest and quality

src/pygitversionhelper/gitversionhelper.py

@@ -25,7 +25,6 @@ Check the unittest s for usage samples.
 """
 
 from __future__ import annotations
-from typing import TYPE_CHECKING
 
 import os
 import subprocess
@@ -35,10 +34,6 @@ import logging
 
 from packaging.version import VERSION_PATTERN as packaging_VERSION_PATTERN
 
-# Only imports the below statements during type checking
-if TYPE_CHECKING:
-    from typing import Union
-
 def _exec(cmd: str, root: str | os.PathLike | None = None) -> list[str]:
     """
     helper function to handle system cmd execution
@@ -52,9 +47,9 @@ def _exec(cmd: str, root: str | os.PathLike | None = None) -> list[str]:
     p = subprocess.run(cmd.split(), text=True, cwd=root, capture_output=True, check=False, timeout=2)
     if re.search("not a git repository",p.stderr):
         raise gitversionhelper.repository.notAGitRepository()
-    if re.search("fatal:",p.stderr):
+    if re.search("fatal:",p.stderr):    #pragma: nocover
         raise gitversionhelper.unknownGITFatalError(p.stderr)
-    if int(p.returncode) < 0:
+    if int(p.returncode) < 0:           #pragma: nocover
         raise gitversionhelper.unknownGITError(p.stderr)
     lines = p.stdout.splitlines()
     return [line.rstrip() for line in lines if line.rstrip()]
@@ -142,10 +137,10 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             Returns:
                 the tags list
             """
-            
+
             if sort not in cls.__validGitTagSort:
                 raise gitversionhelper.wrongArguments("sort option not in allowed list")
-            
+
             if ((cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True)):
                 currentBranch = _exec("git rev-parse --abbrev-ref HEAD")
                 return list(reversed(_exec(f"git tag --merged {currentBranch[0]} --sort={sort}")))
@@ -169,7 +164,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
 
             if len(res)==0:
                 raise cls.tagNotFound("no tag found in commit history")
-            if len(res)!=1:
+            if len(res)!=1: #pragma: nocover
                 raise cls.moreThanOneTag("multiple tags on same commit is unsupported")
             return res[0]
 
@@ -201,9 +196,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                                                                 r"(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)"\
                                                                 r"(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?"\
                                                                 r"(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$",
-                                        "regex_preversion_num": r"(?:\.)(?P<num>(?:\d+(?!\w))+)", 
-                                        "regex_build_num"     : r"(?:\.)(?P<num>(?:\d+(?!\w))+)"          
-                                                   
+                                        "regex_preversion_num": r"(?:\.)(?P<num>(?:\d+(?!\w))+)",
+                                        "regex_build_num"     : r"(?:\.)(?P<num>(?:\d+(?!\w))+)"
                                                                 },
                            "PEP440" : { "regex" :               packaging_VERSION_PATTERN,
                            "Auto"   : None
@@ -220,6 +214,11 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             no valid version found exception
             """
 
+        class PreAndPostVersionUnsupported(versionException):
+            """
+            pre and post release can not be present at the same time
+            """
+
         class MetaVersion:
             """
             generic version object
@@ -284,7 +283,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                         raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['bump_type']} requested")
                 return BumpType
 
-            def bump(self,amount:int=1,**kwargs) -> MetaVersion | str : # pylint: disable=R0912
+            def bump(self,amount:int=1,**kwargs) -> cls | str : # pylint: disable=R0912
                 """
                 bump the version to the next one
                 Keyword Arguments:
@@ -303,7 +302,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                             _v.pre_count = _v.pre_count + amount
                         else:
                             _v.post_count = _v.post_count + amount
-                    elif BumpDevStrategy in ["pre-patch","pre-minor","pre-major"]:
+                    #elif BumpDevStrategy in ["pre-patch","pre-minor","pre-major"]:
+                    else:
                         if _v.post_count > 0:
                             _v.post_count = _v.post_count + amount
                         else:
@@ -313,7 +313,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                                 elif BumpDevStrategy == "pre-minor":
                                     _v.minor = _v.minor + 1
                                     _v.patch = 0
-                                elif BumpDevStrategy == "pre-major":
+                                #elif BumpDevStrategy == "pre-major":
+                                else:
                                     _v.major = _v.major + 1
                                     _v.minor = 0
                                     _v.patch = 0
@@ -323,12 +324,13 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                         _v.major = _v.major + amount
                     elif BumpType == "minor":
                         _v.minor = _v.minor + amount
-                    elif BumpType == "patch":
+                    #elif BumpType == "patch":
+                    else:
                         _v.patch = _v.patch + amount
                     _v.pre_count=0
                     _v.post_count=0
                 _v.raw=_v.doFormatVersion(**kwargs)
-                
+
                 if ((self.__OptDict["formated_output"] in kwargs) and (kwargs[self.__OptDict["formated_output"]] is True)):
                     return _v.doFormatVersion(**kwargs)
                 return _v
@@ -387,7 +389,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             return _v
 
         @classmethod
-        def _parseTag(cls,tag,**kwargs):
+        def _parseTag(cls,tag,**kwargs): # pylint: disable=R0914, R0912, R0915
             """get the last version from tags
             Arguments:
                 tag: the tag to be parsed
@@ -473,7 +475,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             _v=None
             try:
                 _v=cls._parseTag(lastTag,**kwargs)
-            except gitversionhelper.version.noValidVersion:   
+            except gitversionhelper.version.noValidVersion as _ex:   
                 if ((cls.__OptDict["ignore_unknown_tags"] in kwargs) and (kwargs[cls.__OptDict["ignore_unknown_tags"]] is True)):
                     tags = gitversionhelper.tag.getTags(sort= "taggerdate",**kwargs)
                     _v=None
@@ -481,10 +483,10 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                         try:
                             _v=cls._parseTag(_tag,**kwargs)
                             break;
-                        except:
+                        except gitversionhelper.version.noValidVersion:
                             continue
                 if _v is None:
-                    raise gitversionhelper.version.noValidVersion()  
+                    raise gitversionhelper.version.noValidVersion() from _ex  
 
             if ((cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]] is True)):
                 return _v.doFormatVersion(**kwargs)
@@ -517,7 +519,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
             if OutputFormat is None:
                 OutputFormat = "{major}.{minor}.{patch}{revpattern}{revcount}"
                 if post_count > 0 and pre_count > 0:
-                    raise RuntimeError("pre and post release can not be present at the same time")
+                    raise gitversionhelper.version.PreAndPostVersionUnsupported()
                 if      VersionStd == "PEP440":
                     if post_count > 0:
                         revpattern=".post"
@@ -525,7 +527,8 @@ class gitversionhelper: # pylint: disable=too-few-public-methods
                     elif pre_count > 0:
                         revpattern=".pre"
                         revcount=f"{pre_count}"
-                elif    VersionStd == "SemVer":
+                #elif    VersionStd == "SemVer":
+                else:
                     if post_count > 0:
                         revpattern="+post"
                         revcount=f".{post_count}"

test/test_gitversionhelper.py

@@ -12,9 +12,7 @@ import tempfile
 import os
 import pathlib
 import re
-import time
-
-from contextlib import redirect_stdout,redirect_stderr
+import copy
 
 print(__name__)
 print(__package__)
@@ -39,7 +37,7 @@ class Test_gitversionhelper(unittest.TestCase):
         os.system("git add .")
         os.system("git commit -m  \"first commit\"")
         os.system(f"git tag {tag}")
-        
+
         _v = pygitversionhelper.gitversionhelper.version.getLastVersion(**kwargs)
         
         self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion)
@@ -56,6 +54,7 @@ class Test_gitversionhelper(unittest.TestCase):
         self.assertEqual(int(_m.group("MAJ")),_v.major)
         self.assertEqual(int(_m.group("MIN")),_v.minor)
         self.assertEqual(int(_m.group("PATCH")),_v.patch)
+               
         return _v
         
     def _test_version_format(self,_v:pygitversionhelper.gitversionhelper.version.MetaVersion,tag:str,**kwargs):
@@ -66,6 +65,17 @@ class Test_gitversionhelper(unittest.TestCase):
     def _test_version_readback_simple(self,tag:str,**kwargs):   
         _v=self._test_version_readback(tag,**kwargs)
         self._test_version_format(_v,tag,**kwargs)
+
+    def test_nominal__version__formated_output(self):
+        _v = pygitversionhelper.gitversionhelper.version.MetaVersion("PEP440",
+                                                                     1,
+                                                                     0,
+                                                                     0,
+                                                                     0,
+                                                                     0,
+                                                                     "1.0.0")
+        self.assertEqual("1.0.1", _v.bump(formated_output=True))
+        self.assertEqual("2.0.0", _v.bump(formated_output=True,bump_type="major"))
         
     def test_nominal__version__auto_1(self):
         self._test_version_readback_simple("0.0.1")
@@ -189,7 +199,7 @@ class Test_gitversionhelper(unittest.TestCase):
         _v=self._test_version_readback("1.2.1-toto",version_std="SemVer")
         self._test_version_format(_v,"1.2.1-pre.1",version_std="SemVer")
         
-    def test_nominal__version___pump_SemVer(self,**kwargs):
+    def test_nominal__version___pump_SemVer(self):
         _v = self._test_version_readback("1.0.0",version_std="SemVer")
         
         _v = _v.bump()
@@ -315,7 +325,7 @@ class Test_gitversionhelper(unittest.TestCase):
         self.assertEqual(_v.post_count, 2)
         self.assertEqual(_v.doFormatVersion(), "2.1.5+post.2")
 
-    def test_nominal__version___pump_PEP440(self,**kwargs):
+    def test_nominal__version___pump_PEP440(self):
         _v = self._test_version_readback("1.0.0",version_std="PEP440")
         
         _v = _v.bump()
@@ -637,11 +647,19 @@ class Test_gitversionhelper(unittest.TestCase):
         with  open("demofile.txt", "w+t") as tmpFile:
             tmpFile.write("testvalue225") 
              
-        with self.assertRaises(pygitversionhelper.gitversionhelper.repository.repositoryDirty) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.repository.repositoryDirty) :
             pygitversionhelper.gitversionhelper.version.getCurrentVersion()
+            
+
+    def test_defect__version_post_and_pre(self):
+        with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported) :
+            _v=self._test_version_readback("0.1.1.pre1.post1",version_std="PEP440")
+            
+        with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported) :
+            _v=self._test_version_readback("0.1.1-pre.1+post.1",version_std="SemVer")
 
     def test_defect__git__wrongargument_sortargs(self):
-        with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) :
             pygitversionhelper.gitversionhelper.tag.getTags(sort="toto")
             
     def test_defect__git__notagfound(self):
@@ -649,10 +667,10 @@ class Test_gitversionhelper(unittest.TestCase):
             tmpFile.write("testvalue")
         os.system("git add .")
         os.system("git commit -m  \"first commit\"")
-        with self.assertRaises(pygitversionhelper.gitversionhelper.tag.tagNotFound) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.tag.tagNotFound) :
             pygitversionhelper.gitversionhelper.tag.getLastTag()
             
-    """ This test is impossible to do
+    """ This test is impossible to do because current implementation can only return one tag
     def test_defect__git_multipletagsfound(self):
         with  open("demofile.txt", "w+t") as tmpFile:
             tmpFile.write("testvalue")
@@ -660,18 +678,18 @@ class Test_gitversionhelper(unittest.TestCase):
         os.system("git commit -m  \"first commit\"")
         os.system(f"git tag 0.1.0")
         os.system(f"git tag 0.2.0")
-        with self.assertRaises(pygitversionhelper.gitversionhelper.tag.moreThanOneTag) as context:
-            pygitversionhelper.gitversionhelper.tag.getLastTag()
+        with self.assertRaises(pygitversionhelper.gitversionhelper.tag.moreThanOneTag) :
+            pygitversionhelper.gitversionhelper.tag.getLastTag(same_branch=True)
     """
 
     def test_defect__wrongargument_bump_type(self):
         _v=self._test_version_readback("0.1.1",version_std="PEP440")
-        with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) :
             pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="toto")
 
     def test_defect__wrongargument_bump_dev_strategy(self):
         _v=self._test_version_readback("0.1.1",version_std="PEP440")
-        with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) :
             pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_dev_strategy="toto")
 
     def test_nominal__tag__getDistanceFromTag(self):
@@ -956,8 +974,12 @@ class Test_gitversionhelper(unittest.TestCase):
         os.system("git commit -m  \"2nd commit\"")
         os.system(f"git tag INVALIDTAG")
         
-        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) :
             _v = pygitversionhelper.gitversionhelper.version.getLastVersion()
+            
+            
+        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) :
+            _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True)
 
     def test_defect__tag__invalidtag_inbetween(self):
         with  open("demofile.txt", "w+t") as tmpFile:
@@ -972,7 +994,7 @@ class Test_gitversionhelper(unittest.TestCase):
         os.system("git commit -m  \"commit\"")
         os.system(f"git tag INVALIDTAG")
         
-        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) :
             _v = pygitversionhelper.gitversionhelper.version.getLastVersion()
             
         _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True)
@@ -1001,7 +1023,7 @@ class Test_gitversionhelper(unittest.TestCase):
         os.system("git commit -m  \"commit\"")
         os.system(f"git tag INVALIDTA4")
         
-        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) :
             _v = pygitversionhelper.gitversionhelper.version.getLastVersion()
             
         _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True)
@@ -1040,7 +1062,7 @@ class Test_gitversionhelper(unittest.TestCase):
         os.system("git commit -m  \"commit\"")
         os.system(f"git tag INVALIDTA5")
 
-        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) :
             _v = pygitversionhelper.gitversionhelper.version.getLastVersion()
             
         _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True)
@@ -1083,7 +1105,7 @@ class Test_gitversionhelperNoRepo(unittest.TestCase):
         os.chdir(self.TmpWorkingDirPath)
 
     def test_defect__norepo(self):
-        with self.assertRaises(pygitversionhelper.gitversionhelper.repository.notAGitRepository) as context:
+        with self.assertRaises(pygitversionhelper.gitversionhelper.repository.notAGitRepository) :
             _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion()
 
     def tearDown(self):