Merge pull request #176 from dbt-labs/release-0.2.5

New Release 0.2.5 with a few fixes

Author: b-per

CHANGELOG.md

@@ -2,7 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
-## [Unreleased](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.4...HEAD)
+## [Unreleased](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.5...HEAD)
+
+## [0.2.5](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.4...v0.2.5)
+
+## Fixes
+
+- [#172](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/172): Fix issue when changing the schedule of jobs from a list of hours to an interval in a [dbtcloud_job](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/job)
+- [#175](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/175): Fix issue when modifying the `environment_id` of an existing [dbtcloud_job](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/job)
+- [#154](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/154): Allow the creation of [Databricks connections](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/connection) using Service Tokens when it was only possible with User Tokens before
+
+## Changes
+
+- Use the `v2/users/<id>` endpoint to get the groups of a user
 
 ## [0.2.4](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.3...v0.2.4)
 
@@ -12,9 +24,9 @@ All notable changes to this project will be documented in this file.
 
 ## Changes
 
-- [171](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/171) Add the ability to define which environment is the production one (to be used with cross project references in dbt Cloud)
-- Add guide on how to use the Hashicorp HTTP provider
-- [174](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/174) Add the ability to assign User groups to dbt Cloud users.
+- [#171](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/171) Add the ability to define which [environment](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/environment) is the production one (to be used with cross project references in dbt Cloud)
+- Add [guide](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/guides/2_leveraging_http_provider) on how to use the Hashicorp HTTP provider
+- [#174](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/174) Add the ability to assign User groups to dbt Cloud users.
 
 ## [0.2.3](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.2...v0.2.3)
 
@@ -25,27 +37,27 @@ All notable changes to this project will be documented in this file.
 
 ## Changes
 
-- [164](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/164) Add the ability to define `priority` and `execution_project` for BigQuery connections
-- [168](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/168) Add the ability to set up email notifications (to internal users and external email addresses) based on jobs results
+- [164](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/164) Add the ability to define `priority` and `execution_project` for [BigQuery connections](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/bigquery_connection)
+- [168](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/168) Add the ability to set up [email notifications](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/resources/notification) (to internal users and external email addresses) based on jobs results
 
 ## [0.2.2](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.1...v0.2.2)
 
 ## Fixes
 
-- [156](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/156) Fix the `dbtcloud_connection` for Databricks when updating the `http_path` or `catalog` + add integration test
-- [157](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/157) Fix updating an environment with credentials already set + add integration test
+- [#156](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/156) Fix the `dbtcloud_connection` for Databricks when updating the `http_path` or `catalog` + add integration test
+- [#157](https://github.com/dbt-labs/terraform-provider-dbtcloud/issues/157) Fix updating an environment with credentials already set + add integration test
 
 ## Changes
 
-- Add guide to get started with the provider
+- Add [guide](https://registry.terraform.io/providers/dbt-labs/dbtcloud/latest/docs/guides/1_getting_started) to get started with the provider
 - Add missing import and fix more docs
 - Update docs template to allow using Subcategories later
 
 ## [0.2.1](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.2.0...v0.2.1)
 
 ## Changes
 
-- Resources deleted from dbt Cloud won't crash the provider and we now consider the resource as deleted, removing it from the state. This is the expected behaviour of a provider.
+- Resources deleted from dbt Cloud won't crash the provider and we now consider the resource as deleted, removing it from the state. This is the expected behavior of a provider.
 - Add examples in the docs to resources that didn't have any so far
 
 ## [0.2.0](https://github.com/dbt-labs/terraform-provider-dbtcloud/compare/v0.1.12...v0.2.0)

pkg/dbt_cloud/connection.go

@@ -2,7 +2,6 @@ package dbt_cloud
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
 	"net/http"
 	"strconv"
@@ -52,15 +51,16 @@ type ConnectionResponse struct {
 }
 
 type Adapter struct {
-	ID             *int            `json:"id,omitempty"`
-	AccountID      int             `json:"account_id"`
-	ProjectID      int             `json:"project_id"`
-	CreatedByID    int             `json:"created_by_id"`
-	Metadata       AdapterMetadata `json:"metadata_json"`
-	State          int             `json:"state"`
-	AdapterVersion string          `json:"adapter_version"`
-	CreatedAt      *string         `json:"created_at,omitempty"`
-	UpdatedAt      *string         `json:"updated_at,omitempty"`
+	ID                      *int            `json:"id,omitempty"`
+	AccountID               int             `json:"account_id"`
+	ProjectID               int             `json:"project_id"`
+	CreatedByID             *int            `json:"created_by_id,omitempty"`
+	CreatedByServiceTokenID *int            `json:"created_by_service_token_id,omitempty"`
+	Metadata                AdapterMetadata `json:"metadata_json"`
+	State                   int             `json:"state"`
+	AdapterVersion          string          `json:"adapter_version"`
+	CreatedAt               *string         `json:"created_at,omitempty"`
+	UpdatedAt               *string         `json:"updated_at,omitempty"`
 }
 
 type AdapterMetadata struct {
@@ -104,9 +104,6 @@ func (c *Client) CreateConnection(projectID int, name string, connectionType str
 	if connectionType == "adapter" {
 		adapterId, err := c.createDatabricksAdapter(projectID, state)
 		if err != nil {
-			if strings.Contains(err.Error(), "This endpoint cannot be accessed with a service token") {
-				return nil, errors.New("to create an adapter typed connection, you need to use a user token. A service token can not be used to create adapters")
-			}
 			return nil, err
 		}
 
@@ -211,17 +208,12 @@ func (c *Client) DeleteConnection(connectionID, projectID string) (string, error
 }
 
 func (c *Client) createDatabricksAdapter(projectID int, state int) (*int, error) {
-	currentUser, err := c.GetConnectedUser()
-	if err != nil {
-		return nil, err
-	}
 
 	newAdapter := Adapter{
 		ID:             nil,
 		AdapterVersion: "databricks_v0",
 		ProjectID:      projectID,
 		AccountID:      c.AccountID,
-		CreatedByID:    currentUser.ID,
 		State:          state,
 		Metadata: AdapterMetadata{
 			Title:     "Databricks",
@@ -230,6 +222,22 @@ func (c *Client) createDatabricksAdapter(projectID int, state int) (*int, error)
 		},
 	}
 
+	currentUser, err := c.GetConnectedUser()
+	if err != nil {
+		// if GetConnectedUser is the following specific error, it means that the user is using a service token
+		// as there is no way to get the current token ID, we always use 1
+		if strings.Contains(err.Error(), "This endpoint cannot be accessed with a service token") {
+			serviceTokenID := 1
+			newAdapter.CreatedByServiceTokenID = &serviceTokenID
+		} else {
+			// if the error is different, return it
+			return nil, err
+		}
+	} else {
+		// if there is no error, the user is using a user token
+		newAdapter.CreatedByID = &currentUser.ID
+	}
+
 	newAdapterData, err := json.Marshal(newAdapter)
 	if err != nil {
 		return nil, err

pkg/dbt_cloud/user.go

@@ -53,7 +53,7 @@ func (c *Client) GetUser(email string) (*User, error) {
 }
 
 func (c *Client) GetConnectedUser() (*User, error) {
-	req, err := http.NewRequest("GET", fmt.Sprintf("%s/v2/whoami", c.HostURL), nil)
+	req, err := http.NewRequest("GET", fmt.Sprintf("%s/v2/whoami/", c.HostURL), nil)
 	if err != nil {
 		return nil, err
 	}

pkg/dbt_cloud/user_groups.go

@@ -38,41 +38,8 @@ type AssignUserGroupsResponse struct {
 	Status ResponseStatus `json:"status"`
 }
 
-// the 2 following types are used to parse groups from /users/
-// they could be removed once we can call /users/{user_id}/
-type UserWithGroups struct {
-	ID     int          `json:"id"`
-	Email  string       `json:"email"`
-	Groups []Permission `json:"permissions"`
-}
-
-type UserListResponseWithGroups struct {
-	Data   []UserWithGroups `json:"data"`
-	Status ResponseStatus   `json:"status"`
-}
-
 func (c *Client) GetUserGroups(userId int) (*UserGroupsCurrentAccount, error) {
-
-	// TODO: the current endpoint is not working for service tokens, we could use it when it is updated
-	// in the meantime we use the /users/ endpoint and parse the groups from there
-
-	// req, err := http.NewRequest("GET", fmt.Sprintf("%s/v2/accounts/%s/users/%s/", c.HostURL, strconv.Itoa(c.AccountID), strconv.Itoa(userId)), nil)
-	// if err != nil {
-	// 	return nil, err
-	// }
-
-	// body, err := c.doRequest(req)
-	// if err != nil {
-	// 	return nil, err
-	// }
-
-	// userGroupsResponse := UserGroupsResponse{}
-	// err = json.Unmarshal(body, &userGroupsResponse)
-	// if err != nil {
-	// 	return nil, err
-	// }
-
-	req, err := http.NewRequest("GET", fmt.Sprintf("%s/v3/accounts/%s/users/?limit=1000", c.HostURL, strconv.Itoa(c.AccountID)), nil)
+	req, err := http.NewRequest("GET", fmt.Sprintf("%s/v2/accounts/%s/users/%s/", c.HostURL, strconv.Itoa(c.AccountID), strconv.Itoa(userId)), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -82,23 +49,16 @@ func (c *Client) GetUserGroups(userId int) (*UserGroupsCurrentAccount, error) {
 		return nil, err
 	}
 
-	userListResponse := UserListResponseWithGroups{}
-	err = json.Unmarshal(body, &userListResponse)
+	userGroupsResponse := UserGroupsResponse{}
+	err = json.Unmarshal(body, &userGroupsResponse)
 	if err != nil {
 		return nil, err
 	}
 
-	userGroupsPermissions := []Permission{}
-	for i, user := range userListResponse.Data {
-		if user.ID == userId {
-			userGroupsPermissions = userListResponse.Data[i].Groups
-		}
-	}
-
 	// the API returns the permissions for all accounts
 	// we just want to get the ones of the current account
 	userGroupsCurrentAccount := UserGroupsCurrentAccount{}
-	for _, permission := range userGroupsPermissions {
+	for _, permission := range userGroupsResponse.Data.Permissions {
 		if permission.AccountID == c.AccountID {
 			userGroupsCurrentAccount.Groups = append(userGroupsCurrentAccount.Groups, permission.Groups...)
 		}

pkg/resources/job.go

@@ -310,17 +310,37 @@ func resourceJobUpdate(ctx context.Context, d *schema.ResourceData, m interface{
 	c := m.(*dbt_cloud.Client)
 	jobId := d.Id()
 
-	if d.HasChange("name") || d.HasChange("dbt_version") || d.HasChange("num_threads") ||
-		d.HasChange("target_name") || d.HasChange("execute_steps") || d.HasChange("run_generate_sources") ||
-		d.HasChange("generate_docs") || d.HasChange("triggers") || d.HasChange("schedule_type") ||
-		d.HasChange("schedule_interval") || d.HasChange("schedule_hours") || d.HasChange("schedule_days") ||
-		d.HasChange("schedule_cron") || d.HasChange("deferring_job_id") || d.HasChange("self_deferring") ||
+	if d.HasChange("project_id") ||
+		d.HasChange("environment_id") ||
+		d.HasChange("name") ||
+		d.HasChange("dbt_version") ||
+		d.HasChange("num_threads") ||
+		d.HasChange("target_name") ||
+		d.HasChange("execute_steps") ||
+		d.HasChange("run_generate_sources") ||
+		d.HasChange("generate_docs") ||
+		d.HasChange("triggers") ||
+		d.HasChange("schedule_type") ||
+		d.HasChange("schedule_interval") ||
+		d.HasChange("schedule_hours") ||
+		d.HasChange("schedule_days") ||
+		d.HasChange("schedule_cron") ||
+		d.HasChange("deferring_job_id") ||
+		d.HasChange("self_deferring") ||
 		d.HasChange("timeout_seconds") {
 		job, err := c.GetJob(jobId)
 		if err != nil {
 			return diag.FromErr(err)
 		}
 
+		if d.HasChange("project_id") {
+			projectID := d.Get("project_id").(int)
+			job.Project_Id = projectID
+		}
+		if d.HasChange("environment_id") {
+			envID := d.Get("environment_id").(int)
+			job.Environment_Id = envID
+		}
 		if d.HasChange("name") {
 			name := d.Get("name").(string)
 			job.Name = name
@@ -375,9 +395,12 @@ func resourceJobUpdate(ctx context.Context, d *schema.ResourceData, m interface{
 			}
 			if len(d.Get("schedule_hours").([]interface{})) > 0 {
 				job.Schedule.Time.Hours = &scheduleHours
+				job.Schedule.Time.Type = "at_exact_hours"
+				job.Schedule.Time.Interval = 0
+			} else {
+				job.Schedule.Time.Hours = nil
+				job.Schedule.Time.Type = "every_hour"
 			}
-			job.Schedule.Time.Type = "at_exact_hours"
-			job.Schedule.Time.Interval = 0
 		}
 		if d.HasChange("schedule_days") {
 			scheduleDays := make([]int, len(d.Get("schedule_days").([]interface{})))

pkg/resources/job_acceptance_test.go

@@ -122,10 +122,17 @@ resource "dbtcloud_environment" "test_job_environment" {
     type = "development"
 }
 
+resource "dbtcloud_environment" "test_job_environment_new" {
+    project_id = dbtcloud_project.test_job_project.id
+    name = "DEPL %s"
+    dbt_version = "%s"
+    type = "deployment"
+}
+
 resource "dbtcloud_job" "test_job" {
   name        = "%s"
   project_id = dbtcloud_project.test_job_project.id
-  environment_id = dbtcloud_environment.test_job_environment.environment_id
+  environment_id = dbtcloud_environment.test_job_environment_new.environment_id
   dbt_version = "%s"
   execute_steps = [
     "dbt test"
@@ -145,7 +152,7 @@ resource "dbtcloud_job" "test_job" {
   schedule_hours = [9, 17]
   timeout_seconds = 180
 }
-`, projectName, environmentName, DBT_CLOUD_VERSION, jobName, DBT_CLOUD_VERSION)
+`, projectName, environmentName, DBT_CLOUD_VERSION, environmentName, DBT_CLOUD_VERSION, jobName, DBT_CLOUD_VERSION)
 }
 
 func testAccDbtCloudJobResourceDeferringJobConfig(jobName, jobName2, jobName3, projectName, environmentName string, selfDeferring bool) string {
@@ -158,17 +165,17 @@ resource "dbtcloud_project" "test_job_project" {
     name = "%s"
 }
 
-resource "dbtcloud_environment" "test_job_environment" {
+resource "dbtcloud_environment" "test_job_environment_new" {
     project_id = dbtcloud_project.test_job_project.id
-    name = "%s"
+    name = "DEPL %s"
     dbt_version = "%s"
-    type = "development"
+    type = "deployment"
 }
 
 resource "dbtcloud_job" "test_job" {
   name        = "%s"
   project_id = dbtcloud_project.test_job_project.id
-  environment_id = dbtcloud_environment.test_job_environment.environment_id
+  environment_id = dbtcloud_environment.test_job_environment_new.environment_id
   dbt_version = "%s"
   execute_steps = [
     "dbt test"
@@ -191,7 +198,7 @@ resource "dbtcloud_job" "test_job" {
 resource "dbtcloud_job" "test_job_2" {
   name        = "%s"
   project_id = dbtcloud_project.test_job_project.id
-  environment_id = dbtcloud_environment.test_job_environment.environment_id
+  environment_id = dbtcloud_environment.test_job_environment_new.environment_id
   execute_steps = [
     "dbt test"
   ]
@@ -207,7 +214,7 @@ resource "dbtcloud_job" "test_job_2" {
 resource "dbtcloud_job" "test_job_3" {
 	name        = "%s"
 	project_id = dbtcloud_project.test_job_project.id
-	environment_id = dbtcloud_environment.test_job_environment.environment_id
+	environment_id = dbtcloud_environment.test_job_environment_new.environment_id
 	execute_steps = [
 	  "dbt test"
 	]