Skip to content

Commit cdac2ab

Browse files
julienduchesnejulienduchesne
authored
Mark old client as deprecated (#1227)
Just making it clear so we don't get any reverts like #1225 The client itself will be marked as deprecated once all resources are migrated here and when cloud resources are also migrated off
1 parent 3c57def commit cdac2ab

28 files changed

+81
-83
lines changed

‎internal/common/client.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ import (
1313
)
1414

1515
type Client struct {
16-
GrafanaAPIURL string
17-
GrafanaAPIURLParsed *url.URL
18-
GrafanaAPIConfig *gapi.Config
19-
GrafanaAPI *gapi.Client
20-
GrafanaCloudAPI *gapi.Client
16+
GrafanaAPIURL string
17+
GrafanaAPIURLParsed *url.URL
18+
GrafanaAPIConfig *gapi.Config
19+
DeprecatedGrafanaAPI *gapi.Client
20+
GrafanaCloudAPI *gapi.Client
2121

2222
GrafanaOAPI *goapi.GrafanaHTTPAPI
2323

‎internal/provider/configure_clients.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func createClients(providerConfig frameworkProviderConfig) (*common.Client, erro
2929
var err error
3030
c := &common.Client{}
3131
if !providerConfig.Auth.IsNull() {
32-
c.GrafanaAPIURL, c.GrafanaAPIConfig, c.GrafanaAPI, err = createGrafanaClient(providerConfig)
32+
c.GrafanaAPIURL, c.GrafanaAPIConfig, c.DeprecatedGrafanaAPI, err = createGrafanaClient(providerConfig)
3333
if err != nil {
3434
return nil, err
3535
}

‎internal/provider/legacy_provider_validation.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import (
1717
type metadataValidation func(resourceName string, m interface{}) error
1818

1919
func grafanaClientPresent(resourceName string, m interface{}) error {
20-
if m.(*common.Client).GrafanaAPI == nil {
20+
if m.(*common.Client).GrafanaOAPI == nil {
2121
return fmt.Errorf("the Grafana client is required for `%s`. Set the auth and url provider attributes", resourceName)
2222
}
2323
return nil

‎internal/resources/grafana/oss_org_id.go‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,10 @@ func SplitOrgResourceID(id string) (int64, string) {
4040
return 0, id
4141
}
4242

43-
// ClientFromExistingOrgResource creates a client from the ID of an org-scoped resource
44-
// Those IDs are in the <orgID>:<resourceID> format
45-
func ClientFromExistingOrgResource(meta interface{}, id string) (*gapi.Client, int64, string) {
43+
// Deprecated: Use OAPIClientFromExistingOrgResource instead
44+
func DeprecatedClientFromExistingOrgResource(meta interface{}, id string) (*gapi.Client, int64, string) {
4645
orgID, restOfID := SplitOrgResourceID(id)
47-
client := meta.(*common.Client).GrafanaAPI
46+
client := meta.(*common.Client).DeprecatedGrafanaAPI
4847
if orgID == 0 {
4948
orgID = meta.(*common.Client).GrafanaAPIConfig.OrgID // It's configured globally. TODO: Remove this once we drop support for the global org_id
5049
} else if orgID > 0 {
@@ -53,11 +52,10 @@ func ClientFromExistingOrgResource(meta interface{}, id string) (*gapi.Client, i
5352
return client, orgID, restOfID
5453
}
5554

56-
// ClientFromNewOrgResource creates a client from the `org_id` attribute of a resource
57-
// This client is meant to be used in `Create` functions when the ID hasn't already been baked into the resource ID
58-
func ClientFromNewOrgResource(meta interface{}, d *schema.ResourceData) (*gapi.Client, int64) {
55+
// Deprecated: Use OAPIClientFromNewOrgResource instead
56+
func DeprecatedClientFromNewOrgResource(meta interface{}, d *schema.ResourceData) (*gapi.Client, int64) {
5957
orgID := parseOrgID(d)
60-
client := meta.(*common.Client).GrafanaAPI
58+
client := meta.(*common.Client).DeprecatedGrafanaAPI
6159
if orgID == 0 {
6260
orgID = meta.(*common.Client).GrafanaAPIConfig.OrgID // It's configured globally. TODO: Remove this once we drop support for the global org_id
6361
} else if orgID > 0 {

‎internal/resources/grafana/resource_alerting_contact_point.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This resource requires Grafana 9.1.0 or later.
8686

8787
func importContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
8888
name := data.Id()
89-
client := meta.(*common.Client).GrafanaAPI
89+
client := meta.(*common.Client).DeprecatedGrafanaAPI
9090

9191
ps, err := client.ContactPointsByName(name)
9292
if err != nil {
@@ -107,7 +107,7 @@ func importContactPoint(ctx context.Context, data *schema.ResourceData, meta int
107107
}
108108

109109
func readContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
110-
client := meta.(*common.Client).GrafanaAPI
110+
client := meta.(*common.Client).DeprecatedGrafanaAPI
111111

112112
uidsToFetch := unpackUIDs(data.Id())
113113

@@ -139,7 +139,7 @@ func readContactPoint(ctx context.Context, data *schema.ResourceData, meta inter
139139

140140
func createContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
141141
lock := &meta.(*common.Client).AlertingMutex
142-
client := meta.(*common.Client).GrafanaAPI
142+
client := meta.(*common.Client).DeprecatedGrafanaAPI
143143

144144
ps := unpackContactPoints(data)
145145
uids := make([]string, 0, len(ps))
@@ -165,7 +165,7 @@ func createContactPoint(ctx context.Context, data *schema.ResourceData, meta int
165165

166166
func updateContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
167167
lock := &meta.(*common.Client).AlertingMutex
168-
client := meta.(*common.Client).GrafanaAPI
168+
client := meta.(*common.Client).DeprecatedGrafanaAPI
169169

170170
existingUIDs := unpackUIDs(data.Id())
171171
ps := unpackContactPoints(data)
@@ -207,7 +207,7 @@ func updateContactPoint(ctx context.Context, data *schema.ResourceData, meta int
207207

208208
func deleteContactPoint(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
209209
lock := &meta.(*common.Client).AlertingMutex
210-
client := meta.(*common.Client).GrafanaAPI
210+
client := meta.(*common.Client).DeprecatedGrafanaAPI
211211

212212
uids := unpackUIDs(data.Id())
213213

‎internal/resources/grafana/resource_alerting_contact_point_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ func TestAccContactPoint_notifiers(t *testing.T) {
322322
}
323323
uid := rs.Primary.ID
324324

325-
client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
325+
client := testutils.Provider.Meta().(*common.Client).DeprecatedGrafanaAPI
326326
pt, err := client.ContactPoint(uid)
327327
if err != nil {
328328
return fmt.Errorf("error getting resource: %w", err)
@@ -431,7 +431,7 @@ func testContactPointCheckExists(rname string, pts *[]gapi.ContactPoint, expCoun
431431
return fmt.Errorf("resource name not set")
432432
}
433433

434-
client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
434+
client := testutils.Provider.Meta().(*common.Client).DeprecatedGrafanaAPI
435435
points, err := client.ContactPointsByName(name)
436436
if err != nil {
437437
return fmt.Errorf("error getting resource: %w", err)
@@ -456,7 +456,7 @@ func testContactPointCheckExists(rname string, pts *[]gapi.ContactPoint, expCoun
456456

457457
func testContactPointCheckDestroy(points []gapi.ContactPoint) resource.TestCheckFunc {
458458
return func(s *terraform.State) error {
459-
client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
459+
client := testutils.Provider.Meta().(*common.Client).DeprecatedGrafanaAPI
460460
for _, p := range points {
461461
_, err := client.ContactPoint(p.UID)
462462
if err == nil {
@@ -470,7 +470,7 @@ func testContactPointCheckDestroy(points []gapi.ContactPoint) resource.TestCheck
470470

471471
func testContactPointCheckAllDestroy(name string) resource.TestCheckFunc {
472472
return func(s *terraform.State) error {
473-
client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
473+
client := testutils.Provider.Meta().(*common.Client).DeprecatedGrafanaAPI
474474
points, err := client.ContactPointsByName(name)
475475
if err != nil {
476476
return fmt.Errorf("error getting resource: %w", err)

‎internal/resources/grafana/resource_alerting_mute_timing.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ This resource requires Grafana 9.1.0 or later.
117117
}
118118

119119
func readMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
120-
client := meta.(*common.Client).GrafanaAPI
120+
client := meta.(*common.Client).DeprecatedGrafanaAPI
121121

122122
name := data.Id()
123123
mt, err := client.MuteTiming(name)
@@ -133,7 +133,7 @@ func readMuteTiming(ctx context.Context, data *schema.ResourceData, meta interfa
133133

134134
func createMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
135135
lock := &meta.(*common.Client).AlertingMutex
136-
client := meta.(*common.Client).GrafanaAPI
136+
client := meta.(*common.Client).DeprecatedGrafanaAPI
137137

138138
mt := unpackMuteTiming(data)
139139

@@ -149,7 +149,7 @@ func createMuteTiming(ctx context.Context, data *schema.ResourceData, meta inter
149149

150150
func updateMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
151151
lock := &meta.(*common.Client).AlertingMutex
152-
client := meta.(*common.Client).GrafanaAPI
152+
client := meta.(*common.Client).DeprecatedGrafanaAPI
153153

154154
mt := unpackMuteTiming(data)
155155

@@ -163,7 +163,7 @@ func updateMuteTiming(ctx context.Context, data *schema.ResourceData, meta inter
163163

164164
func deleteMuteTiming(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
165165
lock := &meta.(*common.Client).AlertingMutex
166-
client := meta.(*common.Client).GrafanaAPI
166+
client := meta.(*common.Client).DeprecatedGrafanaAPI
167167
name := data.Id()
168168

169169
lock.Lock()

‎internal/resources/grafana/resource_alerting_notification_policy.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ func policySchema(depth uint) *schema.Resource {
172172
}
173173

174174
func readNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
175-
client := meta.(*common.Client).GrafanaAPI
175+
client := meta.(*common.Client).DeprecatedGrafanaAPI
176176

177177
npt, err := client.NotificationPolicyTree()
178178
if err != nil {
@@ -186,7 +186,7 @@ func readNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta
186186

187187
func createNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
188188
lock := &meta.(*common.Client).AlertingMutex
189-
client := meta.(*common.Client).GrafanaAPI
189+
client := meta.(*common.Client).DeprecatedGrafanaAPI
190190

191191
npt, err := unpackNotifPolicy(data)
192192
if err != nil {
@@ -205,7 +205,7 @@ func createNotificationPolicy(ctx context.Context, data *schema.ResourceData, me
205205

206206
func updateNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
207207
lock := &meta.(*common.Client).AlertingMutex
208-
client := meta.(*common.Client).GrafanaAPI
208+
client := meta.(*common.Client).DeprecatedGrafanaAPI
209209

210210
npt, err := unpackNotifPolicy(data)
211211
if err != nil {
@@ -223,7 +223,7 @@ func updateNotificationPolicy(ctx context.Context, data *schema.ResourceData, me
223223

224224
func deleteNotificationPolicy(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics {
225225
lock := &meta.(*common.Client).AlertingMutex
226-
client := meta.(*common.Client).GrafanaAPI
226+
client := meta.(*common.Client).DeprecatedGrafanaAPI
227227

228228
lock.Lock()
229229
defer lock.Unlock()

‎internal/resources/grafana/resource_alerting_notification_policy_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ func TestAccNotificationPolicy_basic(t *testing.T) {
9090

9191
func testNotifPolicyCheckDestroy() resource.TestCheckFunc {
9292
return func(s *terraform.State) error {
93-
client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
93+
client := testutils.Provider.Meta().(*common.Client).DeprecatedGrafanaAPI
9494
npt, err := client.NotificationPolicyTree()
9595
if err != nil {
9696
return fmt.Errorf("failed to get notification policies")
@@ -114,7 +114,7 @@ func testNotifPolicyCheckExists(rname string) resource.TestCheckFunc {
114114
return fmt.Errorf("resource id not set")
115115
}
116116

117-
client := testutils.Provider.Meta().(*common.Client).GrafanaAPI
117+
client := testutils.Provider.Meta().(*common.Client).DeprecatedGrafanaAPI
118118
npt, err := client.NotificationPolicyTree()
119119
if err != nil {
120120
return fmt.Errorf("failed to get notification policies")

‎internal/resources/grafana/resource_api_key.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Manages Grafana API Keys.
6262
}
6363

6464
func resourceAPIKeyCreate(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
65-
c, orgID := ClientFromNewOrgResource(m, d)
65+
c, orgID := DeprecatedClientFromNewOrgResource(m, d)
6666

6767
request := gapi.CreateAPIKeyRequest{
6868
Name: d.Get("name").(string),
@@ -82,7 +82,7 @@ func resourceAPIKeyCreate(ctx context.Context, d *schema.ResourceData, m interfa
8282
}
8383

8484
func resourceAPIKeyRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
85-
c, orgID, idStr := ClientFromExistingOrgResource(m, d.Id())
85+
c, orgID, idStr := DeprecatedClientFromExistingOrgResource(m, d.Id())
8686

8787
response, err := c.GetAPIKeys(true)
8888
if err, shouldReturn := common.CheckReadError("API key", d, err); shouldReturn {
@@ -115,7 +115,7 @@ func resourceAPIKeyRead(ctx context.Context, d *schema.ResourceData, m interface
115115
}
116116

117117
func resourceAPIKeyDelete(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
118-
c, _, idStr := ClientFromExistingOrgResource(m, d.Id())
118+
c, _, idStr := DeprecatedClientFromExistingOrgResource(m, d.Id())
119119
id, err := strconv.ParseInt(idStr, 10, 32)
120120
if err != nil {
121121
return diag.FromErr(err)

0 commit comments

Comments
 (0)