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.

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

Implement installation_target webhook event type #2829

Merged
merged 2 commits into from
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 2 additions & 0 deletions github/event.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ func (e *Event) ParsePayload() (payload interface{}, err error) {
payload = &InstallationEvent{}
case "InstallationRepositoriesEvent":
payload = &InstallationRepositoriesEvent{}
case "InstallationTargetEvent":
payload = &InstallationTargetEvent{}
case "IssueCommentEvent":
payload = &IssueCommentEvent{}
case "IssuesEvent":
Expand Down
32 changes: 32 additions & 0 deletions github/event_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,38 @@ type InstallationRepositoriesEvent struct {
Installation *Installation `json:"installation,omitempty"`
}

// Change in login
type Login struct {
RickleAndMortimer marked this conversation as resolved.
Show resolved Hide resolved
From *string `json:"from,omitempty"`
}

// Change in slug
type Slug struct {
RickleAndMortimer marked this conversation as resolved.
Show resolved Hide resolved
From *string `json:"from,omitempty"`
}

// Changes represents a change in slug or login
type Changes struct {
RickleAndMortimer marked this conversation as resolved.
Show resolved Hide resolved
Login *Login `json:"login,omitempty"`
Slug *Slug `json:"slug,omitempty"`
}

// InstallationTargetEvent is triggered when there is activity on an installation from a user or organization account.
// The Webhook event name is "installation_target".
//
// GitHub API docs: https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads#installation_target
type InstallationTargetEvent struct {
Account *User `json:"account,omitempty"`
Action *string `json:"action,omitempty"`
Changes *Changes `json:"changes,omitempty"`
Enterprise *Enterprise `json:"enterprise,omitempty"`
Installation *Installation `json:"installation,omitempty"`
Organization *Organization `json:"organization,omitempty"`
Repository *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
TargetType *string `json:"target_type,omitempty"`
}

// IssueCommentEvent is triggered when an issue comment is created on an issue
// or pull request.
// The Webhook event name is "issue_comment".
Expand Down
336 changes: 336 additions & 0 deletions github/event_types_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1332,6 +1332,342 @@ func TestInstallationRepositoriesEvent_Marshal(t *testing.T) {
testJSONMarshal(t, u, want)
}

func TestInstallationTargetEvent_Marshal(t *testing.T) {
testJSONMarshal(t, &InstallationTargetEvent{}, "{}")

u := &InstallationTargetEvent{
Account: &User{
Login: String("u"),
ID: Int64(1),
NodeID: String("n"),
URL: String("u"),
ReposURL: String("r"),
EventsURL: String("e"),
AvatarURL: String("l"),
},
Action: String("a"),
Changes: &Changes{
Login: &Login{
From: String("p"),
},
Slug: &Slug{
From: String("j"),
},
},
Enterprise: &Enterprise{
ID: Int(1),
Slug: String("s"),
Name: String("n"),
NodeID: String("nid"),
AvatarURL: String("au"),
Description: String("d"),
WebsiteURL: String("wu"),
HTMLURL: String("hu"),
CreatedAt: &Timestamp{referenceTime},
UpdatedAt: &Timestamp{referenceTime},
},
Installation: &Installation{
ID: Int64(1),
NodeID: String("nid"),
AppID: Int64(1),
AppSlug: String("as"),
TargetID: Int64(1),
Account: &User{
Login: String("l"),
ID: Int64(1),
URL: String("u"),
AvatarURL: String("a"),
GravatarID: String("g"),
Name: String("n"),
Company: String("c"),
Blog: String("b"),
Location: String("l"),
Email: String("e"),
Hireable: Bool(true),
Bio: String("b"),
TwitterUsername: String("t"),
PublicRepos: Int(1),
Followers: Int(1),
Following: Int(1),
CreatedAt: &Timestamp{referenceTime},
SuspendedAt: &Timestamp{referenceTime},
},
AccessTokensURL: String("atu"),
RepositoriesURL: String("ru"),
HTMLURL: String("hu"),
TargetType: String("tt"),
SingleFileName: String("sfn"),
RepositorySelection: String("rs"),
Events: []string{"e"},
SingleFilePaths: []string{"s"},
Permissions: &InstallationPermissions{
Actions: String("a"),
Administration: String("ad"),
Checks: String("c"),
Contents: String("co"),
ContentReferences: String("cr"),
Deployments: String("d"),
Environments: String("e"),
Issues: String("i"),
Metadata: String("md"),
Members: String("m"),
OrganizationAdministration: String("oa"),
OrganizationHooks: String("oh"),
OrganizationPlan: String("op"),
OrganizationPreReceiveHooks: String("opr"),
OrganizationProjects: String("op"),
OrganizationSecrets: String("os"),
OrganizationSelfHostedRunners: String("osh"),
OrganizationUserBlocking: String("oub"),
Packages: String("pkg"),
Pages: String("pg"),
PullRequests: String("pr"),
RepositoryHooks: String("rh"),
RepositoryProjects: String("rp"),
RepositoryPreReceiveHooks: String("rprh"),
Secrets: String("s"),
SecretScanningAlerts: String("ssa"),
SecurityEvents: String("se"),
SingleFile: String("sf"),
Statuses: String("s"),
TeamDiscussions: String("td"),
VulnerabilityAlerts: String("va"),
Workflows: String("w"),
},
CreatedAt: &Timestamp{referenceTime},
UpdatedAt: &Timestamp{referenceTime},
HasMultipleSingleFiles: Bool(false),
SuspendedBy: &User{
Login: String("l"),
ID: Int64(1),
URL: String("u"),
AvatarURL: String("a"),
GravatarID: String("g"),
Name: String("n"),
Company: String("c"),
Blog: String("b"),
Location: String("l"),
Email: String("e"),
Hireable: Bool(true),
Bio: String("b"),
TwitterUsername: String("t"),
PublicRepos: Int(1),
Followers: Int(1),
Following: Int(1),
CreatedAt: &Timestamp{referenceTime},
SuspendedAt: &Timestamp{referenceTime},
},
SuspendedAt: &Timestamp{referenceTime},
},
Organization: &Organization{
BillingEmail: String("be"),
Blog: String("b"),
Company: String("c"),
Email: String("e"),
TwitterUsername: String("tu"),
Location: String("loc"),
Name: String("n"),
Description: String("d"),
IsVerified: Bool(true),
HasOrganizationProjects: Bool(true),
HasRepositoryProjects: Bool(true),
DefaultRepoPermission: String("drp"),
MembersCanCreateRepos: Bool(true),
MembersCanCreateInternalRepos: Bool(true),
MembersCanCreatePrivateRepos: Bool(true),
MembersCanCreatePublicRepos: Bool(false),
MembersAllowedRepositoryCreationType: String("marct"),
MembersCanCreatePages: Bool(true),
MembersCanCreatePublicPages: Bool(false),
MembersCanCreatePrivatePages: Bool(true),
},
Repository: &Repository{
ID: Int64(1),
URL: String("s"),
Name: String("n"),
},
Sender: &User{
Login: String("l"),
ID: Int64(1),
NodeID: String("n"),
URL: String("u"),
ReposURL: String("r"),
EventsURL: String("e"),
AvatarURL: String("a"),
},
TargetType: String("running"),
}

want := `{
"account": {
"login": "u",
"id": 1,
"node_id": "n",
"avatar_url": "l",
"url": "u",
"events_url": "e",
"repos_url": "r"
},
"action": "a",
"changes": {
"login": {
"from": "p"
},
"slug": {
"from": "j"
}
},
"enterprise": {
"id": 1,
"slug": "s",
"name": "n",
"node_id": "nid",
"avatar_url": "au",
"description": "d",
"website_url": "wu",
"html_url": "hu",
"created_at": ` + referenceTimeStr + `,
"updated_at": ` + referenceTimeStr + `
},
"installation": {
"id": 1,
"node_id": "nid",
"app_id": 1,
"app_slug": "as",
"target_id": 1,
"account": {
"login": "l",
"id": 1,
"avatar_url": "a",
"gravatar_id": "g",
"name": "n",
"company": "c",
"blog": "b",
"location": "l",
"email": "e",
"hireable": true,
"bio": "b",
"twitter_username": "t",
"public_repos": 1,
"followers": 1,
"following": 1,
"created_at": ` + referenceTimeStr + `,
"suspended_at": ` + referenceTimeStr + `,
"url": "u"
},
"access_tokens_url": "atu",
"repositories_url": "ru",
"html_url": "hu",
"target_type": "tt",
"single_file_name": "sfn",
"repository_selection": "rs",
"events": [
"e"
],
"single_file_paths": [
"s"
],
"permissions": {
"actions": "a",
"administration": "ad",
"checks": "c",
"contents": "co",
"content_references": "cr",
"deployments": "d",
"environments": "e",
"issues": "i",
"metadata": "md",
"members": "m",
"organization_administration": "oa",
"organization_hooks": "oh",
"organization_plan": "op",
"organization_pre_receive_hooks": "opr",
"organization_projects": "op",
"organization_secrets": "os",
"organization_self_hosted_runners": "osh",
"organization_user_blocking": "oub",
"packages": "pkg",
"pages": "pg",
"pull_requests": "pr",
"repository_hooks": "rh",
"repository_projects": "rp",
"repository_pre_receive_hooks": "rprh",
"secrets": "s",
"secret_scanning_alerts": "ssa",
"security_events": "se",
"single_file": "sf",
"statuses": "s",
"team_discussions": "td",
"vulnerability_alerts": "va",
"workflows": "w"
},
"created_at": ` + referenceTimeStr + `,
"updated_at": ` + referenceTimeStr + `,
"has_multiple_single_files": false,
"suspended_by": {
"login": "l",
"id": 1,
"avatar_url": "a",
"gravatar_id": "g",
"name": "n",
"company": "c",
"blog": "b",
"location": "l",
"email": "e",
"hireable": true,
"bio": "b",
"twitter_username": "t",
"public_repos": 1,
"followers": 1,
"following": 1,
"created_at": ` + referenceTimeStr + `,
"suspended_at": ` + referenceTimeStr + `,
"url": "u"
},
"suspended_at": ` + referenceTimeStr + `
},
"organization": {
"name": "n",
"company": "c",
"blog": "b",
"location": "loc",
"email": "e",
"twitter_username": "tu",
"description": "d",
"billing_email": "be",
"is_verified": true,
"has_organization_projects": true,
"has_repository_projects": true,
"default_repository_permission": "drp",
"members_can_create_repositories": true,
"members_can_create_public_repositories": false,
"members_can_create_private_repositories": true,
"members_can_create_internal_repositories": true,
"members_allowed_repository_creation_type": "marct",
"members_can_create_pages": true,
"members_can_create_public_pages": false,
"members_can_create_private_pages": true
},
"repository": {
"id": 1,
"url": "s",
"name": "n"
},
"sender": {
"login": "l",
"id": 1,
"node_id": "n",
"avatar_url": "a",
"url": "u",
"events_url": "e",
"repos_url": "r"
},
"target_type": "running"
}`

testJSONMarshal(t, u, want)
}

func TestEditTitle_Marshal(t *testing.T) {
testJSONMarshal(t, &EditTitle{}, "{}")

Expand Down
Loading