Skip to content

Commit e274e11

Browse files
thaJeztahthaJeztah
committed
container/(docker|podman) use more generic names
use more generic names to start aligning the implementations for easier maintenance. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent 86dae15 commit e274e11

File tree

4 files changed

+59
-59
lines changed

4 files changed

+59
-59
lines changed

‎container/docker/factory.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ func (f *dockerFactory) NewContainerHandler(name string, metadataEnvAllowList []
147147
dockerMetadataEnvAllowList = metadataEnvAllowList
148148
}
149149

150-
handler, err = newDockerContainerHandler(
150+
handler, err = newContainerHandler(
151151
client,
152152
f.containerdClient,
153153
name,

‎container/docker/handler.go‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ const (
5151
pathToContainersDir = "containers"
5252
)
5353

54-
type dockerContainerHandler struct {
54+
type containerHandler struct {
5555
// machineInfoFactory provides info.MachineInfo
5656
machineInfoFactory info.MachineInfoFactory
5757

@@ -97,7 +97,7 @@ type dockerContainerHandler struct {
9797
client docker.APIClient
9898
}
9999

100-
var _ container.ContainerHandler = &dockerContainerHandler{}
100+
var _ container.ContainerHandler = &containerHandler{}
101101

102102
func getRwLayerID(containerID, storageDir string, sd StorageDriver, dockerVersion []int) (string, error) {
103103
const (
@@ -116,8 +116,8 @@ func getRwLayerID(containerID, storageDir string, sd StorageDriver, dockerVersio
116116
return string(bytes), err
117117
}
118118

119-
// newDockerContainerHandler returns a new container.ContainerHandler
120-
func newDockerContainerHandler(
119+
// newContainerHandler returns a new container.ContainerHandler
120+
func newContainerHandler(
121121
client *dclient.Client,
122122
containerdClient containerd.ContainerdClient,
123123
name string,
@@ -192,7 +192,7 @@ func newDockerContainerHandler(
192192
metrics := common.RemoveNetMetrics(includedMetrics, ctnr.HostConfig.NetworkMode.IsContainer())
193193

194194
// TODO: extract object mother method
195-
handler := &dockerContainerHandler{
195+
handler := &containerHandler{
196196
machineInfoFactory: machineInfoFactory,
197197
cgroupPaths: cgroupPaths,
198198
fsInfo: fsInfo,
@@ -295,23 +295,23 @@ func DetermineDeviceStorage(storageDriver StorageDriver, storageDir string, rwLa
295295
return
296296
}
297297

298-
func (h *dockerContainerHandler) Start() {
298+
func (h *containerHandler) Start() {
299299
if h.fsHandler != nil {
300300
h.fsHandler.Start()
301301
}
302302
}
303303

304-
func (h *dockerContainerHandler) Cleanup() {
304+
func (h *containerHandler) Cleanup() {
305305
if h.fsHandler != nil {
306306
h.fsHandler.Stop()
307307
}
308308
}
309309

310-
func (h *dockerContainerHandler) ContainerReference() (info.ContainerReference, error) {
310+
func (h *containerHandler) ContainerReference() (info.ContainerReference, error) {
311311
return h.reference, nil
312312
}
313313

314-
func (h *dockerContainerHandler) GetSpec() (info.ContainerSpec, error) {
314+
func (h *containerHandler) GetSpec() (info.ContainerSpec, error) {
315315
hasFilesystem := h.includedMetrics.Has(container.DiskUsageMetrics)
316316
hasNetwork := h.includedMetrics.Has(container.NetworkUsageMetrics)
317317
spec, err := common.GetSpec(h.cgroupPaths, h.machineInfoFactory, hasNetwork, hasFilesystem)
@@ -327,7 +327,7 @@ func (h *dockerContainerHandler) GetSpec() (info.ContainerSpec, error) {
327327
return spec, nil
328328
}
329329

330-
func (h *dockerContainerHandler) GetStats() (*info.ContainerStats, error) {
330+
func (h *containerHandler) GetStats() (*info.ContainerStats, error) {
331331
// TODO(vmarmol): Get from libcontainer API instead of cgroup manager when we don't have to support older Dockers.
332332
stats, err := h.libcontainerHandler.GetStats()
333333
if err != nil {
@@ -354,12 +354,12 @@ func (h *dockerContainerHandler) GetStats() (*info.ContainerStats, error) {
354354
return stats, nil
355355
}
356356

357-
func (h *dockerContainerHandler) ListContainers(listType container.ListType) ([]info.ContainerReference, error) {
357+
func (h *containerHandler) ListContainers(listType container.ListType) ([]info.ContainerReference, error) {
358358
// No-op for Docker driver.
359359
return []info.ContainerReference{}, nil
360360
}
361361

362-
func (h *dockerContainerHandler) GetCgroupPath(resource string) (string, error) {
362+
func (h *containerHandler) GetCgroupPath(resource string) (string, error) {
363363
var res string
364364
if !cgroups.IsCgroup2UnifiedMode() {
365365
res = resource
@@ -371,22 +371,22 @@ func (h *dockerContainerHandler) GetCgroupPath(resource string) (string, error)
371371
return path, nil
372372
}
373373

374-
func (h *dockerContainerHandler) GetContainerLabels() map[string]string {
374+
func (h *containerHandler) GetContainerLabels() map[string]string {
375375
return h.labels
376376
}
377377

378-
func (h *dockerContainerHandler) GetContainerIPAddress() string {
378+
func (h *containerHandler) GetContainerIPAddress() string {
379379
return h.ipAddress
380380
}
381381

382-
func (h *dockerContainerHandler) ListProcesses(listType container.ListType) ([]int, error) {
382+
func (h *containerHandler) ListProcesses(listType container.ListType) ([]int, error) {
383383
return h.libcontainerHandler.GetProcesses()
384384
}
385385

386-
func (h *dockerContainerHandler) Exists() bool {
386+
func (h *containerHandler) Exists() bool {
387387
return common.CgroupExists(h.cgroupPaths)
388388
}
389389

390-
func (h *dockerContainerHandler) Type() container.ContainerType {
390+
func (h *containerHandler) Type() container.ContainerType {
391391
return container.ContainerTypeDocker
392392
}

‎container/podman/factory.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ func (f *podmanFactory) String() string {
109109
}
110110

111111
func (f *podmanFactory) NewContainerHandler(name string, metadataEnvAllowList []string, inHostNamespace bool) (handler container.ContainerHandler, err error) {
112-
return newPodmanContainerHandler(name, f.machineInfoFactory, f.fsInfo,
112+
return newContainerHandler(name, f.machineInfoFactory, f.fsInfo,
113113
f.storageDriver, f.storageDir, f.cgroupSubsystem, inHostNamespace,
114114
metadataEnvAllowList, f.metrics, f.thinPoolName, f.thinPoolWatcher, f.zfsWatcher)
115115
}

‎container/podman/handler.go‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import (
3535
"github.com/google/cadvisor/zfs"
3636
)
3737

38-
type podmanContainerHandler struct {
38+
type containerHandler struct {
3939
// machineInfoFactory provides info.MachineInfo
4040
machineInfoFactory info.MachineInfoFactory
4141

@@ -72,7 +72,7 @@ type podmanContainerHandler struct {
7272
libcontainerHandler *containerlibcontainer.Handler
7373
}
7474

75-
func newPodmanContainerHandler(
75+
func newContainerHandler(
7676
name string,
7777
machineInfoFactory info.MachineInfoFactory,
7878
fsInfo fs.FsInfo,
@@ -125,7 +125,7 @@ func newPodmanContainerHandler(
125125

126126
otherStorageDir := filepath.Join(storageDir, string(storageDriver)+"-containers", id)
127127

128-
handler := &podmanContainerHandler{
128+
handler := &containerHandler{
129129
machineInfoFactory: machineInfoFactory,
130130
cgroupPaths: cgroupPaths,
131131
storageDriver: storageDriver,
@@ -212,98 +212,98 @@ func determineDeviceStorage(storageDriver docker.StorageDriver, storageDir strin
212212
}
213213
}
214214

215-
func (p podmanContainerHandler) ContainerReference() (info.ContainerReference, error) {
216-
return p.reference, nil
215+
func (h containerHandler) ContainerReference() (info.ContainerReference, error) {
216+
return h.reference, nil
217217
}
218218

219-
func (p podmanContainerHandler) needNet() bool {
220-
if p.metrics.Has(container.NetworkUsageMetrics) {
221-
p.networkMode.IsContainer()
222-
return !p.networkMode.IsContainer()
219+
func (h containerHandler) needNet() bool {
220+
if h.metrics.Has(container.NetworkUsageMetrics) {
221+
h.networkMode.IsContainer()
222+
return !h.networkMode.IsContainer()
223223
}
224224
return false
225225
}
226226

227-
func (p podmanContainerHandler) GetSpec() (info.ContainerSpec, error) {
228-
hasFilesystem := p.metrics.Has(container.DiskUsageMetrics)
227+
func (h containerHandler) GetSpec() (info.ContainerSpec, error) {
228+
hasFilesystem := h.metrics.Has(container.DiskUsageMetrics)
229229

230-
spec, err := common.GetSpec(p.cgroupPaths, p.machineInfoFactory, p.needNet(), hasFilesystem)
230+
spec, err := common.GetSpec(h.cgroupPaths, h.machineInfoFactory, h.needNet(), hasFilesystem)
231231
if err != nil {
232232
return info.ContainerSpec{}, err
233233
}
234234

235-
spec.Labels = p.labels
236-
spec.Envs = p.envs
237-
spec.Image = p.image
238-
spec.CreationTime = p.creationTime
235+
spec.Labels = h.labels
236+
spec.Envs = h.envs
237+
spec.Image = h.image
238+
spec.CreationTime = h.creationTime
239239

240240
return spec, nil
241241
}
242242

243-
func (p podmanContainerHandler) GetStats() (*info.ContainerStats, error) {
244-
stats, err := p.libcontainerHandler.GetStats()
243+
func (h containerHandler) GetStats() (*info.ContainerStats, error) {
244+
stats, err := h.libcontainerHandler.GetStats()
245245
if err != nil {
246246
return stats, err
247247
}
248248

249-
if !p.needNet() {
249+
if !h.needNet() {
250250
stats.Network = info.NetworkStats{}
251251
}
252252

253-
err = docker.FsStats(stats, p.machineInfoFactory, p.metrics, p.storageDriver,
254-
p.fsHandler, p.fsInfo, p.thinPoolName, p.rootfsStorageDir, p.zfsParent)
253+
err = docker.FsStats(stats, h.machineInfoFactory, h.metrics, h.storageDriver,
254+
h.fsHandler, h.fsInfo, h.thinPoolName, h.rootfsStorageDir, h.zfsParent)
255255
if err != nil {
256256
return stats, err
257257
}
258258

259259
return stats, nil
260260
}
261261

262-
func (p podmanContainerHandler) ListContainers(listType container.ListType) ([]info.ContainerReference, error) {
262+
func (h containerHandler) ListContainers(listType container.ListType) ([]info.ContainerReference, error) {
263263
return []info.ContainerReference{}, nil
264264
}
265265

266-
func (p podmanContainerHandler) ListProcesses(listType container.ListType) ([]int, error) {
267-
return p.libcontainerHandler.GetProcesses()
266+
func (h containerHandler) ListProcesses(listType container.ListType) ([]int, error) {
267+
return h.libcontainerHandler.GetProcesses()
268268
}
269269

270-
func (p podmanContainerHandler) GetCgroupPath(resource string) (string, error) {
270+
func (h containerHandler) GetCgroupPath(resource string) (string, error) {
271271
var res string
272272
if !cgroups.IsCgroup2UnifiedMode() {
273273
res = resource
274274
}
275-
path, ok := p.cgroupPaths[res]
275+
path, ok := h.cgroupPaths[res]
276276
if !ok {
277-
return "", fmt.Errorf("couldn't find path for resource %q for container %q", resource, p.reference.Name)
277+
return "", fmt.Errorf("couldn't find path for resource %q for container %q", resource, h.reference.Name)
278278
}
279279

280280
return path, nil
281281
}
282282

283-
func (p podmanContainerHandler) GetContainerLabels() map[string]string {
284-
return p.labels
283+
func (h containerHandler) GetContainerLabels() map[string]string {
284+
return h.labels
285285
}
286286

287-
func (p podmanContainerHandler) GetContainerIPAddress() string {
288-
return p.ipAddress
287+
func (h containerHandler) GetContainerIPAddress() string {
288+
return h.ipAddress
289289
}
290290

291-
func (p podmanContainerHandler) Exists() bool {
292-
return common.CgroupExists(p.cgroupPaths)
291+
func (h containerHandler) Exists() bool {
292+
return common.CgroupExists(h.cgroupPaths)
293293
}
294294

295-
func (p podmanContainerHandler) Cleanup() {
296-
if p.fsHandler != nil {
297-
p.fsHandler.Stop()
295+
func (h containerHandler) Cleanup() {
296+
if h.fsHandler != nil {
297+
h.fsHandler.Stop()
298298
}
299299
}
300300

301-
func (p podmanContainerHandler) Start() {
302-
if p.fsHandler != nil {
303-
p.fsHandler.Start()
301+
func (h containerHandler) Start() {
302+
if h.fsHandler != nil {
303+
h.fsHandler.Start()
304304
}
305305
}
306306

307-
func (p podmanContainerHandler) Type() container.ContainerType {
307+
func (h containerHandler) Type() container.ContainerType {
308308
return container.ContainerTypePodman
309309
}

0 commit comments

Comments
 (0)