Document alert rules and add tests

Author: jianyuan

Diff for: docs/resources/rule.md

@@ -1,6 +1,6 @@
 # sentry_rule Resource
 
-Sentry Rule resource.
+Sentry Rule resource. Note that there's no public documentation for the values of conditions, filters, and actions. You can either inspect the request payload sent when creating or editing an alert rule on Sentry or inspect [Sentry's rules registry in the source code](https://github.com/getsentry/sentry/tree/master/src/sentry/rules).
 
 ## Example Usage
 
@@ -15,17 +15,24 @@ resource "sentry_rule" "default" {
 
   conditions = [
     {
-      id       = "sentry.rules.conditions.event_frequency.EventFrequencyCondition"
-      value    = 500
-      interval = "1h"
+      id   = "sentry.rules.conditions.first_seen_event.FirstSeenEventCondition"
+      name = "A new issue is created"
+    }
+  ]
+
+  filters = [
+    {
+      id         = "sentry.rules.filters.assigned_to.AssignedToFilter"
+      targetType = "Unassigned"
     }
   ]
 
   actions = [
     {
-      id        = "sentry.integrations.slack.notify_action.SlackNotifyServiceAction"
-      channel   = "#alerts"
-      workspace = "12345"
+      id               = "sentry.mail.actions.NotifyEmailAction"
+      name             = "Send an email to IssueOwners"
+      targetIdentifier = ""
+      targetType       = "IssueOwners"
     }
   ]
 }
@@ -37,19 +44,19 @@ The following arguments are supported:
 
 - `organization` - (Required) The slug of the organization the plugin should be enabled for.
 - `project` - (Required) The slug of the project the plugin should be enabled for.
-- `action_match` - (Optional) Use `all` to trigger alerting when all conditions are met, and `any` when at least a condition is met. Defaults to `any`.
+- `name` - (Required) Name for this alert.
+- `action_match` - (Optional) Use `all` to trigger alerting when all conditions are met, and `any` when at. least a condition is met. Defaults to `any`.
 - `frequency` - (Optional) Perform actions at most once every `X` minutes for this issue. Defaults to `30`.
-- `environment` - (Optional) Environment name
-- `actions` - (Required) List of actions
-- `conditions` - (Required) List of conditions
+- `environment` - (Optional) Environment for these conditions to apply to.
+- `conditions` - (Required) List of conditions.
+- `filters` - (Optional) List of filters.
+- `actions` - (Required) List of actions.
 
 ## Attribute Reference
 
 The following attributes are exported:
 
 - `id` - The ID of the created rule.
 - `name` - The name of the created rule.
-- `actions` - The rule's actions.
-- `conditions` - The rule's conditions.
 - `frequency` - The rule's frequency.
 - `environment` - The rule's environment.

Diff for: go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/dghubble/sling v1.3.0 // indirect
 	github.com/fatih/color v1.9.0 // indirect
 	github.com/go-git/go-git/v5 v5.2.0 // indirect
-	github.com/hashicorp/errwrap v1.1.0
+	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-hclog v0.14.1 // indirect
 	github.com/hashicorp/go-multierror v1.1.0 // indirect
 	github.com/hashicorp/go-uuid v1.0.2 // indirect

Diff for: sentry/resource_sentry_project_rule.go

@@ -4,7 +4,6 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/hashicorp/errwrap"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/jianyuan/go-sentry/sentry"
 	"github.com/mitchellh/mapstructure"
@@ -68,7 +67,7 @@ func resourceSentryRule() *schema.Resource {
 			},
 			"filters": {
 				Type:     schema.TypeList,
-				Required: true,
+				Optional: true,
 				Elem: &schema.Schema{
 					Type: schema.TypeMap,
 				},
@@ -195,15 +194,6 @@ func resourceSentryRuleRead(d *schema.ResourceData, meta interface{}) error {
 
 	d.SetId(rule.ID)
 	d.Set("name", rule.Name)
-	if err := d.Set("actions", rule.Actions); err != nil {
-		return errwrap.Wrapf("Unable to store rule 'actions' attribute: {{err}}", err)
-	}
-	if err := d.Set("conditions", rule.Conditions); err != nil {
-		return errwrap.Wrapf("Unable to store rule 'conditions' attribute: {{err}}", err)
-	}
-	if err := d.Set("filters", rule.Filters); err != nil {
-		return errwrap.Wrapf("Unable to store rule 'filters' attribute: {{err}}", err)
-	}
 	d.Set("frequency", rule.Frequency)
 	d.Set("environment", rule.Environment)
 
@@ -238,13 +228,13 @@ func resourceSentryRuleUpdate(d *schema.ResourceData, meta interface{}) error {
 	conditions := make([]sentry.ConditionType, len(inputConditions))
 	for i, ic := range inputConditions {
 		var condition sentry.ConditionType
-		mapstructure.Decode(ic, &condition)
+		mapstructure.WeakDecode(ic, &condition)
 		conditions[i] = condition
 	}
 	actions := make([]sentry.ActionType, len(inputActions))
 	for i, ia := range inputActions {
 		var action sentry.ActionType
-		mapstructure.Decode(ia, &action)
+		mapstructure.WeakDecode(ia, &action)
 		actions[i] = action
 	}
 	filters := make([]sentry.FilterType, len(inputFilters))

Diff for: sentry/resource_sentry_project_rule_test.go

@@ -0,0 +1,129 @@
+package sentry
+
+import (
+	"errors"
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+	"github.com/jianyuan/go-sentry/sentry"
+)
+
+func TestAccSentryProjectRule_basic(t *testing.T) {
+	var rule sentry.Rule
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckSentryProjectRuleDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccSentryProjectRuleConfig,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckSentryProjectRuleExists("sentry_rule.test_rule", &rule),
+					resource.TestCheckResourceAttr("sentry_rule.test_rule", "name", "Test rule"),
+					resource.TestCheckResourceAttr("sentry_rule.test_rule", "environment", ""),
+					resource.TestCheckResourceAttr("sentry_rule.test_rule", "frequency", "30"),
+				),
+			},
+		},
+	})
+}
+
+func testAccCheckSentryProjectRuleDestroy(s *terraform.State) error {
+	client := testAccProvider.Meta().(*sentry.Client)
+
+	for _, rs := range s.RootModule().Resources {
+		if rs.Type != "sentry_rule" {
+			continue
+		}
+
+		rules, resp, err := client.Rules.List(testOrganization, rs.Primary.Attributes["project"])
+		if err == nil {
+			for _, rule := range rules {
+				if rule.ID == rs.Primary.ID {
+					return errors.New("Project rule still exists")
+				}
+			}
+		}
+		if resp.StatusCode != 404 {
+			return err
+		}
+		return nil
+	}
+
+	return nil
+}
+
+func testAccCheckSentryProjectRuleExists(n string, rule *sentry.Rule) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs, ok := s.RootModule().Resources[n]
+		if !ok {
+			return fmt.Errorf("Not found: %s", n)
+		}
+
+		if rs.Primary.ID == "" {
+			return errors.New("No project ID is set")
+		}
+
+		client := testAccProvider.Meta().(*sentry.Client)
+		sentryRules, _, err := client.Rules.List(
+			rs.Primary.Attributes["organization"],
+			rs.Primary.Attributes["project"],
+		)
+		if err != nil {
+			return err
+		}
+		for _, sentryRule := range sentryRules {
+			if sentryRule.ID == rs.Primary.ID {
+				*rule = sentryRule
+				break
+			}
+		}
+		return nil
+	}
+}
+
+var testAccSentryProjectRuleConfig = fmt.Sprintf(`
+resource "sentry_team" "test_team" {
+	organization = "%s"
+	name         = "Test team"
+}
+
+resource "sentry_project" "test_project" {
+	organization = "%s"
+	team         = "${sentry_team.test_team.id}"
+	name         = "Test project"
+	platform     = "go"
+}
+
+resource "sentry_rule" "test_rule" {
+	organization = "%s"
+	project      = "${sentry_project.test_project.id}"
+	name         = "Test rule"
+
+	conditions = [
+		{
+			id   = "sentry.rules.conditions.first_seen_event.FirstSeenEventCondition"
+			name = "A new issue is created"
+		}
+	]
+
+	filters = [
+		{
+			id         = "sentry.rules.filters.assigned_to.AssignedToFilter"
+			targetType = "Unassigned"
+		}
+	]
+
+	actions = [
+		{
+			id               = "sentry.mail.actions.NotifyEmailAction"
+			name             = "Send an email to IssueOwners"
+			targetIdentifier = ""
+			targetType       = "IssueOwners"
+		}
+	]
+}
+`, testOrganization, testOrganization, testOrganization)