feat(data_source_github_release_asset): make download configurable

Per code review feedback from @stevehipwell (#2514 (review)),
this makes the release asset download optional, controlled by a `download_body`
attribute, and off by default.

Signed-off-by: Mike Ball <mikedball@gmail.com>

Author: mdb

github/data_source_github_release_asset.go

@@ -32,10 +32,16 @@ func dataSourceGithubReleaseAsset() *schema.Resource {
 				Required:    true,
 				Description: "Name of the repository to retrieve the release asset from",
 			},
+			"download_body": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "Whether to download the asset content into the body attribute",
+			},
 			"body": {
 				Type:        schema.TypeString,
 				Computed:    true,
-				Description: "The release asset body",
+				Description: "The release asset body (requires download_body to be 'true'",
 			},
 			"url": {
 				Type:        schema.TypeString,
@@ -98,35 +104,8 @@ func dataSourceGithubReleaseAssetRead(ctx context.Context, d *schema.ResourceDat
 		return diag.FromErr(err)
 	}
 
-	// Use a client copy to avoid possible mutation of shared GitHub client state
-	// by client.Repositories.DownloadReleaseAsset.
-	clientCopy := client.Client()
-	req, err := http.NewRequestWithContext(ctx, "GET", asset.GetBrowserDownloadURL(), nil)
-	if err != nil {
-		return diag.FromErr(err)
-	}
-
-	req.Header.Set("Accept", "application/octet-stream")
-	resp, err := clientCopy.Do(req)
-	if err != nil {
-		return diag.FromErr(err)
-	}
-	defer resp.Body.Close()
-
-	if resp.StatusCode != http.StatusOK {
-		return diag.Errorf("failed to get release asset (%s/%s %d): %s", owner, repository, assetID, resp.Status)
-	}
-
-	buf := new(strings.Builder)
-	if _, err := io.Copy(buf, resp.Body); err != nil {
-		return diag.FromErr(err)
-	}
-
 	d.SetId(buildThreePartID(owner, repository, strconv.FormatInt(assetID, 10)))
 
-	if err := d.Set("body", buf.String()); err != nil {
-		return diag.FromErr(err)
-	}
 	if err := d.Set("url", asset.URL); err != nil {
 		return diag.FromErr(err)
 	}
@@ -155,5 +134,37 @@ func dataSourceGithubReleaseAssetRead(ctx context.Context, d *schema.ResourceDat
 		return diag.FromErr(err)
 	}
 
+	if !d.Get("download_body").(bool) {
+		return nil
+	}
+
+	// Use a client copy to avoid possible mutation of shared GitHub client state
+	// by client.Repositories.DownloadReleaseAsset.
+	clientCopy := client.Client()
+	req, err := http.NewRequestWithContext(ctx, "GET", asset.GetBrowserDownloadURL(), nil)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	req.Header.Set("Accept", "application/octet-stream")
+	resp, err := clientCopy.Do(req)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return diag.Errorf("failed to get release asset (%s/%s %d): %s", owner, repository, assetID, resp.Status)
+	}
+
+	buf := new(strings.Builder)
+	if _, err := io.Copy(buf, resp.Body); err != nil {
+		return diag.FromErr(err)
+	}
+
+	if err := d.Set("body", buf.String()); err != nil {
+		return diag.FromErr(err)
+	}
+
 	return nil
 }

github/data_source_github_release_asset_test.go

@@ -15,13 +15,13 @@ func TestAccGithubReleaseAssetDataSource(t *testing.T) {
 	testReleaseAssetName := testAccConf.testPublicRelaseAssetName
 	testReleaseAssetContent := testAccConf.testPublicReleaseAssetContent
 
-	t.Run("queries specified asset ID", func(t *testing.T) {
-
+	t.Run("queries and downloads specified asset ID", func(t *testing.T) {
 		config := fmt.Sprintf(`
 			data "github_release_asset" "test" {
 				repository = "%s"
 				owner = "%s"
 				asset_id = "%s"
+				download_body = true
 			}
 		`, testReleaseRepository, testRepositoryOwner, testReleaseAssetID)
 
@@ -45,4 +45,34 @@ func TestAccGithubReleaseAssetDataSource(t *testing.T) {
 			},
 		})
 	})
+
+	t.Run("queries without downloading the specified asset ID", func(t *testing.T) {
+		config := fmt.Sprintf(`
+			data "github_release_asset" "test" {
+				repository = "%s"
+				owner = "%s"
+				asset_id = "%s"
+			}
+		`, testReleaseRepository, testRepositoryOwner, testReleaseAssetID)
+
+		resource.Test(t, resource.TestCase{
+			ProviderFactories: providerFactories,
+			Steps: []resource.TestStep{
+				{
+					Config: config,
+					Check: resource.ComposeTestCheckFunc(
+						resource.TestCheckResourceAttr(
+							"data.github_release_asset.test", "asset_id", testReleaseAssetID,
+						),
+						resource.TestCheckResourceAttr(
+							"data.github_release_asset.test", "name", testReleaseAssetName,
+						),
+						resource.TestCheckNoResourceAttr(
+							"data.github_release_asset.test", "body",
+						),
+					),
+				},
+			},
+		})
+	})
 }

website/docs/d/release_asset.html.markdown

@@ -10,27 +10,30 @@ description: |-
 Use this data source to retrieve information about a GitHub release asset.
 
 ## Example Usage
-To retrieve the latest release that is present in a repository:
+To retrieve a specific release asset from a repository based on its ID:
 
 ```hcl
-data "github_release" "example" {
+data "github_release_asset" "example" {
     repository  = "example-repository"
     owner       = "example-owner"
-    retrieve_by = "latest"
+    asset_id    = 12345
 }
 ```
 
-To retrieve a specific release asset from a repository based on its ID:
+To retrieve a specific release asset from a repository, and download its body
+into a `body` attribute on the data source:
 
 ```hcl
 data "github_release_asset" "example" {
-    repository  = "example-repository"
-    owner       = "example-owner"
-    asset_id    = 12345
+    repository    = "example-repository"
+    owner         = "example-owner"
+    asset_id      = 12345
+    download_body = true
 }
 ```
 
-To retrieve the first release asset associated with the the latest release in a repository:
+
+To retrieve the first release asset associated with the latest release in a repository:
 
 ```hcl
 data "github_release" "example" {
@@ -68,6 +71,7 @@ data "github_release_asset" "example" {
 *  `repository`  -  (Required) Name of the repository to retrieve the release from
 *  `owner`  -  (Required) Owner of the repository
 *  `asset_id`  -  (Required) ID of the release asset to retrieve
+*  `download_body`  -  (Optional) If `true`, download the release asset to the `body` attribute. Defaults to `false`.
 
 ## Attributes Reference
 
@@ -81,4 +85,4 @@ data "github_release_asset" "example" {
 * `created_at` - Date the asset was created
 * `updated_at` - Date the asset was last updated
 * `browser_download_url` - Browser URL from which the release asset can be downloaded
-* `body` - The release asset body
+* `body` - The release asset body (requires `download_body` to be `true`)