chore: Extend test coverage for notebooks (#4237)

<!-- summary of changes -->

- Added more tests for the warehouse parameter
- Added validation tests
- Added integration test for setting a non-existing warehouse

Author: sfc-gh-mkowalski

CONTRIBUTING.md

@@ -106,7 +106,7 @@ We believe that code following the same conventions is easier to maintain and ex
 
 ### Introducing a new part of the SDK
 
-To create new objects in our SDK we use quickly created generator that outputs the majority of the files needed. These files should be later edited and filled with the missing parts. We plan to improve the generator later on, but it should be enough for now. Please read more in the [generator readme](pkg/sdk/poc/README.md).
+To create new objects in our SDK we use quickly created generator that outputs the majority of the files needed. These files should be later edited and filled with the missing parts. We plan to improve the generator later on, but it should be enough for now. Please read more in the [generator readme](pkg/sdk/generator/README.md).
 
 ### Test the change
 Every introduced change should be tested. Depending on the type of the change it may require (any or mix of):

docs/resources/notebook.md

@@ -9,6 +9,8 @@ description: |-
 
 -> **Note** `secrets` is currently not supported. It will be supported in the following versions of the provider which may still affect this resource.
 
+-> **Note** `warehouse` and `query_warehouse` parameters can only be set to upper-case identifiers.
+
 !> **Caution: Preview Feature** This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to `preview_features_enabled` field in the [provider configuration](https://registry.terraform.io/providers/snowflakedb/snowflake/latest/docs#schema). Please always refer to the [Getting Help](https://github.com/snowflakedb/terraform-provider-snowflake?tab=readme-ov-file#getting-help) section in our Github repo to best determine how to get help for your questions.
 
 # snowflake_notebook (Resource)
@@ -62,9 +64,9 @@ resource "snowflake_notebook" "complete" {
 - `from` (Block List) Specifies the location in a stage of an .ipynb file from which the notebook should be created. MAIN_FILE parameter a user-specified identifier for the notebook file name must also be set alongside it. (see [below for nested schema](#nestedblock--from))
 - `idle_auto_shutdown_time_seconds` (Number) Specifies the number of seconds of idle time before the notebook is shut down automatically.
 - `main_file` (String) Specifies a user-specified identifier for the notebook file name.
-- `query_warehouse` (String) Specifies the warehouse where SQL queries in the notebook are run.
+- `query_warehouse` (String) Specifies the warehouse where SQL queries in the notebook are run. Only upper-case identifiers are supported.
 - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
-- `warehouse` (String) Specifies the warehouse that runs the notebook kernel and python code.
+- `warehouse` (String) Specifies the warehouse that runs the notebook kernel and python code. Only upper-case identifiers are supported.
 
 ### Read-Only
 

pkg/acceptance/helpers/schema_client.go

@@ -2,6 +2,7 @@ package helpers
 
 import (
 	"context"
+	"fmt"
 	"testing"
 
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk"
@@ -154,3 +155,13 @@ func (c *SchemaClient) Alter(t *testing.T, id sdk.DatabaseObjectIdentifier, opts
 	err := c.client().Alter(ctx, id, opts)
 	require.NoError(t, err)
 }
+
+func (c *SchemaClient) AlterDefaultStreamlitNotebookWarehouse(t *testing.T, id sdk.DatabaseObjectIdentifier, warehouse sdk.AccountObjectIdentifier) {
+	t.Helper()
+	ctx := context.Background()
+
+	query := fmt.Sprintf(`ALTER SCHEMA %s SET DEFAULT_STREAMLIT_NOTEBOOK_WAREHOUSE = '%s'`, id.FullyQualifiedName(), warehouse.Name())
+
+	_, err := c.context.client.ExecForTests(ctx, query)
+	require.NoError(t, err)
+}

pkg/resources/notebook.go

@@ -78,7 +78,7 @@ var notebookSchema = map[string]*schema.Schema{
 	"query_warehouse": {
 		Type:             schema.TypeString,
 		Optional:         true,
-		Description:      "Specifies the warehouse where SQL queries in the notebook are run.",
+		Description:      "Specifies the warehouse where SQL queries in the notebook are run. Only upper-case identifiers are supported.",
 		ValidateDiagFunc: IsValidIdentifier[sdk.AccountObjectIdentifier](),
 		DiffSuppressFunc: suppressIdentifierQuoting,
 	},
@@ -91,7 +91,7 @@ var notebookSchema = map[string]*schema.Schema{
 	"warehouse": {
 		Type:             schema.TypeString,
 		Optional:         true,
-		Description:      "Specifies the warehouse that runs the notebook kernel and python code.",
+		Description:      "Specifies the warehouse that runs the notebook kernel and python code. Only upper-case identifiers are supported.",
 		ValidateDiagFunc: IsValidIdentifier[sdk.AccountObjectIdentifier](),
 		DiffSuppressFunc: suppressIdentifierQuoting,
 	},

pkg/sdk/notebooks_gen_test.go

@@ -125,7 +125,8 @@ func TestInt_Notebooks(t *testing.T) {
 
 		request := sdk.NewCreateNotebookRequest(id)
 
-		err := client.Notebooks.Create(ctx, request)
+		_, notebookCleanup := testClientHelper().Notebook.CreateWithRequest(t, request)
+		t.Cleanup(notebookCleanup)
 
 		computePool, computePoolCleanup := testClientHelper().ComputePool.Create(t)
 		t.Cleanup(computePoolCleanup)
@@ -146,7 +147,7 @@ func TestInt_Notebooks(t *testing.T) {
 
 		alterRequest := sdk.NewAlterNotebookRequest(id).WithSet(*setRequest)
 
-		err = client.Notebooks.Alter(ctx, alterRequest)
+		err := client.Notebooks.Alter(ctx, alterRequest)
 		require.NoError(t, err)
 
 		updatedNotebook, err := client.Notebooks.ShowByID(ctx, id)
@@ -196,6 +197,20 @@ func TestInt_Notebooks(t *testing.T) {
 		)
 	})
 
+	t.Run("alter: set non-existing warehouse", func(t *testing.T) {
+		id := testClientHelper().Ids.RandomSchemaObjectIdentifier()
+		request := sdk.NewCreateNotebookRequest(id)
+
+		_, notebookCleanup := testClientHelper().Notebook.CreateWithRequest(t, request)
+		t.Cleanup(notebookCleanup)
+
+		setRequest := sdk.NewNotebookSetRequest().WithWarehouse(sdk.NewAccountObjectIdentifier("invalid warehouse"))
+		alterRequest := sdk.NewAlterNotebookRequest(id).WithSet(*setRequest)
+
+		err := client.Notebooks.Alter(ctx, alterRequest)
+		require.Error(t, err)
+	})
+
 	t.Run("alter: unset", func(t *testing.T) {
 		id := testClientHelper().Ids.RandomSchemaObjectIdentifier()
 

pkg/sdk/testint/notebooks_integration_test.go

@@ -2,13 +2,16 @@ package testacc
 
 import (
 	"fmt"
+	"regexp"
 	"strconv"
 	"testing"
 
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/assert"
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/assert/invokeactionassert"
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/assert/objectassert"
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/assert/resourceassert"
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/assert/resourceshowoutputassert"
+	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/config"
 	accconfig "github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/config"
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/bettertestspoc/config/model"
 	"github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/acceptance/helpers/random"
@@ -22,7 +25,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/tfversion"
 )
 
-func TestAcc_Notebook_BasisUseCase(t *testing.T) {
+func TestAcc_Notebook_BasicUseCase(t *testing.T) {
 	id := testClient().Ids.RandomSchemaObjectIdentifier()
 	comment := random.Comment()
 
@@ -554,7 +557,6 @@ func TestAcc_Notebook_ExternalWarehouseChange(t *testing.T) {
 	t.Cleanup(warehouseCleanup)
 
 	modelBasic := model.NotebookFromId("test", id)
-	warehouseNoQuotes := warehouse.ID().FullyQualifiedName()[1 : len(warehouse.ID().FullyQualifiedName())-1]
 
 	resource.Test(t, resource.TestCase{
 		ProtoV6ProviderFactories: TestAccProtoV6ProviderFactories,
@@ -607,8 +609,8 @@ func TestAcc_Notebook_ExternalWarehouseChange(t *testing.T) {
 				ConfigPlanChecks: resource.ConfigPlanChecks{
 					PreApply: []plancheck.PlanCheck{
 						plancheck.ExpectResourceAction(modelBasic.ResourceReference(), plancheck.ResourceActionUpdate),
-						planchecks.ExpectDrift("snowflake_notebook.test", "warehouse", nil, sdk.String(warehouseNoQuotes)),
-						planchecks.ExpectChange("snowflake_notebook.test", "warehouse", tfjson.ActionUpdate, sdk.String(warehouseNoQuotes), nil),
+						planchecks.ExpectDrift("snowflake_notebook.test", "warehouse", nil, sdk.String(warehouse.ID().Name())),
+						planchecks.ExpectChange("snowflake_notebook.test", "warehouse", tfjson.ActionUpdate, sdk.String(warehouse.ID().Name()), nil),
 					},
 				},
 				Check: assertThat(t,
@@ -644,3 +646,106 @@ func TestAcc_Notebook_ExternalWarehouseChange(t *testing.T) {
 		},
 	})
 }
+
+func TestAcc_notebook_WarehouseSchemaLevelChange(t *testing.T) {
+	schema, schemaCleanup := testClient().Schema.CreateSchema(t)
+	t.Cleanup(schemaCleanup)
+
+	id := testClient().Ids.RandomSchemaObjectIdentifierInSchema(schema.ID())
+
+	warehouse, warehouseCleanup := testClient().Warehouse.CreateWarehouse(t)
+	t.Cleanup(warehouseCleanup)
+
+	modelBasic := model.NotebookFromId("test", id)
+
+	assertBasic := []assert.TestCheckFuncProvider{
+		objectassert.Notebook(t, id).
+			HasName(id.Name()).
+			HasDatabaseName(id.DatabaseName()).
+			HasSchemaName(id.SchemaName()).
+			HasNoComment().
+			HasOwner(snowflakeroles.Accountadmin.Name()).
+			HasOwnerRoleType("ROLE").
+			HasCodeWarehouse(sdk.NewAccountObjectIdentifier("\"SYSTEM$STREAMLIT_NOTEBOOK_WH\"")),
+		resourceassert.NotebookResource(t, modelBasic.ResourceReference()).
+			HasNameString(id.Name()).
+			HasDatabaseString(id.DatabaseName()).
+			HasSchemaString(id.SchemaName()).
+			HasNoFromString().
+			HasNoMainFile().
+			HasNoQueryWarehouse().
+			HasNoIdleAutoShutdownTimeSeconds().
+			HasNoWarehouse().
+			HasCommentString("").
+			HasFullyQualifiedNameString(id.FullyQualifiedName()),
+		resourceshowoutputassert.NotebookShowOutput(t, modelBasic.ResourceReference()).
+			HasCreatedOnNotEmpty().
+			HasName(id.Name()).
+			HasDatabaseName(id.DatabaseName()).
+			HasSchemaName(id.SchemaName()).
+			HasQueryWarehouse(sdk.NewAccountObjectIdentifier("")).
+			HasCodeWarehouse(sdk.NewAccountObjectIdentifier("\"SYSTEM$STREAMLIT_NOTEBOOK_WH\"")).
+			HasOwner(snowflakeroles.Accountadmin.Name()).
+			HasOwnerRoleType("ROLE").
+			HasComment(""),
+		assert.Check(resource.TestCheckResourceAttr(modelBasic.ResourceReference(), "describe_output.0.name", id.Name())),
+		assert.Check(resource.TestCheckResourceAttr(modelBasic.ResourceReference(), "describe_output.0.main_file", "notebook_app.ipynb")),
+		assert.Check(resource.TestCheckResourceAttr(modelBasic.ResourceReference(), "describe_output.0.query_warehouse", "")),
+		assert.Check(resource.TestCheckResourceAttr(modelBasic.ResourceReference(), "describe_output.0.idle_auto_shutdown_time_seconds", "1800")),
+		assert.Check(resource.TestCheckResourceAttr(modelBasic.ResourceReference(), "describe_output.0.code_warehouse", "SYSTEM$STREAMLIT_NOTEBOOK_WH")),
+		assert.Check(resource.TestCheckResourceAttr(modelBasic.ResourceReference(), "describe_output.0.owner", snowflakeroles.Accountadmin.Name())),
+		assert.Check(resource.TestCheckResourceAttr(modelBasic.ResourceReference(), "describe_output.0.comment", "")),
+	}
+
+	resource.Test(t, resource.TestCase{
+		ProtoV6ProviderFactories: TestAccProtoV6ProviderFactories,
+		TerraformVersionChecks: []tfversion.TerraformVersionCheck{
+			tfversion.RequireAbove(tfversion.Version1_5_0),
+		},
+		CheckDestroy: CheckDestroy(t, resources.Notebook),
+		Steps: []resource.TestStep{
+			{
+				Config: accconfig.FromModels(t, modelBasic),
+				Check:  assertThat(t, assertBasic...),
+			},
+			{
+				PreConfig: func() {
+					testClient().Schema.AlterDefaultStreamlitNotebookWarehouse(t, sdk.NewDatabaseObjectIdentifier(id.DatabaseName(), id.SchemaName()), warehouse.ID())
+				},
+				Config: accconfig.FromModels(t, modelBasic),
+				Check:  assertThat(t, assertBasic...),
+			},
+		},
+	})
+}
+
+func TestAcc_Notebook_Validations(t *testing.T) {
+	id := testClient().Ids.RandomSchemaObjectIdentifier()
+
+	modelInvalidIdleAutoShutdownTimeSeconds := model.NotebookFromId("test", id).WithIdleAutoShutdownTimeSeconds(0)
+
+	stage := testClient().Ids.RandomSchemaObjectIdentifier()
+	path := "test/path"
+
+	modelFromWithoutMainFile := model.NotebookFromId("test", id).WithFrom(path, stage)
+
+	resource.Test(t, resource.TestCase{
+		ProtoV6ProviderFactories: TestAccProtoV6ProviderFactories,
+		TerraformVersionChecks: []tfversion.TerraformVersionCheck{
+			tfversion.RequireAbove(tfversion.Version1_5_0),
+		},
+		CheckDestroy: CheckDestroy(t, resources.Notebook),
+		Steps: []resource.TestStep{
+			{
+				Config:      config.FromModels(t, modelInvalidIdleAutoShutdownTimeSeconds),
+				PlanOnly:    true,
+				ExpectError: regexp.MustCompile(`expected idle_auto_shutdown_time_seconds to be at least \(1\), got 0`),
+			},
+			{
+				Config:      config.FromModels(t, modelFromWithoutMainFile),
+				PlanOnly:    true,
+				ExpectError: regexp.MustCompile("\"from\": all of `from,main_file` must be specified"),
+			},
+		},
+	})
+}

pkg/testacc/resource_notebook_acceptance_test.go

@@ -13,6 +13,8 @@ description: |-
 
 -> **Note** `secrets` is currently not supported. It will be supported in the following versions of the provider which may still affect this resource.
 
+-> **Note** `warehouse` and `query_warehouse` parameters can only be set to upper-case identifiers.
+
 !> **Caution: Preview Feature** This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to `preview_features_enabled` field in the [provider configuration](https://registry.terraform.io/providers/snowflakedb/snowflake/latest/docs#schema). Please always refer to the [Getting Help](https://github.com/snowflakedb/terraform-provider-snowflake?tab=readme-ov-file#getting-help) section in our Github repo to best determine how to get help for your questions.
 
 # {{.Name}} ({{.Type}})