Skip to content
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.

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

[Bug] - azuredevops_build_folder_permissions Fixing bug where root folder permissions for builds would not be set #893

Merged
merged 3 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,16 @@ import (

func hclBuildFolderPermissions(projectName string, path string, permissions map[string]string) string {
rootPermissions := datahelper.JoinMap(permissions, "=", "\n")
description := "Integration Test Folder"
var requiredResources string
var pathArgument string
if path != `\\` {
pathArgument = `azuredevops_build_folder.test_folder.path`
description := "Integration Test Folder"
requiredResources = testutils.HclBuildFolder(projectName, path, description)
} else {
pathArgument = `"\\"`
requiredResources = testutils.HclProjectResource(projectName)
}

return fmt.Sprintf(`
%s
Expand All @@ -28,21 +37,22 @@ data "azuredevops_group" "tf-project-readers" {
resource "azuredevops_build_folder_permissions" "permissions" {
project_id = azuredevops_project.project.id
principal = data.azuredevops_group.tf-project-readers.id
path = azuredevops_build_folder.test_folder.path
path = %s

permissions = {
%s
}
}
`,
testutils.HclBuildFolder(projectName, path, description),
requiredResources,
pathArgument,
rootPermissions,
)
}

func TestAccBuildFolderPermissions_SetPermissions(t *testing.T) {
projectName := testutils.GenerateResourceName()
config := hclBuildFolderPermissions(projectName, `\test-folder`, map[string]string{
permissions := map[string]string{
"ViewBuilds": "Allow",
"EditBuildQuality": "Allow",
"RetainIndefinitely": "Allow",
Expand All @@ -57,27 +67,35 @@ func TestAccBuildFolderPermissions_SetPermissions(t *testing.T) {
"EditBuildDefinition": "Allow",
"DeleteBuildDefinition": "Deny",
"AdministerBuildPermissions": "NotSet",
})
}
configFolder := hclBuildFolderPermissions(projectName, `\test-folder`, permissions)
configRootFolder := hclBuildFolderPermissions(projectName, `\\`, permissions)
tfNodeRoot := "azuredevops_build_folder_permissions.permissions"

testFunc := resource.ComposeTestCheckFunc(
testutils.CheckProjectExists(projectName),
resource.TestCheckResourceAttrSet(tfNodeRoot, "project_id"),
resource.TestCheckResourceAttrSet(tfNodeRoot, "principal"),
resource.TestCheckResourceAttrSet(tfNodeRoot, "path"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.%", "14"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.ViewBuilds", "allow"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.DeleteBuilds", "deny"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.DeleteBuildDefinition", "deny"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.AdministerBuildPermissions", "notset"),
)

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { testutils.PreCheck(t, nil) },
Providers: testutils.GetProviders(),
CheckDestroy: testutils.CheckProjectDestroyed,
Steps: []resource.TestStep{
{
Config: config,
Check: resource.ComposeTestCheckFunc(
testutils.CheckProjectExists(projectName),
resource.TestCheckResourceAttrSet(tfNodeRoot, "project_id"),
resource.TestCheckResourceAttrSet(tfNodeRoot, "principal"),
resource.TestCheckResourceAttrSet(tfNodeRoot, "path"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.%", "14"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.ViewBuilds", "allow"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.DeleteBuilds", "deny"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.DeleteBuildDefinition", "deny"),
resource.TestCheckResourceAttr(tfNodeRoot, "permissions.AdministerBuildPermissions", "notset"),
),
Config: configFolder,
Check: testFunc,
},
{
Config: configRootFolder,
Check: testFunc,
},
},
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ func createBuildFolderToken(d *schema.ResourceData, clients *client.AggregatedCl

aclToken = fmt.Sprintf("%s/%s", projectID.(string), transformedPath)
} else {
aclToken = fmt.Sprintf("%s/%s", projectID.(string), *Folder.Path)
aclToken = fmt.Sprintf("%s", projectID.(string))
}

return aclToken, nil
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func TestBuildFolderPermissions_CreateBuildFolderToken(t *testing.T) {
token, err = createBuildFolderToken(d, clients)
assert.NotEmpty(t, token)
assert.Nil(t, err)
assert.Equal(t, "9083e944-8e9e-405e-960a-c80180aa71e6/\\", token)
assert.Equal(t, "9083e944-8e9e-405e-960a-c80180aa71e6", token)

d = getBuildFolderPermissionsResource(t, "", "")
token, err = createBuildFolderToken(d, clients)
Expand Down
26 changes: 26 additions & 0 deletions website/docs/r/build_folder_permissions.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Manages permissions for a Build Folder
~> **Note** Permissions can be assigned to group principals and not to single user principals.

## Example Usage
### Set specific folder permissions

```hcl
resource "azuredevops_project" "example" {
Expand Down Expand Up @@ -56,6 +57,31 @@ resource "azuredevops_build_folder_permissions" "example" {
}
}
```
### Set root folder permissions
```hcl
resource "azuredevops_project" "example" {
name = "Example Project"
work_item_template = "Agile"
version_control = "Git"
visibility = "private"
description = "Managed by Terraform"
}

data "azuredevops_group" "example-readers" {
project_id = azuredevops_project.example.id
name = "Readers"
}

resource "azuredevops_build_folder_permissions" "example" {
project_id = azuredevops_project.example.id
path = "\\"
principal = data.azuredevops_group.example-readers.id

permissions = {
"RetainIndefinitely": "Allow"
}
}
```

## Argument Reference

Expand Down