add support for listing pipeline variables (#117)

Based on existing support for listing repository tags.

Signed-off-by: Kent R. Spillner <kspillner@acm.org>

Author: sl4mmy

bitbucket.go

@@ -34,6 +34,7 @@ type repository interface {
 	ListForks(opt RepositoryOptions) (interface{}, error)
 	ListDefaultReviewers(opt RepositoryOptions) (interface{}, error)
 	UpdatePipelineConfig(opt RepositoryPipelineOptions) (*Pipeline, error)
+	ListPipelineVariables(opt RepositoryPipelineVariablesOptions) (*PipelineVariables, error)
 	AddPipelineVariable(opt RepositoryPipelineVariableOptions) (*PipelineVariable, error)
 	AddPipelineKeyPair(opt RepositoryPipelineKeyPairOptions) (*PipelineKeyPair, error)
 	UpdatePipelineBuildNumber(opt RepositoryPipelineBuildNumberOptions) (*PipelineBuildNumber, error)
@@ -252,6 +253,16 @@ type RepositoryPipelineOptions struct {
 	Enabled  bool   `json:"has_pipelines"`
 }
 
+type RepositoryPipelineVariablesOptions struct {
+	Owner    string `json:"owner"`
+	RepoSlug string `json:"repo_slug"`
+	Query    string `json:"q"`
+	Sort     string `json:"sort"`
+	PageNum  int    `json:"page"`
+	Pagelen  int    `json:"pagelen"`
+	MaxDepth int    `json:"max_depth"`
+}
+
 type RepositoryPipelineVariableOptions struct {
 	Owner    string `json:"owner"`
 	RepoSlug string `json:"repo_slug"`

repository.go

@@ -94,6 +94,15 @@ type Pipeline struct {
 	Repository Repository
 }
 
+type PipelineVariables struct {
+	Page      int
+	Pagelen   int
+	MaxDepth  int
+	Size      int
+	Next      string
+	Variables []PipelineVariable
+}
+
 type PipelineVariable struct {
 	Type    string
 	Uuid    string
@@ -331,6 +340,42 @@ func (r *Repository) UpdatePipelineConfig(rpo *RepositoryPipelineOptions) (*Pipe
 	return decodePipelineRepository(response)
 }
 
+func (r *Repository) ListPipelineVariables(opt *RepositoryPipelineVariablesOptions) (*PipelineVariables, error) {
+
+	params := url.Values{}
+	if opt.Query != "" {
+		params.Add("q", opt.Query)
+	}
+
+	if opt.Sort != "" {
+		params.Add("sort", opt.Sort)
+	}
+
+	if opt.PageNum > 0 {
+		params.Add("page", strconv.Itoa(opt.PageNum))
+	}
+
+	if opt.Pagelen > 0 {
+		params.Add("pagelen", strconv.Itoa(opt.Pagelen))
+	}
+
+	if opt.MaxDepth > 0 {
+		params.Add("max_depth", strconv.Itoa(opt.MaxDepth))
+	}
+
+	urlStr := r.c.requestUrl("/repositories/%s/%s/pipelines_config/variables/?%s", opt.Owner, opt.RepoSlug, params.Encode())
+	response, err := r.c.executeRaw("GET", urlStr, "")
+	if err != nil {
+		return nil, err
+	}
+	bodyBytes, err := ioutil.ReadAll(response)
+	if err != nil {
+		return nil, err
+	}
+	bodyString := string(bodyBytes)
+	return decodePipelineVariables(bodyString)
+}
+
 func (r *Repository) AddPipelineVariable(rpvo *RepositoryPipelineVariableOptions) (*PipelineVariable, error) {
 	data := r.buildPipelineVariableBody(rpvo)
 	urlStr := r.c.requestUrl("/repositories/%s/%s/pipelines_config/variables/", rpvo.Owner, rpvo.RepoSlug)
@@ -696,6 +741,58 @@ func decodePipelineRepository(repoResponse interface{}) (*Pipeline, error) {
 	return pipeline, nil
 }
 
+func decodePipelineVariables(responseStr string) (*PipelineVariables, error) {
+
+	var responseMap map[string]interface{}
+	err := json.Unmarshal([]byte(responseStr), &responseMap)
+	if err != nil {
+		return nil, err
+	}
+
+	values := responseMap["values"].([]interface{})
+	var variables []PipelineVariable
+	for _, variable := range values {
+		var pipelineVariable PipelineVariable
+		err = mapstructure.Decode(variable, &pipelineVariable)
+		if err == nil {
+			variables = append(variables, pipelineVariable)
+		}
+	}
+
+	page, ok := responseMap["page"].(float64)
+	if !ok {
+		page = 0
+	}
+
+	pagelen, ok := responseMap["pagelen"].(float64)
+	if !ok {
+		pagelen = 0
+	}
+	max_depth, ok := responseMap["max_depth"].(float64)
+	if !ok {
+		max_depth = 0
+	}
+	size, ok := responseMap["size"].(float64)
+	if !ok {
+		size = 0
+	}
+
+	next, ok := responseMap["next"].(string)
+	if !ok {
+		next = ""
+	}
+
+	pipelineVariables := PipelineVariables{
+		Page:      int(page),
+		Pagelen:   int(pagelen),
+		MaxDepth:  int(max_depth),
+		Size:      int(size),
+		Next:      next,
+		Variables: variables,
+	}
+	return &pipelineVariables, nil
+}
+
 func decodePipelineVariableRepository(repoResponse interface{}) (*PipelineVariable, error) {
 	repoMap := repoResponse.(map[string]interface{})
 

tests/repository_test.go

@@ -44,3 +44,40 @@ func TestGetRepositoryRepositories(t *testing.T) {
 		t.Error("Cannot catch repos full name.")
 	}
 }
+
+func TestGetRepositoryPipelineVariables(t *testing.T) {
+
+	user := os.Getenv("BITBUCKET_TEST_USERNAME")
+	pass := os.Getenv("BITBUCKET_TEST_PASSWORD")
+	owner := os.Getenv("BITBUCKET_TEST_OWNER")
+	repo := os.Getenv("BITBUCKET_TEST_REPOSLUG")
+
+	if user == "" {
+		t.Error("BITBUCKET_TEST_USERNAME is empty.")
+	}
+	if pass == "" {
+		t.Error("BITBUCKET_TEST_PASSWORD is empty.")
+	}
+	if owner == "" {
+		t.Error("BITBUCKET_TEST_OWNER is empty.")
+	}
+	if repo == "" {
+		t.Error("BITBUCKET_TEST_REPOSLUG is empty.")
+	}
+
+	c := bitbucket.NewBasicAuth(user, pass)
+
+	opt := &bitbucket.RepositoryPipelineVariablesOptions{
+		Owner:    owner,
+		RepoSlug: repo,
+	}
+
+	res, err := c.Repositories.Repository.ListPipelineVariables(opt)
+	if err != nil {
+		t.Error(err)
+	}
+
+	if res == nil {
+		t.Error("Cannot list pipeline variables")
+	}
+}