Merge pull request #308 from jacobweinstock/fix-rufio-preferred-order

jacobweinstock · web-flow · commit 61d885340597 · 2025-03-28T09:42:54.000-06:00
Use PreferDriver instead of PreferProtocol:

## Description

&lt;!--- Please describe what this PR is going to change --&gt;
The API spec defines PreferredOrder to be the driver name not the protocol name. This causes the "gofish" provider to not change the order as that is the driver name not the protocol. The protocol is "redfish". Changing the implementation to use PreferDriver is chosen so as not to have to change the API spec validation.

## Why is this needed

&lt;!--- Link to issue you have raised --&gt;

Fixes: #

## How Has This Been Tested?
&lt;!--- Please describe in detail how you tested your changes. --&gt;
&lt;!--- Include details of your testing environment, and the tests you ran to --&gt;
&lt;!--- see how your change affects other areas of the code, etc. --&gt;


## How are existing users impacted? What migration steps/scripts do we need?

&lt;!--- Fixes a bug, unblocks installation, removes a component of the stack etc --&gt;
&lt;!--- Requires a DB migration script, etc. --&gt;


## Checklist:

I have:

- [ ] updated the documentation and/or roadmap (if required)
- [ ] added unit or e2e tests
- [ ] provided instructions on how to upgrade
diff --git a/controller/client.go b/controller/client.go
@@ -36,7 +36,7 @@ func NewClientFunc(timeout time.Duration) ClientFunc {
 		defer cancel()
 
 		if opts != nil && opts.ProviderOptions != nil && len(opts.PreferredOrder) > 0 {
-			client.Registry.Drivers = client.Registry.PreferProtocol(toStringSlice(opts.PreferredOrder)...)
+			client.Registry.Drivers = client.Registry.PreferDriver(toStringSlice(opts.PreferredOrder)...)
 		}
 		if err := client.Open(ctx); err != nil {
 			md := client.GetMetadata()
diff --git a/controller/helpers_test.go b/controller/helpers_test.go
@@ -58,7 +58,7 @@ func (t *testProvider) Protocol() string {
 	if t.Proto != "" {
 		return t.Proto
 	}
-	return "redfish"
+	return "gofish"
 }
 
 func (t *testProvider) Features() registrar.Features {

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func NewClientFunc(timeout time.Duration) ClientFunc {`
`36`	`36`	`defer cancel()`
`37`	`37`
`38`	`38`	`if opts != nil && opts.ProviderOptions != nil && len(opts.PreferredOrder) > 0 {`
`39`		`- client.Registry.Drivers = client.Registry.PreferProtocol(toStringSlice(opts.PreferredOrder)...)`
	`39`	`+ client.Registry.Drivers = client.Registry.PreferDriver(toStringSlice(opts.PreferredOrder)...)`
`40`	`40`	`}`
`41`	`41`	`if err := client.Open(ctx); err != nil {`
`42`	`42`	`md := client.GetMetadata()`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ func (t *testProvider) Protocol() string {`
`58`	`58`	`if t.Proto != "" {`
`59`	`59`	`return t.Proto`
`60`	`60`	`}`
`61`		`- return "redfish"`
	`61`	`+ return "gofish"`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`func (t *testProvider) Features() registrar.Features {`