openbrokerapi 4.7.1__tar.gz → 4.7.3__tar.gz

openbrokerapi-4.7.3/.bumpversion.cfg

@@ -0,0 +1,6 @@
+[bumpversion]
+current_version = 4.7.3
+
+[bumpversion:file:pyproject.toml]
+
+[bumpversion:file:doc/conf.py]

openbrokerapi-4.7.3/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

openbrokerapi-4.7.3/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

openbrokerapi-4.7.3/.github/codeql/codeql-config.yml

@@ -0,0 +1,7 @@
+paths:
+  - openbrokerapi
+paths-ignore:
+  - 'docs/**'
+  - '.github/**'
+  - '.pytest_cache/**'
+  - 'tests/**'

openbrokerapi-4.7.3/.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "uv" # update deps
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily

openbrokerapi-4.7.3/.github/workflows/auto-merge.yml

@@ -0,0 +1,19 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions: {}
+
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' || github.event.label.name == 'automerge' }}
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

openbrokerapi-4.7.3/.github/workflows/codeql.yml

@@ -0,0 +1,82 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.txt'
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.txt'
+  schedule:
+    - cron: '31 16 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5
+      with:
+        languages: ${{ matrix.language }}
+        config-file: ./.github/codeql/codeql-config.yml
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5
+      with:
+        category: "/language:${{matrix.language}}"

openbrokerapi-4.7.3/.github/workflows/python-publish.yml

@@ -0,0 +1,60 @@
+name: Python publish package
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build-and-testpypi:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: 'latest'
+          python-version: '3.8'  # use the oldest supported Python version for publishing
+          enable-cache: true
+
+      - name: Build Package
+        run: |
+          uv build
+
+      - name: Upload dist artefact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+
+      - name: Publish package distributions to Test-PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    needs: build-and-testpypi
+
+    steps:
+      - name: Download dist artefact
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1

openbrokerapi-4.7.3/.github/workflows/python-test.yml

@@ -0,0 +1,58 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+    - name: Install uv and set the Python version
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        uv sync
+        uv pip install "coveralls[toml]" pytest-cov "coverage[toml]"
+    - name: Lint with ruff
+      run: |
+        uv run ruff check .
+    - name: Test with pytest
+      run: |
+        uv run pytest --cov=openbrokerapi
+    - name: Upload coverage data to coveralls.io
+      run: uv run coveralls --service=github
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_FLAG_NAME: ${{ matrix.python-version }}
+        COVERALLS_PARALLEL: true
+
+  coveralls:
+    name: Indicate completion to coveralls.io
+    needs: test
+    runs-on: ubuntu-latest
+    container: python:3-slim
+    steps:
+    - name: Finished
+      run: |
+        pip3 install --upgrade "coveralls[toml]"
+        coveralls --service=github --finish
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

openbrokerapi-4.7.3/.github/workflows/scorecard.yml

@@ -0,0 +1,69 @@
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '25 11 * * 6'
+  push:
+    branches: [ "main" ]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@dc50aa9510b46c811795eb24b2f1ba02a914e534 # v2.3.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@3599b3baa15b485a2e49ef411a7a4bb2452e7f93 # v3.30.5
+        with:
+          sarif_file: results.sarif

openbrokerapi-4.7.3/.gitignore

@@ -0,0 +1,24 @@
+.DS_Store
+
+*.iml
+.idea
+
+env
+.env
+venv
+.venv
+.python-version
+
+__pycache__
+*.py[cod]
+_build
+build
+
+dist
+*.egg-info
+.eggs
+
+README.html
+CHANGELOG.html
+
+.coverage

openbrokerapi-4.7.3/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-ast
+
+  - repo: https://github.com/psf/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.0.1'
+    hooks:
+      - id: mypy
+        additional_dependencies:
+        - types-requests
+        - Flask-Testing
+        # needs to be excluded from pre-commit in addition to mypy config in pyproject
+        # see: https://github.com/pre-commit/mirrors-mypy/issues/1#issuecomment-1011579690
+        exclude: "^(doc|tests)/.*"
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: 'v0.4.8'
+    hooks:
+    - id: ruff

openbrokerapi-4.7.3/.readthedocs.yml

@@ -0,0 +1,14 @@
+# Required
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.8"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

openbrokerapi-4.7.3/CHANGELOG.rst

@@ -0,0 +1,195 @@
+Changelog
+=========
+
+**unreleased**
+  - nothing yet
+
+**4.7.3**
+  - API `bind`` and `unbind`` methods with `AsyncRequired` error handling
+  - Update dependencies
+  - Migrate project setup to `uv`
+
+**4.7.2**
+  - Lost to ci/cd
+
+**4.7.1**
+  - Update depenendcies
+  - Read settings values during check, instead of import time
+    Use `import openbrokerapi.settings; openbrokerapi.settings.DISABLE_SPACE_ORG_GUID_CHECK = True`
+    to disable the check for space_guid and organization_guid, or use the environment variable
+    `DISABLE_SPACE_ORG_GUID_CHECK=True`
+
+**4.7.0**
+  - Update to latest dependencies (incl Flask >=3)
+
+
+**4.6.0**
+  - Update dependencies
+
+    - Removing types-urllib3 (1.26.25.14)
+    - Updating charset-normalizer (3.2.0 -> 3.3.0)
+    - Updating urllib3 (2.0.4 -> 2.0.6)
+    - Updating zipp (3.16.2 -> 3.17.0)
+    - Updating packaging (23.1 -> 23.2)
+    - Updating blinker (1.6.2 -> 1.6.3)
+    - Updating filelock (3.12.2 -> 3.12.4)
+    - Updating platformdirs (3.10.0 -> 3.11.0)
+    - Updating setuptools (68.1.2 -> 68.2.2)
+    - Updating werkzeug (2.3.7 -> 3.0.0)
+    - Updating identify (2.5.27 -> 2.5.30)
+    - Updating pluggy (1.2.0 -> 1.3.0)
+    - Updating typing-extensions (4.7.1 -> 4.8.0)
+    - Updating virtualenv (20.24.3 -> 20.24.5)
+    - Updating black (23.7.0 -> 23.9.1)
+    - Updating mypy (1.5.1 -> 1.6.0)
+    - Updating pre-commit (3.3.3 -> 3.5.0)
+    - Updating pytest (7.4.0 -> 7.4.2)
+    - Updating types-requests (2.31.0.2 -> 2.31.0.9)
+
+
+**4.5.8**
+  - Update dependencies (Werkzeug=2.3.7, Flask=2.3.3, ...)
+
+**4.5.7**
+  - minor improvements
+
+**4.5.6**
+  - Improve documentation for Authenticator and rename to BrokerAuthenticator. Keep old names for now.
+
+**4.5.5**
+  - Update Flask to 2.3.2: [CVE-2023-30861](https://github.com/advisories/GHSA-m2qf-hxjv-5gpq)
+  - Update pytest from 7.2.1 to 7.3.1
+  - Use trusted provider flow to publish to pypi
+
+> Releases 4.5.1-4 were used to test the new GitHub workflow and are only pushed to Test-PYPI
+
+**4.5**
+  - Drop Python 3.7 support
+  - Update dependencies
+
+**v4.4**
+  - Provide an option to provide a custom authentication implementing `openbrokerapi.auth.Authenticator`
+
+**v4.3.1**
+  - Pass error messages of `ErrBadRequest` to inform the platform about the issue details
+
+
+**v4.3**
+  - Fix [issue 211](https://github.com/eruvanos/openbrokerapi/issues/211) use keyword arguments to call broker functions from api
+
+**v4.2**
+  - ErrConcurrentInstanceAccess exception on an instance update, an instance deprovision, a binding or unbinding must return 422 not 500.
+  - ErrPlanChangeNotSupported exception must return 400 not 500.
+  - last_operation and last_binding_operation forward service and plan identifiers when provided
+
+  - Update dependencies
+  - Drop Python 3.6 support
+  - Migrate to Poetry
+
+**v4.1**
+  - Drop Python 3.5 support
+  - Fix ´bind´ in multi broker setup (#117); thx @vaxvms
+  - Removing requirement to have a space_guid and an organization_guid (#116); thx @rajahaidar
+  - Improve documentation; thx @vaxvms
+  - Fix collections.abc deprecation; thx @tammersaleh
+
+**v4.0.2**
+  - Introduce new error to return BadRequest
+  - Add **kwargs to catalog classes
+
+**v4.0.1**
+  - Add gunicorn installation
+
+**v4.0**
+  - Extract routing mechanism into a `Router` class
+  - Clean `ServiceBroker` interface
+  - `gevent` is now optional and can be installed by `pip install openbrokerapi[gevent]`
+  - Added endpoint to get last binding operation
+  - Introduce `**kwargs` into some signatures to improve backwards compatibility in the future
+  - Fixed responses with status 412 don't contain body (https://github.com/pallets/werkzeug/issues/1231)
+  - `ServiceBroker` provides methods to fetch instance and binding
+  - Provision does not require `organization_guid` and `space_guid` parameters, if they are available in the context object
+
+**Incompatibility**
+  - Changed parameter order in `UnbindDetails`, `DeprovisionDetails`
+  - Changed parameter name of `ServiceBroker.provision`
+  - Removed deprecated `ServicePlanMetaData` (use `ServicePlanMetadata`)
+  - Unbind now returns `UnbindSpec`
+  - `ServiceBroker.bind` and `ServiceBroker.unbind` now receive `async_allowed` flag
+
+        **Why breaking changes?**
+
+        To catch up with the newest features of the OpenServiceBroker API some breaking changes were neccessary.
+        While I was working on the new version I realised that there are a few things I really wanted to fix, which is at the end the reason, for some changes that may not be necessary but nice to have.
+
+**v3.2**
+  - Add shareable to ServiceMetaData
+  - 501 to unimplemented broker actions  #41
+  - Fixed: AttributeError in broker without creds #43
+  - Add `ErrInvalidParameters` to respond with `400` for malformed or missing mandatory data #49
+  - Support for custom Metadata fields. #47
+
+**v3.1.x**
+  - Fix typos
+  - Add checks for Content-Type
+  - Use `gevent` instead of `app.run`
+  - Originating-Identity available (thx to #10 redorff)
+  - Context dict available (thx to #10 redorff)
+  - Support multiple credentials (thx to #10 redorff)
+  - Service update can return dashboard_url
+  - Return 400 also when body not parsable
+  - Improve docs
+
+**v2.0.0**
+  - Refactor API
+
+**v1.0.0**
+  - permit to run a broker without authentication
+  - Support multiple services with one broker
+
+**v0.5.0**
+  - error handling fixed for ServiceExceptions
+  - support 200-OK as provision and bind responses `[issue #1]`_
+
+    - instead of 'is_async' flag an enumeration is used
+
+.. _[issue #1]: https://github.com/eruvanos/openbrokerapi/issues/1
+
+**v0.4.1**
+  - support Python 3.5+
+
+**v0.4.0**
+  - remove unused response classes
+  - ProvisionedServiceSpec: do not require optional fields
+  - DeprovisionServiceSpec: do not require optional fields
+  - LastOperation: do not require optional fields
+  - update to openbrokerapi 2.13 (minimal required)
+  - correct some required vs non required fields
+
+**v0.3.1**
+  - fix api.serve
+
+**v0.3**
+  - use LastOperationResponse for last\_operation response
+  - fix: catalog response was not convertible to json
+  - fix: not required fields were still in catalog response
+  - add missing tests for catalog endpoint
+  - support for VolumeMounts is tested
+
+**v0.2**
+  - improve testing
+  - fix: Bind and update getting dict instead of expected objects
+  - support async for provision, update and deprovision
+  - Handle unexpected exception with global error\_handler (responding
+    with 500)
+  - get\_blueprint() now expects a logger
+  - add log\_utils with basic\_config()
+
+**v0.1**
+    -  initial version
+    -  supported operations
+    -  provision
+    -  update
+    -  bind
+    -  unbind
+    -  deprovision

openbrokerapi-4.7.3/DEVELOPMENT.md

@@ -0,0 +1,54 @@
+# Development commands and notes
+
+## Contributing
+
+Use black to format your code!
+
+## Build pipeline
+
+To publish a release use bumpversion. This will update the `pyproject.toml` and tag the commit.
+#TODO a Github action will pick up the new tag and publish a new version on pypi
+
+> To trigger the whole build process use `ship.sh`.
+
+```bash
+./ship.sh patch|minor
+```
+
+
+## Manual steps
+
+### Install dependencies
+```
+uv sync --extra dev
+```
+
+### Test
+```
+uv run pytest .
+```
+
+### Build
+```
+uv build
+```
+
+### Upload
+```
+# Test PyPI
+uv publish --publish-url https://test.pypi.org/legacy/
+# PyPI
+uv publish
+```
+
+### Install from testpypi
+```
+pip install -i https://testpypi.python.org/simple openbrokerapi
+```
+
+### Create docs
+
+```
+cd doc
+uv run sphinx-build -b html . _build
+```