PMM-12429 Use a configuration file for mockery

.mockery.yaml

@@ -0,0 +1,110 @@
+# This is the top-level configuration file for mockery.
+disable-version-string: True
+with-expecter: False
+inpackage: True
+dir: "{{.InterfaceDir}}"
+filename: "mock_{{ .InterfaceName | snakecase }}_test.go"
+mockname: "mock{{ .InterfaceName | camelcase }}"
+packages:
+  # managed
+  github.com/percona/pmm/managed/services/backup:
+    interfaces:
+      agentService:
+      compatibilityService:
+      jobsService:
+      pbmPITRService:
+      removalService:
+      Storage:
+        config:
+          mockname: "Mock{{ .InterfaceName | camelcase }}"
+      versioner:
+  github.com/percona/pmm/managed/services/checks:
+    interfaces:
+      agentsRegistry:
+  github.com/percona/pmm/managed/services/grafana:
+    interfaces:
+      awsInstanceChecker:
+  github.com/percona/pmm/managed/services/inventory:
+    interfaces:
+      agentService:
+      agentsRegistry:
+      agentsStateUpdater:
+      connectionChecker:
+      inventoryMetrics:
+      prometheusService:
+      serviceInfoBroker:
+      versionCache:
+  github.com/percona/pmm/managed/services/management:
+    interfaces:
+      agentsRegistry:
+      agentsStateUpdater:
+      apiKeyProvider:
+      checksService:
+      connectionChecker:
+      grafanaClient:
+      jobsService:
+      prometheusService:
+      serviceInfoBroker:
+      versionCache:
+      victoriaMetricsClient:
+  github.com/percona/pmm/managed/services/management/alerting:
+    interfaces:
+      grafanaClient:
+  github.com/percona/pmm/managed/services/management/backup:
+    interfaces:
+      awsS3:
+      backupService:
+      scheduleService:
+      removalService:
+      pbmPITRService:
+  github.com/percona/pmm/managed/services/qan:
+    interfaces:
+      qanCollectorClient:
+  github.com/percona/pmm/managed/services/scheduler:
+    interfaces:
+      backupService:
+  github.com/percona/pmm/managed/services/server:
+    interfaces:
+      agentsStateUpdater:
+      alertmanagerService:
+      checksService:
+      emailer:
+      grafanaClient:
+      prometheusService:
+      rulesService:
+      supervisordService:
+      telemetryService:
+      templatesService:
+      vmAlertExternalRules:
+  github.com/percona/pmm/managed/services/versioncache:
+    interfaces:
+      Versioner:
+        config:
+          mockname: "Mock{{ .InterfaceName | camelcase }}"
+  github.com/percona/pmm/managed/services/telemetry:
+    interfaces:
+      DataSource:
+      DataSourceLocator:
+      distributionUtilService:
+      sender:
+  # admin
+  github.com/percona/pmm/admin/commands/pmm/server/docker:
+    interfaces:
+      Functions:
+        config:
+          mockname: "Mock{{ .InterfaceName | camelcase }}"
+  # agent
+  github.com/percona/pmm/agent/agentlocal:
+    interfaces:
+      client:
+      supervisor:
+  github.com/percona/pmm/agent/client:
+    interfaces:
+      connectionChecker:
+      serviceInfoBroker:
+      supervisor:
+  github.com/percona/pmm/agent/versioner:
+    interfaces:
+      ExecFunctions:
+        config:
+          mockname: "Mock{{ .InterfaceName | camelcase }}"

Makefile.include

@@ -33,10 +33,16 @@ gen: clean            ## Generate files
 	make -C admin gen
 	make -C managed gen
 
+	make gen-mocks      ## Generate mocks
+
 	make format
 	make format ## TODO: One formatting run is not enough, figure out why.
 	go install -v ./...
 
+gen-mocks:
+	find . -name mock_*.go -delete
+	./bin/mockery --config .mockery.yaml
+
 gen-api:            ## Generate PMM API
 	# generated by descriptors target
 	bin/buf breaking --against descriptor.bin api

admin/Makefile

@@ -29,7 +29,6 @@ gen: clean                      ## Generate files
 
 clean:                          ## Remove generated files
 	find . -name *_reform.go -delete
-	find . -name mock_*.go -delete
 
 release:                        ## Build pmm-admin release binary
 	env CGO_ENABLED=0 go build -v $(LD_FLAGS) -o $(PMM_RELEASE_PATH)/pmm-admin ./cmd/pmm-admin/

admin/commands/pmm/server/docker/deps.go

@@ -27,8 +27,6 @@ import (
 	"github.com/percona/pmm/admin/pkg/docker"
 )
 
-//go:generate ../../../../../bin/mockery --name=Functions --case=snake --inpackage --testonly
-
 // Functions contain methods required to interact with Docker.
 type Functions interface { //nolint:interfacebloat
 	Imager

agent/Makefile

@@ -38,7 +38,6 @@ gen: clean                      ## Generate files
 
 clean:                          ## Remove generated files
 	find . -name *_reform.go -delete
-	find . -name mock_*.go -delete
 
 # generate stub models for perfschema QAN agent; hidden from help as it is not generally useful
 gen-init:

agent/agentlocal/deps.go

@@ -23,9 +23,6 @@ import (
 	"github.com/percona/pmm/api/agentpb"
 )
 
-//go:generate ../../bin/mockery --name=client --case=snake --inpackage --testonly
-//go:generate ../../bin/mockery --name=supervisor --case=snake --inpackage --testonly
-
 // client is a subset of methods of client.Client used by this package.
 // We use it instead of real type for testing and to avoid dependency cycle.
 type client interface {

agent/client/deps.go

@@ -23,10 +23,6 @@ import (
 	"github.com/percona/pmm/api/agentpb"
 )
 
-//go:generate ../../bin/mockery --name=connectionChecker --case=snake --inpackage --testonly
-//go:generate ../../bin/mockery --name=serviceInfoBroker --case=snake --inpackage --testonly
-//go:generate ../../bin/mockery --name=supervisor --case=snake --inpackage --testonly
-
 // connectionChecker is a subset of methods of connectionchecker.ConnectionChecker used by this package.
 // We use it instead of real type for testing and to avoid dependency cycle.
 type connectionChecker interface {

agent/versioner/versioner.go

@@ -51,8 +51,6 @@ type CombinedOutputer interface {
 	CombinedOutput() ([]byte, error)
 }
 
-//go:generate ../../bin/mockery --name=ExecFunctions --case=snake --inpackage --testonly
-
 // ExecFunctions is an interface for the LookPath() and CommandContext() functions.
 type ExecFunctions interface {
 	LookPath(file string) (string, error)

managed/Makefile

@@ -27,7 +27,6 @@ gen: clean                      ## Generate files
 
 clean:                          ## Remove generated files
 	find . -name *_reform.go -delete
-	find . -name mock_*.go -delete
 
 release:                        ## Build pmm-managed release binaries
 	env CGO_ENABLED=0 go build -v $(PMM_LD_FLAGS) -o $(PMM_RELEASE_PATH)/ ./cmd/...

managed/services/backup/deps.go

@@ -24,14 +24,6 @@ import (
 	"github.com/percona/pmm/managed/services/minio"
 )
 
-//go:generate ../../../bin/mockery --name=jobsService --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=agentService --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=versioner --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=compatibilityService --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=pbmPITRService --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=Storage --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=removalService --case=snake --inpackage --testonly
-
 // jobsService is a subset of methods of agents.JobsService used by this package.
 // We use it instead of real type for testing and to avoid dependency cycle.
 type jobsService interface {

managed/services/checks/deps.go

@@ -21,8 +21,6 @@ import (
 	"github.com/percona/pmm/managed/models"
 )
 
-//go:generate ../../../bin/mockery --name=agentsRegistry --case=snake --inpackage --testonly
-
 // agentsRegistry is a subset of methods of agents.Registry used by this package.
 // We use it instead of real type for testing and to avoid dependency cycle.
 type agentsRegistry interface {

managed/services/grafana/deps.go

@@ -15,8 +15,6 @@
 
 package grafana
 
-//go:generate ../../../bin/mockery --name=awsInstanceChecker --case=snake --inpackage --testonly
-
 // checker is a subset of methods of server.AWSInstanceChecker used by this package.
 // We use it instead of real type for testing and to avoid dependency cycle.
 type awsInstanceChecker interface {

managed/services/inventory/deps.go

@@ -23,15 +23,6 @@ import (
 	"github.com/percona/pmm/managed/models"
 )
 
-//go:generate ../../../bin/mockery --name=agentsRegistry --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=agentService --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=agentsStateUpdater --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=prometheusService --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=connectionChecker --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=serviceInfoBroker --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=versionCache --case=snake --inpackage --testonly
-//go:generate ../../../bin/mockery --name=inventoryMetrics --case=snake --inpackage --testonly
-
 // agentsRegistry is a subset of methods of agents.Registry used by this package.
 // We use it instead of real type for testing and to avoid dependency cycle.
 type agentsRegistry interface {

managed/services/management/alerting/deps.go

@@ -23,8 +23,6 @@ import (
 	"github.com/percona/pmm/managed/services"
 )
 
-//go:generate ../../../../bin/mockery --name=grafanaClient --case=snake --inpackage --testonly
-
 type grafanaClient interface {
 	CreateAlertRule(ctx context.Context, folderName, groupName string, rule *services.Rule) error
 	GetDatasourceUIDByID(ctx context.Context, id int64) (string, error)