feat: [SNOW-1942865] wip: integrate cicd into project init

Author: sfc-gh-jwilkowski

src/snowflake/cli/_plugins/cicd/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2025 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

src/snowflake/cli/_plugins/cicd/manager.py

@@ -0,0 +1,77 @@
+import enum
+from typing import Generator, List, Optional, Type
+
+from snowflake.cli.api.secure_path import SecurePath
+
+
+class CIProviderChoices(str, enum.Enum):
+    GITHUB = "GITHUB"
+    GITLAB = "GITLAB"
+
+
+class CIProvider:
+    name: str
+    files_to_render_directories: list[str] = []
+
+    @classmethod
+    def cleanup(cls, root: SecurePath) -> None:
+        raise NotImplementedError()
+
+    def __eq__(self, other) -> bool:
+        return self.name == other.name
+
+    @classmethod
+    def from_choice(cls, choice: CIProviderChoices) -> "CIProvider":
+        return {
+            CIProviderChoices.GITHUB: GithubProvider,
+            CIProviderChoices.GITLAB: GitLabProvider,
+        }[choice]()
+
+    @classmethod
+    def all(cls) -> List[Type["CIProvider"]]:  # noqa: A003
+        return [GithubProvider, GitLabProvider]
+
+    def get_files_to_render(self, root_dir: SecurePath) -> Generator[str, None, None]:
+        for directory in self.files_to_render_directories:
+            for path in (root_dir / directory).rglob("*"):
+                yield str(path.relative_to(root_dir.path))
+
+    def has_template(self, root_dir: SecurePath) -> bool:
+        raise NotImplementedError()
+
+
+class GithubProvider(CIProvider):
+    name = CIProviderChoices.GITLAB.name
+    files_to_render_directories = [".github/workflows/"]
+
+    @classmethod
+    def cleanup(cls, root_dir: SecurePath):
+        (root_dir / ".github").rmdir(recursive=True)
+
+    def has_template(self, root_dir: SecurePath) -> bool:
+        return (root_dir / ".github/workflows").exists()
+
+
+class GitLabProvider(CIProvider):
+    name = CIProviderChoices.GITLAB.name
+
+    @classmethod
+    def cleanup(cls, root_dir: SecurePath):
+        (root_dir / ".gitlab-ci.yml").unlink(missing_ok=True)
+
+    def get_files_to_render(self, root_dir: SecurePath):
+        if (root_dir / ".gitlab-ci.yml").exists():
+            return [".gitlab-ci.yml"]
+
+    def has_template(self, root_dir: SecurePath) -> bool:
+        return (root_dir / ".gitlab-ci.yml").exists()
+
+
+class CIProviderManager:
+    @staticmethod
+    def project_post_gen_cleanup(
+        selected_provider: Optional[CIProvider], template_root: SecurePath
+    ):
+        for provider_cls in CIProvider.all():
+            if selected_provider and not isinstance(selected_provider, provider_cls):
+                provider_cls.cleanup(template_root)

src/snowflake/cli/_plugins/cicd/plugin_spec.py

@@ -0,0 +1,24 @@
+# Copyright (c) 2024 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# from snowflake.cli._plugins.cicd import commands
+
+#
+# @plugin_hook_impl
+# def command_spec():
+#     return CommandSpec(
+#         parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
+#         command_type=CommandType.COMMAND_GROUP,
+#         typer_instance=commands.app.create_instance(),
+#     )

src/snowflake/cli/_plugins/init/commands.py

@@ -21,6 +21,11 @@
 import yaml
 from click import ClickException
 from snowflake.cli.__about__ import VERSION
+from snowflake.cli._plugins.cicd.manager import (
+    CIProvider,
+    CIProviderChoices,
+    CIProviderManager,
+)
 from snowflake.cli.api.commands.flags import (
     NoInteractiveOption,
     variables_option,
@@ -42,6 +47,7 @@
 
 
 DEFAULT_SOURCE = "https://github.com/snowflakedb/snowflake-cli-templates"
+DEFAULT_CI_SOURCE = DEFAULT_SOURCE + "/cicd"
 
 log = logging.getLogger(__name__)
 
@@ -72,6 +78,17 @@ def _path_argument_callback(path: str) -> str:
     "--template-source",
     help=f"local path to template directory or URL to git repository with templates.",
 )
+CIProviderOption = typer.Option(
+    None,
+    "--ci-provider",
+    help=f"CI provider to generate workflow for.",
+    case_sensitive=True,
+)
+CITemplateSourceOption = typer.Option(
+    None,
+    "--ci-template-source",
+    help=f"local path to template directory or URL to git repository with ci/cd templates.",
+)
 VariablesOption = variables_option(
     "String in `key=value` format. Provided variables will not be prompted for."
 )
@@ -191,6 +208,8 @@ def init(
     path: str = PathArgument,
     template: Optional[str] = TemplateOption,
     template_source: Optional[str] = SourceOption,
+    ci_provider: Optional[CIProviderChoices] = CIProviderOption,
+    ci_template_source: Optional[str] = CITemplateSourceOption,
     variables: Optional[List[str]] = VariablesOption,
     no_interactive: bool = NoInteractiveOption,
     **options,
@@ -219,6 +238,28 @@ def init(
                 destination=tmpdir,
             )
 
+        if ci_provider:
+            ci_provider_instance = CIProvider.from_choice(ci_provider)
+            if ci_template_source is not None:
+                with SecurePath.temporary_directory() as cicd_tmpdir:
+                    cicd_template_root = _fetch_remote_template(
+                        url=ci_template_source,
+                        path=None,
+                        destination=cicd_tmpdir
+                        # type: ignore
+                    )
+                    cicd_template_root.copy(template_root.path)
+
+            elif ci_provider_instance.has_template(template_root):
+                pass  # template has ci files
+            else:
+                # use generic ci/cd template
+                with SecurePath.temporary_directory() as cicd_tmpdir:
+                    cicd_template_root = _fetch_remote_template(
+                        url=DEFAULT_SOURCE, path=f"cicd/{ci_provider_instance.name.lower()}", destination=cicd_tmpdir  # type: ignore
+                    )
+                    cicd_template_root.copy(template_root.path)
+
         template_metadata = _read_template_metadata(
             template_root, args_error_msg=args_error_msg
         )
@@ -233,16 +274,22 @@ def init(
             "project_dir_name": SecurePath(path).name,
             "snowflake_cli_version": VERSION,
         }
-        log.debug(
-            "Rendering template files: %s", ", ".join(template_metadata.files_to_render)
+        files_to_render = template_metadata.files_to_render + list(
+            ci_provider_instance.get_files_to_render(template_root)
         )
+        log.debug("Rendering template files: %s", ", ".join(files_to_render))
         render_template_files(
             template_root=template_root,
-            files_to_render=template_metadata.files_to_render,
+            files_to_render=files_to_render,
             data=variable_values,
         )
         _remove_template_metadata_file(template_root)
+        post_generate(template_root, ci_provider_instance)
         SecurePath(path).parent.mkdir(exist_ok=True, parents=True)
         template_root.copy(path)
 
     return MessageResult(f"Initialized the new project in {path}")
+
+
+def post_generate(template_root: SecurePath, ci_provider: Optional[CIProvider]):
+    CIProviderManager.project_post_gen_cleanup(ci_provider, template_root)

src/snowflake/cli/api/secure_path.py

@@ -116,6 +116,14 @@ def glob(self, pattern: str):
         """
         return self._path.glob(pattern)
 
+    def rglob(self, pattern: str) -> Generator[Path, None, None]:
+        """
+        Recursively yield all existing files (of any kind, including
+        directories) matching the given relative pattern, anywhere in
+        this subtree.
+        """
+        return self._path.rglob(pattern)
+
     def as_posix(self) -> str:
         """
         Return the string representation of the path with forward slashes (/) as the path separator.