From f492ebe3f4ff80fb1cd7153da9cc47f968516e59 Mon Sep 17 00:00:00 2001 From: jackofallops <11830746+jackofallops@users.noreply.github.com> Date: Tue, 14 Jan 2025 17:35:56 +0100 Subject: [PATCH] `linting` - new/updated linter violations (#28505) * linting errors in tests * fix testing linting * fixup retryError returns - shouldn't silently return/succeed * fixup flatten error return - should not silently return and skip rest of Read --- internal/provider/framework/helpers_test.go | 27 ++++++------------ internal/sdk/resource_helpers_test.go | 3 +- .../services/datafactory/data_factory_test.go | 10 +++---- .../services/mssql/mssql_database_resource.go | 28 +++++++++---------- .../network/private_endpoint_resource.go | 2 +- 5 files changed, 29 insertions(+), 41 deletions(-) diff --git a/internal/provider/framework/helpers_test.go b/internal/provider/framework/helpers_test.go index 98ba67ff4822e..ffd6cea141f43 100644 --- a/internal/provider/framework/helpers_test.go +++ b/internal/provider/framework/helpers_test.go @@ -23,9 +23,7 @@ func Test_getOidcToken(t *testing.T) { if result == nil { t.Fatalf("getOidcToken returned nil result without an error") - } - - if *result != expectedString { + } else if *result != expectedString { t.Fatalf("getOidcToken did not return expected string (%s), got %+v", expectedString, *result) } } @@ -43,9 +41,7 @@ func Test_getOidcTokenFromFile(t *testing.T) { if result == nil { t.Fatalf("getOidcToken returned nil result without an error") - } - - if *result != expectedString { + } else if *result != expectedString { t.Fatalf("getOidcToken did not return expected string `%s`, got `%s`", expectedString, *result) } } @@ -117,8 +113,7 @@ func Test_getClientSecret(t *testing.T) { } if result == nil { t.Fatalf("getClientSecret returned nil result without an error") - } - if *result != expectedString { + } else if *result != expectedString { t.Fatalf("getCLientSecret did not return expected string `%s`, got `%s`", expectedString, *result) } } @@ -152,8 +147,7 @@ func Test_getClientSecretFromFile(t *testing.T) { } if result == nil { t.Fatalf("getClientSecretFromFile returned nil result without an error") - } - if *result != expectedString { + } else if *result != expectedString { t.Fatalf("getClientSecret did not return expected string `%s`, got `%s`", expectedString, *result) } } @@ -185,8 +179,7 @@ func Test_getClientID(t *testing.T) { } if result == nil { t.Fatalf("getClientID returned nil result without an error") - } - if *result != expectedString { + } else if *result != expectedString { t.Fatalf("getClientID did not return expected string `%s`, got `%s`", expectedString, *result) } } @@ -218,8 +211,7 @@ func Test_getClientIDFromFile(t *testing.T) { } if result == nil { t.Fatalf("getClientID returned nil result without an error") - } - if *result != expectedString { + } else if *result != expectedString { t.Fatalf("getClientID did not return expected string `%s`, got `%s`", expectedString, *result) } } @@ -238,8 +230,7 @@ func Test_getClientIDAKSWorkload(t *testing.T) { } if result == nil { t.Fatalf("getClientID returned nil result without an error") - } - if *result != expectedString { + } else if *result != expectedString { t.Fatalf("getClientID did not return expected string `%s`, got `%s`", expectedString, *result) } } @@ -270,9 +261,7 @@ func Test_decodeCertificate(t *testing.T) { if err != nil { t.Fatalf("decodeCertificate returned unexpected error %v", err) } - if result == nil { - t.Fatalf("decodeCertificate returned nil result without an error") - } + if string(result) != expected { t.Fatalf("decodeCertificate did not return expected result `%s`, got `%s`", expected, result) } diff --git a/internal/sdk/resource_helpers_test.go b/internal/sdk/resource_helpers_test.go index 2c08f027f280d..b458fd67951f4 100644 --- a/internal/sdk/resource_helpers_test.go +++ b/internal/sdk/resource_helpers_test.go @@ -132,8 +132,7 @@ func TestParseStructTags_WithValue(t *testing.T) { if actual == nil { t.Fatalf("expected actual to have a value but got nil") - } - if !reflect.DeepEqual(*data.expected, *actual) { + } else if !reflect.DeepEqual(*data.expected, *actual) { t.Fatalf("expected [%+v] and actual [%+v] didn't match", *data.expected, *actual) } } diff --git a/internal/services/datafactory/data_factory_test.go b/internal/services/datafactory/data_factory_test.go index 13ffc87f91faa..664f6fb844d8b 100644 --- a/internal/services/datafactory/data_factory_test.go +++ b/internal/services/datafactory/data_factory_test.go @@ -121,11 +121,11 @@ func TestDataFactoryDeserializePipelineActivities(t *testing.T) { t.Fatal(err) } - if items == nil && !tc.ExpectErr { - t.Fatal("Expected items got nil") - } - - if len(*items) != tc.ExpectActivityCount { + if items == nil { + if !tc.ExpectErr { + t.Fatal("Expected items got nil") + } + } else if len(*items) != tc.ExpectActivityCount { t.Fatal("Failed to deserialise pipeline") } } diff --git a/internal/services/mssql/mssql_database_resource.go b/internal/services/mssql/mssql_database_resource.go index cd0c6efec8a85..674d39ccbbe8a 100644 --- a/internal/services/mssql/mssql_database_resource.go +++ b/internal/services/mssql/mssql_database_resource.go @@ -509,9 +509,9 @@ func resourceMsSqlDatabaseCreate(d *pluginsdk.ResourceData, meta interface{}) er state = transparentdataencryptions.TransparentDataEncryptionStateEnabled } - tde, err := transparentEncryptionClient.Get(ctx, id) - if err != nil { - return fmt.Errorf("while retrieving Transparent Data Encryption state for %s: %+v", id, err) + tde, retryErr := transparentEncryptionClient.Get(ctx, id) + if retryErr != nil { + return fmt.Errorf("while retrieving Transparent Data Encryption state for %s: %+v", id, retryErr) } currentState := transparentdataencryptions.TransparentDataEncryptionStateDisabled @@ -523,21 +523,21 @@ func resourceMsSqlDatabaseCreate(d *pluginsdk.ResourceData, meta interface{}) er // Submit TDE state only when state is being changed, otherwise it can cause unwanted detection of state changes from the cloud side if !strings.EqualFold(string(currentState), string(state)) { - input := transparentdataencryptions.LogicalDatabaseTransparentDataEncryption{ + tdePayload := transparentdataencryptions.LogicalDatabaseTransparentDataEncryption{ Properties: &transparentdataencryptions.TransparentDataEncryptionProperties{ State: state, }, } - if err := transparentEncryptionClient.CreateOrUpdateThenPoll(ctx, id, input); err != nil { + if err := transparentEncryptionClient.CreateOrUpdateThenPoll(ctx, id, tdePayload); err != nil { return fmt.Errorf("while enabling Transparent Data Encryption for %q: %+v", id.String(), err) } // NOTE: Internal x-ref, this is another case of hashicorp/go-azure-sdk#307 so this can be removed once that's fixed - if err = pluginsdk.Retry(d.Timeout(pluginsdk.TimeoutCreate), func() *pluginsdk.RetryError { - c, err := client.Get(ctx, id, databases.DefaultGetOperationOptions()) - if err != nil { - return pluginsdk.NonRetryableError(fmt.Errorf("while polling %s for status: %+v", id.String(), err)) + if retryErr = pluginsdk.Retry(d.Timeout(pluginsdk.TimeoutCreate), func() *pluginsdk.RetryError { + c, err2 := client.Get(ctx, id, databases.DefaultGetOperationOptions()) + if err2 != nil { + return pluginsdk.NonRetryableError(fmt.Errorf("while polling %s for status: %+v", id.String(), err2)) } if c.Model != nil && c.Model.Properties != nil && c.Model.Properties.Status != nil { if c.Model.Properties.Status == pointer.To(databases.DatabaseStatusScaling) { @@ -548,8 +548,8 @@ func resourceMsSqlDatabaseCreate(d *pluginsdk.ResourceData, meta interface{}) er } return nil - }); err != nil { - return nil + }); retryErr != nil { + return retryErr } } else { log.Print("[DEBUG] Skipping re-writing of Transparent Data Encryption, since encryption state is not changing ...") @@ -597,7 +597,7 @@ func resourceMsSqlDatabaseCreate(d *pluginsdk.ResourceData, meta interface{}) er return nil }); err != nil { - return nil + return err } longTermRetentionPolicyProps := helper.ExpandLongTermRetentionPolicy(d.Get("long_term_retention_policy").([]interface{})) @@ -1001,7 +1001,7 @@ func resourceMsSqlDatabaseUpdate(d *pluginsdk.ResourceData, meta interface{}) er } return nil }); err != nil { - return nil + return err } } } @@ -1050,7 +1050,7 @@ func resourceMsSqlDatabaseUpdate(d *pluginsdk.ResourceData, meta interface{}) er return nil }); err != nil { - return nil + return err } if d.HasChange("long_term_retention_policy") { diff --git a/internal/services/network/private_endpoint_resource.go b/internal/services/network/private_endpoint_resource.go index 9ab1f514c560e..703e633960cd9 100644 --- a/internal/services/network/private_endpoint_resource.go +++ b/internal/services/network/private_endpoint_resource.go @@ -665,7 +665,7 @@ func resourcePrivateEndpointRead(d *pluginsdk.ResourceData, meta interface{}) er for _, dnsZoneId := range *privateDnsZoneIds { flattened, err := retrieveAndFlattenPrivateDnsZone(ctx, dnsClient, dnsZoneId) if err != nil { - return nil + return fmt.Errorf("reading %s for %s: %+v", dnsZoneId, id, err) } // an exceptional case but no harm in handling