Merge pull request #7 from wundergraph/andi/eng-5704-inquiring-about-…

…resources-for-contracts-in-terraform

feat: enable contract usage

Makefile

@@ -72,6 +72,7 @@ include examples/Makefile
 .PHONY: e2e-cd e2e-cosmo e2e-cosmo-monograph clean
 
 e2e-apply-cd:
+	rm -rf examples/provider/.terraform.lock.hcl
 	FEATURE=examples/provider make e2e-init
 	FEATURE=examples/provider make e2e-apply 
 
@@ -82,24 +83,37 @@ e2e-clean-cd:
 	make e2e-clean 
 
 e2e-apply-cosmo: 
-	FEATURE=examples/cosmo make e2e-init 
-	FEATURE=examples/cosmo make e2e-apply 
+	rm -rf examples/guides/cosmo/.terraform.lock.hcl
+	FEATURE=examples/guides/cosmo make e2e-init 
+	FEATURE=examples/guides/cosmo make e2e-apply 
 
 e2e-destroy-cosmo: 
-	FEATURE=examples/cosmo make e2e-destroy 
+	FEATURE=examples/guides/cosmo make e2e-destroy 
 
 e2e-clean-cosmo: 
-	FEATURE=examples/cosmo make e2e-clean
+	FEATURE=examples/guides/cosmo make e2e-clean
 
 e2e-apply-cosmo-monograph: 
-	FEATURE=examples/resources/comso_monograph make e2e-init 
-	FEATURE=examples/resources/comso_monograph make e2e-apply 
+	rm -rf examples/guides/cosmo-monograph/.terraform.lock.hcl
+	FEATURE=examples/guides/cosmo-monograph make e2e-init 
+	FEATURE=examples/guides/cosmo-monograph make e2e-apply 
 
 e2e-destroy-cosmo-monograph: 
-	FEATURE=examples/resources/comso_monograph make e2e-destroy 
+	FEATURE=examples/guides/cosmo-monograph make e2e-destroy 
 
 e2e-clean-cosmo-monograph: 
-	FEATURE=examples/resources/comso_monograph make e2e-clean
+	FEATURE=examples/guides/cosmo-monograph make e2e-clean
+
+e2e-apply-cosmo-monograph-contract: 
+	rm -rf examples/guides/cosmo-monograph-contract/.terraform.lock.hcl
+	FEATURE=examples/guides/cosmo-monograph-contract make e2e-init 
+	FEATURE=examples/guides/cosmo-monograph-contract make e2e-apply 
+
+e2e-destroy-cosmo-monograph-contract: 
+	FEATURE=examples/guides/cosmo-monograph-contract make e2e-destroy 
+
+e2e-clean-cosmo-monograph-contract: 
+	FEATURE=examples/guides/cosmo-monograph-contract make e2e-clean
 
 ## Cosmo Local
 # Full example installing cosmo locally with a minikube kubernetes cluster 
@@ -108,23 +122,25 @@ e2e-clean-cosmo-monograph:
 # output "hosts" generated after apply
 
 e2e-apply-cosmo-local: 
-	rm -rf examples/cosmo-local/.terraform.lock.hcl
-	FEATURE=examples/cosmo-local make e2e-init 
-	FEATURE=examples/cosmo-local make e2e-apply 
+	rm -rf examples/guides/cosmo-local/.terraform.lock.hcl
+	FEATURE=examples/guides/cosmo-local make e2e-init 
+	FEATURE=examples/guides/cosmo-local make e2e-apply 
 
 e2e-destroy-cosmo-local: 
-	FEATURE=examples/cosmo-local make e2e-destroy 
+	FEATURE=examples/guides/cosmo-local make e2e-destroy 
 
 e2e-clean-cosmo-local: 
-	FEATURE=examples/cosmo-local make e2e-clean
+	FEATURE=examples/guides/cosmo-local make e2e-clean
 
 ## Convenience targets to run specific e2e tests
 
 e2e-cd: e2e-apply-cd e2e-destroy-cd
 e2e-cosmo: e2e-apply-cosmo e2e-destroy-cosmo
 e2e-cosmo-monograph: e2e-apply-cosmo-monograph e2e-destroy-cosmo-monograph
+e2e-cosmo-monograph-contract: e2e-apply-cosmo-monograph-contract e2e-destroy-cosmo-monograph-contract
+e2e-cosmo-local: e2e-apply-cosmo-local e2e-destroy-cosmo-local
 
-e2e: e2e-cd e2e-cosmo e2e-cosmo-monograph
+e2e: e2e-cd e2e-cosmo e2e-cosmo-monograph e2e-cosmo-monograph-contract
 
-clean: e2e-clean-cd e2e-clean-cosmo e2e-clean-cosmo-monograph clean-local
-destroy: e2e-destroy-cd e2e-destroy-cosmo e2e-destroy-cosmo-monograph
+clean: e2e-clean-cd e2e-clean-cosmo e2e-clean-cosmo-monograph e2e-clean-cosmo-monograph-contract clean-local
+destroy: e2e-destroy-cd e2e-destroy-cosmo e2e-destroy-cosmo-monograph e2e-destroy-cosmo-monograph-contract e2e-destroy-cosmo-local

README.md

@@ -203,24 +203,45 @@ The following commands are used to build and install the provider binary locally
 
 The Makefile includes several tasks to facilitate development and testing. For local development, `make build install` should be used to install the provider locally.
 
+### General Build Tasks
+
 - **default**: Runs acceptance tests.
 - **testacc**: Runs tests with a timeout.
+- **test-go**: Runs Go tests.
+- **test**: Cleans, builds, installs, runs acceptance tests, and executes end-to-end tests.
 - **generate**: Updates generated files.
 - **tidy**: Cleans up the `go.mod` file.
-- **fmt**: Formats code.
+- **fmt**: Formats Go and Terraform files for consistency.
 - **build**: Compiles the provider binary.
 - **install**: Installs the binary in the Terraform plugin directory after building it.
+- **clean-local**: Cleans up local build artifacts.
 - **build-all-arches**: Compiles the binary for multiple OS and architectures.
-- **release**: Generates files and builds binaries for all architectures.
-- **e2e-cd-apply**: Runs end-to-end tests for apply. (References: `examples/provider`)
-- **e2e-cd-destroy**: Runs end-to-end tests for destroy. (References: `examples/provider`)
-- **e2e-cosmo-apply**: Runs end-to-end tests for the cosmo feature. (References: `examples/cosmo`)
-- **e2e-cosmo-destroy**: Runs end-to-end tests for cosmo destroy. (References: `examples/cosmo`)
-- **e2e-cosmo-monograph-apply**: Runs end-to-end tests for the monograph feature. (References: `examples/resources/comso_monograph`)
-- **e2e-cosmo-monograph-destroy**: Runs end-to-end tests for monograph destroy. (References: `examples/resources/comso_monograph`)
-- **e2e-apply-cosmo-local**: Runs end-to-end tests for cosmo local. (References: `examples/cosmo-local`)
-- **e2e-destroy-cosmo-local**: Runs end-to-end tests for cosmo local destroy. (References: `examples/cosmo-local`)
-- **e2e-clean-cosmo-local**: Cleans up the cosmo local setup. (References: `examples/cosmo-local`)
+
+### End-to-End (E2E) Tasks
+
+- **e2e-apply-cd**: Runs end-to-end tests for the CD feature (points to `examples/provider`).
+- **e2e-destroy-cd**: Cleans up after CD tests (points to `examples/provider`).
+- **e2e-clean-cd**: Cleans up CD test artifacts (points to `examples/provider`).
+- **e2e-apply-cosmo**: Runs end-to-end tests for the Cosmo feature (points to `examples/guides/cosmo`).
+- **e2e-destroy-cosmo**: Cleans up after Cosmo tests (points to `examples/guides/cosmo`).
+- **e2e-clean-cosmo**: Cleans up Cosmo test artifacts (points to `examples/guides/cosmo`).
+- **e2e-apply-cosmo-monograph**: Runs end-to-end tests for the Cosmo monograph feature (points to `examples/guides/cosmo-monograph`).
+- **e2e-destroy-cosmo-monograph**: Cleans up after Cosmo monograph tests (points to `examples/guides/cosmo-monograph`).
+- **e2e-clean-cosmo-monograph**: Cleans up Cosmo monograph test artifacts (points to `examples/guides/cosmo-monograph`).
+- **e2e-apply-cosmo-monograph-contract**: Runs end-to-end tests for the Cosmo monograph contract feature (points to `examples/guides/cosmo-monograph-contract`).
+- **e2e-destroy-cosmo-monograph-contract**: Cleans up after Cosmo monograph contract tests (points to `examples/guides/cosmo-monograph-contract`).
+- **e2e-clean-cosmo-monograph-contract**: Cleans up Cosmo monograph contract test artifacts (points to `examples/guides/cosmo-monograph-contract`).
+- **e2e-apply-cosmo-local**: Runs end-to-end tests for the local Cosmo setup (points to `examples/guides/cosmo-local`).
+- **e2e-destroy-cosmo-local**: Cleans up after local Cosmo tests (points to `examples/guides/cosmo-local`).
+- **e2e-clean-cosmo-local**: Cleans up local Cosmo test artifacts (points to `examples/guides/cosmo-local`).
+- **e2e-cd**: Runs both apply and destroy for CD tests.
+- **e2e-cosmo**: Runs both apply and destroy for Cosmo tests.
+- **e2e-cosmo-monograph**: Runs both apply and destroy for Cosmo monograph tests.
+- **e2e-cosmo-monograph-contract**: Runs both apply and destroy for Cosmo monograph contract tests.
+- **e2e-cosmo-local**: Runs both apply and destroy for local Cosmo tests.
+- **e2e**: Runs all end-to-end tests.
+- **clean**: Cleans up all test artifacts and local builds.
+- **destroy**: Cleans up all resources created by the tests.
 
 ## Releasing
 

docs/data-sources/contract.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "cosmo_contract Data Source - cosmo"
+subcategory: ""
+description: |-
+  
+---
+
+# cosmo_contract (Data Source)
+
+
+
+## Example Usage
+
+```terraform
+data "cosmo_subgraph" "test" {
+  name      = var.name
+  namespace = var.namespace
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) The name of the federated graph.
+- `namespace` (String) The namespace in which the federated graph is located.
+
+### Read-Only
+
+- `admission_webhook_secret` (String, Sensitive) The secret token used to authenticate the admission webhook requests.
+- `admission_webhook_url` (String) The URL for the admission webhook that will be triggered during graph operations.
+- `id` (String) The unique identifier of the federated graph resource, automatically generated by the system.
+- `label_matchers` (Map of String) A list of label matchers used to select the services that will form the federated graph.
+- `readme` (String) Readme content for the federated graph.
+- `routing_url` (String) The URL for the federated graph.

docs/data-sources/federated_graph.md

@@ -13,15 +13,6 @@ Cosmo Federated Graph Data Source
 ## Example Usage
 
 ```terraform
-terraform {
-  required_providers {
-    cosmo = {
-      source  = "terraform.local/wundergraph/cosmo"
-      version = "0.0.1"
-    }
-  }
-}
-
 data "cosmo_federated_graph" "test" {
   name      = var.name
   namespace = var.namespace

docs/data-sources/monograph.md

@@ -13,15 +13,6 @@ Cosmo Monograph Data Source
 ## Example Usage
 
 ```terraform
-terraform {
-  required_providers {
-    cosmo = {
-      source  = "terraform.local/wundergraph/cosmo"
-      version = "0.0.1"
-    }
-  }
-}
-
 data "cosmo_monograph" "example" {
   name = var.name
 }

docs/data-sources/namespace.md

@@ -13,15 +13,6 @@ Cosmo Namespace Data Source
 ## Example Usage
 
 ```terraform
-terraform {
-  required_providers {
-    cosmo = {
-      source  = "terraform.local/wundergraph/cosmo"
-      version = "0.0.1"
-    }
-  }
-}
-
 data "cosmo_namespace" "test" {
   name = var.name
 }

docs/data-sources/subgraph.md

@@ -13,15 +13,6 @@ Cosmo Subgraph Data Source
 ## Example Usage
 
 ```terraform
-terraform {
-  required_providers {
-    cosmo = {
-      source  = "terraform.local/wundergraph/cosmo"
-      version = "0.0.1"
-    }
-  }
-}
-
 data "cosmo_subgraph" "test" {
   name      = var.name
   namespace = var.namespace

docs/index.md

@@ -4,34 +4,24 @@ page_title: "cosmo Provider"
 subcategory: ""
 description: |-
   The Cosmo provider allows you to interact with WunderGraph's Cosmo API, managing key resources.
-  It supports creating and reading namespaces, federated graphs, and monographs.
-  You can also generate router tokens for use with the router, and manage subgraphs by creating, publishing, or reading them.
+  It supports creating and reading namespaces, federated graphs, subgraphs, router tokens, monographs, and contracts.
   Refer to the official Cosmo Documentation https://cosmo-docs.wundergraph.com/ for more details.
 ---
 
 # cosmo Provider
 
 The Cosmo provider allows you to interact with WunderGraph's Cosmo API, managing key resources. 
-It supports creating and reading namespaces, federated graphs, and monographs. 
-You can also generate router tokens for use with the router, and manage subgraphs by creating, publishing, or reading them. 
+It supports creating and reading namespaces, federated graphs, subgraphs, router tokens, monographs, and contracts. 
 
 Refer to the official [Cosmo Documentation](https://cosmo-docs.wundergraph.com/) for more details.
 
 ## Example Usage
 
 ```terraform
-terraform {
-  required_providers {
-    cosmo = {
-      source  = "terraform.local/wundergraph/cosmo"
-      version = "0.0.1"
-    }
-  }
-}
-
 provider "cosmo" {
-  api_url = var.api_url
   api_key = var.api_key
+  # Set to your onpremise instance if needed
+  # api_url = var.api_url
 }
 ```
 
@@ -40,5 +30,5 @@ provider "cosmo" {
 
 ### Optional
 
-- `api_key` (String) The Api Key to be used: COSMO_API_KEY
-- `api_url` (String) The Api Url to be used: COSMO_API_URL
+- `api_key` (String) The Api Key to be used: Leave blank to use the COSMO_API_KEY environment variable
+- `api_url` (String) The Api Url to be used: Leave blank to use: https://cosmo-cp.wundergraph.com or use the COSMO_API_URL environment variable

docs/resources/contract.md

@@ -0,0 +1,47 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "cosmo_contract Resource - cosmo"
+subcategory: ""
+description: |-
+  A contract is a Terraform resource representing a single subgraph with GraphQL Federation enabled, allowing developers to build versatile, multi-audience graphs while simplifying development and ensuring maintainability.
+  For more information, refer to the Cosmo Documentation at https://cosmo-docs.wundergraph.com/concepts/schema-contracts.
+---
+
+# cosmo_contract (Resource)
+
+A contract is a Terraform resource representing a single subgraph with GraphQL Federation enabled, allowing developers to build versatile, multi-audience graphs while simplifying development and ensuring maintainability. 
+
+For more information, refer to the Cosmo Documentation at https://cosmo-docs.wundergraph.com/concepts/schema-contracts.
+
+## Example Usage
+
+```terraform
+resource "cosmo_contract" "test" {
+  name         = var.name
+  namespace    = var.namespace
+  source       = var.source_graph_name
+  routing_url  = var.routing_url
+  exclude_tags = var.exclude_tags
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String)
+- `namespace` (String)
+- `routing_url` (String)
+- `source` (String)
+
+### Optional
+
+- `admission_webhook_secret` (String)
+- `admission_webhook_url` (String)
+- `exclude_tags` (List of String)
+- `readme` (String)
+
+### Read-Only
+
+- `id` (String) The ID of this resource.

docs/resources/federated_graph.md

@@ -16,15 +16,6 @@ For more information on federated graphs, please refer to the [Cosmo Documentati
 ## Example Usage
 
 ```terraform
-terraform {
-  required_providers {
-    cosmo = {
-      source  = "terraform.local/wundergraph/cosmo"
-      version = "0.0.1"
-    }
-  }
-}
-
 resource "cosmo_federated_graph" "test" {
   name           = var.name
   routing_url    = var.routing_url

docs/resources/monograph.md

@@ -13,7 +13,16 @@ A monograph is a resource that represents a single subgraph with GraphQL Federat
 
 For more information on monographs, please refer to the [Cosmo Documentation](https://cosmo-docs.wundergraph.com/cli/monograph).
 
-
+## Example Usage
+
+```terraform
+resource "cosmo_monograph" "example" {
+  name        = var.monograph_name
+  namespace   = var.monograph_namespace
+  graph_url   = var.monograph_graph_url
+  routing_url = var.monograph_routing_url
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/namespace.md

@@ -16,15 +16,6 @@ For more information on namespaces, please refer to the [Cosmo Documentation](ht
 ## Example Usage
 
 ```terraform
-terraform {
-  required_providers {
-    cosmo = {
-      source  = "terraform.local/wundergraph/cosmo"
-      version = "0.0.1"
-    }
-  }
-}
-
 resource "cosmo_namespace" "test" {
   name = var.name
 }