Fixes #7023 - API Org Visibility

integrations/api_admin_org_test.go

@@ -0,0 +1,86 @@
+// Copyright 2019 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package integrations
+
+import (
+	"net/http"
+	"net/url"
+	"strings"
+	"testing"
+
+	"code.gitea.io/gitea/models"
+	api "code.gitea.io/gitea/modules/structs"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestAPIAdminOrgCreate(t *testing.T) {
+	onGiteaRun(t, func(*testing.T, *url.URL) {
+		session := loginUser(t, "user1")
+		token := getTokenForLoggedInUser(t, session)
+
+		var org = api.CreateOrgOption{
+			UserName:    "user2_org",
+			FullName:    "User2's organization",
+			Description: "This organization created by admin for user2",
+			Website:     "https://try.gitea.io",
+			Location:    "Shanghai",
+			Visibility:  "private",
+		}
+		req := NewRequestWithJSON(t, "POST", "/api/v1/admin/users/user2/orgs?token="+token, &org)
+		resp := session.MakeRequest(t, req, http.StatusCreated)
+
+		var apiOrg api.Organization
+		DecodeJSON(t, resp, &apiOrg)
+
+		assert.Equal(t, org.UserName, apiOrg.UserName)
+		assert.Equal(t, org.FullName, apiOrg.FullName)
+		assert.Equal(t, org.Description, apiOrg.Description)
+		assert.Equal(t, org.Website, apiOrg.Website)
+		assert.Equal(t, org.Location, apiOrg.Location)
+		assert.Equal(t, org.Visibility, apiOrg.Visibility)
+
+		models.AssertExistsAndLoadBean(t, &models.User{
+			Name:      org.UserName,
+			LowerName: strings.ToLower(org.UserName),
+			FullName:  org.FullName,
+		})
+	})
+}
+
+func TestAPIAdminOrgCreateBadVisibility(t *testing.T) {
+	onGiteaRun(t, func(*testing.T, *url.URL) {
+		session := loginUser(t, "user1")
+		token := getTokenForLoggedInUser(t, session)
+
+		var org = api.CreateOrgOption{
+			UserName:    "user2_org",
+			FullName:    "User2's organization",
+			Description: "This organization created by admin for user2",
+			Website:     "https://try.gitea.io",
+			Location:    "Shanghai",
+			Visibility:  "notvalid",
+		}
+		req := NewRequestWithJSON(t, "POST", "/api/v1/admin/users/user2/orgs?token="+token, &org)
+		session.MakeRequest(t, req, http.StatusUnprocessableEntity)
+	})
+}
+
+func TestAPIAdminOrgCreateNotAdmin(t *testing.T) {
+	prepareTestEnv(t)
+	nonAdminUsername := "user2"
+	session := loginUser(t, nonAdminUsername)
+	token := getTokenForLoggedInUser(t, session)
+	var org = api.CreateOrgOption{
+		UserName:    "user2_org",
+		FullName:    "User2's organization",
+		Description: "This organization created by admin for user2",
+		Website:     "https://try.gitea.io",
+		Location:    "Shanghai",
+		Visibility:  "public",
+	}
+	req := NewRequestWithJSON(t, "POST", "/api/v1/admin/users/user2/orgs?token="+token, &org)
+	session.MakeRequest(t, req, http.StatusForbidden)
+}

integrations/api_org_test.go

@@ -17,7 +17,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestAPIOrg(t *testing.T) {
+func TestAPIOrgCreate(t *testing.T) {
 	onGiteaRun(t, func(*testing.T, *url.URL) {
 		session := loginUser(t, "user1")
 
@@ -28,6 +28,7 @@ func TestAPIOrg(t *testing.T) {
 			Description: "This organization created by user1",
 			Website:     "https://try.gitea.io",
 			Location:    "Shanghai",
+			Visibility:  "limited",
 		}
 		req := NewRequestWithJSON(t, "POST", "/api/v1/orgs?token="+token, &org)
 		resp := session.MakeRequest(t, req, http.StatusCreated)
@@ -40,6 +41,7 @@ func TestAPIOrg(t *testing.T) {
 		assert.Equal(t, org.Description, apiOrg.Description)
 		assert.Equal(t, org.Website, apiOrg.Website)
 		assert.Equal(t, org.Location, apiOrg.Location)
+		assert.Equal(t, org.Visibility, apiOrg.Visibility)
 
 		models.AssertExistsAndLoadBean(t, &models.User{
 			Name:      org.UserName,
@@ -72,6 +74,50 @@ func TestAPIOrg(t *testing.T) {
 	})
 }
 
+func TestAPIOrgEdit(t *testing.T) {
+	onGiteaRun(t, func(*testing.T, *url.URL) {
+		session := loginUser(t, "user1")
+
+		token := getTokenForLoggedInUser(t, session)
+		var org = api.EditOrgOption{
+			FullName:    "User3 organization new full name",
+			Description: "A new description",
+			Website:     "https://try.gitea.io/new",
+			Location:    "Beijing",
+			Visibility:  "private",
+		}
+		req := NewRequestWithJSON(t, "PATCH", "/api/v1/orgs/user3?token="+token, &org)
+		resp := session.MakeRequest(t, req, http.StatusOK)
+
+		var apiOrg api.Organization
+		DecodeJSON(t, resp, &apiOrg)
+
+		assert.Equal(t, "user3", apiOrg.UserName)
+		assert.Equal(t, org.FullName, apiOrg.FullName)
+		assert.Equal(t, org.Description, apiOrg.Description)
+		assert.Equal(t, org.Website, apiOrg.Website)
+		assert.Equal(t, org.Location, apiOrg.Location)
+		assert.Equal(t, org.Visibility, apiOrg.Visibility)
+	})
+}
+
+func TestAPIOrgEditBadVisibility(t *testing.T) {
+	onGiteaRun(t, func(*testing.T, *url.URL) {
+		session := loginUser(t, "user1")
+
+		token := getTokenForLoggedInUser(t, session)
+		var org = api.EditOrgOption{
+			FullName:    "User3 organization new full name",
+			Description: "A new description",
+			Website:     "https://try.gitea.io/new",
+			Location:    "Beijing",
+			Visibility:  "badvisibility",
+		}
+		req := NewRequestWithJSON(t, "PATCH", "/api/v1/orgs/user3?token="+token, &org)
+		session.MakeRequest(t, req, http.StatusUnprocessableEntity)
+	})
+}
+
 func TestAPIOrgDeny(t *testing.T) {
 	onGiteaRun(t, func(*testing.T, *url.URL) {
 		setting.Service.RequireSignInView = true

integrations/api_user_orgs_test.go

@@ -38,6 +38,7 @@ func TestUserOrgs(t *testing.T) {
 			Description: "",
 			Website:     "",
 			Location:    "",
+			Visibility:  "public",
 		},
 	}, orgs)
 }
@@ -63,6 +64,7 @@ func TestMyOrgs(t *testing.T) {
 			Description: "",
 			Website:     "",
 			Location:    "",
+			Visibility:  "public",
 		},
 	}, orgs)
 }

modules/structs/org.go

@@ -6,25 +6,25 @@ package structs
 
 // Organization represents an organization
 type Organization struct {
-	ID          int64       `json:"id"`
-	UserName    string      `json:"username"`
-	FullName    string      `json:"full_name"`
-	AvatarURL   string      `json:"avatar_url"`
-	Description string      `json:"description"`
-	Website     string      `json:"website"`
-	Location    string      `json:"location"`
-	Visibility  VisibleType `json:"visibility"`
+	ID          int64  `json:"id"`
+	UserName    string `json:"username"`
+	FullName    string `json:"full_name"`
+	AvatarURL   string `json:"avatar_url"`
+	Description string `json:"description"`
+	Website     string `json:"website"`
+	Location    string `json:"location"`
+	Visibility  string `json:"visibility"`
 }
 
 // CreateOrgOption options for creating an organization
 type CreateOrgOption struct {
 	// required: true
-	UserName    string      `json:"username" binding:"Required"`
-	FullName    string      `json:"full_name"`
-	Description string      `json:"description"`
-	Website     string      `json:"website"`
-	Location    string      `json:"location"`
-	Visibility  VisibleType `json:"visibility"`
+	UserName    string `json:"username" binding:"Required"`
+	FullName    string `json:"full_name"`
+	Description string `json:"description"`
+	Website     string `json:"website"`
+	Location    string `json:"location"`
+	Visibility  string `json:"visibility" binding:"In(,visible,limited,private)"`
 }
 
 // EditOrgOption options for editing an organization
@@ -33,4 +33,5 @@ type EditOrgOption struct {
 	Description string `json:"description"`
 	Website     string `json:"website"`
 	Location    string `json:"location"`
+	Visibility  string `json:"visibility" binding:"In(,visible,limited,private)"`
 }

modules/structs/org_type.go

@@ -40,6 +40,16 @@ func (vt VisibleType) IsPrivate() bool {
 	return vt == VisibleTypePrivate
 }
 
+// VisibilityString provides the mode string of the visibility type (public, limited, private)
+func (vt VisibleType) VisibilityString() string {
+	for k, v := range VisibilityModes {
+		if vt == v {
+			return k
+		}
+	}
+	return ""
+}
+
 // ExtractKeysFromMapString provides a slice of keys from map
 func ExtractKeysFromMapString(in map[string]VisibleType) (keys []string) {
 	for k := range in {

routers/api/v1/admin/org.go

@@ -31,6 +31,7 @@ func CreateOrg(ctx *context.APIContext, form api.CreateOrgOption) {
 	//   required: true
 	// - name: organization
 	//   in: body
+	//   description: "'visibility' can be \"public\", \"limited\" or \"private\""
 	//   required: true
 	//   schema: { "$ref": "#/definitions/CreateOrgOption" }
 	// responses:
@@ -45,6 +46,11 @@ func CreateOrg(ctx *context.APIContext, form api.CreateOrgOption) {
 		return
 	}
 
+	visibility := api.VisibleTypePublic
+	if form.Visibility != "" {
+		visibility = api.VisibilityModes[form.Visibility]
+	}
+
 	org := &models.User{
 		Name:        form.UserName,
 		FullName:    form.FullName,
@@ -53,7 +59,9 @@ func CreateOrg(ctx *context.APIContext, form api.CreateOrgOption) {
 		Location:    form.Location,
 		IsActive:    true,
 		Type:        models.UserTypeOrganization,
+		Visibility:  visibility,
 	}
+
 	if err := models.CreateOrganization(org, u); err != nil {
 		if models.IsErrUserAlreadyExist(err) ||
 			models.IsErrNameReserved(err) ||

routers/api/v1/convert/convert.go

@@ -213,6 +213,7 @@ func ToOrganization(org *models.User) *api.Organization {
 		Description: org.Description,
 		Website:     org.Website,
 		Location:    org.Location,
+		Visibility:  org.Visibility.VisibilityString(),
 	}
 }
 

routers/api/v1/org/org.go

@@ -75,6 +75,7 @@ func Create(ctx *context.APIContext, form api.CreateOrgOption) {
 	// parameters:
 	// - name: organization
 	//   in: body
+	//   description: "'visibility' can be \"public\", \"limited\" or \"private\""
 	//   required: true
 	//   schema: { "$ref": "#/definitions/CreateOrgOption" }
 	// responses:
@@ -90,6 +91,11 @@ func Create(ctx *context.APIContext, form api.CreateOrgOption) {
 		return
 	}
 
+	visibility := api.VisibleTypePublic
+	if form.Visibility != "" {
+		visibility = api.VisibilityModes[form.Visibility]
+	}
+
 	org := &models.User{
 		Name:        form.UserName,
 		FullName:    form.FullName,
@@ -98,6 +104,7 @@ func Create(ctx *context.APIContext, form api.CreateOrgOption) {
 		Location:    form.Location,
 		IsActive:    true,
 		Type:        models.UserTypeOrganization,
+		Visibility:  visibility,
 	}
 	if err := models.CreateOrganization(org, ctx.User); err != nil {
 		if models.IsErrUserAlreadyExist(err) ||
@@ -153,6 +160,7 @@ func Edit(ctx *context.APIContext, form api.EditOrgOption) {
 	//   required: true
 	// - name: body
 	//   in: body
+	//   description: "'visibility' can be \"public\", \"limited\" or \"private\""
 	//   schema:
 	//     "$ref": "#/definitions/EditOrgOption"
 	// responses:
@@ -163,8 +171,11 @@ func Edit(ctx *context.APIContext, form api.EditOrgOption) {
 	org.Description = form.Description
 	org.Website = form.Website
 	org.Location = form.Location
-	if err := models.UpdateUserCols(org, "full_name", "description", "website", "location"); err != nil {
-		ctx.Error(500, "UpdateUser", err)
+	if form.Visibility != "" {
+		org.Visibility = api.VisibilityModes[form.Visibility]
+	}
+	if err := models.UpdateUserCols(org, "full_name", "description", "website", "location", "visibility"); err != nil {
+		ctx.Error(500, "EditOrganization", err)
 		return
 	}
 

templates/swagger/v1_json.tmpl

@@ -272,6 +272,7 @@
             "required": true
           },
           {
+            "description": "'visibility' can be \"public\", \"limited\" or \"private\"",
             "name": "organization",
             "in": "body",
             "required": true,
@@ -459,6 +460,7 @@
         "operationId": "orgCreate",
         "parameters": [
           {
+            "description": "'visibility' can be \"public\", \"limited\" or \"private\"",
             "name": "organization",
             "in": "body",
             "required": true,
@@ -550,6 +552,7 @@
             "required": true
           },
           {
+            "description": "'visibility' can be \"public\", \"limited\" or \"private\"",
             "name": "body",
             "in": "body",
             "schema": {
@@ -7140,7 +7143,8 @@
           "x-go-name": "UserName"
         },
         "visibility": {
-          "$ref": "#/definitions/VisibleType"
+          "type": "string",
+          "x-go-name": "Visibility"
         },
         "website": {
           "type": "string",
@@ -7652,6 +7656,10 @@
           "type": "string",
           "x-go-name": "Location"
         },
+        "visibility": {
+          "type": "string",
+          "x-go-name": "Visibility"
+        },
         "website": {
           "type": "string",
           "x-go-name": "Website"
@@ -8612,7 +8620,8 @@
           "x-go-name": "UserName"
         },
         "visibility": {
-          "$ref": "#/definitions/VisibleType"
+          "type": "string",
+          "x-go-name": "Visibility"
         },
         "website": {
           "type": "string",
@@ -9466,12 +9475,6 @@
       },
       "x-go-package": "code.gitea.io/gitea/models"
     },
-    "VisibleType": {
-      "description": "VisibleType defines the visibility (Organization only)",
-      "type": "integer",
-      "format": "int64",
-      "x-go-package": "code.gitea.io/gitea/modules/structs"
-    },
     "WatchInfo": {
       "description": "WatchInfo represents an API watch status of one repository",
       "type": "object",