feat: add unit test for commands (#4)

- Add test for root, tc, and eBay commands with the separate test for flags
- Add GH workflow to automate testing on PR and Push

Author: Pradumnasaraf

.github/workflows/unit-test.yml

@@ -0,0 +1,29 @@
+name: Unit Tests
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+  pull_request:
+
+jobs:
+  build-format:
+    name: Build and Format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Setup Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.19
+
+      - name: Clear the test cache
+        run: go clean -testcache
+
+      - name: Install Executable to $GOPATH/bin
+        run: go install
+
+      - name: Run Tests
+        run: go test -v ./tests/...

cmd/root.go

@@ -11,7 +11,7 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "scrapy [command] [flags]",
-	Short: "Scape the web from the command line",
+	Short: "Scrape the web from the command line",
 	Run: func(cmd *cobra.Command, args []string) {
 		err := cmd.Help()
 		if err != nil {

tests/ebay_test.go

@@ -0,0 +1,53 @@
+package test
+
+import (
+	"os/exec"
+	"strings"
+	"testing"
+)
+
+// TestEbayCmd tests the ebay command
+func TestEbayCmd(t *testing.T) {
+
+	expectedOutput := "Searching for: iphone"
+	cmd := exec.Command("scrapy", "ebay", "iphone")
+
+	// Capture the output
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		t.Errorf("expected no error, but got: %v", err)
+	}
+
+	// Validate the cli output
+	got := strings.TrimSpace(string(output)[:22])
+	if got != strings.Trim(expectedOutput, " ") {
+		t.Errorf("expected %v, but got: %v", expectedOutput, got)
+	}
+
+}
+
+// TestEbayCmdPagesFlag tests the ebay command with the pages flag
+func TestEbayCmdPagesFlag(t *testing.T) {
+
+	expectedOutput := "Searching for: macbook"
+	stringContains := "Scraping page 1 of 2"
+	cmd := exec.Command("scrapy", "ebay", "macbook", "--pages", "2")
+
+	// Capture the output
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		t.Errorf("expected no error, but got: %v", err)
+	}
+
+	// Validate the 1st line of the cli output
+	got := strings.TrimSpace(string(output)[:22])
+	if got != strings.Trim(expectedOutput, " ") {
+		t.Errorf("expected %v, but got: %v", expectedOutput, got)
+	}
+
+	// Validate the 2nd line of the cli output
+	if strings.Contains(string(output), stringContains) != true {
+		t.Errorf("expected %v, but got: %v", stringContains, string(output))
+	}
+
+}

tests/root_test.go

@@ -0,0 +1,47 @@
+package test
+
+import (
+	"os/exec"
+	"strings"
+	"testing"
+)
+
+// TestRootCmd tests the root command (scrapy)
+func TestRootCmd(t *testing.T) {
+
+	expectedOutput := "Scrape the web from the command line"
+	cmd := exec.Command("scrapy")
+
+	// Capture the output
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		t.Errorf("expected no error, but got: %v", err)
+	}
+
+	// Validate the cli output
+	got := strings.TrimSpace(string(output)[:36])
+	if got != expectedOutput {
+		t.Errorf("expected %v, but got: %v", expectedOutput, got)
+	}
+
+}
+
+// TestRootCmdHelpFlag tests the root command (scrapy) with the help flag
+func TestRootCmdHelpFlag(t *testing.T) {
+
+	expectedOutput := "Scrape the web from the command line"
+	cmd := exec.Command("scrapy", "--help")
+
+	// Capture the output
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		t.Errorf("expected no error, but got: %v", err)
+	}
+
+	// Validate the cli output
+	got := strings.TrimSpace(string(output)[:36])
+	if got != expectedOutput {
+		t.Errorf("expected %v, but got: %v", expectedOutput, got)
+	}
+
+}

tests/techcrunch_test.go

@@ -0,0 +1,74 @@
+package test
+
+import (
+	"os/exec"
+	"strings"
+	"testing"
+)
+
+// TestTcCmd tests the tc command
+func TestTcCmd(t *testing.T) {
+
+	expectedOutput := "Searching for latest blogs on techcrunch...."
+	cmd := exec.Command("scrapy", "tc")
+
+	// Capture the output
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		t.Errorf("expected no error, but got: %v", err)
+	}
+
+	// Validate the cli output
+	got := strings.TrimSpace(string(output)[:44])
+	if got != strings.Trim(expectedOutput, " ") {
+		t.Errorf("expected %v, but got: %v", expectedOutput, got)
+	}
+
+}
+
+// TestTcCmdWithCategoryFlag tests the tc command with the category flag
+
+func TestTcCmdWithCategoryFlag(t *testing.T) {
+
+	expectedOutput := "Searching for latest blogs on techcrunch...."
+	cmd := exec.Command("scrapy", "tc", "--category", "startups")
+
+	// Capture the output
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		t.Errorf("expected no error, but got: %v", err)
+	}
+
+	// Validate the 1st line of the cli output
+	got := strings.TrimSpace(string(output)[:44])
+	if got != strings.Trim(expectedOutput, " ") {
+		t.Errorf("expected %v, but got: %v", expectedOutput, got)
+	}
+
+}
+
+// // TestTcCmdWithInvalidCategoryFlag tests the tc command with the category flag
+func TestTcCmdWithInvalidCategoryFlag(t *testing.T) {
+
+	expectedOutput := "Searching for latest blogs on techcrunch...."
+	stringsContains := "Invalid category. Showing homepage instead."
+	cmd := exec.Command("scrapy", "tc", "--category", "football")
+
+	// Capture the output
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		t.Errorf("expected no error, but got: %v", err)
+	}
+
+	// Validate the 1st line of the cli output
+	got := strings.TrimSpace(string(output)[:44])
+	if got != strings.Trim(expectedOutput, " ") {
+		t.Errorf("expected %v, but got: %v", expectedOutput, got)
+	}
+
+	// Validate the 2nd line of the cli output
+	if strings.Contains(string(output), stringsContains) != true {
+		t.Errorf("expected %v, but got: %v", stringsContains, string(output))
+	}
+
+}