terraform-provider-snowflake

README

Terraform Provider: Snowflake

---

Please note: If you believe you have found a security issue, please responsibly disclose by contacting us at security@chanzuckerberg.com.

---

This is a terraform provider plugin for managing Snowflake accounts.

Setup

To use, download a binary from our releases and follow the Terraform directions for installing 3rd party plugins.

TODO fogg config

Resources

We support managing a subset of snowflakedb resources, with a focus on access control and management.

You can see a number of examples here.

snowflake_database

properties

NAME	TYPE	DESCRIPTION	OPTIONAL	REQUIRED	COMPUTED	DEFAULT
comment	string		true	false	false	""
data_retention_time_in_days	int		true	false	true
name	string	TODO	false	true	false

snowflake_role

properties

NAME	TYPE	DESCRIPTION	OPTIONAL	REQUIRED	COMPUTED	DEFAULT
comment	string		true	false	false
name	string		false	true	false

snowflake_role_grants

properties

NAME	TYPE	DESCRIPTION	OPTIONAL	REQUIRED	COMPUTED	DEFAULT
name	string		false	true	false
role_name	string	The name of the role we are	false	true	false
		granting.
roles	set	Grants role to this specified	true	false	false
		role.
users	set	Grants role to this specified	true	false	false
		user.

snowflake_user

properties

NAME	TYPE	DESCRIPTION	OPTIONAL	REQUIRED	COMPUTED	DEFAULT
comment	string		true	false	false
name	string	Name of the user. Note that if you do not supply login_name this will be used as login_name.	false	true	false
		doc
password	string	WARNING: this will put	true	false	false
		the password in the terraform
		state file. Use carefully.

snowflake_warehouse

properties

NAME	TYPE	DESCRIPTION	OPTIONAL	REQUIRED	COMPUTED	DEFAULT
comment	string		true	false	false	""
name	string		false	true	false
warehouse_size	string		true	false	true

Development

To do development you need Go installed, this repo cloned and that's about it. It has not been tested on Windows, so if you find problems let us know.

If you want to build and test the provider localling there is a make target make install-tf that will build the provider binary and install it in a location that terraform can find.

Testing

For the Terraform resources, there are 3 levels of testing - internal, unit and acceptance tests.

The 'internal' tests are run in the github.com/chanzuckerberg/terraform-provider-snowflake/pkg/resources package so that they can test functions that are not exported. These tests are intended to be limited to unit tests for simple functions.

The 'unit' tests are run in github.com/chanzuckerberg/terraform-provider-snowflake/pkg/resources_test, so they only have access to the exported methods of resources. These tests exercise the CRUD methods that on the terraform resources. Note that all tests here make use of database mocking and are run locally. This means the tests are fast, but are liable to be wrong in suble ways (since the mocks are unlikely to be perfect).

You can run these first two sets of tests with make test.

The 'acceptance' tests run the full stack, creating, modifying and destroying resources in a live snowflake account. To run them you need a snowflake account and the proper environment variables set- SNOWFLAKE_ACCOUNT, SNOWFLAKE_USER, SNOWFLAKE_PASSWORD, SNOWFLAKE_ROLE. These tests are slower but have higher fidelity.

To run all tests, including the acceptance tests, run make test-acceptance.

Note that we also run all tests in our Travis-CI account.