这是indexloc提供的服务，不要输入任何密码
Skip to content

dgls/test refactor #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 14, 2025
Merged

dgls/test refactor #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64e40af
Start work on refactoring tests to use a configured provider
dglsparsons May 13, 2025
c36fd02
Refactor all data_source tests to use `cfg` wrapper, initialising the…
dglsparsons May 14, 2025
01c917b
Fix build & lint errors
dglsparsons May 14, 2025
6e77dab
Fix failing tests (omg, bugs!)
dglsparsons May 14, 2025
fdcd5e5
Rewrite rest of tests to use configured provider
dglsparsons May 14, 2025
19ab23d
Fix failing tests due to missing team ID and `cfg` usage
dglsparsons May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Taskfile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ tasks:
install-staticcheck:
desc: "Install the staticheck tool"
cmds:
- go install honnef.co/go/tools/cmd/staticcheck@2024.1
- go install honnef.co/go/tools/cmd/staticcheck@2025.1
status:
- which staticcheck

Expand Down
22 changes: 11 additions & 11 deletions client/access_group.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ type GetAccessGroupRequest struct {

func (c *Client) GetAccessGroup(ctx context.Context, req GetAccessGroupRequest) (r AccessGroup, err error) {
url := fmt.Sprintf("%s/v1/access-groups/%s", c.baseURL, req.AccessGroupID)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
tflog.Info(ctx, "getting access group", map[string]any{
"url": url,
Expand All @@ -36,7 +36,7 @@ func (c *Client) GetAccessGroup(ctx context.Context, req GetAccessGroupRequest)
return r, fmt.Errorf("unable to get access group: %w", err)
}

r.TeamID = c.teamID(req.TeamID)
r.TeamID = c.TeamID(req.TeamID)
return r, err
}

Expand All @@ -47,8 +47,8 @@ type CreateAccessGroupRequest struct {

func (c *Client) CreateAccessGroup(ctx context.Context, req CreateAccessGroupRequest) (r AccessGroup, err error) {
url := fmt.Sprintf("%s/v1/access-groups", c.baseURL)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
payload := string(mustMarshal(
struct {
Expand All @@ -70,7 +70,7 @@ func (c *Client) CreateAccessGroup(ctx context.Context, req CreateAccessGroupReq
if err != nil {
return r, err
}
r.TeamID = c.teamID(req.TeamID)
r.TeamID = c.TeamID(req.TeamID)
return r, err
}

Expand All @@ -82,8 +82,8 @@ type UpdateAccessGroupRequest struct {

func (c *Client) UpdateAccessGroup(ctx context.Context, req UpdateAccessGroupRequest) (r AccessGroup, err error) {
url := fmt.Sprintf("%s/v1/access-groups/%s", c.baseURL, req.AccessGroupID)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
payload := string(mustMarshal(
struct {
Expand All @@ -105,7 +105,7 @@ func (c *Client) UpdateAccessGroup(ctx context.Context, req UpdateAccessGroupReq
if err != nil {
return r, err
}
r.TeamID = c.teamID(req.TeamID)
r.TeamID = c.TeamID(req.TeamID)
return r, err
}

Expand All @@ -116,8 +116,8 @@ type DeleteAccessGroupRequest struct {

func (c *Client) DeleteAccessGroup(ctx context.Context, req DeleteAccessGroupRequest) error {
url := fmt.Sprintf("%s/v1/access-groups/%s", c.baseURL, req.AccessGroupID)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
tflog.Info(ctx, "deleting access group", map[string]any{
"url": url,
Expand Down
20 changes: 10 additions & 10 deletions client/access_group_project.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ type CreateAccessGroupProjectRequest struct {

func (c *Client) CreateAccessGroupProject(ctx context.Context, req CreateAccessGroupProjectRequest) (r AccessGroupProject, err error) {
url := fmt.Sprintf("%s/v1/access-groups/%s/projects", c.baseURL, req.AccessGroupID)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
payload := string(mustMarshal(
struct {
Expand All @@ -48,7 +48,7 @@ func (c *Client) CreateAccessGroupProject(ctx context.Context, req CreateAccessG
if err != nil {
return r, err
}
r.TeamID = c.teamID(req.TeamID)
r.TeamID = c.TeamID(req.TeamID)
return r, err
}

Expand All @@ -60,8 +60,8 @@ type GetAccessGroupProjectRequest struct {

func (c *Client) GetAccessGroupProject(ctx context.Context, req GetAccessGroupProjectRequest) (r AccessGroupProject, err error) {
url := fmt.Sprintf("%s/v1/access-groups/%s/projects/%s", c.baseURL, req.AccessGroupID, req.ProjectID)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
tflog.Info(ctx, "getting access group project", map[string]any{
"url": url,
Expand All @@ -88,8 +88,8 @@ type UpdateAccessGroupProjectRequest struct {

func (c *Client) UpdateAccessGroupProject(ctx context.Context, req UpdateAccessGroupProjectRequest) (r AccessGroupProject, err error) {
url := fmt.Sprintf("%s/v1/access-groups/%s/projects/%s", c.baseURL, req.AccessGroupID, req.ProjectID)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
payload := string(mustMarshal(
struct {
Expand All @@ -111,7 +111,7 @@ func (c *Client) UpdateAccessGroupProject(ctx context.Context, req UpdateAccessG
if err != nil {
return r, err
}
r.TeamID = c.teamID(req.TeamID)
r.TeamID = c.TeamID(req.TeamID)
return r, err
}

Expand All @@ -123,8 +123,8 @@ type DeleteAccessGroupProjectRequest struct {

func (c *Client) DeleteAccessGroupProject(ctx context.Context, req DeleteAccessGroupProjectRequest) error {
url := fmt.Sprintf("%s/v1/access-groups/%s/projects/%s", c.baseURL, req.AccessGroupID, req.ProjectID)
if c.teamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(req.TeamID))
if c.TeamID(req.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(req.TeamID))
}
tflog.Info(ctx, "deleting access group project", map[string]any{
"url": url,
Expand Down
16 changes: 8 additions & 8 deletions client/alias.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ type createAliasResponse struct {
// UpsertAlias creates an alias within Vercel.
func (c *Client) UpsertAlias(ctx context.Context, request UpsertAliasRequest) (r AliasResponse, err error) {
url := fmt.Sprintf("%s/v2/deployments/%s/aliases", c.baseURL, request.DeploymentID)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}
payload := string(mustMarshal(request))

Expand All @@ -47,7 +47,7 @@ func (c *Client) UpsertAlias(ctx context.Context, request UpsertAliasRequest) (r
UID: aliasResponse.UID,
Alias: aliasResponse.Alias,
DeploymentID: request.DeploymentID,
TeamID: c.teamID(request.TeamID),
TeamID: c.TeamID(request.TeamID),
}, nil
}

Expand All @@ -59,8 +59,8 @@ type DeleteAliasResponse struct {
// DeleteAlias deletes an alias within Vercel.
func (c *Client) DeleteAlias(ctx context.Context, aliasUID string, teamID string) (r DeleteAliasResponse, err error) {
url := fmt.Sprintf("%s/v2/aliases/%s", c.baseURL, aliasUID)
if c.teamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(teamID))
if c.TeamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(teamID))
}

tflog.Info(ctx, "deleting alias", map[string]any{
Expand All @@ -86,8 +86,8 @@ type AliasResponse struct {
// GetAlias retrieves information about an existing alias from vercel.
func (c *Client) GetAlias(ctx context.Context, alias, teamID string) (r AliasResponse, err error) {
url := fmt.Sprintf("%s/v4/aliases/%s", c.baseURL, alias)
if c.teamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(teamID))
if c.TeamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(teamID))
}
tflog.Info(ctx, "getting alias", map[string]any{
"url": url,
Expand All @@ -98,6 +98,6 @@ func (c *Client) GetAlias(ctx context.Context, alias, teamID string) (r AliasRes
url: url,
body: "",
}, &r)
r.TeamID = c.teamID(teamID)
r.TeamID = c.TeamID(teamID)
return r, err
}
4 changes: 2 additions & 2 deletions client/attack_challenge_mode.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ func (c *Client) GetAttackChallengeMode(ctx context.Context, projectID, teamID s

func (c *Client) UpdateAttackChallengeMode(ctx context.Context, request AttackChallengeMode) (a AttackChallengeMode, err error) {
url := fmt.Sprintf("%s/security/attack-mode", c.baseURL)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}

payload := string(mustMarshal(request))
Expand Down
8 changes: 4 additions & 4 deletions client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ func (c *Client) Team(ctx context.Context, teamID string) (Team, error) {
return c.team, nil
}

// teamID is a helper method to return one of two values based on specificity.
// It will return an explicitly passed teamID if it is defined. If not defined,
// it will fall back to the teamID configured on the client.
func (c *Client) teamID(teamID string) string {
// TeamID is a helper method to return one of two values based on specificity.
// It will return an explicitly passed TeamID if it is defined. If not defined,
// it will fall back to the TeamID configured on the client.
func (c *Client) TeamID(teamID string) string {
if teamID != "" {
return teamID
}
Expand Down
22 changes: 11 additions & 11 deletions client/custom_environment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ type CustomEnvironmentResponse struct {

func (c *Client) CreateCustomEnvironment(ctx context.Context, request CreateCustomEnvironmentRequest) (res CustomEnvironmentResponse, err error) {
url := fmt.Sprintf("%s/v1/projects/%s/custom-environments", c.baseURL, request.ProjectID)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}
payload := string(mustMarshal(request))
tflog.Info(ctx, "creating custom environment", map[string]any{
Expand All @@ -48,7 +48,7 @@ func (c *Client) CreateCustomEnvironment(ctx context.Context, request CreateCust
if err != nil {
return res, err
}
res.TeamID = c.teamID(request.TeamID)
res.TeamID = c.TeamID(request.TeamID)
res.ProjectID = request.ProjectID
return res, nil
}
Expand All @@ -61,8 +61,8 @@ type GetCustomEnvironmentRequest struct {

func (c *Client) GetCustomEnvironment(ctx context.Context, request GetCustomEnvironmentRequest) (res CustomEnvironmentResponse, err error) {
url := fmt.Sprintf("%s/v1/projects/%s/custom-environments/%s", c.baseURL, request.ProjectID, request.Slug)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}
tflog.Info(ctx, "getting custom environment", map[string]any{
"url": url,
Expand All @@ -75,7 +75,7 @@ func (c *Client) GetCustomEnvironment(ctx context.Context, request GetCustomEnvi
if err != nil {
return res, err
}
res.TeamID = c.teamID(request.TeamID)
res.TeamID = c.TeamID(request.TeamID)
res.ProjectID = request.ProjectID
return res, nil

Expand All @@ -92,8 +92,8 @@ type UpdateCustomEnvironmentRequest struct {

func (c *Client) UpdateCustomEnvironment(ctx context.Context, request UpdateCustomEnvironmentRequest) (res CustomEnvironmentResponse, err error) {
url := fmt.Sprintf("%s/v1/projects/%s/custom-environments/%s", c.baseURL, request.ProjectID, request.OldSlug)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}
payload := string(mustMarshal(request))
tflog.Info(ctx, "updating custom environment", map[string]any{
Expand All @@ -109,7 +109,7 @@ func (c *Client) UpdateCustomEnvironment(ctx context.Context, request UpdateCust
if err != nil {
return res, err
}
res.TeamID = c.teamID(request.TeamID)
res.TeamID = c.TeamID(request.TeamID)
res.ProjectID = request.ProjectID
return res, nil
}
Expand All @@ -122,8 +122,8 @@ type DeleteCustomEnvironmentRequest struct {

func (c *Client) DeleteCustomEnvironment(ctx context.Context, request DeleteCustomEnvironmentRequest) error {
url := fmt.Sprintf("%s/v1/projects/%s/custom-environments/%s", c.baseURL, request.ProjectID, request.Slug)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}
tflog.Info(ctx, "deleting custom environment", map[string]any{
"url": url,
Expand Down
8 changes: 4 additions & 4 deletions client/deploy_hooks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ type CreateDeployHookRequest struct {

func (c *Client) CreateDeployHook(ctx context.Context, request CreateDeployHookRequest) (h DeployHook, err error) {
url := fmt.Sprintf("%s/v2/projects/%s/deploy-hooks", c.baseURL, request.ProjectID)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}
payload := string(mustMarshal(request))
tflog.Info(ctx, "creating deploy hook", map[string]any{
Expand Down Expand Up @@ -63,8 +63,8 @@ type DeleteDeployHookRequest struct {

func (c *Client) DeleteDeployHook(ctx context.Context, request DeleteDeployHookRequest) error {
url := fmt.Sprintf("%s/v2/projects/%s/deploy-hooks/%s", c.baseURL, request.ProjectID, request.ID)
if c.teamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(request.TeamID))
if c.TeamID(request.TeamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(request.TeamID))
}
payload := string(mustMarshal(request))
tflog.Info(ctx, "creating deploy hook", map[string]any{
Expand Down
14 changes: 7 additions & 7 deletions client/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,8 @@ func (c *Client) CreateDeployment(ctx context.Context, request CreateDeploymentR
request.GitSource = &gitSource
}
url := fmt.Sprintf("%s/v12/now/deployments?skipAutoDetectionConfirmation=1", c.baseURL)
if c.teamID(teamID) != "" {
url = fmt.Sprintf("%s&teamId=%s", url, c.teamID(teamID))
if c.TeamID(teamID) != "" {
url = fmt.Sprintf("%s&teamId=%s", url, c.TeamID(teamID))
}
payload := string(mustMarshal(request))

Expand Down Expand Up @@ -259,8 +259,8 @@ type DeleteDeploymentResponse struct {
// DeleteDeployment deletes a deployment within Vercel.
func (c *Client) DeleteDeployment(ctx context.Context, deploymentID string, teamID string) (r DeleteDeploymentResponse, err error) {
url := fmt.Sprintf("%s/v13/deployments/%s", c.baseURL, deploymentID)
if c.teamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(teamID))
if c.TeamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(teamID))
}

tflog.Info(ctx, "deleting deployment", map[string]any{
Expand All @@ -278,8 +278,8 @@ func (c *Client) DeleteDeployment(ctx context.Context, deploymentID string, team
// GetDeployment retrieves information from Vercel about an existing Deployment.
func (c *Client) GetDeployment(ctx context.Context, deploymentID, teamID string) (r DeploymentResponse, err error) {
url := fmt.Sprintf("%s/v13/deployments/%s", c.baseURL, deploymentID)
if c.teamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.teamID(teamID))
if c.TeamID(teamID) != "" {
url = fmt.Sprintf("%s?teamId=%s", url, c.TeamID(teamID))
}

tflog.Info(ctx, "getting deployment", map[string]any{
Expand All @@ -291,6 +291,6 @@ func (c *Client) GetDeployment(ctx context.Context, deploymentID, teamID string)
url: url,
body: "",
}, &r)
r.TeamID = c.teamID(teamID)
r.TeamID = c.TeamID(teamID)
return r, err
}
Loading