Merge pull request #2 from jamaalscarlett/add_ruff_formatting

Run black and ruff formatters

Author: jamaalscarlett

.github/workflows/tests.yml

@@ -6,7 +6,7 @@ on:
     branches: [ master ]
     paths:
       - '**.py'
-      - 'run_tests.sh'
+      - 'download_vault.sh'
       - 'tox.ini'
       - 'requirements.txt'
       - 'pyproject.toml'
@@ -35,18 +35,18 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install uv
+        pip install uv ruff
+    - name: Run Ruff
+      run: ruff check .        
     - name: Install tox
       run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv
     - name: Install Python
       if: startsWith(matrix.env, '3.') && matrix.env != '3.13'
       run: uv python install --python-preference only-managed ${{ matrix.env }}
     - name: Make test script executable
-      run: chmod +x ./run_tests.sh
+      run: chmod +x ./download_vault.sh
     - name: Run test script
-#      env:
-#        PATH: "root/.local/bin:/root/.local/bin:/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
-      run: ./run_tests.sh
+      run: ./download_vault.sh
     - name: Run test suite vault 1.16.3
       run: tox run --skip-pkg-install -e py${{ matrix.env }}-vault1163
     - name: Run test suite vault 1.17.6

Dockerfile

@@ -1,16 +1,17 @@
 FROM python:3.12-slim-bullseye
 
-COPY run_tests.sh /run_tests.sh
+COPY download_vault.sh /download_vault.sh
+COPY docker_tests.sh /docker_tests.sh
 COPY async_hvac/ /src/async_hvac/
 COPY test/ /src/test/
 COPY tox.ini /src/
 COPY requirements-dev.txt /src/
 
 RUN apt update
 RUN apt install -y wget zip gcc
-RUN pip install uv tox
+RUN pip install uv
 RUN uv tool install tox --with tox-uv
 ENV PATH=/root/.local/bin:$PATH
 WORKDIR /src
 
-CMD ["/run_tests.sh"]
+CMD ["/docker_tests.sh"]

Makefile

@@ -1,6 +1,15 @@
-test: version
+SHELL := /bin/bash
+
+test: version download_vault
 	tox
 
+download_vault:
+	if [[ ! -f "/tmp/async-hvac/vault_1.16.3" || \
+	      ! -f "/tmp/async-hvac/vault_1.17.6" || \
+	      ! -f "/tmp/async-hvac/vault_1.18.3" ]]; then \
+		./download_vault.sh; \
+	fi
+
 version:
 	cp version async_hvac/version
 

async_hvac/__init__.py

@@ -11,27 +11,35 @@ def wrapper(*args, **kwargs):
             return f(*args, **kwargs)
         coro = coroutine(f)
         future = coro(*args, **kwargs)
-        return self._executor.submit(
-            self._loop.run_until_complete,
-            future).result()
+        return self._executor.submit(self._loop.run_until_complete, future).result()
+
     return wrapper
 
 
 # Just for test and try and do not work properly in some cases... not part of the Async API
 class Client(AsyncClient):
 
-    def __init__(self, url='http://127.0.0.1:8200', token=None,
-                 cert=None, verify=True, timeout=30, proxies=None,
-                 allow_redirects=True, session=None, sync=True,
-                 loop=None):
+    def __init__(
+        self,
+        url="http://127.0.0.1:8200",
+        token=None,
+        cert=None,
+        verify=True,
+        timeout=30,
+        proxies=None,
+        allow_redirects=True,
+        session=None,
+        sync=True,
+        loop=None,
+    ):
         super(Client, self).__init__(
-            url, token, cert, verify, timeout,
-            proxies, allow_redirects, session, loop)
+            url, token, cert, verify, timeout, proxies, allow_redirects, session, loop
+        )
         self._sync = sync
         if sync:
             for attr in AsyncClient.__dict__:
                 attr_obj = getattr(AsyncClient, attr)
-                if callable(attr_obj) and not attr.startswith('_'):
+                if callable(attr_obj) and not attr.startswith("_"):
                     setattr(self, attr, async_to_sync(self, getattr(self, attr)))
             self._executor = concurrent.futures.ThreadPoolExecutor(
                 max_workers=3,
@@ -48,37 +56,37 @@ def seal_status(self):
         if not self._sync or self._loop.is_running():
             return super(Client, self).seal_status
         return self._executor.submit(
-            self._loop.run_until_complete,
-            super(Client, self).seal_status).result()
+            self._loop.run_until_complete, super(Client, self).seal_status
+        ).result()
 
     @property
     def generate_root_status(self):
         if not self._sync or self._loop.is_running():
             return super(Client, self).generate_root_status
         return self._executor.submit(
-            self._loop.run_until_complete,
-            super(Client, self).generate_root_status).result()
+            self._loop.run_until_complete, super(Client, self).generate_root_status
+        ).result()
 
     @property
     def key_status(self):
         if not self._sync or self._loop.is_running():
             return super(Client, self).key_status
         return self._executor.submit(
-            self._loop.run_until_complete,
-            super(Client, self).key_status).result()
+            self._loop.run_until_complete, super(Client, self).key_status
+        ).result()
 
     @property
     def rekey_status(self):
         if not self._sync or self._loop.is_running():
             return super(Client, self).rekey_status
         return self._executor.submit(
-            self._loop.run_until_complete,
-            super(Client, self).rekey_status).result()
+            self._loop.run_until_complete, super(Client, self).rekey_status
+        ).result()
 
     @property
     def ha_status(self):
         if not self._sync or self._loop.is_running():
             return super(Client, self).ha_status
         return self._executor.submit(
-            self._loop.run_until_complete,
-            super(Client, self).ha_status).result()
+            self._loop.run_until_complete, super(Client, self).ha_status
+        ).result()

async_hvac/aws_utils.py

@@ -11,34 +11,45 @@ def __init__(self, access_key, secret_key, session_token=None):
 
     def add_auth(self, method, headers, body):
         if body:
-            headers['Content-Length'] = str(len(body))
-        timestamp = datetime.utcnow().strftime('%Y%m%dT%H%M%SZ')
-        headers['X-Amz-Date'] = timestamp
+            headers["Content-Length"] = str(len(body))
+        timestamp = datetime.utcnow().strftime("%Y%m%dT%H%M%SZ")
+        headers["X-Amz-Date"] = timestamp
 
         if self.session_token:
-            headers['X-Amz-Security-Token'] = self.session_token
+            headers["X-Amz-Security-Token"] = self.session_token
 
         # https://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html
-        canonical_headers = ''.join('{0}:{1}\n'.format(k.lower(), headers[k]) for k in sorted(headers))
-        signed_headers = ';'.join(k.lower() for k in sorted(headers))
-        payload_hash = sha256(body.encode('utf-8')).hexdigest()
-        canonical_request = '\n'.join([method, '/', '', canonical_headers, signed_headers, payload_hash])
+        canonical_headers = "".join(
+            "{0}:{1}\n".format(k.lower(), headers[k]) for k in sorted(headers)
+        )
+        signed_headers = ";".join(k.lower() for k in sorted(headers))
+        payload_hash = sha256(body.encode("utf-8")).hexdigest()
+        canonical_request = "\n".join(
+            [method, "/", "", canonical_headers, signed_headers, payload_hash]
+        )
 
         # https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html
-        algorithm = 'AWS4-HMAC-SHA256'
-        credential_scope = '/'.join([timestamp[0:8], 'us-east-1', 'sts', 'aws4_request'])
-        canonical_request_hash = sha256(canonical_request.encode('utf-8')).hexdigest()
-        string_to_sign = '\n'.join([algorithm, timestamp, credential_scope, canonical_request_hash])
+        algorithm = "AWS4-HMAC-SHA256"
+        credential_scope = "/".join(
+            [timestamp[0:8], "us-east-1", "sts", "aws4_request"]
+        )
+        canonical_request_hash = sha256(canonical_request.encode("utf-8")).hexdigest()
+        string_to_sign = "\n".join(
+            [algorithm, timestamp, credential_scope, canonical_request_hash]
+        )
 
         # https://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html
-        key = 'AWS4{0}'.format(self.secret_key).encode('utf-8')
-        key = hmac.new(key, timestamp[0:8].encode('utf-8'), sha256).digest()
-        key = hmac.new(key, 'us-east-1'.encode('utf-8'), sha256).digest()
-        key = hmac.new(key, 'sts'.encode('utf-8'), sha256).digest()
-        key = hmac.new(key, 'aws4_request'.encode('utf-8'), sha256).digest()
-        signature = hmac.new(key, string_to_sign.encode('utf-8'), sha256).hexdigest()
+        key = "AWS4{0}".format(self.secret_key).encode("utf-8")
+        key = hmac.new(key, timestamp[0:8].encode("utf-8"), sha256).digest()
+        key = hmac.new(key, "us-east-1".encode("utf-8"), sha256).digest()
+        key = hmac.new(key, "sts".encode("utf-8"), sha256).digest()
+        key = hmac.new(key, "aws4_request".encode("utf-8"), sha256).digest()
+        signature = hmac.new(key, string_to_sign.encode("utf-8"), sha256).hexdigest()
 
         # https://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html
-        authorization = '{0} Credential={1}/{2}, SignedHeaders={3}, Signature={4}'.format(
-            algorithm, self.access_key, credential_scope, signed_headers, signature)
-        headers['Authorization'] = authorization
+        authorization = (
+            "{0} Credential={1}/{2}, SignedHeaders={3}, Signature={4}".format(
+                algorithm, self.access_key, credential_scope, signed_headers, signature
+            )
+        )
+        headers["Authorization"] = authorization

async_hvac/exceptions.py

@@ -1,7 +1,7 @@
 class VaultError(Exception):
     def __init__(self, message=None, errors=None):
         if errors:
-            message = ', '.join(errors)
+            message = ", ".join(errors)
 
         self.errors = errors