Additional refactoring around 'Tool' interface

openshift / backplane-tools

Manages the tools needed to interact with clusters

Apache License 2.0

4 stars 28 forks source link

Additional refactoring around 'Tool' interface #43

Closed tnierman closed 10 months ago

tnierman commented 10 months ago

Reformats and simplifies logic around the Tool interface:

Moves the Tool interface from pkg/tools/base/tool.go to pkg/tool/tools.go. Keeping the definition at the root of the tools package, where the various implementations are defined, makes the definition easier to find and reduces the number of imports needed to utilize the toolMap
Renames the methods Tool.GetName() to Tool.Name() and Tool.GetExecutableName() to Tool.ExecutableName() to conform to the Golang standard.
Adds various helper comments to pkg/tools/default
Introduces constructors for the Default Tool implementation, which allows us to simplify the logic around the executableName in several methods.

openshift-ci[bot] commented 10 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tnierman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/openshift/backplane-tools/blob/main/OWNERS)~~ [tnierman] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

tnierman commented 10 months ago

/retest

openshift-ci[bot] commented 10 months ago

@tnierman: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository. I understand the commands that are listed [here](https://go.k8s.io/bot-commands).