From 79724f81b881808ca0047f7dd52eee6c2ce0624b Mon Sep 17 00:00:00 2001
From: Patrice Chalin <pchalin@gmail.com>
Date: Tue, 28 Nov 2023 15:11:31 -0500
Subject: [PATCH] Add support for `--test-only DIR`

---
 README.md                      |  2 ++
 htmldoc/document_store.go      |  6 ++++++
 htmldoc/document_store_test.go | 22 ++++++++++++++++++++++
 htmltest/htmltest.go           |  1 +
 htmltest/htmltest_test.go      | 10 ++++++++++
 htmltest/options.go            |  2 ++
 main.go                        | 31 +++++++++++++++++++++++++++++++
 7 files changed, 74 insertions(+)

diff --git a/README.md b/README.md
index 150e6c7..a83d16a 100644
--- a/README.md
+++ b/README.md
@@ -78,6 +78,7 @@ Options:
   -l LEVEL, --log-level LEVEL  Logging level, 0-3: debug, info, warning, error.
   -s, --skip-external          Skip external link checks, may shorten execution
                                time considerably.
+  -t, --test-only DIR          Site subdirectory to test, relative to the site base path
   -v, --version                Show version and build time.
 ```
 
@@ -135,6 +136,7 @@ htmltest uses a YAML configuration file. Put `.htmltest.yml` in the same directo
 | `DirectoryIndex` | The file to look for when linking to a directory.                                                                                                                                                               | `index.html` |
 | `FilePath` | Single file to test within `DirectoryPath`, omit to test all.                                                                                                                                                   | |
 | `FileExtension` | Extension of your HTML documents, includes the dot. If `FilePath` is set we use the extension from that.                                                                                                        | `.html` |
+| `TestOnlyDir` | Single directory to test within `DirectoryPath`, omit to test all.                                                                                                                                                   | |
 | `CheckDoctype` | Enables checking the document type declaration.                                                                                                                                                                 | `true` |
 | `CheckAnchors` | Enables checking `<a…` tags.                                                                                                                                                                                    | `true` |
 | `CheckLinks` | Enables checking `<link…` tags.                                                                                                                                                                                 | `true` |
diff --git a/htmldoc/document_store.go b/htmldoc/document_store.go
index adf4386..2ece3b2 100644
--- a/htmldoc/document_store.go
+++ b/htmldoc/document_store.go
@@ -7,6 +7,7 @@ import (
 	"os"
 	"path"
 	"regexp"
+	"strings"
 
 	"github.com/wjdp/htmltest/output"
 )
@@ -15,6 +16,7 @@ import (
 type DocumentStore struct {
 	BasePath           string               // Path, relative to cwd, the site is located in
 	IgnorePatterns     []interface{}        // Regexes of directories to ignore
+	TestOnlyDir        string               // Clean non-nil path of directory to test relative to `BasePath`
 	Documents          []*Document          // All of the documents, used to iterate over
 	DocumentPathMap    map[string]*Document // Maps slash separated paths to documents
 	DocumentExtension  string               // File extension to look for
@@ -51,6 +53,10 @@ func (dS *DocumentStore) isDirIgnored(dir string) bool {
 			return true
 		}
 	}
+	if dS.TestOnlyDir != "" {
+		matchesTestOnlyDir := strings.HasPrefix(dir, dS.TestOnlyDir)
+		return !matchesTestOnlyDir
+	}
 	return false
 }
 
diff --git a/htmldoc/document_store_test.go b/htmldoc/document_store_test.go
index 95dce03..a54dba3 100644
--- a/htmldoc/document_store_test.go
+++ b/htmldoc/document_store_test.go
@@ -29,6 +29,28 @@ func TestDocumentStoreIgnorePatterns(t *testing.T) {
 	assert.Equals(t, "document count", len(dS.Documents), 6)
 }
 
+func TestDocumentStoreTestOnlyDir(t *testing.T) {
+	dS := NewDocumentStore()
+	dS.BasePath = "fixtures/documents"
+	dS.DocumentExtension = ".html" // Ignores .htm
+	dS.DirectoryIndex = "index.html"
+	dS.TestOnlyDir = "dir1"
+	dS.Discover()
+	// TestOnlyDir does not affect stored document count
+	assert.Equals(t, "document count", len(dS.Documents), 6)
+	// TODO: uncomment the following if/once https://github.com/wjdp/htmltest/pull/229 is merged
+	// assert.Equals(t, "ignored document count", dS.IgnoredDocCount(), 4)
+	ignoredFile := "dir2/index.html"
+	assert.IsTrue(t, ignoredFile+" is ignored", dS.DocumentPathMap[ignoredFile].IgnoreTest)
+
+	testFiles := [2]string{"dir1/index.html", "dir1/dir11/index.html"}
+	for _, keptFile := range testFiles {
+		f, exists := dS.DocumentPathMap[keptFile]
+		assert.IsTrue(t, keptFile+" exists", exists)
+		assert.IsFalse(t, keptFile+" is not ignored", f.IgnoreTest)
+	}
+}
+
 func TestDocumentStoreDocumentExists(t *testing.T) {
 	// documentstore knows if documents exist or not
 	dS := NewDocumentStore()
diff --git a/htmltest/htmltest.go b/htmltest/htmltest.go
index e30bc62..280d9e5 100644
--- a/htmltest/htmltest.go
+++ b/htmltest/htmltest.go
@@ -149,6 +149,7 @@ func Test(optsUser map[string]interface{}) (*HTMLTest, error) {
 	hT.documentStore.DirectoryIndex = hT.opts.DirectoryIndex
 	hT.documentStore.IgnorePatterns = hT.opts.IgnoreDirs
 	hT.documentStore.IgnoreTagAttribute = hT.opts.IgnoreTagAttribute
+	hT.documentStore.TestOnlyDir = hT.opts.TestOnlyDir
 	// Discover documents
 	hT.documentStore.Discover()
 
diff --git a/htmltest/htmltest_test.go b/htmltest/htmltest_test.go
index 30d359f..0c1ea92 100644
--- a/htmltest/htmltest_test.go
+++ b/htmltest/htmltest_test.go
@@ -92,6 +92,16 @@ func TestCountErrors(t *testing.T) {
 	assert.Equals(t, "CountErrors", hT.CountErrors(), 2)
 }
 
+func TestCountFolderDocuments(t *testing.T) {
+	hT := tTestDirectoryOpts("fixtures/documents/folder-ok", map[string]interface{}{
+		"TestOnlyDir": "a",
+	})
+	assert.Equals(t, "CountDocuments", hT.CountDocuments(), 3)
+	// TODO: uncomment the following if/once https://github.com/wjdp/htmltest/pull/229 is merged
+	// assert.Equals(t, "CountTestedDocuments", hT.CountTestedDocuments(), 1)
+	assert.Equals(t, "CountErrors", hT.CountErrors(), 0)
+}
+
 func TestFileExtensionDefault(t *testing.T) {
 	// Non .html files are ignored
 	hT := tTestDirectory("fixtures/documents/folder-htm")
diff --git a/htmltest/options.go b/htmltest/options.go
index 6ed0088..15deb72 100644
--- a/htmltest/options.go
+++ b/htmltest/options.go
@@ -18,6 +18,7 @@ type Options struct {
 	DirectoryIndex string
 	FilePath       string
 	FileExtension  string
+	TestOnlyDir    string
 
 	CheckDoctype bool
 	CheckAnchors bool
@@ -86,6 +87,7 @@ func DefaultOptions() map[string]interface{} {
 	return map[string]interface{}{
 		"DirectoryIndex": "index.html",
 		"FileExtension":  ".html",
+		"TestOnlyDir":    "",
 
 		"CheckDoctype": true,
 		"CheckAnchors": true,
diff --git a/main.go b/main.go
index 554d0c8..e00c496 100644
--- a/main.go
+++ b/main.go
@@ -41,6 +41,7 @@ Options:
   -l LEVEL, --log-level LEVEL  Logging level, 0-3: debug, info, warning, error.
   -s, --skip-external          Skip external link checks, may shorten execution
                                time considerably.
+  -t, --test-only DIR          Site subdirectory to test, relative to the site base path
   -v, --version                Show version and build time.
 `
 	versionText := "htmltest " + version
@@ -139,6 +140,36 @@ func augmentWithCLIArgs(options optsMap, arguments map[string]interface{}) {
 
 	}
 
+	if arguments["--test-only"] != nil {
+		var testOnlyDir = path.Clean(arguments["--test-only"].(string))
+		options["TestOnlyDir"] = testOnlyDir
+
+		var directoryPath string = ""
+		if options["DirectoryPath"] != nil {
+			directoryPath = options["DirectoryPath"].(string)
+		}
+		var testOnlyDirFullPath = testOnlyDir
+
+		if directoryPath != "" && !strings.HasPrefix(testOnlyDir, "/") && !strings.HasPrefix(testOnlyDir, directoryPath) {
+			testOnlyDirFullPath = path.Join(directoryPath, testOnlyDir)
+		}
+
+		f, err := os.Open(path.Clean(testOnlyDirFullPath))
+		if os.IsNotExist(err) {
+			output.AbortWith("Cannot access --test-only path '" + testOnlyDirFullPath + "', no such directory.")
+		}
+		output.CheckErrorGeneric(err)
+		defer f.Close()
+
+		fi, err := f.Stat()
+		output.CheckErrorPanic(err)
+
+		if !fi.IsDir() {
+			output.AbortWith("Argument to --test-only must be directory: '" + testOnlyDirFullPath + "'")
+		}
+
+	}
+
 	if arguments["--log-level"] != nil {
 		if ll, err := strconv.Atoi(arguments["--log-level"].(string)); err == nil && ll >= 0 {
 			options["LogLevel"] = ll