Add basic auth support for Redmine instances

CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Add basic auth support for Redmine instances
 
 ## [0.6.0] - 2024-05-14
 ### Added
@@ -103,4 +105,3 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 [0.1.0]: https://github.com/nekeal/issx/compare/0.0.4...0.1.0
 [0.0.4]: https://github.com/nekeal/issx/compare/0.0.2...0.0.4
 [0.0.2]: https://github.com/nekeal/issx/tree/0.0.2
-

README.md

@@ -129,6 +129,20 @@ that `issx` will interact with.
 an instance.
 `project` field should contain the project id available in the chosen instance (usually it is a number).
 
+### Basic auth
+
+For Redmine instances that use basic authentication, you can specify the credentials using `basic_auth_user` and
+`basic_auth_password` properties in the instance configuration:
+
+```toml
+[instances.INSTANCE_NAME]
+    backend = "redmine"
+    url = "<absolute url to the instance>"
+    token = "<API token used for authentication>"
+    basic_auth_user = "username"
+    basic_auth_password = "password"
+```
+
 ## Development
 
 * Clone this repository

pyproject.toml

@@ -47,6 +47,7 @@ python-kacl = "*"
 ruff = "*"
 pytest-asyncio = "^0.23.6"
 import-linter = "^2.0"
+types-requests = "^2.32.0.20250328"
 
 [tool.poetry.group.docs.dependencies]
 mkdocstrings = {version = ">=0.23", extras = ["python"]}

src/issx/clients/redmine.py

@@ -6,6 +6,7 @@
 from redminelib.resources import Issue as RedmineIssue
 from redminelib.resources import Project
 from redminelib.resultsets import ResourceSet
+from requests.auth import HTTPBasicAuth
 
 from issx.clients.exceptions import IssueDoesNotExistError, ProjectDoesNotExistError
 from issx.clients.interfaces import InstanceClientInterface, IssueClientInterface
@@ -46,10 +47,21 @@ def get_instance_url(self) -> str:
     @classmethod
     def instance_from_config(cls, instance_config: InstanceConfig) -> Self:
         instance_config = cls.instance_config_class(**asdict(instance_config))
+        additional_kwargs = {}
+        if instance_config.basic_auth_user and instance_config.basic_auth_password:
+            additional_kwargs = {
+                "requests": {
+                    "auth": HTTPBasicAuth(
+                        instance_config.basic_auth_user,
+                        instance_config.basic_auth_password,
+                    )
+                }
+            }
         return cls(
             Redmine(
                 instance_config.url,
                 key=instance_config.token,
+                **additional_kwargs,
             )
         )
 

src/issx/domain/config.py

@@ -53,6 +53,14 @@ class InstanceConfig(BaseConfig):
     )
     url: str = attr.ib(validator=attr.validators.instance_of(str))
     token: str = attr.ib(validator=attr.validators.instance_of(str))
+    basic_auth_user: str | None = attr.ib(
+        default=None,
+        validator=attr.validators.optional(attr.validators.instance_of(str)),
+    )
+    basic_auth_password: str | None = attr.ib(
+        default=None,
+        validator=attr.validators.optional(attr.validators.instance_of(str)),
+    )
 
 
 @define(kw_only=True)

tests/test_config.py

@@ -9,6 +9,8 @@ def test_meaningful_fields(self):
             fields.backend,
             fields.url,
             fields.token,
+            fields.basic_auth_user,
+            fields.basic_auth_password,
         ]
 
     def test_as_toml(self):
@@ -21,5 +23,24 @@ def test_as_toml(self):
             "[test]\n"
             "backend = 'gitlab'\n"
             "url = 'http://example.com'\n"
-            "token = '123'"
+            "token = '123'\n"
+            "basic_auth_user = None\n"
+            "basic_auth_password = None"
+        )
+
+    def test_as_toml_with_basic_auth(self):
+        config = InstanceConfig(
+            backend="redmine",  # type: ignore
+            url="http://example.com",
+            token="123",
+            basic_auth_user="myuser",
+            basic_auth_password="mypassword",
+        )
+        assert config.as_toml("test") == (
+            "[test]\n"
+            "backend = 'redmine'\n"
+            "url = 'http://example.com'\n"
+            "token = '123'\n"
+            "basic_auth_user = 'myuser'\n"
+            "basic_auth_password = 'mypassword'"
         )