Add workspaces support to HTTP backend

[lenaing]

Hi,

Here is an implementation of HTTP remote backend workspace handling by passing workspace information as query param.

Work was influenced by the lock implementation that pass the LockID information as query parameter on all subsequent requests.

This version passes the workspace also as query parameter to all operations if workspace is not the default one, enabling the remote HTTP endpoint to act accordingly with minimal user configuration.
Workspace path handling implementation is left to the remote HTTP endpoint.

If workspaces_address is enabled, Terraform act as if workspaces are enabled and will:

• use by default the OPTIONS HTTP method to list current workspaces.
• use the DELETE HTTP method to remove a workspace.

If workspaces_address is not enabled, workspace are disabled.

A simple backend configuration could then be:

terraform {
  backend "http" {
    address = "http://myrestapi.example.com/foo"
    lock_address = "http://myrestapi.example.com/foo"
    unlock_address = "http://myrestapi.example.com/foo"
    workspaces_address = "http://myrestapi.example.com/foo"
  }
}

Also, workspaces handling can be enabled on default address through the workspaces setting.

terraform {
  backend "http" {
    address = "http://myrestapi.example.com/foo"
    lock_address = "http://myrestapi.example.com/foo"
    unlock_address = "http://myrestapi.example.com/foo"
    workspaces = true
  }
}

Regards,

[hashicorp-cla]

All committers have signed the CLA.

[codecov]

Codecov Report

Merging #26796 into master will increase coverage by 0.00%.
The diff coverage is 54.63%.

Impacted Files	Coverage Δ
backend/remote-state/http/backend.go	77.90% <53.19%> (-7.25%)	⬇️
backend/remote-state/http/client.go	50.90% <56.00%> (+0.48%)	⬆️
internal/providercache/dir.go	67.34% <0.00%> (-6.13%)	⬇️
terraform/node_resource_apply_instance.go	75.78% <0.00%> (+0.78%)	⬆️
terraform/eval_diff.go	67.43% <0.00%> (+0.91%)	⬆️
dag/marshal.go	54.79% <0.00%> (+1.36%)	⬆️
terraform/node_resource_plan.go	97.16% <0.00%> (+1.88%)	⬆️

[kalw]

Hi there !

Is this PR relate to specific issues encountered with #26032 ?

[lenaing]

Hello,

Yes it does. I worked on the subject prior checking if another PR was already opened... so I launched a discussion thread here about the implementation : #26797
My PR only deals with workspaces support however, not HTTP header injection if that's what your are looking for.

Regards,

[zeitounator]

Hello, is someone from hashicorp actually looking at this PR and related discussion?

[gmarkey]

This would be such a powerful enhancement for Terraform; it would be great if someone from Hashicorp could take a look at the associated PR.

[hartkibo]

this would be a really nice addition, please someone have a look