]> git.ipfire.org Git - thirdparty/patchwork.git/log
thirdparty/patchwork.git
2 years agotests: Change from expectedFailure to skip stable/3.0
Stephen Finucane [Fri, 30 Sep 2022 15:42:52 +0000 (16:42 +0100)] 
tests: Change from expectedFailure to skip

Python 3.10 recognises unexpected passes as failures now.

Signed-off-by: Stephen Finucane <stephen@that.guru>
(cherry picked from commit 40133ec5a0004dba0232a89185df4cc2e90b5455)
(cherry picked from commit 04b7b671b04d636c17807b7ed6a6a3039586adcf)

2 years agotests: Mark 'test_series.test_duplicated' as expected failure
Stephen Finucane [Sun, 8 Sep 2019 15:28:34 +0000 (16:28 +0100)] 
tests: Mark 'test_series.test_duplicated' as expected failure

This is failing again :(

Signed-off-by: Stephen Finucane <stephen@that.guru>
(cherry picked from commit 70afc025f60666d6e8372e13a7971085f6e3ad79)

2 years agoPost-release version bump
Stephen Finucane [Fri, 30 Sep 2022 16:51:36 +0000 (17:51 +0100)] 
Post-release version bump

Signed-off-by: Stephen Finucane <stephen@that.guru>
2 years agoRelease 3.0.6 v3.0.6
Stephen Finucane [Fri, 30 Sep 2022 16:50:10 +0000 (17:50 +0100)] 
Release 3.0.6

Signed-off-by: Stephen Finucane <stephen@that.guru>
2 years agodocs: Actually configure reno to use the main branch
Stephen Finucane [Mon, 18 Jul 2022 11:28:24 +0000 (12:28 +0100)] 
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>
(cherry picked from commit b39dabffa4c55f45419b13b240bd924fea84b969)
(cherry picked from commit b89ba00e375fdeb86dd3b92fcf40aec6fd7e9e40)

2 years agoReplace references to master with main
Stephen Finucane [Mon, 18 Jul 2022 09:34:59 +0000 (10:34 +0100)] 
Replace references to master with main

Signed-off-by: Stephen Finucane <stephen@that.guru>
(cherry picked from commit c3e5c8899c1ba31b3f5f342c9aceecbcfb253e17)
(cherry picked from commit 13f86fb05efc2b46c2707f242abc919474a474e7)

3 years agoparser: Handle binary git patches
Stephen Finucane [Wed, 11 May 2022 09:30:45 +0000 (10:30 +0100)] 
parser: Handle binary git patches

'git-format-patch' is able to generate binary patches. Fortunately,
these are quite easy to spot since they're explicitly labelled as such.
Add support for parsing these to the parser.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #463
(cherry picked from commit 6ba50aadcea526a9b4e4742f0427479bb237da48)

3 years ago[StableOnly] Fix docs job
Stephen Finucane [Wed, 11 May 2022 09:08:10 +0000 (10:08 +0100)] 
[StableOnly] Fix docs job

This is a combination of multiple commits from master:

  60a7b11d docs: pin mistune version due to breakage
  7544f8f5 requirements: Bump doc requirements
  0968130a Revert "docs: prevent build error by rolling back Sphinx version"
  65547c87 docs: prevent build error by rolling back Sphinx version
  bdb049c7 requirements: Update doc requirements

Though we don't usually change requirements on stable branches, this one
seems okay since it only affects docs builds and not production code.

Signed-off-by: Stephen Finucane <stephen@that.guru>
3 years agolib: fix table names
Ali Alnubani [Sun, 24 Apr 2022 20:59:35 +0000 (23:59 +0300)] 
lib: fix table names

Migration 0042 (introduced in 0686a73) renamed the "Comment" model
to "PatchComment", and some of the table names changed in a51e7cf
were already correct.

This reverts a51e7cf and removes a nonexistent table name to resolve
the following error:

  $ psql -f lib/sql/grant-all.postgres.sql DATABASE_NAME
  BEGIN
  psql:lib/sql/grant-all.postgres.sql:38: ERROR:  relation
    "patchwork_comment" does not exist

Fixes: a51e7cfd95e2 ("lib: Correct PatchComment table")
Fixes: 7b967db4e12f ("lib: Update DB permissions to reflect model changes")
Cc: stephen@that.guru
Closes: #396
Signed-off-by: Ali Alnubani <alialnu@nvidia.com>
(cherry picked from commit 5b53f46def5fc4961bfa77a8abb3e968ae839c59)

3 years agoPost-release version bump
Stephen Finucane [Tue, 10 May 2022 17:30:13 +0000 (18:30 +0100)] 
Post-release version bump

Signed-off-by: Stephen Finucane <stephen@that.guru>
3 years agoRelease 3.0.5 v3.0.5
Stephen Finucane [Tue, 10 May 2022 17:29:29 +0000 (18:29 +0100)] 
Release 3.0.5

Signed-off-by: Stephen Finucane <stephen@that.guru>
3 years agoSwitch from Travis CI to GitHub Actions
Stephen Finucane [Fri, 19 Nov 2021 12:09:06 +0000 (12:09 +0000)] 
Switch from Travis CI to GitHub Actions

Travis has imposed quotas on builds that require us to contact them to
obtain OSS credits. The CI tool is irrelevant so long as builds do
happen, so switch to GitHub Actions for now. This is a little more
complicated that the switch for related projects like git-pw, given the
need for a database service. We may wish to investigate reusing some of
our own Docker files in the future but for now, this should do the
trick.

Signed-off-by: Stephen Finucane <stephen@that.guru>
(cherry picked from commit 9933a170ed6f3036e64603105fbaee356393579a)

3 years agomigrations: ignore flake8 on 0041_python3
Daniel Axtens [Thu, 19 Aug 2021 03:04:26 +0000 (13:04 +1000)] 
migrations: ignore flake8 on 0041_python3

commit 3a979ed8bfc6 ("migrations: don't go to the db for 0041_python3 migration")
made a bunch of strings go past 79 characters, breaking flake8 checks.

`black` doesn't seem to fix this and reflowing the strings manually is
error-prone.

We're not really expecting future changes to this file so just don't run
flake8 against it.

Fixes: 3a979ed8bfc6 ("migrations: don't go to the db for 0041_python3 migration")
Signed-off-by: Daniel Axtens <dja@axtens.net>
(cherry picked from commit 77793ad6ebc8469a7af9b3be05b4f7e21c389b57)

3 years agorequirements: Pin jsonschema
Stephen Finucane [Thu, 28 Oct 2021 10:38:41 +0000 (11:38 +0100)] 
requirements: Pin jsonschema

The new 4.x release of jsonschema has borked our schemas for reasons I
do not yet fully understand (though I have an idea - see inline). Unbork
things now and fix our CI, while we work on a longer-term fix.

Conflicts:
  requirements-test.txt

Changes:
  requirements-text.txt

NOTE(stephenfin): The conflict is because we're using a slightly older
version of openapi-core here which we don't want to update. We also need
to modify the file futher to pin openapi-schema-validator to keep pip
happy since openapi-schema-validator 0.2.0 requires jsonschema > 4.0.

Signed-off-by: Stephen Finucane <stephen@that.guru>
3 years agoparser: Ignore CFWS in Message-ID header
Stephen Finucane [Fri, 6 May 2022 17:21:02 +0000 (18:21 +0100)] 
parser: Ignore CFWS in Message-ID header

We recently started stripping comments and folding white space from the
In-Reply-To and References headers. Do so also for the Message-ID
header. Because of the importance of the Message-ID header, we accept
even non-compliant headers and because we now have a pattern for this,
we also start (re-)accepting non-compliant In-Reply-To headers.

Conflicts:
  patchwork/parser.py

NOTE(stephenfin): Conflicts are due to the absence of commit 94d75a1c78
("Blackify code") which we don't want to backport.

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

3 years agoparser: Ignore CFWS in In-Reply-To, References headers
Stephen Finucane [Fri, 6 May 2022 16:53:13 +0000 (17:53 +0100)] 
parser: Ignore CFWS in In-Reply-To, References headers

RFC2822 states that [1] a comment or folding white space is permitted to
be inserted before or after a msg-id in in the Message-ID, In-Reply-To
or References fields. Allow for this.

[1] https://tools.ietf.org/html/rfc2822#section-3.6.4

Conflicts:
  patchwork/tests/test_parser.py

NOTE(stephenfin): Conflicts are due to the absence of commits f5cd52144c
("parser: Add 'X-Patchwork-Action-Required' header") and 94d75a1c78
("Blackify code"), neither of which we want to backport.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Reviewed-by: DJ Delorie <dj@redhat.com>
Closes: #399
3 years agoPost-release version bump
Stephen Finucane [Wed, 27 Oct 2021 10:55:16 +0000 (11:55 +0100)] 
Post-release version bump

Signed-off-by: Stephen Finucane <stephen@that.guru>
3 years agoRelease 3.0.4 v3.0.4
Stephen Finucane [Wed, 27 Oct 2021 10:53:02 +0000 (11:53 +0100)] 
Release 3.0.4

Signed-off-by: Stephen Finucane <stephen@that.guru>
3 years agoREST: Don't error if a versioned field we would remove is absent
Daniel Axtens [Fri, 20 Aug 2021 14:57:58 +0000 (00:57 +1000)] 
REST: Don't error if a versioned field we would remove is absent

We remove fields that shouldn't be seen on old versions of the API.
This was done with `pop(field name)`, which will throw an exception
if the named field is absent from the data. However, sometimes if
a patch request is via an old API version, we hit this line without
ever having the field present.

This is odd, but not harmful and we definitely shouldn't 500.

Signed-off-by: Daniel Axtens <dja@axtens.net>
[stephenfin: Merge test into bug fix]
Signed-off-by: Stephen Finucane <stephen@that.guru>
Tested-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Fixes: d944f17ec059 ("REST: Use versioning for modified responses")
Closes: #423
(cherry picked from commit 5c22f9d8fcc72deec7d8beaefc97207ea8fc646d)

4 years agomigrations: don't go to the db for 0041_python3 migration
Daniel Axtens [Fri, 16 Jul 2021 17:19:37 +0000 (03:19 +1000)] 
migrations: don't go to the db for 0041_python3 migration

When we moved to Python 3, makemigrations wanted to change a bunch of
things, see commit 4ad87ed72aec ("migrations: Add the Python 3 patch").

The change is, as observed then, just to make django happy; it's not
supposed to change the database at all.

So make the migration change the state as seen by Django only.
This makes the migration ~instant, even for a huge database.

Signed-off-by: Daniel Axtens <dja@axtens.net>
Reviewed-by: Stephen Finucane <stephen@that.guru>
Related: #420
(cherry picked from commit 3a979ed8bfc69aecb38e3a8280e87996c5384482)

4 years agoPost-release version bump
Stephen Finucane [Mon, 26 Jul 2021 17:03:06 +0000 (18:03 +0100)] 
Post-release version bump

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoRelease 3.0.3 v3.0.3
Stephen Finucane [Mon, 26 Jul 2021 17:02:44 +0000 (18:02 +0100)] 
Release 3.0.3

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoOnly show unique checks
Stephen Finucane [Sat, 6 Mar 2021 14:54:59 +0000 (14:54 +0000)] 
Only show unique checks

Commit e5c641fc4 optimized fetching of checks when displaying a patch by
prefetching these checks ahead of time. Unfortunately we missed that
this should exclude older versions of checks for a given context. Make
the code used to generate the unique checks generic and allow us to use
that as a filter to the checks provided to the template, restoring the
correct behavior.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #398
Fixes: e5c641fc4 ("Optimise fetching checks when displaying a patch")
(cherry picked from commit a43d6acda0939c14e8135549968815876680d497)

4 years agoPost-release version bump
Stephen Finucane [Wed, 24 Feb 2021 15:31:05 +0000 (15:31 +0000)] 
Post-release version bump

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoRelease 3.0.2 v3.0.2
Stephen Finucane [Wed, 24 Feb 2021 15:30:48 +0000 (15:30 +0000)] 
Release 3.0.2

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agolib: Correct PatchComment table
Stephen Finucane [Wed, 24 Feb 2021 15:26:08 +0000 (15:26 +0000)] 
lib: Correct PatchComment table

The table is 'patchwork_comment', not 'patchwork_patchcomment'. Correct
this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #396
Fixes: 7b967db4 ("lib: Update DB permissions to reflect model changes")
(cherry picked from commit a51e7cfd95e24d6757a146e9c8e8f3aec44b226c)

4 years agoapi: do not fetch every patch in a patch detail view 404 (v2)
Stephen Finucane [Wed, 24 Feb 2021 15:08:45 +0000 (15:08 +0000)] 
api: do not fetch every patch in a patch detail view 404 (v2)

Commit 08c5856 fixed an issue whereby a 404 on the aforementioned URL
could result in a large DB query due to DRF attempting to populate the
'related' list box with all patches on the instance. That was
accidentally reverted in commit fe07f30. "Unrevert" this change.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: fe07f30 ("Remove 'PatchRelationSerializer'")
Closes: #397
(cherry picked from commit 79700f321335a2d7c649eb03932797af521942a0)

4 years agoPost-release version bump
Stephen Finucane [Sat, 20 Feb 2021 16:23:39 +0000 (16:23 +0000)] 
Post-release version bump

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoRelease 3.0.1 v3.0.1
Stephen Finucane [Sat, 20 Feb 2021 16:23:10 +0000 (16:23 +0000)] 
Release 3.0.1

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agodocs: Update docs to point to v3.0.0 release
Stephen Finucane [Sat, 20 Feb 2021 15:40:00 +0000 (15:40 +0000)] 
docs: Update docs to point to v3.0.0 release

Signed-off-by: Stephen Finucane <stephen@that.guru>
(cherry picked from commit 99f5e88e521806c8d1a711ef4eea71ae9c288024)

4 years agomodels: Use parent model to get comment's 'list_archive_url'
Stephen Finucane [Sat, 20 Feb 2021 14:35:07 +0000 (14:35 +0000)] 
models: Use parent model to get comment's 'list_archive_url'

We were attempting to retrieve the 'list_archive_url' attribute from the
'PatchComment' or 'CoverComment' instances, rather than the parent
'Patch' and 'Cover' object, respectively. Correct this and add plenty of
tests to prevent this regressing.

NOTE(stephenfin): Squashed in 5fe02b6a7444b40f705d1efe33e70a9a9ef36e0a
which added the release note for this fix.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 02ffb1315 ("models: Add list archive lookup")
Closes: #391
(cherry picked from commit 93ff4db29262c0560122f61eadf78d9626def238)

4 years agotests: Fix compatibility with openapi_core 0.13.7
Stephen Finucane [Sat, 20 Feb 2021 13:27:08 +0000 (13:27 +0000)] 
tests: Fix compatibility with openapi_core 0.13.7

It seems the 'openapi_core.schema.schemas.models.Format' mechanism of
defining custom formatters was deprecated in openapi_core 0.12.0 but we
never noticed. They've finally broken it in 0.13.7. Switch to the new
thing, 'openapi_core.unmarshalling.schemas.formatters.Formatter', which
expects a slightly different format.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #395
(cherry picked from commit d11ac34e9f0f2a86901ed74da27fa7a2df109728)

4 years agourls: Support sha256-based tokens
Stephen Finucane [Sat, 20 Feb 2021 12:22:08 +0000 (12:22 +0000)] 
urls: Support sha256-based tokens

Django 3.1 changed the default hashing algorithm used for things like
password reset tokens from SHA-1 to SHA-256. As noted in the release
notes [1], this is configurable via the 'DEFAULT_HASHING_ALGORITHM'
transitional setting, but that's only intended to allow upgrades of
multiple instances in a HA deployment and shouldn't be used post
upgrade. Instead, we need to fix our URLs to support the longer tokens
generated by SHA-256.

Long term, we want to replace these regex-based routes with the simpler
flask-style template string routes. That's not really backportable so
we'll do that separately.

[1] https://docs.djangoproject.com/en/3.1/releases/3.1/#default-hashing-algorithm-settings

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #394
(cherry picked from commit 8d988f15b8a3c433aa385de7e5ba5129fdba4f40)

4 years agoRelease 3.0.0 v3.0.0
Stephen Finucane [Sun, 4 Oct 2020 11:18:11 +0000 (12:18 +0100)] 
Release 3.0.0

Major version bump because of Python 2.7 removal and the unfortunately
large DB migration.

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoAdd Python 3.9 support
Stephen Finucane [Sun, 13 Dec 2020 20:06:50 +0000 (20:06 +0000)] 
Add Python 3.9 support

This has been out since October. Time to support it.

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agorequirements: Switch to openapi-core 0.13.4
Stephen Finucane [Sun, 13 Dec 2020 19:44:53 +0000 (19:44 +0000)] 
requirements: Switch to openapi-core 0.13.4

In commit b7f3c3d34 ("tests: Switch to openapi-core 0.13.x") we added
support for 'openapi-core' 0.13.x. However, we needed to use a commit
from master since an important fix [1] was not included in the latest
release at the time, 0.13.3. 0.13.4 has since been released so let's
move on and use that.

[1] https://github.com/p1c2u/openapi-core/issues/226

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoRe-enable django-dbbackup
Stephen Finucane [Sun, 13 Dec 2020 19:16:38 +0000 (19:16 +0000)] 
Re-enable django-dbbackup

...and bump to 3.3.0, which does support Django 3.0 [1].

[1] https://github.com/django-dbbackup/django-dbbackup/issues/314#issuecomment-613608064

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agorequirements: Bump django-debug-toolbar to 3.2.x
Stephen Finucane [Sun, 13 Dec 2020 19:15:17 +0000 (19:15 +0000)] 
requirements: Bump django-debug-toolbar to 3.2.x

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoAdd release note for #379
Stephen Finucane [Sun, 13 Dec 2020 18:34:47 +0000 (18:34 +0000)] 
Add release note for #379

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoREST: Null out previous, current relation info
Stephen Finucane [Sun, 29 Nov 2020 12:50:22 +0000 (12:50 +0000)] 
REST: Null out previous, current relation info

These fields don't work like we expect them to. Because we're linking to
a non-idempotent entity, an instance of 'relation', what we're storing
in either of these fields is subject to change as patches are added and
removed. This makes the information pretty much useless after the fact.
It's best to just state the patch and request that people query the
information themselves if necessary. We don't want to remove the field
entirely from the API - that would be a truly breaking change - so
instead we null it out like we do for patch tags. In a v2 API (i.e. a
major version bump) we can remove this entirely.

A small bug with the schema generation is corrected.

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

4 years agoRemove 'PatchRelationSerializer'
Stephen Finucane [Thu, 1 Oct 2020 13:38:31 +0000 (14:38 +0100)] 
Remove 'PatchRelationSerializer'

This wasn't writeable for reasons I haven't been able to figure out.
However, it's not actually needed: the 'PatchSerializer' can do the job
just fine, given enough information. This exposes a bug in DRF, which
has been reported upstream [1]. While we wait for that fix, or some
variant of it, to be merged, we must monkey patch the library.

[1] https://github.com/encode/django-rest-framework/issues/7550
[2] https://github.com/encode/django-rest-framework/pull/7574

Signed-off-by: Stephen Finucane <stephen@that.guru>
Reported-by: Ralf Ramsauer <ralf.ramsauer@oth-regensburg.de>
Closes: #379
Cc: Daniel Axtens <dja@axtens.net>
Cc: Rohit Sarkar <rohitsarkar5398@gmail.com>
4 years agotests: Add tests for 'patch-relation-changed' events
Stephen Finucane [Sun, 4 Oct 2020 11:03:19 +0000 (12:03 +0100)] 
tests: Add tests for 'patch-relation-changed' events

This event is rather odd. If you have two patches then the way a
relation is created is by creating a 'PatchRelation' instance and then
setting the 'related' attribute on the first patch followed by the
second patch. Because the event uses the 'Patch' model's 'pre_save'
signal, we'll only see events for the patch being currently saved. This
means no event will be raised for the first patch and only one event,
the one for the second patch, will be raised when the second patch is
being added to the relationship.

In hindsight, the structure of the event is off. We should have had
something like a 'patch-added-to-relationship' and a
'patch-removed-from-relationship' event, both with the same fields:
'project', 'actor', 'patch' and 'related', the latter of which would
have listed all of the _other_ patches in the relationship. Sadly, this
is an API change which means we can't do it now. We may well wish to do
so in the future though.

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agotests: Rework 'create_relation' helper
Stephen Finucane [Sun, 4 Oct 2020 10:42:42 +0000 (11:42 +0100)] 
tests: Rework 'create_relation' helper

This wasn't actually creating just a patch relation object - it was also
creating patches, which is something we already have an explicit helper
for. Clean this thing up.

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agolib: Grant SELECT on auth_user
Stephen Finucane [Sat, 28 Nov 2020 17:32:32 +0000 (17:32 +0000)] 
lib: Grant SELECT on auth_user

If a mail arrives with the 'X-Patchwork-Delegate' hint header, the
'patchwork.parser' script will need to index the users table to find the
appropriate user. This should be okay from a security perspective since
passwords are hashed and salted and the rest of the information is
mostly accessible publicly via the web UI and REST API.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Suggested-by: Ali Alnubani <alialnu@mellanox.com>
Closes: #365
4 years agoviews/patch: Set correct encoding for patches
Toke Høiland-Jørgensen [Tue, 1 Dec 2020 21:15:11 +0000 (22:15 +0100)] 
views/patch: Set correct encoding for patches

The patch_mbox view returns text/plain data without specifying a character
set, which means clients will assume the default of iso-8559-1 as defined
in the HTTP/1.1 standard. Since the data being returned is in fact utf-8
encoded, set the encoding accordingly in the HTTP Content-Type header.

Reported-by: Jakub Kicinski <kuba@kernel.org>
Suggested-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Signed-off-by: Toke Høiland-Jørgensen <toke@toke.dk>
4 years agorequirements: Bump sqlparse to 0.4.0
Stephen Finucane [Mon, 30 Nov 2020 09:31:48 +0000 (09:31 +0000)] 
requirements: Bump sqlparse to 0.4.0

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agorequirements: Add tblib
Stephen Finucane [Sun, 29 Nov 2020 13:01:42 +0000 (13:01 +0000)] 
requirements: Add tblib

This is needed by the parallel test runner to handle pickling of
tracebacks.

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoAdd parallel testing
Stephen Finucane [Thu, 1 Oct 2020 15:28:58 +0000 (16:28 +0100)] 
Add parallel testing

This saves us a good deal of time, even allowing for process startup and
general overhead. Before:

  real    6m39.103s
  user    1m9.561s
  sys     0m2.705s

After:

  real    4m5.267s
  user    1m24.527s
  sys     0m3.828s

This requires N databases, where N is the N of processors on the host.
We need to update the docker configuration for this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoRemove landscape.yaml
Stephen Finucane [Sun, 29 Nov 2020 12:11:26 +0000 (12:11 +0000)] 
Remove landscape.yaml

landscape.io is dead [1]. No point keeping this artefact around.

[1] https://landscape.io/landscapes-story-in-2016.html

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agolib: Update DB permissions to reflect model changes
Stephen Finucane [Sat, 28 Nov 2020 17:25:25 +0000 (17:25 +0000)] 
lib: Update DB permissions to reflect model changes

These should have been done when we made changes to the model.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: ac0e4de9 ("models: Merge 'Patch' and 'Submission'")
4 years agoparser: Update reference to PatchComment
Stephen Finucane [Sat, 28 Nov 2020 16:34:01 +0000 (16:34 +0000)] 
parser: Update reference to PatchComment

Commit 0686a736fbf6d869bd31bd135ba38080ac96de22 split out 'CoverLetter'
from the old 'Submission' model, removing the common 'Comment' model in
favour of distinct 'CoverComment' and 'PatchComment' models in the
process. Unfortunately we misssed some references to the old model in
the 'patchwork.parser' module. Correct these now, adding unit tests to
prevent regressions.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 0686a736 ("models: Split 'CoverLetter' from 'Submission'")
Closes: #384
4 years agorequirements: Update doc requirements
Stephen Finucane [Thu, 1 Oct 2020 15:51:26 +0000 (16:51 +0100)] 
requirements: Update doc requirements

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agorequirements: Bump mysqlclient to 2.0.0
Stephen Finucane [Thu, 1 Oct 2020 14:17:49 +0000 (15:17 +0100)] 
requirements: Bump mysqlclient to 2.0.0

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agorequirements: Bump django-debug-toolbar to 3.1.x
Stephen Finucane [Thu, 1 Oct 2020 14:16:42 +0000 (15:16 +0100)] 
requirements: Bump django-debug-toolbar to 3.1.x

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agorequirements: Bump django-filter to 2.4.0
Stephen Finucane [Thu, 1 Oct 2020 14:15:37 +0000 (15:15 +0100)] 
requirements: Bump django-filter to 2.4.0

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agoAdd support for djangorestframework 3.12
Stephen Finucane [Thu, 1 Oct 2020 14:14:41 +0000 (15:14 +0100)] 
Add support for djangorestframework 3.12

No changes necessary.

Signed-off-by: Stephen Finucane <stephen@that.guru>
4 years agomodels: Validate Project.linkname does not contain forward slash
Thomas Bracht Laumann Jespersen [Mon, 28 Sep 2020 16:37:07 +0000 (18:37 +0200)] 
models: Validate Project.linkname does not contain forward slash

I started by creating a project that contained a forward slash
(importing patches from https://lists.sr.ht/~sircmpwn/sr.ht-dev/) and
it fails to render the "projects" main page.

The specific error reads:

    NoReverseMatch at /

    Reverse for 'patch-list' with keyword arguments
    '{'project_id': 'foo/bar'}' not found. 1 pattern(s) tried:
    ['project/(?P<project_id>[^/]+)/list/$']

which appears to explicitly disallow forward slashes.

So I think it makes sense to validate that project linkname doesn't
contain forward slahes.

This implementation uses the validate_unicode_slug validator instead of just
rejecting inputs that contain forward slashes.

Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz>
Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #380
5 years agoAdd support for Django 3.1
Andrew Donnellan [Thu, 27 Aug 2020 14:14:06 +0000 (00:14 +1000)] 
Add support for Django 3.1

Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
5 years agorequirements: Update django-filter
Andrew Donnellan [Thu, 27 Aug 2020 14:14:05 +0000 (00:14 +1000)] 
requirements: Update django-filter

Update django-filter dependency to a version that's compatible with Django
3.1.

Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
5 years agosettings: Add context processor django.template.context_processors.request
Andrew Donnellan [Thu, 27 Aug 2020 14:14:04 +0000 (00:14 +1000)] 
settings: Add context processor django.template.context_processors.request

Django 3.1 adds a new admin sidebar feature that requires the
django.template.context_processors.request context processor to be enabled
in the settings.

Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
5 years agourls: Update url pattern functions
Andrew Donnellan [Thu, 27 Aug 2020 14:14:03 +0000 (00:14 +1000)] 
urls: Update url pattern functions

Django 3.1 deprecates django.conf.urls.url() as an alias for
django.urls.re_path(). Also switch to using django.urls.include() rather
than django.conf.urls.include().

Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agotemplates: Replace ifequal and ifnotequal with if
Andrew Donnellan [Thu, 27 Aug 2020 14:14:02 +0000 (00:14 +1000)] 
templates: Replace ifequal and ifnotequal with if

Django 3.1 deprecates the ifequal and ifnotequal tags, for removal in 4.0.
Replace all occurrences of ifequal and ifnotequal with if.

Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
5 years agomanagement: introduce replacerelations command
Rohit Sarkar [Sat, 1 Aug 2020 06:24:15 +0000 (11:54 +0530)] 
management: introduce replacerelations command

The replacerelations script is used to ingest relations into Patchwork's
patch database. A patch groups file is taken as input, which on each
line contains a space separated list of patchwork ids denoting a
relation. All the existing relations in Patchwork's database are removed
and the relations read from the patch groups file are ingested.

Signed-off-by: Rohit Sarkar <rohitsarkar5398@gmail.com>
[dja: pep8, drop relations directory as empty dirs don't get stored by git,
      comment about how lines are generated.]
Signed-off-by: Daniel Axtens <dja@axtens.net>
5 years agodocker: Switch to MariaDB for wider platform support
Stewart Smith [Sat, 13 Jun 2020 23:19:12 +0000 (16:19 -0700)] 
docker: Switch to MariaDB for wider platform support

MySQL docker images only have amd64 arch support
MariaDB images have amd64, arm64v8, and ppc64le

Signed-off-by: Stewart Smith <stewart@flamingspork.com>
Signed-off-by: Daniel Axtens <dja@axtens.net>
5 years agoadmin: fix series query
Jan Remmet [Mon, 25 May 2020 07:03:10 +0000 (09:03 +0200)] 
admin: fix series query

remove typo from search_fields.

Signed-off-by: Jan Remmet <j.remmet@phytec.de>
Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Bump sphinxcontrib-openapi to 0.7.0
Stephen Finucane [Fri, 8 May 2020 08:49:50 +0000 (09:49 +0100)] 
docs: Bump sphinxcontrib-openapi to 0.7.0

This picks up an important fix [1] we want for our docs build.

[1] https://github.com/sphinx-contrib/openapi/pull/87

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agoRevert "tox: Add default Django version"
Stephen Finucane [Fri, 1 May 2020 09:02:11 +0000 (10:02 +0100)] 
Revert "tox: Add default Django version"

This reverts commit 029aff107ea9950418f9ad3cf44c3ba1ca3ea3ee. It appears
this isn't supported by tox either :(

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agotox: Add default Django version
Stephen Finucane [Thu, 30 Apr 2020 21:22:10 +0000 (22:22 +0100)] 
tox: Add default Django version

I occasionally forget myself and run e.g. 'tox -e pyNN' when I want to
sanity check something instead of 'tox -e pyNN-djangoMM'. Add fallback
Django versions so that this doesn't crash and burn. It's less succict
than it could be since tox doesn't seem to support '!django{22,30}'
(yet!).

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agomigrations: Moved squashed migration
Stephen Finucane [Sun, 26 Apr 2020 20:20:46 +0000 (21:20 +0100)] 
migrations: Moved squashed migration

This should have been in the 'patchwork/migrations' directory, not
'migrations.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: 9bb5caec ("migrations: Squash 0001 to 0040")
5 years agomigrations: Resolve issues with other DB backends for 0042, 0043
Stephen Finucane [Sun, 26 Apr 2020 13:17:57 +0000 (14:17 +0100)] 
migrations: Resolve issues with other DB backends for 0042, 0043

0042 was using MySQL-specific SQL to delete entries in the
'patchwork_comment' table that were associated with entries in the
'patchwork_coverletter' table, while 0043 only considered MySQL and
PostgrSQL when attempting to copy fields from 'patchwork_patch' to
'patchwork_submission'. Both issues are resolved.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocker: Ignore postgres data file
Stephen Finucane [Sun, 26 Apr 2020 14:28:20 +0000 (15:28 +0100)] 
docker: Ignore postgres data file

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agomigrations: Squash 0001 to 0040
Stephen Finucane [Fri, 10 Apr 2020 11:08:32 +0000 (12:08 +0100)] 
migrations: Squash 0001 to 0040

Now that we're moving a new major version, we can squash the migrations
we have to date. This coexists alongside the old migrations, which we
can remove and replace entirely when we release 4.0, per the advice of
the 'squashmigrations' tool.

  You should commit this migration but leave the old ones in place; the
  new migration will be used for new installs. Once you are sure all
  instances of the codebase have applied the migrations you squashed,
  you can delete them.

The 'squashmigrations' tool can't parse the output of 'RunPython' blocks
so the output of the tool was less optimized than it could be. As a
result, we've manually modified this change to remove the 'RunPython'
block and unnecessary 'AlterField' entries. This was done by removing
all migrations and generating a new "initial" migration, which was then
modified to mark all strings as byte strings (as they were when we were
using Python 2 to generate these migrations) so that 0041 would apply
cleanly.

The main benefit of this change is that it significantly reduces the
startup time for unit tests. Executed on my host, the run time for a
single test goes from ~ 22 seconds to ~ 14 seconds. This is obviously
reduced for additional tests.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agomodels: Trivial post-merge cleanup
Stephen Finucane [Thu, 9 Apr 2020 16:56:44 +0000 (17:56 +0100)] 
models: Trivial post-merge cleanup

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agomodels: Merge 'Patch' and 'Submission'
Stephen Finucane [Tue, 3 Mar 2020 10:46:37 +0000 (10:46 +0000)] 
models: Merge 'Patch' and 'Submission'

Oh, the follies of youth. Time to undo the damage of 2.0.0, specifically
commit 86172ccc16, which split Patch into two separate models using
concrete inheritance. As noted previously, this introduced a large
number of unavoidable JOINs across large tables and the performance
impacts these introduce are blocking other features we want, such as
improved tagging functionality. To combine these two models, we must do
the following:

- Update any references to the 'Patch' model to point to the
  'Submission' model instead
- Move everything from 'Patch' to 'Submission', including both fields
  and options
- Delete the 'Patch' model
- Rename the 'Submission' model to 'Patch'

With this change, our model "hierarchy" goes from:

  Submission
    Patch
    PatchComment
  Cover
    CoverComment

To a nice, flat:

  Patch
    PatchComment
  Cover
    CoverComment

I expect this migration to be intensive, particularly for MySQL users
who will see their entire tables rewritten. Unfortunately I don't see
any way to resolve this in an easier manner.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agomodels: Split 'CoverLetter' from 'Submission'
Stephen Finucane [Sat, 29 Feb 2020 17:20:50 +0000 (17:20 +0000)] 
models: Split 'CoverLetter' from 'Submission'

We want to get rid of the split between 'Patch' and 'Submission' because
of the cost of using JOINs basically everywhere we use 'Patch'. Before
we do that, we need to move the other users of 'Submission' to other
models and other models that rely on these users sharing the common
'Submission' base. For the former, there is only one user,
'CoverLetter', while for the latter there is only the 'Comment' model.
As a result, we must do the following:

- Create a new 'Cover' model
- Create a new 'CoverComment' model
- Move everything from 'CoverLetter' to 'Cover' and all entries
  associated with a 'CoverLetter' from 'Comment' to 'CoverComment'
- Delete the 'CoverLetter' model
- Rename the 'Comment' model to 'PatchComment'

This means our model "hierarchy" goes from:

  Submission
    Patch
    CoverLetter
    Comment

To:

  Submission
    Patch
    PatchComment
  Cover
    CoverComment

A future change will flatten the 'Submission' and 'Patch' model.

Note that this actually highlighted a bug in Django, which has since
been reported upstream [1]. As noted there, the issue stems from MySQL's
refusal to remove an index from a foreign key when DB constraints are
used and the workaround is to remove the foreign key constraint before
altering the indexes and then re-add the constraint after.

[1] https://code.djangoproject.com/ticket/31335

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agoRevert "Be sensible computing project patch counts"
Stephen Finucane [Wed, 4 Mar 2020 10:50:17 +0000 (10:50 +0000)] 
Revert "Be sensible computing project patch counts"

This reverts commit cfcf2f2a80ac0709f1a5fd9aa212c8403daa5a18.

This will no longer be necessary once we remove the Patch-Submission
split. Revert it now to avoid needing to rejig this later.

Conflicts:
patchwork/views/project.py

NOTE(stephenfin): Conflicts are due to commit 880ec8c5 ("Fetch
maintainer information in one query") which changed nearby lines.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agoRemove unnecessary references to Submission model
Stephen Finucane [Wed, 8 Apr 2020 23:00:10 +0000 (00:00 +0100)] 
Remove unnecessary references to Submission model

We want to drop this in future changes. Start by removing any
unnecessary references.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agotrivial: Rename 'CoverLetter' references to 'Cover'
Stephen Finucane [Sun, 1 Mar 2020 15:13:23 +0000 (15:13 +0000)] 
trivial: Rename 'CoverLetter' references to 'Cover'

We're going to be doing some model surgery shortly. Do the necessary
renaming of variables ahead of this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agoforms: Remove LoginForm
Stephen Finucane [Thu, 23 Apr 2020 09:46:46 +0000 (10:46 +0100)] 
forms: Remove LoginForm

This should have been removed in commit f1e089f773.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agotravis: Resolve warnings, info messages from Travis
Stephen Finucane [Sat, 18 Apr 2020 12:21:13 +0000 (13:21 +0100)] 
travis: Resolve warnings, info messages from Travis

The following were reported by Travis' build config validation:

- root: deprecated key 'sudo' (The key `sudo` has no effect anymore.)
- env: key 'matrix' is an alias for 'jobs', using 'jobs'
- root: key 'matrix' is an alias for 'jobs', using 'jobs'
- root: missing 'os', using the default 'linux'

Resolve all of the above.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agoparser: don't trigger database IntegrityErrors on duplicate coverletters
Jeremy Kerr [Thu, 16 Apr 2020 01:29:28 +0000 (09:29 +0800)] 
parser: don't trigger database IntegrityErrors on duplicate coverletters

As we've done for the Patch and Comment models, this change prevents
database errors from duplicate CoverLetters.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Signed-off-by: Stephen Finucane <stephen@that.guru>
[stephenfin: Add release note]

5 years agoparser: don't trigger database IntegrityErrors on duplicate comments
Jeremy Kerr [Thu, 16 Apr 2020 01:29:27 +0000 (09:29 +0800)] 
parser: don't trigger database IntegrityErrors on duplicate comments

As we've done for the Patch model, this change prevents database errors
from duplicate Comments.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Reviewed-by: Stephen Finucane <stephen@that.guru>
5 years agoparser: prevent IntegrityErrors
Jeremy Kerr [Thu, 16 Apr 2020 01:29:26 +0000 (09:29 +0800)] 
parser: prevent IntegrityErrors

Currently, the parser relies on causing (and catching) IntegrityErrors
on patch insert to catch duplicate (msgid,project) mails.

This change performs an atomic select -> insert instead.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Signed-off-by: Stephen Finucane <stephen@that.guru>
[stephenfin: Remove 'expectedFailure' marker again]

5 years agotests: ensure we don't see database errors during duplicate insert
Jeremy Kerr [Thu, 16 Apr 2020 01:29:25 +0000 (09:29 +0800)] 
tests: ensure we don't see database errors during duplicate insert

Currently, the parser causes IntegrityErrors while inserting duplicate
patches; these tend to pollute database logs.

This change adds a check, which currently fails, to ensure we do not
cause errors during a duplicate patch parse.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Signed-off-by: Stephen Finucane <stephen@that.guru>
[stephenfin: Add 'expectedFailure' marker to keep all tests green]

5 years agotests: Add duplicate mail test
Jeremy Kerr [Thu, 16 Apr 2020 01:29:24 +0000 (09:29 +0800)] 
tests: Add duplicate mail test

Test that we get the correct DuplicateMailError from parsing the same
mail twice.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Reviewed-by: Stephen Finucane <stephen@that.guru>
5 years agoparser: Don't crash when From: is list email but has weird mangle format
Andrew Donnellan [Wed, 15 Apr 2020 09:06:56 +0000 (19:06 +1000)] 
parser: Don't crash when From: is list email but has weird mangle format

get_original_sender() tries to demangle DMARC-mangled From headers, in
the case where the email's From address is the list address. It knows how
to handle Google Groups and Mailman style mangling, where the original
submitter's name will be turned into e.g. "Andrew Donnellan via
linuxppc-dev".

If an email has the From header set to the list address but has a name that
doesn't include " via ", we'll throw an exception because stripped_name
hasn't been set. Sometimes this is because the list name is seemingly
empty, resulting in a mangled name like "Andrew Donnellan via"
without the space after "via" that we detect. Handle this as well as we can
instead, and add a test.

Fixes: 8279a84238c10 ("parser: Unmangle From: headers that have been mangled for DMARC purposes")
Reported-by: Jeremy Kerr <jk@ozlabs.org>
Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Update sphinxcontrib-openapi
Stephen Finucane [Wed, 15 Apr 2020 15:52:25 +0000 (16:52 +0100)] 
docs: Update sphinxcontrib-openapi

No changes necessary, thankfully, though there is a feature gap here
that we will need 0.7.0 to close [1] :(

[1] https://github.com/sphinx-contrib/openapi/pull/87

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agotests: Switch to openapi-core 0.13.x
Stephen Finucane [Wed, 15 Apr 2020 15:52:08 +0000 (16:52 +0100)] 
tests: Switch to openapi-core 0.13.x

We've done the necessary work here already so this is a relatively easy
switchover. However, we do have to work around an issue whereby the
first possible matching route is used rather than the best one [1]. In
addition, we have to install from master since there are fixes missing
from the latest release, 0.13.3. Hopefully both issues will be resolved
in a future release.

[1] https://github.com/p1c2u/openapi-core/issues/226

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agotests: Drop Django 1.x support
Stephen Finucane [Wed, 15 Apr 2020 15:44:32 +0000 (16:44 +0100)] 
tests: Drop Django 1.x support

openapi-core 0.13.x has added support for Django validation. Before we
migrate to that version and presumably remove most of this code, remove
the stuff that is *definitely* dead.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'relations'
Stephen Finucane [Thu, 16 Apr 2020 13:03:54 +0000 (14:03 +0100)] 
docs: Resolve issues with 'relations'

Two issues here:

- 'PATCH /patches/{id}' and 'PUT /patches/{id}' expect a list of
  integers on the 'related' field - not strings
- 'GET /patches' and 'GET /patches/{id}' return a list of embedded patch
  objects on the 'related' field - not strings

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'events'
Stephen Finucane [Thu, 16 Apr 2020 12:45:28 +0000 (13:45 +0100)] 
docs: Resolve issues with 'events'

Four things to change here:

- The response is any array that can contain any type of event, not one
  of them.
- The 'actor' field is nullable.
- The 'cover' field of the 'cover-created' event is an embedded cover
  letter, not a string.
- The specifications for the 'current_delegate' and 'previous_delegate'
  fields of the 'patch-delegated' field were apparently invalid.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'comments'
Stephen Finucane [Thu, 16 Apr 2020 10:48:29 +0000 (11:48 +0100)] 
docs: Resolve issues with 'comments'

Each header in the 'headers' field can be either a string or a list
value.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'patches'
Stephen Finucane [Thu, 16 Apr 2020 09:02:36 +0000 (10:02 +0100)] 
docs: Resolve issues with 'patches'

Two issues:

- Errors are reported as a mapping of the field name to an array of
  errors, not a string.
- We were attempting to validate an invalid request.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'covers'
Stephen Finucane [Wed, 15 Apr 2020 23:51:17 +0000 (00:51 +0100)] 
docs: Resolve issues with 'covers'

Two issues to correct:

- Each header in the 'headers' field can be either a string or a list
  value.
- We state that the 'content' field will always have content but our
  tests were configuring otherwise.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'bundles'
Stephen Finucane [Wed, 15 Apr 2020 23:47:26 +0000 (00:47 +0100)] 
docs: Resolve issues with 'bundles'

Errors are reported as a mapping of the field name to an array of
errors, not a string.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'projects'
Stephen Finucane [Wed, 15 Apr 2020 23:43:40 +0000 (00:43 +0100)] 
docs: Resolve issues with 'projects'

Two issues here:

- The ID in '/projects/{id}' can be either an integer or a string.
- We were attempting to validate an invalid request.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Resolve issues with 'patches'
Stephen Finucane [Wed, 15 Apr 2020 22:36:59 +0000 (23:36 +0100)] 
docs: Resolve issues with 'patches'

Four issues to resolve:

- The 'tags' field is a key-value mapping, not an array.
- Each header in the 'headers' field can be either a string or a list
  value.
- Errors are reported as a mapping of the field name to an array of
  errors, not a string.
- The security type information isn't complete and doesn't account for
  security types. Skip it for now.

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Move common path parameters to parent
Stephen Finucane [Thu, 16 Apr 2020 10:43:04 +0000 (11:43 +0100)] 
docs: Move common path parameters to parent

Turns out you don't have to nest common elements under individual routes
[1]. Less duplication and more sensible docs = winning.

[1] https://swagger.io/specification/#pathItemObject

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Make embedded fields nullable by default
Stephen Finucane [Wed, 15 Apr 2020 22:37:17 +0000 (23:37 +0100)] 
docs: Make embedded fields nullable by default

As discussed at [1], "subtypes can add restrictions, but they cannot
relax restrictions that are already in place." These fields need to be
marked nullable and then "subclassed" to set non-nullability if
required.

[1] https://github.com/OAI/OpenAPI-Specification/issues/1368

Signed-off-by: Stephen Finucane <stephen@that.guru>
5 years agodocs: Add schema validation to 'generate-schemas' tool
Stephen Finucane [Sat, 18 Apr 2020 10:49:38 +0000 (11:49 +0100)] 
docs: Add schema validation to 'generate-schemas' tool

Just to make sure we're not generating garbage.

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