Skip to content

Commit 0671ab4

Browse files
mdbmdb
committed
feat: add github_release_asset data source
This addresses issue #2513 and adds support for a `github_release_asset` data source. Example of passing acceptance tests: ``` GITHUB_ORGANIZATION=mterwill \ GITHUB_OWNER=mterwill \ TF_ACC=1 \ go test -v ./... -run ^TestAccGithubReleaseAssetDataSource ? github.com/integrations/terraform-provider-github/v6 [no test files] === RUN TestAccGithubReleaseAssetDataSource === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account provider_utils.go:51: GITHUB_TOKEN environment variable should be empty provider_utils.go:74: Skipping TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account which requires anonymous mode === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_individual_account === RUN TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_organization_account --- PASS: TestAccGithubReleaseAssetDataSource (11.65s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID (11.65s) --- SKIP: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_anonymous_account (0.00s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_individual_account (8.90s) --- PASS: TestAccGithubReleaseAssetDataSource/queries_specified_asset_ID/with_an_organization_account (2.75s) PASS ok github.com/integrations/terraform-provider-github/v6/github 12.434s ``` Signed-off-by: Mike Ball <[email protected]>
1 parent 972ef3b commit 0671ab4

5 files changed

Lines changed: 333 additions & 1 deletion

File tree

‎github/config.go‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,10 @@ func (injector *previewHeaderInjectorTransport) RoundTrip(req *http.Request) (*h
189189
header := req.Header.Get(name)
190190
if header == "" {
191191
header = value
192-
} else {
192+
// NOTE: Some API endpoints expect a single Accept: application/octet-stream header.
193+
// If one has been set, it's necessary to preserve it as-is, without
194+
// appending previewHeaders value.
195+
} else if !(strings.ToLower(name) == "accept" && header == "application/octet-stream") {
193196
header = strings.Join([]string{header, value}, ",")
194197
}
195198
req.Header.Set(name, header)

‎github/data_source_github_release_asset.go‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
package github
2+
3+
import (
4+
"context"
5+
"io"
6+
"strconv"
7+
"strings"
8+
9+
"github.com/google/go-github/v67/github"
10+
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
11+
)
12+
13+
func dataSourceGithubReleaseAsset() *schema.Resource {
14+
return &schema.Resource{
15+
Read: dataSourceGithubReleaseAssetRead,
16+
17+
Schema: map[string]*schema.Schema{
18+
"asset_id": {
19+
Type: schema.TypeInt,
20+
Required: true,
21+
Description: "The release asset ID.",
22+
},
23+
"owner": {
24+
Type: schema.TypeString,
25+
Required: true,
26+
Description: "The release asset owner.",
27+
},
28+
"repository": {
29+
Type: schema.TypeString,
30+
Required: true,
31+
Description: "The release asset repository.",
32+
},
33+
"body": {
34+
Type: schema.TypeString,
35+
Computed: true,
36+
Description: "The release asset body.",
37+
},
38+
"url": {
39+
Type: schema.TypeString,
40+
Computed: true,
41+
Description: "The release asset URL.",
42+
},
43+
"node_id": {
44+
Type: schema.TypeString,
45+
Computed: true,
46+
Description: "The release asset node ID.",
47+
},
48+
"name": {
49+
Type: schema.TypeString,
50+
Computed: true,
51+
Description: "The release asset name.",
52+
},
53+
"label": {
54+
Type: schema.TypeString,
55+
Computed: true,
56+
Description: "The release asset label.",
57+
},
58+
"content_type": {
59+
Type: schema.TypeString,
60+
Computed: true,
61+
Description: "The release asset content type.",
62+
},
63+
"size": {
64+
Type: schema.TypeInt,
65+
Computed: true,
66+
Description: "The release asset size.",
67+
},
68+
"created_at": {
69+
Type: schema.TypeString,
70+
Computed: true,
71+
Description: "The time at which the release asset was created.",
72+
},
73+
"updated_at": {
74+
Type: schema.TypeString,
75+
Computed: true,
76+
Description: "The time at which the release asset was updated.",
77+
},
78+
"browser_download_url": {
79+
Type: schema.TypeString,
80+
Computed: true,
81+
Description: "The browser URL from which the release asset can be downloaded.",
82+
},
83+
},
84+
}
85+
}
86+
87+
func dataSourceGithubReleaseAssetRead(d *schema.ResourceData, meta interface{}) error {
88+
repository := d.Get("repository").(string)
89+
owner := d.Get("owner").(string)
90+
91+
client := meta.(*Owner).v3client
92+
ctx := context.Background()
93+
94+
var err error
95+
var asset *github.ReleaseAsset
96+
97+
assetID := int64(d.Get("asset_id").(int))
98+
asset, _, err = client.Repositories.GetReleaseAsset(ctx, owner, repository, assetID)
99+
if err != nil {
100+
return err
101+
}
102+
103+
var respBody io.ReadCloser
104+
clientCopy := client.Client()
105+
respBody, _, err = client.Repositories.DownloadReleaseAsset(ctx, owner, repository, assetID, clientCopy)
106+
if err != nil {
107+
return err
108+
}
109+
defer respBody.Close()
110+
111+
buf := new(strings.Builder)
112+
_, err = io.Copy(buf, respBody)
113+
if err != nil {
114+
return err
115+
}
116+
117+
d.SetId(strconv.FormatInt(asset.GetID(), 10))
118+
err = d.Set("body", buf.String())
119+
if err != nil {
120+
return err
121+
}
122+
err = d.Set("url", asset.URL)
123+
if err != nil {
124+
return err
125+
}
126+
err = d.Set("node_id", asset.NodeID)
127+
if err != nil {
128+
return err
129+
}
130+
err = d.Set("name", asset.Name)
131+
if err != nil {
132+
return err
133+
}
134+
err = d.Set("label", asset.Label)
135+
if err != nil {
136+
return err
137+
}
138+
err = d.Set("content_type", asset.ContentType)
139+
if err != nil {
140+
return err
141+
}
142+
err = d.Set("size", asset.Size)
143+
if err != nil {
144+
return err
145+
}
146+
err = d.Set("created_at", asset.CreatedAt.String())
147+
if err != nil {
148+
return err
149+
}
150+
err = d.Set("created_at", asset.UpdatedAt.String())
151+
if err != nil {
152+
return err
153+
}
154+
err = d.Set("browser_download_url", asset.BrowserDownloadURL)
155+
if err != nil {
156+
return err
157+
}
158+
159+
return nil
160+
}

‎github/data_source_github_release_asset_test.go‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
package github
2+
3+
import (
4+
"fmt"
5+
"os"
6+
"testing"
7+
8+
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
9+
)
10+
11+
func TestAccGithubReleaseAssetDataSource(t *testing.T) {
12+
13+
testReleaseRepository := "go-github-issue-demo-1"
14+
if os.Getenv("GITHUB_TEMPLATE_REPOSITORY") != "" {
15+
testReleaseRepository = os.Getenv("GITHUB_TEMPLATE_REPOSITORY")
16+
}
17+
18+
testReleaseAssetID := "151970555"
19+
if os.Getenv("GITHUB_TEMPLATE_REPOSITORY_RELEASE_ASSET_ID") != "" {
20+
testReleaseAssetID = os.Getenv("GITHUB_TEMPLATE_REPOSITORY_RELEASE_ASSET_ID")
21+
}
22+
23+
testReleaseAssetName := "foo.txt"
24+
if os.Getenv("GITHUB_TEMPLATE_REPOSITORY_RELEASE_ASSET_NAME") != "" {
25+
testReleaseAssetName = os.Getenv("GITHUB_TEMPLATE_REPOSITORY_RELEASE_ASSET_NAME")
26+
}
27+
28+
testReleaseAssetContent := "Hello, world!\n"
29+
if os.Getenv("GITHUB_TEMPLATE_REPOSITORY_RELEASE_ASSET_CONTENT") != "" {
30+
testReleaseAssetContent = os.Getenv("GITHUB_TEMPLATE_REPOSITORY_RELEASE_ASSET_CONTENT")
31+
}
32+
33+
testReleaseOwner := testOrganizationFunc()
34+
35+
t.Run("queries specified asset ID", func(t *testing.T) {
36+
37+
config := fmt.Sprintf(`
38+
data "github_release_asset" "test" {
39+
repository = "%s"
40+
owner = "%s"
41+
asset_id = "%s"
42+
}
43+
`, testReleaseRepository, testReleaseOwner, testReleaseAssetID)
44+
45+
check := resource.ComposeTestCheckFunc(
46+
resource.TestCheckResourceAttr(
47+
"data.github_release_asset.test", "asset_id", testReleaseAssetID,
48+
),
49+
resource.TestCheckResourceAttr(
50+
"data.github_release_asset.test", "name", testReleaseAssetName,
51+
),
52+
resource.TestCheckResourceAttr(
53+
"data.github_release_asset.test", "body", testReleaseAssetContent,
54+
),
55+
)
56+
57+
testCase := func(t *testing.T, mode string) {
58+
resource.Test(t, resource.TestCase{
59+
PreCheck: func() { skipUnlessMode(t, mode) },
60+
Providers: testAccProviders,
61+
Steps: []resource.TestStep{
62+
{
63+
Config: config,
64+
Check: check,
65+
},
66+
},
67+
})
68+
}
69+
70+
t.Run("with an anonymous account", func(t *testing.T) {
71+
testCase(t, anonymous)
72+
})
73+
74+
t.Run("with an individual account", func(t *testing.T) {
75+
testCase(t, individual)
76+
})
77+
78+
t.Run("with an organization account", func(t *testing.T) {
79+
testCase(t, organization)
80+
})
81+
82+
})
83+
84+
}

‎github/provider.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ func Provider() *schema.Provider {
264264
"github_organization_webhooks": dataSourceGithubOrganizationWebhooks(),
265265
"github_ref": dataSourceGithubRef(),
266266
"github_release": dataSourceGithubRelease(),
267+
"github_release_asset": dataSourceGithubReleaseAsset(),
267268
"github_repositories": dataSourceGithubRepositories(),
268269
"github_repository": dataSourceGithubRepository(),
269270
"github_repository_autolink_references": dataSourceGithubRepositoryAutolinkReferences(),

‎website/docs/d/release_asset.html.markdown‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
layout: "github"
3+
page_title: "GitHub: github_release_asset"
4+
description: |-
5+
Get information on a GitHub release asset.
6+
---
7+
8+
# github\_release\_asset
9+
10+
Use this data source to retrieve information about a GitHub release asset associated with a specific GitHub release.
11+
12+
## Example Usage
13+
To retrieve the latest release that is present in a repository:
14+
15+
```hcl
16+
data "github_release" "example" {
17+
repository = "example-repository"
18+
owner = "example-owner"
19+
retrieve_by = "latest"
20+
}
21+
```
22+
23+
To retrieve a specific release asset from a repository based on its ID:
24+
25+
```hcl
26+
data "github_release_asset" "example" {
27+
repository = "example-repository"
28+
owner = "example-owner"
29+
asset_id = 12345
30+
}
31+
```
32+
33+
To retrieve the first release asset associated with the the latest release in a repository:
34+
35+
```hcl
36+
data "github_release" "example" {
37+
repository = "example-repository"
38+
owner = "example-owner"
39+
retrieve_by = "latest"
40+
}
41+
42+
data "github_release_asset" "example" {
43+
repository = "example-repository"
44+
owner = "example-owner"
45+
asset_id = data.github_release.example.assets[0].id
46+
}
47+
```
48+
49+
To retrieve all release assets associated with the the latest release in a repository:
50+
51+
```hcl
52+
data "github_release" "example" {
53+
repository = "example-repository"
54+
owner = "example-owner"
55+
retrieve_by = "latest"
56+
}
57+
58+
data "github_release_asset" "example" {
59+
count = length(data.github_release.example.assets)
60+
repository = "example-repository"
61+
owner = "example-owner"
62+
asset_id = data.github_release.example.assets[count.index].id
63+
}
64+
```
65+
66+
## Argument Reference
67+
68+
* `repository` - (Required) Name of the repository to retrieve the release from.
69+
* `owner` - (Required) Owner of the repository.
70+
* `asset_id` - (Required) ID of the release asset to retrieve.
71+
72+
## Attributes Reference
73+
74+
* `id` - ID of the asset
75+
* `url` - URL of the asset
76+
* `node_id` - Node ID of the asset
77+
* `name` - The file name of the asset
78+
* `label` - Label for the asset
79+
* `content_type` - MIME type of the asset
80+
* `size` - Size in byte
81+
* `created_at` - Date the asset was created
82+
* `updated_at` - Date the asset was last updated
83+
* `browser_download_url` - Browser download URL
84+
* `body` - The release asset body

0 commit comments

Comments
 (0)