Skip to content

Return project specific hooks only in ListHooks API for Azure. #192

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

Merged
merged 4 commits into from
Jun 13, 2022
Merged

Return project specific hooks only in ListHooks API for Azure. #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21c8989
Merge pull request #1 from raghavharness/raghav/CI-4621
raghavharness Jun 1, 2022
8fd8aad
Merge pull request #2 from raghavharness/raghav/CI-4621
raghavharness Jun 1, 2022
16ae602
Merge branch 'master' of https://github.com/drone/go-scm
raghavharness Jun 11, 2022
5c53bd5
[CI-4622]: Added projectFilter for ListHooks API for Azure
raghavharness Jun 11, 2022
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
26 changes: 15 additions & 11 deletions scm/driver/azure/repo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ type RepositoryService struct {
func (s *RepositoryService) Find(ctx context.Context, repo string) (*scm.Repository, *scm.Response, error) {
// https://docs.microsoft.com/en-us/rest/api/azure/devops/git/repositories/get?view=azure-devops-rest-4.1
if s.client.project == "" {
return nil, nil, ProjectRequiredError()
}
return nil, nil, ProjectRequiredError()
}
endpoint := fmt.Sprintf("%s/%s/_apis/git/repositories/%s?api-version=6.0", s.client.owner, s.client.project, repo)

out := new(repository)
Expand Down Expand Up @@ -59,12 +59,16 @@ func (s *RepositoryService) List(ctx context.Context, opts scm.ListOptions) ([]*
func (s *RepositoryService) ListHooks(ctx context.Context, repo string, opts scm.ListOptions) ([]*scm.Hook, *scm.Response, error) {
// https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/list?view=azure-devops-rest-6.0
if s.client.project == "" {
return nil, nil, ProjectRequiredError()
}
return nil, nil, ProjectRequiredError()
}
projectID, projErr := s.getProjectIDFromProjectName(ctx, s.client.project)
if projErr != nil {
return nil, nil, fmt.Errorf("ListHooks was unable to look up the project's projectID, %s", projErr)
}
endpoint := fmt.Sprintf("%s/_apis/hooks/subscriptions?api-version=6.0", s.client.owner)
out := new(subscriptions)
res, err := s.client.do(ctx, "GET", endpoint, nil, &out)
return convertHookList(out.Value, repo), res, err
return convertHookList(out.Value, projectID, repo), res, err
}

// ListStatus returns a list of commit statuses.
Expand All @@ -76,8 +80,8 @@ func (s *RepositoryService) ListStatus(ctx context.Context, repo, ref string, op
func (s *RepositoryService) CreateHook(ctx context.Context, repo string, input *scm.HookInput) (*scm.Hook, *scm.Response, error) {
// https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/create?view=azure-devops-rest-6.0
if s.client.project == "" {
return nil, nil, ProjectRequiredError()
}
return nil, nil, ProjectRequiredError()
}
endpoint := fmt.Sprintf("%s/_apis/hooks/subscriptions?api-version=6.0", s.client.owner)
in := new(subscription)
in.Status = "enabled"
Expand Down Expand Up @@ -129,8 +133,8 @@ func (s *RepositoryService) UpdateHook(ctx context.Context, repo, id string, inp
func (s *RepositoryService) DeleteHook(ctx context.Context, repo, id string) (*scm.Response, error) {
// https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/delete?view=azure-devops-rest-6.0
if s.client.project == "" {
return nil, ProjectRequiredError()
}
return nil, ProjectRequiredError()
}
endpoint := fmt.Sprintf("%s/_apis/hooks/subscriptions/%s?api-version=6.0", s.client.owner, id)
return s.client.do(ctx, "DELETE", endpoint, nil, nil)
}
Expand Down Expand Up @@ -262,10 +266,10 @@ func convertRepository(from *repository) *scm.Repository {
}
}

func convertHookList(from []*subscription, repositoryFilter string) []*scm.Hook {
func convertHookList(from []*subscription, projectFilter string, repositoryFilter string) []*scm.Hook {
to := []*scm.Hook{}
for _, v := range from {
if repositoryFilter != "" && repositoryFilter == v.PublisherInputs.Repository {
if repositoryFilter != "" && projectFilter == v.PublisherInputs.ProjectID && repositoryFilter == v.PublisherInputs.Repository {
to = append(to, convertHook(v))
}
}
Expand Down
37 changes: 37 additions & 0 deletions scm/driver/azure/repo_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,43 @@ func TestRepositoryHookCreate(t *testing.T) {
}
}

func TestHooksList(t *testing.T) {
defer gock.Off()

gock.New("https:/dev.azure.com/").
Get("/ORG/_apis/projects").
Reply(201).
Type("application/json").
File("testdata/projects.json")

gock.New("https:/dev.azure.com/").
Get("/ORG/_apis/hooks/subscriptions").
Reply(200).
Type("application/json").
File("testdata/hooks.json")

client := NewDefault("ORG", "test_project")
repoID := "fde2d21f-13b9-4864-a995-83329045289a"

got, _, err := client.Repositories.ListHooks(context.Background(), repoID, scm.ListOptions{})
if err != nil {
t.Error(err)
return
}

want := []*scm.Hook{}
raw, _ := ioutil.ReadFile("testdata/hooks.json.golden")
jsonErr := json.Unmarshal(raw, &want)
if jsonErr != nil {
t.Error(jsonErr)
}

if diff := cmp.Diff(got, want); diff != "" {
t.Errorf("Unexpected Results")
t.Log(diff)
}
}

func TestRepositoryHookDelete(t *testing.T) {
defer gock.Off()

Expand Down
121 changes: 121 additions & 0 deletions scm/driver/azure/testdata/hooks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
{
"count": 2,
"value": [
{
"id": "d455cb11-20a0-4b15-b546-7e9fb9973cc6",
"url": "https://dev.azure.com/tphoney/_apis/hooks/subscriptions/d455cb11-20a0-4b15-b546-7e9fb9973cc6",
"status": "enabled",
"publisherId": "tfs",
"eventType": "git.pullrequest.created",
"subscriber": null,
"resourceVersion": "1.0",
"eventDescription": "Repository test_repo2",
"consumerId": "webHooks",
"consumerActionId": "httpRequest",
"actionDescription": "To host www.bla.com",
"probationRetries": 1,
"createdBy": {
"displayName": "tp",
"id": "3ff4a20f-306e-677e-8a01-57f35e71f109",
"uniqueName": "[email protected]",
"descriptor": "msa.M2ZmNGEyMGYtMzA2ZS03NzdlLThhMDEtNTdmMzVlNzFmMTA5"
},
"createdDate": "2022-03-25T13:28:12.39Z",
"modifiedBy": {
"displayName": "tp",
"id": "3ff4a20f-306e-677e-8a01-57f35e71f109",
"uniqueName": "[email protected]",
"descriptor": "msa.M2ZmNGEyMGYtMzA2ZS03NzdlLThhMDEtNTdmMzVlNzFmMTA5"
},
"modifiedDate": "2022-03-29T10:39:13.813Z",
"lastProbationRetryDate": "2022-03-28T10:44:51.093Z",
"publisherInputs": {
"branch": "",
"projectId": "d350c9c0-7749-4ff8-a78f-f9c1f0e56729",
"pullrequestCreatedBy": "",
"pullrequestReviewersContains": "",
"repository": "fde2d21f-13b9-4864-a995-83329045289a",
"tfsSubscriptionId": "4ce8d6c4-f655-418d-8eb6-9462dd01ff39"
},
"consumerInputs": {
"acceptUntrustedCerts": "true",
"url": "http://www.bla.com"
},
"_links": {
"self": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/subscriptions/d455cb11-20a0-4b15-b546-7e9fb9973cc6"
},
"consumer": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/consumers/webHooks"
},
"actions": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/consumers/webHooks/actions"
},
"notifications": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/subscriptions/d455cb11-20a0-4b15-b546-7e9fb9973cc6/notifications"
},
"publisher": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/publishers/tfs"
}
}
},
{
"id": "d455cb11-20a0-4b15-b546-7e9fb9973cc7",
"url": "https://dev.azure.com/tphoney/_apis/hooks/subscriptions/d455cb11-20a0-4b15-b546-7e9fb9973cc7",
"status": "enabled",
"publisherId": "tfs",
"eventType": "git.pullrequest.merged",
"subscriber": null,
"resourceVersion": "1.0",
"eventDescription": "Repository test_repo2",
"consumerId": "webHooks",
"consumerActionId": "httpRequest",
"actionDescription": "To host www.bla.com",
"probationRetries": 1,
"createdBy": {
"displayName": "tp",
"id": "3ff4a20f-306e-677e-8a01-57f35e71f109",
"uniqueName": "[email protected]",
"descriptor": "msa.M2ZmNGEyMGYtMzA2ZS03NzdlLThhMDEtNTdmMzVlNzFmMTA5"
},
"createdDate": "2022-03-25T13:28:12.39Z",
"modifiedBy": {
"displayName": "tp",
"id": "3ff4a20f-306e-677e-8a01-57f35e71f109",
"uniqueName": "[email protected]",
"descriptor": "msa.M2ZmNGEyMGYtMzA2ZS03NzdlLThhMDEtNTdmMzVlNzFmMTA5"
},
"modifiedDate": "2022-03-29T10:39:13.813Z",
"lastProbationRetryDate": "2022-03-28T10:44:51.093Z",
"publisherInputs": {
"branch": "",
"projectId": "d350c9c0-7749-4ff8-a78f-f9c1f0e56729",
"pullrequestCreatedBy": "",
"pullrequestReviewersContains": "",
"repository": "fde2d21f-13b9-4864-a995-83329045289a",
"tfsSubscriptionId": "4ce8d6c4-f655-418d-8eb6-9462dd01ff39"
},
"consumerInputs": {
"acceptUntrustedCerts": "true",
"url": "http://www.bla.com"
},
"_links": {
"self": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/subscriptions/d455cb11-20a0-4b15-b546-7e9fb9973cc7"
},
"consumer": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/consumers/webHooks"
},
"actions": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/consumers/webHooks/actions"
},
"notifications": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/subscriptions/d455cb11-20a0-4b15-b546-7e9fb9973cc7/notifications"
},
"publisher": {
"href": "https://dev.azure.com/tphoney/_apis/hooks/publishers/tfs"
}
}
}
]
}
22 changes: 22 additions & 0 deletions scm/driver/azure/testdata/hooks.json.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[
{
"ID": "d455cb11-20a0-4b15-b546-7e9fb9973cc6",
"Name": "",
"Target": "http://www.bla.com",
"Events": [
"git.pullrequest.created"
],
"Active": true,
"SkipVerify": true
},
{
"ID": "d455cb11-20a0-4b15-b546-7e9fb9973cc7",
"Name": "",
"Target": "http://www.bla.com",
"Events": [
"git.pullrequest.merged"
],
"Active": true,
"SkipVerify": true
}
]