add initial support for environments (#120)

Currently only supports listing, creating, getting, and deleting
environments.  Updating existing environments is also possible but
unfortunately the existing API documentation for the update endpoint is
incomplete, so I'm skipping it for now.

Documented at: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/environments

Signed-off-by: Kent R. Spillner <[email protected]>

Author: sl4mmy

bitbucket.go

@@ -43,6 +43,10 @@ type repository interface {
 	GetFileBlob(opt RepositoryBlobOptions) (*RepositoryBlob, error)
 	ListBranches(opt RepositoryBranchOptions) (*RepositoryBranches, error)
 	BranchingModel(opt RepositoryBranchingModelOptions) (*BranchingModel, error)
+	ListEnvironments(opt RepositoryEnvironmentsOptions) (*Environments, error)
+	AddEnvironment(opt RepositoryEnvironmentOptions) (*Environment, error)
+	DeleteEnvironment(opt RepositoryEnvironmentDeleteOptions) (interface{}, error)
+	GetEnvironment(opt RepositoryEnvironmentOptions) (*Environment, error)
 }
 
 type repositories interface {
@@ -320,3 +324,35 @@ type PipelinesOptions struct {
 	IDOrUuid string `json:"ID"`
 	StepUuid string `json:"StepUUID"`
 }
+
+type RepositoryEnvironmentsOptions struct {
+	Owner    string `json:"owner"`
+	RepoSlug string `json:"repo_slug"`
+}
+
+type RepositoryEnvironmentTypeOption int
+
+const (
+	Test RepositoryEnvironmentTypeOption = iota
+	Staging
+	Production
+)
+
+func (e RepositoryEnvironmentTypeOption) String() string {
+	return [...]string{"Test", "Staging", "Production"}[e]
+}
+
+type RepositoryEnvironmentOptions struct {
+	Owner           string `json:"owner"`
+	RepoSlug        string `json:"repo_slug"`
+	Uuid            string `json:"uuid"`
+	Name            string `json:"name"`
+	EnvironmentType RepositoryEnvironmentTypeOption `json:"environment_type"`
+	Rank            int `json:"rank"`
+}
+
+type RepositoryEnvironmentDeleteOptions struct {
+	Owner    string `json:"owner"`
+	RepoSlug string `json:"repo_slug"`
+	Uuid     string `json:"uuid"`
+}

repository.go

@@ -3,6 +3,7 @@ package bitbucket
 import (
 	"encoding/json"
 	"errors"
+	"fmt"
 	"io/ioutil"
 	"net/url"
 	"os"
@@ -141,6 +142,29 @@ type BranchModel struct {
 	Use_Mainbranch bool
 }
 
+type Environments struct {
+	Page         int
+	Pagelen      int
+	MaxDepth     int
+	Size         int
+	Next         string
+	Environments []Environment
+}
+
+type EnvironmentType struct {
+	Name string
+	Rank int
+	Type string
+}
+
+type Environment struct {
+	Uuid            string
+	Name            string
+	EnvironmentType EnvironmentType
+	Rank            int
+	Type            string
+}
+
 func (r *Repository) Create(ro *RepositoryOptions) (*Repository, error) {
 	data := r.buildRepositoryBody(ro)
 	urlStr := r.c.requestUrl("/repositories/%s/%s", ro.Owner, ro.RepoSlug)
@@ -426,15 +450,46 @@ func (r *Repository) BranchingModel(rbmo *RepositoryBranchingModelOptions) (*Bra
 	return decodeBranchingModel(response)
 }
 
-func (r *Repository) buildJsonBody(body map[string]interface{}) string {
+func (r *Repository) ListEnvironments(opt *RepositoryEnvironmentsOptions) (*Environments, error) {
+	urlStr := r.c.requestUrl("/repositories/%s/%s/environments/", opt.Owner, opt.RepoSlug)
+	res, err := r.c.executeRaw("GET", urlStr, "")
+	if err != nil {
+		return nil, err
+	}
 
-	data, err := json.Marshal(body)
+	bodyBytes, err := ioutil.ReadAll(res)
 	if err != nil {
-		pp.Println(err)
-		os.Exit(9)
+		return nil, err
 	}
 
-	return string(data)
+	bodyString := string(bodyBytes)
+	return decodeEnvironments(bodyString)
+}
+
+func (r *Repository) AddEnvironment(opt *RepositoryEnvironmentOptions) (*Environment, error) {
+	body := r.buildEnvironmentBody(opt)
+	urlStr := r.c.requestUrl("/repositories/%s/%s/environments/", opt.Owner, opt.RepoSlug)
+	res, err := r.c.execute("POST", urlStr, body)
+	if err != nil {
+		return nil, err
+	}
+
+	return decodeEnvironment(res)
+}
+
+func (r *Repository) DeleteEnvironment(opt *RepositoryEnvironmentDeleteOptions) (interface{}, error) {
+	urlStr := r.c.requestUrl("/repositories/%s/%s/environments/%s", opt.Owner, opt.RepoSlug, opt.Uuid)
+	return r.c.execute("DELETE", urlStr, "")
+}
+
+func (r *Repository) GetEnvironment(opt *RepositoryEnvironmentOptions) (*Environment, error) {
+	urlStr := r.c.requestUrl("/repositories/%s/%s/environments/%s", opt.Owner, opt.RepoSlug, opt.Uuid)
+	res, err := r.c.execute("GET", urlStr, "")
+	if err != nil {
+		return nil, err
+	}
+
+	return decodeEnvironment(res)
 }
 
 func (r *Repository) buildRepositoryBody(ro *RepositoryOptions) string {
@@ -570,6 +625,34 @@ func (r *Repository) buildTagBody(rbo *RepositoryTagCreationOptions) string {
 	return r.buildJsonBody(body)
 }
 
+func (r *Repository) buildEnvironmentBody(opt *RepositoryEnvironmentOptions) string {
+	body := map[string]interface{}{}
+
+	body["environment_type"] = map[string]interface{}{
+		"name": opt.EnvironmentType.String(),
+		"rank": opt.Rank,
+		"type": "deployment_environment_type",
+	}
+	if opt.Uuid != "" {
+		body["uuid"] = opt.Uuid
+	}
+	body["name"] = opt.Name
+	body["rank"] = opt.Rank
+
+	return r.buildJsonBody(body)
+}
+
+func (r *Repository) buildJsonBody(body map[string]interface{}) string {
+
+	data, err := json.Marshal(body)
+	if err != nil {
+		pp.Println(err)
+		os.Exit(9)
+	}
+
+	return string(data)
+}
+
 func decodeRepository(repoResponse interface{}) (*Repository, error) {
 	repoMap := repoResponse.(map[string]interface{})
 
@@ -862,6 +945,83 @@ func decodeBranchingModel(branchingModelResponse interface{}) (*BranchingModel,
 	return branchingModel, nil
 }
 
+func decodeEnvironments(response string) (*Environments, error) {
+	var responseMap map[string]interface{}
+	err := json.Unmarshal([]byte(response), &responseMap)
+	if err != nil {
+		return nil, err
+	}
+
+	values := responseMap["values"].([]interface{})
+	var environmentsArray []Environment
+	var errs error = nil
+	for idx, value := range values {
+		var environment Environment
+		err = mapstructure.Decode(value, &environment)
+		if err != nil {
+			if errs == nil {
+				errs = err
+			} else {
+				errs = fmt.Errorf("%w; environment %d: %w", errs, idx, err)
+			}
+		} else {
+			environmentsArray = append(environmentsArray, environment)
+		}
+	}
+
+	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 = ""
+	}
+
+	environments := Environments{
+		Page:         int(page),
+		Pagelen:      int(pagelen),
+		MaxDepth:     int(max_depth),
+		Size:         int(size),
+		Next:         next,
+		Environments: environmentsArray,
+	}
+
+	return &environments, nil
+}
+
+func decodeEnvironment(response interface{}) (*Environment, error) {
+	responseMap := response.(map[string]interface{})
+
+	if responseMap["type"] == "error" {
+		return nil, DecodeError(responseMap)
+	}
+
+	var environment = new(Environment)
+	err := mapstructure.Decode(responseMap, &environment)
+	if err != nil {
+		return nil, err
+	}
+
+	return environment, nil
+}
+
 func (rf RepositoryFile) String() string {
 	return rf.Path
 }

tests/environment_test.go

@@ -0,0 +1,109 @@
+package tests
+
+import (
+	"os"
+	"testing"
+
+	_ "github.com/k0kubun/pp"
+	"github.com/ktrysmt/go-bitbucket"
+)
+
+func TestListEnvironments(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.RepositoryEnvironmentsOptions{
+		Owner:    owner,
+		RepoSlug: repo,
+	}
+
+	res, err := c.Repositories.Repository.ListEnvironments(opt)
+	if err != nil {
+		t.Error(err)
+	}
+
+	if res == nil {
+		t.Error("list didn't return any environments")
+	}
+}
+
+func TestEndToEndEnvironments(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.RepositoryEnvironmentOptions{
+		Owner:           owner,
+		RepoSlug:        repo,
+		Name:            "foo",
+		EnvironmentType: bitbucket.Test,
+	}
+
+	environment, err := c.Repositories.Repository.AddEnvironment(opt)
+	if err != nil {
+		t.Error(err)
+	}
+
+	if environment.Uuid == "" {
+		t.Error("new environment does not have a UUID")
+	}
+
+	opt.Name = ""
+	opt.Uuid = environment.Uuid
+
+	foundEnvironment, err := c.Repositories.Repository.GetEnvironment(opt)
+	if err != nil {
+		t.Error(err)
+	}
+
+	if foundEnvironment.Name != "foo" {
+		t.Errorf("got environment with wrong name: %s", foundEnvironment.Name)
+	}
+
+	deleteOpt := &bitbucket.RepositoryEnvironmentDeleteOptions{
+		Owner:    owner,
+		RepoSlug: repo,
+		Uuid:     environment.Uuid,
+	}
+
+	// On success the delete API doesn't return any content (HTTP status 204)
+	_, err = c.Repositories.Repository.DeleteEnvironment(deleteOpt)
+	if err != nil {
+		t.Error(err)
+	}
+}