Merge pull request #87 from browniebroke/ci/setup-gh-actions

Bootstrap test infrastructure and add a very basic test

Author: FlipperPA

.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: pre-commit/[email protected]
+      - uses: pre-commit-ci/[email protected]
+        if: always()
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install tox
+      - run: tox -f py$(echo ${{ matrix.python-version }} | tr -d .)

.gitignore

@@ -33,3 +33,4 @@ Desktop.ini
 
 # Coverage
 htmlcov/
+.coverage

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

README.md

@@ -56,7 +56,7 @@ To upgrade to `drf_excel` 2.0.0 from `drf_renderer_xlsx`, update your import pat
 * `drf_renderer_xlsx.renderers.XLSXRenderer` becomes `drf_excel.renderers.XLSXRenderer`.
 * `xlsx_date_format_mappings` has been removed in favor of `column_data_styles` which provides more flexibility
 
-## Configuring Styles 
+## Configuring Styles
 
 Styles can be added to your worksheet header, column header row, body and column data from view attributes `header`, `column_header`, `body`, `column_data_styles`. Any arguments from [the OpenPyXL package](https://openpyxl.readthedocs.io/en/stable/styles.html) can be used for font, alignment, fill and border_side (border will always be all side of cell).
 
@@ -148,7 +148,7 @@ def get_header(self):
     datetime_format = "%H:%M:%S %d.%m.%Y"
     return {
         'tab_title': 'MyReport', # title of tab/workbook
-        'use_header': True,  # show the header_title 
+        'use_header': True,  # show the header_title
         'header_title': 'Report from {} to {}'.format(
             start_time.strftime(datetime_format),
             end_time.strftime(datetime_format),
@@ -200,7 +200,7 @@ They can be set in the view as a property `sheet_view_options`:
 ```python
 class MyExampleViewSet(serializers.Serializer):
     sheet_view_options = {
-        'rightToLeft': True, 
+        'rightToLeft': True,
         'showGridLines': False
     }
 ```
@@ -209,18 +209,18 @@ or using method `get_sheet_view_options`:
 
 ```python
 class MyExampleViewSet(serializers.Serializer):
-    
+
     def get_sheet_view_options(self):
         return {
-            'rightToLeft': True, 
+            'rightToLeft': True,
             'showGridLines': False
         }
 ```
 ## Controlling XLSX headers and values
 
 ### Use Serializer Field labels as header names
 
-By default, headers will use the same 'names' as they are returned by the API. This can be changed by setting `xlsx_use_labels = True` inside your API View. 
+By default, headers will use the same 'names' as they are returned by the API. This can be changed by setting `xlsx_use_labels = True` inside your API View.
 
 Instead of using the field names, the export will use the labels as they are defined inside your Serializer. A serializer field defined as `title = serializers.CharField(label=_("Some title"))` would return `Some title` instead of `title`, also supporting translations. If no label is set, it will fall back to using `title`.
 
@@ -248,9 +248,9 @@ DRF_EXCEL_DECIMAL_FORMAT = '0.00E+00'
 
 ### Name boolean values
 
-`True` and `False` as values for boolean fields are not always the best representation and don't support translation. 
+`True` and `False` as values for boolean fields are not always the best representation and don't support translation.
 
-This can be controlled with in you API view with `xlsx_boolean_labels`. 
+This can be controlled with in you API view with `xlsx_boolean_labels`.
 
 ```
 xlsx_boolean_labels = {True: _('Yes'), False: _('No')}
@@ -282,7 +282,7 @@ def custom_value_formatter(val):
     return val + '!!!'
 
 ### Example response:
-{ 
+{
     results: [
         {
             title: 'XLSX renderer',

drf_excel/renderers.py

@@ -232,7 +232,7 @@ def _save_virtual_workbook(self, wb):
         with TemporaryFile() as tmp:
             save_workbook(wb, tmp)
             tmp.seek(0)
-            virtual_workbook = tmp.read()        
+            virtual_workbook = tmp.read()
 
         return virtual_workbook
 
@@ -380,7 +380,7 @@ def _drf_to_xlsx_field(self, key, value) -> XLSXField:
         elif isinstance(field, (IntegerField, FloatField, DecimalField)):
             return XLSXNumberField(**kwargs)
         elif isinstance(field, (DateTimeField, DateField, TimeField)):
-            return XLSXDateField(**kwargs)        
+            return XLSXDateField(**kwargs)
         elif (
             isinstance(field, ListField)
             or isinstance(value, Iterable)

tests/__init__.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+SECRET_KEY = "NOTASECRET"  # noqa S105
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":memory:",
+        "ATOMIC_REQUESTS": True,
+    },
+}
+
+USE_TZ = True
+TIME_ZONE = "UTC"
+
+INSTALLED_APPS = [
+    "django.contrib.auth",
+    "django.contrib.admin",
+    "django.contrib.contenttypes",
+    "rest_framework",
+    "tests.testapp",
+]
+
+REST_FRAMEWORK = {
+    "DEFAULT_RENDERER_CLASSES": (
+        "rest_framework.renderers.JSONRenderer",
+        "rest_framework.renderers.BrowsableAPIRenderer",
+        "drf_excel.renderers.XLSXRenderer",
+    ),
+}

tests/settings.py

@@ -0,0 +1,5 @@
+from drf_excel.utilities import get_setting
+
+
+def test_get_setting_not_found():
+    assert get_setting("INTEGER_FORMAT") is None

tests/test_utilities.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class TestAppConfig(AppConfig):
+    name = "tests.testapp"
+    verbose_name = "Test App"

tests/testapp/__init__.py

@@ -0,0 +1,22 @@
+[tox]
+envlist =
+    py{38,39,310,311}-dj42
+    py{310,311,312}-dj50
+    py{310,311,312}-dj51
+skipsdist = True
+
+[testenv]
+deps =
+    dj42: Django>=4.2,<5.0
+    dj50: Django>=5.0,<5.1
+    dj51: Django>=5.1,<5.2
+
+    djangorestframework
+    openpyxl
+
+    pytest
+    pytest-django
+    pytest-cov
+    django-coverage-plugin
+
+commands = {posargs:python -m pytest}