go-github/github/issues_timeline_test.go

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

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

func TestIssuesService_ListIssueTimeline(t *testing.T) {
	t.Parallel()
	client, mux, _ := setup(t)

	wantAcceptHeaders := []string{mediaTypeTimelinePreview, mediaTypeProjectCardDetailsPreview}
	mux.HandleFunc("/repos/o/r/issues/1/timeline", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, "GET")
		testHeader(t, r, "Accept", strings.Join(wantAcceptHeaders, ", "))
		testFormValues(t, r, values{
			"page":     "1",
			"per_page": "2",
		})
		fmt.Fprint(w, `[{"id":1}]`)
	})

	opt := &ListOptions{Page: 1, PerPage: 2}
	ctx := t.Context()
	events, _, err := client.Issues.ListIssueTimeline(ctx, "o", "r", 1, opt)
	if err != nil {
		t.Errorf("Issues.ListIssueTimeline returned error: %v", err)
	}

	want := []*Timeline{{ID: new(int64(1))}}
	if !cmp.Equal(events, want) {
		t.Errorf("Issues.ListIssueTimeline = %+v, want %+v", events, want)
	}

	const methodName = "ListIssueTimeline"
	testBadOptions(t, methodName, func() (err error) {
		_, _, err = client.Issues.ListIssueTimeline(ctx, "\n", "\n", -1, opt)
		return err
	})

	testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
		got, resp, err := client.Issues.ListIssueTimeline(ctx, "o", "r", 1, opt)
		if got != nil {
			t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
		}
		return resp, err
	})
}

func TestTimeline_ReviewRequests(t *testing.T) {
	t.Parallel()
	client, mux, _ := setup(t)

	mux.HandleFunc("/repos/example-org/example-repo/issues/3/timeline", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, "GET")
		fmt.Fprint(w, `[{
		    "id": 1234567890,
		    "url": "http://example.com/timeline/1",
		    "actor": {
			"login": "actor-user",
			"id": 1
		    },
		    "event": "review_requested",
		    "created_at": "2006-01-02T15:04:05Z",
		    "requested_reviewer": {
			"login": "reviewer-user",
			"id": 2
		    },
		    "review_requester": {
			"login": "requester-user",
			"id": 1
		    }
		},
		{
		    "id": 1234567891,
		    "url": "http://example.com/timeline/2",
		    "actor": {
			"login": "actor-user",
			"id": 1
		    },
		    "event": "review_request_removed",
		    "created_at": "2006-01-02T15:04:05Z",
		    "requested_reviewer": {
			"login": "reviewer-user",
			"id": 2
		    }
		}]`)
	})

	ctx := t.Context()
	events, _, err := client.Issues.ListIssueTimeline(ctx, "example-org", "example-repo", 3, nil)
	if err != nil {
		t.Errorf("Issues.ListIssueTimeline returned error: %v", err)
	}

	want := []*Timeline{
		{
			ID:  new(int64(1234567890)),
			URL: new("http://example.com/timeline/1"),
			Actor: &User{
				Login: new("actor-user"),
				ID:    new(int64(1)),
			},
			Event:     new("review_requested"),
			CreatedAt: &Timestamp{referenceTime},
			Reviewer: &User{
				Login: new("reviewer-user"),
				ID:    new(int64(2)),
			},
			Requester: &User{
				Login: new("requester-user"),
				ID:    new(int64(1)),
			},
		},
		{
			ID:  new(int64(1234567891)),
			URL: new("http://example.com/timeline/2"),
			Actor: &User{
				Login: new("actor-user"),
				ID:    new(int64(1)),
			},
			Event:     new("review_request_removed"),
			CreatedAt: &Timestamp{referenceTime},
			Reviewer: &User{
				Login: new("reviewer-user"),
				ID:    new(int64(2)),
			},
		},
	}

	if !cmp.Equal(events, want) {
		t.Errorf("Issues.ListIssueTimeline review request events = %+v, want %+v", events, want)
		diff := cmp.Diff(events, want)
		t.Errorf("Difference: %v", diff)
	}
}