From 5bce801a095cd9e8d07458138cb3c6210e7e5726 Mon Sep 17 00:00:00 2001
From: Julien Pivotto <roidelapluie@inuits.eu>
Date: Tue, 13 Apr 2021 09:33:54 +0200
Subject: [PATCH] Rename discovery/dockerswarm to discovery/moby (#8691)

This makes it clear that the dockerswarm package does more than docker
swarm, but does also docker.

I have picked moby as it is the upstream name: https://mobyproject.org/

There is no user-facing change, except in the case of a bad
configuration. Previously, a user who would have a bad docker sd config
would see an error like:

> field xx not found in type dockerswarm.plain

Now that error would be turned into:

> field xx not found in type moby.plain

While not perfect, it should at not be confusing between docker and
dockerswarm.

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
---
 config/config_test.go                         | 10 +++----
 discovery/install/install.go                  |  2 +-
 discovery/{dockerswarm => moby}/docker.go     |  2 +-
 .../{dockerswarm => moby}/docker_test.go      |  2 +-
 .../{dockerswarm => moby}/dockerswarm.go      | 26 +++++++++----------
 discovery/{dockerswarm => moby}/mock_test.go  |  2 +-
 discovery/{dockerswarm => moby}/network.go    |  2 +-
 discovery/{dockerswarm => moby}/nodes.go      |  2 +-
 discovery/{dockerswarm => moby}/nodes_test.go |  4 +--
 discovery/{dockerswarm => moby}/services.go   |  2 +-
 .../{dockerswarm => moby}/services_test.go    |  6 ++---
 discovery/{dockerswarm => moby}/tasks.go      |  2 +-
 discovery/{dockerswarm => moby}/tasks_test.go |  4 +--
 .../testdata/dockerprom/_ping.json            |  0
 .../dockerprom/containers/json_limit_0.json   |  0
 .../testdata/dockerprom/headers.yml           |  0
 .../testdata/dockerprom/networks.json         |  0
 .../testdata/swarmprom/_ping.json             |  0
 .../testdata/swarmprom/headers.yml            |  0
 .../testdata/swarmprom/networks.json          |  0
 .../testdata/swarmprom/nodes.json             |  0
 .../testdata/swarmprom/services.json          |  0
 .../swarmprom/services.json__wvKVCQ4HhD       |  0
 .../testdata/swarmprom/tasks.json             |  0
 24 files changed, 33 insertions(+), 33 deletions(-)
 rename discovery/{dockerswarm => moby}/docker.go (99%)
 rename discovery/{dockerswarm => moby}/docker_test.go (99%)
 rename discovery/{dockerswarm => moby}/dockerswarm.go (85%)
 rename discovery/{dockerswarm => moby}/mock_test.go (99%)
 rename discovery/{dockerswarm => moby}/network.go (99%)
 rename discovery/{dockerswarm => moby}/nodes.go (99%)
 rename discovery/{dockerswarm => moby}/nodes_test.go (99%)
 rename discovery/{dockerswarm => moby}/services.go (99%)
 rename discovery/{dockerswarm => moby}/services_test.go (99%)
 rename discovery/{dockerswarm => moby}/tasks.go (99%)
 rename discovery/{dockerswarm => moby}/tasks_test.go (99%)
 rename discovery/{dockerswarm => moby}/testdata/dockerprom/_ping.json (100%)
 rename discovery/{dockerswarm => moby}/testdata/dockerprom/containers/json_limit_0.json (100%)
 rename discovery/{dockerswarm => moby}/testdata/dockerprom/headers.yml (100%)
 rename discovery/{dockerswarm => moby}/testdata/dockerprom/networks.json (100%)
 rename discovery/{dockerswarm => moby}/testdata/swarmprom/_ping.json (100%)
 rename discovery/{dockerswarm => moby}/testdata/swarmprom/headers.yml (100%)
 rename discovery/{dockerswarm => moby}/testdata/swarmprom/networks.json (100%)
 rename discovery/{dockerswarm => moby}/testdata/swarmprom/nodes.json (100%)
 rename discovery/{dockerswarm => moby}/testdata/swarmprom/services.json (100%)
 rename discovery/{dockerswarm => moby}/testdata/swarmprom/services.json__wvKVCQ4HhD (100%)
 rename discovery/{dockerswarm => moby}/testdata/swarmprom/tasks.json (100%)

diff --git a/config/config_test.go b/config/config_test.go
index 8684ad72f6..330f6f5a44 100644
--- a/config/config_test.go
+++ b/config/config_test.go
@@ -34,13 +34,13 @@ import (
 	"github.com/prometheus/prometheus/discovery/consul"
 	"github.com/prometheus/prometheus/discovery/digitalocean"
 	"github.com/prometheus/prometheus/discovery/dns"
-	"github.com/prometheus/prometheus/discovery/dockerswarm"
 	"github.com/prometheus/prometheus/discovery/ec2"
 	"github.com/prometheus/prometheus/discovery/eureka"
 	"github.com/prometheus/prometheus/discovery/file"
 	"github.com/prometheus/prometheus/discovery/hetzner"
 	"github.com/prometheus/prometheus/discovery/kubernetes"
 	"github.com/prometheus/prometheus/discovery/marathon"
+	"github.com/prometheus/prometheus/discovery/moby"
 	"github.com/prometheus/prometheus/discovery/openstack"
 	"github.com/prometheus/prometheus/discovery/scaleway"
 	"github.com/prometheus/prometheus/discovery/targetgroup"
@@ -658,8 +658,8 @@ var expectedConf = &Config{
 			HTTPClientConfig: config.DefaultHTTPClientConfig,
 
 			ServiceDiscoveryConfigs: discovery.Configs{
-				&dockerswarm.DockerSDConfig{
-					Filters:          []dockerswarm.Filter{},
+				&moby.DockerSDConfig{
+					Filters:          []moby.Filter{},
 					Host:             "unix:///var/run/docker.sock",
 					Port:             80,
 					RefreshInterval:  model.Duration(60 * time.Second),
@@ -679,8 +679,8 @@ var expectedConf = &Config{
 			HTTPClientConfig: config.DefaultHTTPClientConfig,
 
 			ServiceDiscoveryConfigs: discovery.Configs{
-				&dockerswarm.SDConfig{
-					Filters:          []dockerswarm.Filter{},
+				&moby.DockerSwarmSDConfig{
+					Filters:          []moby.Filter{},
 					Host:             "http://127.0.0.1:2375",
 					Role:             "nodes",
 					Port:             80,
diff --git a/discovery/install/install.go b/discovery/install/install.go
index 075a302e4a..d6f69d0d66 100644
--- a/discovery/install/install.go
+++ b/discovery/install/install.go
@@ -20,7 +20,6 @@ import (
 	_ "github.com/prometheus/prometheus/discovery/consul"       // register consul
 	_ "github.com/prometheus/prometheus/discovery/digitalocean" // register digitalocean
 	_ "github.com/prometheus/prometheus/discovery/dns"          // register dns
-	_ "github.com/prometheus/prometheus/discovery/dockerswarm"  // register dockerswarm
 	_ "github.com/prometheus/prometheus/discovery/ec2"          // register ec2
 	_ "github.com/prometheus/prometheus/discovery/eureka"       // register eureka
 	_ "github.com/prometheus/prometheus/discovery/file"         // register file
@@ -28,6 +27,7 @@ import (
 	_ "github.com/prometheus/prometheus/discovery/hetzner"      // register hetzner
 	_ "github.com/prometheus/prometheus/discovery/kubernetes"   // register kubernetes
 	_ "github.com/prometheus/prometheus/discovery/marathon"     // register marathon
+	_ "github.com/prometheus/prometheus/discovery/moby"         // register moby
 	_ "github.com/prometheus/prometheus/discovery/openstack"    // register openstack
 	_ "github.com/prometheus/prometheus/discovery/scaleway"     // register scaleway
 	_ "github.com/prometheus/prometheus/discovery/triton"       // register triton
diff --git a/discovery/dockerswarm/docker.go b/discovery/moby/docker.go
similarity index 99%
rename from discovery/dockerswarm/docker.go
rename to discovery/moby/docker.go
index 04d0b28693..c4da25d122 100644
--- a/discovery/dockerswarm/docker.go
+++ b/discovery/moby/docker.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
diff --git a/discovery/dockerswarm/docker_test.go b/discovery/moby/docker_test.go
similarity index 99%
rename from discovery/dockerswarm/docker_test.go
rename to discovery/moby/docker_test.go
index 9731a62ee9..5cc96f3fea 100644
--- a/discovery/dockerswarm/docker_test.go
+++ b/discovery/moby/docker_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
diff --git a/discovery/dockerswarm/dockerswarm.go b/discovery/moby/dockerswarm.go
similarity index 85%
rename from discovery/dockerswarm/dockerswarm.go
rename to discovery/moby/dockerswarm.go
index c9cf1d115a..2381d763ea 100644
--- a/discovery/dockerswarm/dockerswarm.go
+++ b/discovery/moby/dockerswarm.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
@@ -38,8 +38,8 @@ const (
 
 var userAgent = fmt.Sprintf("Prometheus/%s", version.Version)
 
-// DefaultSDConfig is the default Docker Swarm SD configuration.
-var DefaultSDConfig = SDConfig{
+// DefaultDockerSwarmSDConfig is the default Docker Swarm SD configuration.
+var DefaultDockerSwarmSDConfig = DockerSwarmSDConfig{
 	RefreshInterval:  model.Duration(60 * time.Second),
 	Port:             80,
 	Filters:          []Filter{},
@@ -47,11 +47,11 @@ var DefaultSDConfig = SDConfig{
 }
 
 func init() {
-	discovery.RegisterConfig(&SDConfig{})
+	discovery.RegisterConfig(&DockerSwarmSDConfig{})
 }
 
-// SDConfig is the configuration for Docker Swarm based service discovery.
-type SDConfig struct {
+// DockerSwarmSDConfig is the configuration for Docker Swarm based service discovery.
+type DockerSwarmSDConfig struct {
 	HTTPClientConfig config.HTTPClientConfig `yaml:",inline"`
 
 	Host    string   `yaml:"host"`
@@ -70,22 +70,22 @@ type Filter struct {
 }
 
 // Name returns the name of the Config.
-func (*SDConfig) Name() string { return "dockerswarm" }
+func (*DockerSwarmSDConfig) Name() string { return "dockerswarm" }
 
 // NewDiscoverer returns a Discoverer for the Config.
-func (c *SDConfig) NewDiscoverer(opts discovery.DiscovererOptions) (discovery.Discoverer, error) {
+func (c *DockerSwarmSDConfig) NewDiscoverer(opts discovery.DiscovererOptions) (discovery.Discoverer, error) {
 	return NewDiscovery(c, opts.Logger)
 }
 
 // SetDirectory joins any relative file paths with dir.
-func (c *SDConfig) SetDirectory(dir string) {
+func (c *DockerSwarmSDConfig) SetDirectory(dir string) {
 	c.HTTPClientConfig.SetDirectory(dir)
 }
 
 // UnmarshalYAML implements the yaml.Unmarshaler interface.
-func (c *SDConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
-	*c = DefaultSDConfig
-	type plain SDConfig
+func (c *DockerSwarmSDConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	*c = DefaultDockerSwarmSDConfig
+	type plain DockerSwarmSDConfig
 	err := unmarshal((*plain)(c))
 	if err != nil {
 		return err
@@ -117,7 +117,7 @@ type Discovery struct {
 }
 
 // NewDiscovery returns a new Discovery which periodically refreshes its targets.
-func NewDiscovery(conf *SDConfig, logger log.Logger) (*Discovery, error) {
+func NewDiscovery(conf *DockerSwarmSDConfig, logger log.Logger) (*Discovery, error) {
 	var err error
 
 	d := &Discovery{
diff --git a/discovery/dockerswarm/mock_test.go b/discovery/moby/mock_test.go
similarity index 99%
rename from discovery/dockerswarm/mock_test.go
rename to discovery/moby/mock_test.go
index 74d4853ae8..3006ca5c28 100644
--- a/discovery/dockerswarm/mock_test.go
+++ b/discovery/moby/mock_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"crypto/sha1"
diff --git a/discovery/dockerswarm/network.go b/discovery/moby/network.go
similarity index 99%
rename from discovery/dockerswarm/network.go
rename to discovery/moby/network.go
index 1294a3d378..3982e57776 100644
--- a/discovery/dockerswarm/network.go
+++ b/discovery/moby/network.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
diff --git a/discovery/dockerswarm/nodes.go b/discovery/moby/nodes.go
similarity index 99%
rename from discovery/dockerswarm/nodes.go
rename to discovery/moby/nodes.go
index 79727a9499..85092f9071 100644
--- a/discovery/dockerswarm/nodes.go
+++ b/discovery/moby/nodes.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
diff --git a/discovery/dockerswarm/nodes_test.go b/discovery/moby/nodes_test.go
similarity index 99%
rename from discovery/dockerswarm/nodes_test.go
rename to discovery/moby/nodes_test.go
index df36ad274c..374c8462c1 100644
--- a/discovery/dockerswarm/nodes_test.go
+++ b/discovery/moby/nodes_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
@@ -35,7 +35,7 @@ func TestDockerSwarmNodesSDRefresh(t *testing.T) {
 role: nodes
 host: %s
 `, url)
-	var cfg SDConfig
+	var cfg DockerSwarmSDConfig
 	require.NoError(t, yaml.Unmarshal([]byte(cfgString), &cfg))
 
 	d, err := NewDiscovery(&cfg, log.NewNopLogger())
diff --git a/discovery/dockerswarm/services.go b/discovery/moby/services.go
similarity index 99%
rename from discovery/dockerswarm/services.go
rename to discovery/moby/services.go
index 915dc58b62..1d472b5c00 100644
--- a/discovery/dockerswarm/services.go
+++ b/discovery/moby/services.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
diff --git a/discovery/dockerswarm/services_test.go b/discovery/moby/services_test.go
similarity index 99%
rename from discovery/dockerswarm/services_test.go
rename to discovery/moby/services_test.go
index bee41848e4..01b35e01e4 100644
--- a/discovery/dockerswarm/services_test.go
+++ b/discovery/moby/services_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
@@ -35,7 +35,7 @@ func TestDockerSwarmSDServicesRefresh(t *testing.T) {
 role: services
 host: %s
 `, url)
-	var cfg SDConfig
+	var cfg DockerSwarmSDConfig
 	require.NoError(t, yaml.Unmarshal([]byte(cfgString), &cfg))
 
 	d, err := NewDiscovery(&cfg, log.NewNopLogger())
@@ -329,7 +329,7 @@ filters:
 - name: name
   values: ["mon_node-exporter", "mon_grafana"]
 `, url)
-	var cfg SDConfig
+	var cfg DockerSwarmSDConfig
 	require.NoError(t, yaml.Unmarshal([]byte(cfgString), &cfg))
 
 	d, err := NewDiscovery(&cfg, log.NewNopLogger())
diff --git a/discovery/dockerswarm/tasks.go b/discovery/moby/tasks.go
similarity index 99%
rename from discovery/dockerswarm/tasks.go
rename to discovery/moby/tasks.go
index befce8fa38..002f536d00 100644
--- a/discovery/dockerswarm/tasks.go
+++ b/discovery/moby/tasks.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
diff --git a/discovery/dockerswarm/tasks_test.go b/discovery/moby/tasks_test.go
similarity index 99%
rename from discovery/dockerswarm/tasks_test.go
rename to discovery/moby/tasks_test.go
index 49429836eb..f2c2a5c349 100644
--- a/discovery/dockerswarm/tasks_test.go
+++ b/discovery/moby/tasks_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package dockerswarm
+package moby
 
 import (
 	"context"
@@ -35,7 +35,7 @@ func TestDockerSwarmTasksSDRefresh(t *testing.T) {
 role: tasks
 host: %s
 `, url)
-	var cfg SDConfig
+	var cfg DockerSwarmSDConfig
 	require.NoError(t, yaml.Unmarshal([]byte(cfgString), &cfg))
 
 	d, err := NewDiscovery(&cfg, log.NewNopLogger())
diff --git a/discovery/dockerswarm/testdata/dockerprom/_ping.json b/discovery/moby/testdata/dockerprom/_ping.json
similarity index 100%
rename from discovery/dockerswarm/testdata/dockerprom/_ping.json
rename to discovery/moby/testdata/dockerprom/_ping.json
diff --git a/discovery/dockerswarm/testdata/dockerprom/containers/json_limit_0.json b/discovery/moby/testdata/dockerprom/containers/json_limit_0.json
similarity index 100%
rename from discovery/dockerswarm/testdata/dockerprom/containers/json_limit_0.json
rename to discovery/moby/testdata/dockerprom/containers/json_limit_0.json
diff --git a/discovery/dockerswarm/testdata/dockerprom/headers.yml b/discovery/moby/testdata/dockerprom/headers.yml
similarity index 100%
rename from discovery/dockerswarm/testdata/dockerprom/headers.yml
rename to discovery/moby/testdata/dockerprom/headers.yml
diff --git a/discovery/dockerswarm/testdata/dockerprom/networks.json b/discovery/moby/testdata/dockerprom/networks.json
similarity index 100%
rename from discovery/dockerswarm/testdata/dockerprom/networks.json
rename to discovery/moby/testdata/dockerprom/networks.json
diff --git a/discovery/dockerswarm/testdata/swarmprom/_ping.json b/discovery/moby/testdata/swarmprom/_ping.json
similarity index 100%
rename from discovery/dockerswarm/testdata/swarmprom/_ping.json
rename to discovery/moby/testdata/swarmprom/_ping.json
diff --git a/discovery/dockerswarm/testdata/swarmprom/headers.yml b/discovery/moby/testdata/swarmprom/headers.yml
similarity index 100%
rename from discovery/dockerswarm/testdata/swarmprom/headers.yml
rename to discovery/moby/testdata/swarmprom/headers.yml
diff --git a/discovery/dockerswarm/testdata/swarmprom/networks.json b/discovery/moby/testdata/swarmprom/networks.json
similarity index 100%
rename from discovery/dockerswarm/testdata/swarmprom/networks.json
rename to discovery/moby/testdata/swarmprom/networks.json
diff --git a/discovery/dockerswarm/testdata/swarmprom/nodes.json b/discovery/moby/testdata/swarmprom/nodes.json
similarity index 100%
rename from discovery/dockerswarm/testdata/swarmprom/nodes.json
rename to discovery/moby/testdata/swarmprom/nodes.json
diff --git a/discovery/dockerswarm/testdata/swarmprom/services.json b/discovery/moby/testdata/swarmprom/services.json
similarity index 100%
rename from discovery/dockerswarm/testdata/swarmprom/services.json
rename to discovery/moby/testdata/swarmprom/services.json
diff --git a/discovery/dockerswarm/testdata/swarmprom/services.json__wvKVCQ4HhD b/discovery/moby/testdata/swarmprom/services.json__wvKVCQ4HhD
similarity index 100%
rename from discovery/dockerswarm/testdata/swarmprom/services.json__wvKVCQ4HhD
rename to discovery/moby/testdata/swarmprom/services.json__wvKVCQ4HhD
diff --git a/discovery/dockerswarm/testdata/swarmprom/tasks.json b/discovery/moby/testdata/swarmprom/tasks.json
similarity index 100%
rename from discovery/dockerswarm/testdata/swarmprom/tasks.json
rename to discovery/moby/testdata/swarmprom/tasks.json