From 2f6f8c2e1fc5dfab9f5dc910c260e8d0bfa4c1a7 Mon Sep 17 00:00:00 2001 From: Ere Mid Date: Wed, 8 Feb 2023 17:39:14 +0100 Subject: [PATCH 1/4] chore(lint): blank imports + var declaration --- internal/provider/tier0_vrf_datasource.go | 1 - internal/provider/vdc_datasource.go | 1 - internal/provider/vdcs_datasource.go | 1 - main.go | 2 +- 4 files changed, 1 insertion(+), 4 deletions(-) diff --git a/internal/provider/tier0_vrf_datasource.go b/internal/provider/tier0_vrf_datasource.go index 978f038d..befc3f8a 100644 --- a/internal/provider/tier0_vrf_datasource.go +++ b/internal/provider/tier0_vrf_datasource.go @@ -8,7 +8,6 @@ import ( "github.com/hashicorp/terraform-plugin-framework/datasource/schema" "github.com/hashicorp/terraform-plugin-framework/types" "github.com/hashicorp/terraform-plugin-log/tflog" - _ "github.com/orange-cloudavenue/cloudavenue-sdk-go" "github.com/orange-cloudavenue/terraform-provider-cloudavenue/pkg/utils" ) diff --git a/internal/provider/vdc_datasource.go b/internal/provider/vdc_datasource.go index 1c45a108..92cfb661 100644 --- a/internal/provider/vdc_datasource.go +++ b/internal/provider/vdc_datasource.go @@ -7,7 +7,6 @@ import ( "github.com/hashicorp/terraform-plugin-framework/datasource" "github.com/hashicorp/terraform-plugin-framework/datasource/schema" "github.com/hashicorp/terraform-plugin-framework/types" - _ "github.com/orange-cloudavenue/cloudavenue-sdk-go" ) var ( diff --git a/internal/provider/vdcs_datasource.go b/internal/provider/vdcs_datasource.go index 89129872..d434616f 100644 --- a/internal/provider/vdcs_datasource.go +++ b/internal/provider/vdcs_datasource.go @@ -7,7 +7,6 @@ import ( "github.com/hashicorp/terraform-plugin-framework/datasource" "github.com/hashicorp/terraform-plugin-framework/datasource/schema" "github.com/hashicorp/terraform-plugin-framework/types" - _ "github.com/orange-cloudavenue/cloudavenue-sdk-go" ) var ( diff --git a/main.go b/main.go index b504940d..bc1e9188 100644 --- a/main.go +++ b/main.go @@ -11,7 +11,7 @@ import ( ) // Example version string that can be overwritten by a release process. -var version string = "dev" +var version = "dev" // Provider documentation generation. //go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name cloudavenue From 01fd00b1b6cc497ce8f62570ad0771ad967ef9ce Mon Sep 17 00:00:00 2001 From: Mickael Stanislas Date: Wed, 8 Feb 2023 21:29:33 +0100 Subject: [PATCH 2/4] chore(lint): add new linters in golangci-lint --- .golangci.yml | 130 ++++++++++++++++++++++++++++++++++++------ .vscode/settings.json | 6 +- 2 files changed, 115 insertions(+), 21 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index 223cf95d..18418ac2 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -5,23 +5,115 @@ issues: max-same-issues: 0 linters: - disable-all: true enable: - - durationcheck - - errcheck - - exportloopref - - forcetypeassert - - godot - - gofmt - - gosimple - - ineffassign - - makezero - - misspell - - nilerr - - predeclared - - staticcheck - - tenv - - unconvert - - unparam - - unused - - vet \ No newline at end of file + - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers [fast: true, auto-fix: false] + - bidichk # Checks for dangerous unicode character sequences [fast: true, auto-fix: false] + - containedctx # containedctx is a linter that detects struct contained context.Context field [fast: true, auto-fix: false] + - deadcode # Finds unused code [fast: false, auto-fix: false] + - decorder # check declaration order and count of types, constants, variables and functions [fast: true, auto-fix: false] + - depguard # Go linter that checks if package imports are in a list of acceptable packages [fast: true, auto-fix: false] + - dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false] + - durationcheck # check for two durations multiplied together [fast: false, auto-fix: false] + - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false] + - errchkjson # Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted. [fast: false, auto-fix: false] + - errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`. [fast: false, auto-fix: false] + - execinquery # execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds [fast: false, auto-fix: false] + - exportloopref # checks for pointers to enclosing loop variables [fast: false, auto-fix: false] + - forbidigo # Forbids identifiers [fast: true, auto-fix: false] + - gci # Gci controls golang package import order and makes it always deterministic. [fast: true, auto-fix: false] + - goconst # Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false] + - gocritic # Provides diagnostics that check for bugs, performance and style issues. [fast: false, auto-fix: false] + - gocyclo # Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false] + - gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true] + - goheader # Checks is file header matches to pattern [fast: true, auto-fix: false] + - gofumpt # Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true] + - goimports # In addition to fixing imports, goimports also formats your code in the same style as gofmt. [fast: true, auto-fix: true] + - gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod. [fast: true, auto-fix: false] + - gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations. [fast: true, auto-fix: false] + - goprintffuncname # Checks that printf-like functions are named with `f` at the end [fast: true, auto-fix: false] + - gosec #(gas): Inspects source code for security problems [fast: false, auto-fix: false] + - gosimple #(megacheck): Linter for Go source code that specializes in simplifying a code [fast: false, auto-fix: false] + - govet #(vet, vetshadow): Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string [fast: false, auto-fix: false] + - grouper # An analyzer to analyze expression groups. [fast: true, auto-fix: false] + - ifshort # Checks that your code uses short syntax for if-statements whenever possible [fast: true, auto-fix: false] + - importas # Enforces consistent import aliases [fast: false, auto-fix: false] + - ineffassign # Detects when assignments to existing variables are not used [fast: true, auto-fix: false] + - makezero # Finds slice declarations with non-zero initial length [fast: false, auto-fix: false] + - misspell # Finds commonly misspelled English words in comments [fast: true, auto-fix: true] + - nakedret # Finds naked returns in functions greater than a specified function length [fast: true, auto-fix: false] + - nilerr # Finds the code that returns nil even if it checks that the error is not nil. [fast: false, auto-fix: false] + - noctx # noctx finds sending http request without context.Context [fast: false, auto-fix: false] + - nolintlint # Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: false] + - nosprintfhostport # Checks for misuse of Sprintf to construct a host with port in a URL. [fast: true, auto-fix: false] + - predeclared # find code that shadows one of Go's predeclared identifiers [fast: true, auto-fix: false] + - promlinter # Check Prometheus metrics naming via promlint [fast: true, auto-fix: false] + - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [fast: false, auto-fix: false] + - rowserrcheck # checks whether Err of rows is checked successfully [fast: false, auto-fix: false] + - sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed. [fast: false, auto-fix: false] + - structcheck # Finds unused struct fields [fast: false, auto-fix: false] + - stylecheck # Stylecheck is a replacement for golint [fast: false, auto-fix: false] + - tagliatelle # Checks the struct tags. [fast: true, auto-fix: false] + - tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17 [fast: false, auto-fix: false] + - thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers [fast: false, auto-fix: false] + - tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes [fast: false, auto-fix: false] + - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code [fast: false, auto-fix: false] + - unconvert # Remove unnecessary type conversions [fast: false, auto-fix: false] + - varcheck # Finds unused global variables and constants [fast: false, auto-fix: false] + - wastedassign # wastedassign finds wasted assignment statements. [fast: false, auto-fix: false] + - whitespace # Tool for detection of leading and trailing whitespace [fast: true, auto-fix: true] + + disable: + - cyclop # checks function and package cyclomatic complexity [fast: false, auto-fix: false] + - dupl # Tool for code clone detection [fast: true, auto-fix: false] + - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13. [fast: false, auto-fix: false] + - exhaustive # check exhaustiveness of enum switch statements [fast: false, auto-fix: false] + - funlen # Tool for detection of long functions [fast: true, auto-fix: false] + - gochecknoglobals # check that no global variables exist [fast: true, auto-fix: false] + - gochecknoinits # Checks that no init functions are present in Go code [fast: true, auto-fix: false] + - gocognit # Computes and checks the cognitive complexity of functions [fast: true, auto-fix: false] + - godot # Check if comments end in a period [fast: true, auto-fix: true] + - godox # Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false] + - goerr113 # Golang linter to check the errors handling expressions [fast: false, auto-fix: false] + - gomnd # An analyzer to detect magic numbers. [fast: true, auto-fix: false] + - lll # Reports long lines [fast: true, auto-fix: false] + - maintidx # maintidx measures the maintainability index of each function. [fast: true, auto-fix: false] + - nestif # Reports deeply nested if statements [fast: true, auto-fix: false] + - nilnil # Checks that there is no simultaneous return of `nil` error and an invalid value. [fast: false, auto-fix: false] + - nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity [fast: true, auto-fix: false] + - staticcheck #(megacheck): Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: false, auto-fix: false] + - unused #(megacheck): Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false] + - varnamelen # checks that the length of a variable's name matches its scope [fast: false, auto-fix: false] + - wrapcheck # Checks that errors returned from external packages are wrapped [fast: false, auto-fix: false] + - wsl # Whitespace Linter - Forces you to use empty lines! [fast: true, auto-fix: false] + +linters-settings: + goimports: + local-prefixes: github.com/orange-cloudavenue/terraform-provider-cloudavenue + + gci: + # Section configuration to compare against. + # Section names are case-insensitive and may contain parameters in (). + # The default order of sections is `standard > default > custom > blank > dot`, + # If `custom-order` is `true`, it follows the order of `sections` option. + # Default: ["standard", "default"] + sections: + - standard # Standard section: captures all standard packages. + - default # Default section: contains all imports that could not be matched to another section type. + - prefix(github.com/orange-cloudavenue/terraform-provider-cloudavenue) # Custom section: groups all imports with the specified Prefix. + - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled. + - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled. + # Skip generated files. + # Default: true + skip-generated: false + # Enable custom order of sections. + # If `true`, make the section order the same as the order of `sections`. + # Default: false + custom-order: true + + gofumpt: + # Module path which contains the source code being formatted. + # Default: "" + module-path: github.com/orange-cloudavenue/terraform-provider-cloudavenue + # Choose whether to use the extra rules. + # Default: false + extra-rules: true \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index 22bd8fdc..d6ded716 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,6 +5,8 @@ }, "go.lintTool": "golangci-lint", "go.lintFlags": [ - "--fast" - ] + "--fast", + "--fix" + ], + "go.lintOnSave": "package" } \ No newline at end of file From c018a3273691a6e0ceee50a2aa8a8f3318226ef4 Mon Sep 17 00:00:00 2001 From: Mickael Stanislas Date: Wed, 8 Feb 2023 21:29:50 +0100 Subject: [PATCH 3/4] chore(lint): fix lint errors --- internal/provider/edge_gateway_datasource.go | 4 +--- internal/provider/edge_gateways_datasource.go | 4 +--- internal/provider/helper_api_errors.go | 4 +--- internal/provider/provider.go | 23 +++++++++---------- internal/provider/provider_test.go | 22 ++++++++---------- 5 files changed, 24 insertions(+), 33 deletions(-) diff --git a/internal/provider/edge_gateway_datasource.go b/internal/provider/edge_gateway_datasource.go index a6019e59..0fff5200 100644 --- a/internal/provider/edge_gateway_datasource.go +++ b/internal/provider/edge_gateway_datasource.go @@ -103,7 +103,7 @@ func (d *edgeGatewayDataSource) Read(ctx context.Context, req datasource.ReadReq } gateway, httpR, err := d.client.EdgeGatewaysApi.ApiCustomersV20EdgesEdgeIdGet(d.client.auth, data.EdgeID.ValueString()) - if x := CheckApiError(err, httpR); x != nil { + if x := CheckAPIError(err, httpR); x != nil { resp.Diagnostics.Append(x.GetTerraformDiagnostic()) if resp.Diagnostics.HasError() { return @@ -111,9 +111,7 @@ func (d *edgeGatewayDataSource) Read(ctx context.Context, req datasource.ReadReq // Is Not Found data.ID = types.StringValue("") - } else { - data = edgeGatewayDataSourceModel{ Tier0VrfID: types.StringValue(gateway.Tier0VrfId), EdgeName: types.StringValue(gateway.EdgeName), diff --git a/internal/provider/edge_gateways_datasource.go b/internal/provider/edge_gateways_datasource.go index c510cca4..c5ac2143 100644 --- a/internal/provider/edge_gateways_datasource.go +++ b/internal/provider/edge_gateways_datasource.go @@ -115,7 +115,7 @@ func (d *edgeGatewaysDataSource) Read(ctx context.Context, req datasource.ReadRe } gateways, httpR, err := d.client.EdgeGatewaysApi.ApiCustomersV20EdgesGet(d.client.auth) - if x := CheckApiError(err, httpR); x != nil { + if x := CheckAPIError(err, httpR); x != nil { resp.Diagnostics.Append(x.GetTerraformDiagnostic()) if resp.Diagnostics.HasError() { return @@ -124,9 +124,7 @@ func (d *edgeGatewaysDataSource) Read(ctx context.Context, req datasource.ReadRe // Is Not Found data.EdgeGateways = []gateway{} data.ID = types.StringValue("") - } else { - for _, gw := range gateways { d := gateway{ Tier0VrfID: types.StringValue(gw.Tier0VrfId), diff --git a/internal/provider/helper_api_errors.go b/internal/provider/helper_api_errors.go index ffe19f54..9a011997 100644 --- a/internal/provider/helper_api_errors.go +++ b/internal/provider/helper_api_errors.go @@ -67,14 +67,12 @@ func (e *APIError) IsNotFound() bool { // CheckApiError checks the HTTP response for errors and returns an APIError // if the response code is >= 400. // If the response code is < 400, nil is returned. -func CheckApiError(err error, httpR *http.Response) *APIError { - +func CheckAPIError(err error, httpR *http.Response) *APIError { if err == nil { return nil } if httpR != nil && httpR.StatusCode >= 400 { - if e, ok := err.(apiclient.GenericSwaggerError); ok { x := &APIError{ lastError: err, diff --git a/internal/provider/provider.go b/internal/provider/provider.go index 8a12322d..b2cff84d 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -199,19 +199,18 @@ func (p *cloudavenueProvider) Configure( "CloudAvenue Client Error: "+err.Error(), ) return - } else { - token := ret.Header.Get("x-vmware-vcloud-access-token") - if token == "" { - resp.Diagnostics.AddError( - "Unable to Create CloudAvenue API Client", - "An unexpected error occurred when creating the CloudAvenue API client. "+ - "If the error is not clear, please contact the provider developers.\n\n"+ - "CloudAvenue Client Error: empty token", - ) - return - } - client.auth = context.WithValue(context.Background(), apiclient.ContextAccessToken, token) } + token := ret.Header.Get("x-vmware-vcloud-access-token") + if token == "" { + resp.Diagnostics.AddError( + "Unable to Create CloudAvenue API Client", + "An unexpected error occurred when creating the CloudAvenue API client. "+ + "If the error is not clear, please contact the provider developers.\n\n"+ + "CloudAvenue Client Error: empty token", + ) + return + } + client.auth = context.WithValue(context.Background(), apiclient.ContextAccessToken, token) // Make the CloudAvenue client available during DataSource and Resource // type Configure methods. diff --git a/internal/provider/provider_test.go b/internal/provider/provider_test.go index 8ce62964..7e41f6b2 100644 --- a/internal/provider/provider_test.go +++ b/internal/provider/provider_test.go @@ -7,18 +7,16 @@ import ( "github.com/hashicorp/terraform-plugin-go/tfprotov6" ) -var ( - // testAccProtoV6ProviderFactories are used to instantiate a provider during - // acceptance testing. The factory function will be invoked for every Terraform - // CLI command executed to create a provider server to which the CLI can - // reattach. - testAccProtoV6ProviderFactories = map[string]func() (tfprotov6.ProviderServer, error){ - "cloudavenue": providerserver.NewProtocol6WithError(New("test")()), - } -) +// testAccProtoV6ProviderFactories are used to instantiate a provider during +// acceptance testing. The factory function will be invoked for every Terraform +// CLI command executed to create a provider server to which the CLI can +// reattach. +var testAccProtoV6ProviderFactories = map[string]func() (tfprotov6.ProviderServer, error){ + "cloudavenue": providerserver.NewProtocol6WithError(New("test")()), +} +// You can add code here to run prior to any test case execution, for example assertions +// about the appropriate environment variables being set are common to see in a pre-check +// function. func testAccPreCheck(t *testing.T) { - // You can add code here to run prior to any test case execution, for example assertions - // about the appropriate environment variables being set are common to see in a pre-check - // function. } From 7c9a42e7863133e059f37b0d0a9c8c1533b537fd Mon Sep 17 00:00:00 2001 From: Mickael Stanislas Date: Wed, 8 Feb 2023 21:36:28 +0100 Subject: [PATCH 4/4] chore(lint): remove unused linters --- .golangci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index 18418ac2..d2097d3d 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -8,7 +8,6 @@ linters: enable: - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers [fast: true, auto-fix: false] - bidichk # Checks for dangerous unicode character sequences [fast: true, auto-fix: false] - - containedctx # containedctx is a linter that detects struct contained context.Context field [fast: true, auto-fix: false] - deadcode # Finds unused code [fast: false, auto-fix: false] - decorder # check declaration order and count of types, constants, variables and functions [fast: true, auto-fix: false] - depguard # Go linter that checks if package imports are in a list of acceptable packages [fast: true, auto-fix: false] @@ -54,7 +53,6 @@ linters: - stylecheck # Stylecheck is a replacement for golint [fast: false, auto-fix: false] - tagliatelle # Checks the struct tags. [fast: true, auto-fix: false] - tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17 [fast: false, auto-fix: false] - - thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers [fast: false, auto-fix: false] - tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes [fast: false, auto-fix: false] - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code [fast: false, auto-fix: false] - unconvert # Remove unnecessary type conversions [fast: false, auto-fix: false] @@ -63,6 +61,8 @@ linters: - whitespace # Tool for detection of leading and trailing whitespace [fast: true, auto-fix: true] disable: + - containedctx # containedctx is a linter that detects struct contained context.Context field [fast: true, auto-fix: false] + - thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers [fast: false, auto-fix: false] - cyclop # checks function and package cyclomatic complexity [fast: false, auto-fix: false] - dupl # Tool for code clone detection [fast: true, auto-fix: false] - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13. [fast: false, auto-fix: false]