refactor: rename API to HostAPI

alexander-ding · alexander-ding · commit 0a2b8ff7851a · 2022-10-20T05:17:32.000Z
diff --git a/integrationtests/disk_test.go b/integrationtests/disk_test.go
@@ -10,7 +10,7 @@ import (
 	"time"
 
 	"github.com/kubernetes-csi/csi-proxy/pkg/disk"
-	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/api"
+	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/hostapi"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
diff --git a/integrationtests/filesystem_test.go b/integrationtests/filesystem_test.go
@@ -15,7 +15,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/kubernetes-csi/csi-proxy/pkg/filesystem"
-	filesystemapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/api"
+	filesystemapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/hostapi"
 )
 
 func TestFilesystem(t *testing.T) {
diff --git a/integrationtests/iscsi_test.go b/integrationtests/iscsi_test.go
@@ -7,11 +7,11 @@ import (
 	"testing"
 
 	disk "github.com/kubernetes-csi/csi-proxy/pkg/disk"
-	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/api"
+	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/hostapi"
 	iscsi "github.com/kubernetes-csi/csi-proxy/pkg/iscsi"
-	iscsiapi "github.com/kubernetes-csi/csi-proxy/pkg/iscsi/api"
+	iscsiapi "github.com/kubernetes-csi/csi-proxy/pkg/iscsi/hostapi"
 	system "github.com/kubernetes-csi/csi-proxy/pkg/system"
-	systemapi "github.com/kubernetes-csi/csi-proxy/pkg/system/api"
+	systemapi "github.com/kubernetes-csi/csi-proxy/pkg/system/hostapi"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
diff --git a/integrationtests/smb_test.go b/integrationtests/smb_test.go
@@ -15,9 +15,9 @@ import (
 	"github.com/stretchr/testify/require"
 
 	fs "github.com/kubernetes-csi/csi-proxy/pkg/filesystem"
-	fsapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/api"
+	fsapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/hostapi"
 	"github.com/kubernetes-csi/csi-proxy/pkg/smb"
-	smbapi "github.com/kubernetes-csi/csi-proxy/pkg/smb/api"
+	smbapi "github.com/kubernetes-csi/csi-proxy/pkg/smb/hostapi"
 )
 
 func TestSMB(t *testing.T) {
diff --git a/integrationtests/system_test.go b/integrationtests/system_test.go
@@ -9,7 +9,7 @@ import (
 	"testing"
 
 	system "github.com/kubernetes-csi/csi-proxy/pkg/system"
-	systemapi "github.com/kubernetes-csi/csi-proxy/pkg/system/api"
+	systemapi "github.com/kubernetes-csi/csi-proxy/pkg/system/hostapi"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
diff --git a/integrationtests/volume_test.go b/integrationtests/volume_test.go
@@ -9,9 +9,9 @@ import (
 	"testing"
 
 	disk "github.com/kubernetes-csi/csi-proxy/pkg/disk"
-	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/api"
+	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/hostapi"
 	volume "github.com/kubernetes-csi/csi-proxy/pkg/volume"
-	volumeapi "github.com/kubernetes-csi/csi-proxy/pkg/volume/api"
+	volumeapi "github.com/kubernetes-csi/csi-proxy/pkg/volume/hostapi"
 
 	"github.com/stretchr/testify/require"
 )
diff --git a/pkg/disk/disk.go b/pkg/disk/disk.go
@@ -3,12 +3,12 @@ package disk
 import (
 	"context"
 
-	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/api"
+	diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/hostapi"
 	"k8s.io/klog/v2"
 )
 
 type Disk struct {
-	hostAPI diskapi.API
+	hostAPI diskapi.HostAPI
 }
 
 type Interface interface {
@@ -39,7 +39,7 @@ type Interface interface {
 // check that Disk implements Interface
 var _ Interface = &Disk{}
 
-func New(hostAPI diskapi.API) (*Disk, error) {
+func New(hostAPI diskapi.HostAPI) (*Disk, error) {
 	return &Disk{
 		hostAPI: hostAPI,
 	}, nil
diff --git a/pkg/disk/hostapi/hostapi.go b/pkg/disk/hostapi/hostapi.go
@@ -23,8 +23,8 @@ const (
 	IOCTL_STORAGE_QUERY_PROPERTY    = 0x002d1400
 )
 
-// API declares the interface exposed by the internal API
-type API interface {
+// HostAPI declares the interface exposed by the internal API
+type HostAPI interface {
 	// ListDiskLocations - constructs a map with the disk number as the key and the DiskLocation structure
 	// as the value. The DiskLocation struct has various fields like the Adapter, Bus, Target and LUNID.
 	ListDiskLocations() (map[uint32]DiskLocation, error)
@@ -55,7 +55,7 @@ type API interface {
 type DiskAPI struct{}
 
 // ensure that DiskAPI implements the exposed API
-var _ API = &DiskAPI{}
+var _ HostAPI = &DiskAPI{}
 
 func New() DiskAPI {
 	return DiskAPI{}
diff --git a/pkg/disk/hostapi/types.go b/pkg/disk/hostapi/types.go
diff --git a/pkg/filesystem/filesystem.go b/pkg/filesystem/filesystem.go
@@ -3,12 +3,12 @@ package filesystem
 import (
 	"context"
 
-	filesystemapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/api"
+	filesystemapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/hostapi"
 	"k8s.io/klog/v2"
 )
 
 type Filesystem struct {
-	hostAPI filesystemapi.API
+	hostAPI filesystemapi.HostAPI
 }
 
 type Interface interface {
@@ -41,7 +41,7 @@ type Interface interface {
 // check that Filesystem implements Interface
 var _ Interface = &Filesystem{}
 
-func New(hostAPI filesystemapi.API) (*Filesystem, error) {
+func New(hostAPI filesystemapi.HostAPI) (*Filesystem, error) {
 	return &Filesystem{
 		hostAPI: hostAPI,
 	}, nil
diff --git a/pkg/filesystem/filesystem_test.go b/pkg/filesystem/filesystem_test.go
@@ -4,12 +4,12 @@ import (
 	"context"
 	"testing"
 
-	fsapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/api"
+	fsapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/hostapi"
 )
 
 type fakeFileSystemAPI struct{}
 
-var _ fsapi.API = &fakeFileSystemAPI{}
+var _ fsapi.HostAPI = &fakeFileSystemAPI{}
 
 func (fakeFileSystemAPI) PathExists(path string) (bool, error) {
 	return true, nil
diff --git a/pkg/filesystem/hostapi/hostapi_test.go b/pkg/filesystem/hostapi/hostapi_test.go
diff --git a/pkg/filesystem/hostapi/hotsapi.go b/pkg/filesystem/hostapi/hotsapi.go
@@ -14,8 +14,8 @@ import (
 // pkg/filesystem/filesystem.go so that logic can be easily unit-tested
 // without requiring specific OS environments.
 
-// API is the exposed Filesystem API
-type API interface {
+// HostAPI is the exposed Filesystem API
+type HostAPI interface {
 	PathExists(path string) (bool, error)
 	PathValid(path string) (bool, error)
 	Mkdir(path string) error
@@ -27,10 +27,10 @@ type API interface {
 
 type filesystemAPI struct{}
 
-// check that filesystemAPI implements API
-var _ API = &filesystemAPI{}
+// check that filesystemAPI implements HostAPI
+var _ HostAPI = &filesystemAPI{}
 
-func New() API {
+func New() HostAPI {
 	return filesystemAPI{}
 }
 
diff --git a/pkg/iscsi/hostapi/hostapi.go b/pkg/iscsi/hostapi/hostapi.go
@@ -12,7 +12,7 @@ import (
 // pkg/iscsi/iscsi.go so that logic can be easily unit-tested
 // without requiring specific OS environments.
 
-type API interface {
+type HostAPI interface {
 	AddTargetPortal(portal *TargetPortal) error
 	DiscoverTargetPortal(portal *TargetPortal) ([]string, error)
 	ListTargetPortals() ([]TargetPortal, error)
@@ -26,10 +26,10 @@ type API interface {
 
 type iscsiAPI struct{}
 
-// check that iscsiAPI implements API
-var _ API = &iscsiAPI{}
+// check that iscsiAPI implements HostAPI
+var _ HostAPI = &iscsiAPI{}
 
-func New() API {
+func New() HostAPI {
 	return iscsiAPI{}
 }
 
diff --git a/pkg/iscsi/hostapi/types.go b/pkg/iscsi/hostapi/types.go
diff --git a/pkg/iscsi/iscsi.go b/pkg/iscsi/iscsi.go
@@ -4,14 +4,14 @@ import (
 	"context"
 	"fmt"
 
-	iscsiapi "github.com/kubernetes-csi/csi-proxy/pkg/iscsi/api"
+	iscsiapi "github.com/kubernetes-csi/csi-proxy/pkg/iscsi/hostapi"
 	"k8s.io/klog/v2"
 )
 
 const defaultISCSIPort = 3260
 
 type ISCSI struct {
-	hostAPI iscsiapi.API
+	hostAPI iscsiapi.HostAPI
 }
 
 type Interface interface {
@@ -53,7 +53,7 @@ type Interface interface {
 
 var _ Interface = &ISCSI{}
 
-func New(hostAPI iscsiapi.API) (*ISCSI, error) {
+func New(hostAPI iscsiapi.HostAPI) (*ISCSI, error) {
 	return &ISCSI{
 		hostAPI: hostAPI,
 	}, nil
diff --git a/pkg/smb/hostapi/hostapi.go b/pkg/smb/hostapi/hostapi.go
@@ -7,7 +7,7 @@ import (
 	"github.com/kubernetes-csi/csi-proxy/pkg/utils"
 )
 
-type API interface {
+type HostAPI interface {
 	IsSMBMapped(remotePath string) (bool, error)
 	NewSMBLink(remotePath, localPath string) error
 	NewSMBGlobalMapping(remotePath, username, password string) error
@@ -16,9 +16,9 @@ type API interface {
 
 type smbAPI struct{}
 
-var _ API = &smbAPI{}
+var _ HostAPI = &smbAPI{}
 
-func New() API {
+func New() HostAPI {
 	return smbAPI{}
 }
 
diff --git a/pkg/smb/smb.go b/pkg/smb/smb.go
@@ -6,12 +6,12 @@ import (
 	"strings"
 
 	fs "github.com/kubernetes-csi/csi-proxy/pkg/filesystem"
-	smbapi "github.com/kubernetes-csi/csi-proxy/pkg/smb/api"
+	smbapi "github.com/kubernetes-csi/csi-proxy/pkg/smb/hostapi"
 	"k8s.io/klog/v2"
 )
 
 type SMB struct {
-	hostAPI smbapi.API
+	hostAPI smbapi.HostAPI
 	fs      fs.Interface
 }
 
@@ -51,7 +51,7 @@ func getRootMappingPath(path string) (string, error) {
 	return strings.ToLower("\\\\" + parts[0] + "\\" + parts[1]), nil
 }
 
-func New(hostAPI smbapi.API, fsClient fs.Interface) (*SMB, error) {
+func New(hostAPI smbapi.HostAPI, fsClient fs.Interface) (*SMB, error) {
 	return &SMB{
 		hostAPI: hostAPI,
 		fs:      fsClient,
diff --git a/pkg/smb/smb_test.go b/pkg/smb/smb_test.go
@@ -5,13 +5,13 @@ import (
 	"testing"
 
 	fs "github.com/kubernetes-csi/csi-proxy/pkg/filesystem"
-	fsapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/api"
-	smbapi "github.com/kubernetes-csi/csi-proxy/pkg/smb/api"
+	fsapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/hostapi"
+	smbapi "github.com/kubernetes-csi/csi-proxy/pkg/smb/hostapi"
 )
 
 type fakeSMBAPI struct{}
 
-var _ smbapi.API = &fakeSMBAPI{}
+var _ smbapi.HostAPI = &fakeSMBAPI{}
 
 func (fakeSMBAPI) NewSMBGlobalMapping(remotePath, username, password string) error {
 	return nil
@@ -31,7 +31,7 @@ func (fakeSMBAPI) NewSMBLink(remotePath, localPath string) error {
 
 type fakeFileSystemAPI struct{}
 
-var _ fsapi.API = &fakeFileSystemAPI{}
+var _ fsapi.HostAPI = &fakeFileSystemAPI{}
 
 func (fakeFileSystemAPI) PathExists(path string) (bool, error) {
 	return true, nil
diff --git a/pkg/system/hostapi/hostapi.go b/pkg/system/hostapi/hostapi.go
@@ -14,7 +14,7 @@ import (
 // pkg/system/system.go so that logic can be easily unit-tested
 // without requiring specific OS environments.
 
-type API interface {
+type HostAPI interface {
 	GetBIOSSerialNumber() (string, error)
 	GetService(name string) (*ServiceInfo, error)
 	StartService(name string) error
@@ -23,7 +23,10 @@ type API interface {
 
 type systemAPI struct{}
 
-func New() API {
+// check that systemAPI implements HostAPI
+var _ HostAPI = &systemAPI{}
+
+func New() HostAPI {
 	return systemAPI{}
 }
 
diff --git a/pkg/system/hostapi/types.go b/pkg/system/hostapi/types.go
diff --git a/pkg/system/system.go b/pkg/system/system.go
@@ -3,12 +3,12 @@ package system
 import (
 	"context"
 
-	systemapi "github.com/kubernetes-csi/csi-proxy/pkg/system/api"
+	systemapi "github.com/kubernetes-csi/csi-proxy/pkg/system/hostapi"
 	"k8s.io/klog/v2"
 )
 
 type System struct {
-	hostAPI systemapi.API
+	hostAPI systemapi.HostAPI
 }
 
 type Interface interface {
@@ -32,7 +32,7 @@ type Interface interface {
 // check that System implements Interface
 var _ Interface = &System{}
 
-func New(hostAPI systemapi.API) (*System, error) {
+func New(hostAPI systemapi.HostAPI) (*System, error) {
 	return &System{
 		hostAPI: hostAPI,
 	}, nil
diff --git a/pkg/volume/hostapi/hostapi.go b/pkg/volume/hostapi/hostapi.go
@@ -13,8 +13,8 @@ import (
 	"k8s.io/klog/v2"
 )
 
-// API exposes the internal volume operations available in the server
-type API interface {
+// HostAPI exposes the internal volume operations available in the server
+type HostAPI interface {
 	// ListVolumesOnDisk lists volumes on a disk identified by a `diskNumber` and optionally a partition identified by `partitionNumber`.
 	ListVolumesOnDisk(diskNumber uint32, partitionNumber uint32) (volumeIDs []string, err error)
 	// MountVolume mounts the volume at the requested global staging target path.
@@ -42,8 +42,8 @@ type API interface {
 // volumeAPI implements the internal Volume APIs
 type volumeAPI struct{}
 
-// verifies that the API is implemented
-var _ API = &volumeAPI{}
+// verifies that HostAPI is implemented
+var _ HostAPI = &volumeAPI{}
 
 var (
 	// VolumeRegexp matches a Windows Volume
@@ -57,7 +57,7 @@ var (
 )
 
 // New - Construct a new Volume API Implementation.
-func New() API {
+func New() HostAPI {
 	return &volumeAPI{}
 }
 
diff --git a/pkg/volume/volume.go b/pkg/volume/volume.go
@@ -4,13 +4,13 @@ import (
 	"context"
 	"fmt"
 
-	volumeapi "github.com/kubernetes-csi/csi-proxy/pkg/volume/api"
+	volumeapi "github.com/kubernetes-csi/csi-proxy/pkg/volume/hostapi"
 	"k8s.io/klog/v2"
 )
 
 // Volume wraps the host API and implements the interface
 type Volume struct {
-	hostAPI volumeapi.API
+	hostAPI volumeapi.HostAPI
 }
 
 type Interface interface {
@@ -53,7 +53,7 @@ type Interface interface {
 
 var _ Interface = &Volume{}
 
-func New(hostAPI volumeapi.API) (*Volume, error) {
+func New(hostAPI volumeapi.HostAPI) (*Volume, error) {
 	return &Volume{
 		hostAPI: hostAPI,
 	}, nil
diff --git a/pkg/volume/volume_test.go b/pkg/volume/volume_test.go

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import (`
`10`	`10`	`"time"`
`11`	`11`
`12`	`12`	`"github.com/kubernetes-csi/csi-proxy/pkg/disk"`
`13`		`- diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/api"`
	`13`	`+ diskapi "github.com/kubernetes-csi/csi-proxy/pkg/disk/hostapi"`
`14`	`14`	`"github.com/stretchr/testify/assert"`
`15`	`15`	`"github.com/stretchr/testify/require"`
`16`	`16`	`)`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import (`
`15`	`15`	`"github.com/stretchr/testify/require"`
`16`	`16`
`17`	`17`	`"github.com/kubernetes-csi/csi-proxy/pkg/filesystem"`
`18`		`- filesystemapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/api"`
	`18`	`+ filesystemapi "github.com/kubernetes-csi/csi-proxy/pkg/filesystem/hostapi"`
`19`	`19`	`)`
`20`	`20`
`21`	`21`	`func TestFilesystem(t *testing.T) {`