Skip to content

feat: add data sources github_actions_remove_token and github_actions_organization_remove_token #2702

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
49 changes: 49 additions & 0 deletions github/data_source_github_actions_organization_remove_token.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package github

import (
"context"
"fmt"
"log"

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

func dataSourceGithubActionsOrganizationRemoveToken() *schema.Resource {
return &schema.Resource{
Read: dataSourceGithubActionsOrganizationRemoveTokenRead,

Schema: map[string]*schema.Schema{
"token": {
Type: schema.TypeString,
Computed: true,
},
"expires_at": {
Type: schema.TypeInt,
Computed: true,
},
},
}
}

func dataSourceGithubActionsOrganizationRemoveTokenRead(d *schema.ResourceData, meta interface{}) error {
client := meta.(*Owner).v3client
owner := meta.(*Owner).name

log.Printf("[DEBUG] Creating a GitHub Actions organization remove token for %s", owner)
token, _, err := client.Actions.CreateOrganizationRemoveToken(context.TODO(), owner)
if err != nil {
return fmt.Errorf("error creating a GitHub Actions organization remove token for %s: %s", owner, err)
}

d.SetId(owner)
err = d.Set("token", token.Token)
if err != nil {
return err
}
err = d.Set("expires_at", token.ExpiresAt.Unix())
if err != nil {
return err
}

return nil
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package github

import (
"testing"

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

func TestAccGithubActionsOrganizationRemoveTokenDataSource(t *testing.T) {

t.Run("get an organization remove token without error", func(t *testing.T) {

config := `
data "github_actions_organization_remove_token" "test" {
}
`

check := resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttrSet("data.github_actions_organization_remove_token.test", "token"),
resource.TestCheckResourceAttrSet("data.github_actions_organization_remove_token.test", "expires_at"),
)

testCase := func(t *testing.T, mode string) {
resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessMode(t, mode) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: config,
Check: check,
},
},
})
}

t.Run("with an anonymous account", func(t *testing.T) {
t.Skip("anonymous account not supported for this operation")
})

t.Run("with an individual account", func(t *testing.T) {
testCase(t, individual)
})

t.Run("with an organization account", func(t *testing.T) {
testCase(t, organization)
})

})
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ func TestAccGithubActionsRegistrationTokenDataSource(t *testing.T) {
resource "github_repository" "test" {
name = "tf-acc-test-%[1]s"
auto_init = true
vulnerability_alerts = true
}

data "github_actions_registration_token" "test" {
Expand Down
55 changes: 55 additions & 0 deletions github/data_source_github_actions_remove_token.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package github

import (
"context"
"fmt"
"log"

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

func dataSourceGithubActionsRemoveToken() *schema.Resource {
return &schema.Resource{
Read: dataSourceGithubActionsRemoveTokenRead,

Schema: map[string]*schema.Schema{
"repository": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
},
"token": {
Type: schema.TypeString,
Computed: true,
},
"expires_at": {
Type: schema.TypeInt,
Computed: true,
},
},
}
}

func dataSourceGithubActionsRemoveTokenRead(d *schema.ResourceData, meta interface{}) error {
client := meta.(*Owner).v3client
owner := meta.(*Owner).name
repoName := d.Get("repository").(string)

log.Printf("[DEBUG] Creating a GitHub Actions repository remove token for %s/%s", owner, repoName)
token, _, err := client.Actions.CreateRemoveToken(context.TODO(), owner, repoName)
if err != nil {
return fmt.Errorf("error creating a GitHub Actions repository remove token for %s/%s: %s", owner, repoName, err)
}

d.SetId(fmt.Sprintf("%s/%s", owner, repoName))
err = d.Set("token", token.Token)
if err != nil {
return err
}
err = d.Set("expires_at", token.ExpiresAt.Unix())
if err != nil {
return err
}

return nil
}
61 changes: 61 additions & 0 deletions github/data_source_github_actions_remove_token_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
package github

import (
"fmt"
"testing"

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

func TestAccGithubActionsRemoveTokenDataSource(t *testing.T) {

randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)

t.Run("get a repository remove token without error", func(t *testing.T) {

config := fmt.Sprintf(`
resource "github_repository" "test" {
name = "tf-acc-test-%[1]s"
auto_init = true
vulnerability_alerts = true
}

data "github_actions_remove_token" "test" {
repository = github_repository.test.id
}
`, randomID)

check := resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr("data.github_actions_remove_token.test", "repository", fmt.Sprintf("tf-acc-test-%s", randomID)),
resource.TestCheckResourceAttrSet("data.github_actions_remove_token.test", "token"),
resource.TestCheckResourceAttrSet("data.github_actions_remove_token.test", "expires_at"),
)

testCase := func(t *testing.T, mode string) {
resource.Test(t, resource.TestCase{
PreCheck: func() { skipUnlessMode(t, mode) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: config,
Check: check,
},
},
})
}

t.Run("with an anonymous account", func(t *testing.T) {
t.Skip("anonymous account not supported for this operation")
})

t.Run("with an individual account", func(t *testing.T) {
testCase(t, individual)
})

t.Run("with an organization account", func(t *testing.T) {
testCase(t, organization)
})

})
}
2 changes: 2 additions & 0 deletions github/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -203,10 +203,12 @@ func Provider() *schema.Provider {
"github_actions_organization_oidc_subject_claim_customization_template": dataSourceGithubActionsOrganizationOIDCSubjectClaimCustomizationTemplate(),
"github_actions_organization_public_key": dataSourceGithubActionsOrganizationPublicKey(),
"github_actions_organization_registration_token": dataSourceGithubActionsOrganizationRegistrationToken(),
"github_actions_organization_remove_token": dataSourceGithubActionsOrganizationRemoveToken(),
"github_actions_organization_secrets": dataSourceGithubActionsOrganizationSecrets(),
"github_actions_organization_variables": dataSourceGithubActionsOrganizationVariables(),
"github_actions_public_key": dataSourceGithubActionsPublicKey(),
"github_actions_registration_token": dataSourceGithubActionsRegistrationToken(),
"github_actions_remove_token": dataSourceGithubActionsRemoveToken(),
"github_actions_repository_oidc_subject_claim_customization_template": dataSourceGithubActionsRepositoryOIDCSubjectClaimCustomizationTemplate(),
"github_actions_secrets": dataSourceGithubActionsSecrets(),
"github_actions_variables": dataSourceGithubActionsVariables(),
Expand Down
24 changes: 24 additions & 0 deletions website/docs/d/actions_organization_remove_token.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
layout: "github"
page_title: "GitHub: actions_organization_remove_token"
description: |-
Get a GitHub Actions organization remove token.
---

# actions_remove_token

Use this data source to retrieve a GitHub Actions organization remove token. This token can then be used to remove a self-hosted runner.

## Example Usage

```hcl
data "github_actions_organization_remove_token" "example" {
}
```

## Argument Reference

## Attributes Reference

* `token` - The token that has been retrieved.
* `expires_at` - The token expiration date.
27 changes: 27 additions & 0 deletions website/docs/d/actions_remove_token.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: "github"
page_title: "GitHub: actions_remove_token"
description: |-
Get a GitHub Actions repository remove token.
---

# actions_remove_token

Use this data source to retrieve a GitHub Actions repository remove token. This token can then be used to remove a self-hosted runner.

## Example Usage

```hcl
data "github_actions_remove_token" "example" {
repository = "example_repo"
}
```

## Argument Reference

* `repository` - (Required) Name of the repository to get a GitHub Actions remove token for.

## Attributes Reference

* `token` - The token that has been retrieved.
* `expires_at` - The token expiration date.