Merge pull request #8779 from travisn/obsolete-test-scripts

test: Remove obsolete test scripts for minishift, kubeadm, and update test readme
rook · Sep 24, 2021 · 12506c7 · 12506c7
2 parents 8132909 + ce52a07
commit 12506c7
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 418 deletions.
diff --git a/build/common.sh b/build/common.sh
@@ -26,9 +26,7 @@ export scriptdir
 scriptdir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 export OUTPUT_DIR=${BUILD_ROOT}/_output
 export WORK_DIR=${BUILD_ROOT}/.work
-CACHE_DIR=${BUILD_ROOT}/.cache
-
-export KUBEADM_DIND_DIR=${CACHE_DIR}/kubeadm-dind
+export CACHE_DIR=${BUILD_ROOT}/.cache
 
 CROSS_IMAGE=${BUILD_REGISTRY}/cross-amd64
 CROSS_IMAGE_VOLUME=cross-volume

diff --git a/tests/README.md b/tests/README.md
@@ -1,115 +1,67 @@
 # Rook Test Framework
 
 The Rook Test Framework is used to run end to end and integration tests on Rook. The framework depends on a running instance of Kubernetes.
-The framework also provides scripts for starting Kubernetes using `kubeadm` or `minikube` so users can
-quickly spin up a Kubernetes cluster.The Test framework is designed to install Rook, run tests, and uninstall Rook.
+The framework also provides scripts for starting Kubernetes so users can
+quickly spin up a Kubernetes cluster. The Test framework is designed to install Rook, run tests, and uninstall Rook.
 
-## Requirements
-1. Docker version => 1.2 && < 17.0 (for other alternatives, see below)
-1. Ubuntu 18 (the framework has only been tested on this version)
-1. kernel >= 4.15
-1. Kubernetes with kubectl configured
-1. Rook
+## Install Kubernetes
 
-## Instructions
+You can choose any Kubernetes install of your choice.  The test framework only depends on `kubectl` being configured.
+An optional helper script is provided to install Kubernetes with minikube.
 
-## Setup
+### Minikube
 
-### Container Runtime
-
-By default, the test suite tries to use the `docker` command line tool. To use
-an alternative container runtime tool, set the `DOCKERCMD` environment variable
-to your command line tool of choice.
-
-### Install Kubernetes
-You can choose any Kubernetes flavor of your choice.  The test framework only depends on kubectl being configured.
-The framework also provides scripts to install Kubernetes. There are two scripts to start the cluster:
-1. **Kubeadm** (recommended for Ubuntu): run [kubeadm.sh](/tests/scripts/kubeadm.sh) to setup a single-node K8s cluster using kubeadm
-1. **Minikube** (recommended for non-Ubuntu): Run [minikube.sh](/tests/scripts/minikube.sh) to setup a single-node Minikube Kubernetes.
-
-Minikube scripts only support "docker" and "none" as vm-driver.
-
-#### Minikube (recommended for non-Ubuntu)
 Starting the cluster on Minikube is as simple as running:
+
 ```console
 tests/scripts/minikube.sh up
 ```
 
 To copy Rook images generated from your local build into the Minikube VM, run the following commands after `minikube.sh up` succeeded:
+
 ```console
 tests/scripts/minikube.sh update
 tests/scripts/minikube.sh helm
 ```
 
 Stopping the cluster and destroying the Minikube VM can be done with:
-```console
-tests/scripts/minikube.sh clean
-```
 
-#### Kubeadm (recommended for Ubuntu)
-Starting the cluster using `kubeadm` is as simple as running:
 ```console
-tests/scripts/kubeadm.sh up
-```
-
-`kubeadm.sh` starts Kubernetes on the host, so all the images generated by your local build should be available to the cluster without any additional commands.
-You can change the Kubernetes version (default is v1.15.12) with `KUBE_VERSION` environment variable. Here is the example of using Kubernetes v1.19.0.
-
-```console
-export KUBE_VERSION=v1.19.0
-tests/scripts/kubeadm.sh up
+tests/scripts/minikube.sh clean
 ```
 
-Please note that this script may downgrade the following deb packages.
+For faster iteration during development, take a snapshot of the fresh minikube VM and then reset
+the VM each time you need a clean environment.
 
-- kubernetes-cni
-- kubelet
-- kubeadm
+## Install Helm
 
-Stopping the cluster can be done with:
-```console
-tests/scripts/kubeadm.sh clean
-```
-
-#### Alternate Kubernetes Versions
-These two scripts can install any version of Kubernetes you wish based on the `KUBE_VERSION` environment variable.
-To use an alternate version, simply set this variable before running the relevant `up` command from above.
-For example, if you wanted to use `v1.12.5`, you would run `export KUBE_VERSION=v1.12.5` first before running `up`.
-
-### Install Helm
 Use [helm.sh](/tests/scripts/helm.sh) to install Helm and set up Rook charts defined under `_output/charts` (generated by build):
 
 - To install and set up Helm charts for Rook run `tests/scripts/helm.sh up`.
 - To clean up `tests/scripts/helm.sh clean`.
 
-**NOTE:** `*kubeadm.sh`, `minikube.sh` and `helm.sh` scripts depend on some artifacts under the `_output/` directory generated during build time,
-these scripts should be run from project root. e.g., `tests/script/kubeadm.sh up`.
+**NOTE:** These helper scripts depend on some artifacts under the `_output/` directory generated during build time.
+These scripts should be run from the project root. e.g., `tests/script/minikube.sh up`.
 
 **NOTE**: If Helm is not available in your `PATH`, Helm will be downloaded to a temporary directory (`/tmp/rook-tests-scripts-helm`) and used from that directory.
 
 ## Run Tests
-From the project root do the following:
 
-### 1. Build rook:
-Run `make build`
+From the project root do the following after bringing up your Kubernetes cluster such as minikube:
+
+### 1. Build rook
+
+`make build`
 
 ### 2. Start Kubernetes
-Using one of the following:
 
-- Using Kubeadm
-```
-tests/scripts/kubeadm.sh up
-export KUBECONFIG=~/admin.conf
-tests/scripts/helm.sh up
-```
-- Using minikube
-```
+Start the minikube cluster and copy the local build into minikube:
+
+```console
 tests/scripts/minikube.sh up
-tests/scripts/minikube.sh helm
-tests/scripts/helm.sh up
 ```
 
-### 3. Run integration tests:
+### 3. Run integration tests
 
 Some settings are available to run the tests under different environments. The settings are all configured with environment variables.
 See [environment.go](/tests/framework/installer/environment.go) for the available environment variables.
@@ -121,28 +73,24 @@ export TEST_BASE_DIR=WORKING_DIR
 export TEST_SCRATCH_DEVICE=<block device> # for example, TEST_SCRATCH_DEVICE=/dev/sdb
 ```
 
-Please note that the integration test erases the contents of TEST_SCRATCH_DEVICE.
+Please note that the integration tests erase the contents of TEST_SCRATCH_DEVICE.
 
 To run all integration tests:
+
 ```console
 go test -v -timeout 7200s github.com/rook/rook/tests/integration
 ```
 
 After running tests, you can get test logs under "tests/integration/_output".
 
-In addition, you can choose to test only one storage provider. For example, you can run Ceph tests as follows.
-
-```console
-export STORAGE_PROVIDER_TESTS=ceph
-go test -v -timeout 7200s github.com/rook/rook/tests/integration
-```
-
 To run a specific suite (uses regex):
+
 ```console
 go test -v -timeout 1800s -run CephSmokeSuite github.com/rook/rook/tests/integration
 ```
 
 To run specific tests inside a suite:
+
 ```console
 go test -v -timeout 1800s -run CephSmokeSuite github.com/rook/rook/tests/integration -testify.m TestARookClusterInstallation_SmokeTest
 ```
@@ -153,14 +101,16 @@ go test -v -timeout 1800s -run CephSmokeSuite github.com/rook/rook/tests/integra
 - Make sure `oc` executable file is in the PATH.
 - Only `CephSmokeSuite` is currently supported on OpenShift.
 - Set few environment variables:
-```
+
+```console
 export TEST_ENV_NAME=openshift
 export TEST_STORAGE_CLASS=gp2
 export TEST_BASE_DIR=/tmp
 export RETRY_MAX=40
 ```
 
-To run a `CephSmokeSuite` (uses regex):
+To run the `CephSmokeSuite`:
+
 ```console
 go test -v -timeout 1800s -run CephSmokeSuite github.com/rook/rook/tests/integration
 ```
diff --git a/tests/scripts/kubeadm.sh b/tests/scripts/kubeadm.sh