SCANPY-179 There should be a parameter to configure the heap size (#215)

Author: maksim-grebeniuk-sonarsource

CLI_ARGS.md

@@ -73,6 +73,7 @@
 | `--sonar-scanner-internal-dump-to-file`, `-Dsonar.scanner.internal.dumpToFile` | Filename where the input to the scanner engine will be dumped. Useful for debugging |
 | `--sonar-scanner-internal-sq-version`, `-Dsonar.scanner.internal.sqVersion` | Emulate the result of the call to get SQ server version.  Useful for debugging with --sonar-scanner-internal-dump-to-file |
 | `--sonar-scanner-java-exe-path`, `-Dsonar.scanner.javaExePath` | If defined, the scanner engine will be run with this JRE |
+| `--sonar-scanner-java-heap-size`, `--java-heap-size`, `-Dsonar.scanner.javaHeapSize` | Arguments specifies the heap size provided to the JVM when running the scanner |
 | `--sonar-scanner-java-opts`, `-Dsonar.scanner.javaOpts` | Arguments provided to the JVM when running the scanner |
 | `--sonar-scanner-keystore-password`, `-Dsonar.scanner.keystorePassword` | Password to access the keystore |
 | `--sonar-scanner-keystore-path`, `-Dsonar.scanner.keystorePath` | Path to the keystore containing the client certificates used by the scanner. By default, <sonar.userHome>/ssl/keystore.p12 |

src/pysonar_scanner/configuration/cli.py

@@ -179,6 +179,13 @@ def __create_parser(cls):
             type=str,
             help="Arguments provided to the JVM when running the scanner",
         )
+        parser.add_argument(
+            "--sonar-scanner-java-heap-size",
+            "--java-heap-size",
+            "-Dsonar.scanner.javaHeapSize",
+            type=str,
+            help="Arguments specifies the heap size provided to the JVM when running the scanner",
+        )
 
         parser.add_argument(
             "--sonar-scanner-internal-dump-to-file",

src/pysonar_scanner/configuration/properties.py

@@ -56,6 +56,7 @@
 SONAR_SCANNER_PROXY_PASSWORD: Key = "sonar.scanner.proxyPassword"
 SONAR_SCANNER_METADATA_FILEPATH: Key = "sonar.scanner.metadataFilePath"
 SONAR_SCANNER_JAVA_OPTS: Key = "sonar.scanner.javaOpts"
+SONAR_SCANNER_JAVA_HEAP_SIZE: Key = "sonar.scanner.javaHeapSize"
 SONAR_PROJECT_BASE_DIR: Key = "sonar.projectBaseDir"
 SONAR_PROJECT_KEY: Key = "sonar.projectKey"
 SONAR_PROJECT_NAME: Key = "sonar.projectName"
@@ -299,6 +300,11 @@ def env_variable_name(self) -> str:
         default_value=None, 
         cli_getter=lambda args: args.sonar_scanner_java_opts
     ),
+    Property(
+        name=SONAR_SCANNER_JAVA_HEAP_SIZE,
+        default_value=None,
+        cli_getter=lambda args: args.sonar_scanner_java_heap_size
+    ),
     Property(
         name=SONAR_SCANNER_METADATA_FILEPATH,
         default_value=None,

tests/unit/test_configuration_cli.py

@@ -38,6 +38,7 @@
     SONAR_SCANNER_INTERNAL_SQ_VERSION,
     SONAR_SCANNER_JAVA_EXE_PATH,
     SONAR_SCANNER_JAVA_OPTS,
+    SONAR_SCANNER_JAVA_HEAP_SIZE,
     SONAR_SCANNER_KEYSTORE_PASSWORD,
     SONAR_SCANNER_KEYSTORE_PATH,
     SONAR_SCANNER_OS,
@@ -125,6 +126,7 @@
     SONAR_SCANNER_SKIP_JRE_PROVISIONING: True,
     SONAR_SCANNER_JAVA_EXE_PATH: "mySonarScannerJavaExePath",
     SONAR_SCANNER_JAVA_OPTS: "mySonarScannerJavaOpts",
+    SONAR_SCANNER_JAVA_HEAP_SIZE: "8000Mb",
     SONAR_SCANNER_METADATA_FILEPATH: "myMetadataFilepath",
     SONAR_REGION: "us",
     SONAR_ORGANIZATION: "mySonarOrganization",
@@ -181,8 +183,16 @@ def test_minimal_cli_args(self):
 
     def test_alternative_cli_args(self):
         alternatives = [
-            ["-t", "myToken", "-v", "--project-key", "myProjectKey"],
-            ["--sonar-token", "myToken", "--sonar-verbose", "--sonar-project-key", "myProjectKey"],
+            ["-t", "myToken", "-v", "--project-key", "myProjectKey", "--sonar-scanner-java-heap-size", "8000Mb"],
+            [
+                "--sonar-token",
+                "myToken",
+                "--sonar-verbose",
+                "--sonar-project-key",
+                "myProjectKey",
+                "--java-heap-size",
+                "8000Mb",
+            ],
         ]
         for alternative in alternatives:
             with patch("sys.argv", ["myscript.py", *alternative]), patch("sys.stderr", new=StringIO()):
@@ -191,6 +201,7 @@ def test_alternative_cli_args(self):
                     SONAR_TOKEN: "myToken",
                     SONAR_VERBOSE: True,
                     SONAR_PROJECT_KEY: "myProjectKey",
+                    SONAR_SCANNER_JAVA_HEAP_SIZE: "8000Mb",
                 }
                 self.assertDictEqual(configuration, expected_configuration)
 
@@ -387,6 +398,8 @@ def test_impossible_os_choice(self):
             "path/to/ruff/reports",
             "--sonar-modules",
             "module1,module2",
+            "--sonar-scanner-java-heap-size",
+            "8000Mb",
         ],
     )
     def test_all_cli_args(self):
@@ -464,6 +477,7 @@ def test_all_cli_args(self):
             "-Dsonar.python.flake8.reportPaths=path/to/flake8/reports",
             "-Dsonar.python.ruff.reportPaths=path/to/ruff/reports",
             "-Dsonar.modules=module1,module2",
+            "-Dsonar.scanner.javaHeapSize=8000Mb",
         ],
     )
     def test_jvm_style_cli_args(self):

tests/unit/test_configuration_loader.py

@@ -37,6 +37,7 @@
     SONAR_SCANNER_SKIP_JRE_PROVISIONING,
     SONAR_SCANNER_SOCKET_TIMEOUT,
     SONAR_SCANNER_TRUSTSTORE_PASSWORD,
+    SONAR_SCANNER_JAVA_HEAP_SIZE,
     SONAR_EXCLUSIONS,
     SONAR_SOURCES,
     SONAR_TESTS,
@@ -277,6 +278,7 @@ def test_load_pyproject_toml_from_toml_path(self, mock_get_os, mock_get_arch):
                 project-name = "Custom Path Project"
                 sources = "src/main"
                 tests= "src/test"
+                scanner.javaHeapSize = "8000Mb"
                 """
             ),
         )
@@ -301,6 +303,7 @@ def test_load_pyproject_toml_from_toml_path(self, mock_get_os, mock_get_arch):
             SONAR_SCANNER_OS: Os.LINUX.value,
             SONAR_SCANNER_ARCH: Arch.X64.value,
             TOML_PATH: "custom/path",
+            SONAR_SCANNER_JAVA_HEAP_SIZE: "8000Mb",
         }
         self.assertDictEqual(configuration, expected_configuration)