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

Button up adding support for require_code_owners_review #70

Closed
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
20 changes: 17 additions & 3 deletions github/resource_github_branch_protection.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ func resourceGithubBranchProtection() *schema.Resource {
Optional: true,
Elem: &schema.Schema{Type: schema.TypeString},
},
"require_code_owner_reviews": {
Type: schema.TypeBool,
Optional: true,
},
},
},
},
Expand Down Expand Up @@ -187,6 +191,14 @@ func resourceGithubBranchProtectionUpdate(d *schema.ResourceData, meta interface
if err != nil {
return err
}

if protectionRequest.RequiredPullRequestReviews == nil {
_, err = client.Repositories.RemovePullRequestReviewEnforcement(context.TODO(), meta.(*Organization).name, r, b)
if err != nil {
return err
}
}

d.SetId(buildTwoPartID(&r, &b))

return resourceGithubBranchProtectionRead(d, meta)
Expand Down Expand Up @@ -268,9 +280,10 @@ func flattenRequiredPullRequestReviews(d *schema.ResourceData, protection *githu

if err := d.Set("required_pull_request_reviews", []interface{}{
map[string]interface{}{
"dismiss_stale_reviews": rprr.DismissStaleReviews,
"dismissal_users": schema.NewSet(schema.HashString, users),
"dismissal_teams": schema.NewSet(schema.HashString, teams),
"dismiss_stale_reviews": rprr.DismissStaleReviews,
"dismissal_users": schema.NewSet(schema.HashString, users),
"dismissal_teams": schema.NewSet(schema.HashString, teams),
"require_code_owner_reviews": rprr.RequireCodeOwnerReviews,
},
}); err != nil {
return err
Expand Down Expand Up @@ -363,6 +376,7 @@ func expandRequiredPullRequestReviews(d *schema.ResourceData) (*github.PullReque

rprr.DismissalRestrictionsRequest = drr
rprr.DismissStaleReviews = m["dismiss_stale_reviews"].(bool)
rprr.RequireCodeOwnerReviews = m["require_code_owner_reviews"].(bool)
}

return rprr, nil
Expand Down
10 changes: 8 additions & 2 deletions github/resource_github_branch_protection_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func TestAccGithubBranchProtection_basic(t *testing.T) {
testAccCheckGithubProtectedBranchExists("github_branch_protection.master", repoName+":master", &protection),
testAccCheckGithubBranchProtectionRequiredStatusChecks(&protection, true, []string{"github/foo"}),
testAccCheckGithubBranchProtectionRestrictions(&protection, []string{testUser}, []string{}),
testAccCheckGithubBranchProtectionPullRequestReviews(&protection, true, []string{testUser}, []string{}),
testAccCheckGithubBranchProtectionPullRequestReviews(&protection, true, []string{testUser}, []string{}, true),
resource.TestCheckResourceAttr("github_branch_protection.master", "repository", repoName),
resource.TestCheckResourceAttr("github_branch_protection.master", "branch", "master"),
resource.TestCheckResourceAttr("github_branch_protection.master", "enforce_admins", "true"),
Expand All @@ -38,6 +38,7 @@ func TestAccGithubBranchProtection_basic(t *testing.T) {
resource.TestCheckResourceAttr("github_branch_protection.master", "required_pull_request_reviews.0.dismiss_stale_reviews", "true"),
resource.TestCheckResourceAttr("github_branch_protection.master", "required_pull_request_reviews.0.dismissal_users.#", "1"),
resource.TestCheckResourceAttr("github_branch_protection.master", "required_pull_request_reviews.0.dismissal_teams.#", "0"),
resource.TestCheckResourceAttr("github_branch_protection.master", "required_pull_request_reviews.0.require_code_owner_reviews", "true"),
resource.TestCheckResourceAttr("github_branch_protection.master", "restrictions.0.users.#", "1"),
resource.TestCheckResourceAttr("github_branch_protection.master", "restrictions.0.teams.#", "0"),
),
Expand Down Expand Up @@ -180,7 +181,7 @@ func testAccCheckGithubBranchProtectionRestrictions(protection *github.Protectio
}
}

func testAccCheckGithubBranchProtectionPullRequestReviews(protection *github.Protection, expectedStale bool, expectedUsers, expectedTeams []string) resource.TestCheckFunc {
func testAccCheckGithubBranchProtectionPullRequestReviews(protection *github.Protection, expectedStale bool, expectedUsers, expectedTeams []string, expectedCodeOwners bool) resource.TestCheckFunc {
return func(s *terraform.State) error {
reviews := protection.RequiredPullRequestReviews
if reviews == nil {
Expand All @@ -207,6 +208,10 @@ func testAccCheckGithubBranchProtectionPullRequestReviews(protection *github.Pro
return fmt.Errorf("diff %q: (-got +want)\n%s", "dismissal_teams", diff)
}

if reviews.RequireCodeOwnerReviews != expectedCodeOwners {
return fmt.Errorf("Expected `require_code_owner_reviews` to be %t, got %t", expectedCodeOwners, reviews.RequireCodeOwnerReviews)
}

return nil
}
}
Expand Down Expand Up @@ -278,6 +283,7 @@ resource "github_branch_protection" "master" {
required_pull_request_reviews {
dismiss_stale_reviews = true
dismissal_users = ["%s"]
require_code_owner_reviews = true
}

restrictions {
Expand Down
3 changes: 2 additions & 1 deletion website/docs/r/branch_protection.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ The following arguments are supported:
* `dismiss_stale_reviews`: (Optional) Dismiss approved reviews automatically when a new commit is pushed. Defaults to `false`.
* `dismissal_users`: (Optional) The list of user logins with dismissal access
* `dismissal_teams`: (Optional) The list of team slugs with dismissal access
* `require_code_owner_reviews`: (Optional) Require an approved review in pull requests including files with a designated code owner. Defaults to `false`.

### Restrictions

Expand All @@ -82,4 +83,4 @@ Github Branch Protection can be imported using an id made up of `repository:bran

```
$ terraform import github_branch_protection.terraform terraform:master
```
```