Merge pull request #291 from senjucanon2/master

Added support for branch names containing '&' and '#' for GetFile Operations.

Author: mohitg0795

scm/driver/azure/content.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"encoding/base64"
 	"fmt"
+	"net/url"
 
 	"github.com/drone/go-scm/scm"
 )
@@ -21,8 +22,9 @@ func (s *contentService) Find(ctx context.Context, repo, path, ref string) (*scm
 	if s.client.project == "" {
 		return nil, nil, ProjectRequiredError()
 	}
+	urlEncodedRef := url.QueryEscape(ref)
 	endpoint := fmt.Sprintf("%s/%s/_apis/git/repositories/%s/items?path=%s&includeContent=true&$format=json", s.client.owner, s.client.project, repo, path)
-	endpoint += generateURIFromRef(ref)
+	endpoint += generateURIFromRef(urlEncodedRef)
 	endpoint += "&api-version=6.0"
 	out := new(content)
 	res, err := s.client.do(ctx, "GET", endpoint, nil, out)

scm/driver/azure/content_test.go

@@ -17,6 +17,7 @@ func TestContentFind(t *testing.T) {
 	gock.New("https:/dev.azure.com/").
 		Get("/ORG/PROJ/_apis/git/repositories/REPOID/items").
 		MatchParam("path", "README").
+		MatchParam("versionDescriptor.version", "b1&b2").
 		Reply(200).
 		Type("application/json").
 		File("testdata/content.json")
@@ -26,7 +27,7 @@ func TestContentFind(t *testing.T) {
 		context.Background(),
 		"REPOID",
 		"README",
-		"",
+		"b1&b2",
 	)
 	if err != nil {
 		t.Error(err)

scm/driver/bitbucket/content.go

@@ -8,6 +8,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"net/url"
 
 	"github.com/drone/go-scm/scm"
 )
@@ -17,7 +18,8 @@ type contentService struct {
 }
 
 func (s *contentService) Find(ctx context.Context, repo, path, ref string) (*scm.Content, *scm.Response, error) {
-	endpoint := fmt.Sprintf("/2.0/repositories/%s/src/%s/%s", repo, ref, path)
+	urlEncodedRef := url.QueryEscape(ref)
+	endpoint := fmt.Sprintf("/2.0/repositories/%s/src/%s/%s", repo, urlEncodedRef, path)
 	out := new(bytes.Buffer)
 	res, err := s.client.do(ctx, "GET", endpoint, nil, out)
 	content := &scm.Content{
@@ -27,7 +29,7 @@ func (s *contentService) Find(ctx context.Context, repo, path, ref string) (*scm
 	if err != nil {
 		return content, res, err
 	}
-	metaEndpoint := fmt.Sprintf("/2.0/repositories/%s/src/%s/%s?format=meta", repo, ref, path)
+	metaEndpoint := fmt.Sprintf("/2.0/repositories/%s/src/%s/%s?format=meta", repo, urlEncodedRef, path)
 	metaOut := new(metaContent)
 	metaRes, metaErr := s.client.do(ctx, "GET", metaEndpoint, nil, metaOut)
 	if metaErr == nil {

scm/driver/github/content.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"encoding/base64"
 	"fmt"
+	"net/url"
 
 	"github.com/drone/go-scm/scm"
 )
@@ -17,7 +18,8 @@ type contentService struct {
 }
 
 func (s *contentService) Find(ctx context.Context, repo, path, ref string) (*scm.Content, *scm.Response, error) {
-	endpoint := fmt.Sprintf("repos/%s/contents/%s?ref=%s", repo, path, ref)
+	urlEncodedRef := url.QueryEscape(ref)
+	endpoint := fmt.Sprintf("repos/%s/contents/%s?ref=%s", repo, path, urlEncodedRef)
 	out := new(content)
 	res, err := s.client.do(ctx, "GET", endpoint, nil, out)
 	raw, _ := base64.StdEncoding.DecodeString(out.Content)

scm/driver/github/content_test.go

@@ -47,6 +47,35 @@ func TestContentFind(t *testing.T) {
 		t.Log(diff)
 	}
 
+	gock.New("https://api.github.com").
+		Get("/repos/octocat/hello-world/contents/README").
+		MatchParam("ref", "b1&b2").
+		Reply(200).
+		Type("application/json").
+		SetHeaders(mockHeaders).
+		File("testdata/content.json")
+
+	client = NewDefault()
+	got, res, err = client.Contents.Find(
+		context.Background(),
+		"octocat/hello-world",
+		"README",
+		"b1&b2",
+	)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	want = new(scm.Content)
+	raw, _ = ioutil.ReadFile("testdata/content.json.golden")
+	_ = json.Unmarshal(raw, want)
+
+	if diff := cmp.Diff(got, want); diff != "" {
+		t.Errorf("Unexpected Results")
+		t.Log(diff)
+	}
+
 	t.Run("Request", testRequest(res))
 	t.Run("Rate", testRate(res))
 }

scm/driver/gitlab/content.go

@@ -19,7 +19,8 @@ type contentService struct {
 }
 
 func (s *contentService) Find(ctx context.Context, repo, path, ref string) (*scm.Content, *scm.Response, error) {
-	endpoint := fmt.Sprintf("api/v4/projects/%s/repository/files/%s?ref=%s", encode(repo), encodePath(path), ref)
+	urlEncodedRef := url.QueryEscape(ref)
+	endpoint := fmt.Sprintf("api/v4/projects/%s/repository/files/%s?ref=%s", encode(repo), encodePath(path), urlEncodedRef)
 	out := new(content)
 	res, err := s.client.do(ctx, "GET", endpoint, nil, out)
 	raw, berr := base64.StdEncoding.DecodeString(out.Content)

scm/driver/gitlab/content_test.go

@@ -48,6 +48,35 @@ func TestContentFind(t *testing.T) {
 		t.Log(diff)
 	}
 
+	gock.New("https://gitlab.com").
+		Get("/api/v4/projects/diaspora/diaspora/repository/files/app/models/key.rb").
+		MatchParam("ref", "b1&b2").
+		Reply(200).
+		Type("application/json").
+		SetHeaders(mockHeaders).
+		File("testdata/content.json")
+
+	client = NewDefault()
+	got, res, err = client.Contents.Find(
+		context.Background(),
+		"diaspora/diaspora",
+		"app/models/key.rb",
+		"b1&b2",
+	)
+	if err != nil {
+		t.Error(err)
+		return
+	}
+
+	want = new(scm.Content)
+	raw, _ = ioutil.ReadFile("testdata/content.json.golden")
+	json.Unmarshal(raw, want)
+
+	if diff := cmp.Diff(got, want); diff != "" {
+		t.Errorf("Unexpected Results")
+		t.Log(diff)
+	}
+
 	t.Run("Request", testRequest(res))
 	t.Run("Rate", testRate(res))
 }

scm/driver/stash/content.go

@@ -8,6 +8,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"net/url"
 
 	"github.com/drone/go-scm/scm"
 )
@@ -17,8 +18,9 @@ type contentService struct {
 }
 
 func (s *contentService) Find(ctx context.Context, repo, path, ref string) (*scm.Content, *scm.Response, error) {
+	urlEncodedRef := url.QueryEscape(ref)
 	namespace, name := scm.Split(repo)
-	endpoint := fmt.Sprintf("rest/api/1.0/projects/%s/repos/%s/raw/%s?at=%s", namespace, name, path, ref)
+	endpoint := fmt.Sprintf("rest/api/1.0/projects/%s/repos/%s/raw/%s?at=%s", namespace, name, path, urlEncodedRef)
 	out := new(bytes.Buffer)
 	res, err := s.client.do(ctx, "GET", endpoint, nil, out)
 	return &scm.Content{

scm/driver/stash/content_test.go

@@ -40,6 +40,28 @@ func TestContentFind(t *testing.T) {
 		t.Errorf("Unexpected Results")
 		t.Log(diff)
 	}
+
+	gock.New("http://example.com:7990").
+		Get("/rest/api/1.0/projects/PRJ/repos/my-repo/raw/README").
+		MatchParam("at", "b1&b2").
+		Reply(200).
+		Type("text/plain").
+		File("testdata/content.txt")
+
+	client, _ = New("http://example.com:7990")
+	got, _, err = client.Contents.Find(context.Background(), "PRJ/my-repo", "README", "b1&b2")
+	if err != nil {
+		t.Error(err)
+	}
+
+	want = new(scm.Content)
+	raw, _ = ioutil.ReadFile("testdata/content.json.golden")
+	_ = json.Unmarshal(raw, want)
+
+	if diff := cmp.Diff(got, want); diff != "" {
+		t.Errorf("Unexpected Results")
+		t.Log(diff)
+	}
 }
 
 func TestContentCreate(t *testing.T) {