ci: Add Python 3.12 support

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump Django to 5.x.x, django-filter to 23.5.0

One issue to address, which is caused by changes in Django commit
500e01073ad [1].

We also drop support for Django 3.2, which goes EOL in April 2024, and
Django 4.1, which already went EOL in December 2023.

[1] https://github.com/django/django/commit/500e01073ad

Signed-off-by: Stephen Finucane <stephen@that.guru>

pre-commit: Add vacuum

Lint our OpenAPI specs.

Signed-off-by: Stephen Finucane <stephen@that.guru>

pre-commit: Bump versions

Signed-off-by: Stephen Finucane <stephen@that.guru>

templates/submission: add button to copy the message ID to clipboard

Add an icon alongside the message ID to copy the message ID to the
clipboard, to ease integration with eg b4.

Signed-off-by: Ross Burton <ross.burton@arm.com>

templates/base: generalise clipbboardjs initialisation

Don't limit the clipboardjs hooking to button.btn-copy, as we may want
to use it on icons which are not buttons.

Signed-off-by: Ross Burton <ross.burton@arm.com>

templates/submission: remove duplication when writing the Message ID

The output is identical, but this removes the duplication of the Message
ID itself in the source.

Signed-off-by: Ross Burton <ross.burton@arm.com>

Upgrade to Bootstrap 3.4.1

Upgrade Bootstrap to 3.3.7

Fix docker apt install requirements

Add pkg-config dependency install for docker images. this is required
later on for mysql inside the container.

docs: Replace hyperlink with doc role

Signed-off-by: Stephen Finucane <stephen@that.guru>

readthedocs: Switch back to DirHTML builder

Looks like this got lost in the switch to the '.readthedocs.yaml'
configuration file.

Signed-off-by: Stephen Finucane <stephen@that.guru>

readthedocs: Fetch all branches

Third time lucky. As this is configured, we were only fetching the main
branch. Correct this.

Signed-off-by: Stephen Finucane <stephen@that.guru>

readthedocs: Also fetch all other branches

'stable/2.0' is a branch, not a tag.

Signed-off-by: Stephen Finucane <stephen@that.guru>

readthedocs: Also fetch tags

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Add note about 'series' querystring arg to api-ref

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Switch back to RTD theme

The furo theme needs more work than originally expected, and
sphinx-rtd-theme now supports Sphinx 7.

Signed-off-by: Stephen Finucane <stephen@that.guru>

tools: Add helper script to backup, restore DB

This is handier than doing it via Django and works for my simple,
local-only workflow.

Signed-off-by: Stephen Finucane <stephen@that.guru>

pre-commit: Updates

Signed-off-by: Stephen Finucane <stephen@that.guru>

tests: Remove use of deprecated method

Resolve the following warning:

  RemovedInDjango51Warning: BaseUserManager.make_random_password() is
  deprecated.

Signed-off-by: Stephen Finucane <stephen@that.guru>

tests: Add coloured runner

This is nicer to work with than a wall of red text.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Remove filter for openapi-core

Effectively revert commit 4ddcdea4: the PR referenced merged a long time
ago.

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump openapi-core

Another slog. The joys of pre-v1.0.0 libraries!

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump mysqlclient to 2.1.x

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Unpin tblib

Shouldn't have merged the pyup bot proposed change.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Pin tblib to latest version 2.0.0

requirements: Bump django-debug-toolbar to 4.1.x

Signed-off-by: Stephen Finucane <stephen@that.guru>

pyup: Don't pin unpinned dependencies

Signed-off-by: Stephen Finucane <stephen@that.guru>

Configure dependabot

lib: add missing permissions for patchwork_covercomment_id_seq

Grants UPDATE and SELECT privileges on patchwork_covercomment_id_seq table
for user 'nobody' to fix the following exception when cover comments
are being parsed:
django.db.utils.ProgrammingError: permission denied for sequence
  patchwork_covercomment_id_seq

Signed-off-by: Ali Alnubani <alialnu@nvidia.com>

lib: add missing permissions for patchwork_cover_id_seq

Grants UPDATE and SELECT privileges on patchwork_cover_id_seq table
for user 'nobody' to fix the following exception when cover letters
are being parsed:
django.db.utils.ProgrammingError: permission denied for sequence
  patchwork_cover_id_seq

Signed-off-by: Ali Alnubani <alialnu@nvidia.com>

urls: Also decode slashes in message IDs

In commit 2653fdbb2, we started encoding slashes in message IDs
presented to users. This allowed us to support message IDs containing
slashes, which are allowed per the RFC and have been seen in the wild.
However, we continue to store the original unencoded message IDs in the
database and unfortunately we neglected to reverse the decoding in the
functions for downloading patch diffs and mboxes. Address this now.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 2653fdbb2 ("urls: Encode slashes in message IDs")
Closes: #518
Cc: Siddhesh Poyarekar <siddhesh@gotplt.org>
Cc: DJ Delorie <dj@delorie.com>

Drop Python 3.7 support

Signed-off-by: Stephen Finucane <stephen@that.guru>

tox: Remove redundant environments

These were not being used.

Signed-off-by: Stephen Finucane <stephen@that.guru>

tox: Use pre-commit for pep8 environment

Avoid duplication.

Signed-off-by: Stephen Finucane <stephen@that.guru>

pre-commit: Reorder

Place faster checks first.

Signed-off-by: Stephen Finucane <stephen@that.guru>

pre-commit: Add bashate

Signed-off-by: Stephen Finucane <stephen@that.guru>

Rewrap some bash

Keep bashate happy.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Bump pre-commit versions

Signed-off-by: Stephen Finucane <stephen@that.guru>

tests: Address flake8 issue

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Switch to furo theme

The sphinx-rtd-theme theme is not compatible with Sphinx 7.x yet.

Signed-off-by: Stephen Finucane <stephen@that.guru>

readthedocs: Specify requirements

Signed-off-by: Stephen Finucane <stephen@that.guru>

readthedocs: Specify OS, tools

This is required. The error message is misleading [1].

[1] https://github.com/readthedocs/readthedocs.org/issues/8912

Signed-off-by: Stephen Finucane <stephen@that.guru>

Add readthedocs config file

We need this to maintain our docs build, which won't work with shallow
clones.

Signed-off-by: Stephen Finucane <stephen@that.guru>

lib: add missing permissions for patchwork_comment_id_seq

Grants UPDATE and SELECT privileges on patchwork_comment_id_seq table
for web and mail users to fix the following exception when comments
are parsed:
django.db.utils.ProgrammingError: permission denied for sequence
  patchwork_comment_id_seq

Fixes: 5b53f46def5f ("lib: fix table names")
Signed-off-by: Ali Alnubani <alialnu@nvidia.com>

tests: Always enable REST API

This means django-rest-framework is now a hard requirement for unit
tests. That seems reasonable.

Signed-off-by: Stephen Finucane <stephen@that.guru>

tests: Always enable XML-RPC API

Signed-off-by: Stephen Finucane <stephen@that.guru>

templates: Use REST API backend for pwclientrc

If the REST API is enabled, we should generate a pwclientrc file that
uses it by default.

Signed-off-by: Stephen Finucane <stephen@that.guru>

trivial: Move test file

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump django-debug-toolbar to 4.0.x

Signed-off-by: Stephen Finucane <stephen@that.guru>

Validate email address in from_header

Resolves #512

Signed-off-by: Nisha Poyarekar <nisha.s.menon@gmail.com>

requirements: Bump Django to 4.2.x, django-filter to 23.2.0

There are no apparent issues to be addressed this go round. Hurrah!

We also formally drop support for Django 4.0. This doesn't really mean
anything since we still support 3.2, but it means we can keep our test
matrix as small as possible.

Signed-off-by: Stephen Finucane <stephen@that.guru>

CI: Remove codecov package

This is no longer supported [1].

[1] https://about.codecov.io/blog/message-regarding-the-pypi-package/

Signed-off-by: Stephen Finucane <stephen@that.guru>

xmlrpc: Doc improvement

Signed-off-by: Stephen Finucane <stephen@that.guru>

ci: add Python 3.11 support

Signed-off-by: You-Sheng Yang (vicamo) <vicamo@gmail.com>

black: address check failures against 23.1.0

Signed-off-by: You-Sheng Yang <vicamo@gmail.com>

Remove tox-pyenv

This doesn't appear to be maintained and isn't necessary once we add a
missing 'pyenv init'.

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Correct location of release note

Another one that ended up in the wrong place.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 2653fdbb ("urls: Encode slashes in message IDs")

Correctly append tags on patches without commit details

Only a commit summary (a.k.a. patch subject) is necessary in Git: we
don't need details. The regex we were using to search for postscripts
however assumed that there would be _something_ before the postscript,
resulting in a newline. This wasn't the case. Correct this assumption by
instead using 're.MULTILINE' and matching on '^' and '$' for newlines
instead of '\n'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #516
Cc: siddhesh@gotplt.org

requirements: Bump django-debug-toolbar to 3.8.x

Signed-off-by: Stephen Finucane <stephen@that.guru>

Uncap openapi-core

These issues have been fixed now.

Signed-off-by: Stephen Finucane <stephen@that.guru>

version: format version following PEP-440

PEP-440 regulates public and local version schemes. Git version string
will use local version scheme and alpha/stable releases will follow the
public one.

Signed-off-by: You-Sheng Yang (vicamo) <vicamo@gmail.com>

requirements: Use sphinxcontrib-openapi 0.8.1

This contains an important fix for arrays of types.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Simplify nullable field

openapi-validator requires we specify 'type' twice when using 'oneOf'.
Do this, removing some 'oneOf' declarations in the process.

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Use sphinxcontrib-openapi 0.8.0

Turns out I could release after all.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Install sphinxcontrib-openapi from source

I'm hoping to get permission to publish new releases to this [1]. Until
that happens, we must install from source.

[1] https://github.com/pypi/support/issues/2463

Signed-off-by: Stephen Finucane <stephen@that.guru>

Add temporary cap to openapi-core

This has broken us again :(

Signed-off-by: Stephen Finucane <stephen@that.guru>

Additional updates for compatibility with tox 4

'[tox] skipsdist' behaves differently in tox 4 [1]. In addition, setting
'[testenv] basepython' with '[tox] ignore_basepython_conflict' has been
the cause of a few tox 4 bugs (most since fixed, thankfully) and might
be deprecated [2]. Remove it since we don't need it in any of our
environments.

[1] https://github.com/tox-dev/tox/issues/2730
[2] https://github.com/tox-dev/tox/issues/2846

Signed-off-by: Stephen Finucane <stephen@that.guru>

tox: fix failure due to whitespaces in passenv

When installed tox >= 4, space-separated variables specified for passenv
are no longer allowed.

Signed-off-by: You-Sheng Yang (vicamo) <vicamo@gmail.com>

requirements: Bump openapi-core

openapi-core 0.16.2 includes support for null values [1]. We need this
to fix our CI.

[1] https://github.com/p1c2u/openapi-core/pull/432

Signed-off-by: Stephen Finucane <stephen@that.guru>

Convert to OpenAPI 3.1

OpenAPI 3.0 has some unspecified behavior regarding the combination of
reference objects with 'nullable' [1]. Despite what random StackOverflow
answers [2] suggest, combining nullable with '$ref' still doesn't work.
Do what's suggested in the issue reporting this behavior [3] and upgrade
to OpenAPI 3.1, allowing us to work around this.

[1] https://github.com/OAI/OpenAPI-Specification/issues/1368
[2] https://stackoverflow.com/a/48114924/613428
[3] https://github.com/OAI/OpenAPI-Specification/issues/1368#issuecomment-930112844

Signed-off-by: Stephen Finucane <stephen@that.guru>

Add support for openapi-core 0.16.x

Take two! This time with the necessary fixes to make things actually
work.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Revert "requirements: Bump openapi-core"

This reverts commit ff990da728a6b4b172981d19953dfc1ece6954d9. It seems
this was premature. I didn't rebuild my tox virtualenv before pushing :(

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump djangorestframework version

This should have been done when we added support in commit 84ec76dd.

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump Django version

This should have been done when we added support in commit 84ec76dd.

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump openapi-core

This supports OpenAPI 3.1 finally [1] 🎉. We can uncap jsonschema in the
process.

[1] https://github.com/p1c2u/openapi-core/pull/419

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Update docs to point to v3.1.0 release

Signed-off-by: Stephen Finucane <stephen@that.guru>

views: Redirect to login on password reset

There's no need for a separate reset confirmation page.

Signed-off-by: Stephen Finucane <stephen@that.guru>

forms: Trivial cleanup

Signed-off-by: Stephen Finucane <stephen@that.guru>

trivial: Remove unnecessary whitespace

This was added when we ran black over the codebase.

Signed-off-by: Stephen Finucane <stephen@that.guru>

urls: Encode slashes in message IDs

We were attempting to work around the fact that message IDs could
contain slashes which in some cases broke our ability to generate
meaningful URLs. Rather than doing this, insist that users encode these
slashes so that we can distinguish between semantically meaningful
slashes and those that form the URL. This is a slightly breaking change,
but the current behavior is already broken (see the linked bug) so this
seems reasonable.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #433
Cc: dja@axtens.net
Cc: siddhesh@gotplt.org

REST: Add missing 'url' parameter for comments

This should be present on all resources.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 88f56051 ("api: add comments detail endpoint")

models: Cache 'list_archive_url' property

We really need to get rid of this from the embedded view. It's way too
slow. For now, we just cache it and leave a note for future us.

Signed-off-by: Stephen Finucane <stephen@that.guru>

REST: De-duplicate handling of nested resource URLs

These were all doing the same thing. Make things more generic.

We also speed up test (inadvertently) by using the 'patch_id' attribute
of the 'Check' model rather than 'patch.id', thus avoiding the JOIN.

Signed-off-by: Stephen Finucane <stephen@that.guru>

REST: Fix issues with comment-related events

When we introduced this functionality, we missed the fact that these
resources use nested-style URLs that need to be specially handled. Fix
this now.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: e3d8f7548 ("REST: Add 'patch-comment-created', 'cover-comment-created' events")
Cc: Siddhesh Poyarekar <sipoyare@redhat.com>
Cc: DJ Delorie <dj@redhat.com>
Cc: Carlos O'Donell <carlos@redhat.com>

manage: Check Django version on startup

This was recently reported as an issue. Add a simple check to ensure
people update their dependencies as expected.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Cc: Siddhesh Poyarekar <sipoyare@redhat.com>
Cc: DJ Delorie <dj@redhat.com>
Cc: Carlos O'Donell <carlos@redhat.com>

requirements: Bump Django to 3.2.x, djangorestframework to 4.16.0

There are two issues to be addressed:

  RemovedInDjango50Warning: Passing response to assertFormError() is
  deprecated. Use the form object directly:

  RemovedInDjango50Warning: The "default.html" templates for forms and
  formsets will be removed. These were proxies to the equivalent
  "table.html" templates, but the new "div.html" templates will be the
  default from Django 5.0. Transitional renderers are provided to allow
  you to opt-in to the new output style now. See
  https://docs.djangoproject.com/en/4.1/releases/4.1/ for more details

Nothing complicated in fixing either of these. For the former, we must
do as we're told and use the form object directly. For the latter, we
need to configure our own form renderer so we can continue using the
table form renderer for now.

Signed-off-by: Stephen Finucane <stephen@that.guru>

tox: Output test times, more verbose output

Just a bit more useful for CI logs

Signed-off-by: Stephen Finucane <stephen@that.guru>

trivial: Remove unnecessary unicode prefixes

Signed-off-by: Stephen Finucane <stephen@that.guru>

tests: Change from expectedFailure to skip

Python 3.10 recognises unexpected passes as failures now.

Signed-off-by: Stephen Finucane <stephen@that.guru>

requirements: Bump django-debug-toolbar to 3.7.x

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Add info on contributing docs

Noticed while whipping up a patch to document the new VSCode extension.

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Add references to VSCode Patchwork plugin

Signed-off-by: Stephen Finucane <stephen@that.guru>
Cc: Florent Revest <revest@chromium.org>

trivial: Fix style issues

New flake8, same issues.

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Update sample tox environment

There's no py27-django18 environment anymore.

Signed-off-by: Stephen Finucane <stephen@that.guru>

Use a static file for versioning

This means you don't have to install all dependencies simply to read the
version.

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Actually configure reno to use the main branch

I used the wrong setting [1]

[1] https://docs.openstack.org/reno/latest/user/usage.html#configuring-reno

Signed-off-by: Stephen Finucane <stephen@that.guru>

Replace references to master with main

Signed-off-by: Stephen Finucane <stephen@that.guru>

docs: Update reno for stable/3.1

Signed-off-by: Stephen Finucane <stephen@that.guru>

Post-release version bump

Signed-off-by: Stephen Finucane <stephen@that.guru>