Complete forge delivery regression coverage
This commit is contained in:
@@ -10,7 +10,6 @@ import (
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
)
|
||||
|
||||
type FailureKind string
|
||||
@@ -55,14 +54,7 @@ type Destination struct {
|
||||
Token string
|
||||
}
|
||||
|
||||
type Request struct {
|
||||
Destination Destination
|
||||
Tag string
|
||||
Commit string
|
||||
Note string
|
||||
}
|
||||
|
||||
type Release struct {
|
||||
type release struct {
|
||||
ID int64
|
||||
URL string
|
||||
TagName string
|
||||
@@ -72,12 +64,6 @@ type Release struct {
|
||||
Prerelease bool
|
||||
}
|
||||
|
||||
type Result struct {
|
||||
Release Release
|
||||
Created bool
|
||||
WriteAttempted bool // a create request was issued, including reconciled creates.
|
||||
}
|
||||
|
||||
type Client struct {
|
||||
HTTPClient *http.Client
|
||||
}
|
||||
@@ -108,109 +94,29 @@ type createReleaseRequest struct {
|
||||
Prerelease bool `json:"prerelease"`
|
||||
}
|
||||
|
||||
// EnsureRelease verifies the hosted tag and finds or creates its stable release
|
||||
// page. It never edits a release that already exists.
|
||||
func (c Client) EnsureRelease(ctx context.Context, request Request) (Result, error) {
|
||||
if err := validateRequest(request); err != nil {
|
||||
return Result{}, err
|
||||
}
|
||||
base, err := parseBaseURL(request.Destination.BaseURL)
|
||||
if err != nil {
|
||||
return Result{}, failure(FailureInvalid, "validate destination", 0, err)
|
||||
}
|
||||
client := c.httpClient()
|
||||
apiRoot := strings.TrimRight(base.String(), "/") + "/api/v1/repos/" + url.PathEscape(request.Destination.Owner) + "/" + url.PathEscape(request.Destination.Repository)
|
||||
tagURL := apiRoot + "/tags/" + url.PathEscape(request.Tag)
|
||||
|
||||
var tag tagResponse
|
||||
if err := c.getJSON(ctx, client, request.Destination.Token, "get hosted tag", tagURL, &tag); err != nil {
|
||||
return Result{}, err
|
||||
}
|
||||
if tag.Commit.SHA != request.Commit {
|
||||
return Result{}, failure(FailureConflict, "verify hosted tag", 0, fmt.Errorf("tag %q targets %q, want %q", request.Tag, tag.Commit.SHA, request.Commit))
|
||||
}
|
||||
|
||||
releaseURL := apiRoot + "/releases/tags/" + url.PathEscape(request.Tag)
|
||||
existing, status, err := c.getRelease(ctx, client, request.Destination.Token, releaseURL)
|
||||
if err == nil {
|
||||
return acceptExisting(existing, request)
|
||||
}
|
||||
if status != http.StatusNotFound {
|
||||
return Result{}, err
|
||||
}
|
||||
|
||||
title := noteTitle(request.Note)
|
||||
body, err := json.Marshal(createReleaseRequest{
|
||||
TagName: request.Tag, TargetCommitish: request.Commit,
|
||||
Name: title, Body: request.Note,
|
||||
})
|
||||
if err != nil {
|
||||
return Result{}, failure(FailureInvalid, "encode release", 0, err)
|
||||
}
|
||||
created, postStatus, postErr := c.postRelease(ctx, client, request.Destination.Token, apiRoot+"/releases", body)
|
||||
if postErr == nil {
|
||||
result, verifyErr := acceptCreated(created, request)
|
||||
if verifyErr == nil {
|
||||
result.WriteAttempted = true
|
||||
return result, nil
|
||||
}
|
||||
postErr = verifyErr
|
||||
}
|
||||
if !shouldReconcileWrite(postStatus, postErr) {
|
||||
return Result{}, postErr
|
||||
}
|
||||
|
||||
// A conflict or interrupted server response may have followed a successful
|
||||
// create. One lookup resolves only a page with the exact selected content.
|
||||
retry, retryStatus, retryErr := c.getRelease(ctx, client, request.Destination.Token, releaseURL)
|
||||
if retryErr == nil {
|
||||
result, matchErr := acceptExisting(retry, request)
|
||||
if matchErr == nil {
|
||||
result.WriteAttempted = true
|
||||
return result, nil
|
||||
}
|
||||
return Result{}, failure(FailureConflict, "resolve release creation", postStatus, matchErr)
|
||||
}
|
||||
if retryStatus == http.StatusNotFound {
|
||||
if postStatus == http.StatusConflict {
|
||||
return Result{}, failure(FailureConflict, "create release", postStatus, postErr)
|
||||
}
|
||||
return Result{}, failure(FailureUnknown, "resolve release creation", postStatus, postErr)
|
||||
}
|
||||
return Result{}, failure(FailureUnknown, "resolve release creation", postStatus, errors.Join(postErr, retryErr))
|
||||
}
|
||||
|
||||
func shouldReconcileWrite(status int, err error) bool {
|
||||
if status == http.StatusConflict || status >= 500 || errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
|
||||
return true
|
||||
}
|
||||
var failure *Failure
|
||||
return errors.As(err, &failure) && (failure.Kind == FailureTransport || failure.Kind == FailureMalformed)
|
||||
}
|
||||
|
||||
func (c Client) getRelease(ctx context.Context, client *http.Client, token, endpoint string) (Release, int, error) {
|
||||
func (c Client) getRelease(ctx context.Context, client *http.Client, token, endpoint string) (release, int, error) {
|
||||
request, err := http.NewRequestWithContext(ctx, http.MethodGet, endpoint, nil)
|
||||
if err != nil {
|
||||
return Release{}, 0, failure(FailureInvalid, "find release", 0, err)
|
||||
return release{}, 0, failure(FailureInvalid, "find release", 0, err)
|
||||
}
|
||||
request.Header.Set("Authorization", "token "+token)
|
||||
request.Header.Set("Accept", "application/json")
|
||||
response, err := client.Do(request)
|
||||
if err != nil {
|
||||
return Release{}, 0, failure(FailureTransport, "find release", 0, err)
|
||||
return release{}, 0, failure(FailureTransport, "find release", 0, err)
|
||||
}
|
||||
defer response.Body.Close()
|
||||
if response.StatusCode == http.StatusNotFound {
|
||||
return Release{}, response.StatusCode, failure(FailureNotFound, "find release", response.StatusCode, nil)
|
||||
return release{}, response.StatusCode, failure(FailureNotFound, "find release", response.StatusCode, nil)
|
||||
}
|
||||
if response.StatusCode < 200 || response.StatusCode >= 300 {
|
||||
return Release{}, response.StatusCode, responseFailure("find release", response.StatusCode)
|
||||
return release{}, response.StatusCode, responseFailure("find release", response.StatusCode)
|
||||
}
|
||||
var decoded releaseResponse
|
||||
if err := decodeJSON(response.Body, &decoded); err != nil {
|
||||
return Release{}, response.StatusCode, failure(FailureMalformed, "decode release", response.StatusCode, err)
|
||||
return release{}, response.StatusCode, failure(FailureMalformed, "decode release", response.StatusCode, err)
|
||||
}
|
||||
return decoded.Release(), response.StatusCode, nil
|
||||
return decoded.release(), response.StatusCode, nil
|
||||
}
|
||||
|
||||
func (c Client) getJSON(ctx context.Context, client *http.Client, token, operation, endpoint string, destination any) error {
|
||||
@@ -234,27 +140,27 @@ func (c Client) getJSON(ctx context.Context, client *http.Client, token, operati
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c Client) postRelease(ctx context.Context, client *http.Client, token, endpoint string, body []byte) (Release, int, error) {
|
||||
func (c Client) postRelease(ctx context.Context, client *http.Client, token, endpoint string, body []byte) (release, int, error) {
|
||||
request, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, bytes.NewReader(body))
|
||||
if err != nil {
|
||||
return Release{}, 0, failure(FailureInvalid, "create release", 0, err)
|
||||
return release{}, 0, failure(FailureInvalid, "create release", 0, err)
|
||||
}
|
||||
request.Header.Set("Authorization", "token "+token)
|
||||
request.Header.Set("Accept", "application/json")
|
||||
request.Header.Set("Content-Type", "application/json")
|
||||
response, err := client.Do(request)
|
||||
if err != nil {
|
||||
return Release{}, 0, failure(FailureTransport, "create release", 0, err)
|
||||
return release{}, 0, failure(FailureTransport, "create release", 0, err)
|
||||
}
|
||||
defer response.Body.Close()
|
||||
if response.StatusCode < 200 || response.StatusCode >= 300 {
|
||||
return Release{}, response.StatusCode, responseFailure("create release", response.StatusCode)
|
||||
return release{}, response.StatusCode, responseFailure("create release", response.StatusCode)
|
||||
}
|
||||
var decoded releaseResponse
|
||||
if err := decodeJSON(response.Body, &decoded); err != nil {
|
||||
return Release{}, response.StatusCode, failure(FailureMalformed, "decode created release", response.StatusCode, err)
|
||||
return release{}, response.StatusCode, failure(FailureMalformed, "decode created release", response.StatusCode, err)
|
||||
}
|
||||
return decoded.Release(), response.StatusCode, nil
|
||||
return decoded.release(), response.StatusCode, nil
|
||||
}
|
||||
|
||||
func (c Client) httpClient() *http.Client {
|
||||
@@ -269,28 +175,6 @@ func (c Client) httpClient() *http.Client {
|
||||
return &clientCopy
|
||||
}
|
||||
|
||||
func validateRequest(request Request) error {
|
||||
if strings.TrimSpace(request.Tag) == "" {
|
||||
return failure(FailureInvalid, "validate request", 0, errors.New("full release tag is required"))
|
||||
}
|
||||
if !validObjectID(request.Commit) {
|
||||
return failure(FailureInvalid, "validate request", 0, errors.New("source commit must be a lowercase Git object ID"))
|
||||
}
|
||||
if strings.TrimSpace(request.Destination.Owner) == "" || strings.ContainsAny(request.Destination.Owner, "/\\") {
|
||||
return failure(FailureInvalid, "validate request", 0, errors.New("Gitea owner is required as one path segment"))
|
||||
}
|
||||
if strings.TrimSpace(request.Destination.Repository) == "" || strings.ContainsAny(request.Destination.Repository, "/\\") {
|
||||
return failure(FailureInvalid, "validate request", 0, errors.New("Gitea repository is required as one path segment"))
|
||||
}
|
||||
if strings.TrimSpace(request.Destination.Token) == "" {
|
||||
return failure(FailureInvalid, "validate request", 0, errors.New("Gitea token is required"))
|
||||
}
|
||||
if noteTitle(request.Note) == "" {
|
||||
return failure(FailureInvalid, "validate request", 0, errors.New("release note must begin with a level-one heading"))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func parseBaseURL(raw string) (*url.URL, error) {
|
||||
parsed, err := url.Parse(raw)
|
||||
if err != nil {
|
||||
@@ -302,30 +186,8 @@ func parseBaseURL(raw string) (*url.URL, error) {
|
||||
return parsed, nil
|
||||
}
|
||||
|
||||
func acceptExisting(release Release, request Request) (Result, error) {
|
||||
if release.TagName != request.Tag || release.Body != request.Note || release.Draft || release.Prerelease {
|
||||
return Result{}, failure(FailureConflict, "verify existing release", 0, errors.New("existing release does not match the committed note and stable tag"))
|
||||
}
|
||||
return Result{Release: release}, nil
|
||||
}
|
||||
|
||||
func acceptCreated(release Release, request Request) (Result, error) {
|
||||
if release.ID <= 0 || release.TagName != request.Tag || release.Body != request.Note || release.Title != noteTitle(request.Note) || release.Draft || release.Prerelease {
|
||||
return Result{}, failure(FailureMalformed, "verify created release", 0, errors.New("created release response does not match the requested stable release"))
|
||||
}
|
||||
return Result{Release: release, Created: true}, nil
|
||||
}
|
||||
|
||||
func (response releaseResponse) Release() Release {
|
||||
return Release{ID: response.ID, URL: response.HTMLURL, TagName: response.TagName, Title: response.Name, Body: response.Body, Draft: response.Draft, Prerelease: response.Prerelease}
|
||||
}
|
||||
|
||||
func noteTitle(note string) string {
|
||||
first := strings.SplitN(note, "\n", 2)[0]
|
||||
if !strings.HasPrefix(first, "# ") {
|
||||
return ""
|
||||
}
|
||||
return strings.TrimSpace(strings.TrimPrefix(first, "# "))
|
||||
func (response releaseResponse) release() release {
|
||||
return release{ID: response.ID, URL: response.HTMLURL, TagName: response.TagName, Title: response.Name, Body: response.Body, Draft: response.Draft, Prerelease: response.Prerelease}
|
||||
}
|
||||
|
||||
func validObjectID(value string) bool {
|
||||
|
||||
Reference in New Issue
Block a user