mirror of https://github.com/go-gitea/gitea
Add API for `Variables` (#29520)
close #27801 --------- Co-authored-by: silverwind <me@silverwind.io>pull/30055/head
parent
6103623596
commit
62b073e6f3
@ -0,0 +1,37 @@ |
|||||||
|
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package structs |
||||||
|
|
||||||
|
// CreateVariableOption the option when creating variable
|
||||||
|
// swagger:model
|
||||||
|
type CreateVariableOption struct { |
||||||
|
// Value of the variable to create
|
||||||
|
//
|
||||||
|
// required: true
|
||||||
|
Value string `json:"value" binding:"Required"` |
||||||
|
} |
||||||
|
|
||||||
|
// UpdateVariableOption the option when updating variable
|
||||||
|
// swagger:model
|
||||||
|
type UpdateVariableOption struct { |
||||||
|
// New name for the variable. If the field is empty, the variable name won't be updated.
|
||||||
|
Name string `json:"name"` |
||||||
|
// Value of the variable to update
|
||||||
|
//
|
||||||
|
// required: true
|
||||||
|
Value string `json:"value" binding:"Required"` |
||||||
|
} |
||||||
|
|
||||||
|
// ActionVariable return value of the query API
|
||||||
|
// swagger:model
|
||||||
|
type ActionVariable struct { |
||||||
|
// the owner to which the variable belongs
|
||||||
|
OwnerID int64 `json:"owner_id"` |
||||||
|
// the repository to which the variable belongs
|
||||||
|
RepoID int64 `json:"repo_id"` |
||||||
|
// the name of the variable
|
||||||
|
Name string `json:"name"` |
||||||
|
// the value of the variable
|
||||||
|
Data string `json:"data"` |
||||||
|
} |
@ -0,0 +1,291 @@ |
|||||||
|
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package org |
||||||
|
|
||||||
|
import ( |
||||||
|
"errors" |
||||||
|
"net/http" |
||||||
|
|
||||||
|
actions_model "code.gitea.io/gitea/models/actions" |
||||||
|
"code.gitea.io/gitea/models/db" |
||||||
|
api "code.gitea.io/gitea/modules/structs" |
||||||
|
"code.gitea.io/gitea/modules/util" |
||||||
|
"code.gitea.io/gitea/modules/web" |
||||||
|
"code.gitea.io/gitea/routers/api/v1/utils" |
||||||
|
actions_service "code.gitea.io/gitea/services/actions" |
||||||
|
"code.gitea.io/gitea/services/context" |
||||||
|
) |
||||||
|
|
||||||
|
// ListVariables list org-level variables
|
||||||
|
func ListVariables(ctx *context.APIContext) { |
||||||
|
// swagger:operation GET /orgs/{org}/actions/variables organization getOrgVariablesList
|
||||||
|
// ---
|
||||||
|
// summary: Get an org-level variables list
|
||||||
|
// produces:
|
||||||
|
// - application/json
|
||||||
|
// parameters:
|
||||||
|
// - name: org
|
||||||
|
// in: path
|
||||||
|
// description: name of the organization
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// - name: page
|
||||||
|
// in: query
|
||||||
|
// description: page number of results to return (1-based)
|
||||||
|
// type: integer
|
||||||
|
// - name: limit
|
||||||
|
// in: query
|
||||||
|
// description: page size of results
|
||||||
|
// type: integer
|
||||||
|
// responses:
|
||||||
|
// "200":
|
||||||
|
// "$ref": "#/responses/VariableList"
|
||||||
|
// "400":
|
||||||
|
// "$ref": "#/responses/error"
|
||||||
|
// "404":
|
||||||
|
// "$ref": "#/responses/notFound"
|
||||||
|
|
||||||
|
vars, count, err := db.FindAndCount[actions_model.ActionVariable](ctx, &actions_model.FindVariablesOpts{ |
||||||
|
OwnerID: ctx.Org.Organization.ID, |
||||||
|
ListOptions: utils.GetListOptions(ctx), |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
ctx.Error(http.StatusInternalServerError, "FindVariables", err) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
variables := make([]*api.ActionVariable, len(vars)) |
||||||
|
for i, v := range vars { |
||||||
|
variables[i] = &api.ActionVariable{ |
||||||
|
OwnerID: v.OwnerID, |
||||||
|
RepoID: v.RepoID, |
||||||
|
Name: v.Name, |
||||||
|
Data: v.Data, |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
ctx.SetTotalCountHeader(count) |
||||||
|
ctx.JSON(http.StatusOK, variables) |
||||||
|
} |
||||||
|
|
||||||
|
// GetVariable get an org-level variable
|
||||||
|
func GetVariable(ctx *context.APIContext) { |
||||||
|
// swagger:operation GET /orgs/{org}/actions/variables/{variablename} organization getOrgVariable
|
||||||
|
// ---
|
||||||
|
// summary: Get an org-level variable
|
||||||
|
// produces:
|
||||||
|
// - application/json
|
||||||
|
// parameters:
|
||||||
|
// - name: org
|
||||||
|
// in: path
|
||||||
|
// description: name of the organization
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// - name: variablename
|
||||||
|
// in: path
|
||||||
|
// description: name of the variable
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// responses:
|
||||||
|
// "200":
|
||||||
|
// "$ref": "#/responses/ActionVariable"
|
||||||
|
// "400":
|
||||||
|
// "$ref": "#/responses/error"
|
||||||
|
// "404":
|
||||||
|
// "$ref": "#/responses/notFound"
|
||||||
|
|
||||||
|
v, err := actions_service.GetVariable(ctx, actions_model.FindVariablesOpts{ |
||||||
|
OwnerID: ctx.Org.Organization.ID, |
||||||
|
Name: ctx.Params("variablename"), |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
if errors.Is(err, util.ErrNotExist) { |
||||||
|
ctx.Error(http.StatusNotFound, "GetVariable", err) |
||||||
|
} else { |
||||||
|
ctx.Error(http.StatusInternalServerError, "GetVariable", err) |
||||||
|
} |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
variable := &api.ActionVariable{ |
||||||
|
OwnerID: v.OwnerID, |
||||||
|
RepoID: v.RepoID, |
||||||
|
Name: v.Name, |
||||||
|
Data: v.Data, |
||||||
|
} |
||||||
|
|
||||||
|
ctx.JSON(http.StatusOK, variable) |
||||||
|
} |
||||||
|
|
||||||
|
// DeleteVariable delete an org-level variable
|
||||||
|
func DeleteVariable(ctx *context.APIContext) { |
||||||
|
// swagger:operation DELETE /orgs/{org}/actions/variables/{variablename} organization deleteOrgVariable
|
||||||
|
// ---
|
||||||
|
// summary: Delete an org-level variable
|
||||||
|
// produces:
|
||||||
|
// - application/json
|
||||||
|
// parameters:
|
||||||
|
// - name: org
|
||||||
|
// in: path
|
||||||
|
// description: name of the organization
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// - name: variablename
|
||||||
|
// in: path
|
||||||
|
// description: name of the variable
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// responses:
|
||||||
|
// "200":
|
||||||
|
// "$ref": "#/responses/ActionVariable"
|
||||||
|
// "201":
|
||||||
|
// description: response when deleting a variable
|
||||||
|
// "204":
|
||||||
|
// description: response when deleting a variable
|
||||||
|
// "400":
|
||||||
|
// "$ref": "#/responses/error"
|
||||||
|
// "404":
|
||||||
|
// "$ref": "#/responses/notFound"
|
||||||
|
|
||||||
|
if err := actions_service.DeleteVariableByName(ctx, ctx.Org.Organization.ID, 0, ctx.Params("variablename")); err != nil { |
||||||
|
if errors.Is(err, util.ErrInvalidArgument) { |
||||||
|
ctx.Error(http.StatusBadRequest, "DeleteVariableByName", err) |
||||||
|
} else if errors.Is(err, util.ErrNotExist) { |
||||||
|
ctx.Error(http.StatusNotFound, "DeleteVariableByName", err) |
||||||
|
} else { |
||||||
|
ctx.Error(http.StatusInternalServerError, "DeleteVariableByName", err) |
||||||
|
} |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Status(http.StatusNoContent) |
||||||
|
} |
||||||
|
|
||||||
|
// CreateVariable create an org-level variable
|
||||||
|
func CreateVariable(ctx *context.APIContext) { |
||||||
|
// swagger:operation POST /orgs/{org}/actions/variables/{variablename} organization createOrgVariable
|
||||||
|
// ---
|
||||||
|
// summary: Create an org-level variable
|
||||||
|
// consumes:
|
||||||
|
// - application/json
|
||||||
|
// produces:
|
||||||
|
// - application/json
|
||||||
|
// parameters:
|
||||||
|
// - name: org
|
||||||
|
// in: path
|
||||||
|
// description: name of the organization
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// - name: variablename
|
||||||
|
// in: path
|
||||||
|
// description: name of the variable
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// - name: body
|
||||||
|
// in: body
|
||||||
|
// schema:
|
||||||
|
// "$ref": "#/definitions/CreateVariableOption"
|
||||||
|
// responses:
|
||||||
|
// "201":
|
||||||
|
// description: response when creating an org-level variable
|
||||||
|
// "204":
|
||||||
|
// description: response when creating an org-level variable
|
||||||
|
// "400":
|
||||||
|
// "$ref": "#/responses/error"
|
||||||
|
// "404":
|
||||||
|
// "$ref": "#/responses/notFound"
|
||||||
|
|
||||||
|
opt := web.GetForm(ctx).(*api.CreateVariableOption) |
||||||
|
|
||||||
|
ownerID := ctx.Org.Organization.ID |
||||||
|
variableName := ctx.Params("variablename") |
||||||
|
|
||||||
|
v, err := actions_service.GetVariable(ctx, actions_model.FindVariablesOpts{ |
||||||
|
OwnerID: ownerID, |
||||||
|
Name: variableName, |
||||||
|
}) |
||||||
|
if err != nil && !errors.Is(err, util.ErrNotExist) { |
||||||
|
ctx.Error(http.StatusInternalServerError, "GetVariable", err) |
||||||
|
return |
||||||
|
} |
||||||
|
if v != nil && v.ID > 0 { |
||||||
|
ctx.Error(http.StatusConflict, "VariableNameAlreadyExists", util.NewAlreadyExistErrorf("variable name %s already exists", variableName)) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if _, err := actions_service.CreateVariable(ctx, ownerID, 0, variableName, opt.Value); err != nil { |
||||||
|
if errors.Is(err, util.ErrInvalidArgument) { |
||||||
|
ctx.Error(http.StatusBadRequest, "CreateVariable", err) |
||||||
|
} else { |
||||||
|
ctx.Error(http.StatusInternalServerError, "CreateVariable", err) |
||||||
|
} |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Status(http.StatusNoContent) |
||||||
|
} |
||||||
|
|
||||||
|
// UpdateVariable update an org-level variable
|
||||||
|
func UpdateVariable(ctx *context.APIContext) { |
||||||
|
// swagger:operation PUT /orgs/{org}/actions/variables/{variablename} organization updateOrgVariable
|
||||||
|
// ---
|
||||||
|
// summary: Update an org-level variable
|
||||||
|
// consumes:
|
||||||
|
// - application/json
|
||||||
|
// produces:
|
||||||
|
// - application/json
|
||||||
|
// parameters:
|
||||||
|
// - name: org
|
||||||
|
// in: path
|
||||||
|
// description: name of the organization
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// - name: variablename
|
||||||
|
// in: path
|
||||||
|
// description: name of the variable
|
||||||
|
// type: string
|
||||||
|
// required: true
|
||||||
|
// - name: body
|
||||||
|
// in: body
|
||||||
|
// schema:
|
||||||
|
// "$ref": "#/definitions/UpdateVariableOption"
|
||||||
|
// responses:
|
||||||
|
// "201":
|
||||||
|
// description: response when updating an org-level variable
|
||||||
|
// "204":
|
||||||
|
// description: response when updating an org-level variable
|
||||||
|
// "400":
|
||||||
|
// "$ref": "#/responses/error"
|
||||||
|
// "404":
|
||||||
|
// "$ref": "#/responses/notFound"
|
||||||
|
|
||||||
|
opt := web.GetForm(ctx).(*api.UpdateVariableOption) |
||||||
|
|
||||||
|
v, err := actions_service.GetVariable(ctx, actions_model.FindVariablesOpts{ |
||||||
|
OwnerID: ctx.Org.Organization.ID, |
||||||
|
Name: ctx.Params("variablename"), |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
if errors.Is(err, util.ErrNotExist) { |
||||||
|
ctx.Error(http.StatusNotFound, "GetVariable", err) |
||||||
|
} else { |
||||||
|
ctx.Error(http.StatusInternalServerError, "GetVariable", err) |
||||||
|
} |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
if opt.Name == "" { |
||||||
|
opt.Name = ctx.Params("variablename") |
||||||
|
} |
||||||
|
if _, err := actions_service.UpdateVariable(ctx, v.ID, opt.Name, opt.Value); err != nil { |
||||||
|
if errors.Is(err, util.ErrInvalidArgument) { |
||||||
|
ctx.Error(http.StatusBadRequest, "UpdateVariable", err) |
||||||
|
} else { |
||||||
|
ctx.Error(http.StatusInternalServerError, "UpdateVariable", err) |
||||||
|
} |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
ctx.Status(http.StatusNoContent) |
||||||
|
} |
@ -0,0 +1,100 @@ |
|||||||
|
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package actions |
||||||
|
|
||||||
|
import ( |
||||||
|
"context" |
||||||
|
"regexp" |
||||||
|
"strings" |
||||||
|
|
||||||
|
actions_model "code.gitea.io/gitea/models/actions" |
||||||
|
"code.gitea.io/gitea/modules/log" |
||||||
|
"code.gitea.io/gitea/modules/util" |
||||||
|
secret_service "code.gitea.io/gitea/services/secrets" |
||||||
|
) |
||||||
|
|
||||||
|
func CreateVariable(ctx context.Context, ownerID, repoID int64, name, data string) (*actions_model.ActionVariable, error) { |
||||||
|
if err := secret_service.ValidateName(name); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
if err := envNameCIRegexMatch(name); err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
v, err := actions_model.InsertVariable(ctx, ownerID, repoID, name, util.ReserveLineBreakForTextarea(data)) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
|
||||||
|
return v, nil |
||||||
|
} |
||||||
|
|
||||||
|
func UpdateVariable(ctx context.Context, variableID int64, name, data string) (bool, error) { |
||||||
|
if err := secret_service.ValidateName(name); err != nil { |
||||||
|
return false, err |
||||||
|
} |
||||||
|
|
||||||
|
if err := envNameCIRegexMatch(name); err != nil { |
||||||
|
return false, err |
||||||
|
} |
||||||
|
|
||||||
|
return actions_model.UpdateVariable(ctx, &actions_model.ActionVariable{ |
||||||
|
ID: variableID, |
||||||
|
Name: strings.ToUpper(name), |
||||||
|
Data: util.ReserveLineBreakForTextarea(data), |
||||||
|
}) |
||||||
|
} |
||||||
|
|
||||||
|
func DeleteVariableByID(ctx context.Context, variableID int64) error { |
||||||
|
return actions_model.DeleteVariable(ctx, variableID) |
||||||
|
} |
||||||
|
|
||||||
|
func DeleteVariableByName(ctx context.Context, ownerID, repoID int64, name string) error { |
||||||
|
if err := secret_service.ValidateName(name); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
if err := envNameCIRegexMatch(name); err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
v, err := GetVariable(ctx, actions_model.FindVariablesOpts{ |
||||||
|
OwnerID: ownerID, |
||||||
|
RepoID: repoID, |
||||||
|
Name: name, |
||||||
|
}) |
||||||
|
if err != nil { |
||||||
|
return err |
||||||
|
} |
||||||
|
|
||||||
|
return actions_model.DeleteVariable(ctx, v.ID) |
||||||
|
} |
||||||
|
|
||||||
|
func GetVariable(ctx context.Context, opts actions_model.FindVariablesOpts) (*actions_model.ActionVariable, error) { |
||||||
|
vars, err := actions_model.FindVariables(ctx, opts) |
||||||
|
if err != nil { |
||||||
|
return nil, err |
||||||
|
} |
||||||
|
if len(vars) != 1 { |
||||||
|
return nil, util.NewNotExistErrorf("variable not found") |
||||||
|
} |
||||||
|
return vars[0], nil |
||||||
|
} |
||||||
|
|
||||||
|
// some regular expression of `variables` and `secrets`
|
||||||
|
// reference to:
|
||||||
|
// https://docs.github.com/en/actions/learn-github-actions/variables#naming-conventions-for-configuration-variables
|
||||||
|
// https://docs.github.com/en/actions/security-guides/encrypted-secrets#naming-your-secrets
|
||||||
|
var ( |
||||||
|
forbiddenEnvNameCIRx = regexp.MustCompile("(?i)^CI") |
||||||
|
) |
||||||
|
|
||||||
|
func envNameCIRegexMatch(name string) error { |
||||||
|
if forbiddenEnvNameCIRx.MatchString(name) { |
||||||
|
log.Error("Env Name cannot be ci") |
||||||
|
return util.NewInvalidArgumentErrorf("env name cannot be ci") |
||||||
|
} |
||||||
|
return nil |
||||||
|
} |
@ -0,0 +1,149 @@ |
|||||||
|
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package integration |
||||||
|
|
||||||
|
import ( |
||||||
|
"fmt" |
||||||
|
"net/http" |
||||||
|
"testing" |
||||||
|
|
||||||
|
auth_model "code.gitea.io/gitea/models/auth" |
||||||
|
repo_model "code.gitea.io/gitea/models/repo" |
||||||
|
"code.gitea.io/gitea/models/unittest" |
||||||
|
user_model "code.gitea.io/gitea/models/user" |
||||||
|
api "code.gitea.io/gitea/modules/structs" |
||||||
|
"code.gitea.io/gitea/tests" |
||||||
|
) |
||||||
|
|
||||||
|
func TestAPIRepoVariables(t *testing.T) { |
||||||
|
defer tests.PrepareTestEnv(t)() |
||||||
|
|
||||||
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1}) |
||||||
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID}) |
||||||
|
session := loginUser(t, user.Name) |
||||||
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository) |
||||||
|
|
||||||
|
t.Run("CreateRepoVariable", func(t *testing.T) { |
||||||
|
cases := []struct { |
||||||
|
Name string |
||||||
|
ExpectedStatus int |
||||||
|
}{ |
||||||
|
{ |
||||||
|
Name: "-", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "_", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "TEST_VAR", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "test_var", |
||||||
|
ExpectedStatus: http.StatusConflict, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "ci", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "123var", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "var@test", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "github_var", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "gitea_var", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
} |
||||||
|
|
||||||
|
for _, c := range cases { |
||||||
|
req := NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/repos/%s/actions/variables/%s", repo.FullName(), c.Name), api.CreateVariableOption{ |
||||||
|
Value: "value", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, c.ExpectedStatus) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
t.Run("UpdateRepoVariable", func(t *testing.T) { |
||||||
|
variableName := "test_update_var" |
||||||
|
url := fmt.Sprintf("/api/v1/repos/%s/actions/variables/%s", repo.FullName(), variableName) |
||||||
|
req := NewRequestWithJSON(t, "POST", url, api.CreateVariableOption{ |
||||||
|
Value: "initial_val", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNoContent) |
||||||
|
|
||||||
|
cases := []struct { |
||||||
|
Name string |
||||||
|
UpdateName string |
||||||
|
ExpectedStatus int |
||||||
|
}{ |
||||||
|
{ |
||||||
|
Name: "not_found_var", |
||||||
|
ExpectedStatus: http.StatusNotFound, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "1invalid", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "invalid@name", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "ci", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "updated_var_name", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
ExpectedStatus: http.StatusNotFound, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "updated_var_name", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
} |
||||||
|
|
||||||
|
for _, c := range cases { |
||||||
|
req := NewRequestWithJSON(t, "PUT", fmt.Sprintf("/api/v1/repos/%s/actions/variables/%s", repo.FullName(), c.Name), api.UpdateVariableOption{ |
||||||
|
Name: c.UpdateName, |
||||||
|
Value: "updated_val", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, c.ExpectedStatus) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
t.Run("DeleteRepoVariable", func(t *testing.T) { |
||||||
|
variableName := "test_delete_var" |
||||||
|
url := fmt.Sprintf("/api/v1/repos/%s/actions/variables/%s", repo.FullName(), variableName) |
||||||
|
|
||||||
|
req := NewRequestWithJSON(t, "POST", url, api.CreateVariableOption{ |
||||||
|
Value: "initial_val", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNoContent) |
||||||
|
|
||||||
|
req = NewRequest(t, "DELETE", url).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNoContent) |
||||||
|
|
||||||
|
req = NewRequest(t, "DELETE", url).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNotFound) |
||||||
|
}) |
||||||
|
} |
@ -0,0 +1,144 @@ |
|||||||
|
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
package integration |
||||||
|
|
||||||
|
import ( |
||||||
|
"fmt" |
||||||
|
"net/http" |
||||||
|
"testing" |
||||||
|
|
||||||
|
auth_model "code.gitea.io/gitea/models/auth" |
||||||
|
api "code.gitea.io/gitea/modules/structs" |
||||||
|
"code.gitea.io/gitea/tests" |
||||||
|
) |
||||||
|
|
||||||
|
func TestAPIUserVariables(t *testing.T) { |
||||||
|
defer tests.PrepareTestEnv(t)() |
||||||
|
|
||||||
|
session := loginUser(t, "user1") |
||||||
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteUser) |
||||||
|
|
||||||
|
t.Run("CreateRepoVariable", func(t *testing.T) { |
||||||
|
cases := []struct { |
||||||
|
Name string |
||||||
|
ExpectedStatus int |
||||||
|
}{ |
||||||
|
{ |
||||||
|
Name: "-", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "_", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "TEST_VAR", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "test_var", |
||||||
|
ExpectedStatus: http.StatusConflict, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "ci", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "123var", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "var@test", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "github_var", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "gitea_var", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
} |
||||||
|
|
||||||
|
for _, c := range cases { |
||||||
|
req := NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/user/actions/variables/%s", c.Name), api.CreateVariableOption{ |
||||||
|
Value: "value", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, c.ExpectedStatus) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
t.Run("UpdateRepoVariable", func(t *testing.T) { |
||||||
|
variableName := "test_update_var" |
||||||
|
url := fmt.Sprintf("/api/v1/user/actions/variables/%s", variableName) |
||||||
|
req := NewRequestWithJSON(t, "POST", url, api.CreateVariableOption{ |
||||||
|
Value: "initial_val", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNoContent) |
||||||
|
|
||||||
|
cases := []struct { |
||||||
|
Name string |
||||||
|
UpdateName string |
||||||
|
ExpectedStatus int |
||||||
|
}{ |
||||||
|
{ |
||||||
|
Name: "not_found_var", |
||||||
|
ExpectedStatus: http.StatusNotFound, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "1invalid", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "invalid@name", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "ci", |
||||||
|
ExpectedStatus: http.StatusBadRequest, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
UpdateName: "updated_var_name", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: variableName, |
||||||
|
ExpectedStatus: http.StatusNotFound, |
||||||
|
}, |
||||||
|
{ |
||||||
|
Name: "updated_var_name", |
||||||
|
ExpectedStatus: http.StatusNoContent, |
||||||
|
}, |
||||||
|
} |
||||||
|
|
||||||
|
for _, c := range cases { |
||||||
|
req := NewRequestWithJSON(t, "PUT", fmt.Sprintf("/api/v1/user/actions/variables/%s", c.Name), api.UpdateVariableOption{ |
||||||
|
Name: c.UpdateName, |
||||||
|
Value: "updated_val", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, c.ExpectedStatus) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
t.Run("DeleteRepoVariable", func(t *testing.T) { |
||||||
|
variableName := "test_delete_var" |
||||||
|
url := fmt.Sprintf("/api/v1/user/actions/variables/%s", variableName) |
||||||
|
|
||||||
|
req := NewRequestWithJSON(t, "POST", url, api.CreateVariableOption{ |
||||||
|
Value: "initial_val", |
||||||
|
}).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNoContent) |
||||||
|
|
||||||
|
req = NewRequest(t, "DELETE", url).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNoContent) |
||||||
|
|
||||||
|
req = NewRequest(t, "DELETE", url).AddTokenAuth(token) |
||||||
|
MakeRequest(t, req, http.StatusNotFound) |
||||||
|
}) |
||||||
|
} |
Loading…
Reference in new issue