From 5e78751e906900341918e84dbd262f2e0b3246a2 Mon Sep 17 00:00:00 2001
From: Nathaniel Brough <nathaniel.brough@gmail.com>
Date: Thu, 19 Jan 2023 12:16:00 -0800
Subject: [PATCH] fuzz: Make goldmark compatible with OSS-Fuzz

This set of changes will make goldmark compatible with the fuzzing
requirements for google/oss-fuzz, a continuous fuzzing service.
To ensure compatibility this change adds;
- A seperate fuzzing target that doesn't use the builtin fuzz corpus
- A tool to convert the builtin fuzz corpus to a zip file corpus
  that is compatible with oss-fuzz
---
 _tools/build-oss-fuzz-corpus.go | 61 +++++++++++++++++++++++++++++++++
 fuzz/fuzz_test.go               | 29 +++++++++-------
 fuzz/oss_fuzz_test.go           |  9 +++++
 3 files changed, 86 insertions(+), 13 deletions(-)
 create mode 100644 _tools/build-oss-fuzz-corpus.go
 create mode 100644 fuzz/oss_fuzz_test.go

diff --git a/_tools/build-oss-fuzz-corpus.go b/_tools/build-oss-fuzz-corpus.go
new file mode 100644
index 0000000..bc6b010
--- /dev/null
+++ b/_tools/build-oss-fuzz-corpus.go
@@ -0,0 +1,61 @@
+package main
+
+import (
+	"archive/zip"
+	"encoding/json"
+	"io/ioutil"
+	"log"
+	"os"
+	"strconv"
+	"strings"
+)
+
+type TestCase struct {
+	Example  int    `json:"example"`
+	Markdown string `json:"markdown"`
+}
+
+func main() {
+	corpus_out := os.Args[1]
+	if !strings.HasSuffix(corpus_out, ".zip") {
+		log.Fatalln("Expected command line:", os.Args[0], "<corpus_output>.zip")
+	}
+
+	zip_file, err := os.Create(corpus_out)
+
+	zip_writer := zip.NewWriter(zip_file)
+
+	if err != nil {
+		log.Fatalln("Failed creating file:", err)
+	}
+
+	json_corpus := "_test/spec.json"
+	bs, err := ioutil.ReadFile(json_corpus)
+	if err != nil {
+		log.Fatalln("Could not open file:", json_corpus)
+		panic(err)
+	}
+	var testCases []TestCase
+	if err := json.Unmarshal(bs, &testCases); err != nil {
+		panic(err)
+	}
+
+	for _, c := range testCases {
+		file_in_zip := "example-" + strconv.Itoa(c.Example)
+		f, err := zip_writer.Create(file_in_zip)
+		if err != nil {
+			log.Fatal(err)
+		}
+		_, err = f.Write([]byte(c.Markdown))
+		if err != nil {
+			log.Fatalf("Failed to write file: %s into zip file", file_in_zip)
+		}
+	}
+
+	err = zip_writer.Close()
+	if err != nil {
+		log.Fatal("Failed to close zip writer", err)
+	}
+
+	zip_file.Close()
+}
\ No newline at end of file
diff --git a/fuzz/fuzz_test.go b/fuzz/fuzz_test.go
index 9c9483a..7f07302 100644
--- a/fuzz/fuzz_test.go
+++ b/fuzz/fuzz_test.go
@@ -13,19 +13,7 @@ import (
 	"github.com/yuin/goldmark/util"
 )
 
-func Fuzz(f *testing.F) {
-	bs, err := ioutil.ReadFile("../_test/spec.json")
-	if err != nil {
-		panic(err)
-	}
-	var testCases []map[string]interface{}
-	if err := json.Unmarshal(bs, &testCases); err != nil {
-		panic(err)
-	}
-	for _, c := range testCases {
-		f.Add(c["markdown"])
-	}
-
+func fuzz(f *testing.F) {
 	f.Fuzz(func(t *testing.T, orig string) {
 		markdown := goldmark.New(
 			goldmark.WithParserOptions(
@@ -52,3 +40,18 @@ func Fuzz(f *testing.F) {
 		}
 	})
 }
+
+func FuzzDefault(f *testing.F) {
+	bs, err := ioutil.ReadFile("../_test/spec.json")
+	if err != nil {
+		panic(err)
+	}
+	var testCases []map[string]interface{}
+	if err := json.Unmarshal(bs, &testCases); err != nil {
+		panic(err)
+	}
+	for _, c := range testCases {
+		f.Add(c["markdown"])
+	}
+	fuzz(f)
+}
diff --git a/fuzz/oss_fuzz_test.go b/fuzz/oss_fuzz_test.go
new file mode 100644
index 0000000..e686e8a
--- /dev/null
+++ b/fuzz/oss_fuzz_test.go
@@ -0,0 +1,9 @@
+package fuzz
+
+import (
+	"testing"
+)
+
+func FuzzOss(f *testing.F) {
+	fuzz(f)
+}