Update to Django 5.0

.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: On push
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # python-version: ['3.9', '3.10', '3.11', '3.12']
+        # django-version: ['django>=3.2,<4.0', 'django>=4.0,<5.0', 'django>=5.0']
+        python-version: ['3.12']
+        django-version: ['django>=5.0']
+        exclude:
+          - python-version: '3.9'
+            django-version: ['django>=5.0']
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install -r requirements_dev.txt
+          pip install '${{ matrix.django-version }}'
+      - name: Run tests
+        run: |
+          make test

.gitignore

@@ -48,6 +48,9 @@ coverage.xml
 *.log
 local_settings.py
 
+# pyenv
+.python-version
+
 # virtualenv
 .venv/
 venv/

docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  postgres:
+    image: postgres
+    ports:
+      - 5432:5432
+    restart: unless-stopped
+    environment:
+      - POSTGRES_DB=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=postgres

pgcrypto/fields.py

@@ -125,11 +125,13 @@ class BooleanPGPSymmetricKeyField(PGPPublicKeyFieldMixin, models.BooleanField):
 class DecimalPGPPublicKeyField(DecimalPGPFieldMixin,
                                PGPPublicKeyFieldMixin, models.DecimalField):
     """Decimal PGP public key encrypted field for postgres."""
+    encrypt_sql = PGP_PUB_ENCRYPT_SQL_WITH_NULLIF
 
 
 class DecimalPGPSymmetricKeyField(DecimalPGPFieldMixin,
                                   PGPSymmetricKeyFieldMixin, models.DecimalField):
     """Decimal PGP symmetric key encrypted field for postgres."""
+    encrypt_sql = PGP_SYM_ENCRYPT_SQL_WITH_NULLIF
 
 
 class FloatPGPPublicKeyField(PGPPublicKeyFieldMixin, models.FloatField):
@@ -154,3 +156,15 @@ class TimePGPSymmetricKeyField(PGPSymmetricKeyFieldMixin, models.TimeField):
     """Float PGP symmetric key encrypted field for postgres."""
     encrypt_sql = PGP_SYM_ENCRYPT_SQL_WITH_NULLIF
     cast_type = 'TIME'
+
+
+class JSONPGPPublicKeyField(PGPPublicKeyFieldMixin, models.JSONField):
+    """JSON PGP public key encrypted field for postgres."""
+    encrypt_sql = PGP_PUB_ENCRYPT_SQL_WITH_NULLIF
+    cast_type = 'jsonb'
+
+
+class JSONPGPSymmetricKeyField(PGPSymmetricKeyFieldMixin, models.JSONField):
+    """Float PGP symmetric key encrypted field for postgres."""
+    encrypt_sql = PGP_SYM_ENCRYPT_SQL_WITH_NULLIF
+    cast_type = 'jsonb'

pgcrypto/mixins.py

@@ -157,7 +157,7 @@ def get_decrypt_sql(self, connection):
 
 class DecimalPGPFieldMixin:
     """Decimal PGP encrypted field mixin for postgres."""
-    cast_type = 'NUMERIC(%(max_digits)s, %(decimal_places)s)'
+    cast_type = 'DECIMAL(%(max_digits)s, %(decimal_places)s)'
 
     def get_cast_sql(self):
         """Get cast sql."""

requirements.txt

@@ -1,2 +1,2 @@
 -e .
-django>=1.11,<3.2
+django>=3.2,<=5.0.2

requirements_dev.txt

@@ -1,16 +1,15 @@
 colour-runner==0.1.1
-coveralls==3.1.0
-coverage==5.5
+coveralls==1.8.0
+coverage==7.4.3
 dj-database-url==0.5.0
-factory-boy==3.2.0
-flake8-docstrings==1.6.0
-flake8-import-order==0.18.1
-flake8==3.9.2
+factory-boy==3.3.0
+flake8-docstrings==1.7.0
+flake8-import-order==0.18.2
+flake8==7.0.0
 incuna-test-utils==8.0.0
-pip==22.3
-psycopg2-binary==2.8.6
-pyflakes==2.3.1
-pycodestyle==2.7.0
-setuptools==65.5.0
-twine==3.4.1
-wheel==0.36.2
+psycopg2-binary==2.9.9
+pyflakes==3.2.0
+pycodestyle==2.11.1
+setuptools==69.1.1
+twine==5.0.0
+wheel==0.42.0

tests/db_setup.py

@@ -0,0 +1,13 @@
+import psycopg2
+
+
+def create_dbs(db_config, databases):
+    """Set up the databases for test."""
+    connection = psycopg2.connect(**db_config)
+    connection.set_isolation_level(psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT)
+    cursor = connection.cursor()
+    for database in databases:
+        cursor.execute(f"DROP DATABASE IF EXISTS {database}")
+        cursor.execute(f"CREATE DATABASE {database}")
+    cursor.close()
+    connection.close()

tests/factories.py

@@ -1,7 +1,9 @@
-from datetime import date, datetime
+from datetime import date
 from decimal import Decimal
 
 import factory
+from django.utils import timezone
+
 
 from .models import EncryptedFKModel, EncryptedModel
 
@@ -28,7 +30,7 @@ class EncryptedModelFactory(factory.django.DjangoModelFactory):
     char_pub_field = factory.Sequence('Text {}'.format)
 
     date_pgp_pub_field = date.today()
-    datetime_pgp_pub_field = datetime.now()
+    datetime_pgp_pub_field = timezone.now()
     decimal_pgp_pub_field = Decimal('123456.78')
     boolean_pgp_pub_field = True
 
@@ -39,9 +41,12 @@ class EncryptedModelFactory(factory.django.DjangoModelFactory):
     char_sym_field = factory.Sequence('Text {}'.format)
 
     date_pgp_sym_field = date.today()
-    datetime_pgp_sym_field = datetime.now()
+    datetime_pgp_sym_field = timezone.now()
     boolean_pgp_sym_field = False
 
+    json_pgp_pub_field = {"key": "value"}
+    json_pgp_sym_field = {"key": "value"}
+
     fk_model = factory.SubFactory(EncryptedFKModelFactory)
 
     class Meta:

tests/models.py

@@ -59,6 +59,9 @@ class EncryptedModel(models.Model):
     float_pgp_sym_field = fields.FloatPGPSymmetricKeyField(blank=True, null=True)
     boolean_pgp_sym_field = fields.BooleanPGPSymmetricKeyField(blank=True, null=True)
 
+    json_pgp_pub_field = fields.JSONPGPPublicKeyField(blank=True, null=True)
+    json_pgp_sym_field = fields.JSONPGPSymmetricKeyField(blank=True, null=True)
+
     fk_model = models.ForeignKey(
         EncryptedFKModel, blank=True, null=True, on_delete=models.CASCADE
     )

tests/run.py

@@ -9,6 +9,23 @@
 from django.conf import settings
 from django.test.runner import DiscoverRunner
 
+print("Current directory:", os.getcwd())
+print("Contents of the directory:", os.listdir(os.getcwd()))
+print("Contents of the directory of run.py:", os.listdir(os.chdir(os.path.dirname(os.path.abspath(__file__)))))
+
+from db_setup import create_dbs
+
+default_db_config = {
+    'dbname': 'postgres',
+    'user': 'postgres',
+    'password': 'postgres',
+    'host': 'localhost',
+    'port': 5432,
+}
+
+create_dbs(default_db_config,
+                    databases=('pgcrypto_fields', 'pgcrypto_fields_diff'))
+
 BASEDIR = os.path.dirname(os.path.dirname(__file__))
 PUBLIC_PGP_KEY_PATH = os.path.abspath(
     os.path.join(BASEDIR, 'tests/keys/public.key')
@@ -24,7 +41,7 @@
 )
 
 diff_keys = dj_database_url.config(
-    default='postgres://localhost/pgcrypto_fields_diff'
+    default='postgres://postgres:postgres@localhost/pgcrypto_fields_diff'
 )
 
 # Cannot chain onto the config() call due to error
@@ -37,7 +54,7 @@
 settings.configure(
     DATABASES={
         'default': dj_database_url.config(
-            default='postgres://localhost/pgcrypto_fields'
+            default='postgres://postgres:postgres@localhost/pgcrypto_fields'
         ),
         'diff_keys': diff_keys,
     },
@@ -52,6 +69,8 @@
     PRIVATE_PGP_KEY=open(PRIVATE_PGP_KEY_PATH, 'r').read(),
     PGCRYPTO_KEY='ultrasecret',
     DEBUG=True,
+    DEFAULT_AUTO_FIELD='django.db.models.BigAutoField',
+    USE_TZ=True,
 )
 django.setup()