diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c15ca0..0bf2c02 100644 --- a/CHANGELOG.md +++ b/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 - diff --git a/README.md b/README.md index 88d60f7..9193b28 100644 --- a/README.md +++ b/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 = "" + token = "" + basic_auth_user = "username" + basic_auth_password = "password" +``` + ## Development * Clone this repository diff --git a/poetry.lock b/poetry.lock index 364e522..41ddd84 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.5 and should not be changed by hand. [[package]] name = "attrs" @@ -1119,6 +1119,7 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, + {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1126,8 +1127,15 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, + {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, + {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, + {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, + {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1144,6 +1152,7 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1151,6 +1160,7 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -1461,6 +1471,20 @@ typing-extensions = ">=3.7.4.3" all = ["rich (>=10.11.0)", "shellingham (>=1.3.0)"] standard = ["rich (>=10.11.0)", "shellingham (>=1.3.0)"] +[[package]] +name = "types-requests" +version = "2.32.0.20250328" +description = "Typing stubs for requests" +optional = false +python-versions = ">=3.9" +files = [ + {file = "types_requests-2.32.0.20250328-py3-none-any.whl", hash = "sha256:72ff80f84b15eb3aa7a8e2625fffb6a93f2ad5a0c20215fc1dcfa61117bcb2a2"}, + {file = "types_requests-2.32.0.20250328.tar.gz", hash = "sha256:c9e67228ea103bd811c96984fac36ed2ae8da87a36a633964a21f199d60baf32"}, +] + +[package.dependencies] +urllib3 = ">=2" + [[package]] name = "typing-extensions" version = "4.10.0" @@ -1553,4 +1577,4 @@ watchmedo = ["PyYAML (>=3.10)"] [metadata] lock-version = "2.0" python-versions = ">=3.11, <4.0" -content-hash = "462159cd27001312df1e5495287b568c5b07d68e9926372ad0d52f54fddf276c" +content-hash = "dfc1d3d6234166647800583a7f64e544043d6deb6a72a5533de44c45df5009bf" diff --git a/pyproject.toml b/pyproject.toml index 5d0ce9a..a29732f 100644 --- a/pyproject.toml +++ b/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"]} diff --git a/src/issx/clients/redmine.py b/src/issx/clients/redmine.py index 32940d7..ad43c15 100644 --- a/src/issx/clients/redmine.py +++ b/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, ) ) diff --git a/src/issx/domain/config.py b/src/issx/domain/config.py index b1203d4..bbb2a26 100644 --- a/src/issx/domain/config.py +++ b/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) diff --git a/tests/test_config.py b/tests/test_config.py index cfe62a4..a5b0554 100644 --- a/tests/test_config.py +++ b/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'" )