You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tooling.apache.org by sb...@apache.org on 2025/04/21 13:14:31 UTC
(tooling-trusted-release) branch main updated: Add a page to start a release with the project preselected
This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-trusted-release.git
The following commit(s) were added to refs/heads/main by this push:
new a388109 Add a page to start a release with the project preselected
a388109 is described below
commit a3881091495b632b576845235bd29a5588474d19
Author: Sean B. Palmer <se...@miscoranda.com>
AuthorDate: Mon Apr 21 14:14:09 2025 +0100
Add a page to start a release with the project preselected
---
atr/routes/draft.py | 112 +++++++++++++++++++++++--------------
atr/routes/release.py | 50 +++++++++++++++++
atr/templates/index-committer.html | 2 +-
atr/templates/release-start.html | 42 ++++++++++++++
playwright/test.py | 5 +-
5 files changed, 165 insertions(+), 46 deletions(-)
diff --git a/atr/routes/draft.py b/atr/routes/draft.py
index 09002d0..6d38fa1 100644
--- a/atr/routes/draft.py
+++ b/atr/routes/draft.py
@@ -170,8 +170,21 @@ async def add(session: routes.CommitterSession) -> response.Response | str:
if not await form.validate_on_submit():
# TODO: Show the form with errors
return await session.redirect(add, error="Invalid form data")
- await _add(session, form)
- return await session.redirect(drafts, success="Release candidate created successfully")
+
+ try:
+ new_release, project = await create_release_draft(
+ project_name=str(form.project_name.data), version=str(form.version_name.data), asf_uid=session.uid
+ )
+ return await session.redirect(
+ overview,
+ project_name=project.name,
+ version_name=new_release.version,
+ success="Release candidate draft created successfully",
+ )
+ except (routes.FlashError, base.ASFQuartException) as e:
+ await quart.flash(str(e), "error")
+ # Get the preselected project from the query parameters, then fall through to render the template
+ preselected_project = quart.request.args.get("project")
return await quart.render_template(
"draft-add.html",
@@ -236,6 +249,60 @@ async def add_files(session: routes.CommitterSession, project_name: str, version
)
+async def create_release_draft(project_name: str, version: str, asf_uid: str) -> tuple[models.Release, models.Project]:
+ """Creates the initial release draft record and revision directory."""
+ # Get the project from the project name
+ async with db.session() as data:
+ async with data.begin():
+ project = await data.project(name=project_name, _committee=True).get()
+ if not project:
+ raise routes.FlashError(f"Project {project_name} not found")
+
+ # TODO: Temporarily allow committers to start drafts
+ if project.committee is None or (
+ asf_uid not in project.committee.committee_members and asf_uid not in project.committee.committers
+ ):
+ raise base.ASFQuartException(
+ f"You must be a member or committer for the {project.display_name}"
+ " committee to start a release draft.",
+ errorcode=403,
+ )
+
+ async with revision.create_and_manage(project_name, version, asf_uid) as (
+ _new_revision_dir,
+ _new_revision_name,
+ ):
+ # TODO: Consider using Release.revision instead of ./latest
+ async with db.session() as data:
+ async with data.begin():
+ # Check whether the release already exists
+ if release := await data.release(project_id=project.id, version=version).get():
+ if release.phase == models.ReleasePhase.RELEASE_CANDIDATE_DRAFT:
+ raise routes.FlashError(f"A draft for {project_name} {version} already exists.")
+ else:
+ raise routes.FlashError(
+ f"A release ({release.phase.value}) for {project_name} {version} already exists."
+ )
+
+ # Validate the version name
+ # TODO: We should check that it's bigger than the current version
+ if version_name_error := util.version_name_error(version):
+ raise routes.FlashError(f'Invalid version name "{version}": {version_name_error}')
+
+ release = models.Release(
+ stage=models.ReleaseStage.RELEASE_CANDIDATE,
+ phase=models.ReleasePhase.RELEASE_CANDIDATE_DRAFT,
+ project_id=project.id,
+ project=project,
+ version=version,
+ created=datetime.datetime.now(datetime.UTC),
+ )
+ data.add(release)
+
+ await data.refresh(release)
+ return release, project
+
+
@routes.committer("/draft/delete", methods=["POST"])
async def delete(session: routes.CommitterSession) -> response.Response:
"""Delete a candidate draft and all its associated files."""
@@ -1107,47 +1174,6 @@ async def view_path(
)
-async def _add(session: routes.CommitterSession, form: AddProtocol) -> None:
- """Handle POST request for creating a new release candidate draft."""
- version = str(form.version_name.data)
- project_name = str(form.project_name.data)
-
- # Create the release record in the database
- async with db.session() as data:
- async with data.begin():
- project = await data.project(name=project_name).get()
- if not project:
- raise routes.FlashError("Base project not found")
-
- if project_name not in (p.name for p in await session.user_projects):
- raise routes.FlashError(
- f"You must be a participant of {project_name} to submit a release candidate",
- )
-
- async with revision.create_and_manage(project_name, version, session.uid) as (
- _new_revision_dir,
- _new_revision_name,
- ):
- # TODO: Consider using Release.revision instead of ./latest
- async with db.session() as data:
- async with data.begin():
- if release := await data.release(project_id=project.id, version=version).get():
- raise routes.FlashError(f"{release.phase.value.upper()} with this name already exists")
-
- # Release is now linked to the appropriate project or subproject
- if version_name_error := util.version_name_error(version):
- raise routes.FlashError(f'Invalid version name "{version}": {version_name_error}')
- release = models.Release(
- stage=models.ReleaseStage.RELEASE_CANDIDATE,
- phase=models.ReleasePhase.RELEASE_CANDIDATE_DRAFT,
- project_id=project.id,
- project=project,
- version=version,
- created=datetime.datetime.now(datetime.UTC),
- )
- data.add(release)
-
-
async def _delete_candidate_draft(data: db.Session, candidate_draft_name: str) -> None:
"""Delete a candidate draft and all its associated files."""
# Check that the release exists
diff --git a/atr/routes/release.py b/atr/routes/release.py
index 92bc00b..a89846d 100644
--- a/atr/routes/release.py
+++ b/atr/routes/release.py
@@ -24,17 +24,31 @@ import asfquart
import asfquart.base as base
import quart
import werkzeug.wrappers.response as response
+import wtforms
import atr.db as db
import atr.db.models as models
import atr.routes as routes
import atr.routes.candidate as candidate
+import atr.routes.draft as draft
import atr.util as util
if asfquart.APP is ...:
raise RuntimeError("APP is not set")
+class StartReleaseForm(util.QuartFormTyped):
+ project_name = wtforms.HiddenField()
+ version_name = wtforms.StringField(
+ "Version",
+ validators=[
+ wtforms.validators.InputRequired("Version is required"),
+ wtforms.validators.Length(min=1, max=100),
+ ],
+ )
+ submit = wtforms.SubmitField("Start new release")
+
+
@routes.committer("/release/bulk/<int:task_id>", methods=["GET"])
async def bulk_status(session: routes.CommitterSession, task_id: int) -> str | response.Response:
"""Show status for a bulk download task."""
@@ -129,6 +143,42 @@ async def select(session: routes.CommitterSession, project_name: str) -> str:
)
+@routes.committer("/release/start/<project_name>", methods=["GET", "POST"])
+async def start(session: routes.CommitterSession, project_name: str) -> response.Response | str:
+ """Allow the user to start a new release draft, or handle its submission."""
+ async with db.session() as data:
+ project = await data.project(name=project_name).demand(
+ base.ASFQuartException(f"Project {project_name} not found", errorcode=404)
+ )
+
+ form = await StartReleaseForm.create_form(data=await quart.request.form if quart.request.method == "POST" else None)
+ if (quart.request.method == "GET") or (not form.project_name.data):
+ form.project_name.data = project_name
+
+ if (quart.request.method == "POST") and (await form.validate_on_submit()):
+ try:
+ # TODO: Move the helper somewhere else
+ # We already have the project, so we only need to get [0]
+ new_release = (
+ await draft.create_release_draft(
+ project_name=str(form.project_name.data), version=str(form.version_name.data), asf_uid=session.uid
+ )
+ )[0]
+ # Redirect to the new draft's overview page on success
+ return await session.redirect(
+ draft.overview,
+ project_name=project.name,
+ version_name=new_release.version,
+ success="Release candidate draft created successfully",
+ )
+ except (routes.FlashError, base.ASFQuartException) as e:
+ # Flash the error and let the code fall through to render the template below
+ await quart.flash(str(e), "error")
+
+ # Render the template for GET requests or POST requests with validation errors
+ return await quart.render_template("release-start.html", project=project, form=form, routes=routes)
+
+
@routes.committer("/release/view/<project_name>/<version_name>")
async def view(session: routes.CommitterSession, project_name: str, version_name: str) -> response.Response | str:
"""View all the files in the rsync upload directory for a release."""
diff --git a/atr/templates/index-committer.html b/atr/templates/index-committer.html
index cf41097..cd9bd4b 100644
--- a/atr/templates/index-committer.html
+++ b/atr/templates/index-committer.html
@@ -147,7 +147,7 @@
</a>
{% endfor %}
- <a href="{{ as_url(routes.draft.add, project=project.name) }}"
+ <a href="{{ as_url(routes.release.start, project_name=project.name) }}"
class="text-decoration-none">
<div class="card h-100 shadow-sm hover-lift atr-cursor-pointer page-card">
<div class="card-body d-flex justify-content-center align-items-center text-center text-secondary">
diff --git a/atr/templates/release-start.html b/atr/templates/release-start.html
new file mode 100644
index 0000000..713b5f6
--- /dev/null
+++ b/atr/templates/release-start.html
@@ -0,0 +1,42 @@
+{% extends "layouts/base.html" %}
+
+{% block title %}
+ Start a new release for {{ project.display_name }} ~ ATR
+{% endblock title %}
+
+{% block content %}
+ <h1>Start a new release</h1>
+ <p class="intro">
+ Starting a new release creates an initial <strong>release candidate draft</strong>. You can then add files to this draft before promoting it for review and voting.
+ </p>
+
+ <form method="post"
+ action="{{ as_url(routes.release.start, project_name=project.name) }}"
+ enctype="multipart/form-data"
+ class="atr-canary py-4 px-5 border rounded">
+
+ {{ form.hidden_tag() }} {# Includes csrf_token and project_name #}
+
+ <div class="mb-4">
+ <p class="fs-5">
+ <label class="form-label fs-5">Project:</label>
+ <span class="fw-semibold">{{ project.display_name }}</span>
+ </p>
+ </div>
+
+ <div class="mb-3">
+ <label for="{{ form.version_name.id }}" class="form-label">{{ form.version_name.label.text }}:</label>
+ {{ form.version_name(class_="form-control form-control-lg", placeholder="E.g. 1.2.3+rc1 or 2.5") }}
+ {% if form.version_name.errors -%}
+ <div class="invalid-feedback d-block">{{ form.version_name.errors[0] }}</div>
+ {%- endif %}
+ <div id="versionHelp" class="form-text">Enter the version string for this new release.</div>
+ </div>
+
+ <div class="mt-4">
+ {{ form.submit(class_="btn btn-primary btn-lg") }}
+ <a href="{{ as_url(routes.root.index) }}" class="btn btn-link ms-2">Cancel</a>
+ </div>
+ </form>
+
+{% endblock content %}
diff --git a/playwright/test.py b/playwright/test.py
index 5ed730d..d5c7b92 100644
--- a/playwright/test.py
+++ b/playwright/test.py
@@ -588,13 +588,14 @@ def test_lifecycle_01_add_draft(page: sync_api.Page, credentials: Credentials) -
sync_api.expect(submit_button_locator).to_be_enabled()
submit_button_locator.click()
- logging.info("Waiting for navigation to /drafts after adding draft")
- wait_for_path(page, "/drafts")
+ logging.info("Waiting for navigation to /draft/overview/tooling-test-example/0.1 after adding draft")
+ wait_for_path(page, "/draft/overview/tooling-test-example/0.1")
logging.info("Add draft actions completed successfully")
def test_lifecycle_02_check_draft_added(page: sync_api.Page, credentials: Credentials) -> None:
logging.info("Checking for draft 'tooling-test-example-0.1'")
+ go_to_path(page, "/drafts")
draft_card_locator = page.locator(r"#tooling-test-example-0\.1")
sync_api.expect(draft_card_locator).to_be_visible()
logging.info("Draft 'tooling-test-example-0.1' found successfully")
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tooling.apache.org
For additional commands, e-mail: commits-help@tooling.apache.org