snowflake-cli-labs 2.8.0rc1__tar.gz → 3.0.0rc1__tar.gz

snowflake_cli_labs-3.0.0rc1/.pre-commit-config.yaml

@@ -0,0 +1,132 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: '(^tests/|^tests_integration/|^tests_e2e)'
+      - id: end-of-file-fixer
+        exclude: license_header.txt
+      - id: check-yaml
+        exclude: .github/repo_meta.yaml
+      - id: debug-statements
+        exclude: src/snowflake/cli/_app/dev/pycharm_remote_debug.py
+      - id: check-ast
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.1.7"
+    hooks:
+      - id: ruff
+        args: [--fix, --exclude, "**/tests_common/,**/tests_integration/"]
+  - repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.990
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-pkg-resources==0.1.3, types-all==1.0.0]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+  - repo: local
+    hooks:
+      - id: check-print-in-code
+        language: pygrep
+        name: "Check for print statements"
+        entry: "print\\(|echo\\("
+        pass_filenames: true
+        files: ^src/snowflake/.*\.py$
+        exclude: >
+          (?x)
+          ^src/snowflake/cli/api/console/.*$|
+          ^src/snowflake/cli/_app/printing.py$|
+          ^src/snowflake/cli/_app/dev/.*$|
+          ^src/snowflake/cli/templates/.*$|
+          ^src/snowflake/cli/api/utils/rendering.py$|
+          ^src/snowflake/cli/_plugins/spcs/common.py$|
+          ^src/snowflake/cli/_plugins/snowpark/venv.py$|
+          ^src/snowflake/cli/_app/cli_app.py$
+      - id: check-app-imports-in-api
+        language: pygrep
+        name: "No top level cli._app imports in cli.api"
+        entry: "^from snowflake\\.cli\\._app"
+        pass_filenames: true
+        files: ^src/snowflake/cli/api/.*\.py$
+      - id: avoid-snowcli
+        language: pygrep
+        name: "Prefer snowflake CLI over snowcli"
+        entry: "snowcli"
+        pass_filenames: true
+        files: ^src/.*\.py$
+        exclude: ^src/snowflake/cli/_app/constants.py$
+      - id: dependencies-sync
+        name: "Copy dependencies from pyproject.toml to requirements.txt"
+        language: system
+        entry: python snyk/dependency-sync.py
+        files: ^pyproject.toml$
+      - id: use-local-requirements-model
+        language: pygrep
+        name: "Use snowflake.cli._plugins.snowpark.models.Requirement for requirements parsing"
+        files: ^src/snowflake/.*\.py$
+        entry: >
+          ^from requirements.* import|
+          ^import requirements.*
+        pass_filenames: true
+        exclude: ^src/snowflake/cli/_plugins/snowpark/models.py$
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: insert-license
+        name: Add license for all SQL files
+        files: \.sql$
+        exclude: |
+          (?x)
+          ^\.github/|
+          tests/test_data/projects/.*|
+          tests_integration/test_data/projects/.*
+        args:
+          - --comment-style
+          - "/*||*/"
+          - --license-filepath
+          - scripts/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add license for all toml files
+        files: \.toml$
+        args:
+          - --comment-style
+          - "|#|"
+          - --license-filepath
+          - scripts/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add license for all Python files
+        exclude: |
+          (?x)
+          ^\.github/|
+          tests/test_data/projects/.*|
+          tests_integration/test_data/projects/.*|
+        files: \.py$|\.pyi$
+        args:
+          - --comment-style
+          - "|#|"
+          - --license-filepath
+          - scripts/LICENSE.txt
+          - --fuzzy-match-generates-todo
+      - id: insert-license
+        name: Add license for all Markdown files
+        exclude: |
+          (?x)
+          ^\.github/|
+          tests/test_data/projects/.*|
+          tests_integration/test_data/projects/.*
+        files: \.md$
+        args:
+          - --comment-style
+          - "<!--|| -->"
+          - --license-filepath
+          - scripts/LICENSE.txt
+          - --fuzzy-match-generates-todo

snowflake_cli_labs-3.0.0rc1/CONTRIBUTING.md

@@ -0,0 +1,243 @@
+<!--
+ 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.
+ -->
+
+# Contributing to Snowflake CLI
+
+There are two ways to contribute code to the repository: directly or by use of forks. For best practices for the second approach, refer to the section on forks below. Right now, there is limited access to contributing to the repository directly, and hence using forks is the recommended approach.
+
+## Setup a development environment
+If you are interested in contributing, you will need to instantiate dev virtual environments and the pre-commit logic to help with formatting and linting of commits.
+
+We use [hatch](https://hatch.pypa.io/latest/) to manage and created development environments.
+Default environment will use the python version in your shell.
+```bash
+pip install -U hatch
+hatch run pre-commit
+```
+This will spawn new shell with environment and all required packages installed.
+This will also install snowflake cli package in editable mode.
+
+To enter environment use following command.
+```bash
+hatch shell
+```
+This will spawn new shell with virtual environment enables. To leave just press ^D.
+
+
+Currently, the required Python version for development is Python 3.10+. For local development we recommend to use
+a wrapper for virtual environments like [pyenv](https://github.com/pyenv/pyenv).
+
+If you wish to setup environment with specific version ie. 3.10 you can use following command:
+
+```bash
+hatch env create local.py3.10```
+
+You can see all locally supported environments with
+
+```bash
+hatch env show
+```
+
+Please keep in mind that you need these python versions available in your `$PATH`. You can install them using `hatch` or other tool like [pyenv](https://github.com/pyenv/pyenv)
+
+## Unit tests
+
+Unit tests are executed in random order. If tests fail after your change, you can re-execute them in the same order using `pytest --randomly-seed=<number>`, where number is a seed printed at the beginning of the test execution output.
+Random order of test execution is provided by pytest-randomly, so more details are available in [pytest-randomly docs](https://pypi.org/project/pytest-randomly/).
+
+```bash
+hatch run test
+```
+or by running `pytest` inside activated environment.
+
+
+## Integration tests
+
+Every integration test should have `integration` mark. By default, integration tests are not execute when running `pytest`.
+
+To execute only integration tests run `hatch run integration:test` or `pytest -m integration` inside environment.
+
+### User setup
+
+Integration tests require environment variables to be set up. Parameters must use the following format:
+
+``SNOWFLAKE_CONNECTIONS_INTEGRATION_<key>=<value>``
+
+where ``<key>`` is the name of the key. The following environment variables are required:
+
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_AUTHENTICATOR=SNOWFLAKE_JWT`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_HOST`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_ACCOUNT`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_USER`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_PRIVATE_KEY_FILE` (`SNOWFLAKE_CONNECTIONS_INTEGRATION_PRIVATE_KEY_PATH` will work too, but preferable is with `_FILE` ending)
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_ROLE`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_DATABASE`
+- `SNOWFLAKE_CONNECTIONS_INTEGRATION_WAREHOUSE`
+
+### Integration account setup script
+
+To set up an account for integration tests, run the following script with `ACCOUNTADMIN` role:
+
+```bash
+snow sql \
+  -f tests_integration/scripts/integration_account_setup.sql \
+  -D "user=${SNOWFLAKE_CONNECTIONS_INTEGRATION_USER}" \
+  -D "role=${SNOWFLAKE_CONNECTIONS_INTEGRATION_ROLE}" \
+  -D "warehouse=${SNOWFLAKE_CONNECTIONS_INTEGRATION_WAREHOUSE}" \
+  -D "main_database=${SNOWFLAKE_CONNECTIONS_INTEGRATION_DATABASE}"\
+  -c <your_connection_name>
+```
+
+Note: Before running the script, set up your environment variables.
+
+### Build and push Docker images
+
+To build and push all required Docker images, run the following script:
+
+```bash
+./tests_integration/spcs/docker/build_and_push_all.sh
+```
+
+## Remote debugging with PyCharm or IntelliJ
+
+Snowflake CLI can connect to a remote debug server started in PyCharm or Intellij.
+It allows you to debug any installation of our tool in one of mentioned IDEs.
+
+There are only three requirements:
+* the same source code loaded in your IDE as running in the debugged CLI installation
+* open network connection to your IDE
+* `pydevd-pycharm.egg` file accessible on the machine where the CLI is installed (the file has to match the version of your IDE)
+
+How to use it?
+1. Create a "remote debug config" run configuration in your IDE.
+    * Steps 1-2 from [this tutorial from JetBrains](https://www.jetbrains.com/help/pycharm/remote-debugging-with-product.html#create-remote-debug-config).
+    * `localhost` and `12345` port are defaults both in the IDE and in the CLI.
+1. Run your new configuration in debug mode.
+1. Find `pydevd-pycharm.egg` in the directory where your IDE is installed.
+    * Some tips how to find it should be present in the following places:
+      * The instruction from JetBrains linked above.
+      * The "remote debug config" creation window.
+1. If the CLI and the IDE are on the same machine, you have to just copy the path to the file.
+1. If the CLI is on another machine, then you have to copy the file there and also copy the target file path.
+1. Run the CLI using `snow --pycharm-debug-library-path <path-to-pydevd-pycharm.egg> <other-options-and-command>`.
+    * Example: `snow --pycharm-debug-library-path "/Users/xyz/Library/Application Support/JetBrains/Toolbox/apps/IDEA-U/ch-0/231.9011.34/IntelliJ IDEA.app.plugins/python/debugger-eggs-output/pydevd-pycharm.egg" snowpark function list`
+    * The CLI will try to connect to your debug server (by default to `localhost:12345`).
+    * If a connection cannot be established, you will see some exception about it.
+    * If you want to use other host or port you can use `--pycharm-debug-server-host` and `--pycharm-debug-server-port` options.
+    * The code execution will be paused before execution of your command.
+      You will see the exact line in the IDE's debug view.
+      You can resume code execution, add breakpoints, evaluate variables, do all the things you usually do when debugging locally.
+
+## Using Forks
+Create your own fork from the `snowflake-cli` repo. As a heads up, all `snowflake-cli` forks are publicly accessible on Github.
+
+Syncing forks with the upstream `snowflake-cli` repo can be a hassle when trying to resolve merge conflicts. To avoid issues with this approach, we recommend always rebasing to the upstream `snowflake-cli` branch.
+
+In the cloned copy of your fork, perform the following steps.
+
+```bash
+git remote add sfcli https://github.com/snowflakedb/snowflake-cli.git
+git fetch sfcli
+git checkout <your-branch>
+git rebase sfcli/main
+```
+
+## Presenting intermediate output to users
+
+Snowflake CLI enables users to interact with the Snowflake ecosystem using command line. Some commands provide immediate results, while others require some amount of operations to be executed before the result can be presented to the user.
+
+Presenting intermediate output to the user during execution of complex commands can improve users' experience.
+
+Since snowflake-cli is preparing to support additional commands via plugins, it is the right time to introduce a unified mechanism for displaying intermediate output. This will help keep consistent output among cli and plugins. There is no way to restrain usage of any kind of output in plugins developed in external repositories, but providing api may discourage others from introducing custom output.
+
+The proposal is to introduce cli_console object that will provide following helper methods to interact with the output:
+step - a method for printing regular output
+warning - a method for printing messages that should be
+phase - a context manager that will group all output within its scope as distinct unit
+
+Implemented CliConsole class must respect parameter `–silent` and disable any output when requested.
+
+Context manager must allow only one grouping level at a time. All subsequent invocations will result in raising `CliConsoleNestingProhibitedError` derived from `RuntimeError`.
+
+Logging support
+All messages handled by CliConsole may be logged regardless of is_silent property.
+
+### Example usage
+
+#### Simple output
+
+```python
+from snowflake.cli.api.console import cli_console as cc
+
+def my_command():
+    cc.step("Some work...")
+    ...
+    cc.step("Next work...")
+```
+
+#### Output
+
+```bash
+> snow my_command
+
+Some work...
+Next work...
+```
+
+#### Grouped output
+
+```python
+from snowflake.cli.api.console import cli_console as cc
+
+def my_command():
+    cc.step("Building and publishing the application")
+    prepare_data_for_processing()
+
+    with cc.phase(
+      enter_message="Building app bundle...",
+      exit_message="Application bundle created.",
+    ):
+        try:
+          cc.step("Building package artifact")
+          make_archive_bundle()
+        except BundleSizeWarning:
+          cc.warning("Bundle size is large. It may take some time to upload.")
+
+        cc.step("Uploading bundle")
+        upload_bundle()
+
+    cc.step("Publishing application")
+    publish_application()
+```
+
+#### Output
+
+```bash
+> snow my_command
+
+Building and publishing the application
+Building app bundle...
+  Building package artifact
+  __Bundle size is large. It may take some time to upload.__
+  Uploading bundle
+Application bundle created.
+Publishing application
+```
+
+## Known issues
+
+### `permission denied` during integration tests on Windows
+This error occurs when using NamedTemporaryFile and try to open it second time https://docs.python.org/3/library/tempfile.html#tempfile.NamedTemporaryFile