feat(project) list/add/edit/rm project variables

Author: Stephane Leclercq

README.md

@@ -13,7 +13,8 @@ go-gitlab-client is a simple client written in golang to consume gitlab API.
 	* list projects
 	* get single project
 	* remove project
-
+	* list project variables
+	* add/get/edit/rm project variable
 *	
 	### Repositories [gitlab api doc](http://doc.gitlab.com/ce/api/repositories.html)
 	* list repository branches

examples/projects/main.go

@@ -39,7 +39,8 @@ func main() {
 		"  > -m hooks          -id PROJECT_ID\n"+
 		"  > -m branches       -id PROJECT_ID\n"+
 		"  > -m team           -id PROJECT_ID\n"+
-		"  > -m merge_requests -id PROJECT_ID [-state <all|merged|opened|closed>] [-order <created_at|updated_at>] [-sort <asc|desc>]")
+		"  > -m merge_requests -id PROJECT_ID [-state <all|merged|opened|closed>] [-order <created_at|updated_at>] [-sort <asc|desc>]\n"+
+		"  > -m variables      -id PROJECT_ID [-o <add|get|edit|rm>] [-key VARIABLE_KEY] [-value VARIABLE_VALUE]")
 
 	var id string
 	flag.StringVar(&id, "id", "", "Specify repository id")
@@ -53,6 +54,15 @@ func main() {
 	var sort string
 	flag.StringVar(&sort, "sort", "", "Specify merge request sort")
 
+	var operation string
+	flag.StringVar(&operation, "o", "", "Specify operation")
+
+	var key string
+	flag.StringVar(&key, "key", "", "Specify key")
+
+	var value string
+	flag.StringVar(&value, "value", "", "Specify value")
+
 	flag.Usage = func() {
 		fmt.Printf("Usage:\n")
 		flag.PrintDefaults()
@@ -198,5 +208,99 @@ func main() {
 			fmt.Printf("> [%d] %s (+%d) by %s on %s.\n", mr.Id, mr.Title, mr.Upvotes, mr.Author.Name, mr.CreatedAt)
 		}
 
+	case "variables":
+
+		if id == "" {
+			flag.Usage()
+			return
+		}
+
+		if operation == "" {
+			fmt.Println("Fetching project variables...")
+
+			variables, err := gitlab.ProjectVariables(id)
+			if err != nil {
+				fmt.Println(err.Error())
+				return
+			}
+
+			for _, variable := range variables {
+				fmt.Printf("> %s -> %s.\n", variable.Key, variable.Value)
+			}
+			return
+		}
+
+		switch operation {
+		case "get":
+			fmt.Println("Fetching project variable...")
+			if key == "" {
+				flag.Usage()
+				return
+			}
+
+			variable, err := gitlab.ProjectVariable(id, key)
+			if err != nil {
+				fmt.Println(err.Error())
+				return
+			}
+
+			fmt.Printf("> %s -> %s.\n", variable.Key, variable.Value)
+
+		case "add":
+			fmt.Println("Add project variable...")
+			if key == "" || value == "" {
+				flag.Usage()
+				return
+			}
+
+			req := gogitlab.Variable{
+				Key:   key,
+				Value: value,
+			}
+
+			variable, err := gitlab.AddProjectVariable(id, &req)
+			if err != nil {
+				fmt.Println(err.Error())
+				return
+			}
+
+			fmt.Printf("> %s -> %s.\n", variable.Key, variable.Value)
+
+		case "edit":
+			fmt.Println("Edit project variable...")
+			if key == "" || value == "" {
+				flag.Usage()
+				return
+			}
+
+			req := gogitlab.Variable{
+				Key:   key,
+				Value: value,
+			}
+
+			variable, err := gitlab.UpdateProjectVariable(id, &req)
+			if err != nil {
+				fmt.Println(err.Error())
+				return
+			}
+
+			fmt.Printf("> %s -> %s.\n", variable.Key, variable.Value)
+
+		case "rm":
+			fmt.Println("Delete project variable...")
+			if key == "" {
+				flag.Usage()
+				return
+			}
+
+			variable, err := gitlab.DeleteProjectVariable(id, key)
+			if err != nil {
+				fmt.Println(err.Error())
+				return
+			}
+
+			fmt.Printf("> %s -> %s.\n", variable.Key, variable.Value)
+
+		}
 	}
 }

projects.go

@@ -6,14 +6,16 @@ import (
 )
 
 const (
-	projects_url         = "/projects"                         // Get a list of projects owned by the authenticated user
-	projects_all         = "/projects/all"                     // Get a list of all GitLab projects (admin only)
-	projects_search_url  = "/projects/search/:query"           // Search for projects by name
-	project_url          = "/projects/:id"                     // Get a specific project, identified by project ID or NAME
-	project_url_events   = "/projects/:id/events"              // Get project events
-	project_url_branches = "/projects/:id/repository/branches" // Lists all branches of a project
-	project_url_members  = "/projects/:id/members"             // List project team members
-	project_url_member   = "/projects/:id/members/:user_id"    // Get project team member
+	projects_url          = "/projects"                             // Get a list of projects owned by the authenticated user
+	projects_all          = "/projects/all"                         // Get a list of all GitLab projects (admin only)
+	projects_search_url   = "/projects/search/:query"               // Search for projects by name
+	project_url           = "/projects/:id"                         // Get a specific project, identified by project ID or NAME
+	project_url_events    = "/projects/:id/events"                  // Get project events
+	project_url_branches  = "/projects/:id/repository/branches"     // Lists all branches of a project
+	project_url_members   = "/projects/:id/members"                 // List project team members
+	project_url_member    = "/projects/:id/members/:user_id"        // Get project team member
+	project_url_variables = "/projects/:id/variables"               // List project variables or add one
+	project_url_variable  = "/projects/:id/variables/:variable_key" // Get or Update project variable
 )
 
 type Member struct {
@@ -36,6 +38,11 @@ type Namespace struct {
 	Updated_At  string
 }
 
+type Variable struct {
+	Key   string `json:"key"`
+	Value string `json:"value"`
+}
+
 // A gitlab project
 type Project struct {
 	Id                   int        `json:"id,omitempty"`
@@ -152,3 +159,93 @@ func (g *Gitlab) ProjectMembers(id string) ([]*Member, error) {
 
 	return members, err
 }
+
+/*
+Lists all variables of a project
+*/
+func (g *Gitlab) ProjectVariables(id string) ([]*Variable, error) {
+	url, opaque := g.ResourceUrlRaw(project_url_variables, map[string]string{":id": id})
+
+	var variables []*Variable
+
+	contents, err := g.buildAndExecRequestRaw("GET", url, opaque, nil)
+	if err == nil {
+		err = json.Unmarshal(contents, &variables)
+	}
+
+	return variables, err
+}
+
+/*
+Shows a project variable
+*/
+func (g *Gitlab) ProjectVariable(id string, key string) (*Variable, error) {
+	url, opaque := g.ResourceUrlRaw(project_url_variable, map[string]string{":id": id, ":variable_key": key})
+
+	var result *Variable
+
+	contents, err := g.buildAndExecRequestRaw("GET", url, opaque, nil)
+	if err == nil {
+		err = json.Unmarshal(contents, &result)
+	}
+
+	return result, err
+}
+
+/*
+Adds a project variable
+*/
+func (g *Gitlab) AddProjectVariable(id string, variable *Variable) (*Variable, error) {
+	url, opaque := g.ResourceUrlRaw(project_url_variables, map[string]string{":id": id})
+
+	encodedRequest, err := json.Marshal(variable)
+	if err != nil {
+		return nil, err
+	}
+
+	var result *Variable
+
+	contents, err := g.buildAndExecRequestRaw("POST", url, opaque, encodedRequest)
+	if err == nil {
+		err = json.Unmarshal(contents, &result)
+	}
+
+	return result, err
+}
+
+/*
+Updates a project variable
+*/
+func (g *Gitlab) UpdateProjectVariable(id string, variable *Variable) (*Variable, error) {
+	url := g.ResourceUrl(project_url_variable, map[string]string{":id": id, ":variable_key": variable.Key})
+
+	encodedRequest, err := json.Marshal(variable)
+	if err != nil {
+		return nil, err
+	}
+	var result *Variable
+
+	contents, err := g.buildAndExecRequest("PUT", url, encodedRequest)
+
+	if err == nil {
+		err = json.Unmarshal(contents, &result)
+	}
+
+	return result, err
+}
+
+/*
+Deletes a project variable
+*/
+func (g *Gitlab) DeleteProjectVariable(id string, key string) (*Variable, error) {
+	url, opaque := g.ResourceUrlRaw(project_url_variable, map[string]string{":id": id, ":variable_key": key})
+
+	var result *Variable
+
+	contents, err := g.buildAndExecRequestRaw("DELETE", url, opaque, nil)
+	if err == nil {
+		err = json.Unmarshal(contents, &result)
+	}
+
+	return result, err
+}

projects_test.go

@@ -44,3 +44,63 @@ func TestRemoveProject(t *testing.T) {
 	assert.Equal(t, err, nil)
 	assert.Equal(t, result, true)
 }
+
+func TestListVariables(t *testing.T) {
+	ts, gitlab := Stub("stubs/projects/variables/index.json")
+
+	variables, err := gitlab.ProjectVariables("1")
+
+	assert.Equal(t, err, nil)
+	assert.Equal(t, len(variables), 2)
+	defer ts.Close()
+}
+
+func TestGetVariable(t *testing.T) {
+	ts, gitlab := Stub("stubs/projects/variables/show.json")
+
+	result, err := gitlab.ProjectVariable("1", "Somekey")
+
+	assert.NoError(t, err)
+	assert.Equal(t, result.Key, "somekey")
+	assert.Equal(t, result.Value, "somevalue")
+	defer ts.Close()
+}
+
+func TestAddVariable(t *testing.T) {
+	ts, gitlab := Stub("stubs/projects/variables/show.json")
+	req := Variable{
+		Key:   "somekey",
+		Value: "somevalue",
+	}
+	result, err := gitlab.AddProjectVariable("1", &req)
+
+	assert.NoError(t, err)
+	assert.Equal(t, result.Key, "somekey")
+	assert.Equal(t, result.Value, "somevalue")
+	defer ts.Close()
+}
+
+func TestUpdateVariable(t *testing.T) {
+	ts, gitlab := Stub("stubs/projects/variables/show.json")
+	req := Variable{
+		Key:   "somekey",
+		Value: "somevalue",
+	}
+	result, err := gitlab.UpdateProjectVariable("1", &req)
+
+	assert.NoError(t, err)
+	assert.Equal(t, result.Key, "somekey")
+	assert.Equal(t, result.Value, "somevalue")
+	defer ts.Close()
+}
+
+func TestDeleteVariable(t *testing.T) {
+	ts, gitlab := Stub("stubs/projects/variables/show.json")
+
+	result, err := gitlab.DeleteProjectVariable("1", "somekey")
+
+	assert.NoError(t, err)
+	assert.Equal(t, result.Key, "somekey")
+	assert.Equal(t, result.Value, "somevalue")
+	defer ts.Close()
+}

stubs/projects/variables/index.json

@@ -0,0 +1,10 @@
+[
+  {
+    "key": "somekey",
+    "value": "somevalue"
+  },
+  {
+    "key": "someotherkey",
+    "value": "someothervalue"
+  }
+]

stubs/projects/variables/show.json

@@ -0,0 +1,4 @@
+{
+  "key": "somekey",
+  "value": "somevalue"
+}