drivers: Extract drivers/common package (#21266)

Move all files and packages which are not a driver to the drivers/common
package. This helps to understand the structure of the code.

While moving, move the iso_test.iso into testdata/test.iso to separate
code and test data.

While fixing the test iso path fix few bugs in the tests using wrong iso
path. The test failed because the iso path was wrong instead of issue
with source or destination path.

New directory structure:

    % tree -L1 pkg/drivers
    pkg/drivers
    ├── common
    ├── hyperkit
    ├── kic
    ├── krunkit
    ├── kvm
    ├── none
    ├── qemu
    ├── ssh
    └── vfkit

Author: nirs

cmd/minikube/cmd/start_flags.go

@@ -28,9 +28,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"k8s.io/klog/v2"
+	"k8s.io/minikube/pkg/drivers/common/vmnet"
 	"k8s.io/minikube/pkg/drivers/kic"
 	"k8s.io/minikube/pkg/drivers/kic/oci"
-	"k8s.io/minikube/pkg/drivers/vmnet"
 	"k8s.io/minikube/pkg/minikube/bootstrapper/bsutil"
 	"k8s.io/minikube/pkg/minikube/bootstrapper/bsutil/kverify"
 	"k8s.io/minikube/pkg/minikube/cni"

pkg/drivers/common.go renamed to pkg/drivers/common/common.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package drivers
+package common
 
 import (
 	"bufio"

pkg/drivers/common_test.go renamed to pkg/drivers/common/common_test.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package drivers
+package common
 
 import (
 	"os"

pkg/drivers/iso.go renamed to pkg/drivers/common/iso.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package drivers
+package common
 
 import (
 	"fmt"

pkg/drivers/iso_test.go renamed to pkg/drivers/common/iso_test.go

@@ -14,12 +14,14 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package drivers
+package common
 
 import (
 	"testing"
 )
 
+const testISOPath = "testdata/test.iso"
+
 func TestExtractFile(t *testing.T) {
 	testDir := t.TempDir()
 
@@ -32,42 +34,42 @@ func TestExtractFile(t *testing.T) {
 	}{
 		{
 			name:          "all is right",
-			isoPath:       "iso_test.iso",
+			isoPath:       testISOPath,
 			srcPath:       "/test1.txt",
 			destPath:      testDir + "/test1.txt",
 			expectedError: false,
 		},
 		{
 			name:          "isoPath is error",
-			isoPath:       "tests.iso",
+			isoPath:       "testdata/missing.iso",
 			srcPath:       "/test1.txt",
 			destPath:      testDir + "/test1.txt",
 			expectedError: true,
 		},
 		{
 			name:          "srcPath is empty",
-			isoPath:       "iso_tests.iso",
+			isoPath:       testISOPath,
 			srcPath:       "",
 			destPath:      testDir + "/test1.txt",
 			expectedError: true,
 		},
 		{
 			name:          "srcPath is error",
-			isoPath:       "iso_tests.iso",
+			isoPath:       testISOPath,
 			srcPath:       "/t1.txt",
 			destPath:      testDir + "/test1.txt",
 			expectedError: true,
 		},
 		{
 			name:          "destPath is empty",
-			isoPath:       "iso_test.iso",
+			isoPath:       testISOPath,
 			srcPath:       "/test1.txt",
 			destPath:      "",
 			expectedError: true,
 		},
 		{
 			name:          "find files in a folder",
-			isoPath:       "./iso_test.iso",
+			isoPath:       testISOPath,
 			srcPath:       "/test2/test2.txt",
 			destPath:      testDir + "/test2.txt",
 			expectedError: false,

pkg/drivers/iso_test.iso renamed to pkg/drivers/common/testdata/test.iso

@@ -37,7 +37,7 @@ import (
 	ps "github.com/mitchellh/go-ps"
 	hyperkit "github.com/moby/hyperkit/go"
 	"github.com/pkg/errors"
-	pkgdrivers "k8s.io/minikube/pkg/drivers"
+	"k8s.io/minikube/pkg/drivers/common"
 	"k8s.io/minikube/pkg/minikube/detect"
 )
 
@@ -53,7 +53,7 @@ const (
 // Driver is the machine driver for Hyperkit
 type Driver struct {
 	*drivers.BaseDriver
-	*pkgdrivers.CommonDriver
+	*common.CommonDriver
 	Boot2DockerURL string
 	DiskSize       int
 	CPU            int
@@ -73,7 +73,7 @@ func NewDriver(_, _ string) *Driver {
 		BaseDriver: &drivers.BaseDriver{
 			SSHUser: "docker",
 		},
-		CommonDriver: &pkgdrivers.CommonDriver{},
+		CommonDriver: &common.CommonDriver{},
 	}
 }
 
@@ -103,7 +103,7 @@ func (d *Driver) Create() error {
 	}
 
 	// TODO: handle different disk types.
-	if err := pkgdrivers.MakeDiskImage(d.BaseDriver, d.Boot2DockerURL, d.DiskSize); err != nil {
+	if err := common.MakeDiskImage(d.BaseDriver, d.Boot2DockerURL, d.DiskSize); err != nil {
 		return errors.Wrap(err, "making disk image")
 	}
 
@@ -196,7 +196,7 @@ func (d *Driver) Remove() error {
 
 // Restart a host
 func (d *Driver) Restart() error {
-	return pkgdrivers.Restart(d)
+	return common.Restart(d)
 }
 
 func (d *Driver) createHost() (*hyperkit.HyperKit, error) {
@@ -225,14 +225,14 @@ func (d *Driver) createHost() (*hyperkit.HyperKit, error) {
 
 	h.Disks = []hyperkit.Disk{
 		&hyperkit.RawDisk{
-			Path: pkgdrivers.GetDiskPath(d.BaseDriver),
+			Path: common.GetDiskPath(d.BaseDriver),
 			Size: d.DiskSize,
 			Trim: true,
 		},
 	}
 	for i := 0; i < d.ExtraDisks; i++ {
 		h.Disks = append(h.Disks, &hyperkit.RawDisk{
-			Path: pkgdrivers.ExtraDiskPath(d.BaseDriver, i),
+			Path: common.ExtraDiskPath(d.BaseDriver, i),
 			Size: d.DiskSize,
 			Trim: true,
 		})
@@ -287,7 +287,7 @@ func (d *Driver) setupIP(mac string) error {
 			return fmt.Errorf("hyperkit crashed! command line:\n  hyperkit %s", d.Cmdline)
 		}
 
-		d.IPAddress, err = pkgdrivers.GetIPAddressByMACAddress(mac)
+		d.IPAddress, err = common.GetIPAddressByMACAddress(mac)
 		if err != nil {
 			return &tempError{err}
 		}
@@ -430,7 +430,7 @@ func (d *Driver) extractKernel(isoPath string) error {
 		{"/boot/initrd", "initrd"},
 	} {
 		fullDestPath := d.ResolveStorePath(f.destPath)
-		if err := pkgdrivers.ExtractFile(isoPath, f.pathInIso, fullDestPath); err != nil {
+		if err := common.ExtractFile(isoPath, f.pathInIso, fullDestPath); err != nil {
 			return err
 		}
 	}