Projects CRUD API (#23)

Implements the Projects API Create, Read, Update and Delete
functions with related tests and usage examples.

Author: mauromedda

ROADMAP.md

@@ -12,8 +12,8 @@
 - [ ] Support Dashboard endpoints;
 - [ ] Support Orgnizations endpoints;
 - [ ] Support Users endpoints;
-- [ ] Support Projects endpoints;
-- [ ] Support ProjectUpdates endpoints;
+- [x] Support Projects endpoints;
+- [x] Support ProjectUpdates endpoints;
 - [ ] Support Teams endpoints;
 - [ ] Support Credentials endpoints;
 - [ ] Support CredentialTypes endpoints;

awxtesting/mockserver/mockdata/projects.go

@@ -163,4 +163,85 @@ var (
         "scm_update_cache_timeout": 0,
         "last_update_failed": false
     }`)
+	// MockedUpdateProjectResponse mocked `UpdateProject` endpoint response
+	MockedUpdateProjectResponse = []byte(`
+    {
+        "id": 4,
+        "type": "project",
+        "url": "/api/v2/projects/4/",
+        "related": {
+            "created_by": "/api/v2/users/1/",
+            "modified_by": "/api/v2/users/1/",
+            "object_roles": "/api/v2/projects/4/object_roles/",
+            "copy": "/api/v2/projects/4/copy/",
+            "access_list": "/api/v2/projects/4/access_list/",
+            "schedules": "/api/v2/projects/4/schedules/",
+            "organization": "/api/v2/organizations/1/"
+        },
+        "summary_fields": {
+            "organization": {
+                "id": 1,
+                "name": "Default",
+                "description": ""
+            },
+            "created_by": {
+                "id": 1,
+                "username": "admin",
+                "first_name": "admin",
+                "last_name": "admin"
+            },
+            "modified_by": {
+                "id": 1,
+                "username": "admin",
+                "first_name": "admin",
+                "last_name": "admin"
+            },
+            "object_roles": {
+                "admin_role": {
+                    "id": 14,
+                    "description": "Can manage all aspects of the project",
+                    "name": "Admin"
+                },
+                "use_role": {
+                    "id": 16,
+                    "description": "Can manage all aspects of the project",
+                    "name": "Use"
+                },
+                "update_role": {
+                    "id": 17,
+                    "description": "May update project or inventory or group using the configured source update system",
+                    "name": "Update"
+                },
+                "read_role": {
+                    "id": 15,
+                    "description": "May view settings for the project",
+                    "name": "Read"
+                }
+            },
+            "user_capabilities": {
+                "edit": true,
+                "start": true,
+                "copy": true,
+                "schedule": true,
+                "delete": true
+            }
+        },
+        "created": "2018-06-28T16:31:15.809617Z",
+        "modified": "2018-06-28T16:31:15.923732Z",
+        "name": "Demo Project",
+        "description": "Test Update",
+        "local_path": "",
+        "scm_type": "git",
+        "scm_url": "https://github.com/ansible/ansible-tower-samples",
+        "scm_clean": false,
+        "scm_delete_on_update": false,
+        "status": "never updated",
+        "scm_delete_on_next_update": false,
+        "scm_update_on_launch": true,
+        "scm_update_cache_timeout": 0,
+        "last_update_failed": false
+    }`)
+
+	// MockedDeleteProjectResponse mocked `DeleteProject` endpoint response
+	MockedDeleteProjectResponse = []byte(`{}`)
 )

awxtesting/mockserver/mockserver.go

@@ -121,6 +121,14 @@ func (s *mockServer) ProjectsHandler(rw http.ResponseWriter, req *http.Request)
 		result := mockdata.MockedCreateProjectResponse
 		rw.Write(result)
 		return
+	case req.Method == "PATCH":
+		result := mockdata.MockedUpdateProjectResponse
+		rw.Write(result)
+		return
+	case req.Method == "DELETE":
+		result := mockdata.MockedDeleteProjectResponse
+		rw.Write(result)
+		return
 	default:
 		result := mockdata.MockedListProjectsResponse
 		rw.Write(result)

examples/project.md

@@ -5,6 +5,7 @@
 > List Projects
 
 ```go
+package main
 import (
     "log"
     awxGo "github.com/Colstuwjx/awx-go"
@@ -23,15 +24,17 @@ func main() {
 }
 ```
 
+
 > Create Project
 
 ```go
+package main
 import (
     "log"
     awxGo "github.com/Colstuwjx/awx-go"
 )
 
-fun main() {
+func main() {
     awx := awxGo.NewAWX("http://awx.your_server_host.com", "your_awx_username", "your_awx_passwd", nil)
     result, err := awx.ProjectService.CreateProject(map[string]interface{}{
        "name":         "TestProject",
@@ -48,4 +51,48 @@ fun main() {
 
     log.Printf("Project created. Project ID: %d", result.Project.ID)
 }
-```
+```
+
+> Update Project
+
+```go
+package main
+import (
+    "log"
+    awxGo "github.com/Colstuwjx/awx-go"
+)
+
+func main() {
+    awx := awxGo.NewAWX("http://awx.your_server_host.com", "your_awx_username", "your_awx_passwd", nil)
+    result, err := awx.ProjectService.UpdateProject(4, map[string]interface{}{
+       "description":  "Update Example",
+    }, map[string]string{})
+
+    if err != nil {
+        log.Fatalf("Update Projects err: %s", err)
+    }
+
+    log.Printf("Project Updated. Project ID: %d", result.ID)
+}
+```
+
+> Delete Project
+
+```go
+package main
+import (
+    "log"
+    awxGo "github.com/Colstuwjx/awx-go"
+)
+
+func main() {
+    awx := awxGo.NewAWX("http://awx.your_server_host.com", "your_awx_username", "your_awx_passwd", nil)
+    result, err := awx.ProjectService.DeleteProject(4)
+
+    if err != nil {
+        log.Fatalf("Delete Projects err: %s", err)
+    }
+
+    log.Printf("Project Deleted. Project ID: %d", result.ID)
+}
+```

projects.go

@@ -63,3 +63,40 @@ func (p *ProjectService) CreateProject(data map[string]interface{}, params map[s
 
 	return result, nil
 }
+
+// UpdateProject update an awx Project.
+func (p *ProjectService) UpdateProject(id int, data map[string]interface{}, params map[string]string) (*Project, error) {
+	result := new(Project)
+	endpoint := fmt.Sprintf("/api/v2/projects/%d", id)
+	payload, err := json.Marshal(data)
+	if err != nil {
+		return nil, err
+	}
+	resp, err := p.client.Requester.PatchJSON(endpoint, bytes.NewReader(payload), result, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	if err := CheckResponse(resp); err != nil {
+		return nil, err
+	}
+
+	return result, nil
+}
+
+// DeleteProject delete an awx Project.
+func (p *ProjectService) DeleteProject(id int) (*Project, error) {
+	result := new(Project)
+	endpoint := fmt.Sprintf("/api/v2/projects/%d", id)
+
+	resp, err := p.client.Requester.Delete(endpoint, result, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	if err := CheckResponse(resp); err != nil {
+		return nil, err
+	}
+
+	return result, nil
+}

projects_test.go

@@ -217,3 +217,122 @@ func TestCreateProject(t *testing.T) {
 		t.Log("CreateProject passed!")
 	}
 }
+
+func TestUpdateProject(t *testing.T) {
+	var (
+		expectUpdateProjectResponse = &Project{
+			ID:   4,
+			Type: "project",
+			URL:  "/api/v2/projects/4/",
+			Related: &Related{
+				CreatedBy:    "/api/v2/users/1/",
+				ModifiedBy:   "/api/v2/users/1/",
+				ObjectRoles:  "/api/v2/projects/4/object_roles/",
+				Copy:         "/api/v2/projects/4/copy/",
+				AccessList:   "/api/v2/projects/4/access_list/",
+				Schedules:    "/api/v2/projects/4/schedules/",
+				Organization: "/api/v2/organizations/1/",
+			},
+			SummaryFields: &Summary{
+				Organization: &OrgnizationSummary{
+					ID:          1,
+					Name:        "Default",
+					Description: "",
+				},
+				CreatedBy: &ByUserSummary{
+					ID:        1,
+					Username:  "admin",
+					FirstName: "admin",
+					LastName:  "admin",
+				},
+				ModifiedBy: &ByUserSummary{
+					ID:        1,
+					Username:  "admin",
+					FirstName: "admin",
+					LastName:  "admin",
+				},
+				ObjectRoles: &ObjectRoles{
+					AdminRole: &ApplyRole{
+						ID:          14,
+						Description: "Can manage all aspects of the project",
+						Name:        "Admin",
+					},
+
+					UseRole: &ApplyRole{
+						ID:          16,
+						Description: "Can manage all aspects of the project",
+						Name:        "Use",
+					},
+
+					UpdateRole: &ApplyRole{
+						ID:          17,
+						Description: "May update project or inventory or group using the configured source update system",
+						Name:        "Update",
+					},
+
+					ReadRole: &ApplyRole{
+						ID:          15,
+						Description: "May view settings for the project",
+						Name:        "Read",
+					},
+				},
+
+				UserCapabilities: &UserCapabilities{
+					Edit:     true,
+					Start:    true,
+					Copy:     true,
+					Schedule: true,
+					Delete:   true,
+				},
+			},
+			Created: func() time.Time {
+				t, _ := time.Parse(time.RFC3339, "2018-06-28T16:31:15.809617Z")
+				return t
+			}(),
+
+			Modified: func() time.Time {
+				t, _ := time.Parse(time.RFC3339, "2018-06-28T16:31:15.923732Z")
+				return t
+			}(),
+			Name:                  "Demo Project",
+			Description:           "Test Update",
+			LocalPath:             "",
+			ScmType:               "git",
+			ScmURL:                "https://github.com/ansible/ansible-tower-samples",
+			ScmClean:              false,
+			ScmDeleteOnUpdate:     false,
+			Status:                "never updated",
+			ScmDeleteOnNextUpdate: false,
+			ScmUpdateOnLaunch:     true,
+			ScmUpdateCacheTimeout: 0,
+			LastUpdateFailed:      false,
+		}
+	)
+
+	awx := NewAWX(testAwxHost, testAwxUserName, testAwxPasswd, nil)
+	result, err := awx.ProjectService.UpdateProject(4, map[string]interface{}{
+		"description": "Test Update",
+	}, map[string]string{})
+
+	if err != nil {
+		t.Fatalf("UpdateProject err: %s", err)
+	} else {
+		checkAPICallResult(t, expectUpdateProjectResponse, result)
+		t.Log("UpdateProject passed!")
+	}
+}
+
+func TestDeleteProject(t *testing.T) {
+	var (
+		expectDeleteProjectResponse = &Project{}
+	)
+	awx := NewAWX(testAwxHost, testAwxUserName, testAwxPasswd, nil)
+	result, err := awx.ProjectService.DeleteProject(4)
+
+	if err != nil {
+		t.Fatalf("DeleteProject err: %s", err)
+	} else {
+		checkAPICallResult(t, expectDeleteProjectResponse, result)
+		t.Log("DeleteProject passed!")
+	}
+}