Add support for default code scanning config

Author: rvermeulen

codeql_bundle/cli.py

@@ -11,7 +11,7 @@
 from pathlib import Path
 from codeql_bundle.helpers.codeql import CodeQLException
 from codeql_bundle.helpers.bundle import CustomBundle, BundleException, BundlePlatform
-from typing import List
+from typing import List, Optional
 import sys
 import logging
 
@@ -50,13 +50,15 @@
     default="WARNING",
 )
 @click.option("-p", "--platform", multiple=True, type=click.Choice(["linux64", "osx64", "win64"], case_sensitive=False), help="Target platform for the bundle")
+@click.option("-c", "--code-scanning-config", type=click.Path(exists=True, path_type=Path), help="Path to a Code Scanning configuration file that will be the default for the bundle")
 @click.argument("packs", nargs=-1, required=True)
 def main(
     bundle_path: Path,
     output: Path,
     workspace: Path,
     loglevel: str,
     platform: List[str],
+    code_scanning_config: Optional[Path],
     packs: List[str],
 ) -> None:
 
@@ -119,6 +121,9 @@ def main(
             f"Adding the pack(s) {','.join(map(lambda p: p.config.name, selected_packs))} and its workspace dependencies to the custom bundle."
         )
         bundle.add_packs(*selected_packs)
+        if code_scanning_config:
+            logger.info(f"Adding the Code Scanning configuration file {code_scanning_config} to the custom bundle.")
+            bundle.add_code_scanning_config(code_scanning_config)
         logger.info(f"Bundling custom bundle(s) at {output}")
         platforms = set(map(BundlePlatform.from_string, platform))
         bundle.bundle(output, platforms)

codeql_bundle/helpers/bundle.py

@@ -550,7 +550,14 @@ def bundle_query_pack(pack: ResolvedCodeQLPack):
             elif pack.kind == CodeQLPackKind.QUERY_PACK:
                 bundle_query_pack(pack)
 
-    def bundle(self, output_path: Path, platforms: set[BundlePlatform] = set()):
+    def add_code_scanning_config(self, default_config: Path):
+        if not default_config.exists():
+            raise BundleException(f"Default config {default_config} does not exist.")
+        if not default_config.is_file():
+            raise BundleException(f"Default config {default_config} is not a file.")
+        shutil.copy(default_config, self.bundle_path / "default-codeql-config.yml")
+
+    def bundle(self, output_path: Path, platforms: set[BundlePlatform] = set(), default_config : Optional[Path] = None):
         if len(platforms) == 0:
             if output_path.is_dir():
                 output_path = output_path / "codeql-bundle.tar.gz"