From bf9b4f2207b2795079163bdcc471adaf3f4702ce Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 23:05:20 +0000 Subject: [PATCH 01/30] update from pychangelogfactory --- Jenkinsfile | 2 +- mkdocs.yml | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index 87713da..f15aeb5 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -137,7 +137,7 @@ pipeline { script { if(_PROJECT_NAME!="pygitversionhelper") { - sh(". ~/TOOLS_ENV/bin/activate && pip install git+https://chacha.ddns.net/gitea/chacha/pygitversionhelper.git@master") + sh(". ~/TOOLS_ENV/bin/activate && pip install pygitversionhelper") } else { diff --git a/mkdocs.yml b/mkdocs.yml index f39751d..71d6d83 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,11 @@ +# pyChaChaDummyProject (c) by chacha +# +# pyChaChaDummyProject is licensed under a +# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License. +# +# You should have received a copy of the license along with this +# work. If not, see . + docs_dir: docs site_name: pygitversionhelper site_url: 'https://chacha.ddns.net/mkdocs-web/chacha/pygitversionhelper/latest/' -- 2.47.3 From 4701015ba84b97a6e12a92259f634bb1c086783a Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 23:06:20 +0000 Subject: [PATCH 02/30] update name --- .project | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.project b/.project index abb1fea..83b3568 100644 --- a/.project +++ b/.project @@ -1,6 +1,6 @@ - gitversionhelper + pygitversionhelper -- 2.47.3 From 8bdc425b3c40b7534771b3874ea48e50500dc547 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 23:13:40 +0000 Subject: [PATCH 03/30] updates --- helpers/__init__.py | 2 +- helpers/__main__.py | 153 ++-- helpers/changelog_gen.py | 15 +- helpers/doc_gen.py | 125 +-- helpers/helper_base.py | 78 +- helpers/quality_check.py | 344 +++---- helpers/types_check.py | 64 +- helpers/unit_test.py | 75 +- test/test_gitversionhelper.py | 1594 +++++++++++++++++++-------------- 9 files changed, 1228 insertions(+), 1222 deletions(-) diff --git a/helpers/__init__.py b/helpers/__init__.py index d2eaf8e..725cc2e 100644 --- a/helpers/__init__.py +++ b/helpers/__init__.py @@ -4,4 +4,4 @@ # Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License. # # You should have received a copy of the license along with this -# work. If not, see . +# work. If not, see . \ No newline at end of file diff --git a/helpers/__main__.py b/helpers/__main__.py index 51d805c..8539d81 100644 --- a/helpers/__main__.py +++ b/helpers/__main__.py @@ -16,132 +16,89 @@ import os import logging import sys -if __package__ == "helpers": +if __package__=="helpers": # when calling the module from: > python -m helpers - from .types_check import types_check - from .quality_check import quality_check - from .unit_test import unit_test - from .doc_gen import doc_gen - from .changelog_gen import changelog_gen -else: + from .types_check import types_check + from .quality_check import quality_check + from .unit_test import unit_test + from .doc_gen import doc_gen + from .changelog_gen import changelog_gen +else: # when calling the __main__.py file (from IDE) - from helpers.types_check import types_check - from helpers.quality_check import quality_check - from helpers.unit_test import unit_test - from helpers.doc_gen import doc_gen - from helpers.changelog_gen import changelog_gen - + from helpers.types_check import types_check + from helpers.quality_check import quality_check + from helpers.unit_test import unit_test + from helpers.doc_gen import doc_gen + from helpers.changelog_gen import changelog_gen + logging.getLogger().setLevel(logging.INFO) if __name__ == "__main__": - project_rootdir_path = Path(__file__).parent.parent.absolute() + project_rootdir_path=Path(__file__).parent.parent.absolute() with open(project_rootdir_path / "pyproject.toml", mode="rb") as fp: pyproject = tomli.load(fp) + + parser = argparse.ArgumentParser( prog = 'continuous-integration-helper', + description = 'A tiny set of scripts to help continous integration on python') + + parser.add_argument('-tc', '--type-check', dest='typecheck', action='store_true', help='enable static typing check') + + parser.add_argument('-ut', '--unit-test', dest='unittest', action='store_true', help='enable unit-test') + parser.add_argument('-cc', '--coverage-check', dest='coveragecheck', action='store_true', help='enable unit-test coverage check (requires unit-test)') - parser = argparse.ArgumentParser( - prog="continuous-integration-helper", - description="A tiny set of scripts to help continous integration on python", - ) - - parser.add_argument( - "-tc", - "--type-check", - dest="typecheck", - action="store_true", - help="enable static typing check", - ) - - parser.add_argument( - "-ut", - "--unit-test", - dest="unittest", - action="store_true", - help="enable unit-test", - ) - parser.add_argument( - "-cc", - "--coverage-check", - dest="coveragecheck", - action="store_true", - help="enable unit-test coverage check (requires unit-test)", - ) - - parser.add_argument( - "-qc", - "--quality-check", - dest="qualitycheck", - action="store_true", - help="enable code quality check", - ) - - parser.add_argument( - "-dg", - "--doc-gen", - dest="docgen", - action="store_true", - help="enable documentation generation using MkDoc", - ) - parser.add_argument( - "-pdf", - "--doc-gen-pdf", - dest="docgenpdf", - action="store_true", - help="enable pdf documentation export (requires doc-gen)", - ) - - parser.add_argument( - "-clg", - "--changelog-gen", - dest="changeloggen", - action="store_true", - help="enable changelog generation", - ) - + parser.add_argument('-qc', '--quality-check', dest='qualitycheck', action='store_true', help='enable code quality check') + + parser.add_argument('-dg', '--doc-gen', dest='docgen', action='store_true', help='enable documentation generation using MkDoc') + parser.add_argument('-pdf', '--doc-gen-pdf', dest='docgenpdf', action='store_true', help='enable pdf documentation export (requires doc-gen)') + + parser.add_argument('-clg', '--changelog-gen', dest='changeloggen', action='store_true', help='enable changelog generation') + args = parser.parse_args() - + ################################## # Dev / Debug forced toogles # - # -------------------------------- + #-------------------------------- # - # args.typecheck = True - # args.qualitycheck = True - # args.unittest = True - # args.coveragecheck = True - # args.docgen = True - # args.docgenpdf = True - # args.changeloggen = True - + #args.typecheck = True + #args.qualitycheck = True + #args.unittest = True + #args.coveragecheck = True + #args.docgen = True + #args.docgenpdf = True + #args.changeloggen = True + helpers = [] - if args.typecheck == True: + if args.typecheck == True: helpers.append(types_check) - - if args.unittest == True: + + if args.unittest == True: helpers.append(unit_test) - - if args.coveragecheck == True: + + if args.coveragecheck == True: if args.unittest == True: unit_test.enable_coverage_check = True else: raise RuntimeError("unit-test is required to enable coverage-check") - - if args.qualitycheck == True: + + if args.qualitycheck == True: helpers.append(quality_check) - - if args.docgen == True: + + if args.docgen == True: helpers.append(doc_gen) - - if args.docgenpdf == True: + + if args.docgenpdf==True: if args.docgen == True: doc_gen.enable_gen_pdf = True else: raise RuntimeError("doc-gen is required to enable doc-gen-pdf") - - if args.changeloggen == True: + + if args.changeloggen == True: helpers.append(changelog_gen) - + for helper in helpers: - helper.set_context(project_rootdir_path, pyproject) + helper.set_context(project_rootdir_path,pyproject) helper.reset_result_dir() helper.do_job() + diff --git a/helpers/changelog_gen.py b/helpers/changelog_gen.py index f4a15cb..a0b5734 100644 --- a/helpers/changelog_gen.py +++ b/helpers/changelog_gen.py @@ -9,15 +9,16 @@ from __future__ import annotations from typing import TYPE_CHECKING -# from pathlib import Path -# import os -# import datetime +#from pathlib import Path +#import os +#import datetime from .helper_base import helper_base -class changelog_gen(helper_base): - @classmethod - def do_job(cls): - pass +class changelog_gen(helper_base): + + @classmethod + def do_job(cls): + pass \ No newline at end of file diff --git a/helpers/doc_gen.py b/helpers/doc_gen.py index 790cf27..05dcb38 100644 --- a/helpers/doc_gen.py +++ b/helpers/doc_gen.py @@ -17,7 +17,6 @@ from pathlib import Path from distutils.dir_util import copy_tree import yaml - try: from yaml import CLoader as Loader, CDumper as Dumper except ImportError: @@ -25,44 +24,35 @@ except ImportError: from .helper_base import helper_withresults_base - -class doc_gen(helper_withresults_base): +class doc_gen(helper_withresults_base): enable_gen_pdf: bool = False - - @classmethod - def do_job(cls): + + @classmethod + def do_job(cls): print(cls.project_rootdir_path) print() - + # create doc root dir - doc_path = cls.project_rootdir_path / "docs" + doc_path = cls.project_rootdir_path/"docs" cls._reset_dir(doc_path) - - site_path = cls.get_result_dir() / "site" + + site_path = cls.get_result_dir()/"site" cls._reset_dir(site_path) - + # copy files from main project dir - shutil.copyfile( - str(cls.project_rootdir_path / "README.md"), str(doc_path / "README.md") - ) - shutil.copyfile( - str(cls.project_rootdir_path / "LICENSE.md"), str(doc_path / "LICENSE.md") - ) - + shutil.copyfile(str(cls.project_rootdir_path/"README.md"),str(doc_path/"README.md")) + shutil.copyfile(str(cls.project_rootdir_path/"LICENSE.md"),str(doc_path/"LICENSE.md")) + # copy files from static-doc dir - copy_tree(str(cls.project_rootdir_path / "docs-static"), str(doc_path)) - + copy_tree(str(cls.project_rootdir_path/"docs-static"),str(doc_path)) + # generating API doc + nav from python docstrings reference_path = doc_path / "reference" cls._reset_dir(reference_path) - + for path in sorted((cls.project_rootdir_path / "src").rglob("*.py")): - module_path = path.relative_to( - cls.project_rootdir_path / "src" - ).with_suffix("") - doc_path = path.relative_to(cls.project_rootdir_path / "src").with_suffix( - ".md" - ) + module_path = path.relative_to(cls.project_rootdir_path/ "src").with_suffix("") + doc_path = path.relative_to(cls.project_rootdir_path/ "src").with_suffix(".md") full_doc_path = Path(reference_path, doc_path) parts = list(module_path.parts) @@ -71,60 +61,43 @@ class doc_gen(helper_withresults_base): parts = parts[:-1] elif parts[-1] == "__main__": continue - + cls._reset_dir(os.path.dirname(full_doc_path)) with open(full_doc_path, "w+") as fd: - identifier = "src." + ".".join(parts) + identifier = "src."+".".join(parts) print("::: " + identifier, file=fd) - - cmdopts = [ - f"{sys.executable}", - "-m", - "mkdocs", - "-v", - "build", - "--site-dir", - str(site_path), - "--clean", - ] - + + + cmdopts = [f"{sys.executable}","-m","mkdocs","-v","build","--site-dir",str(site_path),"--clean"] + # little hack here, to enable / disable pdf generation using own class config - # => reason is mkdocs seems to try loading the plugin even if we disable it, so we need to + # => reason is mkdocs seems to try loading the plugin even if we disable it, so we need to # manually process the configuration file. - mkdocsCfg = None - with open(cls.project_rootdir_path / "mkdocs.yml", "r") as mkdocsCfgFile: + mkdocsCfg=None + with open(cls.project_rootdir_path / "mkdocs.yml",'r') as mkdocsCfgFile: mkdocsCfg = yaml.load(mkdocsCfgFile, Loader=yaml.SafeLoader) - - if cls.enable_gen_pdf == True: - mkdocsCfg["plugins"].append( - { - "with-pdf": { - "cover_subtitle": "User Manual", - "cover_logo": str( - cls.project_rootdir_path / "docs-static" / "Library.jpg" - ), - "verbose": False, - "media_type": "print", - "headless_chrome_path": "chromium", - "exclude_pages": ["LICENSE"], - "output_path": str(site_path / "pdf" / "manual.pdf"), - } - } - ) + + if cls.enable_gen_pdf==True: + mkdocsCfg['plugins'].append({ 'with-pdf':{ + 'cover_subtitle': 'User Manual', + 'cover_logo': str(cls.project_rootdir_path / 'docs-static' / 'Library.jpg'), + 'verbose': False, + 'media_type': 'print', + 'exclude_pages': ['LICENSE'], + 'output_path': str(site_path / 'pdf' / 'manual.pdf') + }}) else: - for subelem in mkdocsCfg["plugins"]: - if isinstance(subelem, dict): - if "with-pdf" in subelem.keys(): - mkdocsCfg["plugins"].remove(subelem) - break - - with open(cls.project_rootdir_path / "mkdocs.yml", "w") as mkdocsCfgFile: - mkdocsCfgFile.write( - yaml.dump( - mkdocsCfg, Dumper=Dumper, default_flow_style=False, sort_keys=False - ) - ) - - res = cls.run_cmd(cmdopts) + for subelem in mkdocsCfg['plugins']: + if isinstance(subelem,dict) : + if 'with-pdf' in subelem.keys(): + mkdocsCfg['plugins'].remove(subelem) + break + + with open(cls.project_rootdir_path / "mkdocs.yml",'w') as mkdocsCfgFile: + mkdocsCfgFile.write(yaml.dump(mkdocsCfg, Dumper=Dumper,default_flow_style=False, sort_keys=False)) + + + res=cls.run_cmd(cmdopts) print(res.decode()) - print(" !! done") + print(' !! done') + diff --git a/helpers/helper_base.py b/helpers/helper_base.py index be2583b..74cf0e8 100644 --- a/helpers/helper_base.py +++ b/helpers/helper_base.py @@ -9,76 +9,64 @@ from __future__ import annotations from typing import TYPE_CHECKING -from abc import ABC, abstractmethod +from abc import ABC,abstractmethod import os from pathlib import Path import subprocess if TYPE_CHECKING: # Only imports the below statements during type checking - from typing import Union - + from typing import Union class helper_base(ABC): - project_rootdir_path: Union[Path, None] = None - pyproject: Union[dict, None] = None - current_dir: Union[Path, None] = None - - @classmethod - def set_context(cls, project_rootdir_path: Path, pyproject: dict): - cls.project_rootdir_path = project_rootdir_path - cls.pyproject = pyproject - cls.current_dir = Path(__file__).parent.absolute() - - @classmethod + project_rootdir_path: Union[Path,None] = None + pyproject: Union[dict,None] = None + current_dir: Union[Path,None] = None + + @classmethod + def set_context(cls,project_rootdir_path:Path, pyproject:dict): + cls.project_rootdir_path = project_rootdir_path + cls.pyproject = pyproject + cls.current_dir = Path(__file__).parent.absolute() + + @classmethod def get_result_dir(cls): return None - - @staticmethod - def _reset_dir(dirpath: Path): + + @staticmethod + def _reset_dir(dirpath:Path): dirpath = Path(dirpath) if not os.path.exists(dirpath): os.makedirs(dirpath) - [f.unlink() for f in Path(dirpath).glob("*") if f.is_file()] - - @classmethod + [f.unlink() for f in Path(dirpath).glob("*") if f.is_file()] + + @classmethod def reset_result_dir(cls): result_dir = cls.get_result_dir() if result_dir != None: cls._reset_dir(result_dir) - - @classmethod + + @classmethod @abstractmethod - def do_job(cls): + def do_job(cls): raise NotImplementedError() - @classmethod + @classmethod def run_cmd_(cls, cmdarray): - process = subprocess.run( - cmdarray, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE, - shell=True, - check=True, - ) + process = subprocess.run(cmdarray, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True, check=True) return process.stdout - - @classmethod + + @classmethod def run_cmd(cls, cmdarray): p = subprocess.run(cmdarray, capture_output=True) print(p.stdout) print(p.stderr) return p.stdout - - + class helper_withresults_base(helper_base): - helper_results_dir: Union[Path, None] = None - - @classmethod + helper_results_dir: Union[Path,None] = None + + @classmethod def get_result_dir(cls): - if cls.helper_results_dir == None: - cls.helper_results_dir = cls.__name__ - return ( - Path(__file__).parent.parent.absolute() - / "helpers-results" - / cls.helper_results_dir - ) + if cls.helper_results_dir==None: + cls.helper_results_dir=cls.__name__ + return Path(__file__).parent.parent.absolute() / "helpers-results" / cls.helper_results_dir \ No newline at end of file diff --git a/helpers/quality_check.py b/helpers/quality_check.py index 7a36a87..7616d5f 100644 --- a/helpers/quality_check.py +++ b/helpers/quality_check.py @@ -25,289 +25,197 @@ import pylint_json2html from .helper_base import helper_withresults_base - class PyLintMetricNotFound(Warning): pass - -class quality_check(helper_withresults_base): - PylintMessageList = dict() - - @classmethod +class quality_check(helper_withresults_base): + PylintMessageList=dict() + + @classmethod def GetPylintMessageList(cls): - Messagelist = dict() - regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)" - for line in cls.run_cmd( - [sys.executable, "-m", "pylint", "--list-msgs"] - ).splitlines(): - if res := re.search(regex, line.decode()): - Messagelist[res.group(1)] = res.group(2) + Messagelist=dict() + regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)" + for line in cls.run_cmd([sys.executable,"-m","pylint","--list-msgs"]).splitlines(): + if res:=re.search(regex,line.decode()): + Messagelist[res.group(1)]=res.group(2) cls.PylintMessageList = Messagelist @staticmethod - def TryExtractPYReportMetric(line: str, tag: str): - regex = f"^(?:\|{tag}\s*\|)(\d+)(?=\s*|)" - if res := re.search(regex, line): + def TryExtractPYReportMetric(line: str,tag: str): + regex=f"^(?:\|{tag}\s*\|)(\d+)(?=\s*|)" + if res:=re.search(regex,line): return float(res.group(1)) raise PyLintMetricNotFound() - @classmethod - def do_job(cls): + @classmethod + def do_job(cls): print("checking code quality ...") cls.GetPylintMessageList() - - RES_all = dict() + + RES_all=dict() with StringIO() as StdOutput: - JsonContent = "" + JsonContent="" with redirect_stdout(StdOutput): - pylint_Run( - [ - "--output-format=json,parseable", - "--disable=invalid-name", - "--ignore=_version.py", - "--reports=y", - "--score=yes", - "--max-line-length=140", - "src." + cls.pyproject["project"]["name"], - ], - exit=False, - ) - - with open( - cls.get_result_dir() / "report.json", "w+", encoding="utf-8" - ) as Outfile: + pylint_Run(['--output-format=json,parseable', + '--disable=invalid-name', + '--ignore=_version.py', + '--reports=y', + '--score=yes', + '--max-line-length=140', + 'src.' + cls.pyproject['project']['name']], exit=False) + + with open(cls.get_result_dir()/"report.json","w+", encoding='utf-8') as Outfile: # hacky way of exctracting json + having overall score... class TScanState(Enum): - TEXT_REPORT = 1 - JSON_REPORT = 2 - OTHER_REPORT_START = 3 - OTHER_REPORT_STATISTICS = 4 - OTHER_REPORT_METRICS = 5 - OTHER_REPORT_DUPLICATION = 6 - OTHER_REPORT_MESSAGES_CAT = 7 - OTHER_REPORT_MESSAGES = 8 - OTHER_REPORT_END = 99 - - RES_all["Statistics"] = dict() - RES_all["RawMetrics"] = dict() - RES_all["RawMetricsPercent"] = dict() - RES_all["Duplication"] = dict() - RES_all["MessagesCat"] = dict() - RES_all["Messages"] = dict() - RES_all["GlobalScore"] = -999 - RES_all["NbAnalysedStatments"] = -999 - RES_all["NbAnalysedLines"] = -999 - + TEXT_REPORT = 1 + JSON_REPORT = 2 + OTHER_REPORT_START = 3 + OTHER_REPORT_STATISTICS = 4 + OTHER_REPORT_METRICS = 5 + OTHER_REPORT_DUPLICATION = 6 + OTHER_REPORT_MESSAGES_CAT = 7 + OTHER_REPORT_MESSAGES = 8 + OTHER_REPORT_END = 99 + + RES_all['Statistics'] = dict() + RES_all['RawMetrics'] = dict() + RES_all['RawMetricsPercent'] = dict() + RES_all['Duplication'] = dict() + RES_all['MessagesCat'] = dict() + RES_all['Messages'] = dict() + RES_all['GlobalScore'] = -999 + RES_all['NbAnalysedStatments'] = -999 + RES_all['NbAnalysedLines'] = -999 + ScanState = TScanState.TEXT_REPORT - for line in StdOutput.getvalue().split("\n"): - print(line) - if ScanState == TScanState.TEXT_REPORT: + for line in StdOutput.getvalue().split('\n'): + print(line) + if ScanState == TScanState.TEXT_REPORT: # ignoring this part, we need json - if line == "[": - JsonContent += line + if line=='[': + JsonContent+=line ScanState = TScanState.JSON_REPORT - elif line == "[]": - JsonContent += line + elif line=='[]': + JsonContent+=line ScanState = TScanState.OTHER_REPORT_START - - elif ScanState == TScanState.JSON_REPORT: - JsonContent += line - if line == "]": + + elif ScanState == TScanState.JSON_REPORT: + JsonContent+=line + if line==']': ScanState = TScanState.OTHER_REPORT_START - - elif ScanState == TScanState.OTHER_REPORT_START: - if res := re.search(r"^(\d+)(?= statements analysed.)", line): - RES_all["NbAnalysedStatments"] = float(res.group(1)) + + elif ScanState == TScanState.OTHER_REPORT_START: + if res:=re.search(r"^(\d+)(?= statements analysed.)",line): + RES_all['NbAnalysedStatments'] = float(res.group(1)) if line == "Statistics by type": ScanState = TScanState.OTHER_REPORT_STATISTICS - - elif ScanState == TScanState.OTHER_REPORT_STATISTICS: - if res := re.search( - r"^(\d+)(?= lines have been analyzed)", line - ): - RES_all["NbAnalysedLines"] = float(res.group(1)) + + elif ScanState == TScanState.OTHER_REPORT_STATISTICS: + if res:=re.search(r"^(\d+)(?= lines have been analyzed)",line): + RES_all['NbAnalysedLines' ]= float(res.group(1)) elif line == "Raw metrics": ScanState = TScanState.OTHER_REPORT_METRICS else: - with suppress(PyLintMetricNotFound): - RES_all["Statistics"][ - "module" - ] = cls.TryExtractPYReportMetric(line, "module") - with suppress(PyLintMetricNotFound): - RES_all["Statistics"][ - "class" - ] = cls.TryExtractPYReportMetric(line, "class") - with suppress(PyLintMetricNotFound): - RES_all["Statistics"][ - "method" - ] = cls.TryExtractPYReportMetric(line, "method") - with suppress(PyLintMetricNotFound): - RES_all["Statistics"][ - "function" - ] = cls.TryExtractPYReportMetric(line, "function") - - elif ScanState == TScanState.OTHER_REPORT_METRICS: + with suppress(PyLintMetricNotFound): RES_all['Statistics']['module'] = cls.TryExtractPYReportMetric(line,"module") + with suppress(PyLintMetricNotFound): RES_all['Statistics']['class'] = cls.TryExtractPYReportMetric(line,"class") + with suppress(PyLintMetricNotFound): RES_all['Statistics']['method'] = cls.TryExtractPYReportMetric(line,"method") + with suppress(PyLintMetricNotFound): RES_all['Statistics']['function'] = cls.TryExtractPYReportMetric(line,"function") + + elif ScanState == TScanState.OTHER_REPORT_METRICS: if line == "Duplication": - RES_all["RawMetricsPercent"]["code"] = ( - RES_all["RawMetrics"]["code"] - / RES_all["NbAnalysedLines"] - ) - RES_all["RawMetricsPercent"]["docstring"] = ( - RES_all["RawMetrics"]["docstring"] - / RES_all["NbAnalysedLines"] - ) - RES_all["RawMetricsPercent"]["comment"] = ( - RES_all["RawMetrics"]["comment"] - / RES_all["NbAnalysedLines"] - ) - RES_all["RawMetricsPercent"]["empty"] = ( - RES_all["RawMetrics"]["empty"] - / RES_all["NbAnalysedLines"] - ) + RES_all['RawMetricsPercent']['code'] = RES_all['RawMetrics']['code'] / RES_all['NbAnalysedLines' ] + RES_all['RawMetricsPercent']['docstring'] = RES_all['RawMetrics']['docstring'] / RES_all['NbAnalysedLines' ] + RES_all['RawMetricsPercent']['comment'] = RES_all['RawMetrics']['comment'] / RES_all['NbAnalysedLines' ] + RES_all['RawMetricsPercent']['empty'] = RES_all['RawMetrics']['empty'] / RES_all['NbAnalysedLines' ] ScanState = TScanState.OTHER_REPORT_DUPLICATION else: - with suppress(PyLintMetricNotFound): - RES_all["RawMetrics"][ - "code" - ] = cls.TryExtractPYReportMetric(line, "code") - with suppress(PyLintMetricNotFound): - RES_all["RawMetrics"][ - "docstring" - ] = cls.TryExtractPYReportMetric(line, "docstring") - with suppress(PyLintMetricNotFound): - RES_all["RawMetrics"][ - "comment" - ] = cls.TryExtractPYReportMetric(line, "comment") - with suppress(PyLintMetricNotFound): - RES_all["RawMetrics"][ - "empty" - ] = cls.TryExtractPYReportMetric(line, "empty") - - elif ScanState == TScanState.OTHER_REPORT_DUPLICATION: + with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['code'] = cls.TryExtractPYReportMetric(line,"code") + with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['docstring'] = cls.TryExtractPYReportMetric(line,"docstring") + with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['comment'] = cls.TryExtractPYReportMetric(line,"comment") + with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['empty'] = cls.TryExtractPYReportMetric(line,"empty") + + elif ScanState == TScanState.OTHER_REPORT_DUPLICATION: if line == "Messages by category": ScanState = TScanState.OTHER_REPORT_MESSAGES_CAT else: - with suppress(PyLintMetricNotFound): - RES_all["Duplication"][ - "NbDupLines" - ] = cls.TryExtractPYReportMetric( - line, "nb duplicated lines" - ) - with suppress(PyLintMetricNotFound): - RES_all["Duplication"][ - "PersentDuplicatedLines" - ] = cls.TryExtractPYReportMetric( - line, "percent duplicated lines" - ) - - elif ScanState == TScanState.OTHER_REPORT_MESSAGES_CAT: + with suppress(PyLintMetricNotFound): RES_all['Duplication']['NbDupLines'] = cls.TryExtractPYReportMetric(line,"nb duplicated lines") + with suppress(PyLintMetricNotFound): RES_all['Duplication']['PersentDuplicatedLines'] = cls.TryExtractPYReportMetric(line,"percent duplicated lines") + + elif ScanState == TScanState.OTHER_REPORT_MESSAGES_CAT: if line == "Messages": ScanState = TScanState.OTHER_REPORT_MESSAGES else: - with suppress(PyLintMetricNotFound): - RES_all["MessagesCat"][ - "Convention" - ] = cls.TryExtractPYReportMetric(line, "convention") - with suppress(PyLintMetricNotFound): - RES_all["MessagesCat"][ - "Refactor" - ] = cls.TryExtractPYReportMetric(line, "refactor") - with suppress(PyLintMetricNotFound): - RES_all["MessagesCat"][ - "Warning" - ] = cls.TryExtractPYReportMetric(line, "warning") - with suppress(PyLintMetricNotFound): - RES_all["MessagesCat"][ - "Error" - ] = cls.TryExtractPYReportMetric(line, "error") - - elif ScanState == TScanState.OTHER_REPORT_MESSAGES: + with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Convention'] = cls.TryExtractPYReportMetric(line,"convention") + with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Refactor'] = cls.TryExtractPYReportMetric(line,"refactor") + with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Warning'] = cls.TryExtractPYReportMetric(line,"warning") + with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Error'] = cls.TryExtractPYReportMetric(line,"error") + + elif ScanState == TScanState.OTHER_REPORT_MESSAGES: # approx match because the number of '-' depend on screen width.. if line.startswith("--------"): ScanState = TScanState.OTHER_REPORT_END else: for PylintMessage in cls.PylintMessageList.keys(): - with suppress(PyLintMetricNotFound): - RES_all["Messages"][ - PylintMessage - ] = cls.TryExtractPYReportMetric( - line, PylintMessage - ) - - elif ScanState == TScanState.OTHER_REPORT_END: - if res := re.search( - r"(?<=Your code has been rated at )(\d+(?:\.\d+)?)/10", line - ): - RES_all["GlobalScore"] = float(res.group(1)) - print(RES_all["GlobalScore"]) + with suppress(PyLintMetricNotFound): RES_all['Messages'][PylintMessage] = cls.TryExtractPYReportMetric(line,PylintMessage) + + elif ScanState == TScanState.OTHER_REPORT_END: + if res:=re.search(r"(?<=Your code has been rated at )(\d+(?:\.\d+)?)/10",line): + RES_all['GlobalScore']=float(res.group(1)) + print(RES_all['GlobalScore']) else: raise RuntimeError("Invalid ScanState") Outfile.write(JsonContent) - - with open(cls.get_result_dir() / "metrics.json", "w") as json_file: + + with open(cls.get_result_dir()/"metrics.json", 'w') as json_file: json.dump(RES_all, json_file) - - # exporting all Data in one csv, unused atm because jenkins seems not able to select columns from csv an keep displaying all... + + # exporting all Data in one csv, unused atm because jenkins seems not able to select columns from csv an keep displaying all... # => to export a working full csv we need to a 'flat' dict (no more nested dict) RES_all_trim = copy.deepcopy(RES_all) del RES_all_trim["Messages"] - flat_RES_all = pandas.json_normalize(RES_all_trim, sep="_").to_dict( - orient="records" - )[0] - - with open(cls.get_result_dir() / "metrics.csv", "w", newline="") as csv_file: - writer = csv.DictWriter(csv_file, fieldnames=flat_RES_all.keys()) + flat_RES_all=pandas.json_normalize(RES_all_trim, sep='_').to_dict(orient='records')[0] + + with open(cls.get_result_dir()/"metrics.csv", 'w', newline='') as csv_file: + writer = csv.DictWriter(csv_file,fieldnames=flat_RES_all.keys()) writer.writeheader() writer.writerow(flat_RES_all) - + # splited csv exports for jenkins plots: RawMetricsPercent RES_all_percent = RES_all["RawMetricsPercent"] - with open( - cls.get_result_dir() / "metrics_rawpercent.csv", "w", newline="" - ) as csv_file: - writer = csv.DictWriter(csv_file, fieldnames=RES_all_percent.keys()) + with open(cls.get_result_dir()/"metrics_rawpercent.csv", 'w', newline='') as csv_file: + writer = csv.DictWriter(csv_file,fieldnames=RES_all_percent.keys()) writer.writeheader() writer.writerow(RES_all_percent) # splited csv exports for jenkins plots: Statistics + Duplication + NbAnalysedStatments + NbAnalysedLines RES_all_stats = copy.deepcopy(RES_all["Statistics"]) - RES_all_stats["NbDupLines"] = RES_all["Duplication"]["NbDupLines"] - RES_all_stats["PersentDuplicatedLines"] = RES_all["Duplication"][ - "PersentDuplicatedLines" - ] - RES_all_stats["NbAnalysedStatments"] = RES_all["NbAnalysedStatments"] - RES_all_stats["NbAnalysedLines"] = RES_all["NbAnalysedLines"] - with open( - cls.get_result_dir() / "metrics_Statistics.csv", "w", newline="" - ) as csv_file: - writer = csv.DictWriter(csv_file, fieldnames=RES_all_stats.keys()) + RES_all_stats["NbDupLines"] = RES_all['Duplication']['NbDupLines'] + RES_all_stats["PersentDuplicatedLines"] = RES_all['Duplication']['PersentDuplicatedLines'] + RES_all_stats["NbAnalysedStatments"] = RES_all['NbAnalysedStatments' ] + RES_all_stats["NbAnalysedLines"] = RES_all['NbAnalysedLines' ] + with open(cls.get_result_dir()/"metrics_Statistics.csv", 'w', newline='') as csv_file: + writer = csv.DictWriter(csv_file,fieldnames=RES_all_stats.keys()) writer.writeheader() writer.writerow(RES_all_stats) - + # splited csv exports for jenkins plots: Statistics + Duplication - RES_all_MessagesCat = RES_all["MessagesCat"] - with open( - cls.get_result_dir() / "metrics_MessagesCat.csv", "w", newline="" - ) as csv_file: - writer = csv.DictWriter(csv_file, fieldnames=RES_all_MessagesCat.keys()) + RES_all_MessagesCat = RES_all['MessagesCat'] + with open(cls.get_result_dir()/"metrics_MessagesCat.csv", 'w', newline='') as csv_file: + writer = csv.DictWriter(csv_file,fieldnames=RES_all_MessagesCat.keys()) writer.writeheader() writer.writerow(RES_all_MessagesCat) - + # splited csv exports for jenkins plots: GlobalScore - RES_GlobalScore = {"GlobalScore": RES_all["GlobalScore"]} - with open( - cls.get_result_dir() / "metrics_GlobalScore.csv", "w", newline="" - ) as csv_file: - writer = csv.DictWriter(csv_file, fieldnames=RES_GlobalScore.keys()) + RES_GlobalScore = {'GlobalScore': RES_all['GlobalScore']} + with open(cls.get_result_dir()/"metrics_GlobalScore.csv", 'w', newline='') as csv_file: + writer = csv.DictWriter(csv_file,fieldnames=RES_GlobalScore.keys()) writer.writeheader() writer.writerow(RES_GlobalScore) - + # converting the report using pylint_json2html (/!\ internal API, but as their is no leading '_' ...) - with open( - cls.get_result_dir() / "report.html", "w+", encoding="utf-8" - ) as Outfile: + with open(cls.get_result_dir()/"report.html","w+", encoding='utf-8') as Outfile: raw_data = json.loads(JsonContent) - report = pylint_json2html.Report(raw_data) + report=pylint_json2html.Report( raw_data) Outfile.write(report.render()) - + print("Done") diff --git a/helpers/types_check.py b/helpers/types_check.py index 6179581..4816e0c 100644 --- a/helpers/types_check.py +++ b/helpers/types_check.py @@ -16,46 +16,36 @@ from mypy import api from .helper_base import helper_withresults_base -class types_check(helper_withresults_base): +class types_check(helper_withresults_base): JUnitReportName = "junit.xml" - - @classmethod - def do_job(cls): + + @classmethod + def do_job(cls): print("checking code typing ...") - result = api.run( - [ # project path - "-m", - "src." + str(cls.pyproject["project"]["name"]), - # analysis configuration - "--ignore-missing-imports", - "--strict-equality", - # reports generation - "--cobertura-xml-report", - str(cls.get_result_dir()), - "--html-report", - str(cls.get_result_dir()), - "--linecount-report", - str(cls.get_result_dir()), - "--linecoverage-report", - str(cls.get_result_dir()), - "--lineprecision-report", - str(cls.get_result_dir()), - "--txt-report", - str(cls.get_result_dir()), - "--xml-report", - str(cls.get_result_dir()), - "--junit-xml", - str(cls.get_result_dir()) + "/" + cls.JUnitReportName, - ] - ) - + result = api.run([ # project path + "-m", + "src." + str(cls.pyproject['project']['name']), + # analysis configuration + "--ignore-missing-imports", + "--strict-equality", + # reports generation + "--cobertura-xml-report", str(cls.get_result_dir()), + "--html-report", str(cls.get_result_dir()), + "--linecount-report", str(cls.get_result_dir()), + "--linecoverage-report", str(cls.get_result_dir()), + "--lineprecision-report", str(cls.get_result_dir()), + "--txt-report", str(cls.get_result_dir()), + "--xml-report", str(cls.get_result_dir()), + "--junit-xml", str(cls.get_result_dir()) + "/" + cls.JUnitReportName + ]) + if result[0]: - print("\nType checking report:\n") + print('\nType checking report:\n') print(result[0]) # stdout - + if result[1]: - print("\nError report:\n") + print('\nError report:\n') print(result[1]) # stderr - - print("\nExit status:", result[2]) - print("Done") + + print('\nExit status:', result[2]) + print("Done") \ No newline at end of file diff --git a/helpers/unit_test.py b/helpers/unit_test.py index 166fa5c..571f2da 100644 --- a/helpers/unit_test.py +++ b/helpers/unit_test.py @@ -21,41 +21,34 @@ from junit2htmlreport import parser as junit2html_parser from .helper_base import helper_withresults_base -class unit_test(helper_withresults_base): - enable_coverage_check: bool = False - enable_xml_export: bool = True +class unit_test(helper_withresults_base): + enable_coverage_check: bool = False + enable_xml_export: bool = True enable_full_xml_export: bool = True - FullReportName: str = "full_report" - CoverageReportName: str = "test_coverage" - - @classmethod - def do_job(cls): - if cls.enable_coverage_check == True: + FullReportName: str = "full_report" + CoverageReportName: str = "test_coverage" + + @classmethod + def do_job(cls): + if cls.enable_coverage_check==True: import coverage - + # preparing unittest framework test_loader = unittest.TestLoader() - + if cls.enable_coverage_check == True: - # we start coverage now because module files discovery is part of the coverage measurement - CoverageReportPath = Path(str(cls.get_result_dir()) + "_coverage") + #we start coverage now because module files discovery is part of the coverage measurement + CoverageReportPath = Path(str(cls.get_result_dir())+"_coverage") cls._reset_dir(CoverageReportPath) - cov = coverage.Coverage( - cover_pylib=False, - branch=True, - source_pkgs=["src." + cls.pyproject["project"]["name"]], - ) + cov = coverage.Coverage(cover_pylib=False,branch=True,source_pkgs=["src."+cls.pyproject['project']['name']]) cov.start() - - package_tests = test_loader.discover( - start_dir=str(cls.project_rootdir_path / "test"), - top_level_dir=str(cls.project_rootdir_path / "test"), - ) + + package_tests = test_loader.discover(start_dir=str(cls.project_rootdir_path / "test"),top_level_dir=str(cls.project_rootdir_path / "test")) if cls.enable_xml_export: testRunner = xmlrunner.XMLTestRunner(output=str(str(cls.get_result_dir()))) else: testRunner = unittest.TextTestRunner() - + # running the test testRunner.run(package_tests) @@ -64,33 +57,23 @@ class unit_test(helper_withresults_base): cov.stop() cov.save() cov.html_report(directory=str(CoverageReportPath)) - cov.xml_report( - outfile=(CoverageReportPath / f"{cls.CoverageReportName}.xml") - ) - + cov.xml_report(outfile=(CoverageReportPath/f"{cls.CoverageReportName}.xml")) + # computing results (Only if xml available) if cls.enable_full_xml_export == True: print("Full reports generation...") - FullReportPath = Path(str(cls.get_result_dir()) + "_full") + FullReportPath = Path(str(cls.get_result_dir())+"_full") cls._reset_dir(FullReportPath) - + FullJUnitReport = JUnitXml() - for fname in [ - fname - for fname in os.listdir(cls.get_result_dir()) - if fname.endswith(".xml") - ]: - FullJUnitReport += JUnitXml.fromfile(str(cls.get_result_dir() / fname)) - + for fname in [fname for fname in os.listdir(cls.get_result_dir()) if fname.endswith('.xml')]: + FullJUnitReport+=JUnitXml.fromfile(str(cls.get_result_dir() / fname)) + current_datetime = datetime.datetime.utcnow().strftime("%Y%m%dT%H%M%SZ") full_report_base_name = f'{cls.pyproject["project"]["name"]}-{cls.FullReportName}-{current_datetime}' - FullJUnitReport.write(str(FullReportPath / f"{full_report_base_name}.xml")) - report = junit2html_parser.Junit( - FullReportPath / f"{full_report_base_name}.xml" - ) + FullJUnitReport.write(str(FullReportPath / f'{full_report_base_name}.xml')) + report = junit2html_parser.Junit(FullReportPath/ f'{full_report_base_name}.xml') html = report.html() - with open( - FullReportPath / f"{full_report_base_name}.html", "wb" - ) as outfile: - outfile.write(html.encode("utf-8")) - print("Done") + with open(FullReportPath/ f'{full_report_base_name}.html', "wb") as outfile: + outfile.write(html.encode('utf-8')) + print("Done") \ No newline at end of file diff --git a/test/test_gitversionhelper.py b/test/test_gitversionhelper.py index 7ae1c57..1507609 100644 --- a/test/test_gitversionhelper.py +++ b/test/test_gitversionhelper.py @@ -16,33 +16,33 @@ import copy import time import subprocess -print(__name__) -print(__package__) - from src import pygitversionhelper -HelperRegex=r"^(?P\d+)\.(?P\d+)\.(?P\d+)([\.\-\+])?(?:.*)?" +HelperRegex = r"^(?P\d+)\.(?P\d+)\.(?P\d+)([\.\-\+])?(?:.*)?" + class Test_gitversionhelper(unittest.TestCase): def setUp(self): - self.TmpWorkingDir=tempfile.TemporaryDirectory() - self.TmpWorkingDirPath=pathlib.Path(self.TmpWorkingDir.name) + self.TmpWorkingDir = tempfile.TemporaryDirectory() + self.TmpWorkingDirPath = pathlib.Path(self.TmpWorkingDir.name) os.chdir(self.TmpWorkingDirPath) os.system("git init") os.system('git config --local user.name "john doe"') os.system('git config --local user.email "john@doe.org"') - - def _test_version_readback(self,tag:str,**kwargs): - with open("demofile.txt", "w+t") as tmpFile: + + def _test_version_readback(self, tag: str, **kwargs): + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"first commit\"") + 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) + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) self.assertIsInstance(_v.raw, str) self.assertEqual(_v.raw, tag) self.assertIsInstance(_v.major, int) @@ -50,161 +50,199 @@ class Test_gitversionhelper(unittest.TestCase): self.assertIsInstance(_v.patch, int) self.assertIsInstance(_v.pre_count, int) self.assertIsInstance(_v.post_count, int) - _m = re.match(HelperRegex, tag) - self.assertEqual(int(_m.group("MAJ")),_v.major) - self.assertEqual(int(_m.group("MIN")),_v.minor) - self.assertEqual(int(_m.group("PATCH")),_v.patch) - + 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): - _f=_v.doFormatVersion(**kwargs) - self.assertRegex(_f,HelperRegex) + + def _test_version_format( + self, + _v: pygitversionhelper.gitversionhelper.version.MetaVersion, + tag: str, + **kwargs, + ): + _f = _v.doFormatVersion(**kwargs) + self.assertRegex(_f, HelperRegex) self.assertEqual(_f, tag) - - 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_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") + _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")) - + 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") + def test_nominal__version__auto_2(self): self._test_version_readback_simple("0.0.2") + def test_nominal__version__auto_3(self): self._test_version_readback_simple("0.1.0") + def test_nominal__version__auto_4(self): self._test_version_readback_simple("0.1.1") + def test_nominal__version__auto_5(self): self._test_version_readback_simple("1.0.0") + def test_nominal__version__auto_6(self): self._test_version_readback_simple("1.1.0") + def test_nominal__version__auto_7(self): self._test_version_readback_simple("1.2.0") + def test_nominal__version__auto_8(self): self._test_version_readback_simple("1.1.1") + def test_nominal__version__auto_9(self): self._test_version_readback_simple("1.2.1") - + def test_nominal__version__auto_PEP440_post(self): self._test_version_readback_simple("1.2.1.post1") + def test_nominal__version__auto_PEP440_pre(self): self._test_version_readback_simple("1.2.1.pre1") + def test_nominal__version__auto_PEP440_post_2(self): self._test_version_readback_simple("1.2.1.post10") + def test_nominal__version__auto_PEP440_pre_2(self): self._test_version_readback_simple("1.2.1.pre10") - + def test_nominal__version__auto_SemVer_post(self): self._test_version_readback_simple("1.2.1+post.1") + def test_nominal__version__auto_SemVer_pre(self): self._test_version_readback_simple("1.2.1-pre.1") + def test_nominal__version__auto_SemVer_post_2(self): self._test_version_readback_simple("1.2.1+post.10") + def test_nominal__version__auto_Semver_pre_2(self): self._test_version_readback_simple("1.2.1-pre.10") def test_nominal__version__PEP440_1(self): - self._test_version_readback_simple("0.0.1",version_std="PEP440") + self._test_version_readback_simple("0.0.1", version_std="PEP440") + def test_nominal__version__PEP440_2(self): - self._test_version_readback_simple("0.0.2",version_std="PEP440") + self._test_version_readback_simple("0.0.2", version_std="PEP440") + def test_nominal__version__PEP440_3(self): - self._test_version_readback_simple("0.1.0",version_std="PEP440") + self._test_version_readback_simple("0.1.0", version_std="PEP440") + def test_nominal__version__PEP440_4(self): - self._test_version_readback_simple("0.1.1",version_std="PEP440") + self._test_version_readback_simple("0.1.1", version_std="PEP440") + def test_nominal__version__PEP440_5(self): - self._test_version_readback_simple("1.0.0",version_std="PEP440") + self._test_version_readback_simple("1.0.0", version_std="PEP440") + def test_nominal__version__PEP440_6(self): - self._test_version_readback_simple("1.1.0",version_std="PEP440") + self._test_version_readback_simple("1.1.0", version_std="PEP440") + def test_nominal__version__PEP440_7(self): - self._test_version_readback_simple("1.2.0",version_std="PEP440") + self._test_version_readback_simple("1.2.0", version_std="PEP440") + def test_nominal__version__PEP440_8(self): - self._test_version_readback_simple("1.1.1",version_std="PEP440") + self._test_version_readback_simple("1.1.1", version_std="PEP440") + def test_nominal__version__PEP440_9(self): - self._test_version_readback_simple("1.2.1",version_std="PEP440") + self._test_version_readback_simple("1.2.1", version_std="PEP440") + def test_nominal__version__PEP440_post(self): - self._test_version_readback_simple("1.2.1.post1",version_std="PEP440") + self._test_version_readback_simple("1.2.1.post1", version_std="PEP440") + def test_nominal__version__PEP440_pre(self): - self._test_version_readback_simple("1.2.1.pre1",version_std="PEP440") + self._test_version_readback_simple("1.2.1.pre1", version_std="PEP440") + def test_nominal__version__PEP440_post_2(self): - self._test_version_readback_simple("1.2.1.post10",version_std="PEP440") + self._test_version_readback_simple("1.2.1.post10", version_std="PEP440") + def test_nominal__version__PEP440_pre_2(self): - self._test_version_readback_simple("1.2.1.pre10",version_std="PEP440") + self._test_version_readback_simple("1.2.1.pre10", version_std="PEP440") def test_nominal__version__SemVer_1(self): - self._test_version_readback_simple("0.0.1",version_std="SemVer") + self._test_version_readback_simple("0.0.1", version_std="SemVer") + def test_nominal__version__SemVer_2(self): - self._test_version_readback_simple("0.0.2",version_std="SemVer") + self._test_version_readback_simple("0.0.2", version_std="SemVer") + def test_nominal__version__SemVer_3(self): - self._test_version_readback_simple("0.1.0",version_std="SemVer") + self._test_version_readback_simple("0.1.0", version_std="SemVer") + def test_nominal__version__SemVer_4(self): - self._test_version_readback_simple("0.1.1",version_std="SemVer") + self._test_version_readback_simple("0.1.1", version_std="SemVer") + def test_nominal__version__SemVer_5(self): - self._test_version_readback_simple("1.0.0",version_std="SemVer") + self._test_version_readback_simple("1.0.0", version_std="SemVer") + def test_nominal__version__SemVer_6(self): - self._test_version_readback_simple("1.1.0",version_std="SemVer") + self._test_version_readback_simple("1.1.0", version_std="SemVer") + def test_nominal__version__SemVer_7(self): - self._test_version_readback_simple("1.2.0",version_std="SemVer") + self._test_version_readback_simple("1.2.0", version_std="SemVer") + def test_nominal__version__SemVer_8(self): - self._test_version_readback_simple("1.1.1",version_std="SemVer") + self._test_version_readback_simple("1.1.1", version_std="SemVer") + def test_nominal__version__SemVer_9(self): - self._test_version_readback_simple("1.2.1",version_std="SemVer") + self._test_version_readback_simple("1.2.1", version_std="SemVer") + def test_nominal__version__SemVer_post(self): - self._test_version_readback_simple("1.2.1+post.1",version_std="SemVer") + self._test_version_readback_simple("1.2.1+post.1", version_std="SemVer") + def test_nominal__version__SemVer_pre(self): - self._test_version_readback_simple("1.2.1-pre.1",version_std="SemVer") + self._test_version_readback_simple("1.2.1-pre.1", version_std="SemVer") + def test_nominal__version__SemVer_post_2(self): - self._test_version_readback_simple("1.2.1+post.10",version_std="SemVer") + self._test_version_readback_simple("1.2.1+post.10", version_std="SemVer") + def test_nominal__version__SemVer_pre_2(self): - self._test_version_readback_simple("1.2.1-pre.10",version_std="SemVer") - + self._test_version_readback_simple("1.2.1-pre.10", version_std="SemVer") + def test_nominal__version__post_PEP440_to_SemVer(self): - _v=self._test_version_readback("1.2.1.post10",version_std="PEP440") - self._test_version_format(_v,"1.2.1+post.10",version_std="SemVer") - + _v = self._test_version_readback("1.2.1.post10", version_std="PEP440") + self._test_version_format(_v, "1.2.1+post.10", version_std="SemVer") + def test_nominal__version__post_SemVer_to_PEP440(self): - _v=self._test_version_readback("1.2.1+post.10",version_std="SemVer") - self._test_version_format(_v,"1.2.1.post10",version_std="PEP440") + _v = self._test_version_readback("1.2.1+post.10", version_std="SemVer") + self._test_version_format(_v, "1.2.1.post10", version_std="PEP440") def test_nominal__version__pre_PEP440_to_SemVer(self): - _v=self._test_version_readback("1.2.1.pre10",version_std="PEP440") - self._test_version_format(_v,"1.2.1-pre.10",version_std="SemVer") - + _v = self._test_version_readback("1.2.1.pre10", version_std="PEP440") + self._test_version_format(_v, "1.2.1-pre.10", version_std="SemVer") + def test_nominal__version__pre_SemVer_to_PEP440(self): - _v=self._test_version_readback("1.2.1-pre.10",version_std="SemVer") - self._test_version_format(_v,"1.2.1.pre10",version_std="PEP440") - + _v = self._test_version_readback("1.2.1-pre.10", version_std="SemVer") + self._test_version_format(_v, "1.2.1.pre10", version_std="PEP440") + def test_nominal__version__post_SemVer_nonum(self): - _v=self._test_version_readback("1.2.1+post",version_std="SemVer") - self._test_version_format(_v,"1.2.1+post.1",version_std="SemVer") - + _v = self._test_version_readback("1.2.1+post", version_std="SemVer") + self._test_version_format(_v, "1.2.1+post.1", version_std="SemVer") + def test_nominal__version__post_SemVer_nonum_random(self): - _v=self._test_version_readback("1.2.1+toto",version_std="SemVer") - self._test_version_format(_v,"1.2.1+post.1",version_std="SemVer") - + _v = self._test_version_readback("1.2.1+toto", version_std="SemVer") + self._test_version_format(_v, "1.2.1+post.1", version_std="SemVer") + def test_nominal__version__pre_SemVer_nonum(self): - _v=self._test_version_readback("1.2.1-pre",version_std="SemVer") - self._test_version_format(_v,"1.2.1-pre.1",version_std="SemVer") - + _v = self._test_version_readback("1.2.1-pre", version_std="SemVer") + self._test_version_format(_v, "1.2.1-pre.1", version_std="SemVer") + def test_nominal__version__pre_SemVer_nonum_random(self): - _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") - + _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): - _v = self._test_version_readback("1.0.0",version_std="SemVer") - + _v = self._test_version_readback("1.0.0", version_std="SemVer") + _v = _v.bump() self.assertIsInstance(_v.raw, str) self.assertIsInstance(_v.major, int) @@ -219,7 +257,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "1.0.1") - + _v = _v.bump(bump_type="patch") self.assertEqual(_v.raw, "1.0.2") self.assertEqual(_v.major, 1) @@ -228,7 +266,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "1.0.2") - + _v = _v.bump(bump_type="minor") self.assertEqual(_v.raw, "1.1.2") self.assertEqual(_v.major, 1) @@ -237,7 +275,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "1.1.2") - + _v = _v.bump(bump_type="major") self.assertEqual(_v.raw, "2.1.2") self.assertEqual(_v.major, 2) @@ -246,7 +284,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.2") - + _v = _v.bump(bump_type="dev") self.assertEqual(_v.raw, "2.1.2+post.1") self.assertEqual(_v.major, 2) @@ -255,7 +293,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 1) self.assertEqual(_v.doFormatVersion(), "2.1.2+post.1") - + _v = _v.bump(bump_type="dev") self.assertEqual(_v.raw, "2.1.2+post.2") self.assertEqual(_v.major, 2) @@ -264,7 +302,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 2) self.assertEqual(_v.doFormatVersion(), "2.1.2+post.2") - + _v = _v.bump(bump_type="patch") self.assertEqual(_v.raw, "2.1.3") self.assertEqual(_v.major, 2) @@ -272,9 +310,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.patch, 3) self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) - self.assertEqual(_v.doFormatVersion(), "2.1.3") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="pre-patch") + self.assertEqual(_v.doFormatVersion(), "2.1.3") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="pre-patch") self.assertEqual(_v.raw, "2.1.4-pre.1") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -282,8 +320,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 1) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.4-pre.1") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="pre-patch") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="pre-patch") self.assertEqual(_v.raw, "2.1.4-pre.2") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -291,8 +329,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 2) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.4-pre.2") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="post") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="post") self.assertEqual(_v.raw, "2.1.4-pre.3") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -300,7 +338,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 3) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.4-pre.3") - + _v = _v.bump(bump_type="patch") self.assertEqual(_v.raw, "2.1.5") self.assertEqual(_v.major, 2) @@ -308,9 +346,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.patch, 5) self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) - self.assertEqual(_v.doFormatVersion(), "2.1.5") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="post") + self.assertEqual(_v.doFormatVersion(), "2.1.5") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="post") self.assertEqual(_v.raw, "2.1.5+post.1") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -318,8 +356,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 1) self.assertEqual(_v.doFormatVersion(), "2.1.5+post.1") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="pre-patch") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="pre-patch") self.assertEqual(_v.raw, "2.1.5+post.2") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -329,8 +367,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.doFormatVersion(), "2.1.5+post.2") def test_nominal__version___pump_PEP440(self): - _v = self._test_version_readback("1.0.0",version_std="PEP440") - + _v = self._test_version_readback("1.0.0", version_std="PEP440") + _v = _v.bump() self.assertIsInstance(_v.raw, str) self.assertIsInstance(_v.major, int) @@ -345,7 +383,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "1.0.1") - + _v = _v.bump(bump_type="patch") self.assertEqual(_v.raw, "1.0.2") self.assertEqual(_v.major, 1) @@ -354,7 +392,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "1.0.2") - + _v = _v.bump(bump_type="minor") self.assertEqual(_v.raw, "1.1.2") self.assertEqual(_v.major, 1) @@ -363,7 +401,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "1.1.2") - + _v = _v.bump(bump_type="major") self.assertEqual(_v.raw, "2.1.2") self.assertEqual(_v.major, 2) @@ -372,7 +410,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.2") - + _v = _v.bump(bump_type="dev") self.assertEqual(_v.raw, "2.1.2.post1") self.assertEqual(_v.major, 2) @@ -381,7 +419,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 1) self.assertEqual(_v.doFormatVersion(), "2.1.2.post1") - + _v = _v.bump(bump_type="dev") self.assertEqual(_v.raw, "2.1.2.post2") self.assertEqual(_v.major, 2) @@ -390,7 +428,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 2) self.assertEqual(_v.doFormatVersion(), "2.1.2.post2") - + _v = _v.bump(bump_type="patch") self.assertEqual(_v.raw, "2.1.3") self.assertEqual(_v.major, 2) @@ -398,9 +436,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.patch, 3) self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) - self.assertEqual(_v.doFormatVersion(), "2.1.3") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="pre-patch") + self.assertEqual(_v.doFormatVersion(), "2.1.3") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="pre-patch") self.assertEqual(_v.raw, "2.1.4.pre1") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -408,8 +446,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 1) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.4.pre1") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="pre-patch") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="pre-patch") self.assertEqual(_v.raw, "2.1.4.pre2") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -417,8 +455,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 2) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.4.pre2") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="post") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="post") self.assertEqual(_v.raw, "2.1.4.pre3") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -426,7 +464,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 3) self.assertEqual(_v.post_count, 0) self.assertEqual(_v.doFormatVersion(), "2.1.4.pre3") - + _v = _v.bump(bump_type="patch") self.assertEqual(_v.raw, "2.1.5") self.assertEqual(_v.major, 2) @@ -434,9 +472,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.patch, 5) self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 0) - self.assertEqual(_v.doFormatVersion(), "2.1.5") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="post") + self.assertEqual(_v.doFormatVersion(), "2.1.5") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="post") self.assertEqual(_v.raw, "2.1.5.post1") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -444,8 +482,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 1) self.assertEqual(_v.doFormatVersion(), "2.1.5.post1") - - _v = _v.bump(bump_type="dev",bump_dev_strategy="pre-patch") + + _v = _v.bump(bump_type="dev", bump_dev_strategy="pre-patch") self.assertEqual(_v.raw, "2.1.5.post2") self.assertEqual(_v.major, 2) self.assertEqual(_v.minor, 1) @@ -453,244 +491,290 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 2) self.assertEqual(_v.doFormatVersion(), "2.1.5.post2") - + def test_nominal__version___SemVer_zeroRev(self): - _v=self._test_version_readback("0.0.0",version_std="SemVer") - self._test_version_format(_v,"0.0.0",version_std="SemVer") - + _v = self._test_version_readback("0.0.0", version_std="SemVer") + self._test_version_format(_v, "0.0.0", version_std="SemVer") + def test_nominal__version___PEP440_zeroRev(self): - _v=self._test_version_readback("0.0.0",version_std="PEP440") - self._test_version_format(_v,"0.0.0",version_std="PEP440") - + _v = self._test_version_readback("0.0.0", version_std="PEP440") + self._test_version_format(_v, "0.0.0", version_std="PEP440") def test_nominal__version___PEP440_noRev_noTag(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"first commit\"") - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.0",version_std="PEP440") + os.system('git commit -m "first commit"') + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440" + ) + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.0", version_std="PEP440") self.assertEqual(_v.raw, "0.1.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,0) - + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 0) + def test_nominal__version___SemVer_noRev_noTag(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"first commit\"") - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="SemVer") - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.0",version_std="SemVer") + os.system('git commit -m "first commit"') + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="SemVer" + ) + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.0", version_std="SemVer") self.assertEqual(_v.raw, "0.1.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,0) - + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 0) + def test_nominal__version___AUTO_noRev_noTag(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"first commit\"") - + os.system('git commit -m "first commit"') + _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.0") + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.0") self.assertEqual(_v.raw, "0.1.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,0) + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 0) def test_nominal__version___AUTO_bump_commits(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"first commit\"") + os.system('git commit -m "first commit"') os.system(f"git tag 0.2.0") - + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.2.0") + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.2.0") self.assertEqual(_v.raw, "0.2.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,2) - self.assertEqual(_v.patch,0) - self.assertEqual(_v.pre_count,0) - self.assertEqual(_v.post_count,0) - - with open("demofile.txt", "w+t") as tmpFile: - tmpFile.write("testvalue22") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 2) + self.assertEqual(_v.patch, 0) + self.assertEqual(_v.pre_count, 0) + self.assertEqual(_v.post_count, 0) + + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue22") os.system("git add .") - os.system("git commit -m \"2nd commit\"") + os.system('git commit -m "2nd commit"') _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.2.1") + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.2.1") self.assertEqual(_v.raw, "0.2.1") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,2) - self.assertEqual(_v.patch,1) - self.assertEqual(_v.pre_count,0) - self.assertEqual(_v.post_count,0) + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 2) + self.assertEqual(_v.patch, 1) + self.assertEqual(_v.pre_count, 0) + self.assertEqual(_v.post_count, 0) - with open("demofile.txt", "w+t") as tmpFile: - tmpFile.write("testvalue223") + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue223") os.system("git add .") - os.system("git commit -m \"3rd commit\"") - - with open("demofile.txt", "w+t") as tmpFile: - tmpFile.write("testvalue224") + os.system('git commit -m "3rd commit"') + + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue224") os.system("git add .") - os.system("git commit -m \"4th commit\"") - + os.system('git commit -m "4th commit"') + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.2.3") - self.assertEqual(_v.raw, "0.2.3") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,2) - self.assertEqual(_v.patch,3) - self.assertEqual(_v.pre_count,0) - self.assertEqual(_v.post_count,0) - - with open("demofile.txt", "w+t") as tmpFile: - tmpFile.write("testvalue225") - os.system("git add .") - os.system("git commit -m \"5th commit\"") - - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev") - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self.assertIsInstance(_v.raw, str) - self._test_version_format(_v,"0.2.0+post.4") - self.assertEqual(_v.raw, "0.2.0+post.4") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,2) - self.assertEqual(_v.patch,0) - self.assertEqual(_v.pre_count,0) - self.assertEqual(_v.post_count,4) - - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev",bump_dev_strategy="pre-patch") - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.2.1-pre.4") - self.assertEqual(_v.raw, "0.2.1-pre.4") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,2) - self.assertEqual(_v.patch,1) - self.assertEqual(_v.pre_count,4) - self.assertEqual(_v.post_count,0) - - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev",bump_dev_strategy="pre-minor") - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.3.0-pre.4") - self.assertEqual(_v.raw, "0.3.0-pre.4") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,3) - self.assertEqual(_v.patch,0) - self.assertEqual(_v.pre_count,4) - self.assertEqual(_v.post_count,0) - - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev",bump_dev_strategy="pre-major") - - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"1.0.0-pre.4") - self.assertEqual(_v.raw, "1.0.0-pre.4") - self.assertEqual(_v.major,1) - self.assertEqual(_v.minor,0) - self.assertEqual(_v.patch,0) - self.assertEqual(_v.pre_count,4) - self.assertEqual(_v.post_count,0) - - def test_nominal__version___custom_format(self): - _v=self._test_version_readback("0.1.1",version_std="PEP440") - - self.assertEqual("V_0_1_1____",_v.doFormatVersion(output_format="V_{major}_{minor}_{patch}____{revcount}")) - self.assertEqual("V_0_1",_v.doFormatVersion(output_format="V_{major}_{minor}")) - - with open("demofile.txt", "w+t") as tmpFile: - tmpFile.write("testvalue225") - os.system("git add .") - os.system("git commit -m \"5th commit\"") - - self.assertEqual("V_1_0",pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev",bump_dev_strategy="pre-major").doFormatVersion(output_format="V_{major}_{minor}")) - self.assertEqual("V_1_0",pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev",bump_dev_strategy="pre-major",output_format="V_{major}_{minor}",formated_output=True)) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.2.3") + self.assertEqual(_v.raw, "0.2.3") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 2) + self.assertEqual(_v.patch, 3) + self.assertEqual(_v.pre_count, 0) + self.assertEqual(_v.post_count, 0) + + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue225") + os.system("git add .") + os.system('git commit -m "5th commit"') + + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( + bump_type="dev" + ) + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self.assertIsInstance(_v.raw, str) + self._test_version_format(_v, "0.2.0+post.4") + self.assertEqual(_v.raw, "0.2.0+post.4") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 2) + self.assertEqual(_v.patch, 0) + self.assertEqual(_v.pre_count, 0) + self.assertEqual(_v.post_count, 4) + + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( + bump_type="dev", bump_dev_strategy="pre-patch" + ) + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.2.1-pre.4") + self.assertEqual(_v.raw, "0.2.1-pre.4") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 2) + self.assertEqual(_v.patch, 1) + self.assertEqual(_v.pre_count, 4) + self.assertEqual(_v.post_count, 0) + + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( + bump_type="dev", bump_dev_strategy="pre-minor" + ) + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.3.0-pre.4") + self.assertEqual(_v.raw, "0.3.0-pre.4") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 3) + self.assertEqual(_v.patch, 0) + self.assertEqual(_v.pre_count, 4) + self.assertEqual(_v.post_count, 0) + + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( + bump_type="dev", bump_dev_strategy="pre-major" + ) + + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "1.0.0-pre.4") + self.assertEqual(_v.raw, "1.0.0-pre.4") + self.assertEqual(_v.major, 1) + self.assertEqual(_v.minor, 0) + self.assertEqual(_v.patch, 0) + self.assertEqual(_v.pre_count, 4) + self.assertEqual(_v.post_count, 0) + + def test_nominal__version___custom_format(self): + _v = self._test_version_readback("0.1.1", version_std="PEP440") + + self.assertEqual( + "V_0_1_1____", + _v.doFormatVersion(output_format="V_{major}_{minor}_{patch}____{revcount}"), + ) + self.assertEqual("V_0_1", _v.doFormatVersion(output_format="V_{major}_{minor}")) + + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue225") + os.system("git add .") + os.system('git commit -m "5th commit"') + + self.assertEqual( + "V_1_0", + pygitversionhelper.gitversionhelper.version.getCurrentVersion( + bump_type="dev", bump_dev_strategy="pre-major" + ).doFormatVersion(output_format="V_{major}_{minor}"), + ) + self.assertEqual( + "V_1_0", + pygitversionhelper.gitversionhelper.version.getCurrentVersion( + bump_type="dev", + bump_dev_strategy="pre-major", + output_format="V_{major}_{minor}", + formated_output=True, + ), + ) def test_nominal__git__emptyrepo(self): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.0") + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.0") self.assertEqual(_v.raw, "0.1.0") - - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,0) - self.assertEqual(_v.pre_count,0) - self.assertEqual(_v.post_count,0) - + + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 0) + self.assertEqual(_v.pre_count, 0) + self.assertEqual(_v.post_count, 0) + def test_defect__git__dirty(self): - _v=self._test_version_readback("0.1.1",version_std="PEP440") - - with open("demofile.txt", "w+t") as tmpFile: - tmpFile.write("testvalue225") - - with self.assertRaises(pygitversionhelper.gitversionhelper.repository.repositoryDirty) : + _v = self._test_version_readback("0.1.1", version_std="PEP440") + + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue225") + + with self.assertRaises( + pygitversionhelper.gitversionhelper.repository.repositoryDirty + ): pygitversionhelper.gitversionhelper.version.getCurrentVersion() - def test_defect__version_post_and_pre_output(self): - _v = pygitversionhelper.gitversionhelper.version.MetaVersion("PEP440", - 0, - 0, - 1, - 1, - 1, - "0.0.1.pre1.post1") - with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported) : + _v = pygitversionhelper.gitversionhelper.version.MetaVersion( + "PEP440", 0, 0, 1, 1, 1, "0.0.1.pre1.post1" + ) + with self.assertRaises( + pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported + ): _v.doFormatVersion() - - _v = pygitversionhelper.gitversionhelper.version.MetaVersion("SemVer", - 0, - 0, - 1, - 1, - 1, - "0.0.1-pre.1+post.1") - with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported) : + + _v = pygitversionhelper.gitversionhelper.version.MetaVersion( + "SemVer", 0, 0, 1, 1, 1, "0.0.1-pre.1+post.1" + ) + with self.assertRaises( + pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported + ): _v.doFormatVersion() - + def test_defect__version_post_and_pre_parse(self): - with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported) : + with self.assertRaises( + pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported + ): pygitversionhelper.gitversionhelper.version._parseTag("0.0.1.pre1.post1") - def test_defect__git__wrongargument_sortargs(self): - with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) : + with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments): pygitversionhelper.gitversionhelper.tag.getTags(sort="toto") - + def test_defect__git__notagfound(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"first commit\"") - with self.assertRaises(pygitversionhelper.gitversionhelper.tag.tagNotFound) : + os.system('git commit -m "first commit"') + with self.assertRaises(pygitversionhelper.gitversionhelper.tag.tagNotFound): pygitversionhelper.gitversionhelper.tag.getLastTag() - + """ 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: @@ -704,198 +788,230 @@ class Test_gitversionhelper(unittest.TestCase): """ def test_defect__wrongargument_bump_type(self): - _v=self._test_version_readback("0.1.1",version_std="PEP440") - with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments) : - pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="toto") + _v = self._test_version_readback("0.1.1", version_std="PEP440") + 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) : - pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_dev_strategy="toto") + _v = self._test_version_readback("0.1.1", version_std="PEP440") + with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments): + pygitversionhelper.gitversionhelper.version.getCurrentVersion( + bump_dev_strategy="toto" + ) def test_nominal__tag__getDistanceFromTag(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.2.0") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue1") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.0") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") - - self.assertEqual(2,pygitversionhelper.gitversionhelper.tag.getDistanceFromTag()) - self.assertEqual(4,pygitversionhelper.gitversionhelper.tag.getDistanceFromTag("0.2.0")) - + os.system('git commit -m "commit"') + + self.assertEqual( + 2, pygitversionhelper.gitversionhelper.tag.getDistanceFromTag() + ) + self.assertEqual( + 4, pygitversionhelper.gitversionhelper.tag.getDistanceFromTag("0.2.0") + ) + def test_nominal__tag__getTags(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.2.0") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue1") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.0") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue5") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.1") - - self.assertEqual(set(["0.3.0","0.2.0","0.3.1"]),set(pygitversionhelper.gitversionhelper.tag.getTags())) - + + self.assertEqual( + set(["0.3.0", "0.2.0", "0.3.1"]), + set(pygitversionhelper.gitversionhelper.tag.getTags()), + ) + def test_nominal__tag__getTags_two_branch(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.2.0") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue1") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.0") - + os.system("git checkout -b dev") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue5") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.1") - - self.assertEqual(set(["0.3.0","0.2.0","0.3.1"]),set(pygitversionhelper.gitversionhelper.tag.getTags())) - + + self.assertEqual( + set(["0.3.0", "0.2.0", "0.3.1"]), + set(pygitversionhelper.gitversionhelper.tag.getTags()), + ) + def test_nominal__tag__getTags_two_branch_samebranch(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.2.0") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue1") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.0") - + os.system("git checkout -b dev") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue5") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.1") - - self.assertEqual(set(["0.3.0","0.2.0","0.3.1"]),set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True))) - + + self.assertEqual( + set(["0.3.0", "0.2.0", "0.3.1"]), + set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True)), + ) + os.system("git switch master") - - self.assertEqual(set(["0.3.0","0.2.0"]),set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True))) - + + self.assertEqual( + set(["0.3.0", "0.2.0"]), + set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True)), + ) + os.system("git switch dev") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.3.2") - - self.assertEqual(set(["0.3.0","0.2.0","0.3.1","0.3.2"]),set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True))) - self.assertEqual(set(["0.3.0","0.2.0","0.3.1","0.3.2"]),set(pygitversionhelper.gitversionhelper.tag.getTags())) - + + self.assertEqual( + set(["0.3.0", "0.2.0", "0.3.1", "0.3.2"]), + set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True)), + ) + self.assertEqual( + set(["0.3.0", "0.2.0", "0.3.1", "0.3.2"]), + set(pygitversionhelper.gitversionhelper.tag.getTags()), + ) + os.system("git switch master") - - self.assertEqual(set(["0.3.0","0.2.0"]),set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True))) - self.assertEqual(set(["0.3.0","0.2.0","0.3.1","0.3.2"]),set(pygitversionhelper.gitversionhelper.tag.getTags())) - + + self.assertEqual( + set(["0.3.0", "0.2.0"]), + set(pygitversionhelper.gitversionhelper.tag.getTags(same_branch=True)), + ) + self.assertEqual( + set(["0.3.0", "0.2.0", "0.3.1", "0.3.2"]), + set(pygitversionhelper.gitversionhelper.tag.getTags()), + ) + def test_nominal__tag__getLastTag_two_branches(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"first commit\"") - - with open("demofile.txt", "w+t") as tmpFile: + os.system('git commit -m "first commit"') + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue1") os.system("git add .") - os.system("git commit -m \"2nd commit\"") + os.system('git commit -m "2nd commit"') os.system(f"git tag 0.1.0") - + os.system("git checkout -b dev") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"3rd commit\"") + os.system('git commit -m "3rd commit"') os.system(f"git tag 0.2.0") - + """ print("===") os.system(f"git status") @@ -911,427 +1027,517 @@ class Test_gitversionhelper(unittest.TestCase): os.system(f"git describe --tags") print("===") """ - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.2.0",version_std="PEP440") + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440" + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.2.0", version_std="PEP440") self.assertEqual(_v.raw, "0.2.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,2) - self.assertEqual(_v.patch,0) - - with open("demofile.txt", "w+t") as tmpFile: + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 2) + self.assertEqual(_v.patch, 0) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - os.system("git commit -m \"3rd commit\"") + os.system('git commit -m "3rd commit"') os.system(f"git tag 0.3.0") - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.3.0",version_std="PEP440") + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440" + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.3.0", version_std="PEP440") self.assertEqual(_v.raw, "0.3.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,3) - self.assertEqual(_v.patch,0) - + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 3) + self.assertEqual(_v.patch, 0) + os.system("git switch master") - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.3.0",version_std="PEP440") + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440" + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.3.0", version_std="PEP440") self.assertEqual(_v.raw, "0.3.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,3) - self.assertEqual(_v.patch,0) - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440",same_branch=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.0",version_std="PEP440") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 3) + self.assertEqual(_v.patch, 0) + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440", same_branch=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.0", version_std="PEP440") self.assertEqual(_v.raw, "0.1.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,0) - - os.system("git merge --no-ff dev -m \"merge dev into master\"") - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440",same_branch=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.0",version_std="PEP440") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 0) + + os.system('git merge --no-ff dev -m "merge dev into master"') + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440", same_branch=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.0", version_std="PEP440") self.assertEqual(_v.raw, "0.1.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,0) - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.3.0",version_std="PEP440") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 0) + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440" + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.3.0", version_std="PEP440") self.assertEqual(_v.raw, "0.3.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,3) - self.assertEqual(_v.patch,0) - + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 3) + self.assertEqual(_v.patch, 0) + os.system(f"git tag 0.4.0") - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440",same_branch=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.4.0",version_std="PEP440") + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440", same_branch=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.4.0", version_std="PEP440") self.assertEqual(_v.raw, "0.4.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,4) - self.assertEqual(_v.patch,0) - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.4.0",version_std="PEP440") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 4) + self.assertEqual(_v.patch, 0) + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + version_std="PEP440" + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.4.0", version_std="PEP440") self.assertEqual(_v.raw, "0.4.0") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,4) - self.assertEqual(_v.patch,0) - + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 4) + self.assertEqual(_v.patch, 0) + def test_defect__tag__invalidtag(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue1") os.system("git add .") - os.system("git commit -m \"2nd commit\"") + os.system('git commit -m "2nd commit"') os.system(f"git tag INVALIDTAG") - - with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) : + + 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) + + 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: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue1") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.0.1") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag INVALIDTAG") - - with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) : + + with self.assertRaises( + pygitversionhelper.gitversionhelper.version.noValidVersion + ): _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.0.1",version_std="PEP440") + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + ignore_unknown_tags=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.0.1", version_std="PEP440") self.assertEqual(_v.raw, "0.0.1") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,0) - self.assertEqual(_v.patch,1) - - with open("demofile.txt", "w+t") as tmpFile: + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 0) + self.assertEqual(_v.patch, 1) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag INVALIDTAG2") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag INVALIDTA3") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag INVALIDTA4") - - with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) : + + with self.assertRaises( + pygitversionhelper.gitversionhelper.version.noValidVersion + ): _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.0.1",version_std="PEP440") + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + ignore_unknown_tags=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.0.1", version_std="PEP440") self.assertEqual(_v.raw, "0.0.1") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,0) - self.assertEqual(_v.patch,1) - - with open("demofile.txt", "w+t") as tmpFile: + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 0) + self.assertEqual(_v.patch, 1) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue5") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.1.2") _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.2",version_std="PEP440") + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.2", version_std="PEP440") self.assertEqual(_v.raw, "0.1.2") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,2) - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.2",version_std="PEP440") - self.assertEqual(_v.raw, "0.1.2") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,2) + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 2) - with open("demofile.txt", "w+t") as tmpFile: + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + ignore_unknown_tags=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.2", version_std="PEP440") + self.assertEqual(_v.raw, "0.1.2") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 2) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue6") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag INVALIDTA5") - with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion) : + with self.assertRaises( + pygitversionhelper.gitversionhelper.version.noValidVersion + ): _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.2",version_std="PEP440") + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + ignore_unknown_tags=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.2", version_std="PEP440") self.assertEqual(_v.raw, "0.1.2") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,2) - - with open("demofile.txt", "w+t") as tmpFile: + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 2) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue7") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') os.system(f"git tag 0.1.3") - + _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.3",version_std="PEP440") + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.3", version_std="PEP440") self.assertEqual(_v.raw, "0.1.3") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,3) - - _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) - self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) - self._test_version_format(_v,"0.1.3",version_std="PEP440") + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 3) + + _v = pygitversionhelper.gitversionhelper.version.getLastVersion( + ignore_unknown_tags=True + ) + self.assertIsInstance( + _v, pygitversionhelper.gitversionhelper.version.MetaVersion + ) + self._test_version_format(_v, "0.1.3", version_std="PEP440") self.assertEqual(_v.raw, "0.1.3") - self.assertEqual(_v.major,0) - self.assertEqual(_v.minor,1) - self.assertEqual(_v.patch,3) - + self.assertEqual(_v.major, 0) + self.assertEqual(_v.minor, 1) + self.assertEqual(_v.patch, 3) + def test_nominal__commit_getLast(self): # sleeps are needed because commit date have a 1-sec accuracy :-/ - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') time.sleep(1) initial_commit = pygitversionhelper.gitversionhelper.commit.getLast() - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') time.sleep(1) - + second_commit = pygitversionhelper.gitversionhelper.commit.getLast() - - self.assertNotEqual(initial_commit,second_commit) - - with open("demofile.txt", "w+t") as tmpFile: + + self.assertNotEqual(initial_commit, second_commit) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') time.sleep(1) - + third_commit = pygitversionhelper.gitversionhelper.commit.getLast() - - self.assertNotEqual(initial_commit,third_commit) - self.assertNotEqual(second_commit,third_commit) - - + + self.assertNotEqual(initial_commit, third_commit) + self.assertNotEqual(second_commit, third_commit) + os.system("git checkout -b dev") - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') time.sleep(1) - + fourth_commit = pygitversionhelper.gitversionhelper.commit.getLast() - - self.assertNotEqual(initial_commit,fourth_commit) - self.assertNotEqual(second_commit,fourth_commit) - self.assertNotEqual(third_commit,fourth_commit) - + + self.assertNotEqual(initial_commit, fourth_commit) + self.assertNotEqual(second_commit, fourth_commit) + self.assertNotEqual(third_commit, fourth_commit) + os.system("git switch master") - + fourth2_commit = pygitversionhelper.gitversionhelper.commit.getLast() - self.assertEqual(fourth2_commit,fourth_commit) - - fourth3_commit = pygitversionhelper.gitversionhelper.commit.getLast(same_branch=True) - - self.assertNotEqual(fourth3_commit,fourth_commit) - self.assertEqual(fourth3_commit,third_commit) - - with open("demofile.txt", "w+t") as tmpFile: + self.assertEqual(fourth2_commit, fourth_commit) + + fourth3_commit = pygitversionhelper.gitversionhelper.commit.getLast( + same_branch=True + ) + + self.assertNotEqual(fourth3_commit, fourth_commit) + self.assertEqual(fourth3_commit, third_commit) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue5") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') time.sleep(1) - + fifth_commit = pygitversionhelper.gitversionhelper.commit.getLast() - self.assertNotEqual(fifth_commit,fourth3_commit) - + self.assertNotEqual(fifth_commit, fourth3_commit) + os.system("git switch dev") - + fifth2_commit = pygitversionhelper.gitversionhelper.commit.getLast() - self.assertEqual(fifth2_commit,fifth_commit) - - fifth2_commit = pygitversionhelper.gitversionhelper.commit.getLast(same_branch=True) - self.assertEqual(fifth2_commit,fourth_commit) - + self.assertEqual(fifth2_commit, fifth_commit) + + fifth2_commit = pygitversionhelper.gitversionhelper.commit.getLast( + same_branch=True + ) + self.assertEqual(fifth2_commit, fourth_commit) + def test_defect__commit_notfound(self): - - with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound) : + + with self.assertRaises( + pygitversionhelper.gitversionhelper.commit.commitNotFound + ): pygitversionhelper.gitversionhelper.commit.getLast() - - with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound) : + + with self.assertRaises( + pygitversionhelper.gitversionhelper.commit.commitNotFound + ): pygitversionhelper.gitversionhelper.commit.getLast(same_branch=True) - + def test_nominal__commit_getFromTag(self): - with open("demofile.txt", "w+t") as tmpFile: + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"commit\"") + os.system('git commit -m "commit"') initial_commit = pygitversionhelper.gitversionhelper.commit.getLast() - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - os.system("git commit -m \"commit2\"") + os.system('git commit -m "commit2"') os.system(f"git tag TAG") second_commit = pygitversionhelper.gitversionhelper.commit.getLast() - self.assertNotEqual(second_commit,initial_commit) + self.assertNotEqual(second_commit, initial_commit) second_commit2 = pygitversionhelper.gitversionhelper.commit.getFromTag("TAG") - self.assertEqual(second_commit,second_commit2) - self.assertNotEqual(second_commit2,initial_commit) - + self.assertEqual(second_commit, second_commit2) + self.assertNotEqual(second_commit2, initial_commit) + def test_defect__commit_notfound2(self): - - with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound) : + + with self.assertRaises( + pygitversionhelper.gitversionhelper.commit.commitNotFound + ): pygitversionhelper.gitversionhelper.commit.getFromTag("TAG") - - with open("demofile.txt", "w+t") as tmpFile: + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system("git commit -m \"commit\"") - - with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound) : + os.system('git commit -m "commit"') + + with self.assertRaises( + pygitversionhelper.gitversionhelper.commit.commitNotFound + ): pygitversionhelper.gitversionhelper.commit.getFromTag("TAG") - + os.system(f"git tag OTHER_TAG") - - with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound) : + + with self.assertRaises( + pygitversionhelper.gitversionhelper.commit.commitNotFound + ): pygitversionhelper.gitversionhelper.commit.getFromTag("TAG") - + def test_nominal__commit_getMessage(self): - commit_message="AAAABBB CCCCDDDD".replace('\r\n','\n').replace('\n','\r\n') - with open("demofile.txt", "w+t") as tmpFile: + commit_message = "AAAABBB CCCCDDDD".replace("\r\n", "\n").replace("\n", "\r\n") + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - os.system(f"git commit -m \"{commit_message}\"") + os.system(f'git commit -m "{commit_message}"') commit = pygitversionhelper.gitversionhelper.commit.getLast() message = pygitversionhelper.gitversionhelper.commit.getMessage(commit) - self.assertEqual(message,commit_message) - - def test_nominal__commit_getMessage2(self): - commit_message="""AAAABBB - CCCCDDDD - -f dfsds dfsdfs $""".replace('\r\n','\n').replace('\n','\r\n') + self.assertEqual(message, commit_message) - with open("demofile.txt", "w+t") as tmpFile: + def test_nominal__commit_getMessage2(self): + commit_message = """AAAABBB + CCCCDDDD + -f dfsds dfsdfs $""".replace( + "\r\n", "\n" + ).replace( + "\n", "\r\n" + ) + + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - + cmd = "git commit -m".split() cmd.append(commit_message) - subprocess.run(cmd,text=True,check=True) - + subprocess.run(cmd, text=True, check=True) + commit = pygitversionhelper.gitversionhelper.commit.getLast() message = pygitversionhelper.gitversionhelper.commit.getMessage(commit) - self.assertEqual(message,commit_message) - + self.assertEqual(message, commit_message) + def test_nominal__commit_getMessagesSinceLastTag(self): - commit_message1="1.1 update this"+ os.linesep+\ - "1.1 fix that" + os.linesep+\ - "1.1 test" - commit_message1=commit_message1.replace('\r\n','\n').replace('\n','\r\n') - with open("demofile.txt", "w+t") as tmpFile: + commit_message1 = ( + "1.1 update this" + os.linesep + "1.1 fix that" + os.linesep + "1.1 test" + ) + commit_message1 = commit_message1.replace("\r\n", "\n").replace("\n", "\r\n") + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") os.system("git add .") - + cmd = "git commit -m".split() cmd.append(commit_message1) - subprocess.run(cmd,text=True,check=True) + subprocess.run(cmd, text=True, check=True) os.system(f"git tag 0.1.1") - - commit_message2="2.1 update this"+ os.linesep+\ - "2.1 fix that" + os.linesep+\ - "2.1 test" - commit_message2=commit_message2.replace('\r\n','\n').replace('\n','\r\n') - with open("demofile.txt", "w+t") as tmpFile: + + commit_message2 = ( + "2.1 update this" + os.linesep + "2.1 fix that" + os.linesep + "2.1 test" + ) + commit_message2 = commit_message2.replace("\r\n", "\n").replace("\n", "\r\n") + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") os.system("git add .") - + cmd = "git commit -m".split() cmd.append(commit_message2) - subprocess.run(cmd,text=True,check=True) - - commit_message3="3.1 update this"+ os.linesep+\ - "3.1 fix that" + os.linesep+\ - "3.1 test" - commit_message3=commit_message3.replace('\r\n','\n').replace('\n','\r\n') - with open("demofile.txt", "w+t") as tmpFile: + subprocess.run(cmd, text=True, check=True) + + commit_message3 = ( + "3.1 update this" + os.linesep + "3.1 fix that" + os.linesep + "3.1 test" + ) + commit_message3 = commit_message3.replace("\r\n", "\n").replace("\n", "\r\n") + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") os.system("git add .") - + cmd = "git commit -m".split() cmd.append(commit_message3) - subprocess.run(cmd,text=True,check=True) + subprocess.run(cmd, text=True, check=True) - commit_message4="4.1 update this" + os.linesep+\ - "4.1 fix that" + os.linesep+\ - "4.1 test" - commit_message4=commit_message4.replace('\r\n','\n').replace('\n','\r\n') - with open("demofile.txt", "w+t") as tmpFile: + commit_message4 = ( + "4.1 update this" + os.linesep + "4.1 fix that" + os.linesep + "4.1 test" + ) + commit_message4 = commit_message4.replace("\r\n", "\n").replace("\n", "\r\n") + with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") os.system("git add .") - + cmd = "git commit -m".split() cmd.append(commit_message4) - subprocess.run(cmd,text=True,check=True) + subprocess.run(cmd, text=True, check=True) res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1") - self.assertEqual( [commit_message4,commit_message3,commit_message2],res) - - res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1",merged_output=True) - self.assertEqual( os.linesep.join([commit_message4,commit_message3,commit_message2]),res) - - + self.assertEqual([commit_message4, commit_message3, commit_message2], res) + + res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag( + "0.1.1", merged_output=True + ) + self.assertEqual( + os.linesep.join([commit_message4, commit_message3, commit_message2]), res + ) + def tearDown(self): os.chdir("/") - + + class Test_gitversionhelperNoRepo(unittest.TestCase): def setUp(self): - self.TmpWorkingDir=tempfile.TemporaryDirectory() - self.TmpWorkingDirPath=pathlib.Path(self.TmpWorkingDir.name) + self.TmpWorkingDir = tempfile.TemporaryDirectory() + self.TmpWorkingDirPath = pathlib.Path(self.TmpWorkingDir.name) os.chdir(self.TmpWorkingDirPath) def test_defect__norepo(self): - with self.assertRaises(pygitversionhelper.gitversionhelper.repository.notAGitRepository) : + with self.assertRaises( + pygitversionhelper.gitversionhelper.repository.notAGitRepository + ): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() def tearDown(self): - os.chdir("/") \ No newline at end of file + os.chdir("/") -- 2.47.3 From 235af0fd6d97a57b6670b5ec722bc58b1afb1498 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 23:21:39 +0000 Subject: [PATCH 04/30] apply black --- helpers/__main__.py | 114 ++++---- helpers/changelog_gen.py | 15 +- helpers/doc_gen.py | 101 +++---- helpers/helper_base.py | 66 ++--- helpers/quality_check.py | 276 +++++++++--------- helpers/types_check.py | 64 +++-- helpers/unit_test.py | 60 ++-- src/pygitversionhelper/__init__.py | 3 +- src/pygitversionhelper/gitversionhelper.py | 123 ++------ test/test_gitversionhelper.py | 314 ++++++--------------- 10 files changed, 481 insertions(+), 655 deletions(-) diff --git a/helpers/__main__.py b/helpers/__main__.py index 8539d81..c8d9a54 100644 --- a/helpers/__main__.py +++ b/helpers/__main__.py @@ -16,89 +16,93 @@ import os import logging import sys -if __package__=="helpers": +if __package__ == "helpers": # when calling the module from: > python -m helpers - from .types_check import types_check - from .quality_check import quality_check - from .unit_test import unit_test - from .doc_gen import doc_gen - from .changelog_gen import changelog_gen -else: + from .types_check import types_check + from .quality_check import quality_check + from .unit_test import unit_test + from .doc_gen import doc_gen + from .changelog_gen import changelog_gen +else: # when calling the __main__.py file (from IDE) - from helpers.types_check import types_check - from helpers.quality_check import quality_check - from helpers.unit_test import unit_test - from helpers.doc_gen import doc_gen - from helpers.changelog_gen import changelog_gen - + from helpers.types_check import types_check + from helpers.quality_check import quality_check + from helpers.unit_test import unit_test + from helpers.doc_gen import doc_gen + from helpers.changelog_gen import changelog_gen + logging.getLogger().setLevel(logging.INFO) if __name__ == "__main__": - project_rootdir_path=Path(__file__).parent.parent.absolute() + project_rootdir_path = Path(__file__).parent.parent.absolute() with open(project_rootdir_path / "pyproject.toml", mode="rb") as fp: pyproject = tomli.load(fp) - - parser = argparse.ArgumentParser( prog = 'continuous-integration-helper', - description = 'A tiny set of scripts to help continous integration on python') - - parser.add_argument('-tc', '--type-check', dest='typecheck', action='store_true', help='enable static typing check') - - parser.add_argument('-ut', '--unit-test', dest='unittest', action='store_true', help='enable unit-test') - parser.add_argument('-cc', '--coverage-check', dest='coveragecheck', action='store_true', help='enable unit-test coverage check (requires unit-test)') - parser.add_argument('-qc', '--quality-check', dest='qualitycheck', action='store_true', help='enable code quality check') - - parser.add_argument('-dg', '--doc-gen', dest='docgen', action='store_true', help='enable documentation generation using MkDoc') - parser.add_argument('-pdf', '--doc-gen-pdf', dest='docgenpdf', action='store_true', help='enable pdf documentation export (requires doc-gen)') - - parser.add_argument('-clg', '--changelog-gen', dest='changeloggen', action='store_true', help='enable changelog generation') - + parser = argparse.ArgumentParser( + prog="continuous-integration-helper", description="A tiny set of scripts to help continous integration on python" + ) + + parser.add_argument("-tc", "--type-check", dest="typecheck", action="store_true", help="enable static typing check") + + parser.add_argument("-ut", "--unit-test", dest="unittest", action="store_true", help="enable unit-test") + parser.add_argument( + "-cc", "--coverage-check", dest="coveragecheck", action="store_true", help="enable unit-test coverage check (requires unit-test)" + ) + + parser.add_argument("-qc", "--quality-check", dest="qualitycheck", action="store_true", help="enable code quality check") + + parser.add_argument("-dg", "--doc-gen", dest="docgen", action="store_true", help="enable documentation generation using MkDoc") + parser.add_argument( + "-pdf", "--doc-gen-pdf", dest="docgenpdf", action="store_true", help="enable pdf documentation export (requires doc-gen)" + ) + + parser.add_argument("-clg", "--changelog-gen", dest="changeloggen", action="store_true", help="enable changelog generation") + args = parser.parse_args() - + ################################## # Dev / Debug forced toogles # - #-------------------------------- + # -------------------------------- # - #args.typecheck = True - #args.qualitycheck = True - #args.unittest = True - #args.coveragecheck = True - #args.docgen = True - #args.docgenpdf = True - #args.changeloggen = True - + # args.typecheck = True + # args.qualitycheck = True + # args.unittest = True + # args.coveragecheck = True + # args.docgen = True + # args.docgenpdf = True + # args.changeloggen = True + helpers = [] - if args.typecheck == True: + if args.typecheck == True: helpers.append(types_check) - - if args.unittest == True: + + if args.unittest == True: helpers.append(unit_test) - - if args.coveragecheck == True: + + if args.coveragecheck == True: if args.unittest == True: unit_test.enable_coverage_check = True else: raise RuntimeError("unit-test is required to enable coverage-check") - - if args.qualitycheck == True: + + if args.qualitycheck == True: helpers.append(quality_check) - - if args.docgen == True: + + if args.docgen == True: helpers.append(doc_gen) - - if args.docgenpdf==True: + + if args.docgenpdf == True: if args.docgen == True: doc_gen.enable_gen_pdf = True else: raise RuntimeError("doc-gen is required to enable doc-gen-pdf") - - if args.changeloggen == True: + + if args.changeloggen == True: helpers.append(changelog_gen) - + for helper in helpers: - helper.set_context(project_rootdir_path,pyproject) + helper.set_context(project_rootdir_path, pyproject) helper.reset_result_dir() helper.do_job() - diff --git a/helpers/changelog_gen.py b/helpers/changelog_gen.py index a0b5734..f4a15cb 100644 --- a/helpers/changelog_gen.py +++ b/helpers/changelog_gen.py @@ -9,16 +9,15 @@ from __future__ import annotations from typing import TYPE_CHECKING -#from pathlib import Path -#import os -#import datetime +# from pathlib import Path +# import os +# import datetime from .helper_base import helper_base -class changelog_gen(helper_base): - - @classmethod - def do_job(cls): - pass \ No newline at end of file +class changelog_gen(helper_base): + @classmethod + def do_job(cls): + pass diff --git a/helpers/doc_gen.py b/helpers/doc_gen.py index 05dcb38..1201271 100644 --- a/helpers/doc_gen.py +++ b/helpers/doc_gen.py @@ -17,6 +17,7 @@ from pathlib import Path from distutils.dir_util import copy_tree import yaml + try: from yaml import CLoader as Loader, CDumper as Dumper except ImportError: @@ -24,35 +25,36 @@ except ImportError: from .helper_base import helper_withresults_base -class doc_gen(helper_withresults_base): + +class doc_gen(helper_withresults_base): enable_gen_pdf: bool = False - - @classmethod - def do_job(cls): + + @classmethod + def do_job(cls): print(cls.project_rootdir_path) print() - + # create doc root dir - doc_path = cls.project_rootdir_path/"docs" + doc_path = cls.project_rootdir_path / "docs" cls._reset_dir(doc_path) - - site_path = cls.get_result_dir()/"site" + + site_path = cls.get_result_dir() / "site" cls._reset_dir(site_path) - + # copy files from main project dir - shutil.copyfile(str(cls.project_rootdir_path/"README.md"),str(doc_path/"README.md")) - shutil.copyfile(str(cls.project_rootdir_path/"LICENSE.md"),str(doc_path/"LICENSE.md")) - + shutil.copyfile(str(cls.project_rootdir_path / "README.md"), str(doc_path / "README.md")) + shutil.copyfile(str(cls.project_rootdir_path / "LICENSE.md"), str(doc_path / "LICENSE.md")) + # copy files from static-doc dir - copy_tree(str(cls.project_rootdir_path/"docs-static"),str(doc_path)) - + copy_tree(str(cls.project_rootdir_path / "docs-static"), str(doc_path)) + # generating API doc + nav from python docstrings reference_path = doc_path / "reference" cls._reset_dir(reference_path) - + for path in sorted((cls.project_rootdir_path / "src").rglob("*.py")): - module_path = path.relative_to(cls.project_rootdir_path/ "src").with_suffix("") - doc_path = path.relative_to(cls.project_rootdir_path/ "src").with_suffix(".md") + module_path = path.relative_to(cls.project_rootdir_path / "src").with_suffix("") + doc_path = path.relative_to(cls.project_rootdir_path / "src").with_suffix(".md") full_doc_path = Path(reference_path, doc_path) parts = list(module_path.parts) @@ -61,43 +63,44 @@ class doc_gen(helper_withresults_base): parts = parts[:-1] elif parts[-1] == "__main__": continue - + cls._reset_dir(os.path.dirname(full_doc_path)) with open(full_doc_path, "w+") as fd: - identifier = "src."+".".join(parts) + identifier = "src." + ".".join(parts) print("::: " + identifier, file=fd) - - - cmdopts = [f"{sys.executable}","-m","mkdocs","-v","build","--site-dir",str(site_path),"--clean"] - + + cmdopts = [f"{sys.executable}", "-m", "mkdocs", "-v", "build", "--site-dir", str(site_path), "--clean"] + # little hack here, to enable / disable pdf generation using own class config - # => reason is mkdocs seems to try loading the plugin even if we disable it, so we need to + # => reason is mkdocs seems to try loading the plugin even if we disable it, so we need to # manually process the configuration file. - mkdocsCfg=None - with open(cls.project_rootdir_path / "mkdocs.yml",'r') as mkdocsCfgFile: + mkdocsCfg = None + with open(cls.project_rootdir_path / "mkdocs.yml", "r") as mkdocsCfgFile: mkdocsCfg = yaml.load(mkdocsCfgFile, Loader=yaml.SafeLoader) - - if cls.enable_gen_pdf==True: - mkdocsCfg['plugins'].append({ 'with-pdf':{ - 'cover_subtitle': 'User Manual', - 'cover_logo': str(cls.project_rootdir_path / 'docs-static' / 'Library.jpg'), - 'verbose': False, - 'media_type': 'print', - 'exclude_pages': ['LICENSE'], - 'output_path': str(site_path / 'pdf' / 'manual.pdf') - }}) + + if cls.enable_gen_pdf == True: + mkdocsCfg["plugins"].append( + { + "with-pdf": { + "cover_subtitle": "User Manual", + "cover_logo": str(cls.project_rootdir_path / "docs-static" / "Library.jpg"), + "verbose": False, + "media_type": "print", + "exclude_pages": ["LICENSE"], + "output_path": str(site_path / "pdf" / "manual.pdf"), + } + } + ) else: - for subelem in mkdocsCfg['plugins']: - if isinstance(subelem,dict) : - if 'with-pdf' in subelem.keys(): - mkdocsCfg['plugins'].remove(subelem) - break - - with open(cls.project_rootdir_path / "mkdocs.yml",'w') as mkdocsCfgFile: - mkdocsCfgFile.write(yaml.dump(mkdocsCfg, Dumper=Dumper,default_flow_style=False, sort_keys=False)) - - - res=cls.run_cmd(cmdopts) + for subelem in mkdocsCfg["plugins"]: + if isinstance(subelem, dict): + if "with-pdf" in subelem.keys(): + mkdocsCfg["plugins"].remove(subelem) + break + + with open(cls.project_rootdir_path / "mkdocs.yml", "w") as mkdocsCfgFile: + mkdocsCfgFile.write(yaml.dump(mkdocsCfg, Dumper=Dumper, default_flow_style=False, sort_keys=False)) + + res = cls.run_cmd(cmdopts) print(res.decode()) - print(' !! done') - + print(" !! done") diff --git a/helpers/helper_base.py b/helpers/helper_base.py index 74cf0e8..294ca80 100644 --- a/helpers/helper_base.py +++ b/helpers/helper_base.py @@ -9,64 +9,66 @@ from __future__ import annotations from typing import TYPE_CHECKING -from abc import ABC,abstractmethod +from abc import ABC, abstractmethod import os from pathlib import Path import subprocess if TYPE_CHECKING: # Only imports the below statements during type checking - from typing import Union + from typing import Union + class helper_base(ABC): - project_rootdir_path: Union[Path,None] = None - pyproject: Union[dict,None] = None - current_dir: Union[Path,None] = None - - @classmethod - def set_context(cls,project_rootdir_path:Path, pyproject:dict): - cls.project_rootdir_path = project_rootdir_path - cls.pyproject = pyproject - cls.current_dir = Path(__file__).parent.absolute() - - @classmethod + project_rootdir_path: Union[Path, None] = None + pyproject: Union[dict, None] = None + current_dir: Union[Path, None] = None + + @classmethod + def set_context(cls, project_rootdir_path: Path, pyproject: dict): + cls.project_rootdir_path = project_rootdir_path + cls.pyproject = pyproject + cls.current_dir = Path(__file__).parent.absolute() + + @classmethod def get_result_dir(cls): return None - - @staticmethod - def _reset_dir(dirpath:Path): + + @staticmethod + def _reset_dir(dirpath: Path): dirpath = Path(dirpath) if not os.path.exists(dirpath): os.makedirs(dirpath) - [f.unlink() for f in Path(dirpath).glob("*") if f.is_file()] - - @classmethod + [f.unlink() for f in Path(dirpath).glob("*") if f.is_file()] + + @classmethod def reset_result_dir(cls): result_dir = cls.get_result_dir() if result_dir != None: cls._reset_dir(result_dir) - - @classmethod + + @classmethod @abstractmethod - def do_job(cls): + def do_job(cls): raise NotImplementedError() - @classmethod + @classmethod def run_cmd_(cls, cmdarray): process = subprocess.run(cmdarray, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True, check=True) return process.stdout - - @classmethod + + @classmethod def run_cmd(cls, cmdarray): p = subprocess.run(cmdarray, capture_output=True) print(p.stdout) print(p.stderr) return p.stdout - + + class helper_withresults_base(helper_base): - helper_results_dir: Union[Path,None] = None - - @classmethod + helper_results_dir: Union[Path, None] = None + + @classmethod def get_result_dir(cls): - if cls.helper_results_dir==None: - cls.helper_results_dir=cls.__name__ - return Path(__file__).parent.parent.absolute() / "helpers-results" / cls.helper_results_dir \ No newline at end of file + if cls.helper_results_dir == None: + cls.helper_results_dir = cls.__name__ + return Path(__file__).parent.parent.absolute() / "helpers-results" / cls.helper_results_dir diff --git a/helpers/quality_check.py b/helpers/quality_check.py index 7616d5f..159d05c 100644 --- a/helpers/quality_check.py +++ b/helpers/quality_check.py @@ -25,197 +25,221 @@ import pylint_json2html from .helper_base import helper_withresults_base + class PyLintMetricNotFound(Warning): pass -class quality_check(helper_withresults_base): - PylintMessageList=dict() - - @classmethod + +class quality_check(helper_withresults_base): + PylintMessageList = dict() + + @classmethod def GetPylintMessageList(cls): - Messagelist=dict() - regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)" - for line in cls.run_cmd([sys.executable,"-m","pylint","--list-msgs"]).splitlines(): - if res:=re.search(regex,line.decode()): - Messagelist[res.group(1)]=res.group(2) + Messagelist = dict() + regex = r"^:([a-zA-Z-]+) \(([^\)]+)\)" + for line in cls.run_cmd([sys.executable, "-m", "pylint", "--list-msgs"]).splitlines(): + if res := re.search(regex, line.decode()): + Messagelist[res.group(1)] = res.group(2) cls.PylintMessageList = Messagelist @staticmethod - def TryExtractPYReportMetric(line: str,tag: str): - regex=f"^(?:\|{tag}\s*\|)(\d+)(?=\s*|)" - if res:=re.search(regex,line): + def TryExtractPYReportMetric(line: str, tag: str): + regex = f"^(?:\|{tag}\s*\|)(\d+)(?=\s*|)" + if res := re.search(regex, line): return float(res.group(1)) raise PyLintMetricNotFound() - @classmethod - def do_job(cls): + @classmethod + def do_job(cls): print("checking code quality ...") cls.GetPylintMessageList() - - RES_all=dict() + + RES_all = dict() with StringIO() as StdOutput: - JsonContent="" + JsonContent = "" with redirect_stdout(StdOutput): - pylint_Run(['--output-format=json,parseable', - '--disable=invalid-name', - '--ignore=_version.py', - '--reports=y', - '--score=yes', - '--max-line-length=140', - 'src.' + cls.pyproject['project']['name']], exit=False) - - with open(cls.get_result_dir()/"report.json","w+", encoding='utf-8') as Outfile: + pylint_Run( + [ + "--output-format=json,parseable", + "--disable=invalid-name", + "--ignore=_version.py", + "--reports=y", + "--score=yes", + "--max-line-length=140", + "src." + cls.pyproject["project"]["name"], + ], + exit=False, + ) + + with open(cls.get_result_dir() / "report.json", "w+", encoding="utf-8") as Outfile: # hacky way of exctracting json + having overall score... class TScanState(Enum): - TEXT_REPORT = 1 - JSON_REPORT = 2 - OTHER_REPORT_START = 3 - OTHER_REPORT_STATISTICS = 4 - OTHER_REPORT_METRICS = 5 - OTHER_REPORT_DUPLICATION = 6 - OTHER_REPORT_MESSAGES_CAT = 7 - OTHER_REPORT_MESSAGES = 8 - OTHER_REPORT_END = 99 - - RES_all['Statistics'] = dict() - RES_all['RawMetrics'] = dict() - RES_all['RawMetricsPercent'] = dict() - RES_all['Duplication'] = dict() - RES_all['MessagesCat'] = dict() - RES_all['Messages'] = dict() - RES_all['GlobalScore'] = -999 - RES_all['NbAnalysedStatments'] = -999 - RES_all['NbAnalysedLines'] = -999 - + TEXT_REPORT = 1 + JSON_REPORT = 2 + OTHER_REPORT_START = 3 + OTHER_REPORT_STATISTICS = 4 + OTHER_REPORT_METRICS = 5 + OTHER_REPORT_DUPLICATION = 6 + OTHER_REPORT_MESSAGES_CAT = 7 + OTHER_REPORT_MESSAGES = 8 + OTHER_REPORT_END = 99 + + RES_all["Statistics"] = dict() + RES_all["RawMetrics"] = dict() + RES_all["RawMetricsPercent"] = dict() + RES_all["Duplication"] = dict() + RES_all["MessagesCat"] = dict() + RES_all["Messages"] = dict() + RES_all["GlobalScore"] = -999 + RES_all["NbAnalysedStatments"] = -999 + RES_all["NbAnalysedLines"] = -999 + ScanState = TScanState.TEXT_REPORT - for line in StdOutput.getvalue().split('\n'): - print(line) - if ScanState == TScanState.TEXT_REPORT: + for line in StdOutput.getvalue().split("\n"): + print(line) + if ScanState == TScanState.TEXT_REPORT: # ignoring this part, we need json - if line=='[': - JsonContent+=line + if line == "[": + JsonContent += line ScanState = TScanState.JSON_REPORT - elif line=='[]': - JsonContent+=line + elif line == "[]": + JsonContent += line ScanState = TScanState.OTHER_REPORT_START - - elif ScanState == TScanState.JSON_REPORT: - JsonContent+=line - if line==']': + + elif ScanState == TScanState.JSON_REPORT: + JsonContent += line + if line == "]": ScanState = TScanState.OTHER_REPORT_START - - elif ScanState == TScanState.OTHER_REPORT_START: - if res:=re.search(r"^(\d+)(?= statements analysed.)",line): - RES_all['NbAnalysedStatments'] = float(res.group(1)) + + elif ScanState == TScanState.OTHER_REPORT_START: + if res := re.search(r"^(\d+)(?= statements analysed.)", line): + RES_all["NbAnalysedStatments"] = float(res.group(1)) if line == "Statistics by type": ScanState = TScanState.OTHER_REPORT_STATISTICS - - elif ScanState == TScanState.OTHER_REPORT_STATISTICS: - if res:=re.search(r"^(\d+)(?= lines have been analyzed)",line): - RES_all['NbAnalysedLines' ]= float(res.group(1)) + + elif ScanState == TScanState.OTHER_REPORT_STATISTICS: + if res := re.search(r"^(\d+)(?= lines have been analyzed)", line): + RES_all["NbAnalysedLines"] = float(res.group(1)) elif line == "Raw metrics": ScanState = TScanState.OTHER_REPORT_METRICS else: - with suppress(PyLintMetricNotFound): RES_all['Statistics']['module'] = cls.TryExtractPYReportMetric(line,"module") - with suppress(PyLintMetricNotFound): RES_all['Statistics']['class'] = cls.TryExtractPYReportMetric(line,"class") - with suppress(PyLintMetricNotFound): RES_all['Statistics']['method'] = cls.TryExtractPYReportMetric(line,"method") - with suppress(PyLintMetricNotFound): RES_all['Statistics']['function'] = cls.TryExtractPYReportMetric(line,"function") - - elif ScanState == TScanState.OTHER_REPORT_METRICS: + with suppress(PyLintMetricNotFound): + RES_all["Statistics"]["module"] = cls.TryExtractPYReportMetric(line, "module") + with suppress(PyLintMetricNotFound): + RES_all["Statistics"]["class"] = cls.TryExtractPYReportMetric(line, "class") + with suppress(PyLintMetricNotFound): + RES_all["Statistics"]["method"] = cls.TryExtractPYReportMetric(line, "method") + with suppress(PyLintMetricNotFound): + RES_all["Statistics"]["function"] = cls.TryExtractPYReportMetric(line, "function") + + elif ScanState == TScanState.OTHER_REPORT_METRICS: if line == "Duplication": - RES_all['RawMetricsPercent']['code'] = RES_all['RawMetrics']['code'] / RES_all['NbAnalysedLines' ] - RES_all['RawMetricsPercent']['docstring'] = RES_all['RawMetrics']['docstring'] / RES_all['NbAnalysedLines' ] - RES_all['RawMetricsPercent']['comment'] = RES_all['RawMetrics']['comment'] / RES_all['NbAnalysedLines' ] - RES_all['RawMetricsPercent']['empty'] = RES_all['RawMetrics']['empty'] / RES_all['NbAnalysedLines' ] + RES_all["RawMetricsPercent"]["code"] = RES_all["RawMetrics"]["code"] / RES_all["NbAnalysedLines"] + RES_all["RawMetricsPercent"]["docstring"] = RES_all["RawMetrics"]["docstring"] / RES_all["NbAnalysedLines"] + RES_all["RawMetricsPercent"]["comment"] = RES_all["RawMetrics"]["comment"] / RES_all["NbAnalysedLines"] + RES_all["RawMetricsPercent"]["empty"] = RES_all["RawMetrics"]["empty"] / RES_all["NbAnalysedLines"] ScanState = TScanState.OTHER_REPORT_DUPLICATION else: - with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['code'] = cls.TryExtractPYReportMetric(line,"code") - with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['docstring'] = cls.TryExtractPYReportMetric(line,"docstring") - with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['comment'] = cls.TryExtractPYReportMetric(line,"comment") - with suppress(PyLintMetricNotFound): RES_all['RawMetrics']['empty'] = cls.TryExtractPYReportMetric(line,"empty") - - elif ScanState == TScanState.OTHER_REPORT_DUPLICATION: + with suppress(PyLintMetricNotFound): + RES_all["RawMetrics"]["code"] = cls.TryExtractPYReportMetric(line, "code") + with suppress(PyLintMetricNotFound): + RES_all["RawMetrics"]["docstring"] = cls.TryExtractPYReportMetric(line, "docstring") + with suppress(PyLintMetricNotFound): + RES_all["RawMetrics"]["comment"] = cls.TryExtractPYReportMetric(line, "comment") + with suppress(PyLintMetricNotFound): + RES_all["RawMetrics"]["empty"] = cls.TryExtractPYReportMetric(line, "empty") + + elif ScanState == TScanState.OTHER_REPORT_DUPLICATION: if line == "Messages by category": ScanState = TScanState.OTHER_REPORT_MESSAGES_CAT else: - with suppress(PyLintMetricNotFound): RES_all['Duplication']['NbDupLines'] = cls.TryExtractPYReportMetric(line,"nb duplicated lines") - with suppress(PyLintMetricNotFound): RES_all['Duplication']['PersentDuplicatedLines'] = cls.TryExtractPYReportMetric(line,"percent duplicated lines") - - elif ScanState == TScanState.OTHER_REPORT_MESSAGES_CAT: + with suppress(PyLintMetricNotFound): + RES_all["Duplication"]["NbDupLines"] = cls.TryExtractPYReportMetric(line, "nb duplicated lines") + with suppress(PyLintMetricNotFound): + RES_all["Duplication"]["PersentDuplicatedLines"] = cls.TryExtractPYReportMetric( + line, "percent duplicated lines" + ) + + elif ScanState == TScanState.OTHER_REPORT_MESSAGES_CAT: if line == "Messages": ScanState = TScanState.OTHER_REPORT_MESSAGES else: - with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Convention'] = cls.TryExtractPYReportMetric(line,"convention") - with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Refactor'] = cls.TryExtractPYReportMetric(line,"refactor") - with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Warning'] = cls.TryExtractPYReportMetric(line,"warning") - with suppress(PyLintMetricNotFound): RES_all['MessagesCat']['Error'] = cls.TryExtractPYReportMetric(line,"error") - - elif ScanState == TScanState.OTHER_REPORT_MESSAGES: + with suppress(PyLintMetricNotFound): + RES_all["MessagesCat"]["Convention"] = cls.TryExtractPYReportMetric(line, "convention") + with suppress(PyLintMetricNotFound): + RES_all["MessagesCat"]["Refactor"] = cls.TryExtractPYReportMetric(line, "refactor") + with suppress(PyLintMetricNotFound): + RES_all["MessagesCat"]["Warning"] = cls.TryExtractPYReportMetric(line, "warning") + with suppress(PyLintMetricNotFound): + RES_all["MessagesCat"]["Error"] = cls.TryExtractPYReportMetric(line, "error") + + elif ScanState == TScanState.OTHER_REPORT_MESSAGES: # approx match because the number of '-' depend on screen width.. if line.startswith("--------"): ScanState = TScanState.OTHER_REPORT_END else: for PylintMessage in cls.PylintMessageList.keys(): - with suppress(PyLintMetricNotFound): RES_all['Messages'][PylintMessage] = cls.TryExtractPYReportMetric(line,PylintMessage) - - elif ScanState == TScanState.OTHER_REPORT_END: - if res:=re.search(r"(?<=Your code has been rated at )(\d+(?:\.\d+)?)/10",line): - RES_all['GlobalScore']=float(res.group(1)) - print(RES_all['GlobalScore']) + with suppress(PyLintMetricNotFound): + RES_all["Messages"][PylintMessage] = cls.TryExtractPYReportMetric(line, PylintMessage) + + elif ScanState == TScanState.OTHER_REPORT_END: + if res := re.search(r"(?<=Your code has been rated at )(\d+(?:\.\d+)?)/10", line): + RES_all["GlobalScore"] = float(res.group(1)) + print(RES_all["GlobalScore"]) else: raise RuntimeError("Invalid ScanState") Outfile.write(JsonContent) - - with open(cls.get_result_dir()/"metrics.json", 'w') as json_file: + + with open(cls.get_result_dir() / "metrics.json", "w") as json_file: json.dump(RES_all, json_file) - - # exporting all Data in one csv, unused atm because jenkins seems not able to select columns from csv an keep displaying all... + + # exporting all Data in one csv, unused atm because jenkins seems not able to select columns from csv an keep displaying all... # => to export a working full csv we need to a 'flat' dict (no more nested dict) RES_all_trim = copy.deepcopy(RES_all) del RES_all_trim["Messages"] - flat_RES_all=pandas.json_normalize(RES_all_trim, sep='_').to_dict(orient='records')[0] - - with open(cls.get_result_dir()/"metrics.csv", 'w', newline='') as csv_file: - writer = csv.DictWriter(csv_file,fieldnames=flat_RES_all.keys()) + flat_RES_all = pandas.json_normalize(RES_all_trim, sep="_").to_dict(orient="records")[0] + + with open(cls.get_result_dir() / "metrics.csv", "w", newline="") as csv_file: + writer = csv.DictWriter(csv_file, fieldnames=flat_RES_all.keys()) writer.writeheader() writer.writerow(flat_RES_all) - + # splited csv exports for jenkins plots: RawMetricsPercent RES_all_percent = RES_all["RawMetricsPercent"] - with open(cls.get_result_dir()/"metrics_rawpercent.csv", 'w', newline='') as csv_file: - writer = csv.DictWriter(csv_file,fieldnames=RES_all_percent.keys()) + with open(cls.get_result_dir() / "metrics_rawpercent.csv", "w", newline="") as csv_file: + writer = csv.DictWriter(csv_file, fieldnames=RES_all_percent.keys()) writer.writeheader() writer.writerow(RES_all_percent) # splited csv exports for jenkins plots: Statistics + Duplication + NbAnalysedStatments + NbAnalysedLines RES_all_stats = copy.deepcopy(RES_all["Statistics"]) - RES_all_stats["NbDupLines"] = RES_all['Duplication']['NbDupLines'] - RES_all_stats["PersentDuplicatedLines"] = RES_all['Duplication']['PersentDuplicatedLines'] - RES_all_stats["NbAnalysedStatments"] = RES_all['NbAnalysedStatments' ] - RES_all_stats["NbAnalysedLines"] = RES_all['NbAnalysedLines' ] - with open(cls.get_result_dir()/"metrics_Statistics.csv", 'w', newline='') as csv_file: - writer = csv.DictWriter(csv_file,fieldnames=RES_all_stats.keys()) + RES_all_stats["NbDupLines"] = RES_all["Duplication"]["NbDupLines"] + RES_all_stats["PersentDuplicatedLines"] = RES_all["Duplication"]["PersentDuplicatedLines"] + RES_all_stats["NbAnalysedStatments"] = RES_all["NbAnalysedStatments"] + RES_all_stats["NbAnalysedLines"] = RES_all["NbAnalysedLines"] + with open(cls.get_result_dir() / "metrics_Statistics.csv", "w", newline="") as csv_file: + writer = csv.DictWriter(csv_file, fieldnames=RES_all_stats.keys()) writer.writeheader() writer.writerow(RES_all_stats) - + # splited csv exports for jenkins plots: Statistics + Duplication - RES_all_MessagesCat = RES_all['MessagesCat'] - with open(cls.get_result_dir()/"metrics_MessagesCat.csv", 'w', newline='') as csv_file: - writer = csv.DictWriter(csv_file,fieldnames=RES_all_MessagesCat.keys()) + RES_all_MessagesCat = RES_all["MessagesCat"] + with open(cls.get_result_dir() / "metrics_MessagesCat.csv", "w", newline="") as csv_file: + writer = csv.DictWriter(csv_file, fieldnames=RES_all_MessagesCat.keys()) writer.writeheader() writer.writerow(RES_all_MessagesCat) - + # splited csv exports for jenkins plots: GlobalScore - RES_GlobalScore = {'GlobalScore': RES_all['GlobalScore']} - with open(cls.get_result_dir()/"metrics_GlobalScore.csv", 'w', newline='') as csv_file: - writer = csv.DictWriter(csv_file,fieldnames=RES_GlobalScore.keys()) + RES_GlobalScore = {"GlobalScore": RES_all["GlobalScore"]} + with open(cls.get_result_dir() / "metrics_GlobalScore.csv", "w", newline="") as csv_file: + writer = csv.DictWriter(csv_file, fieldnames=RES_GlobalScore.keys()) writer.writeheader() writer.writerow(RES_GlobalScore) - + # converting the report using pylint_json2html (/!\ internal API, but as their is no leading '_' ...) - with open(cls.get_result_dir()/"report.html","w+", encoding='utf-8') as Outfile: + with open(cls.get_result_dir() / "report.html", "w+", encoding="utf-8") as Outfile: raw_data = json.loads(JsonContent) - report=pylint_json2html.Report( raw_data) + report = pylint_json2html.Report(raw_data) Outfile.write(report.render()) - + print("Done") diff --git a/helpers/types_check.py b/helpers/types_check.py index 4816e0c..6179581 100644 --- a/helpers/types_check.py +++ b/helpers/types_check.py @@ -16,36 +16,46 @@ from mypy import api from .helper_base import helper_withresults_base -class types_check(helper_withresults_base): +class types_check(helper_withresults_base): JUnitReportName = "junit.xml" - - @classmethod - def do_job(cls): + + @classmethod + def do_job(cls): print("checking code typing ...") - result = api.run([ # project path - "-m", - "src." + str(cls.pyproject['project']['name']), - # analysis configuration - "--ignore-missing-imports", - "--strict-equality", - # reports generation - "--cobertura-xml-report", str(cls.get_result_dir()), - "--html-report", str(cls.get_result_dir()), - "--linecount-report", str(cls.get_result_dir()), - "--linecoverage-report", str(cls.get_result_dir()), - "--lineprecision-report", str(cls.get_result_dir()), - "--txt-report", str(cls.get_result_dir()), - "--xml-report", str(cls.get_result_dir()), - "--junit-xml", str(cls.get_result_dir()) + "/" + cls.JUnitReportName - ]) - + result = api.run( + [ # project path + "-m", + "src." + str(cls.pyproject["project"]["name"]), + # analysis configuration + "--ignore-missing-imports", + "--strict-equality", + # reports generation + "--cobertura-xml-report", + str(cls.get_result_dir()), + "--html-report", + str(cls.get_result_dir()), + "--linecount-report", + str(cls.get_result_dir()), + "--linecoverage-report", + str(cls.get_result_dir()), + "--lineprecision-report", + str(cls.get_result_dir()), + "--txt-report", + str(cls.get_result_dir()), + "--xml-report", + str(cls.get_result_dir()), + "--junit-xml", + str(cls.get_result_dir()) + "/" + cls.JUnitReportName, + ] + ) + if result[0]: - print('\nType checking report:\n') + print("\nType checking report:\n") print(result[0]) # stdout - + if result[1]: - print('\nError report:\n') + print("\nError report:\n") print(result[1]) # stderr - - print('\nExit status:', result[2]) - print("Done") \ No newline at end of file + + print("\nExit status:", result[2]) + print("Done") diff --git a/helpers/unit_test.py b/helpers/unit_test.py index 571f2da..4d9d6a3 100644 --- a/helpers/unit_test.py +++ b/helpers/unit_test.py @@ -21,34 +21,36 @@ from junit2htmlreport import parser as junit2html_parser from .helper_base import helper_withresults_base -class unit_test(helper_withresults_base): - enable_coverage_check: bool = False - enable_xml_export: bool = True +class unit_test(helper_withresults_base): + enable_coverage_check: bool = False + enable_xml_export: bool = True enable_full_xml_export: bool = True - FullReportName: str = "full_report" - CoverageReportName: str = "test_coverage" - - @classmethod - def do_job(cls): - if cls.enable_coverage_check==True: + FullReportName: str = "full_report" + CoverageReportName: str = "test_coverage" + + @classmethod + def do_job(cls): + if cls.enable_coverage_check == True: import coverage - + # preparing unittest framework test_loader = unittest.TestLoader() - + if cls.enable_coverage_check == True: - #we start coverage now because module files discovery is part of the coverage measurement - CoverageReportPath = Path(str(cls.get_result_dir())+"_coverage") + # we start coverage now because module files discovery is part of the coverage measurement + CoverageReportPath = Path(str(cls.get_result_dir()) + "_coverage") cls._reset_dir(CoverageReportPath) - cov = coverage.Coverage(cover_pylib=False,branch=True,source_pkgs=["src."+cls.pyproject['project']['name']]) + cov = coverage.Coverage(cover_pylib=False, branch=True, source_pkgs=["src." + cls.pyproject["project"]["name"]]) cov.start() - - package_tests = test_loader.discover(start_dir=str(cls.project_rootdir_path / "test"),top_level_dir=str(cls.project_rootdir_path / "test")) + + package_tests = test_loader.discover( + start_dir=str(cls.project_rootdir_path / "test"), top_level_dir=str(cls.project_rootdir_path / "test") + ) if cls.enable_xml_export: testRunner = xmlrunner.XMLTestRunner(output=str(str(cls.get_result_dir()))) else: testRunner = unittest.TextTestRunner() - + # running the test testRunner.run(package_tests) @@ -57,23 +59,23 @@ class unit_test(helper_withresults_base): cov.stop() cov.save() cov.html_report(directory=str(CoverageReportPath)) - cov.xml_report(outfile=(CoverageReportPath/f"{cls.CoverageReportName}.xml")) - + cov.xml_report(outfile=(CoverageReportPath / f"{cls.CoverageReportName}.xml")) + # computing results (Only if xml available) if cls.enable_full_xml_export == True: print("Full reports generation...") - FullReportPath = Path(str(cls.get_result_dir())+"_full") + FullReportPath = Path(str(cls.get_result_dir()) + "_full") cls._reset_dir(FullReportPath) - + FullJUnitReport = JUnitXml() - for fname in [fname for fname in os.listdir(cls.get_result_dir()) if fname.endswith('.xml')]: - FullJUnitReport+=JUnitXml.fromfile(str(cls.get_result_dir() / fname)) - + for fname in [fname for fname in os.listdir(cls.get_result_dir()) if fname.endswith(".xml")]: + FullJUnitReport += JUnitXml.fromfile(str(cls.get_result_dir() / fname)) + current_datetime = datetime.datetime.utcnow().strftime("%Y%m%dT%H%M%SZ") full_report_base_name = f'{cls.pyproject["project"]["name"]}-{cls.FullReportName}-{current_datetime}' - FullJUnitReport.write(str(FullReportPath / f'{full_report_base_name}.xml')) - report = junit2html_parser.Junit(FullReportPath/ f'{full_report_base_name}.xml') + FullJUnitReport.write(str(FullReportPath / f"{full_report_base_name}.xml")) + report = junit2html_parser.Junit(FullReportPath / f"{full_report_base_name}.xml") html = report.html() - with open(FullReportPath/ f'{full_report_base_name}.html', "wb") as outfile: - outfile.write(html.encode('utf-8')) - print("Done") \ No newline at end of file + with open(FullReportPath / f"{full_report_base_name}.html", "wb") as outfile: + outfile.write(html.encode("utf-8")) + print("Done") diff --git a/src/pygitversionhelper/__init__.py b/src/pygitversionhelper/__init__.py index ed207f0..81d34c1 100644 --- a/src/pygitversionhelper/__init__.py +++ b/src/pygitversionhelper/__init__.py @@ -14,8 +14,9 @@ from importlib.metadata import version, PackageNotFoundError try: # pragma: no cover __version__ = version("pygitversionhelper") -except PackageNotFoundError: # pragma: no cover +except PackageNotFoundError: # pragma: no cover import warnings + warnings.warn("can not read __version__, assuming local test context, setting it to ?.?.?") __version__ = "?.?.?" diff --git a/src/pygitversionhelper/gitversionhelper.py b/src/pygitversionhelper/gitversionhelper.py index 7b869ea..b045bbb 100644 --- a/src/pygitversionhelper/gitversionhelper.py +++ b/src/pygitversionhelper/gitversionhelper.py @@ -37,9 +37,7 @@ import logging from packaging.version import VERSION_PATTERN as packaging_VERSION_PATTERN -def _exec( - cmd: str, root: str | os.PathLike | None = None, raw: bool = False -) -> list[str]: +def _exec(cmd: str, root: str | os.PathLike | None = None, raw: bool = False) -> list[str]: """ helper function to handle system cmd execution Args: @@ -157,23 +155,15 @@ class gitversionhelper: # pylint: disable=too-few-public-methods current_commit_id = cls.getLast(**kwargs) tag_commit_id = cls.getFromTag(tag) - if (cls.__OptDict["same_branch"] in kwargs) and ( - kwargs[cls.__OptDict["same_branch"]] is True - ): - commits = _exec( - f"git rev-list --first-parent --ancestry-path {tag_commit_id}..{current_commit_id}" - ) + if (cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True): + commits = _exec(f"git rev-list --first-parent --ancestry-path {tag_commit_id}..{current_commit_id}") else: - commits = _exec( - f"git rev-list --ancestry-path {tag_commit_id}..{current_commit_id}" - ) + commits = _exec(f"git rev-list --ancestry-path {tag_commit_id}..{current_commit_id}") result = [] for commit in commits: result.append(cls.getMessage(commit)) - if (cls.__OptDict["merged_output"] in kwargs) and ( - kwargs[cls.__OptDict["merged_output"]] is True - ): + if (cls.__OptDict["merged_output"] in kwargs) and (kwargs[cls.__OptDict["merged_output"]] is True): print("JOIN") return os.linesep.join(result) return result @@ -224,19 +214,13 @@ class gitversionhelper: # pylint: disable=too-few-public-methods Returns: the commit Id """ - if (cls.__OptDict["same_branch"] in kwargs) and ( - kwargs[cls.__OptDict["same_branch"]] is True - ): + if (cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True): try: res = _exec("git rev-parse HEAD") except gitversionhelper.unknownGITFatalError as _e: - raise cls.commitNotFound( - "no commit found in commit history" - ) from _e + raise cls.commitNotFound("no commit found in commit history") from _e else: - res = _exec( - 'git for-each-ref --sort=-committerdate refs/heads/ --count 1 --format="%(objectname)"' - ) + res = _exec('git for-each-ref --sort=-committerdate refs/heads/ --count 1 --format="%(objectname)"') if len(res) == 0: raise cls.commitNotFound("no commit found in commit history") @@ -286,15 +270,9 @@ class gitversionhelper: # pylint: disable=too-few-public-methods 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 - ): + 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}") - ) - ) + return list(reversed(_exec(f"git tag --merged {currentBranch[0]} --sort={sort}"))) return list(reversed(_exec(f"git tag -l --sort={sort}"))) @classmethod @@ -306,9 +284,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods Returns: the tag """ - if (cls.__OptDict["same_branch"] in kwargs) and ( - kwargs[cls.__OptDict["same_branch"]] is True - ): + if (cls.__OptDict["same_branch"] in kwargs) and (kwargs[cls.__OptDict["same_branch"]] is True): res = _exec("git describe --tags --first-parent --abbrev=0") else: res = _exec("git rev-list --tags --date-order --max-count=1") @@ -428,15 +404,10 @@ class gitversionhelper: # pylint: disable=too-few-public-methods """ BumpDevStrategy = cls.DefaultBumpDevStrategy if cls.__OptDict["bump_dev_strategy"] in kwargs: - if ( - kwargs[cls.__OptDict["bump_dev_strategy"]] - in cls.BumpDevStrategys - ): + if kwargs[cls.__OptDict["bump_dev_strategy"]] in cls.BumpDevStrategys: BumpDevStrategy = kwargs[cls.__OptDict["bump_dev_strategy"]] else: - raise gitversionhelper.wrongArguments( - f"invalid {cls.__OptDict['bump_type']} requested" - ) + raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['bump_type']} requested") return BumpDevStrategy @classmethod @@ -453,14 +424,10 @@ class gitversionhelper: # pylint: disable=too-few-public-methods if kwargs[cls.__OptDict["bump_type"]] in cls.BumpTypes: BumpType = kwargs[cls.__OptDict["bump_type"]] else: - raise gitversionhelper.wrongArguments( - f"invalid {cls.__OptDict['bump_type']} requested" - ) + raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['bump_type']} requested") return BumpType - def bump( - self, amount: int = 1, **kwargs - ) -> gitversionhelper.version.MetaVersion | str: # pylint: disable=R0912 + def bump(self, amount: int = 1, **kwargs) -> gitversionhelper.version.MetaVersion | str: # pylint: disable=R0912 """ bump the version to the next one Keyword Arguments: @@ -508,9 +475,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods _v.post_count = 0 _v.raw = _v.doFormatVersion(**kwargs) - if (self.__OptDict["formated_output"] in kwargs) and ( - kwargs[self.__OptDict["formated_output"]] is True - ): + if (self.__OptDict["formated_output"] in kwargs) and (kwargs[self.__OptDict["formated_output"]] is True): return _v.doFormatVersion(**kwargs) return _v @@ -538,9 +503,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods if kwargs[cls.__OptDict["version_std"]] in cls.VersionStds: VersionStd = kwargs[cls.__OptDict["version_std"]] else: - raise gitversionhelper.wrongArguments( - f"invalid {cls.__OptDict['version_std']} requested" - ) + raise gitversionhelper.wrongArguments(f"invalid {cls.__OptDict['version_std']} requested") return VersionStd @classmethod @@ -557,10 +520,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods the last version """ if gitversionhelper.repository.isDirty() is not False: - raise gitversionhelper.repository.repositoryDirty( - "The repository is dirty and a current version" - " can not be generated." - ) + raise gitversionhelper.repository.repositoryDirty("The repository is dirty and a current version" " can not be generated.") saved_kwargs = copy(kwargs) if "formated_output" in kwargs: del saved_kwargs["formated_output"] @@ -571,9 +531,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods amount = gitversionhelper.tag.getDistanceFromTag(_v.raw, **kwargs) _v = _v.bump(amount, **saved_kwargs) - if (cls.__OptDict["formated_output"] in kwargs) and ( - kwargs[cls.__OptDict["formated_output"]] is True - ): + if (cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]] is True): return _v.doFormatVersion(**kwargs) return _v @@ -618,31 +576,21 @@ class gitversionhelper: # pylint: disable=too-few-public-methods pre_count = 0 if _pre := _m.group("prerelease"): - if ( - _match := re.search( - cls.VersionStds["SemVer"]["regex_preversion_num"], _pre - ) - ) is not None: + if (_match := re.search(cls.VersionStds["SemVer"]["regex_preversion_num"], _pre)) is not None: pre_count = int(_match.group("num")) else: pre_count = 1 post_count = 0 if _post := _m.group("buildmetadata"): - if ( - _match := re.search( - cls.VersionStds["SemVer"]["regex_build_num"], _post - ) - ) is not None: + if (_match := re.search(cls.VersionStds["SemVer"]["regex_build_num"], _post)) is not None: post_count = int(_match.group("num")) else: post_count = 1 bFound = True VersionStd = "SemVer" - if VersionStd == "PEP440" or ( - (bAutoVersionStd is True) and (bFound is not True) - ): + if VersionStd == "PEP440" or ((bAutoVersionStd is True) and (bFound is not True)): _r = re.compile( r"^\s*" + cls.VersionStds["PEP440"]["regex"] + r"\s*$", re.VERBOSE | re.IGNORECASE, @@ -663,22 +611,14 @@ class gitversionhelper: # pylint: disable=too-few-public-methods VersionStd = "PEP440" if not bFound: - raise gitversionhelper.version.noValidVersion( - "no valid version found in tags" - ) + raise gitversionhelper.version.noValidVersion("no valid version found in tags") if pre_count > 0 and post_count > 0: - raise cls.PreAndPostVersionUnsupported( - "can not parse a version with both pre" " and post release number." - ) - return cls.MetaVersion( - VersionStd, major, minor, patch, pre_count, post_count, tag - ) + raise cls.PreAndPostVersionUnsupported("can not parse a version with both pre" " and post release number.") + return cls.MetaVersion(VersionStd, major, minor, patch, pre_count, post_count, tag) @classmethod - def getLastVersion( - cls, **kwargs - ) -> MetaVersion | str: # pylint: disable=R0914, R0912, R0915 + def getLastVersion(cls, **kwargs) -> MetaVersion | str: # pylint: disable=R0914, R0912, R0915 """get the last version from tags Keyword Arguments: version_std(str): the given version_std (can be None) @@ -700,9 +640,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods try: _v = cls._parseTag(lastTag, **kwargs) except gitversionhelper.version.noValidVersion as _ex: - if (cls.__OptDict["ignore_unknown_tags"] in kwargs) and ( - kwargs[cls.__OptDict["ignore_unknown_tags"]] is True - ): + 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 for _tag in tags: @@ -714,9 +652,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods if _v is None: raise gitversionhelper.version.noValidVersion() from _ex - if (cls.__OptDict["formated_output"] in kwargs) and ( - kwargs[cls.__OptDict["formated_output"]] is True - ): + if (cls.__OptDict["formated_output"] in kwargs) and (kwargs[cls.__OptDict["formated_output"]] is True): return _v.doFormatVersion(**kwargs) return _v @@ -750,8 +686,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods OutputFormat = "{major}.{minor}.{patch}{revpattern}{revcount}" if post_count > 0 and pre_count > 0: raise gitversionhelper.version.PreAndPostVersionUnsupported( - "cannot output a version with both pre " - "and post release number." + "cannot output a version with both pre " "and post release number." ) if VersionStd == "PEP440": if post_count > 0: diff --git a/test/test_gitversionhelper.py b/test/test_gitversionhelper.py index 1507609..5dac6d8 100644 --- a/test/test_gitversionhelper.py +++ b/test/test_gitversionhelper.py @@ -40,9 +40,7 @@ class Test_gitversionhelper(unittest.TestCase): _v = pygitversionhelper.gitversionhelper.version.getLastVersion(**kwargs) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self.assertIsInstance(_v.raw, str) self.assertEqual(_v.raw, tag) self.assertIsInstance(_v.major, int) @@ -73,9 +71,7 @@ class Test_gitversionhelper(unittest.TestCase): 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" - ) + _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")) @@ -507,13 +503,9 @@ class Test_gitversionhelper(unittest.TestCase): os.system("git add .") os.system('git commit -m "first commit"') - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440" - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.0", version_std="PEP440") self.assertEqual(_v.raw, "0.1.0") self.assertEqual(_v.major, 0) @@ -527,13 +519,9 @@ class Test_gitversionhelper(unittest.TestCase): os.system("git add .") os.system('git commit -m "first commit"') - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="SemVer" - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="SemVer") - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.0", version_std="SemVer") self.assertEqual(_v.raw, "0.1.0") self.assertEqual(_v.major, 0) @@ -549,9 +537,7 @@ class Test_gitversionhelper(unittest.TestCase): _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.0") self.assertEqual(_v.raw, "0.1.0") self.assertEqual(_v.major, 0) @@ -567,9 +553,7 @@ class Test_gitversionhelper(unittest.TestCase): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.2.0") self.assertEqual(_v.raw, "0.2.0") self.assertEqual(_v.major, 0) @@ -585,9 +569,7 @@ class Test_gitversionhelper(unittest.TestCase): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.2.1") self.assertEqual(_v.raw, "0.2.1") self.assertEqual(_v.major, 0) @@ -608,9 +590,7 @@ class Test_gitversionhelper(unittest.TestCase): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.2.3") self.assertEqual(_v.raw, "0.2.3") self.assertEqual(_v.major, 0) @@ -624,13 +604,9 @@ class Test_gitversionhelper(unittest.TestCase): os.system("git add .") os.system('git commit -m "5th commit"') - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( - bump_type="dev" - ) + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev") - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self.assertIsInstance(_v.raw, str) self._test_version_format(_v, "0.2.0+post.4") self.assertEqual(_v.raw, "0.2.0+post.4") @@ -640,13 +616,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 4) - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( - bump_type="dev", bump_dev_strategy="pre-patch" - ) + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev", bump_dev_strategy="pre-patch") - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.2.1-pre.4") self.assertEqual(_v.raw, "0.2.1-pre.4") self.assertEqual(_v.major, 0) @@ -655,13 +627,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 4) self.assertEqual(_v.post_count, 0) - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( - bump_type="dev", bump_dev_strategy="pre-minor" - ) + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev", bump_dev_strategy="pre-minor") - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.3.0-pre.4") self.assertEqual(_v.raw, "0.3.0-pre.4") self.assertEqual(_v.major, 0) @@ -670,13 +638,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 4) self.assertEqual(_v.post_count, 0) - _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion( - bump_type="dev", bump_dev_strategy="pre-major" - ) + _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev", bump_dev_strategy="pre-major") - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "1.0.0-pre.4") self.assertEqual(_v.raw, "1.0.0-pre.4") self.assertEqual(_v.major, 1) @@ -701,9 +665,9 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual( "V_1_0", - pygitversionhelper.gitversionhelper.version.getCurrentVersion( - bump_type="dev", bump_dev_strategy="pre-major" - ).doFormatVersion(output_format="V_{major}_{minor}"), + pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_type="dev", bump_dev_strategy="pre-major").doFormatVersion( + output_format="V_{major}_{minor}" + ), ) self.assertEqual( "V_1_0", @@ -717,9 +681,7 @@ class Test_gitversionhelper(unittest.TestCase): def test_nominal__git__emptyrepo(self): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.0") self.assertEqual(_v.raw, "0.1.0") @@ -735,32 +697,20 @@ class Test_gitversionhelper(unittest.TestCase): with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue225") - with self.assertRaises( - pygitversionhelper.gitversionhelper.repository.repositoryDirty - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.repository.repositoryDirty): pygitversionhelper.gitversionhelper.version.getCurrentVersion() def test_defect__version_post_and_pre_output(self): - _v = pygitversionhelper.gitversionhelper.version.MetaVersion( - "PEP440", 0, 0, 1, 1, 1, "0.0.1.pre1.post1" - ) - with self.assertRaises( - pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported - ): + _v = pygitversionhelper.gitversionhelper.version.MetaVersion("PEP440", 0, 0, 1, 1, 1, "0.0.1.pre1.post1") + with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported): _v.doFormatVersion() - _v = pygitversionhelper.gitversionhelper.version.MetaVersion( - "SemVer", 0, 0, 1, 1, 1, "0.0.1-pre.1+post.1" - ) - with self.assertRaises( - pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported - ): + _v = pygitversionhelper.gitversionhelper.version.MetaVersion("SemVer", 0, 0, 1, 1, 1, "0.0.1-pre.1+post.1") + with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported): _v.doFormatVersion() def test_defect__version_post_and_pre_parse(self): - with self.assertRaises( - pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.version.PreAndPostVersionUnsupported): pygitversionhelper.gitversionhelper.version._parseTag("0.0.1.pre1.post1") def test_defect__git__wrongargument_sortargs(self): @@ -790,16 +740,12 @@ class Test_gitversionhelper(unittest.TestCase): def test_defect__wrongargument_bump_type(self): _v = self._test_version_readback("0.1.1", version_std="PEP440") with self.assertRaises(pygitversionhelper.gitversionhelper.wrongArguments): - pygitversionhelper.gitversionhelper.version.getCurrentVersion( - bump_type="toto" - ) + 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): - pygitversionhelper.gitversionhelper.version.getCurrentVersion( - bump_dev_strategy="toto" - ) + pygitversionhelper.gitversionhelper.version.getCurrentVersion(bump_dev_strategy="toto") def test_nominal__tag__getDistanceFromTag(self): with open("demofile.txt", "w+t") as tmpFile: @@ -829,12 +775,8 @@ class Test_gitversionhelper(unittest.TestCase): os.system("git add .") os.system('git commit -m "commit"') - self.assertEqual( - 2, pygitversionhelper.gitversionhelper.tag.getDistanceFromTag() - ) - self.assertEqual( - 4, pygitversionhelper.gitversionhelper.tag.getDistanceFromTag("0.2.0") - ) + self.assertEqual(2, pygitversionhelper.gitversionhelper.tag.getDistanceFromTag()) + self.assertEqual(4, pygitversionhelper.gitversionhelper.tag.getDistanceFromTag("0.2.0")) def test_nominal__tag__getTags(self): with open("demofile.txt", "w+t") as tmpFile: @@ -1028,12 +970,8 @@ class Test_gitversionhelper(unittest.TestCase): print("===") """ - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440" - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.2.0", version_std="PEP440") self.assertEqual(_v.raw, "0.2.0") self.assertEqual(_v.major, 0) @@ -1046,12 +984,8 @@ class Test_gitversionhelper(unittest.TestCase): os.system('git commit -m "3rd commit"') os.system(f"git tag 0.3.0") - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440" - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.3.0", version_std="PEP440") self.assertEqual(_v.raw, "0.3.0") self.assertEqual(_v.major, 0) @@ -1060,24 +994,16 @@ class Test_gitversionhelper(unittest.TestCase): os.system("git switch master") - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440" - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.3.0", version_std="PEP440") self.assertEqual(_v.raw, "0.3.0") self.assertEqual(_v.major, 0) self.assertEqual(_v.minor, 3) self.assertEqual(_v.patch, 0) - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440", same_branch=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440", same_branch=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.0", version_std="PEP440") self.assertEqual(_v.raw, "0.1.0") self.assertEqual(_v.major, 0) @@ -1086,24 +1012,16 @@ class Test_gitversionhelper(unittest.TestCase): os.system('git merge --no-ff dev -m "merge dev into master"') - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440", same_branch=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440", same_branch=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.0", version_std="PEP440") self.assertEqual(_v.raw, "0.1.0") self.assertEqual(_v.major, 0) self.assertEqual(_v.minor, 1) self.assertEqual(_v.patch, 0) - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440" - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.3.0", version_std="PEP440") self.assertEqual(_v.raw, "0.3.0") self.assertEqual(_v.major, 0) @@ -1112,24 +1030,16 @@ class Test_gitversionhelper(unittest.TestCase): os.system(f"git tag 0.4.0") - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440", same_branch=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440", same_branch=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.4.0", version_std="PEP440") self.assertEqual(_v.raw, "0.4.0") self.assertEqual(_v.major, 0) self.assertEqual(_v.minor, 4) self.assertEqual(_v.patch, 0) - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - version_std="PEP440" - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(version_std="PEP440") + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.4.0", version_std="PEP440") self.assertEqual(_v.raw, "0.4.0") self.assertEqual(_v.major, 0) @@ -1143,17 +1053,11 @@ 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 - ): + 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 - ) + 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: @@ -1168,17 +1072,11 @@ class Test_gitversionhelper(unittest.TestCase): os.system('git commit -m "commit"') os.system(f"git tag INVALIDTAG") - with self.assertRaises( - pygitversionhelper.gitversionhelper.version.noValidVersion - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion): _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - ignore_unknown_tags=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.0.1", version_std="PEP440") self.assertEqual(_v.raw, "0.0.1") self.assertEqual(_v.major, 0) @@ -1203,17 +1101,11 @@ class Test_gitversionhelper(unittest.TestCase): os.system('git commit -m "commit"') os.system(f"git tag INVALIDTA4") - with self.assertRaises( - pygitversionhelper.gitversionhelper.version.noValidVersion - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion): _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - ignore_unknown_tags=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.0.1", version_std="PEP440") self.assertEqual(_v.raw, "0.0.1") self.assertEqual(_v.major, 0) @@ -1227,21 +1119,15 @@ class Test_gitversionhelper(unittest.TestCase): os.system(f"git tag 0.1.2") _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.2", version_std="PEP440") self.assertEqual(_v.raw, "0.1.2") self.assertEqual(_v.major, 0) self.assertEqual(_v.minor, 1) self.assertEqual(_v.patch, 2) - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - ignore_unknown_tags=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.2", version_std="PEP440") self.assertEqual(_v.raw, "0.1.2") self.assertEqual(_v.major, 0) @@ -1254,17 +1140,11 @@ class Test_gitversionhelper(unittest.TestCase): os.system('git commit -m "commit"') os.system(f"git tag INVALIDTA5") - with self.assertRaises( - pygitversionhelper.gitversionhelper.version.noValidVersion - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.version.noValidVersion): _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - ignore_unknown_tags=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.2", version_std="PEP440") self.assertEqual(_v.raw, "0.1.2") self.assertEqual(_v.major, 0) @@ -1278,21 +1158,15 @@ class Test_gitversionhelper(unittest.TestCase): os.system(f"git tag 0.1.3") _v = pygitversionhelper.gitversionhelper.version.getLastVersion() - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.3", version_std="PEP440") self.assertEqual(_v.raw, "0.1.3") self.assertEqual(_v.major, 0) self.assertEqual(_v.minor, 1) self.assertEqual(_v.patch, 3) - _v = pygitversionhelper.gitversionhelper.version.getLastVersion( - ignore_unknown_tags=True - ) - self.assertIsInstance( - _v, pygitversionhelper.gitversionhelper.version.MetaVersion - ) + _v = pygitversionhelper.gitversionhelper.version.getLastVersion(ignore_unknown_tags=True) + self.assertIsInstance(_v, pygitversionhelper.gitversionhelper.version.MetaVersion) self._test_version_format(_v, "0.1.3", version_std="PEP440") self.assertEqual(_v.raw, "0.1.3") self.assertEqual(_v.major, 0) @@ -1349,9 +1223,7 @@ class Test_gitversionhelper(unittest.TestCase): fourth2_commit = pygitversionhelper.gitversionhelper.commit.getLast() self.assertEqual(fourth2_commit, fourth_commit) - fourth3_commit = pygitversionhelper.gitversionhelper.commit.getLast( - same_branch=True - ) + fourth3_commit = pygitversionhelper.gitversionhelper.commit.getLast(same_branch=True) self.assertNotEqual(fourth3_commit, fourth_commit) self.assertEqual(fourth3_commit, third_commit) @@ -1370,21 +1242,15 @@ class Test_gitversionhelper(unittest.TestCase): fifth2_commit = pygitversionhelper.gitversionhelper.commit.getLast() self.assertEqual(fifth2_commit, fifth_commit) - fifth2_commit = pygitversionhelper.gitversionhelper.commit.getLast( - same_branch=True - ) + fifth2_commit = pygitversionhelper.gitversionhelper.commit.getLast(same_branch=True) self.assertEqual(fifth2_commit, fourth_commit) def test_defect__commit_notfound(self): - with self.assertRaises( - pygitversionhelper.gitversionhelper.commit.commitNotFound - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound): pygitversionhelper.gitversionhelper.commit.getLast() - with self.assertRaises( - pygitversionhelper.gitversionhelper.commit.commitNotFound - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound): pygitversionhelper.gitversionhelper.commit.getLast(same_branch=True) def test_nominal__commit_getFromTag(self): @@ -1409,9 +1275,7 @@ class Test_gitversionhelper(unittest.TestCase): def test_defect__commit_notfound2(self): - with self.assertRaises( - pygitversionhelper.gitversionhelper.commit.commitNotFound - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound): pygitversionhelper.gitversionhelper.commit.getFromTag("TAG") with open("demofile.txt", "w+t") as tmpFile: @@ -1419,16 +1283,12 @@ class Test_gitversionhelper(unittest.TestCase): os.system("git add .") os.system('git commit -m "commit"') - with self.assertRaises( - pygitversionhelper.gitversionhelper.commit.commitNotFound - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound): pygitversionhelper.gitversionhelper.commit.getFromTag("TAG") os.system(f"git tag OTHER_TAG") - with self.assertRaises( - pygitversionhelper.gitversionhelper.commit.commitNotFound - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound): pygitversionhelper.gitversionhelper.commit.getFromTag("TAG") def test_nominal__commit_getMessage(self): @@ -1464,9 +1324,7 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(message, commit_message) def test_nominal__commit_getMessagesSinceLastTag(self): - commit_message1 = ( - "1.1 update this" + os.linesep + "1.1 fix that" + os.linesep + "1.1 test" - ) + commit_message1 = "1.1 update this" + os.linesep + "1.1 fix that" + os.linesep + "1.1 test" commit_message1 = commit_message1.replace("\r\n", "\n").replace("\n", "\r\n") with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") @@ -1477,9 +1335,7 @@ class Test_gitversionhelper(unittest.TestCase): subprocess.run(cmd, text=True, check=True) os.system(f"git tag 0.1.1") - commit_message2 = ( - "2.1 update this" + os.linesep + "2.1 fix that" + os.linesep + "2.1 test" - ) + commit_message2 = "2.1 update this" + os.linesep + "2.1 fix that" + os.linesep + "2.1 test" commit_message2 = commit_message2.replace("\r\n", "\n").replace("\n", "\r\n") with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue2") @@ -1489,9 +1345,7 @@ class Test_gitversionhelper(unittest.TestCase): cmd.append(commit_message2) subprocess.run(cmd, text=True, check=True) - commit_message3 = ( - "3.1 update this" + os.linesep + "3.1 fix that" + os.linesep + "3.1 test" - ) + commit_message3 = "3.1 update this" + os.linesep + "3.1 fix that" + os.linesep + "3.1 test" commit_message3 = commit_message3.replace("\r\n", "\n").replace("\n", "\r\n") with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue3") @@ -1501,9 +1355,7 @@ class Test_gitversionhelper(unittest.TestCase): cmd.append(commit_message3) subprocess.run(cmd, text=True, check=True) - commit_message4 = ( - "4.1 update this" + os.linesep + "4.1 fix that" + os.linesep + "4.1 test" - ) + commit_message4 = "4.1 update this" + os.linesep + "4.1 fix that" + os.linesep + "4.1 test" commit_message4 = commit_message4.replace("\r\n", "\n").replace("\n", "\r\n") with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue4") @@ -1516,12 +1368,8 @@ class Test_gitversionhelper(unittest.TestCase): res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1") self.assertEqual([commit_message4, commit_message3, commit_message2], res) - res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag( - "0.1.1", merged_output=True - ) - self.assertEqual( - os.linesep.join([commit_message4, commit_message3, commit_message2]), res - ) + res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True) + self.assertEqual(os.linesep.join([commit_message4, commit_message3, commit_message2]), res) def tearDown(self): os.chdir("/") @@ -1534,9 +1382,7 @@ class Test_gitversionhelperNoRepo(unittest.TestCase): os.chdir(self.TmpWorkingDirPath) def test_defect__norepo(self): - with self.assertRaises( - pygitversionhelper.gitversionhelper.repository.notAGitRepository - ): + with self.assertRaises(pygitversionhelper.gitversionhelper.repository.notAGitRepository): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() def tearDown(self): -- 2.47.3 From 3bb580689a7d5992297bb32d68ce92ba2179fc81 Mon Sep 17 00:00:00 2001 From: cclecle Date: Wed, 22 Mar 2023 23:32:36 +0000 Subject: [PATCH 05/30] improve formating fix kwargs call --- src/pygitversionhelper/gitversionhelper.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/pygitversionhelper/gitversionhelper.py b/src/pygitversionhelper/gitversionhelper.py index b045bbb..89df853 100644 --- a/src/pygitversionhelper/gitversionhelper.py +++ b/src/pygitversionhelper/gitversionhelper.py @@ -520,7 +520,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods the last version """ if gitversionhelper.repository.isDirty() is not False: - raise gitversionhelper.repository.repositoryDirty("The repository is dirty and a current version" " can not be generated.") + raise gitversionhelper.repository.repositoryDirty("The repository is dirty and a current version can not be generated.") saved_kwargs = copy(kwargs) if "formated_output" in kwargs: del saved_kwargs["formated_output"] @@ -541,7 +541,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods Same as getCurrentVersion() with formated_output kwarg activated """ kwargs["formated_output"] = True - return cls.getCurrentVersion(kwargs) + return cls.getCurrentVersion(**kwargs) @classmethod def _parseTag(cls, tag, **kwargs): # pylint: disable=R0914, R0912, R0915 @@ -614,7 +614,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods raise gitversionhelper.version.noValidVersion("no valid version found in tags") if pre_count > 0 and post_count > 0: - raise cls.PreAndPostVersionUnsupported("can not parse a version with both pre" " and post release number.") + raise cls.PreAndPostVersionUnsupported("can not parse a version with both pre and post release number.") return cls.MetaVersion(VersionStd, major, minor, patch, pre_count, post_count, tag) @classmethod @@ -686,7 +686,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods OutputFormat = "{major}.{minor}.{patch}{revpattern}{revcount}" if post_count > 0 and pre_count > 0: raise gitversionhelper.version.PreAndPostVersionUnsupported( - "cannot output a version with both pre " "and post release number." + "cannot output a version with both pre and post release number." ) if VersionStd == "PEP440": if post_count > 0: -- 2.47.3 From f74633cee3f32cf680717fac6dd852e20806cb80 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 00:07:53 +0000 Subject: [PATCH 06/30] feat: remove coverage pragma because we need to be realistic test: add missing unit test --- src/pygitversionhelper/gitversionhelper.py | 12 ++++---- test/test_gitversionhelper.py | 35 ++++++++++++++++++++++ 2 files changed, 41 insertions(+), 6 deletions(-) diff --git a/src/pygitversionhelper/gitversionhelper.py b/src/pygitversionhelper/gitversionhelper.py index 89df853..910ba73 100644 --- a/src/pygitversionhelper/gitversionhelper.py +++ b/src/pygitversionhelper/gitversionhelper.py @@ -58,9 +58,9 @@ def _exec(cmd: str, root: str | os.PathLike | None = None, raw: bool = False) -> ) if re.search("not a git repository", p.stderr): raise gitversionhelper.repository.notAGitRepository() - if re.search("fatal:", p.stderr): # pragma: nocover + if re.search("fatal:", p.stderr): raise gitversionhelper.unknownGITFatalError(p.stderr) - if int(p.returncode) < 0: # pragma: nocover + if int(p.returncode) < 0: raise gitversionhelper.unknownGITError(p.stderr) if raw: @@ -145,7 +145,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods def getMessagesSinceTag(cls, tag: str, **kwargs) -> str: """ retrieve a commits message history from repository - from LastCommit to the given tag + from Latest commit to the given tag Keyword Arguments: merged_output: output one single merged string same_branch(bool): force searching only in the same branch @@ -278,7 +278,7 @@ class gitversionhelper: # pylint: disable=too-few-public-methods @classmethod def getLastTag(cls, **kwargs) -> str | None: """ - retrieve the last tag from a repository + retrieve the Latest tag from a repository Keyword Arguments: same_branch(bool): force searching only in the same branch Returns: @@ -293,14 +293,14 @@ 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: # pragma: nocover + if len(res) != 1: raise cls.moreThanOneTag("multiple tags on same commit is unsupported") return res[0] @classmethod def getDistanceFromTag(cls, tag: str = None, **kwargs) -> int: """ - retrieve the distance between HEAD and tag in the repository + retrieve the distance between Latest commit and tag in the repository Arguments: tag: reference tag, if None the most recent one will be used Keyword Arguments: diff --git a/test/test_gitversionhelper.py b/test/test_gitversionhelper.py index 5dac6d8..b7274e0 100644 --- a/test/test_gitversionhelper.py +++ b/test/test_gitversionhelper.py @@ -544,6 +544,15 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.minor, 1) self.assertEqual(_v.patch, 0) + def test_nominal__version___getCurrentFormatedVersion(self): + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue") + os.system("git add .") + os.system('git commit -m "first commit"') + os.system(f"git tag 0.2.0") + + self.assertEqual(pygitversionhelper.gitversionhelper.version.getCurrentFormatedVersion(), "0.2.0") + def test_nominal__version___AUTO_bump_commits(self): with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") @@ -1253,6 +1262,10 @@ class Test_gitversionhelper(unittest.TestCase): with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound): pygitversionhelper.gitversionhelper.commit.getLast(same_branch=True) + def test_defect__commit_getMessage_notfound(self): + with self.assertRaises(pygitversionhelper.gitversionhelper.commit.commitNotFound): + pygitversionhelper.gitversionhelper.commit.getMessage("") + def test_nominal__commit_getFromTag(self): with open("demofile.txt", "w+t") as tmpFile: tmpFile.write("testvalue") @@ -1371,6 +1384,28 @@ class Test_gitversionhelper(unittest.TestCase): res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True) self.assertEqual(os.linesep.join([commit_message4, commit_message3, commit_message2]), res) + cmd = "git checkout -b dev".split() + subprocess.run(cmd, text=True, check=True) + + commit_message5 = "5.1 update this" + os.linesep + "5.1 fix that" + os.linesep + "5.1 test" + commit_message5 = commit_message5.replace("\r\n", "\n").replace("\n", "\r\n") + with open("demofile.txt", "w+t") as tmpFile: + tmpFile.write("testvalue5") + os.system("git add .") + + cmd = "git commit -m".split() + cmd.append(commit_message5) + subprocess.run(cmd, text=True, check=True) + + cmd = "git switch master".split() + subprocess.run(cmd, text=True, check=True) + + res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True, same_branch=True) + self.assertEqual(os.linesep.join([commit_message4, commit_message3, commit_message2]), res) + + res = pygitversionhelper.gitversionhelper.commit.getMessagesSinceTag("0.1.1", merged_output=True) + self.assertEqual(os.linesep.join([commit_message5, commit_message4, commit_message3, commit_message2]), res) + def tearDown(self): os.chdir("/") -- 2.47.3 From 6e1bff135b67ece18099b99b0d3350df8975827b Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 01:12:51 +0000 Subject: [PATCH 07/30] add missing test --- test/test_gitversionhelper.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/test/test_gitversionhelper.py b/test/test_gitversionhelper.py index b7274e0..137ed34 100644 --- a/test/test_gitversionhelper.py +++ b/test/test_gitversionhelper.py @@ -298,6 +298,8 @@ class Test_gitversionhelper(unittest.TestCase): self.assertEqual(_v.pre_count, 0) self.assertEqual(_v.post_count, 2) self.assertEqual(_v.doFormatVersion(), "2.1.2+post.2") + self.assertEqual(_v.doFormatVersion(version_std="SemVer"), "2.1.2+post.2") + self.assertEqual(_v.doFormatVersion(version_std="PEP440"), "2.1.2.post2") _v = _v.bump(bump_type="patch") self.assertEqual(_v.raw, "2.1.3") @@ -687,6 +689,12 @@ class Test_gitversionhelper(unittest.TestCase): formated_output=True, ), ) + self.assertEqual( + "0.1.1", + pygitversionhelper.gitversionhelper.version.getLastVersion( + formated_output=True, + ), + ) def test_nominal__git__emptyrepo(self): _v = pygitversionhelper.gitversionhelper.version.getCurrentVersion() -- 2.47.3 From cc2f6353ac89831523abc53dd05659c73be48f7e Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 21:40:03 +0000 Subject: [PATCH 08/30] add coverage results publishing --- Jenkinsfile | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index f15aeb5..dc6a0f5 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -6,7 +6,11 @@ // You should have received a copy of the license along with this // work. If not, see . - +import groovy.xml.XmlUtil +import static javax.xml.xpath.XPathConstants.* +import javax.xml.xpath.* +import groovy.xml.DOMBuilder +import groovy.xml.dom.DOMCategory // configurable settings: // use to send email if workflow problem @@ -28,6 +32,10 @@ def _MkDocsWebURL = "dabauto--mkdocs-web.dmz.chacha.home/mkdocs-web/" def _MkDocsWebCredentials = "2c5b684e-3787-4b37-8aca-b3dd4a383fe2" def _PypiCredentials = "Pypi" + +def badge_coverage = addEmbeddableBadgeConfiguration(id: "coverage", subject: "unit-test coverage") +def badge_complexity = addEmbeddableBadgeConfiguration(id: "complexity", subject: "code complexity") + // commands Helper: /!\ Made for GITEA /!\ String determineRepoUserName() { return scm.getUserRemoteConfigs()[0].getUrl().tokenize('/')[3].split("\\.")[0] @@ -63,6 +71,27 @@ String ExtractBaseVersion(inVersion) { return matcher[0][1] } +int GetCoverageValue(String CoverageFilePath,String XPath) +{ + File file = new File(CoverageFilePath) + coverageReportRaw = file.getText('UTF-8') + coverageReport = DOMBuilder.parse(new StringReader(coverageReportRaw), false, false) + coverageReportRoot = coverageReport.documentElement + + def xpath = XPathFactory.newInstance().newXPath() + res = xpath.evaluate(XPath,coverageReportRoot,NUMBER) + return res +} + +int GetCoverageValue_lines_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-valid") } +int GetCoverageValue_lines_covered(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-covered") } +int GetCoverageValue_line_rate(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@line-rate") } +int GetCoverageValue_branches_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-valid") } +int GetCoverageValue_branches_covered(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-covered") } +int GetCoverageValue_branch_rate(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branch-rate") } +int GetCoverageValue_branches_complexity(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-complexity") } + + pipeline { // for Docker based build (preferable) @@ -400,6 +429,21 @@ pipeline { println unit_test_full_name__html unit_test_full_name__xml=findFiles(glob: "helpers-results/unit_test_full/*.xml")[0].getName() println unit_test_full_name__xml + + coverage_report_path = "helpers-results/unit_test_coverage/test_coverage.xml" + println GetCoverageValue_lines_valid(coverage_report_path) + println GetCoverageValue_lines_covered(coverage_report_path) + println GetCoverageValue_line_rate(coverage_report_path) + println GetCoverageValue_branches_valid(coverage_report_path) + println GetCoverageValue_branches_covered(coverage_report_path) + println GetCoverageValue_branch_rate(coverage_report_path) + println GetCoverageValue_branches_complexity(coverage_report_path) + + full_rate = (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 + badge_coverage.setStatus(full_rate) + + complexity = GetCoverageValue_branches_complexity(coverage_report_path) + badge_complexity.setStatus(complexity) } } } -- 2.47.3 From 3bbbe946a1a5433b835bc9bfb245ec091a999e34 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 21:54:21 +0000 Subject: [PATCH 09/30] switch to readfile --- Jenkinsfile | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index dc6a0f5..ffa0fb4 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -73,8 +73,9 @@ String ExtractBaseVersion(inVersion) { int GetCoverageValue(String CoverageFilePath,String XPath) { - File file = new File(CoverageFilePath) - coverageReportRaw = file.getText('UTF-8') + //File file = new File(CoverageFilePath) + //coverageReportRaw = file.getText('UTF-8') + coverageReportRaw = readFile(CoverageFilePath) coverageReport = DOMBuilder.parse(new StringReader(coverageReportRaw), false, false) coverageReportRoot = coverageReport.documentElement -- 2.47.3 From e9355471bad73be976feb6e6507b4d90ce536022 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 22:19:48 +0000 Subject: [PATCH 10/30] cast float to strings --- Jenkinsfile | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index ffa0fb4..ead1bdb 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -440,11 +440,13 @@ pipeline { println GetCoverageValue_branch_rate(coverage_report_path) println GetCoverageValue_branches_complexity(coverage_report_path) - full_rate = (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 - badge_coverage.setStatus(full_rate) + full_rate = (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 + sz_full_rate =Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) + badge_coverage.setStatus(sz_full_rate) complexity = GetCoverageValue_branches_complexity(coverage_report_path) - badge_complexity.setStatus(complexity) + sz_complexity =Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) + badge_complexity.setStatus(sz_complexity) } } } -- 2.47.3 From 886a22bef2c76500ce75c79b4706cd853b5ffe61 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 22:23:57 +0000 Subject: [PATCH 11/30] add missing java lib in groovy --- Jenkinsfile | 1 + 1 file changed, 1 insertion(+) diff --git a/Jenkinsfile b/Jenkinsfile index ead1bdb..cc2d381 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -11,6 +11,7 @@ import static javax.xml.xpath.XPathConstants.* import javax.xml.xpath.* import groovy.xml.DOMBuilder import groovy.xml.dom.DOMCategory +import java.math.RoundingMode // configurable settings: // use to send email if workflow problem -- 2.47.3 From bd3389aeb2daa0abf9643a0dbdd8fc9fc0d6f9b4 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 22:37:45 +0000 Subject: [PATCH 12/30] cast to double + fix complexity --- Jenkinsfile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index cc2d381..d5f2847 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -91,7 +91,7 @@ int GetCoverageValue_line_rate(String CoverageFilePath) { return GetCoverageValu int GetCoverageValue_branches_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-valid") } int GetCoverageValue_branches_covered(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-covered") } int GetCoverageValue_branch_rate(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branch-rate") } -int GetCoverageValue_branches_complexity(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@branches-complexity") } +int GetCoverageValue_complexity(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@complexity") } pipeline { @@ -441,11 +441,11 @@ pipeline { println GetCoverageValue_branch_rate(coverage_report_path) println GetCoverageValue_branches_complexity(coverage_report_path) - full_rate = (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 + full_rate = 1.0 * (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 sz_full_rate =Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) badge_coverage.setStatus(sz_full_rate) - complexity = GetCoverageValue_branches_complexity(coverage_report_path) + complexity = 1.0 * GetCoverageValue_complexity(coverage_report_path) sz_complexity =Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) badge_complexity.setStatus(sz_complexity) } -- 2.47.3 From 879a7ca03d2de6b0b63996db0de112681076950f Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 22:42:07 +0000 Subject: [PATCH 13/30] fix wrong method name :-/ --- Jenkinsfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index d5f2847..e5f856c 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -439,7 +439,7 @@ pipeline { println GetCoverageValue_branches_valid(coverage_report_path) println GetCoverageValue_branches_covered(coverage_report_path) println GetCoverageValue_branch_rate(coverage_report_path) - println GetCoverageValue_branches_complexity(coverage_report_path) + println GetCoverageValue_complexity(coverage_report_path) full_rate = 1.0 * (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 sz_full_rate =Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) -- 2.47.3 From 7b9752a17add01f0b19e1426a771f9a446826124 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 22:47:52 +0000 Subject: [PATCH 14/30] cast to decimalformat --- Jenkinsfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index e5f856c..af348c5 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -441,11 +441,11 @@ pipeline { println GetCoverageValue_branch_rate(coverage_report_path) println GetCoverageValue_complexity(coverage_report_path) - full_rate = 1.0 * (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 + full_rate = DecimalFormat( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) sz_full_rate =Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) badge_coverage.setStatus(sz_full_rate) - complexity = 1.0 * GetCoverageValue_complexity(coverage_report_path) + complexity = DecimalFormat( GetCoverageValue_complexity(coverage_report_path)) sz_complexity =Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) badge_complexity.setStatus(sz_complexity) } -- 2.47.3 From 4ab70409a0e55679391e7c907714583c09228cd4 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 22:49:08 +0000 Subject: [PATCH 15/30] switch to BigDecimal grrrrr --- Jenkinsfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index af348c5..f5bc9b3 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -441,11 +441,11 @@ pipeline { println GetCoverageValue_branch_rate(coverage_report_path) println GetCoverageValue_complexity(coverage_report_path) - full_rate = DecimalFormat( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) + full_rate = BigDecimal( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) sz_full_rate =Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) badge_coverage.setStatus(sz_full_rate) - complexity = DecimalFormat( GetCoverageValue_complexity(coverage_report_path)) + complexity = BigDecimal( GetCoverageValue_complexity(coverage_report_path)) sz_complexity =Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) badge_complexity.setStatus(sz_complexity) } -- 2.47.3 From 01ce80982377f84a3f4dcae85eab6443c92a81ae Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 22:57:14 +0000 Subject: [PATCH 16/30] add missing import --- Jenkinsfile | 1 + 1 file changed, 1 insertion(+) diff --git a/Jenkinsfile b/Jenkinsfile index f5bc9b3..e103dba 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -12,6 +12,7 @@ import javax.xml.xpath.* import groovy.xml.DOMBuilder import groovy.xml.dom.DOMCategory import java.math.RoundingMode +import java.math.BigDecimal // configurable settings: // use to send email if workflow problem -- 2.47.3 From eee2bf551c5585f8bc4a07a64f6f26ce747d31ed Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 23:02:57 +0000 Subject: [PATCH 17/30] bvlabnaal --- Jenkinsfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index e103dba..672e670 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -442,11 +442,11 @@ pipeline { println GetCoverageValue_branch_rate(coverage_report_path) println GetCoverageValue_complexity(coverage_report_path) - full_rate = BigDecimal( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) + full_rate = new BigDecimal( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) sz_full_rate =Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) badge_coverage.setStatus(sz_full_rate) - complexity = BigDecimal( GetCoverageValue_complexity(coverage_report_path)) + complexity = new BigDecimal( GetCoverageValue_complexity(coverage_report_path)) sz_complexity =Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) badge_complexity.setStatus(sz_complexity) } -- 2.47.3 From 99f38741fd003c2bf4ad2333399b894dd2d6ec30 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 23:13:55 +0000 Subject: [PATCH 18/30] add code quality badge --- Jenkinsfile | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 672e670..c49fc68 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -35,8 +35,9 @@ def _MkDocsWebCredentials = "2c5b684e-3787-4b37-8aca-b3dd4a383fe2" def _PypiCredentials = "Pypi" -def badge_coverage = addEmbeddableBadgeConfiguration(id: "coverage", subject: "unit-test coverage") -def badge_complexity = addEmbeddableBadgeConfiguration(id: "complexity", subject: "code complexity") +def badge_coverage = addEmbeddableBadgeConfiguration(id: "coverage", subject: "coverage") +def badge_complexity = addEmbeddableBadgeConfiguration(id: "complexity", subject: "code complexity") +def badge_quality = addEmbeddableBadgeConfiguration(id: "quality", subject: "quality score") // commands Helper: /!\ Made for GITEA /!\ String determineRepoUserName() { @@ -366,6 +367,10 @@ pipeline { steps { dir("gitrepo") { sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check") + script { + def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json" + badge_quality.setStatus(jsonObj["GlobalScore"]) + } } } post { -- 2.47.3 From 9e5f0de5c4e8e8ba5c633fd42af16d74cdd684b3 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 23:23:24 +0000 Subject: [PATCH 19/30] add badges in readme fix float value for quality --- Jenkinsfile | 4 ++-- README.md | 7 ++++++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index c49fc68..03e8d7f 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -369,7 +369,7 @@ pipeline { sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check") script { def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json" - badge_quality.setStatus(jsonObj["GlobalScore"]) + badge_quality.setStatus(Float.toString(jsonObj["GlobalScore"])) } } } @@ -448,7 +448,7 @@ pipeline { println GetCoverageValue_complexity(coverage_report_path) full_rate = new BigDecimal( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) - sz_full_rate =Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) + sz_full_rate = Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) badge_coverage.setStatus(sz_full_rate) complexity = new BigDecimal( GetCoverageValue_complexity(coverage_report_path)) diff --git a/README.md b/README.md index 2b71a5b..61e2079 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ +![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=status&status=active&color=seagreen) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=doc&status=MkDocs&color=blue) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job={{repository}}-{{branch}}) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=blue) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage&color=darkviolet) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=complexity&color=darkviolet) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality&color=darkviolet) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=teal) ![](docs-static/Library.jpg) -- 2.47.3 From ef7469f35bb38f3e6c24da68aa0553a9a6655073 Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 23:28:01 +0000 Subject: [PATCH 20/30] aaaaaaa --- Jenkinsfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 03e8d7f..de6b955 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -369,7 +369,7 @@ pipeline { sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check") script { def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json" - badge_quality.setStatus(Float.toString(jsonObj["GlobalScore"])) + badge_quality.setStatus(Double.toString(jsonObj["GlobalScore"])) } } } @@ -452,7 +452,7 @@ pipeline { badge_coverage.setStatus(sz_full_rate) complexity = new BigDecimal( GetCoverageValue_complexity(coverage_report_path)) - sz_complexity =Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) + sz_complexity = Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) badge_complexity.setStatus(sz_complexity) } } -- 2.47.3 From e74a53e3bf81374a2238a4e42ce087ed4382094a Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 23:47:46 +0000 Subject: [PATCH 21/30] fix tostring() method from BigDecimal --- Jenkinsfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index de6b955..848fa8d 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -448,11 +448,11 @@ pipeline { println GetCoverageValue_complexity(coverage_report_path) full_rate = new BigDecimal( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) - sz_full_rate = Float.toString(full_rate.setScale(2, RoundingMode.HALF_EVEN)) + sz_full_rate = full_rate.setScale(2, RoundingMode.HALF_EVEN).toString() badge_coverage.setStatus(sz_full_rate) complexity = new BigDecimal( GetCoverageValue_complexity(coverage_report_path)) - sz_complexity = Float.toString(complexity.setScale(2, RoundingMode.HALF_EVEN)) + sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString() badge_complexity.setStatus(sz_complexity) } } -- 2.47.3 From 4e50b8d03f3280fae9b8c4a24dbcb71e09af432b Mon Sep 17 00:00:00 2001 From: cclecle Date: Thu, 23 Mar 2023 23:56:11 +0000 Subject: [PATCH 22/30] add badge colour score all /10 --- Jenkinsfile | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 848fa8d..ee5a04c 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -87,6 +87,24 @@ int GetCoverageValue(String CoverageFilePath,String XPath) return res } +String getColorScale(BigDecimal value) +{ + if( value >9) { return "gold"} + else if( value >6) { return "seagreen"} + else if( value >4) { return "orange"} + else if( value >2) { return "darkred"} + else { return "dimgrey"} +} + +String getColorScale_reversed(BigDecimal value) +{ + if( value >9) { return "dimgrey"} + else if( value >6) { return "darkred"} + else if( value >4) { return "orange"} + else if( value >2) { return "seagreen"} + else { return "gold"} +} + int GetCoverageValue_lines_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-valid") } int GetCoverageValue_lines_covered(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-covered") } int GetCoverageValue_line_rate(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@line-rate") } @@ -369,7 +387,9 @@ pipeline { sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check") script { def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json" - badge_quality.setStatus(Double.toString(jsonObj["GlobalScore"])) + quality_score = jsonObj["GlobalScore"] + badge_quality.setStatus(Double.toString(quality_score)) + badge_quality.setColor(getColorScale(quality_score)) } } } @@ -447,13 +467,15 @@ pipeline { println GetCoverageValue_branch_rate(coverage_report_path) println GetCoverageValue_complexity(coverage_report_path) - full_rate = new BigDecimal( (GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) + full_rate = new BigDecimal( 10*(GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) sz_full_rate = full_rate.setScale(2, RoundingMode.HALF_EVEN).toString() badge_coverage.setStatus(sz_full_rate) + badge_quality.setColor(getColorScale(full_rate)) - complexity = new BigDecimal( GetCoverageValue_complexity(coverage_report_path)) + complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path)) sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString() badge_complexity.setStatus(sz_complexity) + badge_quality.setColor(getColorScale_reversed(complexity)) } } } -- 2.47.3 From bec5f9234d06f11035d6603e082dc8b4e14ae6a3 Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 00:11:08 +0000 Subject: [PATCH 23/30] fix --- Jenkinsfile | 4 ++-- helpers/quality_check.py | 1 + pyproject.toml | 1 - 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index ee5a04c..afe6817 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -387,8 +387,8 @@ pipeline { sh(". ~/TEST_ENV/bin/activate && python -m helpers --type-check --quality-check") script { def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json" - quality_score = jsonObj["GlobalScore"] - badge_quality.setStatus(Double.toString(quality_score)) + quality_score = new BigDecimal(jsonObj["GlobalScore"]) + badge_quality.setStatus(quality_score.toString()) badge_quality.setColor(getColorScale(quality_score)) } } diff --git a/helpers/quality_check.py b/helpers/quality_check.py index 159d05c..d57c523 100644 --- a/helpers/quality_check.py +++ b/helpers/quality_check.py @@ -60,6 +60,7 @@ class quality_check(helper_withresults_base): with redirect_stdout(StdOutput): pylint_Run( [ + "--load-plugins=pylint.extensions.mccabe", "--output-format=json,parseable", "--disable=invalid-name", "--ignore=_version.py", diff --git a/pyproject.toml b/pyproject.toml index d12dfe8..4409ac0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,6 @@ build-backend = "setuptools.build_meta" [tool.setuptools_scm] version_scheme= "post-release" -# tag_regex="^(?:v)?(?P\\d+\\.\\d+\\.\\d+)([\\.\\-\\+])?(?:.*)?" [project] name = "pygitversionhelper" -- 2.47.3 From c49468e2946191b4d21fa760794bdacf9737dc73 Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 00:19:30 +0000 Subject: [PATCH 24/30] fix decimal + colours --- Jenkinsfile | 3 ++- README.md | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index afe6817..fd00a14 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -388,7 +388,8 @@ pipeline { script { def jsonObj = readJSON file: "helpers-results/quality_check/metrics.json" quality_score = new BigDecimal(jsonObj["GlobalScore"]) - badge_quality.setStatus(quality_score.toString()) + sz_quality_score = quality_score.setScale(2, RoundingMode.HALF_EVEN).toString() + badge_quality.setStatus(sz_quality_score) badge_quality.setColor(getColorScale(quality_score)) } } diff --git a/README.md b/README.md index 61e2079..194964d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=status&status=active&color=seagreen) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=doc&status=MkDocs&color=blue) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job={{repository}}-{{branch}}) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage&color=darkviolet) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=complexity&color=darkviolet) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality&color=darkviolet) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=complexity) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=teal) ![](docs-static/Library.jpg) -- 2.47.3 From 5621ba99f6311e416850920552cc324812027da1 Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 01:09:10 +0000 Subject: [PATCH 25/30] start implementation of complexity measurement --- Jenkinsfile | 5 +++-- helpers/__main__.py | 8 +++++++ helpers/complexity_check.py | 42 +++++++++++++++++++++++++++++++++++++ helpers/doc_gen.py | 2 -- pyproject.toml | 1 + 5 files changed, 54 insertions(+), 4 deletions(-) create mode 100644 helpers/complexity_check.py diff --git a/Jenkinsfile b/Jenkinsfile index fd00a14..6cdc22d 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -375,7 +375,7 @@ pipeline { def wheelPath = findFiles(glob: "**/dist/*.whl")[0] echo "wheel artifact path: $wheelPath" // install the package, with *test* optionnal packages, as user - sh(". ~/TEST_ENV/bin/activate && pip install --find-links dist/ ${PY_PROJECT_NAME} .[test,coverage-check,quality-check,type-check,doc-gen]") + sh(". ~/TEST_ENV/bin/activate && pip install --find-links dist/ ${PY_PROJECT_NAME} .[test,coverage-check,quality-check,type-check,doc-gen,complexity-check]") } } } @@ -392,6 +392,7 @@ pipeline { badge_quality.setStatus(sz_quality_score) badge_quality.setColor(getColorScale(quality_score)) } + sh(". ~/TEST_ENV/bin/activate && python -m helpers --complexity-check") } } post { @@ -471,7 +472,7 @@ pipeline { full_rate = new BigDecimal( 10*(GetCoverageValue_line_rate(coverage_report_path) + GetCoverageValue_branch_rate(coverage_report_path)) / 2 ) sz_full_rate = full_rate.setScale(2, RoundingMode.HALF_EVEN).toString() badge_coverage.setStatus(sz_full_rate) - badge_quality.setColor(getColorScale(full_rate)) + badge_coverage.setColor(getColorScale(full_rate)) complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path)) sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString() diff --git a/helpers/__main__.py b/helpers/__main__.py index c8d9a54..d307ddb 100644 --- a/helpers/__main__.py +++ b/helpers/__main__.py @@ -23,6 +23,7 @@ if __package__ == "helpers": from .unit_test import unit_test from .doc_gen import doc_gen from .changelog_gen import changelog_gen + from .complexity_check import complexity_check else: # when calling the __main__.py file (from IDE) from helpers.types_check import types_check @@ -30,6 +31,7 @@ else: from helpers.unit_test import unit_test from helpers.doc_gen import doc_gen from helpers.changelog_gen import changelog_gen + from helpers.complexity_check import complexity_check logging.getLogger().setLevel(logging.INFO) @@ -59,6 +61,8 @@ if __name__ == "__main__": parser.add_argument("-clg", "--changelog-gen", dest="changeloggen", action="store_true", help="enable changelog generation") + parser.add_argument("-cpc", "--complexity-check", dest="complexitycheck", action="store_true", help="enable complexity check") + args = parser.parse_args() ################################## @@ -73,6 +77,7 @@ if __name__ == "__main__": # args.docgen = True # args.docgenpdf = True # args.changeloggen = True + args.complexitycheck = True helpers = [] if args.typecheck == True: @@ -102,6 +107,9 @@ if __name__ == "__main__": if args.changeloggen == True: helpers.append(changelog_gen) + if args.complexitycheck == True: + helpers.append(complexity_check) + for helper in helpers: helper.set_context(project_rootdir_path, pyproject) helper.reset_result_dir() diff --git a/helpers/complexity_check.py b/helpers/complexity_check.py new file mode 100644 index 0000000..939854a --- /dev/null +++ b/helpers/complexity_check.py @@ -0,0 +1,42 @@ +# pyChaChaDummyProject (c) by chacha +# +# pyChaChaDummyProject is licensed under a +# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Unported License. +# +# You should have received a copy of the license along with this +# work. If not, see . + +from __future__ import annotations +from typing import TYPE_CHECKING + +# from pathlib import Path +# import os +from radon.complexity import cc_rank, SCORE +from radon.cli import Config +from radon.cli.harvest import CCHarvester, HCHarvester, MIHarvester + +from .helper_base import helper_withresults_base +from pprint import pprint + + +class complexity_check(helper_withresults_base): + @classmethod + def do_job(cls): + config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False) + + h = MIHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config) + pprint(h.as_json()) + + print() + + config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False) + + h = CCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config) + pprint(h.as_json()) + + print() + + config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", by_function=None) + + h = HCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config) + pprint(h.as_json()) diff --git a/helpers/doc_gen.py b/helpers/doc_gen.py index 1201271..155db4d 100644 --- a/helpers/doc_gen.py +++ b/helpers/doc_gen.py @@ -31,8 +31,6 @@ class doc_gen(helper_withresults_base): @classmethod def do_job(cls): - print(cls.project_rootdir_path) - print() # create doc root dir doc_path = cls.project_rootdir_path / "docs" diff --git a/pyproject.toml b/pyproject.toml index 4409ac0..900012f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -56,6 +56,7 @@ Tracker = "https://chacha.ddns.net/gitea/chacha/pygitversionhelper/issue [project.optional-dependencies] test = ["junitparser>=2.8","junit2html>=30.1","xmlrunner>=1.7","mypy>=0.99" ] coverage-check = ["coverage>=7.0"] +complexity-check = ["radon>=5.1"] quality-check = ["pylint>=2.15","pylint-json2html>=0.4","pandas>=1.5"] type-check = ["mypy[reports]>=0.99" ] doc-gen = ["mkdocs>=1.4.0", "mkdocs-material>=8.5", "mkdocs-localsearch>=0.9.0", "mkdocstrings[python]>=0.19", "mkdocs-with-pdf>=0.9.3","pyyaml>=6.0","pymdown-extensions>=9","mkdocs-markdownextradata-plugin","mkdocs-mermaid2-plugin"] -- 2.47.3 From cad73c471192621f071b09186d4f8aad9369c102 Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 19:26:11 +0000 Subject: [PATCH 26/30] add complexity check --- Jenkinsfile | 8 ++++++ helpers/__main__.py | 2 +- helpers/complexity_check.py | 52 ++++++++++++++++++++++++++++--------- 3 files changed, 49 insertions(+), 13 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 6cdc22d..29bd969 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -447,6 +447,14 @@ pipeline { style: 'stackedArea', keepRecords: true, numBuilds: '']) + + plot([ csvFileName: 'plot-4ceb9ee2-ca78-11ed-afa1-0242ac120002.csv', + csvSeries: [[ file: 'gitrepo/helpers-results/complexity_check/MI.csv', inclusionFlag: 'INCLUDE_BY_STRING',exclusionValues: 'MeanMaintainability', url: '']], + group: 'metrics', + title: 'maintainability', + style: 'stackedArea', + keepRecords: true, + numBuilds: '']) } } diff --git a/helpers/__main__.py b/helpers/__main__.py index d307ddb..b4dd963 100644 --- a/helpers/__main__.py +++ b/helpers/__main__.py @@ -77,7 +77,7 @@ if __name__ == "__main__": # args.docgen = True # args.docgenpdf = True # args.changeloggen = True - args.complexitycheck = True + # args.complexitycheck = True helpers = [] if args.typecheck == True: diff --git a/helpers/complexity_check.py b/helpers/complexity_check.py index 939854a..529e872 100644 --- a/helpers/complexity_check.py +++ b/helpers/complexity_check.py @@ -11,6 +11,9 @@ from typing import TYPE_CHECKING # from pathlib import Path # import os +import statistics +import csv +from json import loads as JSON_LOADS from radon.complexity import cc_rank, SCORE from radon.cli import Config from radon.cli.harvest import CCHarvester, HCHarvester, MIHarvester @@ -22,21 +25,46 @@ from pprint import pprint class complexity_check(helper_withresults_base): @classmethod def do_job(cls): - config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False) + config = Config( + exclude="__init__\.py", + ignore=None, + order=SCORE, + show_closures=False, + no_assert=True, + min="A", + max="F", + multi=False, + ) - h = MIHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config) - pprint(h.as_json()) + h = MIHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json() + res = JSON_LOADS(h) - print() + with open(cls.get_result_dir() / "MI.json", "w", newline="") as oFile: + oFile.write(h) + + mean = statistics.mean(_["mi"] for _ in res.values()) + + if mean >= 65: + rank = "A+" + elif mean >= 20: + rank = "A" + elif mean >= 10: + rank = "B" + else: + rank = "C" + + RES_MI = {"MeanMaintainability": mean, "MaintainabilityIndex": rank} + with open(cls.get_result_dir() / "MI.csv", "w", newline="") as oFile: + writer = csv.DictWriter(oFile, fieldnames=RES_MI.keys()) + writer.writeheader() + writer.writerow(RES_MI) config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", multi=False) - - h = CCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config) - pprint(h.as_json()) - - print() + h = CCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json() + with open(cls.get_result_dir() / "CC.json", "w", newline="") as oFile: + oFile.write(h) config = Config(exclude=None, ignore=None, order=SCORE, show_closures=False, no_assert=True, min="A", max="F", by_function=None) - - h = HCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config) - pprint(h.as_json()) + h = HCHarvester([str(_) for _ in sorted((cls.project_rootdir_path / "src").rglob("*.py"))], config).as_json() + with open(cls.get_result_dir() / "HC.json", "w", newline="") as oFile: + oFile.write(h) -- 2.47.3 From fa7eaf07695a61d379dcaf9ed87c666ab12b93c1 Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 19:47:54 +0000 Subject: [PATCH 27/30] update badge_maintainability --- Jenkinsfile | 19 ++++++++++++------- README.md | 2 +- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 29bd969..11d8e60 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -35,9 +35,9 @@ def _MkDocsWebCredentials = "2c5b684e-3787-4b37-8aca-b3dd4a383fe2" def _PypiCredentials = "Pypi" -def badge_coverage = addEmbeddableBadgeConfiguration(id: "coverage", subject: "coverage") -def badge_complexity = addEmbeddableBadgeConfiguration(id: "complexity", subject: "code complexity") -def badge_quality = addEmbeddableBadgeConfiguration(id: "quality", subject: "quality score") +def badge_coverage = addEmbeddableBadgeConfiguration(id: "coverage", subject: "coverage") +def badge_maintainability = addEmbeddableBadgeConfiguration(id: "maintainability", subject: "maintainability") +def badge_quality = addEmbeddableBadgeConfiguration(id: "quality", subject: "quality score") // commands Helper: /!\ Made for GITEA /!\ String determineRepoUserName() { @@ -482,10 +482,15 @@ pipeline { badge_coverage.setStatus(sz_full_rate) badge_coverage.setColor(getColorScale(full_rate)) - complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path)) - sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString() - badge_complexity.setStatus(sz_complexity) - badge_quality.setColor(getColorScale_reversed(complexity)) + //complexity = new BigDecimal( 10*GetCoverageValue_complexity(coverage_report_path)) + //sz_complexity = complexity.setScale(2, RoundingMode.HALF_EVEN).toString() + //badge_complexity.setStatus(sz_complexity) + //badge_quality.setColor(getColorScale_reversed(complexity)) + + //badge_maintainability + records = readCSV file: 'gitrepo/helpers-results/complexity_check/MI.csv' + badge_maintainability.setStatus(records[1][1]) + } } } diff --git a/README.md b/README.md index 194964d..a89928c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=doc&status=MkDocs&color=blue) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job={{repository}}-{{branch}}) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage) -![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=complexity) +![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=maintainability) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality) ![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=teal) -- 2.47.3 From 93d2046c98951b5891a3c6115c82b28942db0172 Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 19:51:24 +0000 Subject: [PATCH 28/30] set badge colour --- Jenkinsfile | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index 11d8e60..80b18b3 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -489,8 +489,14 @@ pipeline { //badge_maintainability records = readCSV file: 'gitrepo/helpers-results/complexity_check/MI.csv' - badge_maintainability.setStatus(records[1][1]) + maintainability = records[1][1] + badge_maintainability.setStatus(maintainability) + if ( maintainability == 'D') { badge_maintainability.setColor( "dimgrey")} + else if( maintainability == 'C') { badge_maintainability.setColor( "darkred")} + else if( maintainability == 'B') { badge_maintainability.setColor( "orange")} + else if( maintainability == 'A') { badge_maintainability.setColor( "seagreen")} + else if( maintainability == 'A+') { badge_maintainability.setColor( "gold")} } } } -- 2.47.3 From da9fa475e8c456129a1de318baeec26fc04713bb Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 19:53:01 +0000 Subject: [PATCH 29/30] fix csv path --- Jenkinsfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Jenkinsfile b/Jenkinsfile index 80b18b3..05158c2 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -488,7 +488,7 @@ pipeline { //badge_quality.setColor(getColorScale_reversed(complexity)) //badge_maintainability - records = readCSV file: 'gitrepo/helpers-results/complexity_check/MI.csv' + records = readCSV file: 'helpers-results/complexity_check/MI.csv' maintainability = records[1][1] badge_maintainability.setStatus(maintainability) -- 2.47.3 From 3d2b8d3762be44d37569e905def72354f9f020a4 Mon Sep 17 00:00:00 2001 From: cclecle Date: Fri, 24 Mar 2023 20:02:17 +0000 Subject: [PATCH 30/30] adjust colours --- Jenkinsfile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index 05158c2..5a0144c 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -89,7 +89,7 @@ int GetCoverageValue(String CoverageFilePath,String XPath) String getColorScale(BigDecimal value) { - if( value >9) { return "gold"} + if( value >9) { return "Goldenrod"} else if( value >6) { return "seagreen"} else if( value >4) { return "orange"} else if( value >2) { return "darkred"} @@ -102,7 +102,7 @@ String getColorScale_reversed(BigDecimal value) else if( value >6) { return "darkred"} else if( value >4) { return "orange"} else if( value >2) { return "seagreen"} - else { return "gold"} + else { return "Goldenrod"} } int GetCoverageValue_lines_valid(String CoverageFilePath) { return GetCoverageValue(CoverageFilePath,"/coverage/@lines-valid") } @@ -492,11 +492,11 @@ pipeline { maintainability = records[1][1] badge_maintainability.setStatus(maintainability) - if ( maintainability == 'D') { badge_maintainability.setColor( "dimgrey")} + if ( maintainability == 'D') { badge_maintainability.setColor( "dimgrey")} else if( maintainability == 'C') { badge_maintainability.setColor( "darkred")} else if( maintainability == 'B') { badge_maintainability.setColor( "orange")} else if( maintainability == 'A') { badge_maintainability.setColor( "seagreen")} - else if( maintainability == 'A+') { badge_maintainability.setColor( "gold")} + else if( maintainability == 'A+') { badge_maintainability.setColor( "Goldenrod")} } } } -- 2.47.3