Fix sphinx build and CI tests

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

Author: AyanSinhaMahapatra

docs/source/reference/available_package_parsers.rst

@@ -14,7 +14,7 @@ parsers in scancode-toolkit during documentation builds.
 
 
 .. list-table:: Supported Package Parsers
-   :widths: 10 10 20 10 10 2
+   :widths: 10 10 20 10 10 10 2
    :header-rows: 1
 
    * - Description
@@ -140,6 +140,13 @@ parsers in scancode-toolkit during documentation builds.
      - ``cargo_toml``
      - Rust
      - https://doc.rust-lang.org/cargo/reference/manifest.html
+   * - Rust binary
+     - None
+     - ``cargo``
+     - ``linux``, ``win``, ``mac``
+     - ``rust_binary``
+     - Rust
+     - https://github.com/rust-secure-code/cargo-auditable/blob/master/PARSING.md
    * - Chef cookbook metadata.json
      - ``*/metadata.json``
      - ``chef``
@@ -1008,4 +1015,3 @@ parsers in scancode-toolkit during documentation builds.
      - ``windows_executable``
      - None
      - https://en.wikipedia.org/wiki/Portable_Executable
-   

setup-mini.cfg

@@ -67,7 +67,7 @@ install_requires =
     Beautifulsoup4 >= 4.0.0
     boolean.py >= 4.0
     chardet >= 3.0.0
-    click >= 6.7, !=7.0
+    click >= 6.7, !=7.0, !=8.1.8
     colorama >= 0.3.9
     commoncode >= 32.0.0
     container-inspector >= 31.0.0

setup.cfg

@@ -67,7 +67,7 @@ install_requires =
     Beautifulsoup4 >= 4.0.0
     boolean.py >= 4.0
     chardet >= 3.0.0
-    click >= 6.7, !=7.0
+    click >= 6.7, !=7.0, !=8.1.8
     colorama >= 0.3.9
     commoncode >= 32.0.0
     container-inspector >= 31.0.0

src/packagedcode/models.py

@@ -1045,7 +1045,7 @@ class DatafileHandler:
 
     # tuple of operating systems where getting package data using this DatafileHandler is supported.
     # If None or empty, all platforms are supported, possible values are win, mac, linux, freebsd
-    supported_oses = ('linux', 'win', 'mac')
+    supported_oses = None
 
     # Sequence of known fnmatch-style case-insensitive glob patterns (e.g., Unix
     # shell style patterns) that apply on the whole POSIX path for package

src/packagedcode/plugin_package.py

@@ -89,6 +89,11 @@ def get_available_package_parsers(docs=False):
         if cls.datasource_id is None:
             raise Exception(cls)
 
+        if not cls.supported_oses:
+            supported_oses = ('linux', 'win', 'mac')
+        else:
+            supported_oses = cls.supported_oses
+
         data_packages = {}
         if docs:
             path_patterns = '\n       '.join(f"``{p}``" for p in cls.path_patterns)
@@ -97,11 +102,11 @@ def get_available_package_parsers(docs=False):
             else:
                 data_packages['package_type'] = cls.default_package_type
             data_packages['datasource_id'] = f"``{cls.datasource_id}``"
-            supported_oses = ', '.join(f"``{os_type}``" for os_type in cls.supported_oses)
+            supported_oses = ', '.join(f"``{os_type}``" for os_type in supported_oses)
 
         else:
             path_patterns = ', '.join(repr(p) for p in cls.path_patterns)
-            supported_oses = ', '.join(repr(os_type) for os_type in cls.supported_oses)
+            supported_oses = ', '.join(repr(os_type) for os_type in supported_oses)
             data_packages['package_type'] = cls.default_package_type
             data_packages['datasource_id'] = cls.datasource_id
 

src/packagedcode/templates/available_package_parsers.rst

@@ -14,7 +14,7 @@ parsers in scancode-toolkit during documentation builds.
 
 
 .. list-table:: Supported Package Parsers
-   :widths: 10 10 20 10 10 2
+   :widths: 10 10 20 10 10 10 2
    :header-rows: 1
 
    * - Description

tests/packagedcode/data/plugin/plugins_list_linux.txt

@@ -111,6 +111,13 @@ Package type:  cargo
   description:       Rust Cargo.toml package manifest
   path_patterns:    '*/Cargo.toml', '*/cargo.toml'
 --------------------------------------------
+Package type:  cargo
+  datasource_id:     rust_binary
+  documentation URL: https://github.com/rust-secure-code/cargo-auditable/blob/master/PARSING.md
+  primary language:  Rust
+  description:       Rust binary
+  path_patterns:    
+--------------------------------------------
 Package type:  chef
   datasource_id:     chef_cookbook_metadata_json
   documentation URL: https://docs.chef.io/config_rb_metadata/

tests/scancode/data/help/help_linux.txt

@@ -16,6 +16,7 @@ Options:
                       license/copyright detection and top-level package creation.
     -c, --copyright   Scan <input> for copyrights.
     --go-symbol       Collect Go symbols.
+    --rust-symbol     Collect Rust symbols from rust binaries.
 
   other scans:
     -i, --info   Scan <input> for file information (size, checksums, etc).

tests/scancode/test_cli.py

@@ -128,7 +128,7 @@ def test_no_version_check_run_is_successful():
 
 
 def test_usage_and_help_return_a_correct_script_name_on_all_platforms():
-    result = run_scan_click(['--help'])
+    result = run_scan_click(options=['--help'], test_mode=False, retry=False)
     assert 'Usage: scancode [OPTIONS]' in result.output
     # this was showing up on Windows
     assert 'scancode-script.py' not in result.output