geoservercloud 0.8.1.dev3__tar.gz

geoservercloud-0.8.1.dev3/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2024, Camptocamp SA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

geoservercloud-0.8.1.dev3/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.3
+Name: geoservercloud
+Version: 0.8.1.dev3
+Summary: Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services
+License: BSD-2-Clause
+Author: Camptocamp
+Author-email: info@camptocamp.com
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: OWSLib
+Requires-Dist: psycopg2-binary
+Requires-Dist: pytest
+Requires-Dist: requests
+Requires-Dist: sqlalchemy
+Requires-Dist: xmltodict
+Description-Content-Type: text/markdown
+
+# python-geoservercloud
+
+## Documentation
+
+https://camptocamp.github.io/python-geoservercloud/
+
+## Installation
+
+From PyPI:
+
+```shell
+pip install geoservercloud
+```
+
+From git repository:
+
+```shell
+git clone https://github.com/camptocamp/python-geoservercloud
+cd python-geoservercloud
+python3 -m venv .venv
+source .venv/bin/activate
+poetry install
+```
+
+## Quick start
+
+```python
+from geoservercloud import GeoServerCloud
+
+geoserver = GeoServerCloud(
+    url="http://localhost:9090/geoserver/cloud/",
+    user="admin",
+    password="geoserver",
+)
+geoserver.create_workspace("newworkspace")
+```
+
+## About
+
+Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services.
+Intended use cases are listed below.
+
+### Programmatic setup of a GeoServer catalog
+
+For example, creating a workspace, connecting to a PostGIS datastore and publishing a PG layer:
+
+```python
+geoserver.create_workspace("example")
+geoserver.create_pg_datastore(
+    workspace_name="example",
+    datastore_name="example_store",
+    pg_host="localhost",
+    pg_port=5432,
+    pg_db="database",
+    pg_user="user",
+    pg_password="password"
+)
+geoserver.create_feature_type(
+    layer_name="layer_example",
+    workspace_name="example",
+    datastore_name="example_store",
+    title={
+        "en":"Layer title",
+        "fr": "Titre de la couche",
+        "default": "Default title",
+    },
+)
+```
+
+### Testing
+
+Automatic tests of GeoServer functionalities with `pytest`, for example before upgrading.
+The example below tests the fallback mechanism for internationalized layer titles in the GetCapabilities document.
+
+```python
+@pytest.mark.parametrize(
+    "language,expected_title",
+    [
+        (
+            "en",
+            "Layer title",
+        ),
+        (
+            "fr",
+            "Titre de la couche",
+        ),
+        (
+            "de,en",
+            "Layer title",
+        ),
+        (
+            None,
+            "Default title",
+        ),
+    ],
+)
+def test_i18n_layer_title(geoserver, language, expected_title):
+    capabilities = geoserver.get_wms_layers(
+        workspace="example",
+        accept_languages=language,
+    )
+    layer = capabilities.get("Layer")
+    assert layer.get("Title") == expected_title
+```
+
+A test suite is provided in the directory `geoserver_acceptance_tests`.
+
+### Syncing
+
+Copying a workspace from one GeoServer instance to another, including PG datastores, layers, styles and style images.
+
+#### In a Python console or script
+
+```python
+from geoservercloud import GeoServerCloudSync
+geoserversync = GeoServerCloudSync(
+    src_url="http://localhost:8080/geoserver",
+    src_user="admin",
+    src_password="geoserver",
+    dst_url="http://localhost:9099/geoserver",
+    dst_user="admin",
+    dst_password="geoserver",
+)
+geoserversync.copy_workspace("workspace_name", deep_copy=True)
+```
+
+#### In a shell terminal or script
+
+First install the package in your current virtual environment (see [Installation](#installation)), then run the script with:
+
+```shell
+copy-workspace --src_url "http://localhost:8080/geoserver" --src_user admin --src_password geoserver --dst_url "http://localhost:9099/geoserver" --dst_user admin --dst_password geoserver --workspace workspace_name
+```
+
+### Logging
+
+Set the log level using the standard `logging` module, e.g.:
+
+```python
+import logging
+
+logging.getLogger("geoservercloud").setLevel(logging.DEBUG)
+```
+

geoservercloud-0.8.1.dev3/README.md

@@ -0,0 +1,143 @@
+# python-geoservercloud
+
+## Documentation
+
+https://camptocamp.github.io/python-geoservercloud/
+
+## Installation
+
+From PyPI:
+
+```shell
+pip install geoservercloud
+```
+
+From git repository:
+
+```shell
+git clone https://github.com/camptocamp/python-geoservercloud
+cd python-geoservercloud
+python3 -m venv .venv
+source .venv/bin/activate
+poetry install
+```
+
+## Quick start
+
+```python
+from geoservercloud import GeoServerCloud
+
+geoserver = GeoServerCloud(
+    url="http://localhost:9090/geoserver/cloud/",
+    user="admin",
+    password="geoserver",
+)
+geoserver.create_workspace("newworkspace")
+```
+
+## About
+
+Lightweight Python client to interact with GeoServer Cloud REST API, GeoServer ACL and OGC services.
+Intended use cases are listed below.
+
+### Programmatic setup of a GeoServer catalog
+
+For example, creating a workspace, connecting to a PostGIS datastore and publishing a PG layer:
+
+```python
+geoserver.create_workspace("example")
+geoserver.create_pg_datastore(
+    workspace_name="example",
+    datastore_name="example_store",
+    pg_host="localhost",
+    pg_port=5432,
+    pg_db="database",
+    pg_user="user",
+    pg_password="password"
+)
+geoserver.create_feature_type(
+    layer_name="layer_example",
+    workspace_name="example",
+    datastore_name="example_store",
+    title={
+        "en":"Layer title",
+        "fr": "Titre de la couche",
+        "default": "Default title",
+    },
+)
+```
+
+### Testing
+
+Automatic tests of GeoServer functionalities with `pytest`, for example before upgrading.
+The example below tests the fallback mechanism for internationalized layer titles in the GetCapabilities document.
+
+```python
+@pytest.mark.parametrize(
+    "language,expected_title",
+    [
+        (
+            "en",
+            "Layer title",
+        ),
+        (
+            "fr",
+            "Titre de la couche",
+        ),
+        (
+            "de,en",
+            "Layer title",
+        ),
+        (
+            None,
+            "Default title",
+        ),
+    ],
+)
+def test_i18n_layer_title(geoserver, language, expected_title):
+    capabilities = geoserver.get_wms_layers(
+        workspace="example",
+        accept_languages=language,
+    )
+    layer = capabilities.get("Layer")
+    assert layer.get("Title") == expected_title
+```
+
+A test suite is provided in the directory `geoserver_acceptance_tests`.
+
+### Syncing
+
+Copying a workspace from one GeoServer instance to another, including PG datastores, layers, styles and style images.
+
+#### In a Python console or script
+
+```python
+from geoservercloud import GeoServerCloudSync
+geoserversync = GeoServerCloudSync(
+    src_url="http://localhost:8080/geoserver",
+    src_user="admin",
+    src_password="geoserver",
+    dst_url="http://localhost:9099/geoserver",
+    dst_user="admin",
+    dst_password="geoserver",
+)
+geoserversync.copy_workspace("workspace_name", deep_copy=True)
+```
+
+#### In a shell terminal or script
+
+First install the package in your current virtual environment (see [Installation](#installation)), then run the script with:
+
+```shell
+copy-workspace --src_url "http://localhost:8080/geoserver" --src_user admin --src_password geoserver --dst_url "http://localhost:9099/geoserver" --dst_user admin --dst_password geoserver --workspace workspace_name
+```
+
+### Logging
+
+Set the log level using the standard `logging` module, e.g.:
+
+```python
+import logging
+
+logging.getLogger("geoservercloud").setLevel(logging.DEBUG)
+```

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/.gitignore

@@ -0,0 +1,2 @@
+.venv
+compose/geoserver_data/

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/README.md

@@ -0,0 +1,118 @@
+# GeoServer acceptance test suite
+
+## Installation
+
+The instructions below use `pip`, but it's also possible to use Poetry.
+
+### From PyPI
+
+We recommend working in a dedicated Python virtual environment.
+To create and activate it (on Linux):
+
+```shell
+python -m venv .venv
+source .venv/bin/activate
+```
+
+Install the lib:
+
+```shell
+pip install geoservercloud
+```
+
+### From local repository in development mode
+
+```shell
+git clone git@github.com:camptocamp/python-geoservercloud
+cd python-geoservercloud/geoserver_acceptance_tests
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ..
+```
+
+## Prerequisites
+
+- a GeoServer instance is running and accessible with an admin user
+- a test Postgres DB with the PostGIS extension is accessible
+- the ImageMosaic sample data is mounted in GeoServer at `/opt/geoserver_data/sampledata`
+- Internet access (from GeoServer)
+
+The ImageMosaic sample data is provided as an archive at data/sampledata.tgz.
+A script is provided to copy the sample data and is available in the venv once the package is installed:
+
+```shell
+copy-test-data /example/path/
+```
+
+And to directly extract the sample data to its destination:
+
+```shell
+extract-test-data /example/path/
+```
+
+## Configuration
+
+See example configuration file `example.config.yaml`. Most values can be overridden at run time through environment variables:
+
+| Environment Variable          | Description                                         | Config Override     |
+| ----------------------------- | --------------------------------------------------- | ------------------- |
+| `GEOSERVER_ACCEPTANCE_CONFIG` | Path to the config YAML file                        | (overrides default) |
+| `GEOSERVER_URL`               | GeoServer base URL                                  | `server.url`        |
+| `GEOSERVER_VERIFYTLS`         | Enable/disable TLS verification. Expects true/false | `server.verifytls`  |
+| `GEOSERVER_USER`              | GeoServer admin username                            | `credentials.user`  |
+| `GEOSERVER_PASSWORD`          | GeoServer admin password                            | `credentials.pass`  |
+| `GEOSERVER_PG_HOST_DOCKER`    | PostgreSQL host from Docker container               | `db.pg_host.docker` |
+| `GEOSERVER_PG_PORT_DOCKER`    | PostgreSQL port from Docker container               | `db.pg_port.docker` |
+| `GEOSERVER_PG_HOST_LOCAL`     | PostgreSQL host from local host                     | `db.pg_host.local`  |
+| `GEOSERVER_PG_PORT_LOCAL`     | PostgreSQL port from local host                     | `db.pg_port.local`  |
+| `GEOSERVER_PG_DB`             | PostgreSQL database name                            | `db.pg_db`          |
+| `GEOSERVER_PG_USER`           | PostgreSQL username                                 | `db.pg_user`        |
+| `GEOSERVER_PG_PASSWORD`       | PostgreSQL password                                 | `db.pg_password`    |
+| `GEOSERVER_PG_SCHEMA`         | PostgreSQL schema                                   | `db.pg_schema`      |
+
+There are two separate settings for the DB host and port because typically GeoServer and the DB are run as a docker composition while the tests themselves are run from the host. Supported host platforms are Linux, MacOS (experimental) and Windows (experimental) - feedback and PRs are welcome.
+
+## Usage
+
+Run tests
+
+```shell
+pytest --pyargs geoserver_acceptance_tests.tests -v
+```
+
+The default path to the configuration file is `/opt/geoserver_acceptance/config.yaml`. To change it - for example to use a file in the current directory, use the environment variable `GEOSERVER_ACCEPTANCE_CONFIG`:
+
+```shell
+GEOSERVER_ACCEPTANCE_CONFIG=./config.yaml pytest --pyargs geoserver_acceptance_tests.tests -v
+```
+
+### Enabling and disabling tests
+
+Certain kinds of tests can be enabled or disabled through environment variables:
+
+| Environment Variable                  | Description                                                   | Default |
+| ------------------------------------- | ------------------------------------------------------------- | ------- |
+| `GEOSERVER_ACCEPTANCE_RUN_DB_TESTS`   | Enable/disable tests requiring DB access                      | `true`  |
+| `GEOSERVER_ACCEPTANCE_RUN_SLOW_TESTS` | Enable/disable slow tests                                     | `false` |
+| `GEOSERVER_ACCEPTANCE_RUN_COG_TESTS`  | Enable/disable COG tests                                      | `false` |
+| `GEOSERVER_ACCEPTANCE_RUN_JNDI_TESTS` | Enable/disable tests requiring a JNDI resource (jdbc/postgis) | `false` |
+
+### Run the example docker composition
+
+An example docker composition is provided in order to illustrate the complete setup required to run the tests.
+First, follow the steps described at [From local repository in development mode](#from-local-repository-in-development-mode).
+Then run:
+
+```shell
+extract-test-data ./compose/geoserver_data/
+UID=$(id -u) docker compose -f compose/example.compose.yaml up -d
+export GEOSERVER_ACCEPTANCE_CONFIG=./example.config.yaml
+export GEOSERVER_ACCEPTANCE_RUN_JNDI_TESTS=true
+pytest --pyargs geoserver_acceptance_tests.tests -v
+```
+
+### Image comparison tests
+
+Some tests use image comparison. If such a test fails, the generated image will be persisted in a temporary directory created by pytest (check the test logs for the exact location). The temporary directory location can be overridden with the environment variable `GEOSERVER_ACCEPTANCE_FAILED_TESTS_DIR`.
+
+This allows for visual comparison with the expected images which can be found in `tests/resources`.

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/cli.py

@@ -0,0 +1,40 @@
+import argparse
+import shutil
+from importlib import resources
+from pathlib import Path
+
+
+def copy_test_data():
+    parser = argparse.ArgumentParser(description="Copy GeoServer acceptance test data.")
+    parser.add_argument(
+        "target_dir",
+        help="Directory where test data should be copied",
+    )
+
+    args = parser.parse_args()
+    target = Path(args.target_dir)
+    target.mkdir(parents=True, exist_ok=True)
+
+    with resources.path("geoserver_acceptance_tests.data", "sampledata.tgz") as p:
+        shutil.copy(p, target / "sampledata.tgz")
+
+    print(f"Copied test data to: {target}")
+
+
+def extract_test_data():
+    parser = argparse.ArgumentParser(
+        description="Extract GeoServer acceptance test data."
+    )
+    parser.add_argument(
+        "target_dir",
+        help="Directory where test data should be extracted",
+    )
+
+    args = parser.parse_args()
+    target = Path(args.target_dir)
+    target.mkdir(parents=True, exist_ok=True)
+
+    with resources.path("geoserver_acceptance_tests.data", "sampledata.tgz") as p:
+        shutil.unpack_archive(p, target)
+
+    print(f"Extracted test data to: {target}")

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/compose/example.compose.yaml

@@ -0,0 +1,37 @@
+volumes:
+  geoserver_data:
+    driver: local
+    driver_opts:
+      type: none
+      o: bind
+      device: ./geoserver_data
+
+services:
+  geoserver:
+    image: docker.osgeo.org/geoserver:2.28.x
+    ports:
+      - "8080:8080"
+    environment:
+      GEOSERVER_DATA_DIR: /opt/app/data_dir
+      RUN_WITH_USER_UID: ${UID}
+      CHANGE_OWNERSHIP_ON_FOLDERS: "/opt/app/data_dir /opt/geoserver_data"
+      POSTGRES_JNDI_ENABLED: true
+      POSTGRES_HOST: geodatabase
+      POSTGRES_PORT: 5432
+      POSTGRES_DB: geoserver
+      POSTGRES_USERNAME: geoserver
+      POSTGRES_PASSWORD: geoserver
+      POSTGRES_JNDI_RESOURCE_NAME: jdbc/postgis
+    volumes:
+      - geoserver_data:/opt/geoserver_data
+  geodatabase:
+    #image with arm/64 support:
+    image: imresamu/postgis:15-3.4
+    environment:
+      POSTGRES_DB: acceptance
+      POSTGRES_USER: geoserver
+      POSTGRES_PASSWORD: geoserver
+    volumes:
+      - ./geodatabase:/docker-entrypoint-initdb.d:ro
+    ports:
+      - "6432:5432"

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/compose/geodatabase/001_create_schemas.sql

@@ -0,0 +1,3 @@
+\c acceptance
+CREATE SCHEMA IF NOT EXISTS test1;
+CREATE EXTENSION IF NOT EXISTS postgis;

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/config.py

@@ -0,0 +1,82 @@
+import logging
+import os
+
+import yaml
+
+DEFAULT_CONFIG_PATH = "/opt/geoserver_acceptance/config.yaml"
+
+
+def load_config():
+    """Load test configuration from a YAML file.
+    Environment variables can be used to override specific configuration values."""
+    path = os.getenv("GEOSERVER_ACCEPTANCE_CONFIG", DEFAULT_CONFIG_PATH)
+
+    if not os.path.exists(path):
+        raise FileNotFoundError(f"Config file not found: {path}")
+
+    with open(path) as f:
+        config = yaml.safe_load(f)
+
+    # Environment variables have precedence over configuration file
+    override_url = os.getenv("GEOSERVER_URL")
+    if override_url:
+        config["server"]["url"] = override_url
+    override_verifytls = os.getenv("GEOSERVER_VERIFYTLS")
+    if override_verifytls is not None:
+        config["server"]["verifytls"] = override_verifytls.lower() == "true"
+    override_user = os.getenv("GEOSERVER_USER")
+    if override_user:
+        config["credentials"]["user"] = override_user
+    override_pass = os.getenv("GEOSERVER_PASSWORD")
+    if override_pass:
+        config["credentials"]["pass"] = override_pass
+    override_pg_host = os.getenv("GEOSERVER_PG_HOST_DOCKER")
+    if override_pg_host:
+        config["db"]["pg_host"]["docker"] = override_pg_host
+    override_pg_port = os.getenv("GEOSERVER_PG_PORT_DOCKER")
+    if override_pg_port:
+        config["db"]["pg_port"]["docker"] = int(override_pg_port)
+    override_pg_host = os.getenv("GEOSERVER_PG_HOST_LOCAL")
+    if override_pg_host:
+        config["db"]["pg_host"]["local"] = override_pg_host
+    override_pg_port = os.getenv("GEOSERVER_PG_PORT_LOCAL")
+    if override_pg_port:
+        config["db"]["pg_port"]["local"] = int(override_pg_port)
+    override_pg_db = os.getenv("GEOSERVER_PG_DB")
+    if override_pg_db:
+        config["db"]["pg_db"] = override_pg_db
+    override_pg_user = os.getenv("GEOSERVER_PG_USER")
+    if override_pg_user:
+        config["db"]["pg_user"] = override_pg_user
+    override_pg_password = os.getenv("GEOSERVER_PG_PASSWORD")
+    if override_pg_password:
+        config["db"]["pg_password"] = override_pg_password
+    override_pg_schema = os.getenv("GEOSERVER_PG_SCHEMA")
+    if override_pg_schema:
+        config["db"]["pg_schema"] = override_pg_schema
+
+    # Configure logging for geoservercloud library
+    _setup_logging(config)
+
+    return config
+
+
+def _setup_logging(config: dict):
+    """Set up logging for the geoservercloud library based on configuration."""
+    # Get logging configuration from config file or use defaults
+    log_config = config.get("logging", {})
+    log_level_str = log_config.get("level", "INFO").upper()
+    log_level = getattr(logging, log_level_str, logging.INFO)
+    log_format = log_config.get(
+        "format", "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
+
+    # Configure the geoservercloud logger
+    logger = logging.getLogger("geoservercloud")
+    logger.setLevel(log_level)
+
+    # Add console handler if not already present
+    if not logger.handlers:
+        handler = logging.StreamHandler()
+        handler.setFormatter(logging.Formatter(log_format))
+        logger.addHandler(handler)

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/example.config.yaml

@@ -0,0 +1,23 @@
+server:
+  url: "http://localhost:8080/geoserver"
+  verifytls: true
+
+credentials:
+  user: "admin"
+  pass: "geoserver"
+
+logging:
+  level: "DEBUG"
+  format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+
+db:
+  pg_host:
+    docker: "geodatabase"
+    local: "localhost"
+  pg_port:
+    docker: 5432
+    local: 6432
+  pg_db: "acceptance"
+  pg_user: "geoserver"
+  pg_password: "geoserver"
+  pg_schema: "test1"

geoservercloud-0.8.1.dev3/geoserver_acceptance_tests/tests/__init__.py

@@ -0,0 +1 @@
+# Test package