Fixing sonar code smells (#3)

Author: djpugh

.github/workflows/pipeline.yaml

@@ -211,6 +211,7 @@ jobs:
             -Dsonar.projectKey=djpugh_mkdocs_licenseinfo
             -Dsonar.organization=djpugh
             -Dsonar.coverage.exclusions=**/*.*
+            -Dsonar.sources=src/
           # No coverage as handled separately
 
   license-scan:

noxfile.py

@@ -70,7 +70,7 @@ def test(session):
     if session.posargs:
         test_folder = [f'tests/{u}' for u in session.posargs]
     else:
-        test_folder = ['tests']
+        test_folder = ['tests/unit']
     session.install('.[dev,dev-test]')
     for folder in test_folder:
         args = []

src/mkdocs_licenseinfo/__init__.py

@@ -7,7 +7,8 @@
 def __get_version() -> str:
     """Get version information or return default if unable to do so."""
     # Default
-    version = '0+unknown'
+    default_version = '0+unknown'
+    version = default_version
     # Development installation only
     try:
         # Look here for setuptools scm to update the version - for development environments only
@@ -20,13 +21,13 @@ def __get_version() -> str:
         pass
     # Development installation without setuptools_scm or installed package
     # try loading from file
-    if version == '0+unknown':
+    if version == default_version:
         try:
             from mkdocs_licenseinfo._version import __version__  # noqa: F401
         except ImportError:
             pass
     # Development installation without setuptools_scm
-    if version == '0+unknown':
+    if version == default_version:
         # Use the metadata
         import sys
         if sys.version_info.major >= 3 and sys.version_info.minor >= 8:

src/mkdocs_licenseinfo/extension.py

@@ -91,7 +91,6 @@ def run(self, parent: Element, blocks: MutableSequence[str]) -> None:
             # insert it back into the blocks to be processed as markdown
             block = self._process_block(block, heading_level)
             blocks.insert(0, block)
-        return False
 
     def _process_block(
         self,

tests/unit/test_processor.py

@@ -59,7 +59,7 @@ def test_process_block_simple(self, get_licenses_as_markdown):
 
     @patch.object(extension, 'get_licenses_as_markdown')
     def test_process_block_with_global_config(self, get_licenses_as_markdown):
-        packages = 'Abacus'
+        packages = 'Ipsum'
         get_licenses_as_markdown.return_value = [packages]
         global_config = {
             'ignore_packages': ['a', 'b'],
@@ -89,7 +89,7 @@ def test_process_block_with_global_config(self, get_licenses_as_markdown):
 
     @patch.object(extension, 'get_licenses_as_markdown')
     def test_process_block_with_local_config(self, get_licenses_as_markdown):
-        packages = '# Abacus'
+        packages = '# Ipsum'
         get_licenses_as_markdown.return_value = [packages]
         global_config = {
             'ignore_packages': ['a', 'b'],
@@ -104,7 +104,7 @@ def test_process_block_with_local_config(self, get_licenses_as_markdown):
         }
         processor = LicenseInfoProcessor(BlockParser(Markdown()), global_config)
         result = processor._process_block('requirements_path: ../random\nbase_indent: 3\nusing: xyz\ndiff: ghi\nignore_packages:\n  - k\n  - l\nfail_packages:\n  - m\n  - n\nskip_packages:\n  - o\n  - p\nignore_licenses:\n  - q\n  - r\nfail_licenses:\n  - s\n  - t\npackage_template: mno')
-        self.assertEqual(result, '#### Abacus')
+        self.assertEqual(result, '###'+packages)
         get_licenses_as_markdown.assert_called_once_with(
             using='xyz',
             ignore_packages=['k', 'l'],
@@ -120,7 +120,7 @@ def test_process_block_with_local_config(self, get_licenses_as_markdown):
 
     @patch.object(extension, 'get_licenses_as_markdown')
     def test_process_block_with_env(self, get_licenses_as_markdown):
-        packages = 'Abacus'
+        packages = 'Sit'
         get_licenses_as_markdown.return_value = [packages]
         global_config = {
             'ignore_packages': ['a', 'b'],
@@ -151,11 +151,11 @@ def test_process_block_with_env(self, get_licenses_as_markdown):
 
     @patch.object(extension, 'get_licenses_as_markdown')
     def test_process_block_with_heading_level(self, get_licenses_as_markdown):
-        packages = '# Abacus'
+        packages = '# Amet'
         get_licenses_as_markdown.return_value = [packages]
         processor = LicenseInfoProcessor(BlockParser(Markdown()), {})
         result = processor._process_block('', 2)
-        self.assertEqual(result, '### Abacus')
+        self.assertEqual(result, '##'+packages)
 
     def test_test_matching(self):
         test_strings = [
@@ -183,7 +183,7 @@ def test_test_not_matching(self):
 
     @patch.object(extension, 'get_licenses_as_markdown')
     def test_run_matching_block(self, get_licenses_as_markdown):
-        packages = '# Abacus'
+        packages = '# Consectetur'
         get_licenses_as_markdown.return_value = [packages]
         blocks = ['::licenseinfo', 'b']
         processor = LicenseInfoProcessor(BlockParser(Markdown()), {})