Linting (#1087)

* fix linting
* rename AuditRecordsor to RecordAuditor
* gandi_v5 to gandiv5

commands/fmt.go

@@ -21,6 +21,7 @@ var _ = cmd(catUtils, func() *cli.Command {
 	}
 }())
 
+// FmtArgs stores arguments related to the fmt subcommand.
 type FmtArgs struct {
 	InputFile  string
 	OutputFile string
@@ -44,6 +45,7 @@ func (args *FmtArgs) flags() []cli.Flag {
 	return flags
 }
 
+// FmtFile reads and formats a file.
 func FmtFile(args FmtArgs) error {
 	fileBytes, readErr := ioutil.ReadFile(args.InputFile)
 	if readErr != nil {
@@ -62,14 +64,13 @@ func FmtFile(args FmtArgs) error {
 		beautified = beautified + "\n"
 	}
 
-	if args.OutputFile != "" {
+	if args.OutputFile == "" {
+		fmt.Print(beautified)
+	} else {
 		if err := ioutil.WriteFile(args.OutputFile, []byte(beautified), 0744); err != nil {
 			return err
-		} else {
-			fmt.Fprintf(os.Stderr, "File %s successfully written\n", args.OutputFile)
 		}
-	} else {
-		fmt.Print(beautified)
+		fmt.Fprintf(os.Stderr, "File %s successfully written\n", args.OutputFile)
 	}
 	return nil
 }

providers/_all/all.go

@@ -15,7 +15,7 @@ import (
 	_ "github.com/StackExchange/dnscontrol/v3/providers/dnsimple"
 	_ "github.com/StackExchange/dnscontrol/v3/providers/doh"
 	_ "github.com/StackExchange/dnscontrol/v3/providers/exoscale"
-	_ "github.com/StackExchange/dnscontrol/v3/providers/gandi_v5"
+	_ "github.com/StackExchange/dnscontrol/v3/providers/gandiv5"
 	_ "github.com/StackExchange/dnscontrol/v3/providers/gcloud"
 	_ "github.com/StackExchange/dnscontrol/v3/providers/hedns"
 	_ "github.com/StackExchange/dnscontrol/v3/providers/hetzner"

providers/activedir/activedirProvider.go

@@ -32,7 +32,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:          newDNS,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("ACTIVEDIRECTORY_PS", fns, features)
 }

providers/axfrddns/axfrddnsProvider.go

@@ -119,7 +119,7 @@ func initAxfrDdns(config map[string]string, providermeta json.RawMessage) (provi
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    initAxfrDdns,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("AXFRDDNS", fns, features)
 }

providers/azuredns/azureDnsProvider.go

@@ -70,7 +70,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newAzureDNSDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("AZURE_DNS", fns, features)
 	providers.RegisterCustomRecordType("AZURE_ALIAS", "AZURE_DNS", "")

providers/bind/bindProvider.go

@@ -79,7 +79,7 @@ func initBind(config map[string]string, providermeta json.RawMessage) (providers
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    initBind,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("BIND", fns, features)
 }

providers/cloudflare/cloudflareProvider.go

@@ -55,7 +55,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newCloudflare,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("CLOUDFLAREAPI", fns, features)
 	providers.RegisterCustomRecordType("CF_REDIRECT", "CLOUDFLAREAPI", "")

providers/cloudns/cloudnsProvider.go

@@ -56,7 +56,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    NewCloudns,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("CLOUDNS", fns, features)
 }

providers/desec/desecProvider.go

@@ -58,7 +58,7 @@ var defaultNameServerNames = []string{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:          NewDeSec,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("DESEC", fns, features)
 }

providers/digitalocean/digitaloceanProvider.go

@@ -82,7 +82,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    NewDo,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("DIGITALOCEAN", fns, features)
 }

providers/dnsimple/dnsimpleProvider.go

@@ -37,7 +37,7 @@ func init() {
 	providers.RegisterRegistrarType("DNSIMPLE", newReg)
 	fns := providers.DspFuncs{
 		Initializer:    newDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("DNSIMPLE", fns, features)
 }

providers/exoscale/exoscaleProvider.go

@@ -39,7 +39,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:          NewExoscale,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("EXOSCALE", fns, features)
 }

providers/gandiv5/auditrecords.go

@@ -1,4 +1,4 @@
-package gandi_v5
+package gandiv5
 
 import (
 	"github.com/StackExchange/dnscontrol/v3/models"

providers/gandiv5/convert.go

@@ -1,4 +1,4 @@
-package gandi_v5
+package gandiv5
 
 // Convert the provider's native record description to models.RecordConfig.
 

providers/gandiv5/convert_test.go

@@ -1,4 +1,4 @@
-package gandi_v5
+package gandiv5
 
 import (
 	"testing"

providers/gandiv5/gandi_v5Provider.go

@@ -1,4 +1,4 @@
-package gandi_v5
+package gandiv5
 
 /*
 
@@ -36,8 +36,8 @@ import (
 // init registers the provider to dnscontrol.
 func init() {
 	fns := providers.DspFuncs{
-		Initializer:    newDsp,
-		AuditRecordsor: AuditRecords,
+		Initializer:   newDsp,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("GANDI_V5", fns, features)
 	providers.RegisterRegistrarType("GANDI_V5", newReg)

providers/gcloud/gcloudProvider.go

@@ -39,7 +39,7 @@ func sPtr(s string) *string {
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    New,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("GCLOUD", fns, features)
 }

providers/hedns/hednsProvider.go

@@ -62,7 +62,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newHEDNSProvider,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("HEDNS", fns, features)
 }

providers/hetzner/hetznerProvider.go

@@ -28,7 +28,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    New,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("HETZNER", fns, features)
 }

providers/hexonet/hexonetProvider.go

@@ -68,7 +68,7 @@ func newDsp(conf map[string]string, meta json.RawMessage) (providers.DNSServiceP
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterRegistrarType("HEXONET", newReg)
 	providers.RegisterDomainServiceProviderType("HEXONET", fns, features)

providers/hostingde/hostingdeProvider.go

@@ -35,7 +35,7 @@ func init() {
 	providers.RegisterRegistrarType("HOSTINGDE", newHostingdeReg)
 	fns := providers.DspFuncs{
 		Initializer:    newHostingdeDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("HOSTINGDE", fns, features)
 }

providers/inwx/inwxProvider.go

@@ -70,7 +70,7 @@ func init() {
 	providers.RegisterRegistrarType("INWX", newInwxReg)
 	fns := providers.DspFuncs{
 		Initializer:    newInwxDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("INWX", fns, features)
 }

providers/linode/linodeProvider.go

@@ -95,7 +95,7 @@ func init() {
 	// SRV support is in this provider, but Linode doesn't seem to support it properly
 	fns := providers.DspFuncs{
 		Initializer:          NewLinode,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("LINODE", fns, features)
 }

providers/msdns/msdnsProvider.go

@@ -35,7 +35,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newDNS,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("MSDNS", fns, features)
 }

providers/namecheap/namecheapProvider.go

@@ -43,7 +43,7 @@ func init() {
 	providers.RegisterRegistrarType("NAMECHEAP", newReg)
 	fns := providers.DspFuncs{
 		Initializer:          newDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("NAMECHEAP", fns, features)
 	providers.RegisterCustomRecordType("URL", "NAMECHEAP", "")

providers/namedotcom/namedotcomProvider.go

@@ -57,7 +57,7 @@ func init() {
 	providers.RegisterRegistrarType("NAMEDOTCOM", newReg)
 	fns := providers.DspFuncs{
 		Initializer:          newDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("NAMEDOTCOM", fns, features)
 }

providers/netcup/netcupProvider.go

@@ -23,7 +23,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    New,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("NETCUP", fns, features)
 }

providers/ns1/ns1provider.go

@@ -26,7 +26,7 @@ var docNotes = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newProvider,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("NS1", fns, providers.CanUseSRV, docNotes)
 	providers.RegisterCustomRecordType("NS1_URLFWD", "NS1", "URLFWD")

providers/octodns/octodnsProvider.go

@@ -65,7 +65,7 @@ func initProvider(config map[string]string, providermeta json.RawMessage) (provi
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:          initProvider,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("OCTODNS", fns, features)
 }

providers/oracle/oracleProvider.go

@@ -37,7 +37,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    New,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("ORACLE", fns, features)
 }

providers/ovh/ovhProvider.go

@@ -57,7 +57,7 @@ func newReg(conf map[string]string) (providers.Registrar, error) {
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newDsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterRegistrarType("OVH", newReg)
 	providers.RegisterDomainServiceProviderType("OVH", fns, features)

providers/powerdns/powerdnsProvider.go

@@ -34,7 +34,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    NewProvider,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("POWERDNS", fns, features)
 }

providers/providers.go

@@ -40,15 +40,15 @@ var RegistrarTypes = map[string]RegistrarInitializer{}
 // DspInitializer is a function to create a DNS service provider. Function will be passed the unprocessed json payload from the configuration file for the given provider.
 type DspInitializer func(map[string]string, json.RawMessage) (DNSServiceProvider, error)
 
-// AuditRecordsor is a function that verifies that all the records
+// RecordAuditor is a function that verifies that all the records
 // are supportable by this provider. It returns an error related to
 // the first record that this provider can not support.
-type AuditRecordsor func([]*models.RecordConfig) error
+type RecordAuditor func([]*models.RecordConfig) error
 
 // DspFuncs lists functions registered with a provider.
 type DspFuncs struct {
 	Initializer          DspInitializer
-	AuditRecordsor AuditRecordsor
+	RecordAuditor RecordAuditor
 }
 
 // DNSProviderTypes stores initializer for each DSP.
@@ -90,15 +90,16 @@ func CreateDNSProvider(dType string, config map[string]string, meta json.RawMess
 	return p.Initializer(config, meta)
 }
 
+// AuditRecords calls the RecordAudit function for a provider.
 func AuditRecords(dType string, rcs models.Records) error {
 	p, ok := DNSProviderTypes[dType]
 	if !ok {
 		return fmt.Errorf("DSP type %s not declared", dType)
 	}
-	if p.AuditRecordsor == nil {
-		return fmt.Errorf("DSP type %s has no AuditRecordsor", dType)
+	if p.RecordAuditor == nil {
+		return fmt.Errorf("DSP type %s has no RecordAuditor", dType)
 	}
-	return p.AuditRecordsor(rcs)
+	return p.RecordAuditor(rcs)
 }
 
 // None is a basic provider type that does absolutely nothing. Can be useful as a placeholder for third parties or unimplemented providers.

providers/route53/route53Provider.go

@@ -81,7 +81,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    newRoute53Dsp,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("ROUTE53", fns, features)
 	providers.RegisterRegistrarType("ROUTE53", newRoute53Reg)

providers/softlayer/softlayerProvider.go

@@ -29,7 +29,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:          newReg,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("SOFTLAYER", fns, features)
 }

providers/vultr/vultrProvider.go

@@ -39,7 +39,7 @@ var features = providers.DocumentationNotes{
 func init() {
 	fns := providers.DspFuncs{
 		Initializer:    NewProvider,
-		AuditRecordsor: AuditRecords,
+		RecordAuditor: AuditRecords,
 	}
 	providers.RegisterDomainServiceProviderType("VULTR", fns, features)
 }