Fixed some of the log messages and CLI argument loading.

Author: willynilly

src/same_version/checkers/checker.py

@@ -13,14 +13,15 @@ class Checker():
     def __init__(self, extractor: Extractor, cli_args: Namespace):
         self.extractor = extractor        
         self.cli_args = cli_args
+        self._extracted_version: str | None = self.extractor.extract_version()
 
     def create_pep440_version(self, version_str: str | None) -> packaging.version.Version | None:
         version_pep440 : packaging.version.Version | None = parse_version_pep440(version_str)
         return version_pep440
 
     @property
     def target_version_str(self) -> str | None:
-        return self.extractor.extract_version()
+        return self._extracted_version
 
     @property
     def target_version_pep440(self) -> packaging.version.Version | None:
@@ -54,13 +55,13 @@ def check(self, base_version_str: str | None) -> bool:
             return False
 
     def _log_version_mismatch(self, base_version_str: str | None):
-        logger.error(f"❌ Version mismatch: {self.target_name} {self.target_version_str} != base_version {base_version_str}")
+        logger.error(f"❌ Version mismatch: {self.target_name} {self.target_version_str} != base version {base_version_str}")
 
     def _log_missing_target(self, msg: str | None = None):
         if msg is None:
             msg = f"Data source for parameter {self.target_cli_parameter_name} does not exist: {self.target_name}"
 
-        if self.cli_args.fail_for_missing_file.lower() == 'true':
+        if str(getattr(self.cli_args, 'fail_for_missing_file', '') or '').lower() == 'true':
             msg = "❌ " + msg
             logger.error(msg)
         else:

src/same_version/checkers/package_json_checker.py

@@ -27,7 +27,7 @@ def check(self, base_version_str: str | None) -> bool:
                 target_version_semver = parse_version_semver(target_version_str)
 
                 if base_version_semver != target_version_semver:
-                    logger.error(f"❌ Version mismatch: {target_name} {target_version_str} != base_version {base_version_str}")
+                    logger.error(f"❌ Version mismatch: {target_name} {target_version_str} != base version {base_version_str}")
                     return False
                 else:
                     return True

src/same_version/extractors/cli_extractor.py

@@ -12,13 +12,13 @@ def __init__(self, cli_args: Namespace):
 
     def extract_version(self) -> str | None:
         if self.target_exists:
-            return self._cli_args.base_version
+            return getattr(self._cli_args, 'base_version', None)
         else:
             return None
 
     @property
     def target_exists(self) -> bool:
-        return hasattr(self._cli_args, 'base_version') and self._cli_args.base_version is not None
+        return hasattr(self._cli_args, 'base_version') and getattr(self._cli_args, 'base_version', None) is not None
 
     @property
     def target_name(self) -> str | None:

src/same_version/extractors/extractor.py

@@ -23,7 +23,9 @@ def extract_version(self) -> str | None:
         data: dict = self._get_data()
         version = self._get_version_from_data(data=data)
         if not version:
-            self._log_missing_version_error(data=data)
+            if self.target_exists:
+                # only print this error if the target exists
+                self._log_missing_version_error(data=data)
             return None
         self._log_found_version_info(version=version, data=data)
         return version

src/same_version/extractors/github_event_extractor.py

@@ -11,9 +11,9 @@ class GitHubEventExtractor(Extractor):
     def __init__(self, cli_args: Namespace):
         super().__init__()
         self._data: dict[str, str | None] = {
-            'github_event_name': cli_args.github_event_name, 
-            'github_event_ref': cli_args.github_event_ref, 
-            'github_event_release_tag': cli_args.github_event_release_tag
+            'github_event_name': getattr(cli_args, 'github_event_name', None), 
+            'github_event_ref': getattr(cli_args, 'github_event_ref', None), 
+            'github_event_release_tag': getattr(cli_args, 'github_event_release_tag', None)
         }
 
     @property
@@ -22,7 +22,7 @@ def target_exists(self) -> bool:
 
     @property
     def target_name(self) -> str | None:
-        return self._data['github_event_name']
+        return self._data.get('github_event_name', None)
 
     @property
     def target_cli_parameter_name(self) -> str | None:

src/same_version/extractors/json_extractor.py

@@ -7,7 +7,7 @@ class JsonExtractor(FileExtractor):
 
     def _get_data(self) -> dict:
         data = {}
-        if self.target_file_path:
+        if self.target_file_path and self.target_exists:
             with open(self.target_file_path, 'r', encoding='utf-8') as f:
                 data = json.load(f)
         return data

src/same_version/extractors/setup_py_extractor.py

@@ -1,6 +1,5 @@
 import logging
 import subprocess
-import sys
 from argparse import Namespace
 
 from same_version.extractors.file_extractor import FileExtractor
@@ -20,13 +19,16 @@ def __init__(self, cli_args: Namespace):
 
     def _get_data(self) -> dict:
         data = {}
-        
-        try:
-            output = subprocess.check_output(['python', str(self.target_file_path), '--version'], stderr=subprocess.STDOUT)
-            data['version'] = output.decode('utf-8').strip()
-        except subprocess.CalledProcessError as e:
-            logger.error(f"❌ Error running {self.target_name} --version:\n{e.output.decode('utf-8')}")
-            sys.exit(1)
+
+        if not self.target_exists:
+            data['version'] = None
+        else:
+            try:
+                output = subprocess.check_output(['python', str(self.target_file_path), '--version'], stderr=subprocess.STDOUT)
+                data['version'] = output.decode('utf-8').strip()
+            except subprocess.CalledProcessError as e:
+                logger.error(f"❌ Error running {self.target_name} --version:\n{e.output.decode('utf-8')}")
+                data['version'] = None
 
         return data
 

src/same_version/main.py

@@ -29,20 +29,20 @@
 def parse_args() -> argparse.Namespace:
     parser = argparse.ArgumentParser(description="Check metadata files for consistent software versions using canonical PEP 440 and SemVer")
     parser.add_argument('--base-version', required=False, help='A base version from which to check')
-    parser.add_argument('--fail-for-missing-file', required=False, help='Fail for any checked file that is missing')
-    parser.add_argument('--check-citation-cff', required=False, help='Check CITATION.cff? (true/false)')
-    parser.add_argument('--citation-cff-path', required=False, help='Path to CITATION.cff file')
-    parser.add_argument('--check-pyproject-toml', required=False, help='Check pyproject.toml? (true/false)')
-    parser.add_argument('--pyproject-toml-path', required=False, help='Path to pyproject.toml file')
-    parser.add_argument('--check-codemeta-json', required=False, help='Check codemeta.json? (true/false)')
-    parser.add_argument('--codemeta-json-path', required=False, help='Path to codemeta.json')
-    parser.add_argument('--check-zenodo-json', required=False, help='Check .zenodo.json? (true/false)')
-    parser.add_argument('--zenodo-json-path', required=False, help='Path to .zenodo.json')
-    parser.add_argument('--check-package-json', required=False, help='Check package.json? (true/false)')
-    parser.add_argument('--package-json-path', required=False, help='Path to package.json')
-    parser.add_argument('--check-setup-py', required=False, help='Check setup.py? (true/false)')
-    parser.add_argument('--setup-py-path', required=False, help='Path to setup.py')
-    parser.add_argument('--check-github-event', required=False, help='Check GitHub events? (true/false)')
+    parser.add_argument('--fail-for-missing-file', default=False, required=False, help='Fail for any checked file that is missing')
+    parser.add_argument('--check-citation-cff', default=True, required=False, help='Check CITATION.cff? (true/false)')
+    parser.add_argument('--citation-cff-path', default='CITATION.cff', required=False, help='Path to CITATION.cff file')
+    parser.add_argument('--check-pyproject-toml', default=True, required=False, help='Check pyproject.toml? (true/false)')
+    parser.add_argument('--pyproject-toml-path', default='pyproject.toml', required=False, help='Path to pyproject.toml file')
+    parser.add_argument('--check-codemeta-json', default=True, required=False, help='Check codemeta.json? (true/false)')
+    parser.add_argument('--codemeta-json-path', default='codemeta.json', required=False, help='Path to codemeta.json')
+    parser.add_argument('--check-zenodo-json', default=True, required=False, help='Check .zenodo.json? (true/false)')
+    parser.add_argument('--zenodo-json-path', default='.zenodo.json', required=False, help='Path to .zenodo.json')
+    parser.add_argument('--check-package-json', default=True, required=False, help='Check package.json? (true/false)')
+    parser.add_argument('--package-json-path', default='package.json', required=False, help='Path to package.json')
+    parser.add_argument('--check-setup-py', default=True, required=False, help='Check setup.py? (true/false)')
+    parser.add_argument('--setup-py-path', default='setup.py', required=False, help='Path to setup.py')
+    parser.add_argument('--check-github-event', default=False, required=False, help='Check GitHub events? (true/false)')
     parser.add_argument('--github-event-name', required=False, help='GitHub event name (push/release)')
     parser.add_argument('--github-event-ref', required=False, help='GitHub ref (for push event)')
     parser.add_argument('--github-event-release-tag', required=False, help='GitHub release tag name (for release event)')
@@ -51,67 +51,83 @@ def parse_args() -> argparse.Namespace:
 
 # --- Main ---
 
+
 def main():
     cli_args: argparse.Namespace = parse_args()
 
     base_version_str: str | None = CliExtractor(cli_args=cli_args).extract_version()
 
     checkers: list[Checker] = []
 
+    logger.info('📦 Extracting software version metadata...')
+
     # GitHub Event
-    if cli_args.check_github_event.lower() == 'true':
+    if str(getattr(cli_args, 'check_github_event', '') or '').lower() == 'true':
         github_event_extractor: GitHubEventExtractor = GitHubEventExtractor(cli_args=cli_args)
         github_event_checker: GitHubEventChecker = GitHubEventChecker(extractor=github_event_extractor, cli_args=cli_args)
         checkers.append(github_event_checker)
 
+
     # CITATION.cff
-    if cli_args.check_citation_cff.lower() == 'true':
+    if str(getattr(cli_args, 'check_citation_cff', '') or '').lower() == 'true':
         citation_cff_extractor: CitationCffExtractor = CitationCffExtractor(cli_args=cli_args)
         citation_cff_checker: CitationCffChecker = CitationCffChecker(extractor=citation_cff_extractor, cli_args=cli_args)
         checkers.append(citation_cff_checker)
 
+
+
     # pyproject.toml
-    if cli_args.check_pyproject_toml.lower() == 'true':
+    if str(getattr(cli_args, 'check_pyproject_toml', '') or '').lower() == 'true':
         pyproject_toml_extractor: PyprojectTomlExtractor = PyprojectTomlExtractor(cli_args=cli_args)
         pyproject_toml_checker: PyprojectTomlChecker = PyprojectTomlChecker(extractor=pyproject_toml_extractor, cli_args=cli_args)
         checkers.append(pyproject_toml_checker)
 
+
     # setup.py
-    if cli_args.check_setup_py.lower() == 'true':
+    if str(getattr(cli_args, 'check_setup_py', '') or '').lower() == 'true':
         setup_py_extractor: SetupPyExtractor = SetupPyExtractor(cli_args=cli_args)
         setup_py_checker: SetupPyChecker = SetupPyChecker(extractor=setup_py_extractor, cli_args=cli_args)
         checkers.append(setup_py_checker)
 
+
+
     # package.json
-    if cli_args.check_package_json.lower() == 'true':
+    if str(getattr(cli_args, 'check_package_json', '') or '').lower() == 'true':
         package_json_extractor: PackageJsonExtractor = PackageJsonExtractor(cli_args=cli_args)
         package_json_checker: PackageJsonChecker = PackageJsonChecker(extractor=package_json_extractor, cli_args=cli_args)
         checkers.append(package_json_checker)
-        
+
+
+
     # codemeta.json
-    if cli_args.check_codemeta_json.lower() == 'true':
+    if str(getattr(cli_args, 'check_codemeta_json', '') or '').lower() == 'true':
         codemeta_json_extractor: CodeMetaJsonExtractor = CodeMetaJsonExtractor(cli_args=cli_args)
         codemeta_json_checker: CodeMetaJsonChecker = CodeMetaJsonChecker(extractor=codemeta_json_extractor, cli_args=cli_args)
         checkers.append(codemeta_json_checker)
 
+
+
     # .zenodo.json
-    if cli_args.check_zenodo_json.lower() == 'true':
+    if str(getattr(cli_args, 'check_zenodo_json', '') or '').lower() == 'true':
         zenodo_json_extractor: ZenodoJsonExtractor = ZenodoJsonExtractor(cli_args=cli_args)
         zenodo_json_checker: ZenodoJsonChecker = ZenodoJsonChecker(extractor=zenodo_json_extractor, cli_args=cli_args)
         checkers.append(zenodo_json_checker)
 
     # Loop through checkers
+    logger.info('📦 Checking software version metadata...')
+
     for checker in checkers:
         # find the base version if it does not exist
         if base_version_str is None and checker.target_version_str is not None:
             base_version_str = checker.target_version_str
-            logger.info(f'📦 Using base version ({base_version_str}) from {checker.target_name}')
+            logger.info(f'📦 Using {checker.target_name} for base version: {base_version_str}')
         else:
             checker.check(base_version_str=base_version_str)
 
     # Final result
 
     if get_log_collector().get_error_logs():
+        logger.error("❌ Some versions do not match!")
         sys.exit(1)
     else:
         if base_version_str is None: