Merge branch 'reintroduce-config-ds' into 'main'

Reintroduce the gitlabci_runner_config data source

See merge request rsrchboy/terraform-provider-gitlabci!7

Author: rsrchboy

Makefile

@@ -1,6 +1,10 @@
 GOFMT_FILES?=$$(find . -name '*.go' |grep -v vendor)
 
 sources = $(wildcard *.go gitlabci/*.go go.mod helper/**/*.go internal/**/*.go)
+docs = $(wildcard docs/**/*)
+doc_sources = $(wildcard templates/**/* examples/**/resource.tf examples/**/data-source.tf) \
+		examples/provider/provider.tf \
+		$(wildcard examples/registering-a-runner/**/*)
 
 binary_name = terraform-provider-gitlabci
 
@@ -10,13 +14,14 @@ build: $(binary_name)
 
 $(binary_name): $(sources)
 	go build .
+	rm -f .terraform.lock.hcl
 
 test: $(binary_name)
 	go test `go list ./...`
 
 clean:
-	rm -f $(binary_name) predefined_variables.md vars-data
-	rm -rf terraform.d/
+	rm -f $(binary_name) predefined_variables.md vars-data .terraform.lock.hcl
+	rm -rf terraform.d/ .terraform/
 
 fmt:
 	gofmt -w $(GOFMT_FILES)
@@ -33,6 +38,39 @@ vet:
 gen:
 	go generate
 
+$(docs): $(doc_sources)
+	go generate
+
+# generate docs if templates have been changed
+docs: $(docs)
+
+docs-commit: $(docs)
+	git add -A docs/
+	git commit -m 'Update generated docs' -- docs/
+
+gen-third-party: gen-runner-structs
+
+runner_structs_tools = $(wildcard tools/centrifuge/*.go)
+runner_structs_files = $(wildcard third_party/**/*.go)
+
+third-party: $(runner_structs_files)
+	git diff -- third_party/
+
+$(runner_structs_files): $(runner_structs_tools)
+	# go run ./tools/centrifuge/*.go
+	go run $(runner_structs_tools)
+	git diff -- third_party/
+
+gen-runner-structs:
+	# go run ./tools/centrifuge/*.go
+	go run $(runner_structs_tools)
+	git diff -- third_party/
+
+gen-schema:
+	go run ./tools/config-schema-gen/*.go
+
+.PHONY: gen-schema gen-runner-structs gen
+
 # convenience targets for development
 
 tfa: $(binary_name)
@@ -42,11 +80,13 @@ tfp: $(binary_name)
 	terraform init && TF_LOG=TRACE terraform plan
 
 local: $(local_bin)
-	echo
 
 init: $(local_bin)
 	terraform init
 
+plan:
+	terraform plan
+
 $(local_bin): $(binary_name)
 	mkdir -p $(dir $@)
 	cp $(binary_name) $@
@@ -66,4 +106,4 @@ env-ds-struct: vars-data
 env-ds-set: vars-data
 	@cat $< | sed -e 's/^ `//; s/`.*//' | perl -nE 'chomp; say qq{d.Set("} . lc($$_) . qq{", os.Getenv("$$_"))}'
 
-.PHONY: build clean ci-datasource fmt vet tfa tfp test
+.PHONY: build clean fmt vet tfa tfp test

docs/data-sources/runner_config.md

@@ -3,7 +3,8 @@ layout: ""
 page_title: "gitlabci Provider"
 subcategory: ""
 description: |-
-  The GitLabCI provider allows the trivial creation of a runner token.
+  The GitLabCI provider allows the trivial creation of runner tokens and
+  configuration.
 ---
 
 # GitLabCI Provider
@@ -17,6 +18,11 @@ specific user.
 For more information, please see the [Registering a
 runner](guides/registering-a-runner) guide.
 
+This provider also provides data sources related to GitLab CI, including
+[`gitlabci_runner_config`](data-sources/runner_config), a data source allowing
+runner configuration to be generated (much as, say, the AWS provider's
+`aws_iam_policy_document` does for IAM policies).
+
 For a general-purpose provider (that includes the ability to look up
 registration tokens), please see the [GitLab terraform
 provider](https://www.terraform.io/docs/providers/gitlab/).

docs/index.md

@@ -30,7 +30,30 @@ result in the resource being destroyed and recreated.
 See the [Registering a runner](https://registry.terraform.io/providers/rsrchboy/gitlabci/latest/docs/guides/registering-a-runner)
 guide for more information.
 
+## Example Usage
 
+```terraform
+resource "gitlabci_runner_token" "this" {
+  registration_token = var.registration_token
+  locked             = true
+  tags = [
+    "jinx",
+    "powder",
+    "cupcake",
+  ]
+}
+
+variable "registration_token" {
+  type        = string
+  description = "Runner registration token"
+  sensitive   = true
+}
+
+output "token" {
+  sensitive = true
+  value     = gitlabci_runner_token.this.token
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/runner_token.md

@@ -0,0 +1,36 @@
+data "gitlab_project" "this" {
+  id = var.project_id
+}
+
+resource "gitlabci_runner_token" "this" {
+  registration_token = data.gitlab_project.this.runners_token
+  locked             = true
+  tags               = ["jinx", "powder", "cupcake"]
+}
+
+data "gitlabci_runner_config" "this" {
+  log_format = "json"
+  runners {
+    url   = "https://gitlab.com"
+    token = gitlabci_runner_token.this.token
+    # ...
+  }
+}
+
+resource "local_file" "this" {
+  filename = "${path.module}/config.toml"
+  content  = data.gitlabci_runner_config.this.config
+}
+
+output "config" {
+  description = "Our generated runner configuration"
+  value       = data.gitlabci_runner_config.this.config
+}
+
+variable "project_id" {
+  # note this could also legitimately be an int; see
+  # https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs/data-sources/project#id
+  type        = string
+  description = "Project ID (path, e.g. rsrchboy/scratch)"
+}
+

examples/data-sources/gitlabci_runner_config/data-source.tf

@@ -3,30 +3,41 @@ module gitlab.com/rsrchboy/terraform-provider-gitlabci
 go 1.17
 
 require (
+	github.com/BurntSushi/toml v1.0.0
+	github.com/Masterminds/sprig/v3 v3.2.2
+	github.com/giantswarm/to v0.4.0
 	github.com/hashicorp/terraform-plugin-docs v0.5.1
+	github.com/hashicorp/terraform-plugin-log v0.2.1
+	github.com/hashicorp/terraform-plugin-sdk v1.17.2
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.10.1
+	github.com/imdario/mergo v0.3.12
 	github.com/parnurzeal/gorequest v0.2.16
+	github.com/pkg/errors v0.9.1
 	github.com/spf13/pflag v1.0.5
+	github.com/stoewer/go-strcase v1.2.0
+	golang.org/x/tools v0.1.5
 )
 
 require (
-	cloud.google.com/go v0.61.0 // indirect
+	cloud.google.com/go v0.81.0 // indirect
 	cloud.google.com/go/storage v1.10.0 // indirect
-	github.com/Masterminds/goutils v1.1.0 // indirect
+	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver v1.5.0 // indirect
+	github.com/Masterminds/semver/v3 v3.1.1 // indirect
 	github.com/Masterminds/sprig v2.22.0+incompatible // indirect
+	github.com/Microsoft/go-winio v0.4.17 // indirect
 	github.com/agext/levenshtein v1.2.3 // indirect
 	github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect
 	github.com/armon/go-radix v1.0.0 // indirect
-	github.com/aws/aws-sdk-go v1.25.3 // indirect
+	github.com/aws/aws-sdk-go v1.37.0 // indirect
 	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect
 	github.com/bgentry/speakeasy v0.1.0 // indirect
 	github.com/elazarl/goproxy v0.0.0-20191011121108-aa519ddbe484 // indirect
 	github.com/fatih/color v1.13.0 // indirect
-	github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
-	github.com/google/go-cmp v0.5.6 // indirect
-	github.com/google/uuid v1.1.2 // indirect
+	github.com/google/go-cmp v0.5.7 // indirect
+	github.com/google/uuid v1.2.0 // indirect
 	github.com/googleapis/gax-go/v2 v2.0.5 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-checkpoint v0.5.0 // indirect
@@ -42,16 +53,14 @@ require (
 	github.com/hashicorp/hcl/v2 v2.11.1 // indirect
 	github.com/hashicorp/terraform-exec v0.15.0 // indirect
 	github.com/hashicorp/terraform-json v0.13.0 // indirect
-	github.com/hashicorp/terraform-plugin-go v0.5.0 // indirect
-	github.com/hashicorp/terraform-plugin-log v0.2.1 // indirect
+	github.com/hashicorp/terraform-plugin-go v0.7.0 // indirect
 	github.com/hashicorp/terraform-registry-address v0.0.0-20210816115301-cb2034eba045 // indirect
 	github.com/hashicorp/terraform-svchost v0.0.0-20200729002733-f050f53b9734 // indirect
 	github.com/hashicorp/yamux v0.0.0-20211028200310-0bc27b27de87 // indirect
 	github.com/huandu/xstrings v1.3.2 // indirect
-	github.com/imdario/mergo v0.3.12 // indirect
-	github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af // indirect
+	github.com/jmespath/go-jmespath v0.4.0 // indirect
 	github.com/jstemmer/go-junit-report v0.9.1 // indirect
-	github.com/klauspost/compress v1.11.2 // indirect
+	github.com/klauspost/compress v1.11.13 // indirect
 	github.com/mattn/go-colorable v0.1.12 // indirect
 	github.com/mattn/go-isatty v0.0.14 // indirect
 	github.com/mitchellh/cli v1.1.2 // indirect
@@ -62,27 +71,31 @@ require (
 	github.com/mitchellh/mapstructure v1.4.3 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/oklog/run v1.1.0 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/posener/complete v1.2.1 // indirect
 	github.com/russross/blackfriday v1.6.0 // indirect
+	github.com/shopspring/decimal v1.2.0 // indirect
 	github.com/smartystreets/goconvey v1.6.4 // indirect
+	github.com/spf13/cast v1.3.1 // indirect
 	github.com/ulikunitz/xz v0.5.8 // indirect
 	github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
+	github.com/vmihailenco/msgpack/v4 v4.3.12 // indirect
+	github.com/vmihailenco/tagparser v0.1.2 // indirect
 	github.com/zclconf/go-cty v1.10.0 // indirect
-	go.opencensus.io v0.22.4 // indirect
-	golang.org/x/crypto v0.0.0-20210616213533-5ff15b29337e // indirect
-	golang.org/x/lint v0.0.0-20200302205851-738671d3881b // indirect
-	golang.org/x/mod v0.3.0 // indirect
-	golang.org/x/net v0.0.0-20220111093109-d55c255bac03 // indirect
-	golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d // indirect
-	golang.org/x/sys v0.0.0-20220111092808-5a964db01320 // indirect
+	go.opencensus.io v0.23.0 // indirect
+	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 // indirect
+	golang.org/x/lint v0.0.0-20201208152925-83fdc39ff7b5 // indirect
+	golang.org/x/mod v0.4.2 // indirect
+	golang.org/x/net v0.0.0-20220121210141-e204ce36a2ba // indirect
+	golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f // indirect
+	golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
 	golang.org/x/text v0.3.7 // indirect
-	golang.org/x/tools v0.0.0-20200713011307-fd294ab11aed // indirect
 	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
-	google.golang.org/api v0.29.0 // indirect
+	google.golang.org/api v0.43.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
-	google.golang.org/genproto v0.0.0-20220112215332-a9c7c0acf9f2 // indirect
+	google.golang.org/genproto v0.0.0-20220118154757-00ab72f36ad5 // indirect
 	google.golang.org/grpc v1.43.0 // indirect
 	google.golang.org/protobuf v1.27.1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 	moul.io/http2curl v1.0.0 // indirect
 )