Codespell fixes

.codespell-whitelist

@@ -0,0 +1,3 @@
+alls
+ba
+cas

.drone.yml

@@ -56,13 +56,18 @@ steps:
     commands:
       - CGO_ENABLED=0 go test -v ./...
 
+  - name: check spelling
+    image: nixos/nix
+    commands:
+      - ./ci-checks.sh
+
   - name: build
     image: golang:1.13-alpine3.11
     commands:
       - apk add --update make
       - make
 
-  - name: fmt_lint_check
+  - name: fmt and lint check of go code
     image: golang:1.13-alpine3.11
     commands:
       - apk add --update make

ci-checks.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env nix-shell
+#!nix-shell -i bash
+
+codespell -q 3 -I .codespell-whitelist *

cmd/tink-worker/action.go

@@ -118,7 +118,7 @@ func executeAction(ctx context.Context, action *pb.WorkflowAction, wfID string)
 		}
 	}
 	log.Infoln("Action container exits with status code ", status)
-	return fmt.Sprintf("Successfull Execution"), status, nil
+	return fmt.Sprintf("Successful Execution"), status, nil
 }
 
 func captureLogs(ctx context.Context, id string) {
@@ -271,7 +271,7 @@ func removeContainer(ctx context.Context, id string) error {
 func initializeDockerClient() (*client.Client, error) {
 	registry = os.Getenv("DOCKER_REGISTRY")
 	if registry == "" {
-		return nil, errors.New("requried DOCKER_REGISTRY")
+		return nil, errors.New("required DOCKER_REGISTRY")
 	}
 	c, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
 	if err != nil {

cmd/tink-worker/worker.go

@@ -42,7 +42,7 @@ type WorkflowMetadata struct {
 func processWorkflowActions(client pb.WorkflowSvcClient) error {
 	workerID := os.Getenv("WORKER_ID")
 	if workerID == "" {
-		return fmt.Errorf("requried WORKER_NAME")
+		return fmt.Errorf("required WORKER_NAME")
 	}
 	log = logger.WithField("worker_id", workerID)
 	ctx := context.Background()

db/workflow.go

@@ -111,7 +111,7 @@ func insertIntoWfWorkerTable(ctx context.Context, db *sql.DB, wfID uuid.UUID, wo
 	INSERT INTO
 		workflow_worker_map (workflow_id, worker_id)
 	SELECT $1, $2
-	WHERE 
+	WHERE
 		NOT EXISTS (
 			SELECT workflow_id FROM workflow_worker_map WHERE workflow_id = $1 AND worker_id = $2
 		);
@@ -149,7 +149,7 @@ func insertActionList(ctx context.Context, db *sql.DB, yamlData string, id uuid.
 		if err != nil {
 			return err
 		} else if workerID == "" {
-			return fmt.Errorf("Hardware mentioned with refernece %s not found", task.WorkerAddr)
+			return fmt.Errorf("Hardware mentioned with reference %s not found", task.WorkerAddr)
 		}
 		workerUID, err := uuid.FromString(workerID)
 		if err != nil {
@@ -546,8 +546,8 @@ func UpdateWorkflowState(ctx context.Context, db *sql.DB, wfContext *pb.Workflow
 	UPDATE workflow_state
 	SET current_task_name = $2,
 		current_action_name = $3,
-		current_action_state = $4, 
-		current_worker = $5, 
+		current_action_state = $4,
+		current_worker = $5,
 		current_action_index = $6
 	WHERE
 		workflow_id = $1;
@@ -649,9 +649,9 @@ func ShowWorkflowEvents(db *sql.DB, wfID string, fn func(wfs pb.WorkflowActionSt
 	rows, err := db.Query(`
        SELECT worker_id, task_name, action_name, execution_time, message, status, created_at
 	   FROM workflow_event
-	   WHERE 
+	   WHERE
 			   workflow_id = $1
-		ORDER BY 
+		ORDER BY
 				created_at ASC;
 	   `, wfID)
 
@@ -797,7 +797,7 @@ func getWorkerID(ctx context.Context, db *sql.DB, addr string) (string, error) {
 
 func isValidLength(name string) error {
 	if len(name) > 200 {
-		return fmt.Errorf("Task/Action Name %s in the Temlate as more than 200 characters", name)
+		return fmt.Errorf("Task/Action Name %s in the Template as more than 200 characters", name)
 	}
 	return nil
 }

docs/concepts.md

@@ -43,7 +43,7 @@ tasks:
       - /statedir:/statedir
 ```
 
-A template comprises Tasks, which are executed in a sequential manner. A task can consits multiple Actions. As can be in the above example, a task supports volumes and environment variables. The volumes and environment variables defined for a particular task level are inherited by each action in that particular task. 
+A template comprises Tasks, which are executed in a sequential manner. A task can consists multiple Actions. As can be in the above example, a task supports volumes and environment variables. The volumes and environment variables defined for a particular task level are inherited by each action in that particular task. 
 
 It is important to note that an action can also have its own volumes and environment variables. Therefore, any entry at an action will overwrite the value defined at the task level. For example, in the above template the `MIRROR_HOST` environment variable defined at action `disk-partition` will overwrite the value defined at task level. However, the other actions will receive the original value defined at the task level.
 
@@ -61,7 +61,7 @@ The provisioner machine is the main driver for executing a workflow. A provision
  - Kibana
  - NGINX
 
-It is upto you if you would like to divide these components into multiple servers.
+It is up to you if you would like to divide these components into multiple servers.
 
 ### Worker
 

grpc-server/template.go

@@ -21,7 +21,7 @@ func (s *server) CreateTemplate(ctx context.Context, in *template.WorkflowTempla
 
 	msg := ""
 	labels["op"] = "createtemplate"
-	msg = "creating a new Teamplate"
+	msg = "creating a new Template"
 	id := uuid.NewV4()
 	fn := func() error { return db.CreateTemplate(ctx, s.db, in.Name, in.Data, id) }
 

setup.sh

@@ -362,7 +362,7 @@ generate_certificates() {
 	if [ -d "$deploy"/certs ]; then 
 		echo "$WARN found certs directory"
 		if grep -q "\"$TINKERBELL_HOST_IP\"" "$deploy"/tls/server-csr.in.json; then
-			echo "$WARN found server enty in TLS"
+			echo "$WARN found server entry in TLS"
 			echo "$INFO found existing certificates for host $TINKERBELL_HOST_IP, skipping certificate generation"
 		else 
 			gen_certs

shell.nix

@@ -13,6 +13,7 @@ mkShell {
   buildInputs = [
     gnumake
     go
+    pythonPackages.codespell
     shfmt
     shellcheck
     terraform

test/framework/setup.go

@@ -64,7 +64,7 @@ func createWorkerImage() error {
 	cmd.Stderr = os.Stderr
 	err := cmd.Run()
 	if err != nil {
-		logger.Errorln("Faield to create worker image", err)
+		logger.Errorln("Failed to create worker image", err)
 	}
 	logger.Infoln("Worker Image created")
 	return err
@@ -104,7 +104,7 @@ func StartStack() error {
 	// Docker compose file for starting the containers
 	filepath := "../test-docker-compose.yml"
 
-	// Intialize logger
+	// Initialize logger
 	initializeLogger()
 
 	// Start Db and logging components

test/framework/worker.go

@@ -60,7 +60,7 @@ func waitContainer(ctx context.Context, cli *dc.Client, id string, wg *sync.Wait
 	select {
 	case status := <-wait:
 		statusChannel <- status.StatusCode
-		fmt.Println("Worker with id ", id, "finished sucessfully with status code ", status.StatusCode)
+		fmt.Println("Worker with id ", id, "finished successfully with status code ", status.StatusCode)
 		//stopLogs <- true
 	case err := <-errC:
 		log.Println("Worker with id ", id, "failed : ", err)