Merge pull request #346 from kerny3d/master

feat: Add badge's token to project

Author: jdamata

docs/data-sources/project.md

@@ -27,6 +27,7 @@ data "sonarqube_project" "project" {
 
 ### Read-Only
 
+- `badge_token` (String) The badge token for the project.
 - `id` (String) The ID of this resource.
 - `name` (String) Name of the project
 - `visibility` (String) Project visibility

docs/resources/project.md

@@ -50,6 +50,7 @@ resource "sonarqube_project" "main" {
 
 ### Read-Only
 
+- `badge_token` (String) The badge token for the project.
 - `id` (String) The ID of this resource.
 
 <a id="nestedblock--setting"></a>

sonarqube/data_source_sonarqube_project.go

@@ -24,6 +24,11 @@ func dataSourceSonarqubeProject() *schema.Resource {
 				Computed:    true,
 				Description: "Project visibility",
 			},
+			"badge_token": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The badge token for the project.",
+			},
 		},
 	}
 }

sonarqube/data_source_sonarqube_project_test.go

@@ -39,3 +39,22 @@ func TestAccSonarqubeProjectDataSource(t *testing.T) {
 		},
 	})
 }
+
+func TestAccSonarqubeProjectDataSourceBadgeToken(t *testing.T) {
+	rnd := generateRandomResourceName()
+	name := "data.sonarqube_project." + rnd
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccSonarqubeProjectDataSourceConfig(rnd, "testAccSonarqubeProjectDSBadgeToken", "testAccSonarqubeProjectDSBadgeToken", "public"),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(name, "project", "testAccSonarqubeProjectDSBadgeToken"),
+					resource.TestCheckResourceAttrSet(name, "badge_token"),
+				),
+			},
+		},
+	})
+}

sonarqube/resource_sonarqube_project.go

@@ -34,13 +34,19 @@ type ProjectComponent struct {
 	Version      string   `json:"version"`
 	Tags         []string `json:"tags,omitempty"`
 	Visibility   string   `json:"visibility"`
+	BadgeToken   string   `json:"token,omitempty"`
 }
 
 // CreateProjectResponse for unmarshalling response body of project creation
 type CreateProjectResponse struct {
 	Project Project `json:"project"`
 }
 
+// BadgeTokenResponse for unmarshalling response body of badge token endpoint
+type BadgeTokenResponse struct {
+	Token string `json:"token"`
+}
+
 // Returns the resource represented by this file.
 func resourceSonarqubeProject() *schema.Resource {
 	return &schema.Resource{
@@ -81,6 +87,11 @@ func resourceSonarqubeProject() *schema.Resource {
 				},
 				Description: "A list of tags to put on the project.",
 			},
+			"badge_token": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The badge token for the project.",
+			},
 			"setting": {
 				Type:        schema.TypeList,
 				Optional:    true,
@@ -224,11 +235,41 @@ func resourceSonarqubeProjectRead(d *schema.ResourceData, m interface{}) error {
 		return fmt.Errorf("resourceSonarqubeProjectRead: Failed to decode json into struct: %+v", err)
 	}
 
+	// Get badge token
+	badgeTokenURL := m.(*ProviderConfiguration).sonarQubeURL
+	badgeTokenURL.Path = strings.TrimSuffix(badgeTokenURL.Path, "/") + "/api/project_badges/token"
+	badgeTokenURL.RawQuery = url.Values{
+		"project": []string{d.Get("project").(string)},
+	}.Encode()
+
+	badgeResp, err := httpRequestHelper(
+		m.(*ProviderConfiguration).httpClient,
+		"GET",
+		badgeTokenURL.String(),
+		http.StatusOK,
+		"resourceSonarqubeProjectRead",
+	)
+	if err != nil {
+		return fmt.Errorf("resourceSonarqubeProjectRead: Failed to get badge token: %+v", err)
+	}
+	defer badgeResp.Body.Close()
+
+	// Decode badge token response
+	badgeTokenResponse := BadgeTokenResponse{}
+	err = json.NewDecoder(badgeResp.Body).Decode(&badgeTokenResponse)
+	if err != nil {
+		return fmt.Errorf("resourceSonarqubeProjectRead: Failed to decode badge token json: %+v", err)
+	}
+
+	// Set the token in the project component
+	projectReadResponse.Component.BadgeToken = badgeTokenResponse.Token
+
 	d.SetId(projectReadResponse.Component.Key)
 	errName := d.Set("name", projectReadResponse.Component.Name)
 	errProject := d.Set("project", projectReadResponse.Component.Key)
 	errVisibility := d.Set("visibility", projectReadResponse.Component.Visibility)
-	if err := errors.Join(errName, errProject, errVisibility); err != nil {
+	errToken := d.Set("badge_token", projectReadResponse.Component.BadgeToken)
+	if err := errors.Join(errName, errProject, errVisibility, errToken); err != nil {
 		return err
 	}
 

sonarqube/resource_sonarqube_project_test.go

@@ -421,3 +421,22 @@ func TestAccSonarqubeProjectSettingsFieldValues(t *testing.T) {
 	})
 
 }
+
+func TestAccSonarqubeProjectBadgeToken(t *testing.T) {
+	rnd := generateRandomResourceName()
+	name := "sonarqube_project." + rnd
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccSonarqubeProjectBasicConfig(rnd, "testAccSonarqubeProjectBadgeToken", "testAccSonarqubeProjectBadgeToken", "public"),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(name, "project", "testAccSonarqubeProjectBadgeToken"),
+					resource.TestCheckResourceAttrSet(name, "badge_token"),
+				),
+			},
+		},
+	})
+}