Upgrade Azure Blob Storage SDK to v12

.devcontainer/devcontainer.json

@@ -0,0 +1,8 @@
+// For format details, see https://aka.ms/devcontainer.json
+{
+    "name": "flask-admin (Python 3.12)",
+    "image": "mcr.microsoft.com/devcontainers/python:3.12-bullseye",
+
+    // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+    "remoteUser": "vscode"
+}

.devcontainer/tests/Dockerfile

@@ -0,0 +1,6 @@
+ARG IMAGE=bullseye
+FROM mcr.microsoft.com/devcontainers/${IMAGE}
+
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install --no-install-recommends postgresql-client \
+     && apt-get clean -y && rm -rf /var/lib/apt/lists/*

.devcontainer/tests/devcontainer.json

@@ -0,0 +1,17 @@
+// For format details, see https://aka.ms/devcontainer.json.
+{
+	"name": "flask-admin tests (Postgres + Azurite + Mongo)",
+	"dockerComposeFile": "docker-compose.yaml",
+	"service": "app",
+	"workspaceFolder": "/workspace",
+	"forwardPorts": [10000, 10001, 5432, 27017],
+	"portsAttributes": {
+		"10000": {"label": "Azurite Blob Storage Emulator", "onAutoForward": "silent"},
+        "10001": {"label": "Azurite Blob Storage Emulator HTTPS", "onAutoForward": "silent"},
+		"5432": {"label": "PostgreSQL port", "onAutoForward": "silent"},
+		"27017": {"label": "MongoDB port", "onAutoForward": "silent"},
+	},
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode",
+	"postAttachCommand": "psql -U postgres -h localhost -c 'CREATE EXTENSION IF NOT EXISTS hstore;' flask_admin_test && pip install -e \".[all]\" && pip install --use-pep517 -r requirements/dev.txt"
+}

.devcontainer/tests/docker-compose.yaml

@@ -0,0 +1,44 @@
+version: '3'
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      args:
+        IMAGE: python:3.12
+
+    volumes:
+      - ../..:/workspace:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+    environment:
+      AZURE_STORAGE_CONNECTION_STRING: DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;
+
+  postgres:
+    image: postgis/postgis:16-3.4
+    restart: unless-stopped
+    environment:
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: flask_admin_test
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    network_mode: service:app
+
+  azurite:
+    container_name: azurite
+    image: mcr.microsoft.com/azure-storage/azurite:latest
+    restart: unless-stopped
+    volumes:
+      - azurite-data:/data
+    network_mode: service:app
+
+  mongo:
+    image: mongo:5.0.14-focal
+    restart: unless-stopped
+    network_mode: service:app
+
+volumes:
+  postgres-data:
+  azurite-data:

.github/workflows/tests.yaml

@@ -55,7 +55,7 @@ jobs:
         ports:
           - 27017:27017
       azurite:
-        image: arafato/azurite:2.6.5
+        image: mcr.microsoft.com/azure-storage/azurite:latest
         env:
           executable: blob
         ports:

README.md

@@ -130,11 +130,13 @@ You should see output similar to:
 
     OK
 
-**NOTE!** For all the tests to pass successfully, you\'ll need Postgres (with
-the postgis and hstore extension) & MongoDB to be running locally. You'll
-also need *libgeos* available.
+**NOTE!** For all the tests to pass successfully, you\'ll need several services running locally:
+Postgres (with the postgis and hstore extension), MongoDB, and Azurite.
+You'll also need *libgeos* available.
+See tests.yaml for Docker configuration and follow service-specific setup below.
+
+## Setting up local Postgres for tests
 
-For Postgres:
 ```bash
 psql postgres
 > CREATE DATABASE flask_admin_test;
@@ -143,6 +145,7 @@ psql postgres
 > CREATE EXTENSION postgis;
 > CREATE EXTENSION hstore;
 ```
+
 If you\'re using Homebrew on MacOS, you might need this:
 
 ```bash
@@ -155,6 +158,16 @@ createuser -s postgresql
 brew services restart postgresql
 ```
 
+## Setting up Azure Blob Storage emulator for tests
+
+1. Run the [Azurite emulator](https://learn.microsoft.com/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cblob-storage)
+
+2. Set the connection string for the emulator:
+
+```bash
+export AZURE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
+```
+
 You can also run the tests on multiple environments using *tox*.
 
 ## 3rd Party Stuff

doc/changelog.rst

@@ -4,6 +4,10 @@ Changelog
 2.0.0a3
 -------
 
+Breaking changes:
+
+* Azure Blob Storage SDK has been upgraded from the legacy version (v2) to the latest version (v12). AzureFileAdmin now accept `blob_service_client` rather than `connection_string` to give more flexibility with connection types.
+
 Fixes:
 
 * Jinja templates can now be loaded in StrictUndefined mode.

examples/azure-blob-storage/README.md

@@ -0,0 +1,29 @@
+# Azure Blob Storage Example
+
+Flask-Admin example for an Azure Blob Storage account.
+
+To run this example:
+
+1. Clone the repository and navigate to this example::
+
+    git clone https://github.com/pallets-eco/flask-admin.git
+    cd flask-admin/examples/azure-blob-storage
+
+2. Create and activate a virtual environment::
+
+    python -m venv venv
+    source venv/bin/activate
+
+3. Install requirements::
+
+    pip install -r requirements.txt
+
+4. Either run the Azurite Blob Storage emulator or create an actual Azure Blob Storage account. Set this environment variable:
+
+    export AZURE_STORAGE_CONNECTION_STRING="DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
+
+    The value below is the default for the Azurite emulator.
+
+4. Run the application::
+
+    python app.py

examples/azure-blob-storage/app.py

@@ -0,0 +1,40 @@
+import logging
+import os
+
+from azure.identity import DefaultAzureCredential
+from azure.storage.blob import BlobServiceClient
+from flask import Flask
+from flask_admin import Admin
+from flask_admin.contrib.fileadmin.azure import AzureFileAdmin
+from flask_babel import Babel
+
+logging.basicConfig(level=logging.INFO)
+app = Flask(__name__)
+app.config["SECRET_KEY"] = "secret"
+
+
+@app.route("/")
+def index():
+    return '<a href="/admin/">Click me to get to Admin!</a>'
+
+
+admin = Admin(app)
+babel = Babel(app)
+
+
+if conn_str := os.getenv("AZURE_STORAGE_CONNECTION_STRING"):
+    logging.info("Connecting to Azure Blob storage with connection string.")
+    client = BlobServiceClient.from_connection_string(conn_str)
+elif account_name := os.getenv("AZURE_STORAGE_ACCOUNT_URL"):
+    # https://learn.microsoft.com/azure/storage/blobs/storage-blob-python-get-started?tabs=azure-ad#authorize-access-and-connect-to-blob-storage
+    logging.info("Connecting to Azure Blob storage with keyless auth")
+    client = BlobServiceClient(account_name, credential=DefaultAzureCredential())
+
+file_admin = AzureFileAdmin(
+    blob_service_client=client,
+    container_name="fileadmin-tests",
+)
+admin.add_view(file_admin)
+
+if __name__ == "__main__":
+    app.run(debug=True)

examples/azure-blob-storage/requirements.txt

@@ -0,0 +1,2 @@
+../..[azure-blob-storage]
+azure-identity