Merge pull request #81 from gossion/guwe/spell

Enable spell checking and fix spelling issues

Author: k8s-ci-robot

docs/driver-parameters.md

@@ -29,6 +29,6 @@ volumeAttributes.containerName | existing container name | existing container na
 volumeAttributes.storageAccountName | existing storage account name | existing storage account name | Yes |
 volumeAttributes.keyVaultURL | Azure Key Vault DNS name | existing Azure Key Vault DNS name | No |
 volumeAttributes.keyVaultSecretName | Azure Key Vault secret name | existing Azure Key Vault secret name | No |
-volumeAttributes.keyVaultSecretVersion | Azure Key Vault secret version | existing version | No |if empty, driver will use "current versoin"
+volumeAttributes.keyVaultSecretVersion | Azure Key Vault secret version | existing version | No |if empty, driver will use "current version"
 nodePublishSecretRef.name | secret name that stores storage account name and key(or sastoken) | existing kubernetes secret name |  No  |
 nodePublishSecretRef.namespace | namespace where the secret is | k8s namespace  |  No  | `default`

docs/read-from-keyvault.md

@@ -25,7 +25,7 @@ Please refer to [install blobfuse csi driver](https://github.com/kubernetes-sigs
 
 ## Create PV
 1.  Download a `pv-blobfuse-csi-keyvault.yaml`, edit `keyVaultURL`, `keyVaultSecretName`, `containerName` in PV
-> `keyVaultSecretVersion` is the optional parameter. If not specified, it will be *current versoin*.
+> `keyVaultSecretVersion` is the optional parameter. If not specified, it will be *current version*.
 ```console
 wget https://raw.githubusercontent.com/csi-driver/blobfuse-csi-driver/master/deploy/example/pv-blobfuse-csi-keyvault.yaml
 vi pv-blobfuse-csi-keyvault.yaml

hack/verify-all.sh

@@ -23,3 +23,4 @@ ${PKG_ROOT}/hack/verify-govet.sh
 ${PKG_ROOT}/hack/verify-golint.sh
 ${PKG_ROOT}/hack/verify-dep.sh
 ${PKG_ROOT}/hack/verify-boilerplate.sh
+${PKG_ROOT}/hack/verify-spelling.sh

hack/verify-spelling.sh

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+
+# Copyright 2019 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+TOOL_VERSION="v0.3.4"
+
+# cd to the root path
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
+cd "${ROOT}"
+
+# create a temporary directory
+TMP_DIR=$(mktemp -d)
+
+# cleanup
+exitHandler() (
+  echo "Cleaning up..."
+  rm -rf "${TMP_DIR}"
+)
+trap exitHandler EXIT
+
+# perform go get in a temp dir as we are not tracking this version in a go module
+# if we do the go get in the repo, it will create / update a go.mod and go.sum
+cd "${TMP_DIR}"
+GO111MODULE=on GOBIN="${TMP_DIR}" go get "github.com/client9/misspell/cmd/misspell@${TOOL_VERSION}"
+export PATH="${TMP_DIR}:${PATH}"
+cd "${ROOT}"
+
+# check spelling
+RES=0
+echo "Checking spelling..."
+ERROR_LOG="${TMP_DIR}/errors.log"
+git ls-files | grep -v vendor | xargs misspell > "${ERROR_LOG}"
+if [[ -s "${ERROR_LOG}" ]]; then
+  sed 's/^/error: /' "${ERROR_LOG}" # add 'error' to each line to highlight in e2e status
+  echo "Found spelling errors!"
+  RES=1
+fi
+exit "${RES}"

pkg/blobfuse/blobfuse.go

@@ -35,7 +35,7 @@ import (
 const (
 	// DriverName holds the name of the csi-driver
 	DriverName       = "blobfuse.csi.azure.com"
-	seperator        = "#"
+	separator        = "#"
 	volumeIDTemplate = "%s#%s#%s"
 	fileMode         = "file_mode"
 	dirMode          = "dir_mode"
@@ -114,7 +114,7 @@ func (d *Driver) Run(endpoint string) {
 // input: "rg#f5713de20cde511e8ba4900#pvc-fuse-dynamic-17e43f84-f474-11e8-acd0-000d3a00df41"
 // output: rg, f5713de20cde511e8ba4900, pvc-fuse-dynamic-17e43f84-f474-11e8-acd0-000d3a00df41
 func getContainerInfo(id string) (string, string, string, error) {
-	segments := strings.Split(id, seperator)
+	segments := strings.Split(id, separator)
 	if len(segments) < 3 {
 		return "", "", "", fmt.Errorf("error parsing volume id: %q, should at least contain two #", id)
 	}
@@ -172,11 +172,11 @@ func getStorageAccountFromSecretsMap(secrets map[string]string) (string, string,
 		switch strings.ToLower(k) {
 		case "accountname":
 			accountName = v
-		case "azurestorageaccountname": // for compatability with built-in blobfuse plugin
+		case "azurestorageaccountname": // for compatibility with built-in blobfuse plugin
 			accountName = v
 		case "accountkey":
 			accountKey = v
-		case "azurestorageaccountkey": // for compatability with built-in blobfuse plugin
+		case "azurestorageaccountkey": // for compatibility with built-in blobfuse plugin
 			accountKey = v
 		case "azurestorageaccountsastoken":
 			accountSasToken = v

pkg/util/util.go

@@ -55,7 +55,7 @@ func roundUpSize(volumeSizeBytes int64, allocationUnitBytes int64) int64 {
 	return roundedUp
 }
 
-// GetMountOptions return options with string list seperated by space
+// GetMountOptions return options with string list separated by space
 func GetMountOptions(options []string) string {
 	if len(options) == 0 {
 		return ""