Add --project-key CLI option to usethis show sonarqube (#1487)

Copilot · nathanjmcdougall · web-flow · commit baef7747b864 · 2026-03-25T13:05:44.000+13:00
* Initial plan * Add --project-key CLI option to `usethis show sonarqube` command Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/e9843cd4-603e-4310-92b6-6b614347f0c0 --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
diff --git a/src/usethis/_core/show.py b/src/usethis/_core/show.py
@@ -14,5 +14,5 @@ def show_name() -> None:
     plain_print(get_project_name())
 
 
-def show_sonarqube_config() -> None:
-    plain_print(get_sonar_project_properties())
+def show_sonarqube_config(*, project_key: str | None = None) -> None:
+    plain_print(get_sonar_project_properties(project_key=project_key))
diff --git a/src/usethis/_integrations/sonarqube/config.py b/src/usethis/_integrations/sonarqube/config.py
@@ -15,7 +15,7 @@
 from usethis._python.version import PythonVersion, PythonVersionParseError
 
 
-def get_sonar_project_properties() -> str:
+def get_sonar_project_properties(*, project_key: str | None = None) -> str:
     """Get contents for (or from) the sonar-project.properties file."""
     path = usethis_config.cpd() / "sonar-project.properties"
     if path.exists() and path.is_file():
@@ -31,7 +31,10 @@ def get_sonar_project_properties() -> str:
     except (FileNotFoundError, PythonVersionParseError):
         python_version = PythonVersion.from_interpreter().to_short_string()
 
-    project_key = _get_sonarqube_project_key()
+    if project_key is not None:
+        _validate_project_key(project_key)
+    else:
+        project_key = _get_sonarqube_project_key()
     verbose = _is_sonarqube_verbose()
     exclusions = _get_sonarqube_exclusions()
 
diff --git a/src/usethis/_ui/interface/show.py b/src/usethis/_ui/interface/show.py
@@ -7,6 +7,13 @@
     help="Show information about the current project.", add_completion=False
 )
 
+# show sonarqube options
+project_key_opt = typer.Option(
+    None,
+    "--project-key",
+    help="SonarQube project key. If not provided, will be read from 'tool.usethis.sonarqube.project-key' in 'pyproject.toml'.",
+)
+
 
 @app.command(help="Show the inferred project manager backend, e.g. 'uv' or 'none'.")
 def backend(
@@ -51,6 +58,7 @@ def name(
 def sonarqube(
     offline: bool = offline_opt,
     quiet: bool = quiet_opt,
+    project_key: str | None = project_key_opt,
 ) -> None:
     from usethis._config_file import files_manager
     from usethis._console import err_print
@@ -59,7 +67,7 @@ def sonarqube(
 
     with usethis_config.set(offline=offline, quiet=quiet), files_manager():
         try:
-            show_sonarqube_config()
+            show_sonarqube_config(project_key=project_key)
         except UsethisError as err:
             err_print(err)
             raise typer.Exit(code=1) from None
diff --git a/tests/usethis/_integrations/sonarqube/test_sonarqube_config.py b/tests/usethis/_integrations/sonarqube/test_sonarqube_config.py
@@ -336,6 +336,65 @@ def test_missing_coverage_file_location_error(self, tmp_path: Path):
             with pytest.raises(CoverageReportConfigNotFoundError):
                 get_sonar_project_properties()
 
+    def test_project_key_argument(self, tmp_path: Path):
+        with change_cwd(tmp_path), PyprojectTOMLManager():
+            # Arrange
+            uv_python_pin("3.12")
+            ensure_pyproject_toml()
+            PyprojectTOMLManager().set_value(
+                keys=["tool", "coverage", "xml", "output"], value="coverage.xml"
+            )
+
+            # Act
+            result = get_sonar_project_properties(project_key="cli-key")
+
+        # Assert
+        assert (
+            result
+            == """\
+sonar.projectKey=cli-key
+sonar.language=py
+sonar.python.version=3.12
+sonar.sources=./
+sonar.tests=./tests
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.verbose=false
+sonar.exclusions=tests/*
+"""
+        )
+
+    def test_project_key_argument_overrides_pyproject(self, tmp_path: Path):
+        with change_cwd(tmp_path), PyprojectTOMLManager():
+            # Arrange
+            uv_python_pin("3.12")
+            ensure_pyproject_toml()
+            PyprojectTOMLManager().set_value(
+                keys=["tool", "usethis", "sonarqube", "project-key"],
+                value="from-pyproject",
+            )
+            PyprojectTOMLManager().set_value(
+                keys=["tool", "coverage", "xml", "output"], value="coverage.xml"
+            )
+
+            # Act
+            result = get_sonar_project_properties(project_key="from-cli")
+
+        # Assert
+        assert "sonar.projectKey=from-cli\n" in result
+
+    def test_project_key_argument_invalid(self, tmp_path: Path):
+        with change_cwd(tmp_path), PyprojectTOMLManager():
+            # Arrange
+            uv_python_pin("3.12")
+            ensure_pyproject_toml()
+            PyprojectTOMLManager().set_value(
+                keys=["tool", "coverage", "xml", "output"], value="coverage.xml"
+            )
+
+            # Act, Assert
+            with pytest.raises(InvalidSonarQubeProjectKeyError):
+                get_sonar_project_properties(project_key="invalid key!")
+
     def test_flat_layout_exclusions_already_has_tests(self, tmp_path: Path):
         # When using flat layout and tests/* is already in exclusions,
         # it should not be added again.
diff --git a/tests/usethis/_ui/interface/test_show.py b/tests/usethis/_ui/interface/test_show.py
@@ -94,6 +94,63 @@ def test_missing_key(self, tmp_path: Path):
         # Assert
         assert result.exit_code == 1, result.output
 
+    def test_project_key_option(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text(
+            """
+[tool.coverage.xml.output]
+"""
+        )
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke_safe(
+                app, ["sonarqube", "--project-key", "my-project"]
+            )
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert "sonar.projectKey=my-project" in result.output
+
+    def test_project_key_option_overrides_pyproject(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text(
+            """
+[tool.usethis.sonarqube]
+project-key = "from-pyproject"
+
+[tool.coverage.xml.output]
+"""
+        )
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke_safe(app, ["sonarqube", "--project-key", "from-cli"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert "sonar.projectKey=from-cli" in result.output
+
+    def test_project_key_option_invalid(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text(
+            """
+[tool.coverage.xml.output]
+"""
+        )
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke_safe(
+                app, ["sonarqube", "--project-key", "invalid key!"]
+            )
+
+        # Assert
+        assert result.exit_code == 1, result.output
+
     def test_invalid_pyproject(self, tmp_path: Path):
         # Arrange
         (tmp_path / "pyproject.toml").write_text("[")
