Support erasing a schedule that was defined out of band

Author: pietern

sqlanalytics/resource_query.go

@@ -283,6 +283,15 @@ func (q *QueryEntity) fromAPIObject(aq *api.Query, schema map[string]*schema.Sch
 	q.Tags = append([]string{}, aq.Tags...)
 
 	if s := aq.Schedule; s != nil {
+		// Set `schedule` to non-empty value to ensure it's picked up by `StructToSchema`.
+		// If it is not yet set in `schema.ResourceData`, then `StructToSchema` mistakingly
+		// interprets the server side value as a default and skips the field.
+		// This means, however, that if the schedule is configured out-of-band (e.g. manually),
+		// running `terraform apply` again won't remove the setting.
+		data.Set("schedule", []interface{}{
+			map[string][]interface{}{},
+		})
+
 		q.Schedule = &QuerySchedule{}
 		switch {
 		case s.Interval%secondsInWeek == 0:

sqlanalytics/resource_query_test.go

@@ -306,6 +306,33 @@ func TestQueryRead(t *testing.T) {
 	assert.Equal(t, "foo", d.Id())
 }
 
+func TestQueryReadWithSchedule(t *testing.T) {
+	// Note: this tests that if a schedule is returned by the API,
+	// it will always show up in the resulting resource data.
+	// If it doesn't, we wouldn't be able to erase a schedule
+	// that was defined out of band.
+	d, err := qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/preview/sql/queries/foo",
+				Response: api.Query{
+					ID: "foo",
+					Schedule: &api.QuerySchedule{
+						Interval: 12345,
+					},
+				},
+			},
+		},
+		Resource: ResourceQuery(),
+		Read:     true,
+		ID:       "foo",
+	}.Apply(t)
+
+	assert.NoError(t, err, err)
+	assert.Equal(t, 12345, d.Get("schedule.0.continuous.0.interval_seconds"))
+}
+
 func TestQueryUpdate(t *testing.T) {
 	d, err := qa.ResourceFixture{
 		Fixtures: []qa.HTTPFixture{