From 6a6bed849ab8cf3f722df98498124ad872ce3827 Mon Sep 17 00:00:00 2001 From: Nilesh Singh Date: Sat, 3 Oct 2020 04:55:44 +0530 Subject: [PATCH 1/2] switch to mediaTypeV3 for ChecksRun Accept header --- github/checks.go | 22 +++++++++++----------- github/checks_test.go | 22 +++++++++++----------- github/github.go | 3 --- 3 files changed, 22 insertions(+), 25 deletions(-) diff --git a/github/checks.go b/github/checks.go index 3bdbc5c7e62..96f23717481 100644 --- a/github/checks.go +++ b/github/checks.go @@ -104,7 +104,7 @@ func (s *ChecksService) GetCheckRun(ctx context.Context, owner, repo string, che return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) checkRun := new(CheckRun) resp, err := s.client.Do(ctx, req, checkRun) @@ -125,7 +125,7 @@ func (s *ChecksService) GetCheckSuite(ctx context.Context, owner, repo string, c return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) checkSuite := new(CheckSuite) resp, err := s.client.Do(ctx, req, checkSuite) @@ -167,7 +167,7 @@ func (s *ChecksService) CreateCheckRun(ctx context.Context, owner, repo string, return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) checkRun := new(CheckRun) resp, err := s.client.Do(ctx, req, checkRun) @@ -201,7 +201,7 @@ func (s *ChecksService) UpdateCheckRun(ctx context.Context, owner, repo string, return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) checkRun := new(CheckRun) resp, err := s.client.Do(ctx, req, checkRun) @@ -227,7 +227,7 @@ func (s *ChecksService) ListCheckRunAnnotations(ctx context.Context, owner, repo return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) var checkRunAnnotations []*CheckRunAnnotation resp, err := s.client.Do(ctx, req, &checkRunAnnotations) @@ -268,7 +268,7 @@ func (s *ChecksService) ListCheckRunsForRef(ctx context.Context, owner, repo, re return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) var checkRunResults *ListCheckRunsResults resp, err := s.client.Do(ctx, req, &checkRunResults) @@ -294,7 +294,7 @@ func (s *ChecksService) ListCheckRunsCheckSuite(ctx context.Context, owner, repo return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) var checkRunResults *ListCheckRunsResults resp, err := s.client.Do(ctx, req, &checkRunResults) @@ -334,7 +334,7 @@ func (s *ChecksService) ListCheckSuitesForRef(ctx context.Context, owner, repo, return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) var checkSuiteResults *ListCheckSuiteResults resp, err := s.client.Do(ctx, req, &checkSuiteResults) @@ -377,7 +377,7 @@ func (s *ChecksService) SetCheckSuitePreferences(ctx context.Context, owner, rep return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) var checkSuitePrefResults *CheckSuitePreferenceResults resp, err := s.client.Do(ctx, req, &checkSuitePrefResults) @@ -404,7 +404,7 @@ func (s *ChecksService) CreateCheckSuite(ctx context.Context, owner, repo string return nil, nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) checkSuite := new(CheckSuite) resp, err := s.client.Do(ctx, req, checkSuite) @@ -426,7 +426,7 @@ func (s *ChecksService) ReRequestCheckSuite(ctx context.Context, owner, repo str return nil, err } - req.Header.Set("Accept", mediaTypeCheckRunsPreview) + req.Header.Set("Accept", mediaTypeV3) resp, err := s.client.Do(ctx, req, nil) return resp, err diff --git a/github/checks_test.go b/github/checks_test.go index e510e32f701..57294f45604 100644 --- a/github/checks_test.go +++ b/github/checks_test.go @@ -20,7 +20,7 @@ func TestChecksService_GetCheckRun(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs/1", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) fmt.Fprint(w, `{ "id": 1, "name":"testCheckRun", @@ -55,7 +55,7 @@ func TestChecksService_GetCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/1", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) fmt.Fprint(w, `{ "id": 1, "head_branch":"master", @@ -89,7 +89,7 @@ func TestChecksService_CreateCheckRun(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "POST") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) fmt.Fprint(w, `{ "id": 1, "name":"testCreateCheckRun", @@ -141,7 +141,7 @@ func TestChecksService_ListCheckRunAnnotations(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs/1/annotations", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) testFormValues(t, r, values{ "page": "1", }) @@ -186,7 +186,7 @@ func TestChecksService_UpdateCheckRun(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs/1", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "PATCH") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) fmt.Fprint(w, `{ "id": 1, "name":"testUpdateCheckRun", @@ -240,7 +240,7 @@ func TestChecksService_ListCheckRunsForRef(t *testing.T) { mux.HandleFunc("/repos/o/r/commits/master/check-runs", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) testFormValues(t, r, values{ "check_name": "testing", "page": "1", @@ -292,7 +292,7 @@ func TestChecksService_ListCheckRunsCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/1/check-runs", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) testFormValues(t, r, values{ "check_name": "testing", "page": "1", @@ -344,7 +344,7 @@ func TestChecksService_ListCheckSuiteForRef(t *testing.T) { mux.HandleFunc("/repos/o/r/commits/master/check-suites", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) testFormValues(t, r, values{ "check_name": "testing", "page": "1", @@ -395,7 +395,7 @@ func TestChecksService_SetCheckSuitePreferences(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/preferences", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "PATCH") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) testBody(t, r, `{"auto_trigger_checks":[{"app_id":2,"setting":false}]}`+"\n") fmt.Fprint(w, `{"preferences":{"auto_trigger_checks":[{"app_id": 2,"setting": false}]}}`) }) @@ -427,7 +427,7 @@ func TestChecksService_CreateCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "POST") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) fmt.Fprint(w, `{ "id": 2, "head_branch":"master", @@ -468,7 +468,7 @@ func TestChecksService_ReRequestCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/1/rerequest", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "POST") - testHeader(t, r, "Accept", mediaTypeCheckRunsPreview) + testHeader(t, r, "Accept", mediaTypeV3) w.WriteHeader(http.StatusCreated) }) resp, err := client.Checks.ReRequestCheckSuite(context.Background(), "o", "r", 1) diff --git a/github/github.go b/github/github.go index c2bb4e71fcd..f314b6953ac 100644 --- a/github/github.go +++ b/github/github.go @@ -86,9 +86,6 @@ const ( // https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews/ mediaTypeRequiredApprovingReviewsPreview = "application/vnd.github.luke-cage-preview+json" - // https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/ - mediaTypeCheckRunsPreview = "application/vnd.github.antiope-preview+json" - // https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/ mediaTypePreReceiveHooksPreview = "application/vnd.github.eye-scream-preview" From 25b4fbc0d0a8778d9c089701defec7aa42a14b8b Mon Sep 17 00:00:00 2001 From: Nilesh Singh Date: Sat, 3 Oct 2020 14:03:12 +0530 Subject: [PATCH 2/2] Remove graduated GitHub v3 API preview header --- github/checks.go | 22 ---------------------- github/checks_test.go | 22 +++++++++++----------- 2 files changed, 11 insertions(+), 33 deletions(-) diff --git a/github/checks.go b/github/checks.go index 96f23717481..c8262be3822 100644 --- a/github/checks.go +++ b/github/checks.go @@ -104,8 +104,6 @@ func (s *ChecksService) GetCheckRun(ctx context.Context, owner, repo string, che return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - checkRun := new(CheckRun) resp, err := s.client.Do(ctx, req, checkRun) if err != nil { @@ -125,8 +123,6 @@ func (s *ChecksService) GetCheckSuite(ctx context.Context, owner, repo string, c return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - checkSuite := new(CheckSuite) resp, err := s.client.Do(ctx, req, checkSuite) if err != nil { @@ -167,8 +163,6 @@ func (s *ChecksService) CreateCheckRun(ctx context.Context, owner, repo string, return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - checkRun := new(CheckRun) resp, err := s.client.Do(ctx, req, checkRun) if err != nil { @@ -201,8 +195,6 @@ func (s *ChecksService) UpdateCheckRun(ctx context.Context, owner, repo string, return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - checkRun := new(CheckRun) resp, err := s.client.Do(ctx, req, checkRun) if err != nil { @@ -227,8 +219,6 @@ func (s *ChecksService) ListCheckRunAnnotations(ctx context.Context, owner, repo return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - var checkRunAnnotations []*CheckRunAnnotation resp, err := s.client.Do(ctx, req, &checkRunAnnotations) if err != nil { @@ -268,8 +258,6 @@ func (s *ChecksService) ListCheckRunsForRef(ctx context.Context, owner, repo, re return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - var checkRunResults *ListCheckRunsResults resp, err := s.client.Do(ctx, req, &checkRunResults) if err != nil { @@ -294,8 +282,6 @@ func (s *ChecksService) ListCheckRunsCheckSuite(ctx context.Context, owner, repo return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - var checkRunResults *ListCheckRunsResults resp, err := s.client.Do(ctx, req, &checkRunResults) if err != nil { @@ -334,8 +320,6 @@ func (s *ChecksService) ListCheckSuitesForRef(ctx context.Context, owner, repo, return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - var checkSuiteResults *ListCheckSuiteResults resp, err := s.client.Do(ctx, req, &checkSuiteResults) if err != nil { @@ -377,8 +361,6 @@ func (s *ChecksService) SetCheckSuitePreferences(ctx context.Context, owner, rep return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - var checkSuitePrefResults *CheckSuitePreferenceResults resp, err := s.client.Do(ctx, req, &checkSuitePrefResults) if err != nil { @@ -404,8 +386,6 @@ func (s *ChecksService) CreateCheckSuite(ctx context.Context, owner, repo string return nil, nil, err } - req.Header.Set("Accept", mediaTypeV3) - checkSuite := new(CheckSuite) resp, err := s.client.Do(ctx, req, checkSuite) if err != nil { @@ -426,8 +406,6 @@ func (s *ChecksService) ReRequestCheckSuite(ctx context.Context, owner, repo str return nil, err } - req.Header.Set("Accept", mediaTypeV3) - resp, err := s.client.Do(ctx, req, nil) return resp, err } diff --git a/github/checks_test.go b/github/checks_test.go index 57294f45604..d51a86f4595 100644 --- a/github/checks_test.go +++ b/github/checks_test.go @@ -20,7 +20,7 @@ func TestChecksService_GetCheckRun(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs/1", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeV3) + fmt.Fprint(w, `{ "id": 1, "name":"testCheckRun", @@ -55,7 +55,7 @@ func TestChecksService_GetCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/1", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeV3) + fmt.Fprint(w, `{ "id": 1, "head_branch":"master", @@ -89,7 +89,7 @@ func TestChecksService_CreateCheckRun(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "POST") - testHeader(t, r, "Accept", mediaTypeV3) + fmt.Fprint(w, `{ "id": 1, "name":"testCreateCheckRun", @@ -141,7 +141,7 @@ func TestChecksService_ListCheckRunAnnotations(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs/1/annotations", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeV3) + testFormValues(t, r, values{ "page": "1", }) @@ -186,7 +186,7 @@ func TestChecksService_UpdateCheckRun(t *testing.T) { mux.HandleFunc("/repos/o/r/check-runs/1", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "PATCH") - testHeader(t, r, "Accept", mediaTypeV3) + fmt.Fprint(w, `{ "id": 1, "name":"testUpdateCheckRun", @@ -240,7 +240,7 @@ func TestChecksService_ListCheckRunsForRef(t *testing.T) { mux.HandleFunc("/repos/o/r/commits/master/check-runs", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeV3) + testFormValues(t, r, values{ "check_name": "testing", "page": "1", @@ -292,7 +292,7 @@ func TestChecksService_ListCheckRunsCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/1/check-runs", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeV3) + testFormValues(t, r, values{ "check_name": "testing", "page": "1", @@ -344,7 +344,7 @@ func TestChecksService_ListCheckSuiteForRef(t *testing.T) { mux.HandleFunc("/repos/o/r/commits/master/check-suites", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testHeader(t, r, "Accept", mediaTypeV3) + testFormValues(t, r, values{ "check_name": "testing", "page": "1", @@ -395,7 +395,7 @@ func TestChecksService_SetCheckSuitePreferences(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/preferences", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "PATCH") - testHeader(t, r, "Accept", mediaTypeV3) + testBody(t, r, `{"auto_trigger_checks":[{"app_id":2,"setting":false}]}`+"\n") fmt.Fprint(w, `{"preferences":{"auto_trigger_checks":[{"app_id": 2,"setting": false}]}}`) }) @@ -427,7 +427,7 @@ func TestChecksService_CreateCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "POST") - testHeader(t, r, "Accept", mediaTypeV3) + fmt.Fprint(w, `{ "id": 2, "head_branch":"master", @@ -468,7 +468,7 @@ func TestChecksService_ReRequestCheckSuite(t *testing.T) { mux.HandleFunc("/repos/o/r/check-suites/1/rerequest", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "POST") - testHeader(t, r, "Accept", mediaTypeV3) + w.WriteHeader(http.StatusCreated) }) resp, err := client.Checks.ReRequestCheckSuite(context.Background(), "o", "r", 1)