Documentation
¶
Overview ¶
Package checks exposes all azproviderlint analyzers, grouped by category.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var All = append(azignore.Wrap(slices.Concat( AZC.Checks, AZD.Checks, AZG.Checks, AZR.Checks, AZS.Checks, AZT.Checks, )), AZG000.Analyzer)
All contains every azproviderlint analyzer across all categories, each honouring '//azignore:<Name> - <reason>' comment directives — except AZG000, which polices the directives themselves and is deliberately unwrapped (and kept out of AZG.Checks) so a bare directive cannot suppress the report about itself by listing AZG000.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package AZC collects the client & SDK usage checks.
|
Package AZC collects the client & SDK usage checks. |
|
AZC001_client_missing_base_uri
Package AZC001 defines an analyzer that reports Azure SDK clients being created without the resource manager endpoint explicitly specified.
|
Package AZC001 defines an analyzer that reports Azure SDK clients being created without the resource manager endpoint explicitly specified. |
|
Package AZD collects the data source checks.
|
Package AZD collects the data source checks. |
|
AZD001_data_source_empty_set_id
Package AZD001 defines an analyzer that reports data sources calling SetId with an empty string instead of returning an error when the resource cannot be found.
|
Package AZD001 defines an analyzer that reports data sources calling SetId with an empty string instead of returning an error when the resource cannot be found. |
|
AZD002_data_source_mark_as_gone
Package AZD002 defines an analyzer that reports data sources using MarkAsGone instead of returning an error when the resource cannot be found.
|
Package AZD002 defines an analyzer that reports data sources using MarkAsGone instead of returning an error when the resource cannot be found. |
|
Package AZG collects the general Go style & readability checks.
|
Package AZG collects the general Go style & readability checks. |
|
AZG000_azignore_missing_reason
Package AZG000 defines an analyzer that reports '//azignore:' directives that do not carry a reason explaining why the check is suppressed.
|
Package AZG000 defines an analyzer that reports '//azignore:' directives that do not carry a reason explaining why the check is suppressed. |
|
AZG001_combine_err_assignment_and_check
Package AZG001 defines an analyzer that reports 'err := SomeFunc()' and '_, err := SomeFunc()' assignments that should be combined with the following 'if err != nil' into a single 'if' init statement.
|
Package AZG001 defines an analyzer that reports 'err := SomeFunc()' and '_, err := SomeFunc()' assignments that should be combined with the following 'if err != nil' into a single 'if' init statement. |
|
AZG002_error_should_describe_expected_format
Package AZG002 defines an analyzer that reports unclear 'invalid format of' error messages that should describe the expected format instead.
|
Package AZG002 defines an analyzer that reports unclear 'invalid format of' error messages that should describe the expected format instead. |
|
AZG003_pointer_to_enum_conversion
Package AZG003 defines an analyzer that reports pointer.To being used with an explicit go-azure-sdk enum type conversion (pointer.To(sdk.Enum(v))) where the generic pointer.ToEnum[sdk.Enum](v) helper should be used instead.
|
Package AZG003 defines an analyzer that reports pointer.To being used with an explicit go-azure-sdk enum type conversion (pointer.To(sdk.Enum(v))) where the generic pointer.ToEnum[sdk.Enum](v) helper should be used instead. |
|
AZG004_zero_value_init_pointer_from
Package AZG004 defines an analyzer that reports a zero-value initialization immediately followed by a nil check and pointer dereference — `y := <zero>; if x != nil { y = *x }` — where the generic pointer.From(x) helper should be used instead.
|
Package AZG004 defines an analyzer that reports a zero-value initialization immediately followed by a nil check and pointer dereference — `y := <zero>; if x != nil { y = *x }` — where the generic pointer.From(x) helper should be used instead. |
|
AZG005_single_use_temporary
Package AZG005 defines an analyzer that reports single-use temporaries immediately consumed by the next statement — `x := <expr>` followed by `y = x` or `return x` where x has no other use — which should be inlined.
|
Package AZG005 defines an analyzer that reports single-use temporaries immediately consumed by the next statement — `x := <expr>` followed by `y = x` or `return x` where x has no other use — which should be inlined. |
|
Package AZR collects the resource implementation checks.
|
Package AZR collects the resource implementation checks. |
|
AZR001_set_id_dereferenced_pointer
Package AZR001 defines an analyzer that reports SetId being called with a dereferenced pointer (typically the raw Azure API resource ID) instead of a generated Resource ID Formatter/Parser's id.ID().
|
Package AZR001 defines an analyzer that reports SetId being called with a dereferenced pointer (typically the raw Azure API resource ID) instead of a generated Resource ID Formatter/Parser's id.ID(). |
|
AZR002_combined_create_update_method
Package AZR002 defines an analyzer that reports resources registering a combined CreateUpdate method instead of separate Create and Update methods.
|
Package AZR002 defines an analyzer that reports resources registering a combined CreateUpdate method instead of separate Create and Update methods. |
|
AZR003_resource_data_get_in_delete
Package AZR003 defines an analyzer that reports ResourceData.Get being used inside a resource's Delete function, where it does not work as expected.
|
Package AZR003 defines an analyzer that reports ResourceData.Get being used inside a resource's Delete function, where it does not work as expected. |
|
AZR004_resource_id_equality_comparison
Package AZR004 defines an analyzer that reports Resource IDs being compared with the == or != operators instead of resourceids.Match.
|
Package AZR004 defines an analyzer that reports Resource IDs being compared with the == or != operators instead of resourceids.Match. |
|
AZR005_case_insensitive_segments_feature_flag
Package AZR005 defines an analyzer that reports assignments to the TreatUserSpecifiedSegmentsAsCaseInsensitive feature flag, which must not be configured.
|
Package AZR005 defines an analyzer that reports assignments to the TreatUserSpecifiedSegmentsAsCaseInsensitive feature flag, which must not be configured. |
|
AZR006_stop_context_without_timeouts
Package AZR006 defines an analyzer that reports resources assigning ctx directly from the provider meta object instead of using a timeouts-wrapped StopContext.
|
Package AZR006 defines an analyzer that reports resources assigning ctx directly from the provider meta object instead of using a timeouts-wrapped StopContext. |
|
AZR007_state_change_conf
Package AZR007 defines an analyzer that reports StateChangeConf usage, which should be replaced with a custom poller implementing the pollers.PollerType interface.
|
Package AZR007 defines an analyzer that reports StateChangeConf usage, which should be replaced with a custom poller implementing the pollers.PollerType interface. |
|
Package AZS collects the schema & typed SDK model checks.
|
Package AZS collects the schema & typed SDK model checks. |
|
AZS001_typed_sdk_model_64bit_types
Package AZS001 defines an analyzer that reports tfschema-tagged typed SDK model fields using non-64-bit numeric types where the SDK's Encode/Decode requires int64/float64.
|
Package AZS001 defines an analyzer that reports tfschema-tagged typed SDK model fields using non-64-bit numeric types where the SDK's Encode/Decode requires int64/float64. |
|
AZS002_schema_default_type_mismatch
Package AZS002 defines an analyzer that reports schema declarations whose Default value does not match the declared schema Type.
|
Package AZS002 defines an analyzer that reports schema declarations whose Default value does not match the declared schema Type. |
|
AZS003_schema_allows_empty_block
Package AZS003 defines an analyzer that reports optional or required list blocks whose properties are all optional with no defaults, so an empty block (`foo {}`) is valid configuration that can crash expand functions or produce spurious diffs.
|
Package AZS003 defines an analyzer that reports optional or required list blocks whose properties are all optional with no defaults, so an empty block (`foo {}`) is valid configuration that can crash expand functions or produce spurious diffs. |
|
AZS004_enum_validation_missing_values
Package AZS004 defines an analyzer that reports enum validations built from a hand-written []string that does not cover every possible value of the SDK enum being validated.
|
Package AZS004 defines an analyzer that reports enum validations built from a hand-written []string that does not cover every possible value of the SDK enum being validated. |
|
AZS005_resource_missing_data_source
Package AZS005 defines an analyzer that reports registered resources that have no corresponding data source of the same name, across every registration flavour: untyped plugin SDK maps, typed sdk.Resource slices and framework wrapped resource slices.
|
Package AZS005 defines an analyzer that reports registered resources that have no corresponding data source of the same name, across every registration flavour: untyped plugin SDK maps, typed sdk.Resource slices and framework wrapped resource slices. |
|
AZS006_data_source_missing_properties
Package AZS006 defines an analyzer that reports data sources whose same-named resource exposes schema properties the data source does not, across untyped plugin SDK, typed SDK and framework registration flavours.
|
Package AZS006 defines an analyzer that reports data sources whose same-named resource exposes schema properties the data source does not, across untyped plugin SDK, typed SDK and framework registration flavours. |
|
Package AZT collects the acceptance testing checks.
|
Package AZT collects the acceptance testing checks. |
|
AZT001_acceptance_test_external_package
Package AZT001 defines an analyzer that reports acceptance test files (for resources, data sources, actions and ephemeral resources) that do not use an external _test package.
|
Package AZT001 defines an analyzer that reports acceptance test files (for resources, data sources, actions and ephemeral resources) that do not use an external _test package. |
|
AZT002_credentials_from_environment
Package AZT002 defines an analyzer that reports tests reading provider credentials from the environment instead of provisioning their own identity.
|
Package AZT002 defines an analyzer that reports tests reading provider credentials from the environment instead of provisioning their own identity. |
|
Package azignore implements '//azignore:AZX001 - reason' comment directives, letting individual checks be suppressed per line without disabling every azproviderlint check on that line the way '//nolint:azproviderlint' does.
|
Package azignore implements '//azignore:AZX001 - reason' comment directives, letting individual checks be suppressed per line without disabling every azproviderlint check on that line the way '//nolint:azproviderlint' does. |
Click to show internal directories.
Click to hide internal directories.