mirrors/go-github
0
0 Fork 0
mirror of https://github.com/google/go-github.git synced 2026-10-28 16:34:37 +08:00
Code Activity
Files
master
go-github/github/orgs_audit_log_test.go
T

465 lines
13 KiB
Go
Raw Permalink Blame History

// Copyright 2021 The go-github AUTHORS. All rights reserved.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package github
import (
"encoding/json"
"fmt"
"net/http"
"testing"
"time"
)
func TestOrganizationService_GetAuditLog(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)
mux.HandleFunc("/orgs/o/audit-log", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
testFormValues(t, r, values{"include": "all", "phrase": "action:workflows", "order": "asc"})
fmt.Fprint(w, `[
{
"@timestamp": 1615077308538,
"_document_id": "beeZYapIUe-wKg5-beadb33",
"action": "workflows.completed_workflow_run",
"active": true,
"actor": "testactor",
"actor_ip": "10.0.0.1",
"actor_location": {
"country_code": "US"
},
"cancelled_at": "2021-03-07T00:35:08.000Z",
"completed_at": "2021-03-07T00:35:08.000Z",
"conclusion": "success",
"config": {
"content_type": "json",
"insecure_ssl": "0",
"url": "https://example.com/deadbeef-new-hook"
},
"created_at": 1615077308538,
"event": "schedule",
"events": ["code_scanning_alert"],
"hashed_token": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"head_branch": "master",
"head_sha": "5acdeadbeef64d1a62388e901e5cdc9358644b37",
"job_workflow_ref": "testorg/testrepo/.github/workflows/testjob.yml@refs/pull/1/merge",
"name": "Code scanning - action",
"oauth_application_id": 1,
"old_permission": "read",
"org": "o",
"org_id": 1,
"overridden_codes": [
"review_policy_not_satisfied"
],
"permission": "admin",
"pull_request_id": 1,
"pull_request_title": "a pr title",
"pull_request_url": "https://github.com/testorg/testrepo/pull/1",
"reasons": [
{
"code": "a code",
"message": "a message"
}
],
"programmatic_access_type": "GitHub App server-to-server token",
"referrer": "a referrer",
"repo": "o/blue-crayon-1",
"run_attempt": 1,
"run_number": 1,
"started_at": "2021-03-07T00:33:04.000Z",
"token_id": 1,
"token_scopes": "gist,repo:read",
"topic": "cp1-iad.ingest.github.actions.v0.WorkflowUpdate",
"trigger_id": null,
"user_agent": "a user agent",
"workflow_id": 123456,
"workflow_run_id": 628312345
}]`)
})
ctx := t.Context()
getOpts := GetAuditLogOptions{
Include: new("all"),
Phrase: new("action:workflows"),
Order: new("asc"),
}
auditEntries, _, err := client.Organizations.GetAuditLog(ctx, "o", &getOpts)
if err != nil {
t.Errorf("Organizations.GetAuditLog returned error: %v", err)
}
timestamp := time.Unix(0, 1615077308538*1e6)
want := []*AuditEntry{
{
Timestamp: &Timestamp{timestamp},
DocumentID: new("beeZYapIUe-wKg5-beadb33"),
Action: new("workflows.completed_workflow_run"),
Actor: new("testactor"),
ActorLocation: &ActorLocation{
CountryCode: new("US"),
},
CreatedAt: &Timestamp{timestamp},
HashedToken: new("AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="),
Org: new("o"),
OrgID: new(int64(1)),
TokenID: new(int64(1)),
TokenScopes: new("gist,repo:read"),
AdditionalFields: map[string]any{
"actor_ip": "10.0.0.1",
"active": true,
"cancelled_at": "2021-03-07T00:35:08.000Z",
"completed_at": "2021-03-07T00:35:08.000Z",
"conclusion": "success",
"event": "schedule",
"head_branch": "master",
"head_sha": "5acdeadbeef64d1a62388e901e5cdc9358644b37",
"job_workflow_ref": "testorg/testrepo/.github/workflows/testjob.yml@refs/pull/1/merge",
"name": "Code scanning - action",
"oauth_application_id": float64(1),
"old_permission": "read",
"overridden_codes": []any{"review_policy_not_satisfied"},
"permission": "admin",
"programmatic_access_type": "GitHub App server-to-server token",
"pull_request_id": float64(1),
"pull_request_title": "a pr title",
"pull_request_url": "https://github.com/testorg/testrepo/pull/1",
"reasons": []any{map[string]any{
"code": "a code",
"message": "a message",
}},
"referrer": "a referrer",
"repo": "o/blue-crayon-1",
"run_attempt": float64(1),
"run_number": float64(1),
"started_at": "2021-03-07T00:33:04.000Z",
"topic": "cp1-iad.ingest.github.actions.v0.WorkflowUpdate",
"user_agent": "a user agent",
"workflow_id": float64(123456),
"workflow_run_id": float64(628312345),
"events": []any{"code_scanning_alert"},
"config": map[string]any{
"content_type": "json",
"insecure_ssl": "0",
"url": "https://example.com/deadbeef-new-hook",
},
},
},
}
assertNoDiff(t, want, auditEntries)
const methodName = "GetAuditLog"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Organizations.GetAuditLog(ctx, "\n", &getOpts)
return err
})
testNewRequestAndDoFailureCategory(t, methodName, client, AuditLogCategory, func() (*Response, error) {
got, resp, err := client.Organizations.GetAuditLog(ctx, "o", &GetAuditLogOptions{})
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}
func TestAuditEntry_MarshalJSON(t *testing.T) {
t.Parallel()
testJSONMarshal(t, &AuditEntry{}, "{}")
u := AuditEntry{
Action: new("a"),
Actor: new("ac"),
ActorLocation: &ActorLocation{CountryCode: new("alcc")},
Business: new("b"),
CreatedAt: &Timestamp{referenceTime},
DocumentID: new("did"),
ExternalIdentityNameID: new("ein"),
ExternalIdentityUsername: new("eiu"),
HashedToken: new("ht"),
Org: new("o"),
OrgID: new(int64(1)),
Timestamp: &Timestamp{referenceTime},
TokenID: new(int64(1)),
TokenScopes: new("ts"),
User: new("u"),
Data: map[string]any{
"old_name": "on",
"old_login": "ol",
},
AdditionalFields: map[string]any{
"active": false,
"active_was": false,
"actor_ip": "aip",
"blocked_user": "bu",
"cancelled_at": "2021-03-07T00:35:08.000Z",
"completed_at": "2021-03-07T00:35:08.000Z",
"conclusion": "c",
"config": map[string]any{
"url": "s",
},
"config_was": map[string]any{
"url": "s",
},
"content_type": "ct",
"deploy_key_fingerprint": "dkf",
"emoji": "e",
"environment_name": "en",
"event": "e",
"events": []any{"s"},
"events_were": []any{"s"},
"explanation": "e",
"fingerprint": "f",
"head_branch": "hb",
"head_sha": "hsha",
"hook_id": float64(1),
"is_hosted_runner": false,
"job_name": "jn",
"limited_availability": false,
"message": "m",
"name": "n",
"old_permission": "op",
"old_user": "ou",
"openssh_public_key": "osshpk",
"permission": "p",
"previous_visibility": "pv",
"programmatic_access_type": "pat",
"pull_request_id": float64(1),
"pull_request_title": "prt",
"pull_request_url": "pru",
"read_only": "ro",
"reasons": []any{
map[string]any{
"code": "c",
"message": "m",
},
},
"referrer": "a referrer",
"repo": "r",
"repository": "repo",
"repository_public": false,
"run_attempt": 1,
"runner_group_id": 1,
"runner_group_name": "rgn",
"runner_id": 1,
"runner_labels": []any{"s"},
"runner_name": "rn",
"secrets_passed": []any{"s"},
"source_version": "sv",
"started_at": "2006-01-02T15:04:05Z",
"target_login": "tl",
"target_version": "tv",
"team": "t",
"topic": "cp1-iad.ingest.github.actions.v0.WorkflowUpdate",
"transport_protocol": 1,
"transport_protocol_name": "tpn",
"trigger_id": 1,
"user_agent": "ua",
"visibility": "v",
"workflow_id": 1,
"workflow_run_id": 1,
},
}
want := `{
"action": "a",
"active": false,
"active_was": false,
"actor": "ac",
"actor_ip": "aip",
"actor_location": {
"country_code": "alcc"
},
"blocked_user": "bu",
"business": "b",
"cancelled_at": "2021-03-07T00:35:08.000Z",
"completed_at": "2021-03-07T00:35:08.000Z",
"conclusion": "c",
"config": {
"url": "s"
},
"config_was": {
"url": "s"
},
"content_type": "ct",
"created_at": ` + referenceTimeStr + `,
"deploy_key_fingerprint": "dkf",
"_document_id": "did",
"emoji": "e",
"environment_name": "en",
"event": "e",
"events": [
"s"
],
"events_were": [
"s"
],
"explanation": "e",
"external_identity_nameid": "ein",
"external_identity_username": "eiu",
"fingerprint": "f",
"hashed_token": "ht",
"head_branch": "hb",
"head_sha": "hsha",
"hook_id": 1,
"is_hosted_runner": false,
"job_name": "jn",
"limited_availability": false,
"message": "m",
"name": "n",
"old_permission": "op",
"old_user": "ou",
"openssh_public_key": "osshpk",
"org": "o",
"org_id": 1,
"permission": "p",
"previous_visibility": "pv",
"programmatic_access_type": "pat",
"pull_request_id": 1,
"pull_request_title": "prt",
"pull_request_url": "pru",
"reasons": [{
"code": "c",
"message": "m"
}],
"referrer": "a referrer",
"read_only": "ro",
"repo": "r",
"repository": "repo",
"repository_public": false,
"run_attempt": 1,
"runner_group_id": 1,
"runner_group_name": "rgn",
"runner_id": 1,
"runner_labels": [
"s"
],
"runner_name": "rn",
"secrets_passed": [
"s"
],
"source_version": "sv",
"started_at": ` + referenceTimeStr + `,
"target_login": "tl",
"target_version": "tv",
"team": "t",
"@timestamp": ` + referenceTimeStr + `,
"token_id": 1,
"token_scopes": "ts",
"topic": "cp1-iad.ingest.github.actions.v0.WorkflowUpdate",
"transport_protocol_name": "tpn",
"transport_protocol": 1,
"trigger_id": 1,
"user": "u",
"user_agent": "ua",
"visibility": "v",
"workflow_id": 1,
"workflow_run_id": 1,
"data": {
"old_name": "on",
"old_login": "ol"
}
}`
testJSONMarshalOnly(t, u, want)
testJSONMarshalOnly(t, &u, want)
}
func TestAuditEntry_UnmarshalJSON(t *testing.T) {
t.Parallel()
testJSONUnmarshalOnly(t, &AuditEntry{}, "{}")
tests := []struct {
name string
payload string
want *AuditEntry
}{
{
name: "org is scalar",
payload: `{"action":"test","org":"myorg","org_id":42}`,
want: &AuditEntry{Action: new("test"), Org: new("myorg"), OrgID: new(int64(42))},
},
{
name: "org is single element array",
payload: `{"action":"test","org":["myorg"],"org_id":[42]}`,
want: &AuditEntry{Action: new("test"), Org: new("myorg"), OrgID: new(int64(42))},
},
{
name: "org is multi-element array",
payload: `{"action":"test","org":["org1","org2","org3"],"org_id":[1,2,3]}`,
want: &AuditEntry{Action: new("test"), Org: new("org1, org2, org3"), OrgID: new(int64(1))},
},
{
name: "org_id is scalar",
payload: `{"action":"test","org_id":42}`,
want: &AuditEntry{Action: new("test"), OrgID: new(int64(42))},
},
{
name: "org_id is array",
payload: `{"action":"test","org_id":[42,43,44]}`,
want: &AuditEntry{Action: new("test"), OrgID: new(int64(42))}, // first element
},
{
name: "org is empty array",
payload: `{"action":"test","org":[]}`,
want: &AuditEntry{Action: new("test"), AdditionalFields: map[string]any{"org": []any{}}},
},
{
name: "org_id is empty array",
payload: `{"action":"test","org_id":[]}`,
want: &AuditEntry{Action: new("test"), AdditionalFields: map[string]any{"org_id": []any{}}},
},
{
name: "org and org_id are null",
payload: `{"action":"test","org":null,"org_id":null}`,
want: &AuditEntry{Action: new("test")},
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
testJSONUnmarshalOnly(t, tc.want, tc.payload)
})
}
}
func TestAuditEntry_UnmarshalJSON_Errors(t *testing.T) {
t.Parallel()
tests := []struct {
name string
payload string
}{
{
name: "malformed json",
payload: `{`,
},
{
name: "invalid defined field type",
payload: `{"actor_id":"not-an-int"}`,
},
{
name: "invalid org type",
payload: `{"action":"test","org":{"key":"value"}}`,
},
{
name: "invalid org_id type",
payload: `{"action":"test","org_id":{"key":"value"}}`,
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
var entry AuditEntry
if err := json.Unmarshal([]byte(tc.payload), &entry); err == nil {
t.Errorf("AuditEntry.UnmarshalJSON(%q) = nil, but want error", tc.payload)
}
})
}
}
View Git Blame Copy Permalink