FirmwareUpload interface to accept a *os.File instead

There has been no real use for having an io.Reader passed in
and this interface is to expect a file instead.

bmc/firmware.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"os"
 
 	"github.com/bmc-toolbox/bmclib/v2/constants"
 	bconsts "github.com/bmc-toolbox/bmclib/v2/constants"
@@ -314,7 +315,7 @@ func firmwareInstallSteps(ctx context.Context, component string, generic []firmw
 }
 
 type FirmwareUploader interface {
-	FirmwareUpload(ctx context.Context, component string, reader io.Reader) (uploadVerifyTaskID string, err error)
+	FirmwareUpload(ctx context.Context, component string, file *os.File) (uploadVerifyTaskID string, err error)
 }
 
 // firmwareUploaderProvider is an internal struct to correlate an implementation/provider and its name
@@ -324,7 +325,7 @@ type firmwareUploaderProvider struct {
 }
 
 // FirmwareUploaderFromInterfaces identifies implementations of the FirmwareUploader interface and passes the found implementations to the firmwareUpload() wrapper.
-func FirmwareUploadFromInterfaces(ctx context.Context, component string, reader io.Reader, generic []interface{}) (taskID string, metadata Metadata, err error) {
+func FirmwareUploadFromInterfaces(ctx context.Context, component string, file *os.File, generic []interface{}) (taskID string, metadata Metadata, err error) {
 	implementations := make([]firmwareUploaderProvider, 0)
 	for _, elem := range generic {
 		temp := firmwareUploaderProvider{name: getProviderName(elem)}
@@ -347,10 +348,10 @@ func FirmwareUploadFromInterfaces(ctx context.Context, component string, reader
 		)
 	}
 
-	return firmwareUpload(ctx, component, reader, implementations)
+	return firmwareUpload(ctx, component, file, implementations)
 }
 
-func firmwareUpload(ctx context.Context, component string, reader io.Reader, generic []firmwareUploaderProvider) (taskID string, metadata Metadata, err error) {
+func firmwareUpload(ctx context.Context, component string, file *os.File, generic []firmwareUploaderProvider) (taskID string, metadata Metadata, err error) {
 	var metadataLocal Metadata
 
 	for _, elem := range generic {
@@ -364,7 +365,7 @@ func firmwareUpload(ctx context.Context, component string, reader io.Reader, gen
 			return taskID, metadata, err
 		default:
 			metadataLocal.ProvidersAttempted = append(metadataLocal.ProvidersAttempted, elem.name)
-			taskID, vErr := elem.FirmwareUpload(ctx, component, reader)
+			taskID, vErr := elem.FirmwareUpload(ctx, component, file)
 			if vErr != nil {
 				err = multierror.Append(err, errors.WithMessagef(vErr, "provider: %v", elem.name))
 				err = multierror.Append(err, vErr)

bmc/firmware_test.go

@@ -3,6 +3,7 @@ package bmc
 import (
 	"context"
 	"io"
+	"os"
 	"testing"
 	"time"
 
@@ -304,7 +305,7 @@ type firmwareUploadTester struct {
 	returnError  error
 }
 
-func (f *firmwareUploadTester) FirmwareUpload(ctx context.Context, component string, reader io.Reader) (uploadVerifyTaskID string, err error) {
+func (f *firmwareUploadTester) FirmwareUpload(ctx context.Context, component string, file *os.File) (uploadVerifyTaskID string, err error) {
 	return f.returnTaskID, f.returnError
 }
 
@@ -316,7 +317,7 @@ func TestFirmwareUpload(t *testing.T) {
 	testCases := []struct {
 		testName           string
 		component          string
-		reader             io.Reader
+		file               *os.File
 		returnTaskID       string
 		returnError        error
 		ctxTimeout         time.Duration
@@ -336,7 +337,7 @@ func TestFirmwareUpload(t *testing.T) {
 			}
 			ctx, cancel := context.WithTimeout(context.Background(), tc.ctxTimeout)
 			defer cancel()
-			taskID, metadata, err := firmwareUpload(ctx, tc.component, tc.reader, []firmwareUploaderProvider{{tc.providerName, &testImplementation}})
+			taskID, metadata, err := firmwareUpload(ctx, tc.component, tc.file, []firmwareUploaderProvider{{tc.providerName, &testImplementation}})
 			if tc.returnError != nil {
 				assert.ErrorIs(t, err, tc.returnError)
 				return

client.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"os"
 	"sync"
 	"time"
 
@@ -479,8 +480,8 @@ func (c *Client) FirmwareInstallSteps(ctx context.Context, component string) (ac
 }
 
 // FirmwareUpload just uploads the firmware for install, it returns a task ID to verify the upload status.
-func (c *Client) FirmwareUpload(ctx context.Context, component string, reader io.Reader) (uploadVerifyTaskID string, err error) {
-	uploadVerifyTaskID, metadata, err := bmc.FirmwareUploadFromInterfaces(ctx, component, reader, c.Registry.GetDriverInterfaces())
+func (c *Client) FirmwareUpload(ctx context.Context, component string, file *os.File) (uploadVerifyTaskID string, err error) {
+	uploadVerifyTaskID, metadata, err := bmc.FirmwareUploadFromInterfaces(ctx, component, file, c.Registry.GetDriverInterfaces())
 	c.setMetadata(metadata)
 	return uploadVerifyTaskID, err
 }

internal/redfishwrapper/firmware.go

@@ -41,13 +41,7 @@ type RedfishUpdateServiceParameters struct {
 }
 
 // FirmwareUpload uploads and initiates the firmware install process
-func (c *Client) FirmwareUpload(ctx context.Context, reader io.Reader, params *RedfishUpdateServiceParameters) (taskID string, err error) {
-	// limit to *os.File until theres a need for other types of readers
-	updateFile, ok := reader.(*os.File)
-	if !ok {
-		return "", errors.Wrap(bmclibErrs.ErrFirmwareUpload, "method expects an *os.File object")
-	}
-
+func (c *Client) FirmwareUpload(ctx context.Context, updateFile *os.File, params *RedfishUpdateServiceParameters) (taskID string, err error) {
 	parameters, err := json.Marshal(params)
 	if err != nil {
 		return "", errors.Wrap(errUpdateParams, err.Error())

providers/supermicro/firmware.go

@@ -2,7 +2,7 @@ package supermicro
 
 import (
 	"context"
-	"io"
+	"os"
 	"strings"
 	"time"
 
@@ -49,7 +49,7 @@ func (c *Client) FirmwareInstallSteps(ctx context.Context, component string) ([]
 	return nil, errors.Wrap(errUnexpectedModel, c.model)
 }
 
-func (c *Client) FirmwareUpload(ctx context.Context, component string, reader io.Reader) (taskID string, err error) {
+func (c *Client) FirmwareUpload(ctx context.Context, component string, file *os.File) (taskID string, err error) {
 	if err := c.firmwareInstallSupported(ctx); err != nil {
 		return "", err
 	}
@@ -62,9 +62,9 @@ func (c *Client) FirmwareUpload(ctx context.Context, component string, reader io
 
 	switch {
 	case strings.HasPrefix(strings.ToLower(c.model), "x12"):
-		return c.x12().firmwareUpload(ctx, component, reader)
+		return c.x12().firmwareUpload(ctx, component, file)
 	case strings.HasPrefix(strings.ToLower(c.model), "x11"):
-		return c.x11().firmwareUpload(ctx, component, reader)
+		return c.x11().firmwareUpload(ctx, component, file)
 	}
 
 	return "", errors.Wrap(errUnexpectedModel, c.model)

providers/supermicro/x12_firmware.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"io"
+	"os"
 	"strings"
 
 	"github.com/bmc-toolbox/bmclib/v2/constants"
@@ -45,7 +45,7 @@ func (c *x12) firmwareInstallSteps(component string) ([]constants.FirmwareInstal
 }
 
 // upload firmware
-func (c *x12) firmwareUpload(ctx context.Context, component string, reader io.Reader) (taskID string, err error) {
+func (c *x12) firmwareUpload(ctx context.Context, component string, file *os.File) (taskID string, err error) {
 	if err = c.componentSupported(component); err != nil {
 		return "", err
 	}
@@ -65,7 +65,7 @@ func (c *x12) firmwareUpload(ctx context.Context, component string, reader io.Re
 		return "", err
 	}
 
-	taskID, err = c.redfish.FirmwareUpload(ctx, reader, params)
+	taskID, err = c.redfish.FirmwareUpload(ctx, file, params)
 	if err != nil {
 		if strings.Contains(err.Error(), "OemFirmwareAlreadyInUpdateMode") {
 			return "", errors.Wrap(brrs.ErrBMCColdResetRequired, "BMC currently in update mode, either continue the update OR if no update is currently running - reset the BMC")