[TFgen] Phase 1 Setup CLI (#3842)

* [1.4] Add a github workflow for build + vet

* [1.5] Add make command to build/test the generator

* [1.6] Create testdata/fixtures with README

* root formatting fixes

* updated 1.4 to any branch and added go depencency files to paths

Author: j10czar

.generator-v2/internal/cli/root.go

@@ -16,9 +16,9 @@ type globalFlags struct {
 
 func newRootCmd(version string, flags *globalFlags) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "tfgen",
-		Short:   "Datadog Terraform Provider Generator",
-		Version: version,
+		Use:          "tfgen",
+		Short:        "Datadog Terraform Provider Generator",
+		Version:      version,
 		SilenceUsage: true,
 	}
 

.generator-v2/internal/testdata/fixtures/README.md

@@ -0,0 +1,32 @@
+# Fixture Catalogue
+
+Curated test inputs for the `tfgen` end-to-end suite. Each fixture is a self-contained directory holding everything needed to drive the generator and assert on its output: an OpenAPI input spec and the expected golden code the generator should produce from it.
+
+The E2E suite runs `tfgen` against a fixture's `openapi.yaml` and compares the result against the committed `out/` directory. Each fixture therefore exercises one specific generator capability end to end.
+
+## Layout
+
+Each fixture is a directory under this one:
+
+```
+<fixture_name>/
+├── openapi.yaml         # Input spec with x-datadog-tf-generator annotations
+├── out/                 # Expected golden output (committed)
+│   └── *.go
+└── README.md            # (optional) what this fixture exercises
+```
+
+- **`openapi.yaml`** — the OpenAPI spec the generator reads. The resources and data sources to generate are marked with the `x-datadog-tf-generator` extension.
+- **`out/`** — the golden output: the `.go` files the generator is expected to emit. These are committed and diffed against on every run. When generator behavior changes intentionally, regenerate this directory and review the diff by hand.
+- **`README.md`** *(optional)* — a short note describing the capability the fixture targets (e.g. a particular schema shape, a hook, or an error path).
+
+## Naming
+
+Name each fixture after the artifact it generates so the catalogue reads as a list of capabilities:
+
+- `data_source_<name>` — a generated data source (e.g. `data_source_pet`).
+- `resource_<name>` — a generated resource.
+- Append a distinguishing suffix when a fixture targets a variant or edge case (e.g. `data_source_team_with_hooks`, `broken_hook_signature`).
+
+> [!NOTE]
+> This catalogue is currently empty. Fixtures are added in later phases as the corresponding generator capabilities land.

.github/workflows/tfgen.yml

@@ -0,0 +1,42 @@
+name: Generator Checks
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    paths:
+      - ".generator-v2/internal/**"
+      - ".generator-v2/cmd/tfgen/**"
+      - ".generator-v2/go.mod"
+      - ".generator-v2/go.sum"
+      - ".github/workflows/tfgen.yml"
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}-tfgen
+  cancel-in-progress: true
+
+jobs:
+  build-and-vet:
+    name: build and vet
+    runs-on: ubuntu-latest
+    if: github.event.action != 'closed' && github.event.pull_request.merged != true
+    defaults:
+      run:
+        working-directory: .generator-v2
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744
+
+      - name: Install Go
+        uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe
+        with:
+          go-version-file: .generator-v2/go.mod
+          cache: true
+          cache-dependency-path: .generator-v2/go.sum
+
+      - name: go build
+        run: go build ./cmd/tfgen/...
+
+      - name: go vet
+        run: go vet ./cmd/tfgen/...

GNUmakefile

@@ -6,6 +6,7 @@ DIR=~/.terraform.d/plugins
 ZORKIAN_VERSION?=master
 API_CLIENT_VERSION?=master
 LOCAL_PACKAGE="github.com/terraform-providers/terraform-provider-datadog"
+GO?=go
 
 default: build
 
@@ -68,6 +69,16 @@ test-compile: get-test-deps
 		exit 1; \
 	fi
 	gotestsum --format testname -- -c $(TEST) $(TESTARGS)
+	
+# Build the tfgen binary into bin/tfgen (generator lives in its own module under .generator-v2)
+tfgen-build:
+	cd .generator-v2 && $(GO) build -o $(CURDIR)/bin/tfgen ./cmd/tfgen
+	@echo "Built tfgen -> bin/tfgen"
+
+# Run the tfgen module's unit tests
+tfgen-test:
+	cd .generator-v2 && $(GO) test ./internal/... ./cmd/tfgen/...
+	@echo "tfgen tests passed"
 
 update-go-client:
 	echo "Updating the Zorkian client to ${ZORKIAN_VERSION} and the API Client to ${API_CLIENT_VERSION}"
@@ -103,4 +114,4 @@ check-docs: docs
 		echo "Success: No generated documentation changes detected"; \
 	fi
 
-.PHONY: build check-docs docs test testall testacc cassettes vet fmt fmtcheck errcheck lint lint-new lint-fix test-compile get-test-deps license-check sweep
+.PHONY: build check-docs docs test testall testacc tfgen-build tfgen-test cassettes vet fmt fmtcheck errcheck lint lint-new lint-fix test-compile get-test-deps license-check sweep