feat: add githooks (#1373)

.githooks/pre-commit

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+STAGED_GO_FILES=$(git diff --cached --name-only | grep ".go$")
+
+echo "Formatting go files"
+for FILE in ${STAGED_GO_FILES}
+do
+    gofmt -w -s "${FILE}"
+    goimports -w "${FILE}"
+    git add "${FILE}"
+done
+
+if [[ -n "${STAGED_GO_FILES}" ]]; then
+    set -o errexit
+    make lint-fix
+    make lint
+    set +o errexit
+    for FILE in ${STAGED_GO_FILES}
+    do
+        git add "${FILE}"
+    done
+fi
+
+STAGED_TF_FILES=$(git diff --cached --name-only | grep ".tf$")
+if [ -n "$STAGED_TF_FILES" ]; then
+    echo "Checking the format of Terraform files"
+    make tflint
+fi
+
+STAGED_WEBSITES_FILES=$(git diff --cached --name-only | grep "website/")
+if [ -n "$STAGED_WEBSITES_FILES" ]; then
+    echo "Checking the format of website files"
+    make website-lint
+fi

CONTRIBUTING.md

@@ -1,24 +1,271 @@
-Contributing
----------------------------
-
 # Contributing
 
-## Workflow
 
-MongoDB welcomes community contributions! If you’re interested in making a contribution to  Terraform MongoDB Atlas provider, please follow the steps below before you start writing any code:
+## Development Setup
+### Prerequisite Tools
+
+- [Git](https://git-scm.com/)
+- [Go (at least Go 1.20)](https://golang.org/dl/)
+
+### Environment
+
+- Fork the repository.
+- Clone your forked repository locally.
+- We use Go Modules to manage dependencies, so you can develop outside your `$GOPATH`.
+- We use [golangci-lint](https://github.com/golangci/golangci-lint) to lint our code, you can install it locally via `make setup`.
+### Building
+- Enter the provider directory
+- Run `make tools` to install the needed tools for the provider
+- Run `link-git-hooks` to install githooks 
+- Run `make build` to build the binary in the `./bin` directory: 
+- Use the local provider binary in the `./bin` folder:
+  - Create the following `dev.trfc` file inside your directory 
+  ```terraform
+    provider_installation {
+
+    dev_overrides {
+      "mongodb/mongodbatlas" = "/Users/yourUser/terraform-provider-mongodbatlas/bin" # path to the provider binary
+    }
+
+    direct {} 
+  }
+  ```
+  - Define the env var `TF_CLI_CONFIG_FILE` in your console session
+  ```bash
+  export TF_CLI_CONFIG_FILE=PATH/TO/dev.trfc
+  ```
+- Run `terraform init` to inizialize terraform
+- Run `terraform apply` to use terraform with the local binary
+
+For more explained information about plugin override check [Development Overrides for Provider Developers](https://www.terraform.io/docs/cli/config/config-file.html#development-overrides-for-provider-developers)
+
+### Open a Pull Request
+- Sign the [contributor's agreement](http://www.mongodb.com/contributor). This will allow us to review and accept contributions.
+- Implement your feature, improvement or bug fix, ensuring it adheres to the [Terraform Plugin Best Practices](https://www.terraform.io/docs/extend/best-practices/index.html).
+- Make sure that the PR title follows [*Conventional Commits*](https://www.conventionalcommits.org/).
+- Add comments around your new code that explain what's happening.
+- Commit and push your changes to your branch then submit a pull request against the `master` branch.
+- A repo maintainer will review the your pull request, and may either request additional changes or merge the pull request.
+
+### Testing the Provider
+
+In order to test the provider, you can run `make test`. You can use [meta-arguments](https://www.terraform.io/docs/configuration/providers.html) such as `alias` and `version`. The following arguments are supported in the MongoDB Atlas `provider` block:
+
+* `public_key` - (Optional) This is the MongoDB Atlas API public_key. It must be
+  provided, but it can also be sourced from the `MONGODB_ATLAS_PUBLIC_KEY`
+  environment variable.
+
+* `private_key` - (Optional) This is the MongoDB Atlas private_key. It must be
+  provided, but it can also be sourced from the `MONGODB_ATLAS_PRIVATE_KEY`
+  environment variable.
+
+~> **Notice:**  If you do not have a `public_key` and `private_key` you must create a programmatic API key to configure the provider (see [Creating Programmatic API key](#Programmatic-API-key)). If you already have one, you can continue with [Configuring environment variables](#Configuring-environment-variables)
+
+### Running the acceptance test
+
+#### Programmatic API key
+
+It's necessary to generate and configure an API key for your organization for the acceptance test to succeed. To grant programmatic access to an organization or project using only the [API](https://docs.atlas.mongodb.com/api/) you need to know:
+
+  - The programmatic API key has two parts: a Public Key and a Private Key. To see more details on how to create a programmatic API key visit https://docs.atlas.mongodb.com/configure-api-access/#programmatic-api-keys.
+
+  - The programmatic API key must be granted roles sufficient for the acceptance test to succeed. The Organization Owner and Project Owner roles should be sufficient. You can see the available roles at https://docs.atlas.mongodb.com/reference/user-roles.
+
+  - You must [configure Atlas API Access](https://docs.atlas.mongodb.com/configure-api-access/) for your programmatic API key. You should allow API access for the IP address from which the acceptance test runs.
+
+#### Configuring environment variables
+
+You must also configure the following environment variables before running the test:
+
+##### MongoDB Atlas env variables
+- Required env variables:
+  ```bash
+  export MONGODB_ATLAS_PROJECT_ID=<YOUR_PROJECT_ID>
+  export MONGODB_ATLAS_ORG_ID=<YOUR_ORG_ID>
+  export MONGODB_ATLAS_PUBLIC_KEY=<YOUR_PUBLIC_KEY>
+  export MONGODB_ATLAS_PRIVATE_KEY=<YOUR_PRIVATE_KEY>
+
+  # This env variable is optional and allow you to run terraform with a custom server
+  export MONGODB_ATLAS_BASE_URL=<CUSTOM_SERVER_URL>
+  ```
+
+- For `Authentication database user` resource configuration:
+  ```bash
+  $ export MONGODB_ATLAS_DB_USERNAME=<YOUR_DATABASE_NAME>
+  ```
+
+- For `Project(s)` resource configuration:
+  ```bash
+  $ export MONGODB_ATLAS_TEAMS_IDS=<YOUR_TEAMS_IDS>
+  $ export MONGODB_ATLAS_API_KEYS_IDS=<API_KEYS_IDS>
+  ```
+~> **Notice:** It should be at least one team id up to 3 teams ids depending of acceptance testing using separator comma like this `teamId1,teamdId2,teamId3`.
+
+- For skip acceptances testing that requires additional credentials such as AWS, AZURE and GCP:
+  ```bash
+  export SKIP_TEST_EXTERNAL_CREDENTIALS=TRUE
+  ```
+
+- For `Federated Settings` resource configuration:
+  ```bash
+  $ export MONGODB_ATLAS_FEDERATION_SETTINGS_ID=<YOUR_FEDERATION_SETTINGS_ID>
+  $ export ONGODB_ATLAS_FEDERATED_ORG_ID=<YOUR_FEDERATED_ORG_ID>
+  $ export MONGODB_ATLAS_FEDERATED_PROJECT_ID=<YOUR_VPC_FEDERATED_PROJECT_ID>
+  $ export MONGODB_ATLAS_FEDERATED_GROUP_ID=<YOUR_FEDERATED_GROUP_ID>
+  $ export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID=<YOUR_FEDERATED_ROLE_MAPPING_ID>
+  $ export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID=<YOUR_FEDERATED_OKTA_IDP_ID>
+  $ export MONGODB_ATLAS_FEDERATED_SSO_URL=<YOUR_FEDERATED_SSO_URL>
+  $ export MONGODB_ATLAS_FEDERATED_ISSUER_URI=<YOUR_FEDERATED_ISSUER_URI>
+  ```
+~> **Notice:** For more information about the Federation configuration resource, see: https://www.mongodb.com/docs/atlas/reference/api/federation-configuration/
+
+##### AWS env variables
+
+- For `Network Peering` resource configuration:
+  ```bash
+  $ export AWS_ACCOUNT_ID=<YOUR_ACCOUNT_ID>
+  $ export AWS_VPC_ID=<YOUR_VPC_ID>
+  $ export AWS_VPC_CIDR_BLOCK=<YOUR_VPC_CIDR_BLOCK>
+  $ export AWS_REGION=<YOUR_REGION>
+  $ export AWS_SUBNET_ID=<YOUR_SUBNET_ID>
+  $ export AWS_SECURITY_GROUP_ID=<YOUR_SECURITY_GROUP_ID>
+  ```
+~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/
+
+- For `Encryption at Rest` resource configuration:
+  ```bash
+  $ export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
+  $ export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
+  $ export AWS_CUSTOMER_MASTER_KEY_ID=<YOUR_CUSTOMER_MASTER_KEY_ID>
+  $ export AWS_REGION=<YOUR_REGION>
+
+  $ export AWS_ACCESS_KEY_ID_UPDATED=<YOUR_ACCESS_KEY_ID_UPDATED>
+  $ export AWS_SECRET_ACCESS_KEY_UPDATED=<YOUR_SECRET_ACCESS_KEY_UPDATED>
+  $ export AWS_CUSTOMER_MASTER_KEY_ID_UPDATED=<YOUR_CUSTOMER_MASTER_KEY_ID_UPDATED>
+  $ export AWS_REGION_UPDATED=<YOUR_REGION_UPDATED>
+  ```
+~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/
 
-1. Sign the [contributor's agreement](http://www.mongodb.com/contributor). This will allow us to review and accept contributions.
-1. Read the [Terraform contribution guidelines](https://www.terraform.io/docs/extend/community/contributing.html) and the [README](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/README.md) in this repo
-1. Reach out by filing an [issue](https://github.com/mongodb/terraform-provider-mongodbatlas/issues) to discuss your proposed contribution, be it a bug fix or feature/other improvements.  
+- For `Private Endpoint Link` resource configuration:
+  ```bash
+  $ export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
+  $ export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
+  $ export AWS_CUSTOMER_MASTER_KEY_ID=<YOUR_CUSTOMER_MASTER_KEY_ID>
+  $ export AWS_REGION=<YOUR_REGION>
+  $ export AWS_VPC_ID=<YOUR_VPC_ID>
+  $ export AWS_SUBNET_ID=<YOUR_SUBNET_ID>
+  $ export AWS_SECURITY_GROUP_ID=<YOUR_SECURITY_GROUP_ID>
+  ```
+~> **Notice:** For more information about the PrivateLink (for AWS only), see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/https://docs.atlas.mongodb.com/reference/api/private-endpoint/
+
+##### AZURE env variables
+
+- For `Network Peering` resource configuration:
+  ```bash
+  $ export AZURE_DIRECTORY_ID=<YOUR_DIRECTORY_ID>
+  $ export AZURE_SUBSCRIPTION_ID=<YOUR_SUBSCRIPTION_ID>
+  $ export AZURE_RESOURCE_GROUP_NAME=<YOUR_RESOURCE_GROUP_NAME>
+  $ export AZURE_VNET_NAME=<YOUR_VNET_NAME>
+  ```
+~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/
+
+
+- For Encryption at Rest resource configuration:
+  ```bash
+  export AZURE_CLIENT_ID=<YOUR_CLIENT_ID>
+  export AZURE_SUBSCRIPTION_ID=<YOUR_SUBSCRIPTION_ID>
+  export AZURE_RESOURCE_GROUP_NAME=<YOUR_RESOURCE_GROUP_NAME>
+  export AZURE_SECRET=<YOUR_SECRET>
+  export AZURE_KEY_VAULT_NAME=<YOUR_KEY_VAULT_NAME>
+  export AZURE_KEY_IDENTIFIER=<YOUR_KEY_IDENTIFIER>
+  export AZURE_TENANT_ID=<YOUR_TENANT_ID>
+  export AZURE_DIRECTORY_ID=<YOUR_DIRECTORY_ID>
+
+  export AZURE_CLIENT_ID_UPDATED=<YOUR_CLIENT_ID_UPDATED>
+  export AZURE_RESOURCE_GROUP_NAME_UPDATED=<YOUR_RESOURCE_GROUP_NAME_UPDATED>
+  export AZURE_SECRET_UPDATED=<YOUR_SECRET_UPDATED>
+  export AZURE_KEY_VAULT_NAME_UPDATED=<YOUR_KEY_VAULT_NAME_UPDATED>
+  export AZURE_KEY_IDENTIFIER_UPDATED=<YOUR_KEY_IDENTIFIER_UPDATED>
+  ```
+~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/
+
+##### GCP env variables
+- For `Network Peering` resource configuration:
+  ```bash
+  $export GCP_PROJECT_ID=<YOUR_PROJECT_ID>
+  ```
+~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/
+
+
+- For Encryption at Rest resource configuration:
+  ```bash
+  $ export GCP_SERVICE_ACCOUNT_KEY=<YOUR_GCP_SERVICE_ACCOUNT_KEY>
+  $ export GCP_KEY_VERSION_RESOURCE_ID=<YOUR_GCP_KEY_VERSION_RESOURCE_ID>
+  ```
+~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/
+
+
+#### Run Acceptance tests
+~> **Notice:** Acceptance tests create real resources, and often cost money to run. Please note in any PRs made if you are unable to pay to run acceptance tests for your contribution. We will accept "best effort" implementations of acceptance tests in this case and run them for you on our side. This may delay the contribution but we do not want your contribution blocked by funding.
+- Run `make testacc`
+
+
+
+### Testing Atlas Provider Versions that are NOT hosted on Terraform Registry (i.e. pre-release versions)
+To test development / pre-release versions of the Terraform Atlas Provider that are not hosted on the Terraform Registry, you will need to create a [Terraform Provider Network Mirror](https://developer.hashicorp.com/terraform/internals/provider-network-mirror-protocol). 
+
+The provider network mirror protocol is an optional protocol which you can implement to provide an alternative installation source for Terraform providers, regardless of their origin registries. Terraform uses network mirrors only if you activate them explicitly in the CLI configuration's `provider_installation` block. When enabled, a network mirror can serve providers belonging to any registry hostname, which can allow an organization to serve all of the Terraform providers they intend to use from an internal server, rather than from each provider's origin registry.
+
+To do this you can: 
+-	Create a versions.tf file in a new directory with an existing live version from Terraform Registry. For example this can include:  
+    ```terraform
+    terraform {
+      required_providers {
+        mongodbatlas = {
+          source = "mongodb/mongodbatlas"
+        }
+      }
+      required_version = ">= 0.13"
+    }
+    ```
+
+-	Use `terraform init` to create required file structures 
+
+-	`mkdir` a `tf_cache` sub-directory and `cd` into that directory 
+
+-	Create a .terraformrc file and insert below (modify accordingly to your own local path directory): 
+    ```terraform
+    provider_installation {
+      filesystem_mirror {
+        path    = "C:\Users\ZuhairAhmed\Desktop\Tenant_Upgrade\tf_cache"
+        include = ["registry.terraform.io/hashicorp/*"]
+      }
+      direct {
+        exclude = ["registry.terraform.io/hashicorp/*"]
+      }
+    }
+    plugin_cache_dir = "C:\Users\ZuhairAhmed\Desktop\Tenant_Upgrade\tf_cache"
+    disable_checkpoint=true
+    ```
+-	`cd` back up to original directory and `mv` the `.terraform/providers/registry.terraform.io` directory to `tf_cache` 
+
+-	Create required environment variables (modify accordingly to your own local path directory):
+    ```bash
+    export TF_PLUGIN_CACHE_DIR=/mnt/c/Users/ZuhairAhmed/Desktop/Tenant_Upgrade/tf_cache
+    export TF_CLI_CONFIG_FILE=/mnt/c/Users/ZuhairAhmed/Desktop/Tenant_Upgrade/tf_cache/terraform.rc
+    ```
+-  Delete the `.terraform` and `.terraform.lock.hcl` directories altogether. At this point you should only have the `tf_cache` directory and the `versions.tf` config file remaining. 
+
+- Next in the `tf_cache` directory replace existing terraform provider core files (Terraform Atlas Provider version binary, `CHANGELOG.md`, `LICENSE`, and `README.md`) with the version you seek to test locally. Make sure to keep folder structure the same. 
+
+- Lastly, in the terminal run `terraform init` again and this time terraform will pull provider version from `tf_cache` network mirror. You can confirm this by noting the `Terraform has been successfully initialized! Using mongodb/mongodbatlas Vx.x.x from the shared cache directory` message.  
+
+
+
+## Documentation Best Practises
+
+- In our documentation, when a resource field allows a maximum of only one item, we do not format that field as an array. Instead, we create a subsection specifically for this field. Within this new subsection, we enumerate all the attributes of the field. Let's illustrate this with an example: [cloud_backup_schedule.html.markdown](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/r/cloud_backup_schedule.html.markdown?plain=1#L207)
 
-After the above 3 steps are completed and we've agreed on a path forward:
-1. Fork the repository on GitHub
-1. Create a branch with a name that briefly describes your submission
-1. Implement your feature, improvement or bug fix, ensuring it adheres to the [Terraform Plugin Best Practices](https://www.terraform.io/docs/extend/best-practices/index.html)
-1. Ensure you follow the [Terraform Plugin Testing requirements](https://www.terraform.io/docs/extend/testing/index.html).
-1. Add comments around your new code that explain what's happening
-1. Commit and push your changes to your branch then submit a pull request against the current release branch, not master.  The naming scheme of the branch is `release-staging-v#.#.#`. Note: There will only be one release branch at a time.  
-1. A repo maintainer will review the your pull request, and may either request additional changes or merge the pull request.
 
 ## PR Title Format
 We use [*Conventional Commits*](https://www.conventionalcommits.org/):
@@ -39,8 +286,3 @@ Examples:
   - `fix!: description of the ticket`
   - If the PR has `BREAKING CHANGE`: in its description is a breaking change
 - `remove!: description of the PR`: The commit removes a feature from the product. Typically features are deprecated first for a period of time before being removed. Removing a feature is a breaking change (correlating with MAJOR in Semantic Versioning).
-
-
-## Documentation Best Practises
-
-1. In our documentation, when a resource field allows a maximum of only one item, we do not format that field as an array. Instead, we create a subsection specifically for this field. Within this new subsection, we enumerate all the attributes of the field. Let's illustrate this with an example: [cloud_backup_schedule.html.markdown](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/r/cloud_backup_schedule.html.markdown?plain=1#L207)

GNUmakefile

@@ -124,3 +124,9 @@ tflint: fmtcheck
 .PHONY: tf-validate
 tf-validate: fmtcheck
 	@scripts/tf-validate.sh
+
+.PHONY: link-git-hooks
+link-git-hooks: ## Install git hooks
+	@echo "==> Installing all git hooks..."
+	find .git/hooks -type l -exec rm {} \;
+	find .githooks -type f -exec ln -sf ../../{} .git/hooks/ \;