orgs_audit_log_test.go

// 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 (
	"context"
	"fmt"
	"net/http"
	"strings"
	"testing"
	"time"

	"github.com/google/go-cmp/cmp"
)

func TestOrganizationService_GetAuditLog(t *testing.T) {
	client, mux, _, teardown := setup()
	defer teardown()

	mux.HandleFunc("/orgs/o/audit-log", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, "GET")

		fmt.Fprint(w, `[
		{
		"actor_ip": "10.0.0.1",
		"actor_location": {
			"country_code": "US"
		},
        "active": true,
        "workflow_id": 123456,
        "head_branch": "master",
        "org": "o",
        "trigger_id": null,
        "repo": "o/blue-crayon-1",
        "created_at": 1615077308538,
		"hashed_token": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
        "head_sha": "5acdeadbeef64d1a62388e901e5cdc9358644b37",
        "conclusion": "success",
        "old_permission": "read",
        "permission": "admin",
        "actor": "testactor",
        "completed_at": "2021-03-07T00:35:08.000Z",
        "@timestamp": 1615077308538,
        "name": "Code scanning - action",
        "action": "workflows.completed_workflow_run",
        "started_at": "2021-03-07T00:33:04.000Z",
        "event": "schedule",
        "workflow_run_id": 628312345,
        "_document_id": "beeZYapIUe-wKg5-beadb33",
		"run_attempt": 1,
		"run_number": 1,
		"token_id": 1,
		"token_scopes": "gist,repo:read",
		"topic": "cp1-iad.ingest.github.actions.v0.WorkflowUpdate",
		"job_workflow_ref": "testorg/testrepo/.github/workflows/testjob.yml@refs/pull/1/merge",
		"oauth_application_id": 1,
		"org_id": 1,
		"pull_request_id": 1,
		"pull_request_title": "a pr title",
		"pull_request_url": "https://github.com/testorg/testrepo/pull/1",
		"overridden_codes": [
			"review_policy_not_satisfied"
		],
		"reasons": [
			{
				"code": "a code",
				"message": "a message"
			}
		],
		"programmatic_access_type": "GitHub App server-to-server token",
		"user_agent": "a user agent",
        "config": {
            "content_type": "json",
            "insecure_ssl": "0",
            "url": "https://example.com/deadbeef-new-hook"
         },
        "events": ["code_scanning_alert"]
		}]`)
	})
	ctx := context.Background()
	getOpts := GetAuditLogOptions{
		Include: String("all"),
		Phrase:  String("action:workflows"),
		Order:   String("asc"),
	}

	auditEntries, resp, err := client.Organizations.GetAuditLog(ctx, "o", &getOpts)
	if err != nil {
		t.Errorf("Organizations.GetAuditLog returned error: %v", err)
	}
	startedAt, _ := time.Parse(time.RFC3339, "2021-03-07T00:33:04.000Z")
	completedAt, _ := time.Parse(time.RFC3339, "2021-03-07T00:35:08.000Z")
	timestamp := time.Unix(0, 1615077308538*1e6)

	want := []*AuditEntry{
		{
			Timestamp:  &Timestamp{timestamp},
			DocumentID: String("beeZYapIUe-wKg5-beadb33"),
			Action:     String("workflows.completed_workflow_run"),
			Actor:      String("testactor"),
			ActorIP:    String("10.0.0.1"),
			ActorLocation: &ActorLocation{
				CountryCode: String("US"),
			},
			Active:                 Bool(true),
			CompletedAt:            &Timestamp{completedAt},
			Conclusion:             String("success"),
			CreatedAt:              &Timestamp{timestamp},
			Event:                  String("schedule"),
			HashedToken:            String("AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="),
			HeadBranch:             String("master"),
			HeadSHA:                String("5acdeadbeef64d1a62388e901e5cdc9358644b37"),
			JobWorkflowRef:         String("testorg/testrepo/.github/workflows/testjob.yml@refs/pull/1/merge"),
			Name:                   String("Code scanning - action"),
			OAuthApplicationID:     Int64(1),
			OldPermission:          String("read"),
			Org:                    String("o"),
			OrgID:                  Int64(1),
			OverriddenCodes:        []string{"review_policy_not_satisfied"},
			Permission:             String("admin"),
			ProgrammaticAccessType: String("GitHub App server-to-server token"),
			PullRequestID:          Int64(1),
			PullRequestTitle:       String("a pr title"),
			PullRequestURL:         String("https://github.com/testorg/testrepo/pull/1"),
			Reasons: []*PolicyOverrideReason{{
				Code:    String("a code"),
				Message: String("a message"),
			}},
			Repo:          String("o/blue-crayon-1"),
			RunAttempt:    Int64(1),
			RunNumber:     Int64(1),
			StartedAt:     &Timestamp{startedAt},
			TokenID:       Int64(1),
			TokenScopes:   String("gist,repo:read"),
			Topic:         String("cp1-iad.ingest.github.actions.v0.WorkflowUpdate"),
			UserAgent:     String("a user agent"),
			WorkflowID:    Int64(123456),
			WorkflowRunID: Int64(628312345),
			Events:        []string{"code_scanning_alert"},
			Config: &HookConfig{
				ContentType: String("json"),
				InsecureSSL: String("0"),
				URL:         String("https://example.com/deadbeef-new-hook"),
			},
		},
	}

	if !cmp.Equal(auditEntries, want) {
		t.Errorf("Organizations.GetAuditLog return \ngot: %+v,\nwant:%+v", auditEntries, want)
	}

	// assert query string has lower case params
	requestedQuery := resp.Request.URL.RawQuery
	if !strings.Contains(requestedQuery, "phrase") {
		t.Errorf("Organizations.GetAuditLog query string \ngot: %+v,\nwant:%+v", requestedQuery, "phrase")
	}

	const methodName = "GetAuditLog"
	testBadOptions(t, methodName, func() (err error) {
		_, _, err = client.Organizations.GetAuditLog(ctx, "\n", &getOpts)
		return err
	})

	testNewRequestAndDoFailure(t, methodName, client, 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 TestGetAuditLogOptions_Marshal(t *testing.T) {
	testJSONMarshal(t, &GetAuditLogOptions{}, "{}")

	u := &GetAuditLogOptions{
		Phrase:  String("p"),
		Include: String("i"),
		Order:   String("o"),
		ListCursorOptions: ListCursorOptions{
			Page:    "p",
			PerPage: 1,
			After:   "a",
			Before:  "b",
		},
	}

	want := `{
		"phrase": "p",
		"include": "i",
		"order": "o",
		"Page": "p",
		"PerPage": 1,
		"After": "a",
		"Before": "b"
	}`

	testJSONMarshal(t, u, want)
}

func TestHookConfig_Marshal(t *testing.T) {
	testJSONMarshal(t, &HookConfig{}, "{}")

	u := &HookConfig{
		ContentType: String("ct"),
		InsecureSSL: String("ct"),
		URL:         String("url"),
	}

	want := `{
		"content_type": "ct",
		"insecure_ssl": "ct",
		"url": "url"
	}`

	testJSONMarshal(t, u, want)
}

func TestAuditEntry_Marshal(t *testing.T) {
	testJSONMarshal(t, &AuditEntry{}, "{}")

	u := &AuditEntry{
		Action:                 String("a"),
		Active:                 Bool(false),
		ActiveWas:              Bool(false),
		Actor:                  String("ac"),
		ActorIP:                String("aip"),
		ActorLocation:          &ActorLocation{CountryCode: String("alcc")},
		BlockedUser:            String("bu"),
		Business:               String("b"),
		CancelledAt:            &Timestamp{referenceTime},
		CompletedAt:            &Timestamp{referenceTime},
		Conclusion:             String("c"),
		Config:                 &HookConfig{URL: String("s")},
		ConfigWas:              &HookConfig{URL: String("s")},
		ContentType:            String("ct"),
		CreatedAt:              &Timestamp{referenceTime},
		DeployKeyFingerprint:   String("dkf"),
		DocumentID:             String("did"),
		Emoji:                  String("e"),
		EnvironmentName:        String("en"),
		Event:                  String("e"),
		Events:                 []string{"s"},
		EventsWere:             []string{"s"},
		Explanation:            String("e"),
		Fingerprint:            String("f"),
		HashedToken:            String("ht"),
		HeadBranch:             String("hb"),
		HeadSHA:                String("hsha"),
		HookID:                 Int64(1),
		IsHostedRunner:         Bool(false),
		JobName:                String("jn"),
		LimitedAvailability:    Bool(false),
		Message:                String("m"),
		Name:                   String("n"),
		OldName:                String("on"),
		OldPermission:          String("op"),
		OldUser:                String("ou"),
		OpenSSHPublicKey:       String("osshpk"),
		Org:                    String("o"),
		OrgID:                  Int64(1),
		Permission:             String("p"),
		PreviousVisibility:     String("pv"),
		ProgrammaticAccessType: String("pat"),
		PullRequestID:          Int64(1),
		PullRequestTitle:       String("prt"),
		PullRequestURL:         String("pru"),
		Reasons: []*PolicyOverrideReason{{
			Code:    String("c"),
			Message: String("m"),
		}},
		ReadOnly:              String("ro"),
		Repo:                  String("r"),
		Repository:            String("repo"),
		RepositoryPublic:      Bool(false),
		RunAttempt:            Int64(1),
		RunnerGroupID:         Int64(1),
		RunnerGroupName:       String("rgn"),
		RunnerID:              Int64(1),
		RunnerLabels:          []string{"s"},
		RunnerName:            String("rn"),
		SecretsPassed:         []string{"s"},
		SourceVersion:         String("sv"),
		StartedAt:             &Timestamp{referenceTime},
		TargetLogin:           String("tl"),
		TargetVersion:         String("tv"),
		Team:                  String("t"),
		Timestamp:             &Timestamp{referenceTime},
		TokenID:               Int64(1),
		TokenScopes:           String("ts"),
		Topic:                 String("tp"),
		TransportProtocolName: String("tpn"),
		TransportProtocol:     Int(1),
		TriggerID:             Int64(1),
		User:                  String("u"),
		UserAgent:             String("ua"),
		Visibility:            String("v"),
		WorkflowID:            Int64(1),
		WorkflowRunID:         Int64(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": ` + referenceTimeStr + `,
		"completed_at": ` + referenceTimeStr + `,
		"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",
		"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_name": "on",
		"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"
		}],
		"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": "tp",
		"transport_protocol_name": "tpn",
		"transport_protocol": 1,
		"trigger_id": 1,
		"user": "u",
		"user_agent": "ua",
		"visibility": "v",
		"workflow_id": 1,
		"workflow_run_id": 1
	}`

	testJSONMarshal(t, u, want)
}