Add the ability to forem_article data source to query an article by p…

…ath (#6)

* fix: fix description

* add data source forem_article functionality by username and slug

Makefile

@@ -44,3 +44,7 @@ testacc:
 .PHONY: docs
 docs:
 	tfplugindocs generate
+
+.PHONY: tffmt
+tffmt:
+	terraform fmt -recursive .

docs/data-sources/article.md

@@ -3,14 +3,14 @@
 page_title: "forem_article Data Source - terraform-provider-forem"
 subcategory: ""
 description: |-
-  forem_article data source fetches information about a particular article.
+  forem_article data source fetches information about a particular article. Please, specify either the id of the article or the username and slug combination.
   API Docs
   https://developers.forem.com/api#operation/getArticleById
 ---
 
 # forem_article (Data Source)
 
-`forem_article` data source fetches information about a particular article.
+`forem_article` data source fetches information about a particular article. Please, specify either the `id` of the article or the `username` and `slug` combination.
 
 ## API Docs
 
@@ -19,21 +19,24 @@ https://developers.forem.com/api#operation/getArticleById
 ## Example Usage
 
 ```terraform
-data "forem_article" "example" {
+data "forem_article" "example_id" {
   id = "979788"
 }
+
+data "forem_article" "example_username_slug" {
+  username = "admin_mcadmin"
+  slug     = "basic-traefik-configuration-tutorial-593m"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Required
-
-- `id` (String) ID of the article.
-
 ### Optional
 
-- `tags` (List of String) List of tags related to the article.
+- `id` (String) ID of the article.
+- `slug` (String) Slug of the article.
+- `username` (String) User or organization username.
 
 ### Read-Only
 
@@ -54,8 +57,8 @@ data "forem_article" "example" {
 - `published_at` (String) When the article was published.
 - `published_timestamp` (String) When the article was published.
 - `reading_time_minutes` (Number) Article reading time in minutes.
-- `slug` (String) Slug of the article.
 - `social_image` (String) Social image of the article.
+- `tags` (List of String) List of tags related to the article.
 - `title` (String) Title of the article.
 - `url` (String) Full article URL.
 - `user` (Map of String) User object of the article.

docs/data-sources/user.md

@@ -3,14 +3,14 @@
 page_title: "forem_user Data Source - terraform-provider-forem"
 subcategory: ""
 description: |-
-  `forem_user fetches information about a particular user. You can either use the user's ID or the user's username.
+  forem_user fetches information about a particular user. You can either use the user's ID or the user's username.
   API Docs
   https://developers.forem.com/api#operation/getUser
 ---
 
 # forem_user (Data Source)
 
-``forem_user` fetches information about a particular user. You can either use the user's ID or the user's username.
+`forem_user` fetches information about a particular user. You can either use the user's ID or the user's username.
 
 ## API Docs
 

examples/data-sources/forem_article/data-source.tf

@@ -1,3 +1,8 @@
-data "forem_article" "example" {
+data "forem_article" "example_id" {
   id = "979788"
 }
+
+data "forem_article" "example_username_slug" {
+  username = "admin_mcadmin"
+  slug     = "basic-traefik-configuration-tutorial-593m"
+}

forem/data_source_article.go

@@ -3,6 +3,7 @@ package forem
 import (
 	"context"
 	"fmt"
+	"strconv"
 
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -12,15 +13,23 @@ import (
 
 func dataSourceArticle() *schema.Resource {
 	return &schema.Resource{
-		Description: "`forem_article` data source fetches information about a particular article." +
+		Description: "`forem_article` data source fetches information about a particular article. Please, specify either the `id` of the article or the `username` and `slug` combination." +
 			"\n\n## API Docs\n\n" +
 			"https://developers.forem.com/api#operation/getArticleById",
 		ReadContext: dataSourceArticleRead,
 		Schema: map[string]*schema.Schema{
 			"id": {
-				Description: "ID of the article.",
-				Type:        schema.TypeString,
-				Required:    true,
+				Description:  "ID of the article.",
+				Type:         schema.TypeString,
+				Optional:     true,
+				AtLeastOneOf: []string{"id", "username", "slug"},
+			},
+			"username": {
+				Description:  "User or organization username.",
+				Type:         schema.TypeString,
+				Optional:     true,
+				RequiredWith: []string{"slug"},
+				AtLeastOneOf: []string{"id", "username", "slug"},
 			},
 			"title": {
 				Description: "Title of the article.",
@@ -45,13 +54,15 @@ func dataSourceArticle() *schema.Resource {
 			"tags": {
 				Description: "List of tags related to the article.",
 				Type:        schema.TypeList,
-				Optional:    true,
+				Computed:    true,
 				Elem:        &schema.Schema{Type: schema.TypeString},
 			},
 			"slug": {
-				Description: "Slug of the article.",
-				Type:        schema.TypeString,
-				Computed:    true,
+				Description:  "Slug of the article.",
+				Type:         schema.TypeString,
+				Optional:     true,
+				RequiredWith: []string{"username"},
+				AtLeastOneOf: []string{"id", "username", "slug"},
 			},
 			"path": {
 				Description: "Path of the article URL.",
@@ -154,16 +165,28 @@ func dataSourceArticle() *schema.Resource {
 func dataSourceArticleRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*dev.Client)
 
-	id := d.Get("id").(string)
-
-	tflog.Debug(ctx, fmt.Sprintf("Getting article: %s", id))
-	articlesResp, err := client.GetPublishedArticleByID(id)
-	if err != nil {
-		return diag.FromErr(err)
+	var articlesResp *dev.ArticleVariant
+	var err error
+	if v, ok := d.GetOk("id"); ok {
+		id := v.(string)
+		tflog.Debug(ctx, fmt.Sprintf("Getting article with ID: %s", id))
+		articlesResp, err = client.GetPublishedArticleByID(id)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		tflog.Debug(ctx, fmt.Sprintf("Found article with ID: %s", id))
+	} else {
+		username := d.Get("username").(string)
+		slug := d.Get("slug").(string)
+		tflog.Debug(ctx, fmt.Sprintf("Getting article with username: %s and slug: %s", username, slug))
+		articlesResp, err = client.GetPublishedArticleByPath(username, slug)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+		tflog.Debug(ctx, fmt.Sprintf("Found article with username: %s and slug: %s", username, slug))
 	}
-	tflog.Debug(ctx, fmt.Sprintf("Found article: %s", id))
 
-	d.SetId(id)
+	d.SetId(strconv.Itoa(int(articlesResp.ID)))
 	d.Set("title", articlesResp.Article.Title)
 	d.Set("description", articlesResp.Article.Description)
 	d.Set("body_markdown", articlesResp.Article.BodyMarkdown)

forem/data_source_article_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 )
 
-func TestAccArticleDataSource(t *testing.T) {
+func TestAccArticleDataSource_queryByID(t *testing.T) {
 	articleID := os.Getenv("TEST_DATA_FOREM_ARTICLE_ID")
 	resourceName := "data.forem_article.test"
 
@@ -17,7 +17,7 @@ func TestAccArticleDataSource(t *testing.T) {
 		Providers: testAccProviders,
 		Steps: []resource.TestStep{
 			{
-				Config: testAccArticleDataSourceConfig_id(articleID),
+				Config: testAccArticleDataSourceConfig_queryByID(articleID),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(resourceName, "id", articleID),
 					resource.TestCheckResourceAttrSet(resourceName, "title"),
@@ -30,10 +30,42 @@ func TestAccArticleDataSource(t *testing.T) {
 	})
 }
 
-func testAccArticleDataSourceConfig_id(id string) string {
+func TestAccArticleDataSource_queryByUsernameAndSlug(t *testing.T) {
+	articleUsername := os.Getenv("TEST_DATA_FOREM_ARTICLE_USERNAME")
+	articleSlug := os.Getenv("TEST_DATA_FOREM_ARTICLE_SLUG")
+	resourceName := "data.forem_article.test"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccArticleDataSourceConfig_queryByUsernameAndSlug(articleUsername, articleSlug),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(resourceName, "id"),
+					resource.TestCheckResourceAttrSet(resourceName, "title"),
+					resource.TestCheckResourceAttrSet(resourceName, "body_markdown"),
+					resource.TestCheckResourceAttr(resourceName, "slug", articleSlug),
+					resource.TestCheckResourceAttrSet(resourceName, "path"),
+				),
+			},
+		},
+	})
+}
+
+func testAccArticleDataSourceConfig_queryByID(id string) string {
 	return fmt.Sprintf(`
 data "forem_article" "test" {
 	id = "%s"
 }
 `, id)
 }
+
+func testAccArticleDataSourceConfig_queryByUsernameAndSlug(username, slug string) string {
+	return fmt.Sprintf(`
+data "forem_article" "test" {
+	username = "%s"
+	slug = "%s"
+}
+`, username, slug)
+}

forem/data_source_user.go

@@ -13,7 +13,7 @@ import (
 
 func dataSourceUser() *schema.Resource {
 	return &schema.Resource{
-		Description: "``forem_user` fetches information about a particular user. You can either use the user's ID or the user's username." +
+		Description: "`forem_user` fetches information about a particular user. You can either use the user's ID or the user's username." +
 			"\n\n## API Docs\n\n" +
 			"https://developers.forem.com/api#operation/getUser",
 		ReadContext: dataSourceUserRead,