Skip to content

feat: add coder_git_auth data source #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/data-sources/git_auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "coder_git_auth Data Source - terraform-provider-coder"
subcategory: ""
description: |-
Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated git clone in startup scripts.
---

# coder_git_auth (Data Source)

Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.

## Example Usage

```terraform
provider "coder" {
}

data "coder_git_auth" "github" {
# Matches the ID of the git auth provider in Coder.
id = "github"
}

resource "coder_agent" "dev" {
os = "linux"
arch = "amd64"
dir = "~/coder"
env = {
GITHUB_TOKEN : data.coder_git_auth.github.access_token
}
startup_script = <<EOF
if [ ! -d ~/coder ]; then
git clone https://github.com/coder/coder
fi
EOF
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The identifier of a configured git auth provider set up in your Coder deployment.

### Read-Only

- `access_token` (String) The access token returned by the git authentication provider. This can be used to pre-authenticate command-line tools.


21 changes: 21 additions & 0 deletions examples/data-sources/coder_git_auth/data-source.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
provider "coder" {
}

data "coder_git_auth" "github" {
# Matches the ID of the git auth provider in Coder.
id = "github"
}

resource "coder_agent" "dev" {
os = "linux"
arch = "amd64"
dir = "~/coder"
env = {
GITHUB_TOKEN : data.coder_git_auth.github.access_token
}
startup_script = <<EOF
if [ ! -d ~/coder ]; then
git clone https://github.com/coder/coder
fi
EOF
}
49 changes: 49 additions & 0 deletions provider/gitauth.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package provider

import (
"context"
"fmt"
"os"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)

// gitAuthDataSource returns a schema for a Git authentication data source.
func gitAuthDataSource() *schema.Resource {
return &schema.Resource{
Description: "Use this data source to require users to authenticate with a Git provider prior to workspace creation. This can be used to perform an authenticated `git clone` in startup scripts.",
ReadContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
rawID, ok := rd.GetOk("id")
if !ok {
return diag.Errorf("id is required")
}
id, ok := rawID.(string)
if !ok {
return diag.Errorf("unexpected type %q for id", rawID)
}
rd.SetId(id)

accessToken := os.Getenv(GitAuthAccessTokenEnvironmentVariable(id))
rd.Set("access_token", accessToken)

return nil
},
Schema: map[string]*schema.Schema{
"id": {
Type: schema.TypeString,
Required: true,
Description: "The identifier of a configured git auth provider set up in your Coder deployment.",
},
"access_token": {
Type: schema.TypeString,
Computed: true,
Description: "The access token returned by the git authentication provider. This can be used to pre-authenticate command-line tools.",
},
},
}
}

func GitAuthAccessTokenEnvironmentVariable(id string) string {
return fmt.Sprintf("CODER_GIT_AUTH_ACCESS_TOKEN_%s", id)
}
44 changes: 44 additions & 0 deletions provider/gitauth_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package provider_test

import (
"testing"

"github.com/coder/terraform-provider-coder/provider"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"

"github.com/stretchr/testify/require"
)

func TestGitAuth(t *testing.T) {
t.Parallel()

resource.Test(t, resource.TestCase{
Providers: map[string]*schema.Provider{
"coder": provider.New(),
},
IsUnitTest: true,
Steps: []resource.TestStep{{
Config: `
provider "coder" {
}
data "coder_git_auth" "github" {
id = "github"
}
`,
Check: func(state *terraform.State) error {
require.Len(t, state.Modules, 1)
require.Len(t, state.Modules[0].Resources, 1)
resource := state.Modules[0].Resources["data.coder_git_auth.github"]
require.NotNil(t, resource)

attribs := resource.Primary.Attributes
require.Equal(t, "github", attribs["id"])

return nil
},
}},
})
}
1 change: 1 addition & 0 deletions provider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ func New() *schema.Provider {
"coder_workspace": workspaceDataSource(),
"coder_provisioner": provisionerDataSource(),
"coder_parameter": parameterDataSource(),
"coder_git_auth": gitAuthDataSource(),
},
ResourcesMap: map[string]*schema.Resource{
"coder_agent": agentResource(),
Expand Down