diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e3e110127..d1d60e3fa 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,6 +1,15 @@ +--- version: 2 updates: - package-ecosystem: "pip" directory: "/" # Location of package manifests schedule: interval: "weekly" + versioning-strategy: "increase" + ignore: + - dependency-name: "*" + update-types: ["version-update:semver-patch"] + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index a4a65789b..dbcdd3bee 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -3,19 +3,22 @@ name: CI on: - push - pull_request +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true jobs: lint: name: Run linters runs-on: ubuntu-latest steps: - name: Checkout source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: - python-version: "3.12" + python-version: "3.13" - name: Set up Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: go-version: "1.21" - name: Install dependencies @@ -29,7 +32,7 @@ jobs: matrix: # NOTE: If you add a version here, don't forget to update the # '[gh-actions]' section in tox.ini - python: ["3.8", "3.9", "3.10", "3.11", "3.12"] + python: ["3.9", "3.10", "3.11", "3.12", "3.13"] db: [postgres, mysql, sqlite3] env: DATABASE_TYPE: "${{ matrix.db }}" @@ -68,9 +71,9 @@ jobs: --health-retries 5 steps: - name: Checkout source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python }} - name: Install Python dependencies @@ -99,19 +102,19 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: - python-version: "3.12" + python-version: "3.13" - name: Install dependencies run: python -m pip install tox - name: Build docs (via tox) run: tox -e docs - name: Archive build results - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: html-docs-build path: docs/_build/html @@ -126,39 +129,39 @@ jobs: COMPOSE_FILE: ${{ matrix.db == 'mysql' && 'docker-compose.yml' || (matrix.db == 'postgres' && 'docker-compose-pg.yml') || 'docker-compose-sqlite3.yml' }} steps: - name: Checkout source code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: - python-version: "3.12" + python-version: "3.13" - name: Build docker-compose service run: | - docker-compose build --build-arg UID=$(id -u) --build-arg GID=$(id -g) + docker compose build --build-arg UID=$(id -u) --build-arg GID=$(id -g) - name: Test createsuperuser/changepassword run: | - docker-compose run -T --rm web \ + docker compose run -T --rm web \ python manage.py createsuperuser \ --username patchwork --no-input --email test@example.com { echo patchwork; echo patchwork; } | \ - docker-compose run -T --rm web \ + docker compose run -T --rm web \ python manage.py changepassword patchwork # FIXME(stephenfin): Re-enable this once dbbackup supports Django 4.0 # - name: Test dbbackup/dbrestore # run: | - # docker-compose run -T --rm web python manage.py dbbackup - # echo y | docker-compose run -T --rm web python manage.py dbrestore + # docker compose run -T --rm web python manage.py dbbackup + # echo y | docker compose run -T --rm web python manage.py dbrestore - name: Modify database user permissions (mysql) if: ${{ matrix.db == 'mysql' }} run: | - docker-compose exec -T -- db \ + docker compose exec -T -- db \ sh -c "exec mysql -uroot -p\"\${MYSQL_ROOT_PASSWORD}\" -e \"GRANT ALL ON \\\`test\\_\${MYSQL_DATABASE}%\\\`.* to '\${MYSQL_USER}'@'%'; FLUSH PRIVILEGES;\"" - name: Run unittest - run: docker-compose run -T --rm web tox + run: docker compose run -T --rm web tox - name: Test normal startup run: | - docker-compose up --detach + docker compose up --detach for count in $(seq 50); do \ if curl --fail --silent "http://localhost:8000"; then \ @@ -168,7 +171,7 @@ jobs: done echo - docker-compose ps + docker compose ps - name: Test client access (git-pw) run: | python -m pip install git-pw @@ -177,4 +180,4 @@ jobs: --username patchwork --password patchwork series list - name: Dump container logs if: ${{ always() }} - run: docker-compose logs --no-color --timestamps + run: docker compose logs --no-color --timestamps diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 367d7e05c..d67cf098e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,10 +1,7 @@ --- -default_language_version: - # force all unspecified python hooks to run python3 - python: python3 repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.5.0 + rev: v5.0.0 hooks: - id: check-executables-have-shebangs - id: check-merge-conflict @@ -14,7 +11,7 @@ repos: - id: trailing-whitespace exclude: (.*\.mbox)|(.*\.svg) - repo: https://github.com/Lucas-C/pre-commit-hooks - rev: v1.5.4 + rev: v1.5.5 hooks: - id: remove-tabs exclude: (.*\.mbox)|(.*\.svg)|(.*\.sql)|(.*\.conf) @@ -22,7 +19,7 @@ repos: exclude: (.*\.mbox)|(.*\.svg) - repo: https://github.com/astral-sh/ruff-pre-commit # Ruff version. - rev: v0.1.13 + rev: v0.7.0 hooks: # Run the linter. - id: ruff @@ -33,7 +30,7 @@ repos: hooks: - id: bashate - repo: https://github.com/daveshanley/vacuum - rev: v0.7.2 + rev: v0.12.1 hooks: - id: vacuum files: ^docs/api/schemas/(latest|v\d\.\d)/patchwork.yaml diff --git a/README.rst b/README.rst index 979801fb3..ebde1f363 100644 --- a/README.rst +++ b/README.rst @@ -85,11 +85,14 @@ environment. To install Patchwork: $ git clone https://github.com/getpatchwork/patchwork.git -3. Create a ``.env`` file in the root directory of the project and store your - ``UID`` and ``GID`` attributes there:: +3. (Optional) Create a ``.env`` file in the root directory of the project and + store your ``UID`` and ``GID`` attributes there:: $ cd patchwork && printf "UID=$(id -u)\nGID=$(id -g)\n" > .env + This should only be necessary if you have a ``UID`` or ``GID`` other than + ``1000``. + 4. Build the images. This will download a number of packages from the internet, and compile several versions of Python:: diff --git a/docker-compose-pg.yml b/docker-compose-pg.yml index 645f93e16..44bc3ec0a 100644 --- a/docker-compose-pg.yml +++ b/docker-compose-pg.yml @@ -1,4 +1,4 @@ -version: "3" +--- services: db: image: postgres:latest diff --git a/docker-compose-sqlite3.yml b/docker-compose-sqlite3.yml index d4c66593f..900cb71fd 100644 --- a/docker-compose-sqlite3.yml +++ b/docker-compose-sqlite3.yml @@ -1,4 +1,4 @@ -version: "3" +--- services: web: build: diff --git a/docker-compose.yml b/docker-compose.yml index 9bff93f65..73f080a49 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,4 +1,4 @@ -version: "3" +--- services: db: image: mysql:latest diff --git a/docs/api/rest/index.rst b/docs/api/rest/index.rst index 67022e6f3..97095d13e 100644 --- a/docs/api/rest/index.rst +++ b/docs/api/rest/index.rst @@ -8,7 +8,7 @@ This guide provides an overview of how one can interact with the REST API. For detailed information on type and response format of the various resources exposed by the API, refer to the web browsable API. This can be found at: - https://patchwork.example.com/api/1.3/ + https://patchwork.example.com/api/1.4/ where `patchwork.example.com` refers to the URL of your Patchwork instance. @@ -43,6 +43,11 @@ If all you want is reference guides, skip straight to :ref:`rest-api-schemas`. The API version was bumped to v1.3 in Patchwork v3.1. The older APIs are still supported. For more information, refer to :ref:`rest-api-versions`. +.. versionchanged:: 3.2 + + The API version was bumped to v1.4 in Patchwork v3.2. The older APIs are + still supported. For more information, refer to :ref:`rest-api-versions`. + Getting Started --------------- @@ -57,16 +62,16 @@ Patchwork instance hosted at `patchwork.example.com`, run: .. code-block:: shell - $ curl -s 'https://patchwork.example.com/api/1.3/' | python -m json.tool + $ curl -s 'https://patchwork.example.com/api/1.4/' | python -m json.tool { - "bundles": "https://patchwork.example.com/api/1.3/bundles/", - "covers": "https://patchwork.example.com/api/1.3/covers/", - "events": "https://patchwork.example.com/api/1.3/events/", - "patches": "https://patchwork.example.com/api/1.3/patches/", - "people": "https://patchwork.example.com/api/1.3/people/", - "projects": "https://patchwork.example.com/api/1.3/projects/", - "series": "https://patchwork.example.com/api/1.3/series/", - "users": "https://patchwork.example.com/api/1.3/users/" + "bundles": "https://patchwork.example.com/api/1.4/bundles/", + "covers": "https://patchwork.example.com/api/1.4/covers/", + "events": "https://patchwork.example.com/api/1.4/events/", + "patches": "https://patchwork.example.com/api/1.4/patches/", + "people": "https://patchwork.example.com/api/1.4/people/", + "projects": "https://patchwork.example.com/api/1.4/projects/", + "series": "https://patchwork.example.com/api/1.4/series/", + "users": "https://patchwork.example.com/api/1.4/users/" } @@ -79,17 +84,17 @@ well-supported. To repeat the above example using `requests`:, run $ python >>> import json >>> import requests - >>> r = requests.get('https://patchwork.example.com/api/1.3/') + >>> r = requests.get('https://patchwork.example.com/api/1.4/') >>> print(json.dumps(r.json(), indent=2)) { - "bundles": "https://patchwork.example.com/api/1.3/bundles/", - "covers": "https://patchwork.example.com/api/1.3/covers/", - "events": "https://patchwork.example.com/api/1.3/events/", - "patches": "https://patchwork.example.com/api/1.3/patches/", - "people": "https://patchwork.example.com/api/1.3/people/", - "projects": "https://patchwork.example.com/api/1.3/projects/", - "series": "https://patchwork.example.com/api/1.3/series/", - "users": "https://patchwork.example.com/api/1.3/users/" + "bundles": "https://patchwork.example.com/api/1.4/bundles/", + "covers": "https://patchwork.example.com/api/1.4/covers/", + "events": "https://patchwork.example.com/api/1.4/events/", + "patches": "https://patchwork.example.com/api/1.4/patches/", + "people": "https://patchwork.example.com/api/1.4/people/", + "projects": "https://patchwork.example.com/api/1.4/projects/", + "series": "https://patchwork.example.com/api/1.4/series/", + "users": "https://patchwork.example.com/api/1.4/users/" } Tools like `curl` and libraries like `requests` can be used to build anything @@ -108,7 +113,7 @@ Versioning ---------- By default, all requests will receive the latest version of the API: currently -``1.3``: +``1.4``: .. code-block:: http @@ -119,7 +124,7 @@ changes breaking your application: .. code-block:: http - GET /api/1.3 HTTP/1.1 + GET /api/1.4 HTTP/1.1 Older API versions will be deprecated and removed over time. For more information, refer to :ref:`rest-api-versions`. @@ -275,6 +280,7 @@ Supported Versions 1.1, 2.1, ✓ 1.2, 2.2, ✓ 1.3, 3.1, ✓ + 1.4, 3.2, ✓ Further information about this and more can typically be found in :doc:`the release notes `. @@ -292,6 +298,7 @@ Auto-generated schema documentation is provided below. /api/rest/schemas/v1.1 /api/rest/schemas/v1.2 /api/rest/schemas/v1.3 + /api/rest/schemas/v1.4 .. Links diff --git a/docs/api/rest/schemas/v1.3.rst b/docs/api/rest/schemas/v1.3.rst index 17a4421ae..6bbf1a560 100644 --- a/docs/api/rest/schemas/v1.3.rst +++ b/docs/api/rest/schemas/v1.3.rst @@ -1,5 +1,5 @@ -API v1.3 (latest) -================= +API v1.3 +======== .. openapi:: ../../schemas/v1.3/patchwork.yaml :examples: diff --git a/docs/api/rest/schemas/v1.4.rst b/docs/api/rest/schemas/v1.4.rst new file mode 100644 index 000000000..11e34f6a5 --- /dev/null +++ b/docs/api/rest/schemas/v1.4.rst @@ -0,0 +1,5 @@ +API v1.4 (latest) +================= + +.. openapi:: ../../schemas/v1.4/patchwork.yaml + :examples: diff --git a/docs/api/schemas/generate-schemas.py b/docs/api/schemas/generate-schemas.py index 14b741473..52008dffd 100755 --- a/docs/api/schemas/generate-schemas.py +++ b/docs/api/schemas/generate-schemas.py @@ -14,8 +14,8 @@ yaml = None ROOT_DIR = os.path.dirname(os.path.realpath(__file__)) -VERSIONS = [(1, 0), (1, 1), (1, 2), (1, 3), None] -LATEST_VERSION = (1, 3) +VERSIONS = [(1, 0), (1, 1), (1, 2), (1, 3), (1, 4), None] +LATEST_VERSION = (1, 4) def generate_schemas(): diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml index 93e56fa0f..ae2c7e9cf 100644 --- a/docs/api/schemas/latest/patchwork.yaml +++ b/docs/api/schemas/latest/patchwork.yaml @@ -13,7 +13,7 @@ info: license: name: GPL v2 License url: https://www.gnu.org/licenses/gpl-2.0.html - version: '1.3' + version: '1.4' paths: /api: get: @@ -816,6 +816,190 @@ paths: $ref: '#/components/schemas/Error' tags: - comments + /api/patches/{patch_id}/notes/{note_id}: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: note_id + description: A unique integer value identifying the note. + required: true + schema: + title: Note ID + type: integer + get: + summary: Retrieve a patch note. + description: | + Retrieve note from a patch by the ID of the patch. + operationId: patch_notes_read + responses: + '200': + description: 'A patch note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + patch: + summary: Update a patch note. + description: + Partially update an existing patch note. + You must be a maintainer of the project that the patch note belongs to. + operationId: patch_notes_update + requestBody: + $ref: '#/components/requestBodies/Note' + responses: + '200': + description: 'Updated note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorNoteUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + delete: + summary: Delete a patch note. + description: + Delete an existing patch note. + You must be a maintainer of the project that the patch note belongs to. + operationId: patch_notes_delete + requestBody: + $ref: '#/components/requestBodies/Note' + responses: + '204': + description: 'Delete note' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorNoteUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + /api/patches/{patch_id}/notes: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + post: + summary: Create a patch note. + description: | + Create note for a patch. + operationId: patch_notes_create + responses: + '200': + description: 'A patch note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '201': + description: 'Created' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + get: + summary: Retrieve all notes from a patch. + description: | + Retrieve all note from a specific patch. + operationId: patch_notes_list + responses: + '200': + description: 'A list of patch notes' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Note' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + /api/patches/{patch_id}/checks: parameters: - in: path @@ -1478,6 +1662,14 @@ components: application/json: schema: $ref: '#/components/schemas/CommentUpdate' + Note: + required: true + description: | + A patch note. + content: + application/json: + schema: + $ref: '#/components/schemas/NoteUpdate' Patch: required: true description: | @@ -2170,6 +2362,43 @@ components: $ref: '#/components/schemas/PatchEmbedded' comment: $ref: '#/components/schemas/CommentEmbedded' + Note: + type: object + title: Note + description: | + A note + properties: + id: + title: ID + type: integer + readOnly: true + created_at: + title: CreatedAt + type: string + format: iso8601 + readOnly: true + updated_at: + title: UpdatedAt + type: string + format: iso8601 + readOnly: true + submitter: + type: object + title: Submitter + readOnly: true + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + content: + title: Content + type: string + readOnly: true + minLength: 1 + NoteUpdate: + type: object + properties: + addressed: + title: Addressed + type: boolean PatchList: required: - state @@ -3134,6 +3363,17 @@ components: type: array items: type: string + ErrorNoteUpdate: + type: object + title: A note update error. + description: | + A mapping of field names to validation failures. + properties: + addressed: + title: Addressed + type: array + items: + type: string ErrorPatchUpdate: type: object title: A patch update error. @@ -3210,6 +3450,8 @@ tags: description: Series operations - name: comments description: Comment operations + - name: notes + description: Note operations - name: people description: Submitter operations - name: users diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2 index 516fbe88d..a2928c229 100644 --- a/docs/api/schemas/patchwork.j2 +++ b/docs/api/schemas/patchwork.j2 @@ -840,6 +840,192 @@ paths: $ref: '#/components/schemas/Error' tags: - comments +{% endif %} +{% if version >= (1, 4) %} + /api/{{ version_url }}patches/{patch_id}/notes/{note_id}: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: note_id + description: A unique integer value identifying the note. + required: true + schema: + title: Note ID + type: integer + get: + summary: Retrieve a patch note. + description: | + Retrieve note from a patch by the ID of the patch. + operationId: patch_notes_read + responses: + '200': + description: 'A patch note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + patch: + summary: Update a patch note. + description: + Partially update an existing patch note. + You must be a maintainer of the project that the patch note belongs to. + operationId: patch_notes_update + requestBody: + $ref: '#/components/requestBodies/Note' + responses: + '200': + description: 'Updated note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorNoteUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + delete: + summary: Delete a patch note. + description: + Delete an existing patch note. + You must be a maintainer of the project that the patch note belongs to. + operationId: patch_notes_delete + requestBody: + $ref: '#/components/requestBodies/Note' + responses: + '204': + description: 'Delete note' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorNoteUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + /api/{{ version_url }}patches/{patch_id}/notes: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + post: + summary: Create a patch note. + description: | + Create note for a patch. + operationId: patch_notes_create + responses: + '200': + description: 'A patch note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '201': + description: 'Created' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + get: + summary: Retrieve all notes from a patch. + description: | + Retrieve all note from a specific patch. + operationId: patch_notes_list + responses: + '200': + description: 'A list of patch notes' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Note' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + {% endif %} /api/{{ version_url }}patches/{patch_id}/checks: parameters: @@ -1518,6 +1704,16 @@ components: application/json: schema: $ref: '#/components/schemas/CommentUpdate' +{% endif %} +{% if version >= (1, 4) %} + Note: + required: true + description: | + A patch note. + content: + application/json: + schema: + $ref: '#/components/schemas/NoteUpdate' {% endif %} Patch: required: true @@ -2248,6 +2444,45 @@ components: $ref: '#/components/schemas/PatchEmbedded' comment: $ref: '#/components/schemas/CommentEmbedded' +{% if version >= (1, 4) %} + Note: + type: object + title: Note + description: | + A note + properties: + id: + title: ID + type: integer + readOnly: true + created_at: + title: CreatedAt + type: string + format: iso8601 + readOnly: true + updated_at: + title: UpdatedAt + type: string + format: iso8601 + readOnly: true + submitter: + type: object + title: Submitter + readOnly: true + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + content: + title: Content + type: string + readOnly: true + minLength: 1 + NoteUpdate: + type: object + properties: + addressed: + title: Addressed + type: boolean +{% endif %} PatchList: required: - state @@ -3251,6 +3486,19 @@ components: type: array items: type: string +{% endif %} +{% if version >= (1, 4) %} + ErrorNoteUpdate: + type: object + title: A note update error. + description: | + A mapping of field names to validation failures. + properties: + addressed: + title: Addressed + type: array + items: + type: string {% endif %} ErrorPatchUpdate: type: object @@ -3328,6 +3576,10 @@ tags: description: Series operations - name: comments description: Comment operations +{% if version >= (1, 4) %} + - name: notes + description: Note operations +{% endif %} - name: people description: Submitter operations - name: users diff --git a/docs/api/schemas/v1.4/patchwork.yaml b/docs/api/schemas/v1.4/patchwork.yaml new file mode 100644 index 000000000..8ac2b8fad --- /dev/null +++ b/docs/api/schemas/v1.4/patchwork.yaml @@ -0,0 +1,3468 @@ +# DO NOT EDIT THIS FILE. It is generated from a template. Changes should be +# proposed against the template and updated files generated using the +# 'generate-schemas.py' tool +--- +openapi: '3.1.0' +info: + title: Patchwork API + description: | + Patchwork is a web-based patch tracking system designed to facilitate the + contribution and management of contributions to an open-source project. + contact: + email: patchwork@lists.ozlabs.org + license: + name: GPL v2 License + url: https://www.gnu.org/licenses/gpl-2.0.html + version: '1.4' +paths: + /api/1.4/: + get: + summary: List API resources. + description: | + Show paths to all supported API resources. + operationId: api_list + parameters: [] + responses: + '200': + description: 'List of API resources' + content: + application/json: + schema: + $ref: '#/components/schemas/Index' + tags: + - api + /api/1.4/bundles: + get: + summary: List bundles. + description: | + List all bundles that the current user has access to. + For unauthenticated requests, only public bundles can be shown. + operationId: bundles_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + - in: query + name: project + description: An ID or linkname of a project to filter bundles by. + schema: + title: '' + type: string + - in: query + name: owner + description: An ID or username of a user to filter bundles by. + schema: + title: '' + type: string + - in: query + name: public + description: Show only public (`true`) or private (`false`) bundles. + schema: + title: '' + type: string + enum: + - 'true' + - 'false' + responses: + '200': + description: 'List of bundles' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Bundle' + tags: + - bundles + post: + summary: Create a bundle. + description: | + Create a new bundle. + operationId: bundles_create + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Bundle' + responses: + '201': + description: 'Created bundle' + content: + application/json: + schema: + $ref: '#/components/schemas/Bundle' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorBundleCreateUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - bundles + /api/1.4/bundles/{id}: + parameters: + - in: path + name: id + required: true + description: A unique integer value identifying this bundle. + schema: + title: ID + type: integer + get: + summary: Show a bundle. + description: | + Retrieve a bundle by its ID. + The bundle must be either be public or be owned by the currently authenticated user. + operationId: bundles_read + responses: + '200': + description: 'A bundle' + content: + application/json: + schema: + $ref: '#/components/schemas/Bundle' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - bundles + patch: + summary: Update a bundle (partial). + description: + Partially update an existing bundle. + The bundle must be owned by the currently authenticated user. + operationId: bundles_partial_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Bundle' + responses: + '200': + description: 'Updated bundle' + content: + application/json: + schema: + $ref: '#/components/schemas/Bundle' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorBundleCreateUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - bundles + put: + summary: Update a bundle. + description: + Update an existing bundle. + The bundle must be owned by the currently authenticated user. + operationId: bundles_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Bundle' + responses: + '200': + description: 'Updated bundle' + content: + application/json: + schema: + $ref: '#/components/schemas/Bundle' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorBundleCreateUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - bundles + /api/1.4/covers: + get: + summary: List cover letters. + description: | + List all cover letters. + operationId: covers_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + - $ref: '#/components/parameters/BeforeFilter' + - $ref: '#/components/parameters/SinceFilter' + - in: query + name: project + description: | + An ID or linkname of a project to filter cover letters by. + schema: + title: '' + type: string + - in: query + name: series + description: An ID of a series to filter cover letters by. + schema: + title: '' + type: string + - in: query + name: submitter + description: | + An ID or email address of a person to filter cover letters by. + schema: + title: '' + type: string + - in: query + name: msgid + description: | + The cover message-id as a case-sensitive string, without leading or + trailing angle brackets, to filter by. + schema: + title: '' + type: string + responses: + '200': + description: 'List of cover letters' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CoverList' + tags: + - covers + /api/1.4/covers/{id}: + parameters: + - in: path + name: id + description: A unique integer value identifying this cover letter. + required: true + schema: + title: ID + type: integer + get: + summary: Show a cover letter. + description: | + Retrieve a cover letter by its ID. + operationId: covers_read + responses: + '200': + description: 'A cover letter' + content: + application/json: + schema: + $ref: '#/components/schemas/CoverDetail' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - covers + /api/1.4/covers/{id}/comments: + parameters: + - in: path + name: id + description: | + A unique integer value identifying the parent cover letter. + required: true + schema: + title: ID + type: integer + get: + summary: List cover letter comments + description: | + List all comments for the given cover letter. + operationId: cover_comments_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + responses: + '200': + description: 'List of comments' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Comment' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - comments + /api/1.4/covers/{cover_id}/comments/{comment_id}: + parameters: + - in: path + name: cover_id + description: A unique integer value identifying the parent cover. + required: true + schema: + title: Cover ID + type: integer + - in: path + name: comment_id + description: A unique integer value identifying this comment. + required: true + schema: + title: Comment ID + type: integer + get: + summary: Show a cover letter comment. + description: | + Retrieve a cover letter comment by its ID. + operationId: cover_comments_read + responses: + '200': + description: 'A cover letter comment' + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - comments + patch: + summary: Update a cover letter comment (partial). + description: + Partially update an existing cover letter comment. + You must be a maintainer of the project that the cover letter comment belongs to. + operationId: cover_comments_partial_update + requestBody: + $ref: '#/components/requestBodies/Comment' + responses: + '200': + description: 'Updated cover letter comment' + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorCommentUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - comments + /api/1.4/events: + get: + summary: List events. + description: | + List all events. + This list can be quite large. You are encouraged to use filters to narrow it to specific categories or project(s). + operationId: events_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + - $ref: '#/components/parameters/BeforeFilter' + - $ref: '#/components/parameters/SinceFilter' + - in: query + name: project + description: An ID or linkname of a project to filter events by. + schema: + title: '' + type: string + - in: query + name: category + description: | + An event category to filter events by. These categories are subject + to change depending on the version of Patchwork deployed and are + not subject to the versionining constraints present across the rest + of the API. + schema: + title: '' + type: string + enum: + - cover-created + - patch-created + - patch-completed + - patch-state-changed + - patch-relation-changed + - patch-delegated + - check-created + - series-created + - series-completed + - cover-comment-created + - patch-comment-created + - in: query + name: series + description: An ID of a series to filter events by. + schema: + title: '' + type: integer + - in: query + name: patch + description: An ID of a patch to filter events by. + schema: + title: '' + type: integer + - in: query + name: cover + description: An ID of a cover letter to filter events by. + schema: + title: '' + type: integer + responses: + '200': + description: 'List of events' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + anyOf: + - $ref: '#/components/schemas/EventCoverCreated' + - $ref: '#/components/schemas/EventPatchCreated' + - $ref: '#/components/schemas/EventPatchCompleted' + - $ref: '#/components/schemas/EventPatchStateChanged' + - $ref: '#/components/schemas/EventPatchRelationChanged' + - $ref: '#/components/schemas/EventPatchDelegated' + - $ref: '#/components/schemas/EventCheckCreated' + - $ref: '#/components/schemas/EventSeriesCreated' + - $ref: '#/components/schemas/EventSeriesCompleted' + - $ref: '#/components/schemas/EventCoverCommentCreated' + - $ref: '#/components/schemas/EventPatchCommentCreated' + discriminator: + propertyName: category + mapping: + cover-created: '#/components/schemas/EventCoverCreated' + patch-created: '#/components/schemas/EventPatchCreated' + patch-completed: '#/components/schemas/EventPatchCompleted' + patch-state-changed: '#/components/schemas/EventPatchStateChanged' + patch-relation-changed: '#/components/schemas/EventPatchRelationChanged' + patch-delegated: '#/components/schemas/EventPatchDelegated' + check-created: '#/components/schemas/EventCheckCreated' + series-created: '#/components/schemas/EventSeriesCreated' + series-completed: '#/components/schemas/EventSeriesCompleted' + cover-comment-created: '#/components/schemas/EventCoverCommentCreated' + patch-comment-created: '#/components/schemas/EventPatchCommentCreated' + tags: + - events + /api/1.4/patches: + get: + summary: List patches. + description: | + List all patches. + operationId: patches_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + - $ref: '#/components/parameters/BeforeFilter' + - $ref: '#/components/parameters/SinceFilter' + - in: query + name: project + description: An ID or linkname of a project to filter patches by. + schema: + title: '' + type: string + - in: query + name: series + description: An ID of a series to filter patches by. + schema: + title: '' + type: integer + - in: query + name: submitter + description: | + An ID or email address of a person to filter patches by. + schema: + title: '' + type: string + - in: query + name: delegate + description: An ID or username of a user to filter patches by. + schema: + title: '' + type: string + - in: query + name: state + description: A slug representation of a state to filter patches by. + schema: + title: '' + type: string + - in: query + name: archived + description: | + Show only archived (`true`) or non-archived (`false`) patches. + schema: + title: '' + type: string + enum: + - 'true' + - 'false' + - in: query + name: hash + description: | + The patch hash as a case-insensitive hexadecimal string, to filter by. + schema: + title: '' + type: string + - in: query + name: msgid + description: | + The patch message-id as a case-sensitive string, without leading or + trailing angle brackets, to filter by. + schema: + title: '' + type: string + responses: + '200': + description: 'List of patches' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PatchList' + tags: + - patches + /api/1.4/patches/{id}: + parameters: + - in: path + name: id + description: A unique integer value identifying this patch. + required: true + schema: + title: ID + type: integer + get: + summary: Show a patch. + description: | + Retrieve a patch by its ID. + operationId: patches_read + responses: + '200': + description: 'A patch' + content: + application/json: + schema: + $ref: '#/components/schemas/PatchDetail' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - patches + patch: + summary: Update a patch (partial). + description: + Partially update an existing patch. + You must be a maintainer of the project that the patch belongs to. + operationId: patches_partial_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Patch' + responses: + '200': + description: 'An updated patch' + content: + application/json: + schema: + $ref: '#/components/schemas/PatchDetail' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorPatchUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '409': + description: 'Conflict' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - patches + put: + description: Update a patch. + operationId: patches_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Patch' + responses: + '200': + description: 'An updated patch' + content: + application/json: + schema: + $ref: '#/components/schemas/PatchDetail' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorPatchUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '409': + description: 'Conflict' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - patches + /api/1.4/patches/{id}/comments: + parameters: + - in: path + name: id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: ID + type: integer + get: + summary: List patch comments + description: | + List all comments for the given patch. + operationId: patch_comments_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + responses: + '200': + description: 'List of comments' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Comment' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - comments + /api/1.4/patches/{patch_id}/comments/{comment_id}: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: comment_id + description: A unique integer value identifying this comment. + required: true + schema: + title: Comment ID + type: integer + get: + summary: Show a patch comment. + description: | + Retrieve a patch comment by its ID and the ID of the patch. + operationId: patch_comments_read + responses: + '200': + description: 'A patch comment' + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - comments + patch: + summary: Update a patch comment (partial). + description: + Partially update an existing patch comment. + You must be a maintainer of the project that the patch comment belongs to. + operationId: patch_comments_partial_update + requestBody: + $ref: '#/components/requestBodies/Comment' + responses: + '200': + description: 'Updated patch' + content: + application/json: + schema: + $ref: '#/components/schemas/Comment' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorCommentUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - comments + /api/1.4/patches/{patch_id}/notes/{note_id}: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: note_id + description: A unique integer value identifying the note. + required: true + schema: + title: Note ID + type: integer + get: + summary: Retrieve a patch note. + description: | + Retrieve note from a patch by the ID of the patch. + operationId: patch_notes_read + responses: + '200': + description: 'A patch note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + patch: + summary: Update a patch note. + description: + Partially update an existing patch note. + You must be a maintainer of the project that the patch note belongs to. + operationId: patch_notes_update + requestBody: + $ref: '#/components/requestBodies/Note' + responses: + '200': + description: 'Updated note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorNoteUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + delete: + summary: Delete a patch note. + description: + Delete an existing patch note. + You must be a maintainer of the project that the patch note belongs to. + operationId: patch_notes_delete + requestBody: + $ref: '#/components/requestBodies/Note' + responses: + '204': + description: 'Delete note' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorNoteUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + /api/1.4/patches/{patch_id}/notes: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + post: + summary: Create a patch note. + description: | + Create note for a patch. + operationId: patch_notes_create + responses: + '200': + description: 'A patch note' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '201': + description: 'Created' + content: + application/json: + schema: + $ref: '#/components/schemas/Note' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + get: + summary: Retrieve all notes from a patch. + description: | + Retrieve all note from a specific patch. + operationId: patch_notes_list + responses: + '200': + description: 'A list of patch notes' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Note' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - notes + + /api/1.4/patches/{patch_id}/checks: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + get: + summary: List checks. + description: | + List all checks for the given patch. + operationId: checks_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + - $ref: '#/components/parameters/BeforeFilter' + - $ref: '#/components/parameters/SinceFilter' + - in: query + name: user + description: An ID or username of a user to filter checks by. + schema: + title: '' + type: string + - in: query + name: state + description: A check state to filter checks by. + schema: + title: '' + type: string + enum: + - pending + - success + - warning + - fail + - in: query + name: context + description: A check context to filter checks by. + schema: + title: '' + type: string + responses: + '200': + description: 'List of checks' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Check' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - checks + post: + summary: Create a check. + operationId: checks_create + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Check' + responses: + '201': + description: 'Created check' + content: + application/json: + schema: + $ref: '#/components/schemas/Check' + '400': + description: 'Invalid request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorCheckCreate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - checks + /api/1.4/patches/{patch_id}/checks/{check_id}: + parameters: + - in: path + name: patch_id + description: A unique integer value identifying the parent patch. + required: true + schema: + title: Patch ID + type: integer + - in: path + name: check_id + description: A unique integer value identifying this check. + required: true + schema: + title: Check ID + type: integer + get: + summary: Show a check. + description: | + Retrieve a check by its ID. + operationId: checks_read + responses: + '200': + description: 'A check' + content: + application/json: + schema: + $ref: '#/components/schemas/Check' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - checks + /api/1.4/people: + get: + summary: List people. + description: | + List all people. + A person is anyone that has submitted a patch, a series of patches, or a comment to any project. + operationId: people_list + security: + - basicAuth: [] + - apiKeyAuth: [] + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + responses: + '200': + description: 'List of people' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Person' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - people + /api/1.4/people/{id}: + parameters: + - in: path + name: id + description: A unique integer value identifying this person. + required: true + schema: + title: ID + type: integer + get: + summary: Show a person. + description: | + Retrieve a person by their ID. + A person is anyone that has submitted a patch, a series of patches, or a comment to any project. + operationId: people_read + security: + - basicAuth: [] + - apiKeyAuth: [] + responses: + '200': + description: 'A person' + content: + application/json: + schema: + $ref: '#/components/schemas/Person' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - people + /api/1.4/projects: + get: + summary: List projects. + description: | + List all projects. + operationId: projects_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + responses: + '200': + description: 'List of projects' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Project' + tags: + - projects + /api/1.4/projects/{id}: + parameters: + - in: path + name: id + description: A unique integer value identifying this project. + required: true + schema: + title: ID + # TODO: Add regex? + type: string + get: + summary: Show a project. + description: | + Retrieve a project by its ID. + operationId: projects_read + responses: + '200': + description: 'A project' + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - projects + patch: + summary: Update a project (partial). + description: + Partially update an existing project. + You must be a maintainer of the project. + operationId: projects_partial_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Project' + responses: + '200': + description: 'Updated project' + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorProjectUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - projects + put: + description: Update a project. + operationId: projects_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/Project' + responses: + '200': + description: 'Updated project' + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorProjectUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - projects + /api/1.4/series: + get: + summary: List series. + description: | + List all series. + A series is a collection of patches with an optional cover letter. + operationId: series_list + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + - $ref: '#/components/parameters/BeforeFilter' + - $ref: '#/components/parameters/SinceFilter' + - in: query + name: submitter + description: An ID or email address of a person to filter series by. + schema: + title: '' + type: string + - in: query + name: project + description: An ID or linkname of a project to filter series by. + schema: + title: '' + type: string + responses: + '200': + description: 'List of series' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Series' + tags: + - series + /api/1.4/series/{id}: + parameters: + - in: path + name: id + description: A unique integer value identifying this series. + required: true + schema: + title: ID + type: integer + get: + summary: Show a series. + description: | + Retrieve a series by its ID. + A series is a collection of patches with an optional cover letter. + operationId: series_read + responses: + '200': + description: 'A series' + content: + application/json: + schema: + $ref: '#/components/schemas/Series' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - series + /api/1.4/users: + get: + summary: List users. + description: | + List all users. + operationId: users_list + security: + - basicAuth: [] + - apiKeyAuth: [] + parameters: + - $ref: '#/components/parameters/Page' + - $ref: '#/components/parameters/PageSize' + - $ref: '#/components/parameters/Order' + - $ref: '#/components/parameters/Search' + responses: + '200': + description: 'List of users' + headers: + Link: + $ref: '#/components/headers/Link' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - users + /api/1.4/users/{id}: + parameters: + - in: path + name: id + description: A unique integer value identifying this user. + required: true + schema: + title: ID + type: integer + get: + summary: Show a user. + description: | + Retrieve a user by their ID. + operationId: users_read + security: + - basicAuth: [] + - apiKeyAuth: [] + responses: + '200': + description: 'A user' + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetail' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - users + patch: + summary: Update a user (partial). + description: + Partially update a user account. + Only super users are allowed to update other user's accounts. + operationId: users_partial_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/User' + responses: + '200': + description: 'Updated user' + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetail' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorUserUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - users + put: + description: Update a user. + operationId: users_update + security: + - basicAuth: [] + - apiKeyAuth: [] + requestBody: + $ref: '#/components/requestBodies/User' + responses: + '200': + description: 'Updated user' + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetail' + '400': + description: 'Bad request' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorUserUpdate' + '403': + description: 'Forbidden' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '404': + description: 'Not found' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + tags: + - users +components: + securitySchemes: + basicAuth: + type: http + scheme: basic + description: | + Basic authentication. This should be avoided and may be removed in a future API release. + apiKeyAuth: + type: http + scheme: token + description: | + Token-based authentication. + cookieAuth: + type: apiKey + in: cookie + name: JSESSIONID + description: | + Cookie-based authentication. This is mainly used for the browsable API. + parameters: + Page: + in: query + name: page + description: A page number within the paginated result set. + schema: + title: Page + type: integer + PageSize: + in: query + name: per_page + description: Number of results to return per page. + schema: + title: Page size + type: integer + Order: + in: query + name: order + description: Which field to use when ordering the results. + schema: + title: Ordering + type: string + Search: + in: query + name: q + description: A search term. + schema: + title: Search + type: string + BeforeFilter: + in: query + name: before + description: Latest date-time to retrieve results for. + schema: + title: '' + type: string + SinceFilter: + in: query + name: since + description: Earliest date-time to retrieve results for. + schema: + title: '' + type: string + headers: + Link: + description: | + Links to related resources, in the format defined by + [RFC 5988](https://tools.ietf.org/html/rfc5988#section-5). + This will include a link with relation type `next` to the + next page and `prev` to the previous page, if there is a next + or previous page. It will also include links with the + relation type `first` and `last` pointing to the first and + last page, respectively. + schema: + type: string + requestBodies: + Bundle: + required: true + description: | + A patch bundle. + content: + application/json: + schema: + $ref: '#/components/schemas/BundleCreateUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/BundleCreateUpdate' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/BundleCreateUpdate' + Check: + required: true + description: | + A patch check. + content: + application/json: + schema: + $ref: '#/components/schemas/CheckCreate' + multipart/form-data: + schema: + $ref: '#/components/schemas/CheckCreate' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/CheckCreate' + Comment: + required: true + description: | + A patch or cover letter comment. + content: + application/json: + schema: + $ref: '#/components/schemas/CommentUpdate' + Note: + required: true + description: | + A patch note. + content: + application/json: + schema: + $ref: '#/components/schemas/NoteUpdate' + Patch: + required: true + description: | + A patch. + content: + application/json: + schema: + $ref: '#/components/schemas/PatchUpdate' + multipart/form-data: + schema: + $ref: '#/components/schemas/PatchUpdate' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/PatchUpdate' + Project: + required: true + description: | + A project. + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + multipart/form-data: + schema: + $ref: '#/components/schemas/Project' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/Project' + User: + required: true + description: | + A user. + content: + application/json: + schema: + $ref: '#/components/schemas/UserDetail' + multipart/form-data: + schema: + $ref: '#/components/schemas/UserDetail' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/UserDetail' + schemas: + Index: + type: object + name: Index + description: | + Paths to resource APIs + properties: + bundles: + title: Bundles URL + type: string + format: uri + readOnly: true + covers: + title: Covers URL + type: string + format: uri + readOnly: true + events: + title: Events URL + type: string + format: uri + readOnly: true + patches: + title: Patches URL + type: string + format: uri + readOnly: true + people: + title: People URL + type: string + format: uri + readOnly: true + projects: + title: Projects URL + type: string + format: uri + readOnly: true + users: + title: Users URL + type: string + format: uri + readOnly: true + series: + title: Series URL + type: string + format: uri + readOnly: true + Bundle: + required: + - name + type: object + title: Bundle + description: | + A patch bundle + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + project: + $ref: '#/components/schemas/ProjectEmbedded' + name: + title: Name + type: string + minLength: 1 + maxLength: 50 + owner: + title: Owner + readOnly: true + type: + - 'null' + - 'object' + oneOf: + - type: 'null' + - $ref: '#/components/schemas/UserEmbedded' + patches: + title: Patches + type: array + items: + $ref: '#/components/schemas/PatchEmbedded' + uniqueItems: true + public: + title: Public + type: boolean + mbox: + title: Mbox + description: | + A URL to download the bundle in mbox format. Patches will be + ordered in the same order that they are defined in the bundle. + type: string + format: uri + readOnly: true + BundleCreateUpdate: + type: object + title: Bundle create or update + description: | + The fields to set on a new or existing bundle. + required: + - name + properties: + name: + title: Name + type: string + minLength: 1 + maxLength: 50 + patches: + title: Patches + type: array + items: + type: integer + uniqueItems: true + public: + title: Public + type: boolean + Check: + type: object + title: Check + description: | + A patch check + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + user: + $ref: '#/components/schemas/UserEmbedded' + date: + title: Date + type: string + format: iso8601 + readOnly: true + state: + title: State + description: The state of the check. + type: string + enum: + - pending + - success + - warning + - fail + target_url: + title: Target URL + description: | + The target URL to associate with this check. This should be + specific to the patch. + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 200 + context: + title: Context + description: | + A label to discern check from checks of other testing systems. + type: string + pattern: ^[-a-zA-Z0-9_]+$ + minLength: 1 + maxLength: 255 + description: + title: Description + description: A brief description of the check. + type: + - 'null' + - 'string' + CheckCreate: + type: object + title: Check + description: | + A patch check + required: + - state + properties: + state: + title: State + description: The state of the check. + type: string + enum: + - pending + - success + - warning + - fail + target_url: + title: Target URL + description: | + The target URL to associate with this check. This should be + specific to the patch. + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 200 + context: + title: Context + description: | + A label to discern check from checks of other testing systems. + type: string + pattern: ^[-a-zA-Z0-9_]+$ + minLength: 1 + maxLength: 255 + description: + title: Description + description: A brief description of the check. + type: + - 'null' + - 'string' + Comment: + type: object + title: Comment + description: | + A comment + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + msgid: + title: Message ID + type: string + readOnly: true + minLength: 1 + maxLength: 255 + list_archive_url: + title: List archive URL + readOnly: true + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 2000 + date: + title: Date + type: string + format: iso8601 + readOnly: true + subject: + title: Subject + type: string + readOnly: true + submitter: + type: object + title: Submitter + readOnly: true + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + content: + title: Content + type: string + readOnly: true + minLength: 1 + headers: + title: Headers + anyOf: + - type: object + additionalProperties: + type: array + items: + type: string + - type: object + additionalProperties: + type: string + readOnly: true + addressed: + title: Addressed + type: + - 'null' + - 'boolean' + CommentUpdate: + type: object + title: Comment update + description: | + The fields to set on an existing comment. + properties: + addressed: + title: Addressed + type: + - 'null' + - 'boolean' + CoverList: + type: object + title: Cover letters + description: | + A list of cover letters + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + project: + $ref: '#/components/schemas/ProjectEmbedded' + msgid: + title: Message ID + type: string + readOnly: true + minLength: 1 + maxLength: 255 + list_archive_url: + title: List archive URL + readOnly: true + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 2000 + date: + title: Date + type: string + format: iso8601 + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + maxLength: 255 + submitter: + type: object + title: Submitter + readOnly: true + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + mbox: + title: Mbox + description: | + A URL to download the cover letter in mbox format. + type: string + format: uri + readOnly: true + series: + type: array + items: + $ref: '#/components/schemas/SeriesEmbedded' + readOnly: true + comments: + title: Comments + type: string + format: uri + readOnly: true + CoverDetail: + type: object + title: Cover letters + description: | + A list of cover letters + allOf: + - $ref: '#/components/schemas/CoverList' + - type: object + properties: + headers: + title: Headers + anyOf: + - type: object + additionalProperties: + type: array + items: + type: string + - type: object + additionalProperties: + type: string + readOnly: true + content: + title: Content + type: string + readOnly: true + minLength: 1 + EventBase: + type: object + title: Event base + description: | + Base event. Not directly used. + properties: + id: + title: ID + type: integer + readOnly: true + category: + title: Category + description: The category of the event. + type: string + readOnly: true + project: + $ref: '#/components/schemas/ProjectEmbedded' + date: + title: Date + description: The time this event was created. + type: string + format: iso8601 + readOnly: true + actor: + title: Actor + description: The user that caused/created this event. + readOnly: true + type: + - 'null' + - 'object' + oneOf: + - type: 'null' + - $ref: '#/components/schemas/UserEmbedded' + payload: + type: object + EventCoverCreated: + title: Cover created event + description: | + A cover created event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - cover-created + payload: + properties: + cover: + $ref: '#/components/schemas/CoverEmbedded' + EventPatchCreated: + title: Patch created event + description: | + A patch created event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-created + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + EventPatchCompleted: + title: Patch completed event + description: | + A patch completed event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-completed + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + series: + $ref: '#/components/schemas/SeriesEmbedded' + EventPatchStateChanged: + title: Patch state change event + description: | + A patch state changed event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-state-changed + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + previous_state: + title: Previous state + type: string + current_state: + title: Current state + type: string + EventPatchRelationChanged: + title: Patch relation change event + description: | + A patch relation changed event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-relation-changed + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + previous_relation: + title: Previous relation + type: + - 'null' + - 'string' + current_relation: + title: Current relation + type: + - 'null' + - 'string' + EventPatchDelegated: + title: Patch delegated event + description: | + A patch delegated event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-delegated + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + previous_delegate: + title: Previous delegate + type: + - 'null' + - 'object' + oneOf: + - type: 'null' + - $ref: '#/components/schemas/UserEmbedded' + current_delegate: + title: Current delegate + type: + - 'null' + - 'object' + oneOf: + - type: 'null' + - $ref: '#/components/schemas/UserEmbedded' + EventCheckCreated: + title: Check create event + description: | + A check created event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - check-created + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + check: + $ref: '#/components/schemas/CheckEmbedded' + EventSeriesCreated: + title: Series create event + description: | + A series created event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - series-created + payload: + properties: + series: + $ref: '#/components/schemas/SeriesEmbedded' + EventSeriesCompleted: + title: Series completed event + description: | + A series completed event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - series-completed + payload: + properties: + series: + $ref: '#/components/schemas/SeriesEmbedded' + EventCoverCommentCreated: + title: Cover letter comment create event + description: | + A comment letter comment created event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - cover-comment-created + payload: + properties: + cover: + $ref: '#/components/schemas/CoverEmbedded' + comment: + $ref: '#/components/schemas/CommentEmbedded' + EventPatchCommentCreated: + title: Patch comment create event + description: | + A patch comment created event. + allOf: + - $ref: '#/components/schemas/EventBase' + - type: object + properties: + category: + enum: + - patch-comment-created + payload: + properties: + patch: + $ref: '#/components/schemas/PatchEmbedded' + comment: + $ref: '#/components/schemas/CommentEmbedded' + Note: + type: object + title: Note + description: | + A note + properties: + id: + title: ID + type: integer + readOnly: true + created_at: + title: CreatedAt + type: string + format: iso8601 + readOnly: true + updated_at: + title: UpdatedAt + type: string + format: iso8601 + readOnly: true + submitter: + type: object + title: Submitter + readOnly: true + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + content: + title: Content + type: string + readOnly: true + minLength: 1 + NoteUpdate: + type: object + properties: + addressed: + title: Addressed + type: boolean + PatchList: + required: + - state + - delegate + type: object + title: Patches + description: | + A list of patches. + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + project: + $ref: '#/components/schemas/ProjectEmbedded' + msgid: + title: Message ID + type: string + readOnly: true + minLength: 1 + maxLength: 255 + list_archive_url: + title: List archive URL + readOnly: true + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 2000 + date: + title: Date + type: string + format: iso8601 + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + maxLength: 255 + commit_ref: + title: Commit ref + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + maxLength: 255 + pull_url: + title: Pull URL + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 255 + state: + title: State + type: string + archived: + title: Archived + type: boolean + hash: + title: Hash + type: string + readOnly: true + minLength: 1 + submitter: + type: object + title: Submitter + readOnly: true + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + delegate: + title: Delegate + readOnly: true + type: + - 'null' + - 'object' + oneOf: + - type: 'null' + - $ref: '#/components/schemas/UserEmbedded' + mbox: + title: Mbox + description: | + A URL to download the patch in mbox format. Add the `series=*` + querystring parameter to include series dependencies in the mbox + file. + type: string + format: uri + readOnly: true + series: + type: array + items: + $ref: '#/components/schemas/SeriesEmbedded' + readOnly: true + comments: + title: Comments + type: string + format: uri + readOnly: true + check: + title: Check + type: string + readOnly: true + enum: + - pending + - success + - warning + - fail + checks: + title: Checks + type: string + format: uri + readOnly: true + tags: + title: Tags + type: object + additionalProperties: + type: string + readOnly: true + related: + title: Relations + type: array + items: + $ref: '#/components/schemas/PatchEmbedded' + PatchDetail: + type: object + title: Patches + description: | + A list of patches. + allOf: + - $ref: '#/components/schemas/PatchList' + - type: object + properties: + headers: + title: Headers + anyOf: + - type: object + additionalProperties: + type: array + items: + type: string + - type: object + additionalProperties: + type: string + readOnly: true + content: + title: Content + type: string + readOnly: true + minLength: 1 + diff: + title: Diff + type: string + readOnly: true + minLength: 1 + prefixes: + title: Prefixes + type: array + items: + type: string + readOnly: true + PatchUpdate: + type: object + title: Patch update + description: | + The fields to set on an existing patch. + properties: + commit_ref: + title: Commit ref + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + maxLength: 255 + pull_url: + title: Pull URL + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 255 + state: + title: State + type: string + archived: + title: Archived + type: boolean + delegate: + title: Delegate + type: + - 'null' + - 'integer' + related: + title: Relations + type: array + items: + type: integer + Person: + type: object + title: Person + description: | + A person + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + maxLength: 255 + email: + title: Email + type: string + format: email + readOnly: true + minLength: 1 + maxLength: 255 + user: + title: User + readOnly: true + type: + - 'null' + - 'object' + oneOf: + - type: 'null' + - $ref: '#/components/schemas/UserEmbedded' + Project: + type: object + title: Project + description: | + A project. + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + maxLength: 255 + link_name: + title: Link name + type: string + readOnly: true + minLength: 1 + maxLength: 255 + list_id: + title: List ID + type: string + readOnly: true + minLength: 1 + maxLength: 255 + list_email: + title: List email + type: string + format: email + readOnly: true + minLength: 1 + maxLength: 200 + web_url: + title: Web URL + type: string + format: uri + maxLength: 2000 + scm_url: + title: SCM URL + type: string + format: uri + maxLength: 2000 + webscm_url: + title: Web SCM URL + type: string + format: uri + maxLength: 2000 + maintainers: + type: array + items: + $ref: '#/components/schemas/UserEmbedded' + readOnly: true + uniqueItems: true + subject_match: + title: Subject match + description: | + Regex to match the subject against if only part of emails sent to + the list belongs to this project. Will be used with IGNORECASE and + MULTILINE flags. If rules for more projects match the first one + returned from DB is chosen; empty field serves as a default for + every email which has no other match. + type: string + readOnly: true + maxLength: 64 + list_archive_url: + title: List archive URL + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 2000 + list_archive_url_format: + title: List archive URL format + description: | + URL format for the list archive's Message-ID redirector. {} will be + replaced by the Message-ID. + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 2000 + commit_url_format: + title: Web SCM URL format for a particular commit + type: string + Series: + type: object + title: Series + description: | + A series + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + project: + $ref: '#/components/schemas/ProjectEmbedded' + name: + title: Name + description: | + An optional name to associate with the series, e.g. "John's PCI + series". + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: 'string' + maxLength: 255 + date: + title: Date + type: string + format: iso8601 + readOnly: true + submitter: + type: object + title: Submitter + readOnly: true + allOf: + - $ref: '#/components/schemas/PersonEmbedded' + version: + title: Version + description: | + Version of series as indicated by the subject prefix(es). + type: integer + total: + title: Total + description: | + Number of patches in series as indicated by the subject prefix(es). + type: integer + readOnly: true + received_total: + title: Received total + type: integer + readOnly: true + received_all: + title: Received all + type: boolean + readOnly: true + mbox: + title: Mbox + description: | + A URL to download the series in mbox format. + type: string + format: uri + readOnly: true + cover_letter: + $ref: '#/components/schemas/CoverEmbedded' + patches: + title: Patches + type: array + items: + $ref: '#/components/schemas/PatchEmbedded' + readOnly: true + uniqueItems: true + User: + type: object + title: User + description: | + A user + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + username: + title: Username + type: string + readOnly: true + minLength: 1 + maxLength: 150 + first_name: + title: First name + type: string + maxLength: 30 + last_name: + title: Last name + type: string + maxLength: 150 + email: + title: Email address + type: string + format: email + readOnly: true + minLength: 1 + UserDetail: + type: object + title: User + description: | + A user + allOf: + - $ref: '#/components/schemas/User' + - type: object + properties: + settings: + type: object + properties: + send_email: + title: Send email + description: | + Whether Patchwork should send email on your behalf. + Only present and configurable for your account. + type: boolean + items_per_page: + title: Items per page + description: | + Number of items to display per page (web UI). + Only present and configurable for your account. + type: integer + show_ids: + title: Show IDs + description: | + Show click-to-copy IDs in the list view (web UI). + Only present and configurable for your account. + type: boolean + CheckEmbedded: + type: object + title: Check + description: | + A patch check + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: Url + type: string + format: uri + readOnly: true + date: + title: Date + type: string + format: iso8601 + readOnly: true + state: + title: State + description: The state of the check. + type: string + readOnly: true + enum: + - pending + - success + - warning + - fail + target_url: + title: Target url + description: | + The target URL to associate with this check. This should be specific + to the patch. + readOnly: true + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 200 + context: + title: Context + description: | + A label to discern check from checks of other testing systems. + type: string + pattern: ^[-a-zA-Z0-9_]+$ + maxLength: 255 + minLength: 1 + readOnly: true + CommentEmbedded: + type: object + title: Comment + description: | + A comment + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + msgid: + title: Message ID + type: string + readOnly: true + minLength: 1 + list_archive_url: + title: List archive URL + readOnly: true + type: + - 'null' + - 'string' + date: + title: Date + type: string + format: iso8601 + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + CoverEmbedded: + type: object + title: Cover letter + description: | + A cover letter + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + msgid: + title: Message ID + type: string + readOnly: true + minLength: 1 + list_archive_url: + title: List archive URL + readOnly: true + type: + - 'null' + - 'string' + date: + title: Date + type: string + format: iso8601 + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + mbox: + title: Mbox + description: | + A URL to download the cover letter in mbox format. + type: string + format: uri + readOnly: true + PatchEmbedded: + type: object + title: Patch + description: | + A patch + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + msgid: + title: Message ID + type: string + readOnly: true + minLength: 1 + list_archive_url: + title: List archive URL + readOnly: true + type: + - 'null' + - 'string' + date: + title: Date + type: string + format: iso8601 + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + mbox: + title: Mbox + description: | + A URL to download the patch in mbox format. Add the `series=*` + querystring parameter to include series dependencies in the mbox + file. + type: string + format: uri + readOnly: true + PersonEmbedded: + type: object + title: Person + description: | + A person + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + email: + title: Email + type: string + format: email + readOnly: true + minLength: 1 + ProjectEmbedded: + type: object + title: Project + description: | + A project + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + name: + title: Name + type: string + readOnly: true + minLength: 1 + link_name: + title: Link name + type: string + readOnly: true + maxLength: 255 + minLength: 1 + list_id: + title: List ID + type: string + readOnly: true + maxLength: 255 + minLength: 1 + list_email: + title: List email + type: string + format: email + readOnly: true + maxLength: 200 + minLength: 1 + web_url: + title: Web URL + type: string + format: uri + readOnly: true + maxLength: 2000 + scm_url: + title: SCM URL + type: string + format: uri + readOnly: true + maxLength: 2000 + webscm_url: + title: WebSCM URL + type: string + format: uri + readOnly: true + maxLength: 2000 + list_archive_url: + title: List archive URL + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 2000 + list_archive_url_format: + title: List archive URL format + description: | + URL format for the list archive's Message-ID redirector. {} will be + replaced by the Message-ID. + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + format: uri + maxLength: 2000 + commit_url_format: + title: Web SCM URL format for a particular commit + type: string + readOnly: true + SeriesEmbedded: + type: object + title: Series + description: | + A series + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + web_url: + title: Web URL + type: string + format: uri + readOnly: true + name: + title: Name + description: | + An optional name to associate with the series, e.g. "John's PCI + series". + readOnly: true + type: + - 'null' + - 'string' + oneOf: + - type: 'null' + - type: string + maxLength: 255 + date: + title: Date + type: string + format: iso8601 + readOnly: true + version: + title: Version + description: | + Version of series as indicated by the subject prefix(es). + type: integer + readOnly: true + mbox: + title: Mbox + description: | + A URL to download the series in mbox format. + type: string + format: uri + readOnly: true + UserEmbedded: + type: object + title: User + description: | + A user + properties: + id: + title: ID + type: integer + readOnly: true + url: + title: URL + type: string + format: uri + readOnly: true + username: + title: Username + type: string + readOnly: true + minLength: 1 + maxLength: 150 + first_name: + title: First name + type: string + maxLength: 30 + readOnly: true + last_name: + title: Last name + type: string + maxLength: 150 + readOnly: true + email: + title: Email address + type: string + format: email + readOnly: true + minLength: 1 + Error: + type: object + title: A generic error. + description: | + A generic error. + properties: + detail: + title: Detail + type: string + readOnly: true + ErrorBundleCreateUpdate: + type: object + title: A bundle creation or update error. + description: | + A mapping of field names to validation failures. + properties: + name: + title: Name + type: array + items: + type: string + readOnly: true + patches: + title: Patches + type: array + items: + type: string + readOnly: true + public: + title: Public + type: array + items: + type: string + ErrorCheckCreate: + type: object + title: A check creation error. + description: | + A mapping of field names to validation failures. + properties: + state: + title: State + type: array + items: + type: string + readOnly: true + target_url: + title: Target URL + type: array + items: + type: string + readOnly: true + context: + title: Context + type: array + items: + type: string + readOnly: true + description: + title: Description + type: array + items: + type: string + readOnly: true + ErrorCommentUpdate: + type: object + title: A comment update error. + description: | + A mapping of field names to validation failures. + properties: + addressed: + title: Addressed + type: array + items: + type: string + ErrorNoteUpdate: + type: object + title: A note update error. + description: | + A mapping of field names to validation failures. + properties: + addressed: + title: Addressed + type: array + items: + type: string + ErrorPatchUpdate: + type: object + title: A patch update error. + description: | + A mapping of field names to validation failures. + properties: + state: + title: State + type: array + items: + type: string + readOnly: true + delegate: + title: Delegate + type: array + items: + type: string + readOnly: true + commit_ref: + title: Commit ref + type: array + items: + type: string + readOnly: true + archived: + title: Archived + type: array + items: + type: string + readOnly: true + ErrorProjectUpdate: + type: object + title: A project update error. + description: | + A mapping of field names to validation failures. + properties: + web_url: + title: Web URL + type: string + format: uri + readOnly: true + scm_url: + title: SCM URL + type: string + format: uri + readOnly: true + webscm_url: + title: Web SCM URL + type: string + format: uri + readOnly: true + ErrorUserUpdate: + type: object + title: A user update error. + description: | + A mapping of field names to validation failures. + properties: + first_name: + title: First name + type: string + readOnly: true + last_name: + title: First name + type: string + readOnly: true +tags: + - name: api + description: General API operations + - name: patches + description: Patch operations + - name: covers + description: Cover letter operations + - name: series + description: Series operations + - name: comments + description: Comment operations + - name: notes + description: Note operations + - name: people + description: Submitter operations + - name: users + description: User operations + - name: bundles + description: Bundle operations + - name: projects + description: Project operations + - name: bundles + description: Bundle operations + - name: checks + description: Check operations + - name: events + description: Event operations diff --git a/docs/development/installation.rst b/docs/development/installation.rst index 6f4920a62..c33f768b1 100644 --- a/docs/development/installation.rst +++ b/docs/development/installation.rst @@ -30,14 +30,20 @@ configure Patchwork using Docker: package. __ post-install_ -#. Create a ``.env`` file in the root directory of the project and store your - ``UID`` and ``GID`` attribute there. +#. (Optional) Create a ``.env`` file in the root directory of the project and + store your ``UID`` and ``GID`` attribute there. .. code-block:: shell $ echo "UID=$UID" > .env $ echo "GID=`id -g`" >> .env + This should only be necessary if you have a ``UID`` or ``GID`` other than + ``1000``. For more information on why this is necessary, refer to this + `docker-compose issue`__. + + __ https://github.com/docker/compose/issues/2380 + #. Build the images. This will download over 200MB from the internet: .. code-block:: shell @@ -140,18 +146,6 @@ For more information on Docker itself, please refer to the `docker`_ and __ post-install_ -.. note:: - - If you see an error like the below:: - - You must define UID in .env - - Ensure you have created a ``.env`` file in the root of your project - directory and stored the ``UID`` attribute there. For more information on - why this is necessary, refer to this `docker-compose issue`__. - - __ https://github.com/docker/compose/issues/2380 - .. _docker: https://docs.docker.com/engine/install/ .. _docker-compose: https://docs.docker.com/compose/install/ .. _post-install: https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user diff --git a/docs/index.rst b/docs/index.rst index b58cdc300..33b4981fa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,6 +58,7 @@ of community projects. :caption: Release Notes releases/unreleased + releases/iridescent releases/hessian releases/grosgrain releases/flannel diff --git a/docs/releases/index.rst b/docs/releases/index.rst index 327513266..8c862a383 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -10,6 +10,7 @@ on the release process, refer to :doc:`/development/releasing`. :maxdepth: 2 /releases/unreleased + /releases/iridescent /releases/hessian /releases/grosgrain /releases/flannel diff --git a/docs/releases/iridescent.rst b/docs/releases/iridescent.rst new file mode 100644 index 000000000..2954c4610 --- /dev/null +++ b/docs/releases/iridescent.rst @@ -0,0 +1,5 @@ +v3.2 Series ("Iridescent") +========================== + +.. release-notes:: + :branch: stable/3.2 diff --git a/docs/releases/unreleased.rst b/docs/releases/unreleased.rst index aae1aa96c..80ff4514c 100644 --- a/docs/releases/unreleased.rst +++ b/docs/releases/unreleased.rst @@ -2,4 +2,4 @@ Unreleased ========== .. release-notes:: - :earliest-version: v3.1.0 + :earliest-version: v3.2.0 diff --git a/htdocs/README.rst b/htdocs/README.rst index 22fe58d1f..9a5211233 100644 --- a/htdocs/README.rst +++ b/htdocs/README.rst @@ -122,6 +122,12 @@ js :GitHub: https://github.com/js-cookie/js-cookie/ :Version: 3.0.0 +``patch-list.js.`` + Event helpers and other application logic for patch-list.html. These + support patch list manipulation. + + Part of Patchwork. + ``rest.js.`` Utility module for REST API requests to be used by other Patchwork JS files. diff --git a/htdocs/css/style.css b/htdocs/css/style.css index 9156aa6ee..0f4f8917c 100644 --- a/htdocs/css/style.css +++ b/htdocs/css/style.css @@ -17,7 +17,7 @@ h2 a, h2 span { } pre { - line-height: 110%; + line-height: normal; background-color: white; border-radius: 0; } @@ -56,6 +56,34 @@ pre { color: #999; } +ul.dropdown-menu > li > form { + display: block; + width: 100%; +} + +ul.dropdown-menu > li > form > button { + /* taken from bootstrap's styling for '.dropdown-menu > li > a' */ + background: none; + border: none; + cursor: pointer; + display: block; + padding: 3px 20px; + clear: both; + font-weight: 400; + line-height: 1.42857143; + color: #333; + white-space: nowrap; + width: 100%; + text-align: left; +} + +ul.dropdown-menu > li > form > button:hover { + /* taken from bootstrap's styling for '.dropdown-menu > li > a:hover' */ + color: #262626; + text-decoration: none; + background-color: #f5f5f5; +} + form { padding: 0em; margin: 0em; @@ -134,25 +162,21 @@ table.pw-list > thead { background-color: white; } -a.colinactive, a.colactive { +a.col-inactive, a.col-active { color: black; text-decoration: none; } -a.colinactive:hover { +a.col-inactive:hover { color: red; } div.filters { } -div.patchforms { - margin-top: 1em; -} - /* list order manipulation */ -table.patchlist tr.draghover { +table.patch-list tr.draghover { background: #e8e8e8 !important; } @@ -173,7 +197,7 @@ input#reorder-change { .paginator { text-align: right; clear: both; - margin: 8px 0 15px; + margin: 16px 0; } .paginator .prev-na, @@ -228,7 +252,7 @@ table.patch-meta tr th, table.patch-meta tr td { } /* checks forms */ -/* TODO(stephenfin): Merge this with 'div.patchform' rules */ +/* TODO(stephenfin): Merge this with 'div.patch-form' rules */ .checks { border: 1px solid gray; margin: 0.5em 1em; @@ -316,6 +340,12 @@ table.patch-meta tr th, table.patch-meta tr td { border: 0; } +.submission-message .action-icons { + margin-left: 16px; + display: flex; + gap: 4px; +} + .patch-pull-url { font-family: "DejaVu Sans Mono", fixed; } @@ -354,15 +384,15 @@ button[class^=comment-action] { } .quote { - color: #007f00; + color: #365cb5; } -span.p_header { color: #2e8b57; font-weight: bold; } -span.p_chunk { color: #a52a2a; font-weight: bold; } -span.p_context { color: #a020f0; } -span.p_add { color: #008b8b; } -span.p_del { color: #6a5acd; } -span.p_mod { color: #0000ff; } +span.p_header { font-weight: bold; } +span.p_chunk { color: #329fb0; font-weight: bold; } +span.p_context { } +span.p_add { color: #1b9d09; background-color: #edffed; } +span.p_del { color: #c80101; background-color: #ffe2e2; } +span.p_mod { color: #a020f0; } .acked-by { color: #2d4566; @@ -405,16 +435,94 @@ table.bundlelist td padding-right: 2em; } +.patch-list-actions { + width: 100%; + display: inline-flex; + flex-wrap: wrap; + justify-content: space-between; +} + /* forms that appear for a patch */ -div.patchform { - border: thin solid #080808; - padding-left: 0.6em; - padding-right: 0.6em; - float: left; - margin: 0.5em 5em 0.5em 10px; +.patch-forms { + display: inline-flex; + flex-wrap: wrap; + margin: 16px 0; +} + +div.patch-form { + display: flex; + flex-wrap: wrap; + align-items: center; +} + +#edit-note-form { + display: flex; + flex-direction: column; + gap: 10px; /* Space between form elements */ + max-width: 100%; } -div.patchform h3 { +#edit-note-form textarea { + flex-grow: 1; /* Allows textarea to grow */ + width: 100%; + min-height: 150px; + resize: vertical; /* Allow vertical resizing */ + padding: 10px; + box-sizing: border-box; + border: 1px solid #ccc; + border-radius: 5px; + font-size: 1rem; +} + +#edit-note-form .form-actions { + display: flex; + justify-content: flex-start; /* Align buttons to the left */ + gap: 10px; /* Add space between buttons */ +} +#create-note-form div:first-of-type { + display: flex; + flex-direction: column; +} + +select[class^=change-property-], .archive-patch-select, .add-bundle { + padding: 4px; + margin-right: 8px; + box-sizing: border-box; + border-radius: 4px; + background-color: var(--light-color); +} + +#patch-form-archive { + display: flex; + align-items: center; + margin-right: 4px; +} + +#patch-form-archive > label { + margin: 0px; +} + +#patch-form-archive > select, #patch-form-archive > input { + margin: 0px 4px 0px 4px; +} + +.patch-form-submit { + font-weight: bold; + padding: 4px; +} + +#patch-form-bundle, #add-to-bundle, #remove-bundle, #create-note { + margin-left: 16px; +} + +.create-bundle { + padding: 4px; + margin-right: 8px; + box-sizing: border-box; + border-radius: 4px; +} + +div.patch-form h3 { margin-top: 0em; margin-left: -0.6em; margin-right: -0.6em; @@ -424,21 +532,23 @@ div.patchform h3 { font-size: 100%; } -div.patchform ul { +div.patch-form ul { list-style-type: none; padding-left: 0.2em; margin-top: 0em; } -/* forms */ -table.form { +.create-bundle { + padding: 4px; + margin-right: 8px; + box-sizing: border-box; + border-radius: 4px; } span.help_text { font-size: 80%; } - table.form td { padding: 0.6em; vertical-align: top; diff --git a/htdocs/js/bundle.js b/htdocs/js/bundle.js index c969d0be4..2a721d0dd 100644 --- a/htdocs/js/bundle.js +++ b/htdocs/js/bundle.js @@ -6,8 +6,8 @@ function order_button_click(node) { var rows, form; - form = $("#reorderform"); - rows = $("#patchlist").get(0).tBodies[0].rows; + form = $("#reorder-form"); + rows = $("#patch-list").get(0).tBodies[0].rows; if (rows.length < 1) return; @@ -35,18 +35,18 @@ function order_button_click(node) $("#reorder\\-cancel").css("display", "inline"); /* show help text */ - $("#reorderhelp").text('Drag & drop rows to reorder'); + $("#reorder-help").text('Drag & drop rows to reorder'); /* enable drag & drop on the patches list */ - $("#patchlist").tableDnD({ + $("#patch-list").tableDnD({ onDragClass: 'dragging', onDragStart: function() { dragging = true; }, onDrop: function() { dragging = false; } }); /* replace zebra striping with hover */ - $("#patchlist tbody tr").css("background", "inherit"); - $("#patchlist tbody tr").hover(drag_hover_in, drag_hover_out); + $("#patch-list tbody tr").css("background", "inherit"); + $("#patch-list tbody tr").hover(drag_hover_in, drag_hover_out); } editing_order = !editing_order; diff --git a/htdocs/js/patch-list.js b/htdocs/js/patch-list.js new file mode 100644 index 000000000..6be031a49 --- /dev/null +++ b/htdocs/js/patch-list.js @@ -0,0 +1,14 @@ +$( document ).ready(function() { + $("#patch-list").stickyTableHeaders(); + + $("#patch-list").checkboxes("range", true); + + $("#check-all").change(function(e) { + if(this.checked) { + $("#patch-list > tbody").checkboxes("check"); + } else { + $("#patch-list > tbody").checkboxes("uncheck"); + } + e.preventDefault(); + }); +}); diff --git a/patchwork/admin.py b/patchwork/admin.py index d3bf8d29d..88334fe9b 100644 --- a/patchwork/admin.py +++ b/patchwork/admin.py @@ -13,6 +13,7 @@ from patchwork.models import Cover from patchwork.models import CoverComment from patchwork.models import DelegationRule +from patchwork.models import Note from patchwork.models import Patch from patchwork.models import PatchComment from patchwork.models import PatchRelation @@ -130,6 +131,15 @@ class PatchCommentAdmin(admin.ModelAdmin): admin.site.register(PatchComment, PatchCommentAdmin) +class NoteAdmin(admin.ModelAdmin): + list_display = ('patch', 'submitter', 'created_at', 'updated_at') + search_fields = ('patch__name', 'submitter__name', 'submitter__email') + date_hierarchy = 'created_at' + + +admin.site.register(Note, NoteAdmin) + + class PatchInline(admin.StackedInline): model = Patch extra = 0 diff --git a/patchwork/api/note.py b/patchwork/api/note.py new file mode 100644 index 000000000..352e77406 --- /dev/null +++ b/patchwork/api/note.py @@ -0,0 +1,143 @@ +# Patchwork - automated patch tracking system +# Copyright (C) 2024 Meta Platforms, Inc. and affiliates. +# +# SPDX-License-Identifier: GPL-2.0-or-later + + +from rest_framework import permissions +from rest_framework.generics import get_object_or_404 +from rest_framework.generics import CreateAPIView +from rest_framework.generics import RetrieveUpdateDestroyAPIView +from rest_framework.generics import ListAPIView +from patchwork.api.patch import PatchSerializer +from patchwork.api.user import UserDetailSerializer +from patchwork.api.base import BaseHyperlinkedModelSerializer +from patchwork.models import Note +from patchwork.models import Patch + + +class NoteSerializer(BaseHyperlinkedModelSerializer): + submitter = UserDetailSerializer(read_only=True) + patch = PatchSerializer(read_only=True) + + class Meta: + model = Note + fields = [ + 'id', + 'patch', + 'submitter', + 'content', + 'created_at', + 'updated_at', + 'maintainer_only', + ] + read_only_fields = [ + 'id', + 'patch', + 'submitter', + 'created_at', + 'updated_at', + 'maintainer_only', + ] + + +class NoteDetailPermission(permissions.BasePermission): + def has_permission(self, request, view): + if not request.user.is_authenticated: + return False + + if request.method == 'POST': + patch = Patch.objects.get(id=view.kwargs['patch_id']) + return ( + patch.project in request.user.profile.maintainer_projects.all() + ) + + note = Note.objects.get(id=view.kwargs['note_id']) + return ( + note.patch.project + in request.user.profile.maintainer_projects.all() + ) + + def has_object_permission(self, request, view, obj): + if ( + not obj.maintainer_only + and request.method in permissions.SAFE_METHODS + ): + return True + + if request.method == 'POST': + patch = Patch.objects.get(id=view.kwargs['patch_id']) + return ( + patch.project in request.user.profile.maintainer_projects.all() + ) + + note = Note.objects.get(id=view.kwargs['note_id']) + return ( + note.patch.project + in request.user.profile.maintainer_projects.all() + ) + + +class NoteListPermission(permissions.BasePermission): + def has_permission(self, request, view): + if request.method in permissions.SAFE_METHODS: + return True + if not request.user.is_authenticated: + return False + patch = Patch.objects.get(id=view.kwargs['patch_id']) + return patch.project in request.user.profile.maintainer_projects.all() + + def has_object_permission(self, request, view, obj): + if request.method in permissions.SAFE_METHODS: + return True + + +class NoteMixin(object): + queryset = Note.objects.all() + serializer_class = NoteSerializer + lookup_field = 'patch_id' + + def get_queryset(self): + patch_id = self.kwargs['patch_id'] + get_object_or_404(Patch, id=patch_id) + + return Note.objects.filter(patch=patch_id) + + +class NoteDetail(NoteMixin, RetrieveUpdateDestroyAPIView): + permission_classes = [NoteDetailPermission] + + def get_object(self): + queryset = self.filter_queryset(self.get_queryset()) + note_id = self.kwargs.get('note_id') + instance = get_object_or_404(queryset, id=note_id) + self.check_object_permissions(self.request, instance) + return instance + + +class NoteList(NoteMixin, CreateAPIView, ListAPIView): + ordering = 'id' + permission_classes = [NoteListPermission] + + def get_queryset(self): + patch_queryset = Patch.objects.all() + + queryset = super().get_queryset() + public_notes = queryset.filter(maintainer_only=False) + user_patches = patch_queryset.filter( + project__in=list( + self.request.user.profile.maintainer_projects.all() + ) + ) + maintainer_notes = queryset.filter( + maintainer_only=True, patch__in=list(user_patches) + ) + + return public_notes | maintainer_notes + + def perform_create(self, serializer): + serializer.save( + submitter=self.request.user, + patch=Patch.objects.get(id=self.kwargs['patch_id']), + ) + return super().perform_create(serializer) diff --git a/patchwork/api/patch.py b/patchwork/api/patch.py index 443c38226..8fd345681 100644 --- a/patchwork/api/patch.py +++ b/patchwork/api/patch.py @@ -85,6 +85,7 @@ class PatchListSerializer(BaseHyperlinkedModelSerializer): mbox = SerializerMethodField() series = SeriesSerializer(read_only=True) comments = SerializerMethodField() + notes = SerializerMethodField() check = SerializerMethodField() checks = SerializerMethodField() tags = SerializerMethodField() @@ -108,6 +109,11 @@ def get_comments(self, patch): reverse('api-patch-comment-list', kwargs={'patch_id': patch.id}) ) + def get_notes(self, patch): + return self.context.get('request').build_absolute_uri( + reverse('api-patch-note-list', kwargs={'patch_id': patch.id}) + ) + def get_check(self, instance): return instance.combined_check_state @@ -173,6 +179,7 @@ class Meta: 'mbox', 'series', 'comments', + 'notes', 'check', 'checks', 'tags', @@ -191,6 +198,7 @@ class Meta: 'mbox', 'series', 'comments', + 'notes', 'check', 'checks', 'tags', diff --git a/patchwork/forms.py b/patchwork/forms.py index ed06d0d15..6cbdf3510 100644 --- a/patchwork/forms.py +++ b/patchwork/forms.py @@ -12,6 +12,7 @@ from django.template.backends import django as django_template_backend from patchwork.models import Bundle +from patchwork.models import Note from patchwork.models import Patch from patchwork.models import State from patchwork.models import UserProfile @@ -64,8 +65,11 @@ class BundleForm(forms.ModelForm): regex=r'^[^/]+$', min_length=1, max_length=50, - label='Name', + required=False, error_messages={'invalid': "Bundle names can't contain slashes"}, + widget=forms.TextInput( + attrs={'class': 'create-bundle', 'placeholder': 'Bundle name'} + ), ) class Meta: @@ -76,12 +80,19 @@ class Meta: class CreateBundleForm(BundleForm): def clean_name(self): name = self.cleaned_data['name'] + if not name: + raise forms.ValidationError( + 'No bundle name was specified', code='invalid' + ) + count = Bundle.objects.filter( owner=self.instance.owner, name=name ).count() if count > 0: raise forms.ValidationError( - 'A bundle called %s already exists' % name + 'A bundle called %(name)s already exists', + code='invalid', + params={'name': name}, ) return name @@ -96,6 +107,35 @@ class DeleteBundleForm(forms.Form): bundle_id = forms.IntegerField(widget=forms.HiddenInput) +class CreateNoteForm(forms.ModelForm): + name = 'createnoteform' + form_name = forms.CharField(initial=name, widget=forms.HiddenInput) + content = forms.CharField(label='Content', widget=forms.Textarea) + maintainer_only = forms.BooleanField( + label='Maintainers Only', initial=True, widget=forms.CheckboxInput + ) + + class Meta: + model = Note + fields = ['content', 'maintainer_only'] + + +class EditNoteForm(forms.ModelForm): + name = 'editnoteform' + form_name = forms.CharField(initial=name, widget=forms.HiddenInput) + content = forms.CharField(label='Content', widget=forms.Textarea) + + class Meta: + model = Note + fields = ['content', 'maintainer_only'] + + +class DeleteNoteForm(forms.Form): + name = 'deletenoteform' + form_name = forms.CharField(initial=name, widget=forms.HiddenInput) + note_id = forms.IntegerField(widget=forms.HiddenInput) + + class EmailForm(forms.Form): email = forms.EmailField(max_length=200) @@ -129,19 +169,29 @@ class PatchForm(forms.ModelForm): def __init__(self, instance=None, project=None, *args, **kwargs): super(PatchForm, self).__init__(instance=instance, *args, **kwargs) self.fields['delegate'] = forms.ModelChoiceField( - queryset=_get_delegate_qs(project, instance), required=False + queryset=_get_delegate_qs(project, instance), + widget=forms.Select(attrs={'class': 'change-property-delegate'}), + required=False, ) class Meta: model = Patch fields = ['state', 'archived', 'delegate'] + widgets = { + 'state': forms.Select(attrs={'class': 'change-property-state'}), + 'archived': forms.CheckboxInput( + attrs={'class': 'archive-patch-check'} + ), + } class OptionalModelChoiceField(forms.ModelChoiceField): - no_change_choice = ('*', 'no change') + no_change_choice = ('*', 'No change') to_field_name = None - def __init__(self, *args, **kwargs): + def __init__(self, *args, placeholder, className, **kwargs): + self.no_change_choice = ('*', placeholder) + self.widget = forms.Select(attrs={'class': className}) super(OptionalModelChoiceField, self).__init__( initial=self.no_change_choice[0], *args, **kwargs ) @@ -174,6 +224,10 @@ def clean(self, value): class OptionalBooleanField(forms.TypedChoiceField): + def __init__(self, className, *args, **kwargs): + self.widget = forms.Select(attrs={'class': className}) + super(OptionalBooleanField, self).__init__(*args, **kwargs) + def is_no_change(self, value): return value == self.empty_value @@ -181,22 +235,31 @@ def is_no_change(self, value): class MultiplePatchForm(forms.Form): action = 'update' archived = OptionalBooleanField( + className='archive-patch-select', choices=[ - ('*', 'no change'), - ('True', 'Archived'), - ('False', 'Unarchived'), + ('*', 'No change'), + ('True', 'Archive'), + ('False', 'Unarchive'), ], coerce=lambda x: x == 'True', empty_value='*', + label='Archived', ) def __init__(self, project, *args, **kwargs): super(MultiplePatchForm, self).__init__(*args, **kwargs) self.fields['delegate'] = OptionalModelChoiceField( - queryset=_get_delegate_qs(project=project), required=False + queryset=_get_delegate_qs(project=project), + placeholder='Delegate to', + className='change-property-delegate', + label='Delegate to', + required=False, ) self.fields['state'] = OptionalModelChoiceField( - queryset=State.objects.all() + queryset=State.objects.all(), + placeholder='Change state', + className='change-property-state', + label='Change state', ) def save(self, instance, commit=True): diff --git a/patchwork/migrations/0047_add_database_indexes.py b/patchwork/migrations/0047_add_database_indexes.py new file mode 100644 index 000000000..42c119979 --- /dev/null +++ b/patchwork/migrations/0047_add_database_indexes.py @@ -0,0 +1,18 @@ +import patchwork.fields +from django.db import migrations + + +class Migration(migrations.Migration): + dependencies = [ + ('patchwork', '0046_patch_comment_events'), + ] + + operations = [ + migrations.AlterField( + model_name='patch', + name='hash', + field=patchwork.fields.HashField( + blank=True, db_index=True, max_length=40, null=True + ), + ), + ] diff --git a/patchwork/migrations/0048_note.py b/patchwork/migrations/0048_note.py new file mode 100644 index 000000000..3555b6fc6 --- /dev/null +++ b/patchwork/migrations/0048_note.py @@ -0,0 +1,59 @@ +# Generated by Django 5.1.2 on 2024-11-04 07:50 + +import django.db.models.deletion +import django.utils.timezone +from django.conf import settings +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ('patchwork', '0047_add_database_indexes'), + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ] + + operations = [ + migrations.CreateModel( + name='Note', + fields=[ + ( + 'id', + models.AutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name='ID', + ), + ), + ( + 'created_at', + models.DateTimeField(default=django.utils.timezone.now), + ), + ( + 'updated_at', + models.DateTimeField(default=django.utils.timezone.now), + ), + ('content', models.TextField(blank=True)), + ('maintainer_only', models.BooleanField(default=True)), + ( + 'patch', + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + related_name='note', + related_query_name='note', + to='patchwork.patch', + ), + ), + ( + 'submitter', + models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + to=settings.AUTH_USER_MODEL, + ), + ), + ], + options={ + 'abstract': False, + }, + ), + ] diff --git a/patchwork/migrations/0049_alter_note_created_at_alter_note_updated_at.py b/patchwork/migrations/0049_alter_note_created_at_alter_note_updated_at.py new file mode 100644 index 000000000..7d1786071 --- /dev/null +++ b/patchwork/migrations/0049_alter_note_created_at_alter_note_updated_at.py @@ -0,0 +1,22 @@ +# Generated by Django 5.1.2 on 2024-12-16 13:22 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ('patchwork', '0048_note'), + ] + + operations = [ + migrations.AlterField( + model_name='note', + name='created_at', + field=models.DateTimeField(auto_now_add=True), + ), + migrations.AlterField( + model_name='note', + name='updated_at', + field=models.DateTimeField(auto_now=True), + ), + ] diff --git a/patchwork/models.py b/patchwork/models.py index 9a619bc56..5e427df10 100644 --- a/patchwork/models.py +++ b/patchwork/models.py @@ -33,6 +33,14 @@ def validate_regex_compiles(regex_string): raise ValidationError('Invalid regular expression entered!') +class TimestampMixin(models.Model): + updated_at = models.DateTimeField(auto_now=True) + created_at = models.DateTimeField(auto_now_add=True) + + class Meta: + abstract = True + + class Person(models.Model): # properties @@ -501,7 +509,7 @@ class Patch(SubmissionMixin): ) state = models.ForeignKey(State, null=True, on_delete=models.CASCADE) archived = models.BooleanField(default=False) - hash = HashField(null=True, blank=True) + hash = HashField(null=True, blank=True, db_index=True) # series metadata @@ -823,6 +831,18 @@ class Meta: ] +class Note(TimestampMixin, models.Model): + patch = models.ForeignKey( + Patch, + related_name='note', + related_query_name='note', + on_delete=models.CASCADE, + ) + submitter = models.ForeignKey(User, on_delete=models.CASCADE) + content = models.TextField(null=False, blank=True) + maintainer_only = models.BooleanField(default=True) + + class Series(FilenameMixin, models.Model): """A collection of patches.""" @@ -1059,7 +1079,6 @@ def __str__(self): class Check(models.Model): - """Check for a patch. Checks store the results of any tests executed (or executing) for a diff --git a/patchwork/templates/patchwork/bundles.html b/patchwork/templates/patchwork/bundles.html index cc2ebf90d..6d65a7e8d 100644 --- a/patchwork/templates/patchwork/bundles.html +++ b/patchwork/templates/patchwork/bundles.html @@ -56,7 +56,7 @@

Bundles

Bundles are groups of related patches. You can create bundles by selecting patches from a project, then using the 'create bundle' form to give your bundle a name. Each bundle can be public or private; public - bundles are given a persistent URL, based you your username and the name + bundles are given a persistent URL, based on your username and the name of the bundle. Private bundles are only visible to you.

diff --git a/patchwork/templates/patchwork/partials/patch-forms.html b/patchwork/templates/patchwork/partials/patch-forms.html new file mode 100644 index 000000000..452bc79b8 --- /dev/null +++ b/patchwork/templates/patchwork/partials/patch-forms.html @@ -0,0 +1,56 @@ +
+{% if patch_form %} +
+
+ {{ patch_form.state.errors }} + {{ patch_form.state }} +
+
+ {{ patch_form.delegate.errors }} + {{ patch_form.delegate }} +
+
+ {{ patch_form.archived.errors }} + {{ patch_form.archived.label_tag }} {{ patch_form.archived }} +
+ +
+{% endif %} +{% if user.is_authenticated %} +
+
+ {{ create_bundle_form.name.errors }} + {{ create_bundle_form.name }} + +
+ {% if bundles %} +
+ + +
+ {% endif %} + {% if bundle %} +
+ + +
+ {% endif %} + {% if is_maintainer %} +
+ +
+ {% endif %} +
+{% endif %} +
diff --git a/patchwork/templates/patchwork/partials/patch-list.html b/patchwork/templates/patchwork/partials/patch-list.html index a882cd9d8..981ceee58 100644 --- a/patchwork/templates/patchwork/partials/patch-list.html +++ b/patchwork/templates/patchwork/partials/patch-list.html @@ -4,18 +4,21 @@ {% load project %} {% load static %} +{% block headers %} + +{% endblock %} + {% include "patchwork/partials/filters.html" %} -{% include "patchwork/partials/pagination.html" %} {% if order.editable %} - +
-
-
+
+ {% csrf_token %} - + - + @@ -24,36 +27,16 @@
{% endif %} -{% if page.paginator.long_page and user.is_authenticated %} -
- - ▾ - -
-{% endif %} - - - -
+ {% csrf_token %} - + - + +
+{% include "patchwork/partials/patch-forms.html" %} +{% include "patchwork/partials/pagination.html" %} +
+
{% if user.is_authenticated %} @@ -69,24 +52,24 @@ {% endif %} @@ -172,9 +155,9 @@ {% for patch in page.object_list %} - + {% if user.is_authenticated %} - {% endif %} @@ -185,24 +168,24 @@ {% endif %} - - - - - - - - + + + + + + {% empty %} @@ -214,82 +197,5 @@ {% if page.paginator.count %} {% include "patchwork/partials/pagination.html" %} - -
- -{% if patchform %} -
-

Properties

-
+{% if not order.editable %} {% if order.name == "name" %} - + - + Patch {% else %} -{% if not order.editable %} - Patch -{% else %} - Patch + Patch {% endif %} +{% else %} + Patch {% endif %} - Series + Series @@ -98,72 +81,72 @@ +{% if not order.editable %} {% if order.name == "date" %} - + - + Date {% else %} -{% if not order.editable %} - Date -{% else %} - Date + Date {% endif %} +{% else %} + Date {% endif %} +{% if not order.editable %} {% if order.name == "submitter" %} - + - + Submitter {% else %} -{% if not order.editable %} - + Submitter -{% else %} - Submitter {% endif %} +{% else %} + Submitter {% endif %} +{% if not order.editable %} {% if order.name == "delegate" %} - + - + Delegate {% else %} -{% if not order.editable %} - Delegate -{% else %} - Delegate + Delegate {% endif %} +{% else %} + Delegate {% endif %} +{% if not order.editable %} {% if order.name == "state" %} - + - + State {% else %} -{% if not order.editable %} - State -{% else %} - State + State {% endif %} +{% else %} + State {% endif %}
+ + {{ patch.name|default:"[no subject]"|truncatechars:100 }} + {% if patch.series %} {{ patch.series|truncatechars:100 }} {% endif %} {{ patch|patch_tags }}{{ patch|patch_checks }}{{ patch.date|date:"Y-m-d" }}{{ patch.submitter|personify:project }}{{ patch.delegate.username }}{{ patch.state }}{{ patch|patch_tags }}{{ patch|patch_checks }}{{ patch.date|date:"Y-m-d" }}{{ patch.submitter|personify:project }}{{ patch.delegate.username }}{{ patch.state }}
- - - - - - - - - - - - - - - - -
Change state: - {{ patchform.state }} - {{ patchform.state.errors }} -
Delegate to: - {{ patchform.delegate }} - {{ patchform.delegate.errors }} -
Archive: - {{ patchform.archived }} - {{ patchform.archived.errors }} -
- -
- -{% endif %} - -{% if user.is_authenticated %} -
-

Bundling

- - - - - -{% if bundles %} - - - - -{% endif %} -{% if bundle %} - - - - -{% endif %} -
Create bundle: - - -
Add to bundle: - - -
Remove from bundle: - - -
-
-{% endif %} -
-
- {% endif %}
diff --git a/patchwork/templates/patchwork/submission.html b/patchwork/templates/patchwork/submission.html index 85e7be4b4..b11a8656f 100644 --- a/patchwork/templates/patchwork/submission.html +++ b/patchwork/templates/patchwork/submission.html @@ -3,12 +3,14 @@ {% load humanize %} {% load syntax %} {% load person %} +{% load user %} {% load patch %} {% load static %} {% load utils %} {% block headers %} + {% endblock %} {% block title %}{{submission.name}}{% endblock %} @@ -132,90 +134,19 @@

{{ submission.name }}

{% endif %} -
-{% if patchform %} -
-

Patch Properties

-
- {% csrf_token %} - - - - - - - - - - - - - - - - - -
Change state: - {{ patchform.state }} - {{ patchform.state.errors }} -
Delegate to: - {{ patchform.delegate }} - {{ patchform.delegate.errors }} -
Archived: - {{ patchform.archived }} - {{ patchform.archived.errors }} -
- -
-
-
+
+ {% csrf_token %} + {% include "patchwork/partials/patch-forms.html" %} +
+{% if create_note_form %} +
+

New Note

+ {% csrf_token %} + {{ create_note_form.as_div }} + +
{% endif %} -{% if createbundleform %} -
-

Bundling

- - - - - -{% if bundles %} - - - - -{% endif %} -
Create bundle: -{% if createbundleform.non_field_errors %} -
{{createbundleform.non_field_errors}}
-{% endif %} -
- {% csrf_token %} - -{% if createbundleform.name.errors %} -
{{createbundleform.name.errors}}
-{% endif %} - {{ createbundleform.name }} - -
-
Add to bundle: -
-{% csrf_token %} - - - -
-
-
-{% endif %} -
-
-
- {% if submission.pull_url %}

Pull-request

{{ submission.pull_url }} @@ -262,9 +193,63 @@

Message

{{ submission.date }} UTC 
-  {{ submission|commentsyntax }}
+{{ submission|commentsyntax }}
+
+ + +{% for note in notes %} +{% if forloop.first %} +

Notes

+{% endif %} + +
+
+ User: {{ note.submitter|userfy }}, + + Last modified: {{ note.updated_at }} UTC + +
+ {% if is_maintainer %} +
+ {% csrf_token %} + + + +
+
+ {% csrf_token %} + {{ note.delete_form.as_p }} + +
+ {% endif %} +
+
+ 
+    {% if edit_note_form and edit_note_id == note.id %}
+    

+        {% csrf_token %}
+        
+        
+        
+        

+          
+          
+        

+    

+    {% else %}
+    {{ note.content }}
+    {% endif %}
+{% endfor %} {% for item in comments %} {% if forloop.first %} diff --git a/patchwork/templatetags/user.py b/patchwork/templatetags/user.py new file mode 100644 index 000000000..40c933672 --- /dev/null +++ b/patchwork/templatetags/user.py @@ -0,0 +1,23 @@ +# Patchwork - automated patch tracking system +# Copyright (C) 2024 Meta Platforms, Inc. and affiliates. +# +# SPDX-License-Identifier: GPL-2.0-or-later + +from django import template +from django.utils.html import escape +from django.utils.safestring import mark_safe + + +register = template.Library() + + +@register.filter +def userfy(user): + if user.first_name and user.last_name: + linktext = escape(f'{user.first_name} {user.last_name}') + elif user.email: + linktext = escape(user.email) + else: + linktext = escape(user.username) + + return mark_safe(linktext) diff --git a/patchwork/tests/api/test_notes.py b/patchwork/tests/api/test_notes.py new file mode 100644 index 000000000..f87cf6444 --- /dev/null +++ b/patchwork/tests/api/test_notes.py @@ -0,0 +1,231 @@ +# Patchwork - automated patch tracking system +# Copyright (C) 2024 Collabora +# +# SPDX-License-Identifier: GPL-2.0-or-later + +from django.test import override_settings +from django.urls import reverse +from rest_framework import status + +from patchwork.models import Note +from patchwork.tests.api import utils +from patchwork.tests.utils import create_patch +from patchwork.tests.utils import create_maintainer +from patchwork.tests.utils import create_person +from patchwork.tests.utils import create_project +from patchwork.tests.utils import create_note +from patchwork.tests.utils import create_user + + +@override_settings(ENABLE_REST_API=True) +class TestPatchNotes(utils.APITestCase): + def setUp(self): + super().setUp() + self.project = create_project() + self.user = create_maintainer(self.project) + self.patch = create_patch(project=self.project) + + def check_for_expected(self, instance, response_data): + self.assertEqual(instance.id, response_data['id']) + self.assertEqual(instance.patch.id, response_data['patch']['id']) + self.assertEqual( + instance.submitter.id, response_data['submitter']['id'] + ) + + def test_create_note(self): + start_num = Note.objects.count() + url = reverse( + 'api-patch-note-list', kwargs={'patch_id': self.patch.id} + ) + data = {'content': 'New note'} + self.client.authenticate(user=self.user) + resp = self.client.post(url, data=data) + end_num = Note.objects.count() + + self.assertEqual(status.HTTP_201_CREATED, resp.status_code) + self.assertEqual(start_num + 1, end_num) + + def test_get_note_as_maintainer(self): + """Retrieve patch note with an user that is a maintainer.""" + note = create_note(patch=self.patch, submitter=self.user) + + self.client.authenticate(user=self.user) + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + resp = self.client.get(url) + + self.assertEqual(status.HTTP_200_OK, resp.status_code) + self.check_for_expected(note, resp.data) + + def test_get_note_as_non_maintainer(self): + """Retrieve patch note with an user that is not a maintainer.""" + note = create_note() + + self.client.authenticate(user=self.user) + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + resp = self.client.get(url) + + self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code) + + def test_get_note_public(self): + """Retrieve public patch note with an user that is not a maintainer.""" + person = create_person(user=self.user) + note = create_note(patch=self.patch, maintainer_only=False) + + self.client.authenticate(user=person.user) + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + resp = self.client.get(url) + + self.assertEqual(status.HTTP_200_OK, resp.status_code) + self.check_for_expected(note, resp.data) + + def test_get_note_list_as_maintainer(self): + """Retrieve notes from a patch note with an user that is a maintainer.""" + create_note(patch=self.patch, submitter=self.user) + create_note( + patch=self.patch, submitter=self.user, maintainer_only=False + ) + + self.client.authenticate(user=self.user) + url = reverse( + 'api-patch-note-list', kwargs={'patch_id': self.patch.id} + ) + resp = self.client.get(url) + + self.assertEqual(status.HTTP_200_OK, resp.status_code) + self.assertEqual(len(resp.data), 2) + + def test_get_note_list_as_non_maintainer(self): + """Retrieve notes from a patch note with an user that is not a maintainer.""" + create_note(patch=self.patch, submitter=self.user) + public_note = create_note( + patch=self.patch, submitter=self.user, maintainer_only=False + ) + not_maintainer = create_user() + + self.client.authenticate(user=not_maintainer) + url = reverse( + 'api-patch-note-list', kwargs={'patch_id': self.patch.id} + ) + resp = self.client.get(url) + + self.assertEqual(status.HTTP_200_OK, resp.status_code) + self.assertEqual(len(resp.data), 1) + self.assertEqual(resp.data[0]['id'], public_note.id) + + def test_edit_note_as_maintainer(self): + """Edit patch note with an user that is a maintainer.""" + note = create_note(patch=self.patch, submitter=self.user) + + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + data = {'content': 'New content'} + self.client.authenticate(user=self.user) + resp = self.client.patch(url, data=data) + + self.assertEqual(status.HTTP_200_OK, resp.status_code) + self.check_for_expected(note, resp.data) + self.assertNotEqual(note.content, resp.data['content']) + self.assertNotEqual(note.updated_at, resp.data['updated_at']) + + def test_edit_note_as_non_maintainer(self): + """Edit patch note with an user that is not a maintainer.""" + note = create_note() + + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + data = {'content': 'New content'} + self.client.authenticate(user=self.user) + resp = self.client.patch(url, data=data) + + self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code) + + def test_edit_note_public(self): + """ + Edit public patch note with an user that is a maintainer with + an user that is not a maintainer. + """ + note = create_note(maintainer_only=False) + + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + data = {'content': 'New content'} + self.client.authenticate(user=self.user) + resp = self.client.patch(url, data=data) + + self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code) + + def test_delete_note_as_maintainer(self): + """Delete patch note with an user that is a maintainer.""" + note = create_note(patch=self.patch, submitter=self.user) + start_num = Note.objects.count() + + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + + self.client.authenticate(user=self.user) + resp = self.client.delete(url) + end_num = Note.objects.count() + + self.assertEqual(status.HTTP_204_NO_CONTENT, resp.status_code) + self.assertEqual(start_num - 1, end_num) + + def test_delete_note_as_non_maintainer(self): + """Delete patch note with an user that is not a maintainer.""" + note = create_note() + + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + + self.client.authenticate(user=self.user) + resp = self.client.delete(url) + + self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code) + + def test_delete_note_public(self): + """ + Delete public patch note with an user that is a maintainer with + an user that is not a maintainer. + """ + person = create_person() + note = create_note(patch=self.patch, maintainer_only=False) + + url = reverse( + 'api-patch-note-detail', + kwargs={'patch_id': self.patch.id, 'note_id': note.id}, + ) + self.client.authenticate(user=person.user) + resp = self.client.delete(url) + + self.assertEqual(status.HTTP_403_FORBIDDEN, resp.status_code) + + def test_notes_in_patch(self): + url = reverse('api-patch-detail', kwargs={'pk': self.patch.id}) + self.client.authenticate(user=self.user) + resp = self.client.get(url) + + correct_path = reverse( + 'api-patch-note-list', kwargs={'patch_id': self.patch.id} + ) + self.assertEqual( + resp.data.get('notes'), + f'http://example.com{correct_path}', + ) diff --git a/patchwork/tests/api/validator.py b/patchwork/tests/api/validator.py index b6c64ef03..f7617e453 100644 --- a/patchwork/tests/api/validator.py +++ b/patchwork/tests/api/validator.py @@ -7,7 +7,7 @@ import re from django.urls import resolve -import openapi_core +import jsonschema_path from openapi_core.contrib.django import DjangoOpenAPIRequest from openapi_core.contrib.django import DjangoOpenAPIResponse from openapi_core.exceptions import OpenAPIError @@ -88,7 +88,7 @@ def _load_spec(version): with open(spec_path, 'r') as fh: data = yaml.load(fh, Loader=yaml.SafeLoader) - _LOADED_SPECS[version] = openapi_core.Spec.from_dict(data) + _LOADED_SPECS[version] = jsonschema_path.SchemaPath.from_dict(data) return _LOADED_SPECS[version] diff --git a/patchwork/tests/test_notifications.py b/patchwork/tests/test_notifications.py index 70d25da36..b56c8ccbe 100644 --- a/patchwork/tests/test_notifications.py +++ b/patchwork/tests/test_notifications.py @@ -20,7 +20,6 @@ class PatchNotificationModelTest(TestCase): - """Tests for the creation and update of the PatchChangeNotifications.""" def setUp(self): diff --git a/patchwork/tests/test_version.py b/patchwork/tests/test_version.py index 8e512084c..9cbb13051 100644 --- a/patchwork/tests/test_version.py +++ b/patchwork/tests/test_version.py @@ -32,4 +32,9 @@ def test_validate_version(self): # if the tag is missing from one, it should be missing from the other # (and vice versa) - self.assertEqual(bool(str_match.group(1)), bool(git_match.group(1))) + self.assertEqual( + bool(str_match.group(1)), + bool(git_match.group(1)), + f'mismatch between git and version.txt post-release metadata: ' + f'git={git_match.group(1)!r}, version.txt={str_match.group(1)!r}', + ) diff --git a/patchwork/tests/utils.py b/patchwork/tests/utils.py index 4f4048912..87b33b18b 100644 --- a/patchwork/tests/utils.py +++ b/patchwork/tests/utils.py @@ -15,6 +15,7 @@ from patchwork.models import Check from patchwork.models import Cover from patchwork.models import CoverComment +from patchwork.models import Note from patchwork.models import Patch from patchwork.models import PatchComment from patchwork.models import PatchRelation @@ -270,6 +271,18 @@ def create_patch_comment(**kwargs): return PatchComment.objects.create(**values) +def create_note(**kwargs): + """Create 'Note' object.""" + values = { + 'patch': create_patch() if 'patch' not in kwargs else None, + 'submitter': create_user() if 'submitter' not in kwargs else None, + 'content': 'Note content', + } + values.update(kwargs) + + return Note.objects.create(**values) + + def create_check(**kwargs): """Create 'Check' object.""" values = { diff --git a/patchwork/tests/views/test_api.py b/patchwork/tests/views/test_api.py index b14d402b6..4b6accdb1 100644 --- a/patchwork/tests/views/test_api.py +++ b/patchwork/tests/views/test_api.py @@ -12,7 +12,6 @@ class SubmitterCompletionTest(TestCase): - """Validate the 'submitter' autocomplete endpoint.""" def test_name_complete(self): diff --git a/patchwork/tests/views/test_bundles.py b/patchwork/tests/views/test_bundles.py index e5ac1efad..1d317c305 100644 --- a/patchwork/tests/views/test_bundles.py +++ b/patchwork/tests/views/test_bundles.py @@ -170,7 +170,7 @@ def test_update_public(self): self.assertEqual(bundle.public, not self.bundle.public) # check other forms for errors - formname = 'patchform' + formname = 'patch_form' if formname not in response.context: return form = response.context[formname] @@ -222,7 +222,6 @@ def setUp(self): class BundlePublicModifyTest(BundleTestBase): - """Ensure that non-owners can't modify bundles""" def setUp(self): @@ -275,7 +274,6 @@ def test_bundle_form_submission(self): class BundlePrivateViewTest(BundleTestBase): - """Ensure that non-owners can't view private bundles""" def setUp(self): @@ -306,7 +304,6 @@ def test_private_bundle(self): @override_settings(ENABLE_REST_API=True) class BundlePrivateViewMboxTest(BundlePrivateViewTest): - """Ensure that non-owners can't view private bundle mboxes""" def setUp(self): @@ -371,8 +368,8 @@ class BundleCreateFromListTest(BundleTestBase): def test_create_empty_bundle(self): newbundlename = 'testbundle-new' params = { - 'form': 'patchlistform', - 'bundle_name': newbundlename, + 'form': 'patch-list-form', + 'name': newbundlename, 'action': 'Create', 'project': self.project.id, } @@ -391,8 +388,8 @@ def test_create_non_empty_bundle(self): patch = self.patches[0] params = { - 'form': 'patchlistform', - 'bundle_name': newbundlename, + 'form': 'patch-list-form', + 'name': newbundlename, 'action': 'Create', 'project': self.project.id, 'patch_id:%d' % patch.id: 'checked', @@ -420,8 +417,8 @@ def test_create_non_empty_bundle_empty_name(self): n_bundles = Bundle.objects.count() params = { - 'form': 'patchlistform', - 'bundle_name': '', + 'form': 'patch-list-form', + 'name': '', 'action': 'Create', 'project': self.project.id, 'patch_id:%d' % patch.id: 'checked', @@ -446,8 +443,8 @@ def test_create_duplicate_name(self): patch = self.patches[0] params = { - 'form': 'patchlistform', - 'bundle_name': newbundlename, + 'form': 'patch-list-form', + 'name': newbundlename, 'action': 'Create', 'project': self.project.id, 'patch_id:%d' % patch.id: 'checked', @@ -478,7 +475,9 @@ def test_create_duplicate_name(self): ) self.assertNotContains(response, 'Bundle %s created' % newbundlename) - self.assertContains(response, 'You already have a bundle called') + self.assertContains( + response, 'A bundle called %s already exists' % newbundlename + ) self.assertEqual(Bundle.objects.count(), n_bundles) self.assertEqual(bundle.patches.count(), 1) @@ -488,7 +487,7 @@ def test_create_non_empty_bundle(self): newbundlename = 'testbundle-new' patch = self.patches[0] - params = {'name': newbundlename, 'action': 'createbundle'} + params = {'name': newbundlename, 'action': 'Create'} response = self.client.post( reverse( @@ -511,7 +510,7 @@ def test_create_with_existing_name(self): newbundlename = self.bundle.name patch = self.patches[0] - params = {'name': newbundlename, 'action': 'createbundle'} + params = {'name': newbundlename, 'action': 'Create'} response = self.client.post( reverse( @@ -535,7 +534,7 @@ class BundleAddFromListTest(BundleTestBase): def test_add_to_empty_bundle(self): patch = self.patches[0] params = { - 'form': 'patchlistform', + 'form': 'patch-list-form', 'action': 'Add', 'project': self.project.id, 'bundle_id': self.bundle.id, @@ -560,7 +559,7 @@ def test_add_to_non_empty_bundle(self): self.bundle.append_patch(self.patches[0]) patch = self.patches[1] params = { - 'form': 'patchlistform', + 'form': 'patch-list-form', 'action': 'Add', 'project': self.project.id, 'bundle_id': self.bundle.id, @@ -595,7 +594,7 @@ def test_add_duplicate(self): patch = self.patches[0] params = { - 'form': 'patchlistform', + 'form': 'patch-list-form', 'action': 'Add', 'project': self.project.id, 'bundle_id': self.bundle.id, @@ -620,7 +619,7 @@ def test_add_new_and_duplicate(self): patch = self.patches[0] params = { - 'form': 'patchlistform', + 'form': 'patch-list-form', 'action': 'Add', 'project': self.project.id, 'bundle_id': self.bundle.id, @@ -647,7 +646,7 @@ def test_add_new_and_duplicate(self): class BundleAddFromPatchTest(BundleTestBase): def test_add_to_empty_bundle(self): patch = self.patches[0] - params = {'action': 'addtobundle', 'bundle_id': self.bundle.id} + params = {'action': 'Add', 'bundle_id': self.bundle.id} response = self.client.post( reverse( @@ -662,7 +661,7 @@ def test_add_to_empty_bundle(self): self.assertContains( response, - 'added to bundle "%s"' % self.bundle.name, + 'added to bundle %s' % self.bundle.name, count=1, ) @@ -672,7 +671,7 @@ def test_add_to_empty_bundle(self): def test_add_to_non_empty_bundle(self): self.bundle.append_patch(self.patches[0]) patch = self.patches[1] - params = {'action': 'addtobundle', 'bundle_id': self.bundle.id} + params = {'action': 'Add', 'bundle_id': self.bundle.id} response = self.client.post( reverse( @@ -687,7 +686,7 @@ def test_add_to_non_empty_bundle(self): self.assertContains( response, - 'added to bundle "%s"' % self.bundle.name, + 'added to bundle %s' % self.bundle.name, count=1, ) @@ -704,7 +703,6 @@ def test_add_to_non_empty_bundle(self): class BundleInitialOrderTest(BundleTestBase): - """When creating bundles from a patch list, ensure that the patches in the bundle are ordered by date""" @@ -727,8 +725,8 @@ def _test_order(self, ids, expected_order): # need to define our querystring explicity to enforce ordering params = { - 'form': 'patchlistform', - 'bundle_name': newbundlename, + 'form': 'patch-list-form', + 'name': newbundlename, 'action': 'Create', 'project': self.project.id, } @@ -785,7 +783,7 @@ def check_reordering(self, neworder, start, end): slice_ids = neworder_ids[start:end] params = { - 'form': 'reorderform', + 'form': 'reorder-form', 'order_start': firstpatch.id, 'neworder': slice_ids, } diff --git a/patchwork/tests/views/test_mail.py b/patchwork/tests/views/test_mail.py index ae0b2c388..798b83f48 100644 --- a/patchwork/tests/views/test_mail.py +++ b/patchwork/tests/views/test_mail.py @@ -175,7 +175,6 @@ def test_valid_hash(self): class OptoutPreexistingTest(OptoutTest): - """Test that a duplicated opt-out behaves the same as the initial one""" def setUp(self): @@ -280,7 +279,6 @@ def test_valid_hash(self): class OptinWithoutOptoutTest(TestCase): - """Test an opt-in with no existing opt-out.""" def test_opt_in_without_optout(self): @@ -294,7 +292,6 @@ def test_opt_in_without_optout(self): class UserProfileOptoutFormTest(TestCase): - """Validate presence of correct optin/optout forms.""" form_re_template = ( diff --git a/patchwork/tests/views/test_patch.py b/patchwork/tests/views/test_patch.py index b34d4ed1a..9a46ef2af 100644 --- a/patchwork/tests/views/test_patch.py +++ b/patchwork/tests/views/test_patch.py @@ -19,6 +19,7 @@ from patchwork.models import State from patchwork.tests.utils import create_check from patchwork.tests.utils import create_maintainer +from patchwork.tests.utils import create_note from patchwork.tests.utils import create_patch from patchwork.tests.utils import create_patch_comment from patchwork.tests.utils import create_patches @@ -100,7 +101,7 @@ def setUp(self): create_patch(submitter=person, project=self.project, date=date) def _extract_patch_ids(self, response): - id_re = re.compile(r'Notes'.encode('utf-8'), response.content) + self.assertIn(note.content.encode('utf-8'), response.content) + + def test_hide_private_note(self): + project = create_project() + user = create_maintainer(project) + patch = create_patch(project=project) + note = create_note(patch=patch, submitter=user) + requested_url = reverse( + 'patch-detail', + kwargs={ + 'project_id': patch.project.linkname, + 'msgid': patch.encoded_msgid, + }, + ) + response = self.client.get(requested_url) + self.assertNotIn('

Notes

'.encode('utf-8'), response.content) + self.assertNotIn(note.content.encode('utf-8'), response.content) + + def test_show_public_note(self): + project = create_project() + user = create_maintainer(project) + patch = create_patch(project=project) + note = create_note(patch=patch, submitter=user, maintainer_only=False) + requested_url = reverse( + 'patch-detail', + kwargs={ + 'project_id': patch.project.linkname, + 'msgid': patch.encoded_msgid, + }, + ) + response = self.client.get(requested_url) + self.assertIn('

Notes

'.encode('utf-8'), response.content) + self.assertIn(note.content.encode('utf-8'), response.content) + def test_old_detail_url(self): patch = create_patch() @@ -382,7 +432,7 @@ def test_patch_with_checks(self): class PatchUpdateTest(TestCase): - properties_form_id = 'patchform-properties' + properties_form_id = 'patch-form-properties' def setUp(self): self.project = create_project() @@ -397,7 +447,7 @@ def setUp(self): self.base_data = { 'action': 'Update', 'project': str(self.project.id), - 'form': 'patchlistform', + 'form': 'patch-list-form', 'archived': '*', 'delegate': '*', 'state': '*', @@ -462,7 +512,7 @@ def test_state_change_invalid(self): self.assertEqual(new_states, orig_states) if django.VERSION >= (4, 1): self.assertFormError( - response.context['patchform'], + response.context['patch_form'], 'state', 'Select a valid choice. That choice is not one ' 'of the available choices.', @@ -470,7 +520,7 @@ def test_state_change_invalid(self): else: self.assertFormError( response, - 'patchform', + 'patch_form', 'state', 'Select a valid choice. That choice is not one ' 'of the available choices.', diff --git a/patchwork/tests/views/test_utils.py b/patchwork/tests/views/test_utils.py index 61fa07633..91f6b86e5 100644 --- a/patchwork/tests/views/test_utils.py +++ b/patchwork/tests/views/test_utils.py @@ -38,11 +38,11 @@ def test_utf8_nbsp_tags(self): """Test that UTF-8 NBSP characters are correctly handled.""" patch = create_patch(content='patch text\n') create_patch_comment( - patch=patch, content='comment\nAcked-by:\u00A0 foo' + patch=patch, content='comment\nAcked-by:\u00a0 foo' ) mbox = utils.patch_to_mbox(patch) - self.assertIn('\u00A0 foo\n', mbox) + self.assertIn('\u00a0 foo\n', mbox) def test_multiple_tags(self): """Test that the mbox view appends tags correct. diff --git a/patchwork/urls.py b/patchwork/urls.py index ecd3668de..1e0ffe568 100644 --- a/patchwork/urls.py +++ b/patchwork/urls.py @@ -224,6 +224,7 @@ from patchwork.api import cover as api_cover_views # noqa from patchwork.api import event as api_event_views # noqa from patchwork.api import index as api_index_views # noqa + from patchwork.api import note as api_note_views # noqa from patchwork.api import patch as api_patch_views # noqa from patchwork.api import person as api_person_views # noqa from patchwork.api import project as api_project_views # noqa @@ -345,14 +346,32 @@ ), ] + api_1_4_patterns = [ + path( + 'patches//notes/', + api_note_views.NoteDetail.as_view(), + name='api-patch-note-detail', + ), + path( + 'patches//notes/', + api_note_views.NoteList.as_view(), + name='api-patch-note-list', + ), + ] + urlpatterns += [ re_path( - r'^api/(?:(?P(1.0|1.1|1.2|1.3))/)?', include(api_patterns) + r'^api/(?:(?P(1.0|1.1|1.2|1.3|1.4))/)?', + include(api_patterns), + ), + re_path( + r'^api/(?:(?P(1.1|1.2|1.3|1.4))/)?', + include(api_1_1_patterns), ), re_path( - r'^api/(?:(?P(1.1|1.2|1.3))/)?', include(api_1_1_patterns) + r'^api/(?:(?P(1.3|1.4))/)?', include(api_1_3_patterns) ), - re_path(r'^api/(?:(?P(1.3))/)?', include(api_1_3_patterns)), + re_path(r'^api/(?:(?P(1.4))/)?', include(api_1_4_patterns)), # token change path( 'user/generate-token/', diff --git a/patchwork/views/__init__.py b/patchwork/views/__init__.py index 704ab8153..db484c799 100644 --- a/patchwork/views/__init__.py +++ b/patchwork/views/__init__.py @@ -3,11 +3,14 @@ # # SPDX-License-Identifier: GPL-2.0-or-later +import json + from django.contrib import messages from django.shortcuts import get_object_or_404 from django.db.models import Prefetch from patchwork.filters import Filters +from patchwork.forms import CreateBundleForm from patchwork.forms import MultiplePatchForm from patchwork.models import Bundle from patchwork.models import BundlePatch @@ -108,52 +111,34 @@ def apply(self, qs): # TODO(stephenfin): Refactor this to break it into multiple, testable functions -def set_bundle(request, project, action, data, patches, context): +def set_bundle(request, project, action, data, patches): # set up the bundle bundle = None user = request.user if action == 'create': - bundle_name = data['bundle_name'].strip() - if '/' in bundle_name: - return ["Bundle names can't contain slashes"] - - if not bundle_name: - return ['No bundle name was specified'] - - if Bundle.objects.filter(owner=user, name=bundle_name).count() > 0: - return ['You already have a bundle called "%s"' % bundle_name] - + bundle_name = data['name'].strip() bundle = Bundle(owner=user, project=project, name=bundle_name) - bundle.save() - messages.success(request, 'Bundle %s created' % bundle.name) + create_bundle_form = CreateBundleForm( + instance=bundle, data=request.POST + ) + if create_bundle_form.is_valid(): + create_bundle_form.save() + add_bundle_patches(request, patches, bundle) + bundle.save() + messages.success(request, 'Bundle %s created' % bundle.name) + else: + formErrors = json.loads(create_bundle_form.errors.as_json()) + errors = [e['message'] for e in formErrors['name']] + return errors elif action == 'add': + if not data['bundle_id']: + return ['No bundle was selected'] bundle = get_object_or_404(Bundle, id=data['bundle_id']) + add_bundle_patches(request, patches, bundle) elif action == 'remove': bundle = get_object_or_404(Bundle, id=data['removed_bundle_id']) - - if not bundle: - return ['no such bundle'] - - for patch in patches: - if action in ['create', 'add']: - bundlepatch_count = BundlePatch.objects.filter( - bundle=bundle, patch=patch - ).count() - if bundlepatch_count == 0: - bundle.append_patch(patch) - messages.success( - request, - "Patch '%s' added to bundle %s" - % (patch.name, bundle.name), - ) - else: - messages.warning( - request, - "Patch '%s' already in bundle %s" - % (patch.name, bundle.name), - ) - elif action == 'remove': + for patch in patches: try: bp = BundlePatch.objects.get(bundle=bundle, patch=patch) bp.delete() @@ -165,10 +150,26 @@ def set_bundle(request, project, action, data, patches, context): "Patch '%s' removed from bundle %s\n" % (patch.name, bundle.name), ) + return [] - bundle.save() - return [] +def add_bundle_patches(request, patches, bundle): + for patch in patches: + bundlepatch_count = BundlePatch.objects.filter( + bundle=bundle, patch=patch + ).count() + if bundlepatch_count == 0: + bundle.append_patch(patch) + bundle.save() + messages.success( + request, + "Patch '%s' added to bundle %s" % (patch.name, bundle.name), + ) + else: + messages.warning( + request, + "Patch '%s' already in bundle %s" % (patch.name, bundle.name), + ) def generic_list( @@ -232,28 +233,30 @@ def generic_list( data = None user = request.user properties_form = None + create_bundle_form = None if user.is_authenticated: # we only pass the post data to the MultiplePatchForm if that was # the actual form submitted data_tmp = None - if data and data.get('form', '') == 'patchlistform': + if data and data.get('form', '') == 'patch-list-form': data_tmp = data properties_form = MultiplePatchForm(project, data=data_tmp) + create_bundle_form = CreateBundleForm() - if request.method == 'POST' and data.get('form') == 'patchlistform': + if request.method == 'POST' and data.get('form') == 'patch-list-form': action = data.get('action', '').lower() # special case: the user may have hit enter in the 'create bundle' # text field, so if non-empty, assume the create action: - if data.get('bundle_name', False): + if data.get('name', False): action = 'create' ps = Patch.objects.filter(id__in=get_patch_ids(data)) if action in bundle_actions: - errors = set_bundle(request, project, action, data, ps, context) + errors = set_bundle(request, project, action, data, ps) elif properties_form and action == properties_form.action: errors = process_multiplepatch_form( @@ -319,7 +322,8 @@ def generic_list( context.update( { 'page': paginator.current_page, - 'patchform': properties_form, + 'patch_form': properties_form, + 'create_bundle_form': create_bundle_form, 'project': project, 'order': order, } diff --git a/patchwork/views/bundle.py b/patchwork/views/bundle.py index 6b7c264ad..26bf8fec3 100644 --- a/patchwork/views/bundle.py +++ b/patchwork/views/bundle.py @@ -110,7 +110,7 @@ def bundle_detail(request, username, bundlename): if ( request.method == 'POST' - and request.POST.get('form') == 'reorderform' + and request.POST.get('form') == 'reorder-form' ): order = get_object_or_404( BundlePatch, diff --git a/patchwork/views/mail.py b/patchwork/views/mail.py index 7c864c9ce..8709f0ad0 100644 --- a/patchwork/views/mail.py +++ b/patchwork/views/mail.py @@ -78,9 +78,9 @@ def _optinout(request, action): form = EmailForm(data=request.POST) if not form.is_valid(): - context[ - 'error' - ] = 'There was an error in the form. Please review and re-submit.' + context['error'] = ( + 'There was an error in the form. Please review and re-submit.' + ) context['form'] = form return render(request, html_template, context) diff --git a/patchwork/views/patch.py b/patchwork/views/patch.py index 54cf992c5..53a37a419 100644 --- a/patchwork/views/patch.py +++ b/patchwork/views/patch.py @@ -13,12 +13,16 @@ from django.urls import reverse from patchwork.forms import CreateBundleForm +from patchwork.forms import CreateNoteForm +from patchwork.forms import EditNoteForm +from patchwork.forms import DeleteNoteForm from patchwork.forms import PatchForm -from patchwork.models import Bundle +from patchwork.models import Note from patchwork.models import Cover from patchwork.models import Patch from patchwork.models import Project from patchwork.views import generic_list +from patchwork.views import set_bundle from patchwork.views.utils import patch_to_mbox from patchwork.views.utils import series_patch_to_mbox @@ -63,55 +67,89 @@ def patch_detail(request, project_id, msgid): context = {'project': patch.project} form = None - createbundleform = None + create_bundle_form = None + create_note_form = None + edit_note_form = None + edit_note_id = None + edit_cancel = False + errors = None + is_maintainer = ( + request.user.is_superuser + or request.user.is_authenticated + and patch.project in request.user.profile.maintainer_projects.all() + ) if editable: form = PatchForm(instance=patch) if request.user.is_authenticated: - createbundleform = CreateBundleForm() + create_bundle_form = CreateBundleForm() if request.method == 'POST': - action = request.POST.get('action', None) - if action: - action = action.lower() - - if action == 'createbundle': - bundle = Bundle(owner=request.user, project=project) - createbundleform = CreateBundleForm( - instance=bundle, data=request.POST - ) - if createbundleform.is_valid(): - createbundleform.save() - bundle.append_patch(patch) - bundle.save() - createbundleform = CreateBundleForm() - messages.success(request, 'Bundle %s created' % bundle.name) - elif action == 'addtobundle': - bundle = get_object_or_404( - Bundle, id=request.POST.get('bundle_id') - ) - if bundle.append_patch(patch): - messages.success( - request, - 'Patch "%s" added to bundle "%s"' - % (patch.name, bundle.name), + form_name = request.POST.get('form_name', '') + if is_maintainer and form_name == DeleteNoteForm.name: + note_form = DeleteNoteForm(request.POST) + if note_form.is_valid(): + note = get_object_or_404( + Note, id=note_form.cleaned_data['note_id'] ) + note.delete() + messages.success(request, 'Note removed') else: - messages.error( - request, - 'Failed to add patch "%s" to bundle "%s": ' - 'patch is already in bundle' % (patch.name, bundle.name), + errors = note_form.errors + + elif is_maintainer and form_name == CreateNoteForm.name: + create_note = CreateNoteForm( + request.POST, + instance=Note(patch=patch, submitter=request.user), + ) + if create_note.is_valid(): + create_note.save() + messages.success(request, 'Note created') + create_note_form = None + + elif is_maintainer and form_name == EditNoteForm.name: + edit_cancel = not not request.POST.get('cancel', None) + if not edit_cancel: + edit_note_form = EditNoteForm(request.POST) + if edit_note_form.is_valid(): + note = get_object_or_404( + Note, id=request.POST.get('note_id'), patch=patch + ) + edit_note_form = EditNoteForm(request.POST, instance=note) + if edit_note_form.is_valid(): + edit_note_form.save() + messages.success(request, 'Note updated') + else: + errors = edit_note_form.err + else: + action = request.POST.get('action', None) + if action: + action = action.lower() + + if is_maintainer and action == 'add-note': + create_note_form = CreateNoteForm() + + if is_maintainer and action == 'edit-note': + print(edit_cancel) + if not edit_cancel: + edit_note_form = EditNoteForm() + edit_note_id = request.POST.get('edit_note_id', None) + if edit_note_id is not Note: + edit_note_id = int(edit_note_id) + + elif action in ['create', 'add']: + errors = set_bundle( + request, project, action, request.POST, [patch] ) - # all other actions require edit privs - elif not editable: - return HttpResponseForbidden() + elif not editable: + return HttpResponseForbidden() - elif action is None: - form = PatchForm(data=request.POST, instance=patch) - if form.is_valid(): - form.save() - messages.success(request, 'Patch updated') + elif action == 'update': + form = PatchForm(data=request.POST, instance=patch) + if form.is_valid(): + form.save() + messages.success(request, 'Patch updated') if request.user.is_authenticated: context['bundles'] = request.user.bundles.all() @@ -122,6 +160,11 @@ def patch_detail(request, project_id, msgid): 'submitter', 'date', 'id', 'content', 'patch', 'addressed' ) + if is_maintainer: + notes = patch.note.all() + else: + notes = patch.note.filter(maintainer_only=False) + if patch.related: related_same_project = patch.related.patches.only( 'name', 'msgid', 'project', 'related' @@ -136,17 +179,28 @@ def patch_detail(request, project_id, msgid): related_same_project = [] related_different_project = [] + for note in notes: + note.delete_form = DeleteNoteForm( + auto_id=False, initial={'note_id': note.id} + ) + context['notes'] = notes context['comments'] = comments context['checks'] = Patch.filter_unique_checks( patch.check_set.all().select_related('user'), ) context['submission'] = patch context['editable'] = editable - context['patchform'] = form - context['createbundleform'] = createbundleform + context['is_maintainer'] = is_maintainer + context['create_note_form'] = create_note_form + context['edit_note_form'] = edit_note_form + context['edit_note_id'] = edit_note_id + context['patch_form'] = form + context['create_bundle_form'] = create_bundle_form context['project'] = patch.project context['related_same_project'] = related_same_project context['related_different_project'] = related_different_project + if errors: + context['errors'] = errors return render(request, 'patchwork/submission.html', context) diff --git a/releasenotes/notes/django-4-1-support-bcbe65a71d235b43.yaml b/releasenotes/notes/django-4-1-support-bcbe65a71d235b43.yaml deleted file mode 100644 index 3dcab1bdf..000000000 --- a/releasenotes/notes/django-4-1-support-bcbe65a71d235b43.yaml +++ /dev/null @@ -1,5 +0,0 @@ ---- -features: - - | - `Django 4.1 `_ is - now supported. diff --git a/releasenotes/notes/django-5-0-support-923e45ec2dc93117.yaml b/releasenotes/notes/django-5-0-support-923e45ec2dc93117.yaml index 84ec05969..2e7aa35e5 100644 --- a/releasenotes/notes/django-5-0-support-923e45ec2dc93117.yaml +++ b/releasenotes/notes/django-5-0-support-923e45ec2dc93117.yaml @@ -5,6 +5,5 @@ features: now supported. upgrade: - | - Django 3.2 and 4.1 are no longer supported. 4.1 is no longer supported - upstream while Django 3.2 goes EOL in April 2024. Most distributions - provide a newer version. + Django 3.2 and 4.1 are no longer supported. Bother releases are no longer + supported upstream and most distributions provide a newer version. diff --git a/releasenotes/notes/django-5-1-support-83a264d5f28e32c1.yaml b/releasenotes/notes/django-5-1-support-83a264d5f28e32c1.yaml new file mode 100644 index 000000000..c433eb41e --- /dev/null +++ b/releasenotes/notes/django-5-1-support-83a264d5f28e32c1.yaml @@ -0,0 +1,5 @@ +--- +features: + - | + `Django 5.1 `_ is + now supported. diff --git a/releasenotes/notes/issue-441-8392549b54b1178d.yaml b/releasenotes/notes/issue-441-8392549b54b1178d.yaml new file mode 100644 index 000000000..df40f855d --- /dev/null +++ b/releasenotes/notes/issue-441-8392549b54b1178d.yaml @@ -0,0 +1,15 @@ +--- +features: + - | + Added notes feature allowing maintainers of a patch to write notes for it so that maintainers + can understand why a patch is in any given state or to give any contextual information others + may not have. These can also be public so that any user can read them. +api: + - | + The API version has been updated to v1.4. + - | + A new REST API endpoint is available at ``/api/patches//notes``. + This can be used to create a new note or to retrive all notes from the specified patch + - | + A new REST API endpoint is available at ``/api/patches//notes/``. + This can be used to retrieve, update and delete the specified note diff --git a/releasenotes/notes/make-diff-colors-more-accessible-82eda58a89984d46.yaml b/releasenotes/notes/make-diff-colors-more-accessible-82eda58a89984d46.yaml new file mode 100644 index 000000000..f65995e51 --- /dev/null +++ b/releasenotes/notes/make-diff-colors-more-accessible-82eda58a89984d46.yaml @@ -0,0 +1,5 @@ +--- +other: + - | + The patch diff color palette was modified to make it more accessible for + all users, including those with common color deficiencies. diff --git a/releasenotes/notes/prelude-3_2-fadbacb4fe4227b4.yaml b/releasenotes/notes/prelude-3_2-fadbacb4fe4227b4.yaml new file mode 100644 index 000000000..743274fd5 --- /dev/null +++ b/releasenotes/notes/prelude-3_2-fadbacb4fe4227b4.yaml @@ -0,0 +1,8 @@ +--- +prelude: > + This release is another smaller release that focuses on bumping the + supported dependencies and updates the test matrix in advance of future, + larger changes. As always, recent versions of Python (3.12, 3.13) and + Django (5.0, 5.1) are now supported, while support for older Python + (3.7, 3.8) and Django (3.2, 4.0, 4.1) versions has been removed. More + information is included below. diff --git a/releasenotes/notes/python-3-12-support-db9b9726661b70e9.yaml b/releasenotes/notes/python-3-12-support-db9b9726661b70e9.yaml new file mode 100644 index 000000000..2ceca1b77 --- /dev/null +++ b/releasenotes/notes/python-3-12-support-db9b9726661b70e9.yaml @@ -0,0 +1,9 @@ +--- +features: + - | + `Python 3.12 `_ is + now supported. +upgrade: + - | + Python 3.8 is no longer supported. It is no longer supported upstream and + most distributions provide a newer version. diff --git a/releasenotes/notes/python-3-13-support-dc538fa3bc716863.yaml b/releasenotes/notes/python-3-13-support-dc538fa3bc716863.yaml new file mode 100644 index 000000000..f6831d827 --- /dev/null +++ b/releasenotes/notes/python-3-13-support-dc538fa3bc716863.yaml @@ -0,0 +1,5 @@ +--- +features: + - | + `Python 3.13 `_ is + now supported. diff --git a/requirements-dev.txt b/requirements-dev.txt index 47ee9afe8..123bd88fd 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,6 +1,6 @@ -Django~=5.0.0 -djangorestframework~=3.14.0 -django-filter~=23.5.0 -django-debug-toolbar~=4.2.0 -django-dbbackup~=4.1.0 +Django~=5.1.0 +djangorestframework~=3.15.2 +django-filter~=24.2.0 +django-debug-toolbar~=4.4.6 +django-dbbackup~=4.2.0 -r requirements-test.txt diff --git a/requirements-prod.txt b/requirements-prod.txt index 75c3825e3..4bd824a7b 100644 --- a/requirements-prod.txt +++ b/requirements-prod.txt @@ -1,5 +1,5 @@ -Django~=5.0.0 -djangorestframework~=3.14.0 -django-filter~=23.5.0 -psycopg2~=2.9.0 -sqlparse~=0.4.0 +Django~=5.1.0 +djangorestframework~=3.15.0 +django-filter~=24.3.0 +psycopg2~=2.9.10 +sqlparse~=0.5.1 diff --git a/requirements-test.txt b/requirements-test.txt index 5e9000edf..1371abd39 100644 --- a/requirements-test.txt +++ b/requirements-test.txt @@ -1,7 +1,8 @@ -mysqlclient~=2.2.0 -psycopg2-binary~=2.9.0 -sqlparse~=0.4.0 -python-dateutil~=2.8.0 +mysqlclient~=2.2.5 +psycopg2-binary~=2.9.9 +sqlparse~=0.5.1 +python-dateutil~=2.9.0 tblib~=3.0.0 -openapi-core~=0.18.0 -termcolor~=2.4.0 +openapi-core~=0.19.2 +jsonschema-path~=0.3.3 +termcolor~=2.5.0 diff --git a/templates/base.html b/templates/base.html index 747da5922..9519ecc55 100644 --- a/templates/base.html +++ b/templates/base.html @@ -93,7 +93,12 @@
  • Administration
    • {% endif %}
  • View profile
    • -
  • Logout
    • +
  • +
    + {% csrf_token %} + +
    +
    • {% else %} diff --git a/tools/docker/Dockerfile b/tools/docker/Dockerfile index bdae67a27..0a55b54db 100644 --- a/tools/docker/Dockerfile +++ b/tools/docker/Dockerfile @@ -1,13 +1,7 @@ FROM ghcr.io/getpatchwork/pyenv:latest -ARG UID -ARG GID - -# make sure the user has configured the '.env' file and quick fail if not - -RUN echo $UID; echo $GID; \ - [ -n "$UID" ] || { echo "You must define UID in .env" 1>&2; exit 1; }; \ - [ -n "$GID" ] || { echo "You must define GID in .env" 1>&2; exit 1; } +ARG UID=1000 +ARG GID=1000 ARG TZ="Australia/Canberra" ENV DEBIAN_FRONTEND noninteractive diff --git a/tox.ini b/tox.ini index 041097cd5..f1385fda7 100644 --- a/tox.ini +++ b/tox.ini @@ -1,17 +1,20 @@ [tox] minversion = 3.2 -envlist = pep8,docs,py{38,39,310,311}-django42,py{310,311,312}-django50 +envlist = pep8,docs,py{39,310,311}-django42,py{310,311,312}-django{50,51},py313-django51 [testenv] skip_install = true deps = -r{toxinidir}/requirements-test.txt django42: django~=4.2.0 - django42: djangorestframework~=3.14.0 - django42: django-filter~=23.5.0 + django42: djangorestframework~=3.15.0 + django42: django-filter~=24.3.0 django50: django~=5.0.0 - django50: djangorestframework~=3.14.0 - django50: django-filter~=23.5.0 + django50: djangorestframework~=3.15.0 + django50: django-filter~=24.3.0 + django51: django~=5.1.0 + django51: djangorestframework~=3.15.0 + django51: django-filter~=24.3.0 setenv = DJANGO_SETTINGS_MODULE = patchwork.settings.dev PYTHONDONTWRITEBYTECODE = 1 @@ -71,8 +74,8 @@ commands = [gh-actions] python = - 3.8: py38 3.9: py39 3.10: py310 3.11: py311 3.12: py312 + 3.13: py313 diff --git a/version.txt b/version.txt index 28f243b61..d4f3a239f 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -3.2.0.a.0 +3.3.0.a.0