Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

enhance: add scm user id to build obj #1133

Merged
merged 7 commits into from
Jun 4, 2024
Merged

enhance: add scm user id to build obj #1133

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
32861c6
enhance: add scm user id to build obj
plyr4 Jun 3, 2024
a8958cf
enhance: add GetUserID to scm interface
plyr4 Jun 3, 2024
242ebf9
fix: apply missing scm id using scm client lookups
plyr4 Jun 3, 2024
7625a96
chore: verbose comment on fallback user fetch
plyr4 Jun 4, 2024
82c8578
chore: comment typo
plyr4 Jun 4, 2024
167c95b
enhance: use repo owner token in schedule processing
plyr4 Jun 4, 2024
37d5dfc
enhance: use repo owner token in restart build
plyr4 Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions api/build/restart.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ func RestartBuild(c *gin.Context) {
o := org.Retrieve(c)
r := repo.Retrieve(c)
u := user.Retrieve(c)
scm := scm.FromContext(c)
ctx := c.Request.Context()

entry := fmt.Sprintf("%s/%d", r.GetFullName(), b.GetNumber())
Expand All @@ -112,8 +113,22 @@ func RestartBuild(c *gin.Context) {
return
}

// set sender to the user who initiated the restart and parent to the previous build
// set sender to the user who initiated the restart and
b.SetSender(cl.Subject)

// fetch scm user id
senderID, err := scm.GetUserID(ctx, u.GetName(), u.GetToken())
if err != nil {
retErr := fmt.Errorf("unable to get SCM user id for %s: %w", u.GetName(), err)

util.HandleError(c, http.StatusInternalServerError, retErr)

return
}

b.SetSenderSCMID(senderID)

// parent to the previous build
b.SetParent(b.GetNumber())

logger.Debugf("Generating queue items for build %s", entry)
Expand All @@ -132,7 +147,7 @@ func RestartBuild(c *gin.Context) {
c,
config,
database.FromContext(c),
scm.FromContext(c),
scm,
compiler.FromContext(c),
queue.FromContext(c),
)
Expand Down
84 changes: 57 additions & 27 deletions api/types/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ type Build struct {
Message *string `json:"message,omitempty"`
Commit *string `json:"commit,omitempty"`
Sender *string `json:"sender,omitempty"`
SenderSCMID *string `json:"sender_scm_id,omitempty"`
Author *string `json:"author,omitempty"`
Email *string `json:"email,omitempty"`
Link *string `json:"link,omitempty"`
Expand Down Expand Up @@ -86,33 +87,34 @@ func (b *Build) Duration() string {
// provided from the fields of the Build type.
func (b *Build) Environment(workspace, channel string) map[string]string {
envs := map[string]string{
"VELA_BUILD_APPROVED_AT": ToString(b.GetApprovedAt()),
"VELA_BUILD_APPROVED_BY": ToString(b.GetApprovedBy()),
"VELA_BUILD_AUTHOR": ToString(b.GetAuthor()),
"VELA_BUILD_AUTHOR_EMAIL": ToString(b.GetEmail()),
"VELA_BUILD_BASE_REF": ToString(b.GetBaseRef()),
"VELA_BUILD_BRANCH": ToString(b.GetBranch()),
"VELA_BUILD_CHANNEL": ToString(channel),
"VELA_BUILD_CLONE": ToString(b.GetClone()),
"VELA_BUILD_COMMIT": ToString(b.GetCommit()),
"VELA_BUILD_CREATED": ToString(b.GetCreated()),
"VELA_BUILD_DISTRIBUTION": ToString(b.GetDistribution()),
"VELA_BUILD_ENQUEUED": ToString(b.GetEnqueued()),
"VELA_BUILD_EVENT": ToString(b.GetEvent()),
"VELA_BUILD_EVENT_ACTION": ToString(b.GetEventAction()),
"VELA_BUILD_HOST": ToString(b.GetHost()),
"VELA_BUILD_LINK": ToString(b.GetLink()),
"VELA_BUILD_MESSAGE": ToString(b.GetMessage()),
"VELA_BUILD_NUMBER": ToString(b.GetNumber()),
"VELA_BUILD_PARENT": ToString(b.GetParent()),
"VELA_BUILD_REF": ToString(b.GetRef()),
"VELA_BUILD_RUNTIME": ToString(b.GetRuntime()),
"VELA_BUILD_SENDER": ToString(b.GetSender()),
"VELA_BUILD_STARTED": ToString(b.GetStarted()),
"VELA_BUILD_SOURCE": ToString(b.GetSource()),
"VELA_BUILD_STATUS": ToString(b.GetStatus()),
"VELA_BUILD_TITLE": ToString(b.GetTitle()),
"VELA_BUILD_WORKSPACE": ToString(workspace),
"VELA_BUILD_APPROVED_AT": ToString(b.GetApprovedAt()),
"VELA_BUILD_APPROVED_BY": ToString(b.GetApprovedBy()),
"VELA_BUILD_AUTHOR": ToString(b.GetAuthor()),
"VELA_BUILD_AUTHOR_EMAIL": ToString(b.GetEmail()),
"VELA_BUILD_BASE_REF": ToString(b.GetBaseRef()),
"VELA_BUILD_BRANCH": ToString(b.GetBranch()),
"VELA_BUILD_CHANNEL": ToString(channel),
"VELA_BUILD_CLONE": ToString(b.GetClone()),
"VELA_BUILD_COMMIT": ToString(b.GetCommit()),
"VELA_BUILD_CREATED": ToString(b.GetCreated()),
"VELA_BUILD_DISTRIBUTION": ToString(b.GetDistribution()),
"VELA_BUILD_ENQUEUED": ToString(b.GetEnqueued()),
"VELA_BUILD_EVENT": ToString(b.GetEvent()),
"VELA_BUILD_EVENT_ACTION": ToString(b.GetEventAction()),
"VELA_BUILD_HOST": ToString(b.GetHost()),
"VELA_BUILD_LINK": ToString(b.GetLink()),
"VELA_BUILD_MESSAGE": ToString(b.GetMessage()),
"VELA_BUILD_NUMBER": ToString(b.GetNumber()),
"VELA_BUILD_PARENT": ToString(b.GetParent()),
"VELA_BUILD_REF": ToString(b.GetRef()),
"VELA_BUILD_RUNTIME": ToString(b.GetRuntime()),
"VELA_BUILD_SENDER": ToString(b.GetSender()),
"VELA_BUILD_SENDER_SCM_ID": ToString(b.GetSenderSCMID()),
"VELA_BUILD_STARTED": ToString(b.GetStarted()),
"VELA_BUILD_SOURCE": ToString(b.GetSource()),
"VELA_BUILD_STATUS": ToString(b.GetStatus()),
"VELA_BUILD_TITLE": ToString(b.GetTitle()),
"VELA_BUILD_WORKSPACE": ToString(workspace),

// deprecated environment variables
"BUILD_AUTHOR": ToString(b.GetAuthor()),
Expand Down Expand Up @@ -502,6 +504,19 @@ func (b *Build) GetSender() string {
return *b.Sender
}

// GetSenderSCMID returns the SenderSCMID field.
//
// When the provided Build type is nil, or the field within
// the type is nil, it returns the zero value for the field.
func (b *Build) GetSenderSCMID() string {
// return zero value if Build type or SenderSCMID field is nil
if b == nil || b.SenderSCMID == nil {
return ""
}

return *b.SenderSCMID
}

// GetAuthor returns the Author field.
//
// When the provided Build type is nil, or the field within
Expand Down Expand Up @@ -944,6 +959,19 @@ func (b *Build) SetSender(v string) {
b.Sender = &v
}

// SetSenderSCMID sets the SenderSCMID field.
//
// When the provided Build type is nil, it
// will set nothing and immediately return.
func (b *Build) SetSenderSCMID(v string) {
// return if Build type is nil
if b == nil {
return
}

b.SenderSCMID = &v
}

// SetAuthor sets the Author field.
//
// When the provided Build type is nil, it
Expand Down Expand Up @@ -1135,6 +1163,7 @@ func (b *Build) String() string {
Repo: %s,
Runtime: %s,
Sender: %s,
SenderSCMID: %s,
Source: %s,
Started: %d,
Status: %s,
Expand Down Expand Up @@ -1170,6 +1199,7 @@ func (b *Build) String() string {
b.GetRepo().GetFullName(),
b.GetRuntime(),
b.GetSender(),
b.GetSenderSCMID(),
b.GetSource(),
b.GetStarted(),
b.GetStatus(),
Expand Down
Loading
Loading