Snow 2113906 enable release channels should default to false (#2323)

* enable_release_channels defaults to None

* fix integration tests

Author: sfc-gh-pczajka

RELEASE-NOTES.md

@@ -25,6 +25,16 @@
 ## Fixes and improvements
 
 
+# v3.8.2
+
+## Deprecations
+
+## New additions
+
+## Fixes and improvements
+* Fix `enable_release_channels` property in application package definition to default to `None` instead of `False`.
+
+
 # v3.8.1
 
 ## Deprecations

src/snowflake/cli/_plugins/nativeapp/entities/application_package.py

@@ -190,9 +190,9 @@ class ApplicationPackageEntityModel(EntityModelBaseWithArtifacts):
         title="Entities that will be bundled and deployed as part of this application package",
         default=[],
     )
-    enable_release_channels: bool = Field(
+    enable_release_channels: Optional[bool] = Field(
         title="Enable release channels for this application package",
-        default=False,
+        default=None,
     )
 
     @field_validator("children")
@@ -1559,13 +1559,16 @@ def _get_enable_release_channels_flag(self) -> Optional[bool]:
         If return value is None, it means do not explicitly set the flag.
         """
         value_from_snowflake_yml = self.model.enable_release_channels
-        feature_flag_from_config = FeatureFlag.ENABLE_RELEASE_CHANNELS.is_enabled()
-        if feature_flag_from_config and not value_from_snowflake_yml:
-            self._workspace_ctx.console.warning(
-                f"{FeatureFlag.ENABLE_RELEASE_CHANNELS.name} value in config.toml is deprecated."
-                f" Set [enable_release_channels] for the application package in snowflake.yml instead."
-            )
-        enable_release_channels = value_from_snowflake_yml or feature_flag_from_config
+        feature_flag_from_config = FeatureFlag.ENABLE_RELEASE_CHANNELS.get_value()
+        if value_from_snowflake_yml is not None:
+            enable_release_channels = value_from_snowflake_yml
+        else:
+            enable_release_channels = feature_flag_from_config
+            if feature_flag_from_config is not None:
+                self._workspace_ctx.console.warning(
+                    f"{FeatureFlag.ENABLE_RELEASE_CHANNELS.name} value in config.toml is deprecated."
+                    f" Set [enable_release_channels] for the application package in snowflake.yml instead."
+                )
 
         feature_enabled_in_account = (
             get_snowflake_facade().get_ui_parameter(

tests/nativeapp/test_application_package_entity.py

@@ -140,7 +140,7 @@ def test_bundle(project_directory):
 @mock.patch(f"{APP_PACKAGE_ENTITY}.validate_setup_script")
 @mock.patch(f"{APPLICATION_PACKAGE_ENTITY_MODULE}.sync_deploy_root_with_stage")
 @mock.patch(SQL_FACADE_GET_UI_PARAMETER, return_value="ENABLED")
-@pytest.mark.parametrize("enable_release_channels", [False, True])
+@pytest.mark.parametrize("enable_release_channels", [False, True, None])
 def test_deploy(
     mock_get_parameter,
     mock_sync,
@@ -193,18 +193,26 @@ def test_deploy(
                 mock.call("describe application package pkg"),
             ),
             (None, mock.call("use role old_role")),
-            (
-                mock_cursor([("old_role",)], []),
-                mock.call("select current_role()"),
-            ),
-            (None, mock.call("use role app_role")),
-            (
-                None,
-                mock.call(
-                    f"alter application package pkg\n    set enable_release_channels = {enable_release_channels}\n".lower()
+        ]
+        + (
+            []
+            if enable_release_channels is None
+            else [
+                (
+                    mock_cursor([("old_role",)], []),
+                    mock.call("select current_role()"),
                 ),
-            ),
-            (None, mock.call("use role old_role")),
+                (None, mock.call("use role app_role")),
+                (
+                    None,
+                    mock.call(
+                        f"alter application package pkg\n    set enable_release_channels = {enable_release_channels}\n".lower()
+                    ),
+                ),
+                (None, mock.call("use role old_role")),
+            ]
+        )
+        + [
             (
                 mock_cursor([("old_role",)], []),
                 mock.call("select current_role()"),
@@ -311,18 +319,6 @@ def test_deploy_w_stage_subdir(
                 mock.call("select current_role()"),
             ),
             (None, mock.call("use role app_role")),
-            (
-                None,
-                mock.call(
-                    "alter application package pkg\n    set enable_release_channels = false\n"
-                ),
-            ),
-            (None, mock.call("use role old_role")),
-            (
-                mock_cursor([("old_role",)], []),
-                mock.call("select current_role()"),
-            ),
-            (None, mock.call("use role app_role")),
             (None, mock.call("use role old_role")),
         ]
     )
@@ -2612,3 +2608,32 @@ def test_given_release_channel_and_label_without_create_version_when_publish_the
         )
 
     assert str(e.value) == "--label can only be used with --create-version flag."
+
+
+@pytest.mark.parametrize(
+    "feature_flag, enable_snowflake_yml, expected",
+    [
+        (None, None, None),
+        (True, None, True),
+        (False, None, False),
+        (False, True, True),
+        (True, False, False),
+    ],
+)
+@mock.patch(f"{APPLICATION_PACKAGE_ENTITY_MODULE}.sync_deploy_root_with_stage")
+@mock.patch(SQL_FACADE_GET_UI_PARAMETER, return_value="ENABLED")
+@mock.patch("snowflake.cli.api.config.get_config_value")
+def test_get_enable_release_channels(
+    mock_get_config_value,
+    mock_get_parameter,
+    mock_sync,
+    project_directory,
+    mock_cursor,
+    feature_flag,
+    enable_snowflake_yml,
+    expected,
+):
+    mock_get_config_value.return_value = feature_flag
+    app_pkg, bundle_ctx, mock_console = _get_app_pkg_entity(project_directory)
+    app_pkg.model.enable_release_channels = enable_snowflake_yml
+    assert app_pkg._get_enable_release_channels_flag() == expected  # noqa: SLF001

tests/nativeapp/test_manager.py

@@ -79,7 +79,6 @@
 from tests.nativeapp.utils import (
     APP_PACKAGE_ENTITY_DEPLOY,
     APP_PACKAGE_ENTITY_GET_EXISTING_APP_PKG_INFO,
-    APP_PACKAGE_ENTITY_GET_RELEASE_CHANNELS,
     APP_PACKAGE_ENTITY_IS_DISTRIBUTION_SAME,
     ENTITIES_UTILS_MODULE,
     SQL_EXECUTOR_EXECUTE,
@@ -845,7 +844,7 @@ def test_get_snowsight_url_without_pdf_warehouse(
 @mock.patch(SQL_FACADE_GET_UI_PARAMETER, return_value="ENABLED")
 @mock.patch(SQL_FACADE_CREATE_APP_PKG)
 @mock.patch("snowflake.cli.api.config.get_config_value")
-@pytest.mark.parametrize("feature_flag", [True, False])
+@pytest.mark.parametrize("feature_flag", [True, False, None])
 def test_given_no_existing_pkg_when_create_app_pkg_then_success_and_respect_release_channels_flag(
     mock_get_config_value,
     mock_create_app_pkg,
@@ -888,7 +887,7 @@ def test_given_no_existing_pkg_when_create_app_pkg_then_success_and_respect_rele
 @mock.patch(SQL_FACADE_GET_UI_PARAMETER, return_value="ENABLED")
 @mock.patch(SQL_FACADE_ALTER_APP_PKG_PROPERTIES)
 @mock.patch("snowflake.cli.api.config.get_config_value")
-@pytest.mark.parametrize("feature_flag", [True, False])
+@pytest.mark.parametrize("feature_flag", [True, False, None])
 def test_given_existing_app_package_with_feature_flag_set_when_create_pkg_then_set_pkg_property_to_same_value(
     mock_get_config_value,
     mock_alter_app_pkg_properties,
@@ -939,9 +938,7 @@ def test_given_existing_app_package_with_feature_flag_set_when_create_pkg_then_s
 @mock_get_app_pkg_distribution_in_sf()
 @mock.patch(APP_PACKAGE_ENTITY_IS_DISTRIBUTION_SAME, return_value=True)
 @mock.patch(SQL_FACADE_GET_UI_PARAMETER, return_value="ENABLED")
-@mock.patch(APP_PACKAGE_ENTITY_GET_RELEASE_CHANNELS, return_value=None)
 def test_create_app_pkg_different_owner(
-    mock_get_release_channels,
     mock_get_ui_parameter,
     mock_is_distribution_same,
     mock_get_distribution,
@@ -986,9 +983,7 @@ def test_create_app_pkg_different_owner(
     [False, True],
 )
 @mock.patch(SQL_FACADE_GET_UI_PARAMETER, return_value="ENABLED")
-@mock.patch(APP_PACKAGE_ENTITY_GET_RELEASE_CHANNELS, return_value=None)
 def test_create_app_pkg_external_distribution(
-    mock_get_release_channels,
     mock_get_ui_parameter,
     mock_is_distribution_same,
     mock_get_distribution,
@@ -1038,9 +1033,7 @@ def test_create_app_pkg_external_distribution(
     ],
 )
 @mock.patch(SQL_FACADE_GET_UI_PARAMETER, return_value="ENABLED")
-@mock.patch(APP_PACKAGE_ENTITY_GET_RELEASE_CHANNELS, return_value=None)
 def test_create_app_pkg_internal_distribution_special_comment(
-    mock_get_release_channel,
     mock_get_ui_parameter,
     mock_is_distribution_same,
     mock_get_distribution,

tests/nativeapp/utils.py

@@ -58,9 +58,6 @@
 APP_PACKAGE_ENTITY_GET_EXISTING_VERSION_INFO = (
     f"{APP_PACKAGE_ENTITY}.get_existing_version_info"
 )
-APP_PACKAGE_ENTITY_GET_RELEASE_CHANNELS = (
-    f"{APP_PACKAGE_ENTITY}._get_enable_release_channels_flag"
-)
 APP_PACKAGE_ENTITY_IS_DISTRIBUTION_SAME = (
     f"{APP_PACKAGE_ENTITY}.verify_project_distribution"
 )

tests_integration/nativeapp/test_release_channels.py

@@ -69,15 +69,6 @@ def test_release_channels_disabled_to_enabled_switch(
         assert result.exit_code == 0
         assert result.json == []
 
-        # setting ENABLE_RELEASE_CHANNELS feature flag should issue a warning
-        get_value_mock.return_value = True
-        result = runner.invoke_with_connection(["app", "deploy"])
-        assert result.exit_code == 0
-        assert (
-            "ENABLE_RELEASE_CHANNELS value in config.toml is deprecated. "
-            "Set [enable_release_channels] for the application package in snowflake.yml instead."
-        ) in result.output
-
         # setting enable_release_channels in pdf should silence the warning
         set_pdf_release_channels(True)
         result = runner.invoke_with_connection(["app", "deploy"])