dabocs · skamansam · Jul 6, 2023 · Jul 6, 2023 · Jul 6, 2023 · Jul 6, 2023
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,20 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
diff --git a/.github/workflows/linty.yml b/.github/workflows/linty.yml
@@ -0,0 +1,26 @@
+name: Lint
+
+on:
+  push:
+    paths:
+      - '*.py'
+
+jobs:
+  flake8_py3:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.11.4
+          architecture: x64
+      - name: Checkout PyTorch
+        uses: actions/checkout@master
+      - name: Install flake8
+        run: pip install flake8
+      - name: Run flake8
+        uses: suo/flake8-github-action@releases/v1
+        with:
+          checkName: 'flake8_py3'   # NOTE: this needs to be the same as the job name
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.travis.yml b/.travis.yml
@@ -8,6 +8,7 @@ env:
   - DJANGO_VERSION=1.11
   - DJANGO_VERSION=2.0
   - DJANGO_VERSION=4.1
+  - DJANGO_VERSION=4.2
 addons:
     sonarcloud:
       organization: $SC_ORG

diff --git a/Makefile b/Makefile
@@ -1,18 +1,18 @@
 install-python:
-	pip install --upgrade setuptools
-	pip install -e .
-	pip install "file://`pwd`#egg=django-keycloak[dev,doc]"
+	# pyenv virtualenv 3.11.4 django-keycloak || pyenv activate django-keycloak
+	pip install --upgrade setuptools poethepoet
+	poe install
+	poe addsudo  "file://`pwd`#egg=django-keycloak[dev,doc]"
 
 bump-patch:
-	bumpversion patch
+	poetry version patch
 
 bump-minor:
-	bumpversion minor
+	poetry version minor
 
 deploy-pypi: clear
-	python3 -c "import sys; sys.version_info >= (3, 5, 3) or sys.stdout.write('Python version must be greatest then 3.5.2\n') or exit(1)"
-	python3 setup.py sdist bdist_wheel
-	twine upload dist/*
+	poetry build
+	poetry publish
 
 clear:
 	rm -rf dist/*
diff --git a/README.rst b/README.rst
@@ -2,17 +2,17 @@
 Django Keycloak
 ===============
 
-.. image:: https://www.travis-ci.org/Peter-Slump/django-keycloak.svg?branch=master
-   :target: https://www.travis-ci.org/Peter-Slump/django-keycloak
+.. image:: https://www.travis-ci.org/skamansam/django-keycloak.svg?branch=master
+   :target: https://www.travis-ci.org/skamansam/django-keycloak
    :alt: Build Status
 .. image:: https://readthedocs.org/projects/django-keycloak/badge/?version=latest
    :target: http://django-keycloak.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
-.. image:: https://codecov.io/gh/Peter-Slump/django-keycloak/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/Peter-Slump/django-keycloak
+.. image:: https://codecov.io/gh/skamansam/django-keycloak/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/skamansam/django-keycloak
    :alt: codecov
 .. image:: https://api.codeclimate.com/v1/badges/eb19f47dc03dec40cea7/maintainability
-   :target: https://codeclimate.com/github/Peter-Slump/django-keycloak/maintainability
+   :target: https://codeclimate.com/github/skamansam/django-keycloak/maintainability
    :alt: Maintainability
 
 Django app to add Keycloak  support to your project.
@@ -72,6 +72,7 @@ Release Notes
 =============
 
 **unreleased**
+**v0.1.2**
 
 **v0.2.5**
 

diff --git a/src/django_keycloak/__init__.py → django_keycloak/__init__.py b/src/django_keycloak/__init__.py → django_keycloak/__init__.py
diff --git a/src/django_keycloak/admin/__init__.py → django_keycloak/admin/__init__.py b/src/django_keycloak/admin/__init__.py → django_keycloak/admin/__init__.py
diff --git a/src/django_keycloak/admin/realm.py → django_keycloak/admin/realm.py b/src/django_keycloak/admin/realm.py → django_keycloak/admin/realm.py
diff --git a/src/django_keycloak/admin/server.py → django_keycloak/admin/server.py b/src/django_keycloak/admin/server.py → django_keycloak/admin/server.py
diff --git a/src/django_keycloak/app_settings.py → django_keycloak/app_settings.py b/src/django_keycloak/app_settings.py → django_keycloak/app_settings.py
diff --git a/src/django_keycloak/apps.py → django_keycloak/apps.py b/src/django_keycloak/apps.py → django_keycloak/apps.py
diff --git a/src/django_keycloak/auth/__init__.py → django_keycloak/auth/__init__.py b/src/django_keycloak/auth/__init__.py → django_keycloak/auth/__init__.py
diff --git a/src/django_keycloak/auth/backends.py → django_keycloak/auth/backends.py b/src/django_keycloak/auth/backends.py → django_keycloak/auth/backends.py
diff --git a/src/django_keycloak/factories.py → django_keycloak/factories.py b/src/django_keycloak/factories.py → django_keycloak/factories.py
diff --git a/src/django_keycloak/hashers.py → django_keycloak/hashers.py b/src/django_keycloak/hashers.py → django_keycloak/hashers.py
diff --git a/src/django_keycloak/management/__init__.py → django_keycloak/management/__init__.py b/src/django_keycloak/management/__init__.py → django_keycloak/management/__init__.py
diff --git a/..._keycloak/management/commands/__init__.py → ..._keycloak/management/commands/__init__.py b/..._keycloak/management/commands/__init__.py → ..._keycloak/management/commands/__init__.py
diff --git a/.../management/commands/keycloak_add_user.py → .../management/commands/keycloak_add_user.py b/.../management/commands/keycloak_add_user.py → .../management/commands/keycloak_add_user.py
diff --git a/...gement/commands/keycloak_refresh_realm.py → ...gement/commands/keycloak_refresh_realm.py b/...gement/commands/keycloak_refresh_realm.py → ...gement/commands/keycloak_refresh_realm.py
diff --git a/...ement/commands/keycloak_sync_resources.py → ...ement/commands/keycloak_sync_resources.py b/...ement/commands/keycloak_sync_resources.py → ...ement/commands/keycloak_sync_resources.py
diff --git a/src/django_keycloak/middleware.py → django_keycloak/middleware.py b/src/django_keycloak/middleware.py → django_keycloak/middleware.py
diff --git a/...jango_keycloak/migrations/0001_initial.py → django_keycloak/migrations/0001_initial.py b/...jango_keycloak/migrations/0001_initial.py → django_keycloak/migrations/0001_initial.py
diff --git a/...oak/migrations/0002_auto_20180322_2059.py → ...oak/migrations/0002_auto_20180322_2059.py b/...oak/migrations/0002_auto_20180322_2059.py → ...oak/migrations/0002_auto_20180322_2059.py
diff --git a/...oak/migrations/0003_auto_20190204_1949.py → ...oak/migrations/0003_auto_20190204_1949.py b/...oak/migrations/0003_auto_20190204_1949.py → ...oak/migrations/0003_auto_20190204_1949.py
diff --git a/...ns/0004_client_service_account_profile.py → ...ns/0004_client_service_account_profile.py b/...ns/0004_client_service_account_profile.py → ...ns/0004_client_service_account_profile.py
diff --git a/...oak/migrations/0005_auto_20190219_2002.py → ...oak/migrations/0005_auto_20190219_2002.py b/...oak/migrations/0005_auto_20190219_2002.py → ...oak/migrations/0005_auto_20190219_2002.py
diff --git a/...ons/0006_remove_client_service_account.py → ...ons/0006_remove_client_service_account.py b/...ons/0006_remove_client_service_account.py → ...ons/0006_remove_client_service_account.py
diff --git a/...nt_id_alter_exchangedtoken_id_and_more.py → ...nt_id_alter_exchangedtoken_id_and_more.py b/...nt_id_alter_exchangedtoken_id_and_more.py → ...nt_id_alter_exchangedtoken_id_and_more.py
diff --git a/src/django_keycloak/migrations/__init__.py → django_keycloak/migrations/__init__.py b/src/django_keycloak/migrations/__init__.py → django_keycloak/migrations/__init__.py
diff --git a/src/django_keycloak/models.py → django_keycloak/models.py b/src/django_keycloak/models.py → django_keycloak/models.py
diff --git a/src/django_keycloak/remote_user.py → django_keycloak/remote_user.py b/src/django_keycloak/remote_user.py → django_keycloak/remote_user.py
diff --git a/src/django_keycloak/response.py → django_keycloak/response.py b/src/django_keycloak/response.py → django_keycloak/response.py
diff --git a/src/django_keycloak/services/__init__.py → django_keycloak/services/__init__.py b/src/django_keycloak/services/__init__.py → django_keycloak/services/__init__.py
diff --git a/src/django_keycloak/services/client.py → django_keycloak/services/client.py b/src/django_keycloak/services/client.py → django_keycloak/services/client.py
diff --git a/src/django_keycloak/services/exceptions.py → django_keycloak/services/exceptions.py b/src/django_keycloak/services/exceptions.py → django_keycloak/services/exceptions.py
diff --git a/src/django_keycloak/services/oidc_profile.py → django_keycloak/services/oidc_profile.py b/src/django_keycloak/services/oidc_profile.py → django_keycloak/services/oidc_profile.py
diff --git a/src/django_keycloak/services/permissions.py → django_keycloak/services/permissions.py b/src/django_keycloak/services/permissions.py → django_keycloak/services/permissions.py
diff --git a/src/django_keycloak/services/realm.py → django_keycloak/services/realm.py b/src/django_keycloak/services/realm.py → django_keycloak/services/realm.py
diff --git a/...django_keycloak/services/remote_client.py → django_keycloak/services/remote_client.py b/...django_keycloak/services/remote_client.py → django_keycloak/services/remote_client.py
diff --git a/src/django_keycloak/services/uma.py → django_keycloak/services/uma.py b/src/django_keycloak/services/uma.py → django_keycloak/services/uma.py
diff --git a/src/django_keycloak/services/users.py → django_keycloak/services/users.py b/src/django_keycloak/services/users.py → django_keycloak/services/users.py
diff --git a/...loak/includes/session_iframe_support.html → ...loak/includes/session_iframe_support.html b/...loak/includes/session_iframe_support.html → ...loak/includes/session_iframe_support.html
diff --git a/...lates/django_keycloak/session_iframe.html → ...lates/django_keycloak/session_iframe.html b/...lates/django_keycloak/session_iframe.html → ...lates/django_keycloak/session_iframe.html
diff --git a/src/django_keycloak/tests/__init__.py → django_keycloak/tests/__init__.py b/src/django_keycloak/tests/__init__.py → django_keycloak/tests/__init__.py
diff --git a/...jango_keycloak/tests/backends/__init__.py → django_keycloak/tests/backends/__init__.py b/...jango_keycloak/tests/backends/__init__.py → django_keycloak/tests/backends/__init__.py
diff --git a/...s/keycloak_authorization_base/__init__.py → ...s/keycloak_authorization_base/__init__.py b/...s/keycloak_authorization_base/__init__.py → ...s/keycloak_authorization_base/__init__.py
diff --git a/...ion_base/test_get_keycloak_permissions.py → ...ion_base/test_get_keycloak_permissions.py b/...ion_base/test_get_keycloak_permissions.py → ...ion_base/test_get_keycloak_permissions.py
diff --git a/...cloak_authorization_base/test_has_perm.py → ...cloak_authorization_base/test_has_perm.py b/...cloak_authorization_base/test_has_perm.py → ...cloak_authorization_base/test_has_perm.py
diff --git a/src/django_keycloak/tests/mixins.py → django_keycloak/tests/mixins.py b/src/django_keycloak/tests/mixins.py → django_keycloak/tests/mixins.py
diff --git a/...jango_keycloak/tests/services/__init__.py → django_keycloak/tests/services/__init__.py b/...jango_keycloak/tests/services/__init__.py → django_keycloak/tests/services/__init__.py
diff --git a/...k/tests/services/oidc_profile/__init__.py → ...k/tests/services/oidc_profile/__init__.py b/...k/tests/services/oidc_profile/__init__.py → ...k/tests/services/oidc_profile/__init__.py
diff --git a/...c_profile/test_get_active_access_token.py → ...c_profile/test_get_active_access_token.py b/...c_profile/test_get_active_access_token.py → ...c_profile/test_get_active_access_token.py
diff --git a/...ices/oidc_profile/test_get_entitlement.py → ...ices/oidc_profile/test_get_entitlement.py b/...ices/oidc_profile/test_get_entitlement.py → ...ices/oidc_profile/test_get_entitlement.py
diff --git a/...ofile/test_get_or_create_from_id_token.py → ...ofile/test_get_or_create_from_id_token.py b/...ofile/test_get_or_create_from_id_token.py → ...ofile/test_get_or_create_from_id_token.py
diff --git a/...ces/oidc_profile/test_update_or_create.py → ...ces/oidc_profile/test_update_or_create.py b/...ces/oidc_profile/test_update_or_create.py → ...ces/oidc_profile/test_update_or_create.py
diff --git a/...keycloak/tests/services/realm/__init__.py → ...keycloak/tests/services/realm/__init__.py b/...keycloak/tests/services/realm/__init__.py → ...keycloak/tests/services/realm/__init__.py
diff --git a/...rvices/realm/test_get_realm_api_client.py → ...rvices/realm/test_get_realm_api_client.py b/...rvices/realm/test_get_realm_api_client.py → ...rvices/realm/test_get_realm_api_client.py
diff --git a/...ces/realm/test_refresh_well_known_oidc.py → ...ces/realm/test_refresh_well_known_oidc.py b/...ces/realm/test_refresh_well_known_oidc.py → ...ces/realm/test_refresh_well_known_oidc.py
diff --git a/src/django_keycloak/tests/settings.py → django_keycloak/tests/settings.py b/src/django_keycloak/tests/settings.py → django_keycloak/tests/settings.py
diff --git a/src/django_keycloak/urls.py → django_keycloak/urls.py b/src/django_keycloak/urls.py → django_keycloak/urls.py
diff --git a/src/django_keycloak/views.py → django_keycloak/views.py b/src/django_keycloak/views.py → django_keycloak/views.py
diff --git a/example/docker-compose.yml → docker-compose.yml b/example/docker-compose.yml → docker-compose.yml
@@ -22,27 +22,42 @@ services:
       - resource-provider-api
 
   keycloak:
-    image: jboss/keycloak:3.4.3.Final         # Pinned to 3.4.3 because this is currently the latest version which has commercial support from Red Hat: https://www.keycloak.org/support.html
+    # build: ./keycloak
+    image: quay.io/keycloak/keycloak:latest
     command: [
-      "-b", "0.0.0.0",
-      "-Dkeycloak.migration.action=import",   # Replace with 'export' in order to export everything
-      "-Dkeycloak.migration.provider=dir",
-      "-Dkeycloak.migration.dir=/opt/jboss/keycloak/standalone/configuration/export/",
-      "-Dkeycloak.migration.strategy=IGNORE_EXISTING"
+      "start-dev",
+      # "--help",
+      # "-b", "0.0.0.0",
+      "--import-realm",
+      "--log-level=debug",
+      "--metrics-enabled=true",
+      "--db=postgres",
+      "--db-url=postgres:5432",
+      "--db-username=keycloak",
+      "--db-password=keycloak",
+      "--db-schema=keycloak",
+      # "--verbose",
+      # "-Dkeycloak.migration.action=import",   # Replace with 'export' in order to export everything
+      # "-Dkeycloak.migration.provider=dir",
+      # "-Dkeycloak.migration.dir=/opt/keycloak/data/import",
+      # "-Dkeycloak.migration.strategy=IGNORE_EXISTING"
     ]
     environment:
-      - POSTGRES_DATABASE=keycloak
-      - POSTGRES_USER=keycloak
-      - POSTGRES_PASSWORD=password
+      - KC_METRICS_ENABLED=true
+      # - POSTGRES_DATABASE=keycloak
+      # - POSTGRES_USER=keycloak
+      # - POSTGRES_PASSWORD=password
       - KEYCLOAK_HOSTNAME=identity.localhost.yarf.nl
-      # Legacy linking functionality is used
-      - POSTGRES_PORT_5432_TCP_ADDR=postgres
-      - POSTGRES_PORT_5432_TCP_PORT=5432
+      # # Legacy linking functionality is used
+      # - POSTGRES_PORT_5432_TCP_ADDR=postgres
+      # - POSTGRES_PORT_5432_TCP_PORT=5432
       - PROXY_ADDRESS_FORWARDING=true
       - KEYCLOAK_LOGLEVEL=DEBUG
-#      - JAVA_TOOL_OPTIONS=-Dkeycloak.profile.feature.admin_fine_grained_authz=enabled -Dkeycloak.profile.feature.token_exchange=enabled  # Required to enable Token exchange feature in newer versions of Keycloak
+      # - KEYCLOAK_ADMIN=admin
+      # - KEYCLOAK_ADMIN_PASSWORD=admin
+      # # - JAVA_TOOL_OPTIONS=-Dkeycloak.profile.feature.admin_fine_grained_authz=enabled -Dkeycloak.profile.feature.token_exchange=enabled  # Required to enable Token exchange feature in newer versions of Keycloak
     volumes:
-      - ./keycloak/export:/opt/jboss/keycloak/standalone/configuration/export
+      - ./keycloak/export:/opt/keycloak/data/import/
     networks:
       default:
         aliases:

diff --git a/docs/index.rst b/docs/index.rst
@@ -41,7 +41,7 @@ Install requirement.
 
 .. code-block:: bash
 
-    $ pip install git+https://github.com/Peter-Slump/django-keycloak.git
+    $ pip install git+https://github.com/skamansam/django-keycloak.git
 
 Setup
 =====
@@ -85,7 +85,7 @@ add the middleware, configure the urls and point to the correct login page.
     urlpatterns = [
         ...
 
-        url(r'^keycloak/', include('django_keycloak.urls')),
+        path('keycloak/', include('django_keycloak.urls')),
     ]
 
 

diff --git a/example/keycloak/Dockerfile b/example/keycloak/Dockerfile
@@ -0,0 +1,24 @@
+FROM quay.io/keycloak/keycloak:latest as builder
+
+# Enable health and metrics support
+# ENV KC_HEALTH_ENABLED=true
+# ENV KC_METRICS_ENABLED=true
+
+# Configure a database vendor
+# ENV KC_DB=postgres
+
+WORKDIR /opt/keycloak
+# for demonstration purposes only, please make sure to use proper certificates in production instead
+RUN keytool -genkeypair -storepass password -storetype PKCS12 -keyalg RSA -keysize 2048 -dname "CN=server" -alias server -ext "SAN:c=DNS:localhost,IP:127.0.0.1" -keystore conf/server.keystore
+RUN /opt/keycloak/bin/kc.sh build
+
+FROM quay.io/keycloak/keycloak:latest
+COPY --from=builder /opt/keycloak/ /opt/keycloak/
+
+# change these values to point to a running postgres instance
+# ENV KC_DB=postgres
+# ENV KC_DB_URL=localhost:5432
+# ENV KC_DB_USERNAME=admin
+# ENV KC_DB_PASSWORD=admin
+# ENV KC_HOSTNAME=localhost
+ENTRYPOINT ["/opt/keycloak/bin/kc.sh"]
diff --git a/example/resource-provider-api/Dockerfile b/example/resource-provider-api/Dockerfile
@@ -1,15 +1,14 @@
-FROM python:3-alpine
+FROM python:3.11.4-alpine
 
 RUN apk update \
-   && apk add git openssl-dev libffi-dev python-dev build-base
+   && apk add git openssl-dev libffi-dev build-base \
+   && pip install poethepoet poetry
 
-RUN mkdir -p /usr/src/app
+COPY ./poetry.lock ./pyproject.toml /usr/src/app/
 
 WORKDIR /usr/src/app
 
-COPY requirements.txt /usr/src/app/
-
-RUN pip install --no-cache-dir -r requirements.txt
+RUN poetry install
 
 COPY . /usr/src/app
 

diff --git a/example/resource-provider-api/myapp/urls.py b/example/resource-provider-api/myapp/urls.py
@@ -13,14 +13,14 @@
     1. Import the include() function: from django.conf.urls import url, include
     2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
 """
-from django.conf.urls import url, include
+from django.urls import include, path
 from django.contrib import admin
 
 from myapp import views
 
 
 urlpatterns = [
-    url(r'^api/end-point$', views.api_end_point),
-    url(r'^api/authenticated-end-point$', views.authenticated_end_point),
-    url(r'^admin/', admin.site.urls),
+    path(r'api/end-point', views.api_end_point),
+    path(r'api/authenticated-end-point', views.authenticated_end_point),
+    path(r'admin/', admin.site.urls),
 ]
diff --git a/example/resource-provider-api/poetry.lock b/example/resource-provider-api/poetry.lock
diff --git a/example/resource-provider-api/pyproject.toml b/example/resource-provider-api/pyproject.toml
@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "resource-provider-api"
+version = "0.1.0"
+description = "api provider for django-keycloak example"
+authors = ["Samuel C. Tyler <[email protected]>"]
+# readme = "README.md"
+# packages = [{include = "resource_provider"}]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+Django = "^4.2.4"
+
+[tool.poetry.group.dev.dependencies]
+django-dynamic-fixtures = "^0.2.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
diff --git a/example/resource-provider-api/requirements.txt b/example/resource-provider-api/requirements.txt
@@ -1,3 +1,3 @@
 django>=2.0.10
-git+git://github.com/Peter-Slump/django-keycloak.git#egg=django-keycloak
+git+git://github.com/skamansam/django-keycloak.git#egg=django-keycloak
 django-dynamic-fixtures==0.1.7
diff --git a/example/resource-provider/Dockerfile b/example/resource-provider/Dockerfile
@@ -1,15 +1,14 @@
-FROM python:3-alpine
+FROM python:3.11.4-alpine
 
 RUN apk update \
-   && apk add git openssl-dev libffi-dev python-dev build-base
+   && apk add git openssl-dev libffi-dev build-base \
+   && pip install poethepoet poetry
 
-RUN mkdir -p /usr/src/app
+COPY ./poetry.lock ./pyproject.toml /usr/src/app/
 
 WORKDIR /usr/src/app
 
-COPY requirements.txt /usr/src/app/
-
-RUN pip install --no-cache-dir -r requirements.txt
+RUN poetry install
 
 COPY . /usr/src/app
 

diff --git a/example/resource-provider/manage.py b/example/resource-provider/manage.py
@@ -2,6 +2,9 @@
 import os
 import sys
 
+sys.path.append(os.path.abspath('../../src'))
+print(sys.path)
+
 if __name__ == "__main__":
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "myapp.settings")
     try: