feat(drone_crons): added new drone_crons data source (#104)

Author: mavimo

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

@@ -0,0 +1,4 @@
+#retrieve all crons in a repositorie from drone instance
+data "drone_crons" "all" {
+  repository = "octolab/hello-world"
+}

internal/provider/data_source_crons.go

@@ -0,0 +1,80 @@
+package drone
+
+import (
+	"context"
+	"fmt"
+	"regexp"
+	"sort"
+
+	"github.com/drone/drone-go/drone"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
+	"github.com/mavimo/terraform-provider-drone/internal/provider/utils"
+)
+
+func dataSourceCrons() *schema.Resource {
+	return &schema.Resource{
+		Description: "Data source for retrieving all Drone crons for a repo",
+		ReadContext: dataSourceCronsRead,
+		Schema: map[string]*schema.Schema{
+			"repository": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "Repository name",
+				ValidateFunc: validation.StringMatch(
+					regexp.MustCompile("^[^/ ]+/[^/ ]+$"),
+					"Invalid repository (e.g. octocat/hello-world)",
+				),
+			},
+			"names": {
+				Type: schema.TypeList,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+				Computed:    true,
+				Description: "List with cron name for a specific repository",
+			},
+		},
+	}
+}
+
+func dataSourceCronsRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
+	client := m.(drone.Client)
+
+	// Warning or errors can be collected in a slice type
+	var diags diag.Diagnostics
+
+	owner, repo, err := utils.ParseRepo(d.Get("repository").(string))
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	crons, err := client.CronList(owner, repo)
+
+	if err != nil {
+		diags = append(diags, diag.Diagnostic{
+			Severity: diag.Error,
+			Summary:  fmt.Sprintf("failed to read Drone Crons for repo: %s/%ss", owner, repo),
+			Detail:   err.Error(),
+		})
+
+		return diags
+	}
+
+	ids := make([]string, 0)
+	slugs := make([]string, 0)
+
+	for _, cron := range crons {
+		ids = append(ids, cron.Name)
+		slugs = append(slugs, cron.Name)
+	}
+
+	sort.Strings(slugs)
+	d.Set("names", slugs)
+	d.Set("repository", fmt.Sprintf("%s/%s", owner, repo))
+
+	d.SetId(utils.BuildChecksumID(ids))
+
+	return diags
+}

internal/provider/data_source_crons_test.go

@@ -0,0 +1,100 @@
+package drone
+
+import (
+	"fmt"
+	"regexp"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccDroneCronsDataSource(t *testing.T) {
+	t.Run("check drone_crons data source with default values", func(t *testing.T) {
+		orgName := "terraform"
+		repoName := "repo-test-1"
+		cronName1 := "cron-test-1"
+		cronName2 := "cron-test-2"
+		cronName3 := "cron-test-3"
+
+		configResource := fmt.Sprintf(`
+			resource "drone_repo" "test" {
+				repository = "%s/%s"
+			}
+
+			resource "drone_cron" "test1" {
+				repository = "${drone_repo.test.repository}"
+				name       = "%s"
+				event      = "push"
+				expr       = "@daily"
+			}
+
+			resource "drone_cron" "test2" {
+				repository = "${drone_repo.test.repository}"
+				name       = "%s"
+				event      = "push"
+				expr       = "@weekly"
+			}
+
+			resource "drone_cron" "test3" {
+				repository = "${drone_repo.test.repository}"
+				name       = "%s"
+				event      = "push"
+				expr       = "@monthly"
+			}
+		`, orgName, repoName, cronName1, cronName2, cronName3)
+
+		configData := configResource + fmt.Sprintf(`
+			data "drone_crons" "test" {
+				repository = "%s/%s"
+			}
+		`, orgName, repoName)
+
+		resource.Test(t, resource.TestCase{
+			PreCheck:  func() { testAccPreCheck(t) },
+			Providers: testProviders,
+			Steps: []resource.TestStep{
+				{
+					Config: configResource,
+					Check:  resource.ComposeTestCheckFunc(),
+				},
+				{
+					Config: configData,
+					Check: resource.ComposeTestCheckFunc(
+						// We check that id is computed
+						resource.TestCheckResourceAttrSet("data.drone_crons.test", "id"),
+						// We check that are correctly sorted
+						resource.TestCheckResourceAttr("data.drone_crons.test", "names.0", cronName1),
+						resource.TestCheckResourceAttr("data.drone_crons.test", "names.1", cronName2),
+						resource.TestCheckResourceAttr("data.drone_crons.test", "names.2", cronName3),
+						// We check that we get only the repos we created
+						resource.TestCheckResourceAttr("data.drone_crons.test", "names.#", "3"),
+					),
+				},
+			},
+		})
+	})
+
+	t.Run("check drone_crons data source with non existing repository", func(t *testing.T) {
+		orgName := "terraform"
+		testMissingRepoName := "missing-repo"
+
+		configData := fmt.Sprintf(`
+			data "drone_crons" "test" {
+				repository = "%s/%s"
+			}
+		`, orgName, testMissingRepoName)
+
+		resource.Test(t, resource.TestCase{
+			PreCheck:  func() { testAccPreCheck(t) },
+			Providers: testProviders,
+			Steps: []resource.TestStep{
+				{
+					Config: configData,
+					ExpectError: regexp.MustCompile(
+						fmt.Sprintf("Error: failed to read Drone Crons for repo: %s/%s", orgName, testMissingRepoName),
+					),
+				},
+			},
+		})
+	})
+}

internal/provider/provider.go

@@ -54,6 +54,7 @@ func Provider() *schema.Provider {
 		},
 		DataSourcesMap: map[string]*schema.Resource{
 			"drone_cron":      dataSourceCron(),
+			"drone_crons":     dataSourceCrons(),
 			"drone_repo":      dataSourceRepo(),
 			"drone_repos":     dataSourceRepos(),
 			"drone_template":  dataSourceTemplate(),