fix: coverage, failures, and doc fixes (#24)

* fix: added failure test coverage

* fix: added docs and updated to include description field

* fix: updated breakpoints and TOC for HTML report

* fix: updated links to carousel in docs and regenerated

* fix: lint fixed

Makefile

@@ -11,6 +11,11 @@ build:
 .PHONY: build
 
 docs:
+	go run *.go run \
+		-i ./cmd/test_data/01_basic_flow_will_pass.yaml \
+		-o ./docs/example-outputs/carousel \
+		-r carousel \
+		-u False
 	go run *.go run \
 		-i ./cmd/test_data/01_basic_flow_will_pass.yaml \
 		-o ./docs/example-outputs/html-simple \

cmd/init.go

@@ -9,6 +9,7 @@ import (
 
 // templateFile - yaml formatted
 const templateFile = `label: clingy flow
+description: sample description
 steps:
 - label: start
   description: starting clingy flow

cmd/root.go

@@ -87,7 +87,7 @@ func RootCmd(c *RootConfig) *cobra.Command {
 	rootCmd.PersistentFlags().BoolVarP(&unixTimestampDirDisabled, "unixTimestampDirDisabled", "u", false, "disable saving output by unix timestamp subdirectories to output directory")
 	rootCmd.PersistentFlags().StringVarP(&outputPath, "outputPath", "o", outputPath, "build path that dumps outputs")
 	rootCmd.PersistentFlags().StringVarP(&inputFile, "inputFile", "i", inputFile, "input file representing a .clingy.yaml")
-	rootCmd.PersistentFlags().StringVarP(&reportStyle, "reportStyle", "r", reportStyle, "report style to output to (choices: 'html-simple', 'images-only')")
+	rootCmd.PersistentFlags().StringVarP(&reportStyle, "reportStyle", "r", reportStyle, "report style to output to (choices: 'carousel', 'html-simple', 'images-only')")
 	rootCmd.Flags().SortFlags = true
 
 	return rootCmd

cmd/run.go

@@ -21,16 +21,16 @@ func (r *RootConfig) newRunCmd() *cobra.Command {
 
 			if err := lib.ClingyCanRun(); err != nil {
 				logger.Println("Unable to run clingy due to error in startup", err)
-				fmt.Printf("Clingy cannot run for reason: %s\n", err.Error())
+				cmd.Printf("Clingy cannot run for reason: %s\n", err.Error())
 				r.ExitTools.Exit(1)
 			}
 
 			clingyData, err := lib.ParseClingyFile(logger, inputFile)
 			if err != nil {
-				fmt.Printf("Error in reading: %s %s\n", inputFile, err.Error())
+				cmd.Printf("Error in reading: %s %s\n", inputFile, err.Error())
 				r.ExitTools.Exit(1)
 			}
-			fmt.Printf("Running: %s", clingyData.Label)
+			cmd.Printf("Running: %s", clingyData.Label)
 
 			for idx, step := range clingyData.Steps {
 				// clear terminal for fresh screenshot
@@ -78,7 +78,7 @@ func (r *RootConfig) newRunCmd() *cobra.Command {
 
 				// if output key, process output and store it for future use
 				if step.OutputProcessing != nil {
-					fmt.Printf("Output processing found for key %s\n", step.OutputProcessing.Key)
+					cmd.Printf("Output processing found for key %s\n", step.OutputProcessing.Key)
 					if err := lib.HydrateOutput(logger, string(output), clingyData, idx); err != nil {
 						cmd.Println("Error in capturing output in processing", err)
 						r.ExitTools.Exit(1)
@@ -90,16 +90,16 @@ func (r *RootConfig) newRunCmd() *cobra.Command {
 			internal.ClearTerminal()
 			switch reportStyle {
 			case "images-only":
-				fmt.Printf("Completed clingy run, generated images at %s.", getOutputPath())
-			case "html-simple":
+				cmd.Printf("Completed clingy run, generated images at %s.\n", getOutputPath())
+			case "carousel", "html-simple":
 				cmd.Println("Completed clingy run, generating report.")
 
 				reportPath := fmt.Sprintf("%s/index.html", getOutputPath())
-				if err := internal.GenerateHTMLReport(logger, clingyData, reportPath); err != nil {
+				if err := internal.GenerateHTMLReport(logger, clingyData, reportStyle, reportPath); err != nil {
 					cmd.Println("Error in generating report")
 					r.ExitTools.Exit(1)
 				}
-				fmt.Printf("Generated report: %s\n", reportPath)
+				cmd.Printf("Generated report: %s\n", reportPath)
 			}
 		},
 	}

cmd/run_test.go

@@ -1,7 +1,9 @@
 package cmd
 
 import (
+	"bytes"
 	"fmt"
+	"io/ioutil"
 	"os"
 	"strings"
 	"testing"
@@ -30,6 +32,30 @@ func TestRunCmdExecuteSuccess(t *testing.T) {
 	}
 }
 
+func TestRunCmdExecuteFailures(t *testing.T) {
+	mockTools := internal.GenerateMockInterfacesForClingy(t)
+	defer mockTools.Ctrl.Finish()
+
+	mockTools.MagickClientImpl.EXPECT().CaptureWindow(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes()
+	files, err := os.ReadDir("./test_data")
+	if err != nil {
+		t.Fatalf("Error in reading test_data directory's files %s", err.Error())
+	}
+	for _, file := range files {
+		if strings.Contains(file.Name(), "will_fail") {
+			mockTools.ExitClientsImpl.EXPECT().Exit(1) // this is important, make sure we expect a failure
+			b := new(bytes.Buffer)
+			cmd := RootCmd(&RootConfig{ExitTools: mockTools.ExitClientsImpl, ImageTools: mockTools.MagickClientImpl})
+			cmd.SetOut(b)
+			cmd.SetErr(b)
+			cmd.SetArgs([]string{"run", "-o", "../output", "-i", fmt.Sprintf("./test_data/%s", file.Name())})
+			_ = cmd.Execute()
+			out, _ := ioutil.ReadAll(b)
+			assert.Contains(t, string(out), "Error ")
+		}
+	}
+}
+
 func TestRunCmdHelpSuccess(t *testing.T) {
 	mockTools := internal.GenerateMockInterfacesForClingy(t)
 	defer mockTools.Ctrl.Finish()

cmd/test_data/00_will_fail.yaml → cmd/test_data/00_will_badly_fail.yaml

@@ -1,2 +1,3 @@
 label: "will fail - no steps"
+description: sample description
 steps:

cmd/test_data/01_basic_flow_will_pass.yaml

@@ -1,4 +1,5 @@
 label: "basic flow #1"
+description: sample description
 steps:
   - label: start
     description: starting the example flow

cmd/test_data/02_basic_full_input_will_pass.yaml

@@ -1,4 +1,5 @@
 label: "basic flow #1"
+description: sample description
 steps:
   - label: start
     command: echo

cmd/test_data/03_basic_full_input_overwrite_will_pass.yaml

@@ -1,4 +1,5 @@
 label: "basic flow #1"
+description: sample description
 steps:
   - label: start
     command: echo

cmd/test_data/04_basic_regex_input_will_pass.yaml

@@ -1,4 +1,5 @@
 label: "basic flow #1"
+description: sample description
 steps:
   - label: start
     command: echo

cmd/test_data/05_basic_regex_input_overwrite_will_pass.yaml

@@ -1,4 +1,5 @@
 label: "basic flow #1"
+description: sample description
 steps:
   - label: start
     command: echo

cmd/test_data/06_basic_positional_input_will_pass.yaml

@@ -1,4 +1,5 @@
 label: "basic flow #1"
+description: sample description
 steps:
   - label: start
     command: echo

cmd/test_data/07_basic_positional_input_will_pass.yaml → cmd/test_data/07_basic_positional_input_overwrite_will_pass.yaml

@@ -1,4 +1,5 @@
 label: "basic flow #1"
+description: sample description
 steps:
   - label: start
     command: echo

cmd/test_data/08_basic_regex_input_will_fail_no_match.yaml

@@ -0,0 +1,17 @@
+label: "basic flow #1"
+description: sample description
+steps:
+  - label: start
+    command: echo
+    args:
+      - Starting
+  - label: saving input
+    command: echo
+    args:
+      - "unmatched-input-value"
+    output_processing:
+      key: sample_input_key
+      matching_args:
+        regex: \[\[([^]]+)\]
+      matching_type: regex
+      fail_on_no_match: true

cmd/test_data/09_basic_positional_input_will_fail_no_match.yaml

@@ -0,0 +1,18 @@
+label: "basic flow #1"
+description: sample description
+steps:
+  - label: start
+    command: echo
+    args:
+      - Starting
+  - label: saving input
+    command: echo
+    args:
+      - "unmatched-input-value"
+    output_processing:
+      key: sample_input_key
+      matching_args:
+        positional_delimiter: "-"
+        positional_index: 3
+      matching_type: positional
+      fail_on_no_match: true

docs/02_yaml.md

@@ -7,6 +7,13 @@ By default, `clingy init` will place a `.clingy.yaml` file in your present worki
 * `label` - a label to label the entire clingy workflow
 * `description` - provide a description for the clingy workflow
 
+```yaml
+label: sample label
+description: sample description
+```
+
+Gets set on the top level with the above, like [this example](/clingy/example-outputs/html-simple).
+
 ## Environment variables
 
 If you have environment variables you wish to pass into the YAML, you can do so with the following

docs/03_outputs.md

@@ -24,7 +24,7 @@ This generates a simple HTML report that includes:
 
 ## HTML Reports - Carousel
 
-Example can be found at this link [here](/).
+Example can be found at this link [here](/clingy/example-outputs/carousel).
 
 This generates a simple HTML report that includes:
 

docs/example-outputs/carousel/index.html

@@ -0,0 +1,99 @@
+<html lang="en" data-theme="dark">
+<head>
+    <title>Clingy Report - basic flow #1</title>
+    <link rel="stylesheet" href="https://unpkg.com/@picocss/pico@latest/css/pico.min.css">
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/bootstrap-grid.min.css">
+    <style>
+        html {
+            overflow-x: hidden;
+        }
+        main.container {
+            overflow: hidden;
+        }
+        img.baseImage {
+            max-height: 70vh;
+        }
+    </style>
+</head>
+<body>
+    <main class="container">
+        <div class="row">
+            <div class="col-sm-7 offset-sm-1">
+                <hgroup>
+                    <h1>
+                        basic flow #1
+                    </h1>
+                    <h2>
+
+                        sample description
+
+                    </h2>
+                </hgroup>
+            </div>
+            <div class="col-sm-4">
+                <a href="#" class="contrast outline prev" role="button">Prev</a>
+                <a href="#" class="contrast outline next" role="button">Next</a>
+            </div>
+        </div>
+        <div class="row">
+            <div class="siema col-sm-11 offset-sm-1">
+
+                <div class="slide">
+                    <hgroup>
+                        <h3 id="0">
+                            #0 start
+                        </h3>
+                        <h4>
+                            starting the example flow
+                        </h4>
+                    </hgroup>
+                    <img class="baseImage" alt="screenshot of start" src="0.jpg" />
+                </div>
+
+                <div class="slide">
+                    <hgroup>
+                        <h3 id="1">
+                            #1 waiting
+                        </h3>
+                        <h4>
+                            sleeping for 1 second
+                        </h4>
+                    </hgroup>
+                    <img class="baseImage" alt="screenshot of waiting" src="1.jpg" />
+                </div>
+
+                <div class="slide">
+                    <hgroup>
+                        <h3 id="2">
+                            #2 printing timestamp
+                        </h3>
+                        <h4>
+                            printing the date
+                        </h4>
+                    </hgroup>
+                    <img class="baseImage" alt="screenshot of printing timestamp" src="2.jpg" />
+                </div>
+
+                <div class="slide">
+                    <hgroup>
+                        <h3 id="3">
+                            #3 finish
+                        </h3>
+                        <h4>
+                            finishing the example flow
+                        </h4>
+                    </hgroup>
+                    <img class="baseImage" alt="screenshot of finish" src="3.jpg" />
+                </div>
+
+            </div>
+        </div>
+    </main>
+</body>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/siema.min.js" integrity="sha256-o/z6kPkEdOiAuBTgTdUaFN/F+srDaF3EbsJbkeAboXk=" crossorigin="anonymous"></script>
+<script>
+    const siema = new Siema();
+    document.querySelector('.prev').addEventListener('click', () => siema.prev());
+    document.querySelector('.next').addEventListener('click', () => siema.next());
+</script>
+</html>