NSOF-5653 Makefile, README.md: add Makefile and documentation for developing the repo

Author: hod-alpert

Makefile

@@ -0,0 +1,33 @@
+debug-build:
+	go build -o ./bin/terraform_provider_pfptmeta_linux_amd64 -gcflags="all=-N -l"
+	./bin/terraform_provider_pfptmeta_linux_amd64 --debug
+
+mod-tidy:
+	go mod tidy
+
+
+unittest:
+	go test ./... $(if $(VERBOSE),"-v") -timeout 120m
+
+
+acc_tests:
+	TF_ACC=1 go test ./... $(if $(VERBOSE),"-v") -run "TestAcc*" -timeout 120m
+
+
+generate:
+	go generate -v -x
+
+
+tests: acc_tests unittest
+
+
+verify_clean: mod-tidy generate
+	! git status -s | grep "??" || (echo "Uncommitted files found" && exit 1)
+	git diff --stat --exit-code || (echo "Uncommitted files found" && exit 1)
+
+local-release: verify_clean tests
+	gpg --batch --import $(GPG_SECRET_PATH) && goreleaser release --rm-dist --snapshot
+
+
+release: verify_clean tests
+	gpg --batch --import $(GPG_SECRET_PATH) && goreleaser release --rm-dist

README.md

@@ -1,62 +1,74 @@
-# Terraform Provider Scaffolding
-
-This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
-
- - A resource, and a data source (`internal/provider/`),
- - Examples (`examples/`) and generated documentation (`docs/`),
- - Miscellaneous meta files.
- 
-These files contain boilerplate code that you will need to edit to create your own Terraform provider. A full guide to creating Terraform providers can be found at [Writing Custom Providers](https://www.terraform.io/docs/extend/writing-custom-providers.html).
-
-Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub.
-
-Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://www.terraform.io/docs/registry/providers/publishing.html) so that others can use it.
+# Terraform Provider for Proofpoint - Meta Networks
 
+See the [Proofpoint - Meta Networks Provider documentation](docs/index.md) to get started using the provider.
 
 ## Requirements
 
--	[Terraform](https://www.terraform.io/downloads.html) >= 0.13.x
--	[Go](https://golang.org/doc/install) >= 1.15
+- [Terraform](https://www.terraform.io/downloads.html) 0.12.x or higher
+- [Go](https://golang.org/doc/install) >= 1.13
+- [Goreleaser](https://goreleaser.com/install/)
 
 ## Building The Provider
 
 1. Clone the repository
-1. Enter the repository directory
-1. Build the provider using the Go `install` command: 
+2. Enter the repository directory
+3. Build the provider using the Go `install` command:
 ```sh
 $ go install
 ```
 
-## Adding Dependencies
+## Developing the Provider
+
+### Adding Dependencies
 
 This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
-Please see the Go documentation for the most up to date information about using Go modules.
+Please see the Go documentation for the most up-to-date information about using Go modules.
 
 To add a new dependency `github.com/author/dependency` to your Terraform provider:
 
-```
-go get github.com/author/dependency
-go mod tidy
+```sh
+$ go get github.com/author/dependency
+$ make mod-tidy
 ```
 
 Then commit the changes to `go.mod` and `go.sum`.
 
-## Using the provider
+If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).
+
+To compile and run the provider locally run:
+```sh
+$ make debug-mode
+```
+And then export the printed `TF_REATTACH_PROVIDERS` as env variable.
 
-Fill this in for each provider
+This will compile the provider in debug mode and will allow you to execute terraform command with it.
 
-## Developing the Provider
+### Documentation
 
-If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).
+In order to generate or update documentation, run `make generate`.
 
-To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
+The documentation are auto-generated using the [docs generation tool](github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs)
+and are based on the resources descriptions in the schema and on the files in the `examples` folder
 
-To generate or update documentation, run `go generate`.
+### Testing
 
-In order to run the full suite of Acceptance tests, run `make testacc`.
+There are two types of tests that can be executed:
+- unit-tests
+- acceptance-tests
 
-*Note:* Acceptance tests create real resources, and often cost money to run.
+Acceptance tests are expressed in terms of Test Cases, each using one or more Terraform configurations designed to create a set of resources under test, and then verify the actual infrastructure created.
 
+*Note:* Acceptance tests create real resources, and often cost money to run, see more about it [here](https://www.terraform.io/docs/extend/testing/acceptance-tests/testcase.html)
+
+In order to run the full suite of Acceptance tests:
+- Configure the authentication env variables or configuration file specified in [provider documentation](docs/index.md).
+- Execute:
 ```sh
-$ make testacc
+$ make acc_tests
+```
+
+In order to tun unit-tests only run
+```shell
+$ make unittest
 ```
+