Skip to content

Commit

Permalink
feat(eventsources/bitbucketserver): add OneEventPerChange config opti…
Browse files Browse the repository at this point in the history
…on for webhook event handling

Add OneEventPerChange config option to control whether to process each change in a repo:refs_changed webhook event as a separate event. This allows independent processing of each tag or reference update in a single webhook event useful for triggering distinct workflows in Argo Workflows.

Signed-off-by: Ryan Currah <ryan@currah.ca>
  • Loading branch information
ryancurrah committed Aug 26, 2024
1 parent 7b44edd commit 31a4f20
Show file tree
Hide file tree
Showing 16 changed files with 1,309 additions and 921 deletions.
19 changes: 18 additions & 1 deletion api/event-source.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 22 additions & 2 deletions api/event-source.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 17 additions & 1 deletion api/jsonschema/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -1055,7 +1055,7 @@
"type": "object"
},
"io.argoproj.eventsource.v1alpha1.BitbucketBasicAuth": {
"description": "BasicAuth holds the information required to authenticate user via basic auth mechanism",
"description": "BitbucketBasicAuth holds the information required to authenticate user via basic auth mechanism",
"properties": {
"password": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
Expand Down Expand Up @@ -1186,6 +1186,10 @@
"description": "Metadata holds the user defined metadata which will passed along the event payload.",
"type": "object"
},
"oneEventPerChange": {
"description": "OneEventPerChange controls whether to process each change in a repo:refs_changed webhook event as a separate event. This setting is useful when multiple tags are pushed simultaneously for the same commit, and each tag needs to independently trigger an action, such as a distinct workflow in Argo Workflows. When enabled, the BitbucketServerEventSource publishes an individual BitbucketServerEventData for each change, ensuring independent processing of each tag or reference update in a single webhook event.",
"type": "boolean"
},
"projectKey": {
"description": "DeprecatedProjectKey is the key of project for which integration needs to set up. Deprecated: use Repositories instead. Will be unsupported in v1.8.",
"type": "string"
Expand Down Expand Up @@ -5381,6 +5385,9 @@
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
Expand Down Expand Up @@ -5439,6 +5446,9 @@
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
Expand Down Expand Up @@ -5854,6 +5864,9 @@
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
Expand Down Expand Up @@ -5912,6 +5925,9 @@
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
Expand Down
18 changes: 17 additions & 1 deletion api/openapi-spec/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

148 changes: 148 additions & 0 deletions eventsources/sources/bitbucketserver/bitbucketserverclients.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
package bitbucketserver

import (
"context"
"fmt"
"net/http"

"github.com/argoproj/argo-events/common"
"github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1"
bitbucketv1 "github.com/gfleury/go-bitbucket-v1"
"github.com/mitchellh/mapstructure"
)

func newBitbucketServerClientCfg(bitbucketserverEventSource *v1alpha1.BitbucketServerEventSource) (*bitbucketv1.Configuration, error) {
bitbucketCfg := bitbucketv1.NewConfiguration(bitbucketserverEventSource.BitbucketServerBaseURL)
bitbucketCfg.AddDefaultHeader("x-atlassian-token", "no-check")
bitbucketCfg.AddDefaultHeader("x-requested-with", "XMLHttpRequest")
bitbucketCfg.HTTPClient = &http.Client{}

if bitbucketserverEventSource.TLS != nil {
tlsConfig, err := common.GetTLSConfig(bitbucketserverEventSource.TLS)
if err != nil {
return nil, fmt.Errorf("failed to get the tls configuration: %w", err)
}

bitbucketCfg.HTTPClient.Transport = &http.Transport{
TLSClientConfig: tlsConfig,
}
}

return bitbucketCfg, nil
}

func newBitbucketServerClient(ctx context.Context, bitbucketConfig *bitbucketv1.Configuration, bitbucketToken string) *bitbucketv1.APIClient {
ctx = context.WithValue(ctx, bitbucketv1.ContextAccessToken, bitbucketToken)
return bitbucketv1.NewAPIClient(ctx, bitbucketConfig)
}

type bitbucketServerReposPager struct {
Size int `json:"size"`
Limit int `json:"limit"`
Start int `json:"start"`
NextPageStart int `json:"nextPageStart"`
IsLastPage bool `json:"isLastPage"`
Values []bitbucketv1.Repository `json:"values"`
}

// getProjectRepositories returns all the Bitbucket Server repositories in the provided projects.
func getProjectRepositories(client *bitbucketv1.APIClient, projects []string) ([]v1alpha1.BitbucketServerRepository, error) {
var bitbucketRepos []bitbucketv1.Repository
for _, project := range projects {
paginationOptions := map[string]interface{}{"start": 0, "limit": 500}
for {
response, err := client.DefaultApi.GetRepositoriesWithOptions(project, paginationOptions)
if err != nil {
return nil, fmt.Errorf("unable to list repositories for project %s: %w", project, err)
}

var reposPager bitbucketServerReposPager
err = mapstructure.Decode(response.Values, &reposPager)
if err != nil {
return nil, fmt.Errorf("unable to decode repositories for project %s: %w", project, err)
}

bitbucketRepos = append(bitbucketRepos, reposPager.Values...)

if reposPager.IsLastPage {
break
}

paginationOptions["start"] = reposPager.NextPageStart
}
}

var repositories []v1alpha1.BitbucketServerRepository
for n := range bitbucketRepos {
repositories = append(repositories, v1alpha1.BitbucketServerRepository{
ProjectKey: bitbucketRepos[n].Project.Key,
RepositorySlug: bitbucketRepos[n].Slug,
})
}

return repositories, nil
}

type refsChangedWebhookEvent struct {
EventKey string `json:"eventKey"`
Date string `json:"date"`
Actor struct {
Name string `json:"name"`
EmailAddress string `json:"emailAddress"`
ID int `json:"id"`
DisplayName string `json:"displayName"`
Active bool `json:"active"`
Slug string `json:"slug"`
Type string `json:"type"`
Links struct {
Self []struct {
Href string `json:"href"`
} `json:"self"`
} `json:"links"`
} `json:"actor"`
Repository struct {
Slug string `json:"slug"`
ID int `json:"id"`
Name string `json:"name"`
HierarchyID string `json:"hierarchyId"`
ScmID string `json:"scmId"`
State string `json:"state"`
StatusMessage string `json:"statusMessage"`
Forkable bool `json:"forkable"`
Project struct {
Key string `json:"key"`
ID int `json:"id"`
Name string `json:"name"`
Public bool `json:"public"`
Type string `json:"type"`
Links struct {
Self []struct {
Href string `json:"href"`
} `json:"self"`
} `json:"links"`
} `json:"project"`
Public bool `json:"public"`
Links struct {
Clone []struct {
Href string `json:"href"`
Name string `json:"name"`
} `json:"clone"`
Self []struct {
Href string `json:"href"`
} `json:"self"`
} `json:"links"`
} `json:"repository"`
Changes []refsChangedWebHookEventChange `json:"changes"`
}

type refsChangedWebHookEventChange struct {
Ref struct {
ID string `json:"id"`
DisplayID string `json:"displayId"`
Type string `json:"type"`
} `json:"ref"`
RefID string `json:"refId"`
FromHash string `json:"fromHash"`
ToHash string `json:"toHash"`
Type string `json:"type"`
}
Loading

0 comments on commit 31a4f20

Please sign in to comment.