ossa-scanner 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

ossa_scanner/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.2"

ossa_scanner/cli.py

@@ -0,0 +1,35 @@
+import argparse
+from .scanner import Scanner
+from .uploader import GitHubUploader
+
+def main():
+    parser = argparse.ArgumentParser(description="OSSA Scanner CLI Tool")
+    parser.add_argument('--output-dir', type=str, required=True, help="Directory to save downloaded source")
+    parser.add_argument('--results-file', type=str, required=True, help="Path to save the JSON results")
+    parser.add_argument('--threads', type=int, default=4, help="Number of threads for parallel processing")
+    parser.add_argument('--upload', action='store_true', help="Upload results to GitHub")
+    parser.add_argument('--repo-owner', type=str, help="GitHub repository owner")
+    parser.add_argument('--repo-name', type=str, help="GitHub repository name")
+    parser.add_argument('--token', type=str, help="GitHub token")
+    parser.add_argument('--repo-dir', type=str, help="Target directory in GitHub repo for results")
+    args = parser.parse_args()
+
+    # Initialize the scanner
+    scanner = Scanner(output_dir=args.output_dir, threads=args.threads)
+    
+    # Perform scanning
+    results = scanner.scan_packages()
+
+    # Save results locally
+    scanner.save_results(results, args.results_file)
+
+    # Upload results to GitHub if specified
+    if args.upload:
+        if not (args.repo_owner and args.repo_name and args.token and args.repo_dir):
+            raise ValueError("GitHub upload requires --repo-owner, --repo-name, --token, and --repo-dir")
+
+        uploader = GitHubUploader(args.token, args.repo_owner, args.repo_name)
+        scanner.upload_results(args.results_file, uploader, args.repo_dir)
+
+if __name__ == "__main__":
+    main()

ossa_scanner/scanner.py

@@ -1,21 +1,15 @@
 import os
 import json
 from concurrent.futures import ThreadPoolExecutor, as_completed
-from ossa_scanner.utils.os_detection import detect_os
-from ossa_scanner.utils.package_manager import list_packages, get_package_info, download_source
-from ossa_scanner.utils.hash_calculator import calculate_file_hash
-from ossa_scanner.utils.swhid_calculator import calculate_swhid
-from ossa_scanner.uploader import GitHubUploader
+from .utils.os_detection import detect_os
+from .utils.package_manager import list_packages, get_package_info
+from .utils.downloader import download_source
+from .utils.hash_calculator import calculate_file_hash
+from .utils.swhid_calculator import calculate_swhid
+from .uploader import GitHubUploader
 
 class Scanner:
     def __init__(self, output_dir, threads=4):
-        """
-        Initialize the scanner with the output directory and thread count.
-
-        Args:
-            output_dir (str): Directory to store downloaded files and extracted sources.
-            threads (int): Number of threads for parallel processing.
-        """
         self.output_dir = output_dir
         self.os_type = detect_os()
         self.threads = threads
@@ -75,7 +69,6 @@ class Scanner:
         print(f"Detected OS: {self.os_type}")
         print("Listing available packages...")
         packages = list_packages(self.os_type)
-
         results = []
         with ThreadPoolExecutor(max_workers=self.threads) as executor:
             # Submit tasks for parallel processing

ossa_scanner/utils/downloader.py

@@ -1,11 +1,47 @@
 import subprocess
+import os
+import shutil
+import glob
 
 def download_source(package_manager, package_name, output_dir):
-    if package_manager == 'apt':
-        cmd = ['apt-get', 'source', package_name, '-d', output_dir]
-    elif package_manager in ['yum', 'dnf']:
-        cmd = ['dnf', 'download', '--source', package_name, '--downloaddir', output_dir]
-    else:
-        raise ValueError("Unsupported package manager")
-
-    subprocess.run(cmd)
+    try:
+        if package_manager == 'apt':
+            cmd = ['apt-get', 'source', package_name, '-d', output_dir]
+            subprocess.run(cmd, check=True)
+        elif package_manager in ['yum', 'dnf']:
+            cmd = ['dnf', 'download', '--source', package_name, '--downloaddir', output_dir]
+            subprocess.run(cmd, check=True)
+        elif package_manager == 'brew':
+            # Fetch the source tarball
+            cmd = ['brew', 'fetch', '--build-from-source', package_name]
+            subprocess.run(cmd, check=True, capture_output=True, text=True)
+            cache_dir = subprocess.run(
+                ['brew', '--cache', package_name],
+                capture_output=True,
+                text=True,
+                check=True
+            ).stdout.strip()
+            prefixes_to_remove = ['aarch64-elf-', 'arm-none-eabi-', 'other-prefix-']
+            stripped_package_name = package_name
+            for prefix in prefixes_to_remove:
+                if package_name.startswith(prefix):
+                    stripped_package_name = package_name[len(prefix):]
+                    break
+            cache_folder = os.path.dirname(cache_dir)
+            tarball_pattern = os.path.join(cache_folder, f"*{stripped_package_name}*")
+            matching_files = glob.glob(tarball_pattern)
+            if not matching_files:
+                raise FileNotFoundError(f"Tarball not found for {package_name} in {cache_folder}")
+            tarball_path = matching_files[0]
+            os.makedirs(output_dir, exist_ok=True)
+            target_path = os.path.join(output_dir, os.path.basename(tarball_path))
+            shutil.move(tarball_path, target_path)
+            return target_path
+        else:
+            raise ValueError("Unsupported package manager")
+    except subprocess.CalledProcessError as e:
+        print(f"Command failed: {e}")
+        return None
+    except Exception as e:
+        print(f"Error: {e}")
+        return None

ossa_scanner/utils/os_detection.py

@@ -1,10 +1,13 @@
-import platform
+import distro
 
 def detect_os():
-    dist, _, _ = platform.linux_distribution(full_distribution_name=False)
-    if 'Ubuntu' in dist or 'Debian' in dist:
+    dist = distro.id()
+    if 'ubuntu' in dist or 'debian' in dist:
         return 'apt'
-    elif 'Red Hat' in dist or 'CentOS' in dist or 'AlmaLinux' in dist:
+    elif 'redhat' in dist or 'centos' in dist or 'almalinux' in dist:
         return 'yum'
+    elif 'darwin' in dist:
+        return 'brew'
     else:
         raise ValueError("Unsupported OS")
+

ossa_scanner/utils/package_manager.py

@@ -1,5 +1,6 @@
 import subprocess
 
+
 def list_packages(package_manager):
     if package_manager == 'apt':
         result = subprocess.run(
@@ -13,19 +14,115 @@ def list_packages(package_manager):
             capture_output=True,
             text=True
         )
+    elif package_manager == 'brew':
+        result = subprocess.run(
+            ['brew', 'search', '.'],
+            capture_output=True,
+            text=True
+        )
     else:
-        raise ValueError("Unsupported package manager")
+        raise ValueError("ER1: Unsupported package manager for search")
 
     packages = result.stdout.splitlines()
-    return [pkg.split()[0] for pkg in packages]
+    extracted_packages = []
+    max_packages = 5
+    k_packages = 0
+    for line in packages:
+        if not line.strip() or line.startswith("==>"):
+            continue
+        extracted_packages.append(line.split()[0])
+        if k_packages >= max_packages:
+            break
+        k_packages += 1
+
+    return extracted_packages
+
 
 def get_package_info(package_manager, package_name):
     if package_manager == 'apt':
         cmd = ['apt-cache', 'show', package_name]
     elif package_manager in ['yum', 'dnf']:
         cmd = ['repoquery', '--info', package_name]
+    elif package_manager == 'brew':
+        cmd = ['brew', 'info', package_name]
     else:
-        raise ValueError("Unsupported package manager")
+        raise ValueError("ER: Unsupported package manager for info")
+
+    try:
+        result = subprocess.run(cmd, capture_output=True, text=True, check=True)
+        output = result.stdout
+
+        # Parse the output based on the package manager
+        if package_manager == 'brew':
+            return parse_brew_info(output)
+        elif package_manager in ['yum', 'dnf']:
+            return parse_yum_info(output)
+        elif package_manager == 'apt':
+            return parse_apt_info(output)
+    except subprocess.CalledProcessError as e:
+        print(f"Command failed: {e}")
+        return None
+
+
+def parse_brew_info(output):
+    """Parses brew info output to extract license, website, and description."""
+    info = {}
+    lines = output.splitlines()
+    info["license"] = "Unknown"
+    info["website"] = "Unknown"
+    info["description"] = "Unknown"
+
+    for i, line in enumerate(lines):
+        if i == 1:  # The description is usually on the second line
+            info["description"] = line.strip()
+        elif line.startswith("https://"):  # The website URL
+            info["website"] = line.strip()
+        elif line.startswith("License:"):  # The license information
+            info["license"] = line.split(":", 1)[1].strip()
+
+    # Ensure all keys are present even if some fields are missing
+    return info
+
+
+
+def parse_yum_info(output):
+    """Parses yum repoquery --info output."""
+    info = {}
+    lines = output.splitlines()
+
+    for line in lines:
+        if line.startswith("License"):
+            info["license"] = line.split(":", 1)[1].strip()
+        elif line.startswith("URL"):
+            info["website"] = line.split(":", 1)[1].strip()
+        elif "Copyright" in line:
+            info["copyright"] = line.strip()
+
+    # Ensure all keys are present even if data is missing
+    return {
+        "license": info.get("license", "Unknown"),
+        "copyright": info.get("copyright", "Unknown"),
+        "website": info.get("website", "Unknown"),
+    }
+
+
+def parse_apt_info(output):
+    """Parses apt-cache show output."""
+    info = {}
+    lines = output.splitlines()
+
+    for line in lines:
+        if line.startswith("License:") or "License" in line:
+            info["license"] = line.split(":", 1)[1].strip()
+        elif line.startswith("Homepage:"):
+            info["website"] = line.split(":", 1)[1].strip()
+        elif "Copyright" in line:
+            info["copyright"] = line.strip()
+
+    # Ensure all keys are present even if data is missing
+    return {
+        "license": info.get("license", "Unknown"),
+        "copyright": info.get("copyright", "Unknown"),
+        "website": info.get("website", "Unknown"),
+    }
 
-    result = subprocess.run(cmd, capture_output=True, text=True)
-    return result.stdout

ossa_scanner/utils/swhid_calculator.py

@@ -1,4 +1,3 @@
-from swh.model.hashutil import hash_directory
 
 def calculate_swhid(directory_path):
-    return hash_directory(directory_path)
+    return directory_path

ossa_scanner-0.1.2.dist-info/METADATA

@@ -0,0 +1,28 @@
+Metadata-Version: 2.1
+Name: ossa_scanner
+Version: 0.1.2
+Summary: A Python library for scanning Linux packages, managing metadata, and generating SWHIDs.
+Home-page: https://github.com/oscarvalenzuelab/ossa_scanner
+Author: Oscar Valenzuela
+Author-email: oscar.valenzuela.b@gmail.com
+License: MIT
+Keywords: linux packages SWHID open-source compliance
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: swh.model
+Requires-Dist: distro
+
+# ossa_scanner
+Open Source Advisory Scanner (Generator)

ossa_scanner-0.1.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+ossa_scanner/__init__.py,sha256=YvuYzWnKtqBb-IqG8HAu-nhIYAsgj9Vmc_b9o7vO-js,22
+ossa_scanner/cli.py,sha256=hyRUOgp9kcwFtQrIeyth5vTxeK7eOlxfn5R9E7HX5sA,1640
+ossa_scanner/scanner.py,sha256=SAkiBLjAuO3dklbHPgXs0p047buO6Pp51RROq6G7Yq8,4082
+ossa_scanner/uploader.py,sha256=X8bo7GqfpBjz2NlnvSwDR_rVqNoZDRPF2pnQMaVENbc,2436
+ossa_scanner/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ossa_scanner/utils/downloader.py,sha256=3ccwcde9yJ_SEP0mG9TDr2O0MMdA1p-K6hpzqme-KQ4,2081
+ossa_scanner/utils/hash_calculator.py,sha256=i47KS_HoZNiSbGyd0iP9_TcDwxWS2SrmkIcNF2MWLcA,254
+ossa_scanner/utils/os_detection.py,sha256=QdRKQ4li4SOHgBofe1qWf8OOcw8XvhM-XWUNu0Cy0a4,315
+ossa_scanner/utils/package_manager.py,sha256=tWuQwgkFQjTzeisem0Gz8uFvWw5Cxd-Tft5HM8tIQmk,4028
+ossa_scanner/utils/swhid_calculator.py,sha256=4Z0H2GmECMAJlvH6JBbUmaLXSLRNntyYEdxsS6CTEMQ,63
+ossa_scanner-0.1.2.dist-info/LICENSE,sha256=9slQ_XNiEkio28l90NwihP7a90fCL2GQ6YhcVXTBls4,1064
+ossa_scanner-0.1.2.dist-info/METADATA,sha256=dWWsJKRvqN1vdal81dAseom9Cb1OwLjuOZAllrfOoMs,1043
+ossa_scanner-0.1.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+ossa_scanner-0.1.2.dist-info/entry_points.txt,sha256=UVoAo-wTPxT82g3cfqTs2CmQnazd57TAwhd9VwEKD1c,55
+ossa_scanner-0.1.2.dist-info/top_level.txt,sha256=uUp5CvhZfJLapXn9DyUXvgH7QK3uzF2ibH943lWN5Bs,13
+ossa_scanner-0.1.2.dist-info/RECORD,,

ossa_scanner-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ossa_scanner = ossa_scanner.cli:main

ossa_scanner-0.1.0.dist-info/METADATA

@@ -1,41 +0,0 @@
-Metadata-Version: 2.1
-Name: ossa-scanner
-Version: 0.1.0
-Summary: A CLI tool to scan Linux packages, manage metadata, and upload results to GitHub.
-Author: Oscar Valenzuela
-Author-email: Oscar Valenzuela <oscar.valenzuela.b@gmail.com>
-License: MIT License
-        
-        Copyright (c) 2024 Oscar V
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Keywords: linux,packages,SWHID,GitHub,open-source
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: POSIX :: Linux
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: swh.model
-
-# ossa_scanner
-Open Source Advisory Scanner (Generator)

ossa_scanner-0.1.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-ossa_scanner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ossa_scanner/scanner.py,sha256=nku8pJR1n7Z2Fjs5F3lbxBlv9xFUWrUb3dfucZZcM30,4387
-ossa_scanner/uploader.py,sha256=X8bo7GqfpBjz2NlnvSwDR_rVqNoZDRPF2pnQMaVENbc,2436
-ossa_scanner/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ossa_scanner/utils/downloader.py,sha256=5fV531x-oiFTyh6B17Afi4W72zFC2ejopvMpn1qNpw4,408
-ossa_scanner/utils/hash_calculator.py,sha256=i47KS_HoZNiSbGyd0iP9_TcDwxWS2SrmkIcNF2MWLcA,254
-ossa_scanner/utils/os_detection.py,sha256=h2hlS5QHHVyyGSHI5jDwq7aivGZTEHk1v_Ml9lTTxbQ,320
-ossa_scanner/utils/package_manager.py,sha256=N_noGTVHxxCTfH9q6ftq2GhkACj1ExOt1AXhNdFFgNQ,953
-ossa_scanner/utils/swhid_calculator.py,sha256=mvjx4wlTDCrWhH3Z_6TitKtt1WsPMC7QYwmWSMck7Ro,126
-ossa_scanner-0.1.0.dist-info/LICENSE,sha256=9slQ_XNiEkio28l90NwihP7a90fCL2GQ6YhcVXTBls4,1064
-ossa_scanner-0.1.0.dist-info/METADATA,sha256=VdiOAhrJ6M75qRG6ntG8UGxYFUR8IQoPNvtFX-bB_Nk,1927
-ossa_scanner-0.1.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-ossa_scanner-0.1.0.dist-info/top_level.txt,sha256=uUp5CvhZfJLapXn9DyUXvgH7QK3uzF2ibH943lWN5Bs,13
-ossa_scanner-0.1.0.dist-info/RECORD,,