Skip to content

Escape # in CompareCommits base and head refs #1649

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.

Sign up for GitHub

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

Merged
gmlewis merged 3 commits into from
Nov 27, 2020
Merged

Escape # in CompareCommits base and head refs #1649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d70c5f
Replace # with %23 in CompareCommits
urohit011 Nov 15, 2020
eb6377c
Add test for CompareCommits
urohit011 Nov 20, 2020
ee2258f
Update github/repos_commits.go
urohit011 Nov 24, 2020
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
7 changes: 5 additions & 2 deletions github/repos_commits.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"bytes"
"context"
"fmt"
"net/url"
"time"
)

Expand Down Expand Up @@ -222,9 +223,11 @@ func (s *RepositoriesService) GetCommitSHA1(ctx context.Context, owner, repo, re

// CompareCommits compares a range of commits with each other.
//
// The url query string is escaped before making the request.
//
// GitHub API docs: https://docs.github.com/en/rest/reference/repos/#compare-two-commits
func (s *RepositoriesService) CompareCommits(ctx context.Context, owner, repo string, base, head string) (*CommitsComparison, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/compare/%v...%v", owner, repo, base, head)
func (s *RepositoriesService) CompareCommits(ctx context.Context, owner, repo, base, head string) (*CommitsComparison, *Response, error) {
u := url.QueryEscape(fmt.Sprintf("repos/%v/%v/compare/%v...%v", owner, repo, base, head))

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
Expand Down
186 changes: 103 additions & 83 deletions github/repos_commits_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"context"
"fmt"
"net/http"
"net/url"
"reflect"
"strings"
"testing"
Expand Down Expand Up @@ -305,99 +306,118 @@ func TestRepositoriesService_CompareCommits(t *testing.T) {
client, mux, _, teardown := setup()
defer teardown()

mux.HandleFunc("/repos/o/r/compare/b...h", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprintf(w, `{
"base_commit": {
"sha": "s",
"commit": {
"author": { "name": "n" },
"committer": { "name": "n" },
"message": "m",
"tree": { "sha": "t" }
},
"author": { "login": "l" },
"committer": { "login": "l" },
"parents": [ { "sha": "s" } ]
},
"status": "s",
"ahead_by": 1,
"behind_by": 2,
"total_commits": 1,
"commits": [
{
"sha": "s",
"commit": { "author": { "name": "n" } },
"author": { "login": "l" },
"committer": { "login": "l" },
"parents": [ { "sha": "s" } ]
}
],
"files": [ { "filename": "f" } ],
"html_url": "https://github.com/o/r/compare/b...h",
"permalink_url": "https://github.com/o/r/compare/o:bbcd538c8e72b8c175046e27cc8f907076331401...o:0328041d1152db8ae77652d1618a02e57f745f17",
"diff_url": "https://github.com/o/r/compare/b...h.diff",
"patch_url": "https://github.com/o/r/compare/b...h.patch",
"url": "https://api.github.com/repos/o/r/compare/b...h"
}`)
})
cases := []struct {
name string
b string
h string
}{
{name: "case 1", b: "b", h: "h"},
{name: "case 2", b: "#b#", h: "#h#"},
}

for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
b := url.QueryEscape(c.b)
h := url.QueryEscape(c.h)
Copy link
Copy Markdown
Contributor Author

@urohit011 urohit011 Nov 24, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, acutally I store the escaped value for head and base in h and b and use the variables in the test instead of using literal values.


u := fmt.Sprintf("/repos/o/r/compare/%v...%v", c.b, c.h)

mux.HandleFunc(u, func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
fmt.Fprintf(w, `{
"base_commit": {
"sha": "s",
"commit": {
"author": { "name": "n" },
"committer": { "name": "n" },
"message": "m",
"tree": { "sha": "t" }
},
"author": { "login": "l" },
"committer": { "login": "l" },
"parents": [ { "sha": "s" } ]
},
"status": "s",
"ahead_by": 1,
"behind_by": 2,
"total_commits": 1,
"commits": [
{
"sha": "s",
"commit": { "author": { "name": "n" } },
"author": { "login": "l" },
"committer": { "login": "l" },
"parents": [ { "sha": "s" } ]
}
],
"files": [ { "filename": "f" } ],
"html_url": "https://github.com/o/r/compare/%[1]v...%[2]v",
"permalink_url": "https://github.com/o/r/compare/o:bbcd538c8e72b8c175046e27cc8f907076331401...o:0328041d1152db8ae77652d1618a02e57f745f17",
"diff_url": "https://github.com/o/r/compare/%[1]v...%[2]v.diff",
"patch_url": "https://github.com/o/r/compare/%[1]v...%[2]v.patch",
"url": "https://api.github.com/repos/o/r/compare/%[1]v...%[2]v"
}`, b, h)
})

got, _, err := client.Repositories.CompareCommits(context.Background(), "o", "r", "b", "h")
if err != nil {
t.Errorf("Repositories.CompareCommits returned error: %v", err)
}
got, _, err := client.Repositories.CompareCommits(context.Background(), "o", "r", c.b, c.h)
if err != nil {
t.Errorf("Repositories.CompareCommits returned error: %v", err)
}

want := &CommitsComparison{
BaseCommit: &RepositoryCommit{
SHA: String("s"),
Commit: &Commit{
Author: &CommitAuthor{Name: String("n")},
Committer: &CommitAuthor{Name: String("n")},
Message: String("m"),
Tree: &Tree{SHA: String("t")},
},
Author: &User{Login: String("l")},
Committer: &User{Login: String("l")},
Parents: []*Commit{
{
want := &CommitsComparison{
BaseCommit: &RepositoryCommit{
SHA: String("s"),
Commit: &Commit{
Author: &CommitAuthor{Name: String("n")},
Committer: &CommitAuthor{Name: String("n")},
Message: String("m"),
Tree: &Tree{SHA: String("t")},
},
Author: &User{Login: String("l")},
Committer: &User{Login: String("l")},
Parents: []*Commit{
{
SHA: String("s"),
},
},
},
},
},
Status: String("s"),
AheadBy: Int(1),
BehindBy: Int(2),
TotalCommits: Int(1),
Commits: []*RepositoryCommit{
{
SHA: String("s"),
Commit: &Commit{
Author: &CommitAuthor{Name: String("n")},
},
Author: &User{Login: String("l")},
Committer: &User{Login: String("l")},
Parents: []*Commit{
Status: String("s"),
AheadBy: Int(1),
BehindBy: Int(2),
TotalCommits: Int(1),
Commits: []*RepositoryCommit{
{
SHA: String("s"),
Commit: &Commit{
Author: &CommitAuthor{Name: String("n")},
},
Author: &User{Login: String("l")},
Committer: &User{Login: String("l")},
Parents: []*Commit{
{
SHA: String("s"),
},
},
},
},
},
},
Files: []*CommitFile{
{
Filename: String("f"),
},
},
HTMLURL: String("https://github.com/o/r/compare/b...h"),
PermalinkURL: String("https://github.com/o/r/compare/o:bbcd538c8e72b8c175046e27cc8f907076331401...o:0328041d1152db8ae77652d1618a02e57f745f17"),
DiffURL: String("https://github.com/o/r/compare/b...h.diff"),
PatchURL: String("https://github.com/o/r/compare/b...h.patch"),
URL: String("https://api.github.com/repos/o/r/compare/b...h"),
}
Files: []*CommitFile{
{
Filename: String("f"),
},
},
HTMLURL: String(fmt.Sprintf("https://github.com/o/r/compare/%v...%v", b, h)),
PermalinkURL: String("https://github.com/o/r/compare/o:bbcd538c8e72b8c175046e27cc8f907076331401...o:0328041d1152db8ae77652d1618a02e57f745f17"),
DiffURL: String(fmt.Sprintf("https://github.com/o/r/compare/%v...%v.diff", b, h)),
PatchURL: String(fmt.Sprintf("https://github.com/o/r/compare/%v...%v.patch", b, h)),
URL: String(fmt.Sprintf("https://api.github.com/repos/o/r/compare/%v...%v", b, h)),
}

if !reflect.DeepEqual(got, want) {
t.Errorf("Repositories.CompareCommits returned \n%+v, want \n%+v", got, want)
if !reflect.DeepEqual(got, want) {
t.Errorf("Repositories.CompareCommits returned \n%+v, want \n%+v", got, want)
}
})
}

}

func TestRepositoriesService_CompareCommitsRaw_diff(t *testing.T) {
Expand Down