Multiple updates

cmd/build_results.go

@@ -8,7 +8,11 @@ import (
 	"os"
 )
 
-func BuildResults(rulesetFlag string, specBytes []byte, customFunctions map[string]model.RuleFunction) (*model.RuleResultSet, *motor.RuleSetExecutionResult, error) {
+func BuildResults(
+	rulesetFlag string,
+	specBytes []byte,
+	customFunctions map[string]model.RuleFunction,
+	base string) (*model.RuleResultSet, *motor.RuleSetExecutionResult, error) {
 
 	// read spec and parse
 	defaultRuleSets := rulesets.BuildDefaultRuleSets()
@@ -36,6 +40,7 @@ func BuildResults(rulesetFlag string, specBytes []byte, customFunctions map[stri
 		RuleSet:         selectedRS,
 		Spec:            specBytes,
 		CustomFunctions: customFunctions,
+		Base:            base,
 	})
 
 	resultSet := model.NewRuleResultSet(ruleset.Results)

cmd/build_results_test.go

@@ -6,6 +6,6 @@ import (
 )
 
 func TestBuildResults(t *testing.T) {
-	_, _, err := BuildResults("nuggets", nil, nil)
+	_, _, err := BuildResults("nuggets", nil, nil, "")
 	assert.Error(t, err)
 }

cmd/dashboard.go

@@ -14,6 +14,7 @@ import (
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v3"
+	"net/url"
 	"time"
 )
 
@@ -39,6 +40,7 @@ func GetDashboardCommand() *cobra.Command {
 				pterm.Println()
 				return errors.New(errText)
 			}
+			baseFlag, _ := cmd.Flags().GetString("base")
 
 			var err error
 			vacuumReport, specBytes, _ := vacuum_report.BuildVacuumReportFromFile(args[0])
@@ -59,7 +61,7 @@ func GetDashboardCommand() *cobra.Command {
 				customFunctions, _ := LoadCustomFunctions(functionsFlag)
 
 				rulesetFlag, _ := cmd.Flags().GetString("ruleset")
-				resultSet, ruleset, err = BuildResults(rulesetFlag, specBytes, customFunctions)
+				resultSet, ruleset, err = BuildResults(rulesetFlag, specBytes, customFunctions, baseFlag)
 				if err != nil {
 					pterm.Error.Printf("Failed to render dashboard: %v\n\n", err)
 					return err
@@ -82,7 +84,19 @@ func GetDashboardCommand() *cobra.Command {
 					return err
 				}
 
-				config := index.CreateOpenAPIIndexConfig()
+				config := index.CreateClosedAPIIndexConfig()
+				if baseFlag != "" {
+					u, e := url.Parse(baseFlag)
+					if e == nil && u.Scheme != "" && u.Host != "" {
+						config.BaseURL = u
+						config.BasePath = ""
+					} else {
+						config.BasePath = baseFlag
+					}
+					config.AllowFileLookup = true
+					config.AllowRemoteLookup = true
+				}
+
 				specIndex = index.NewSpecIndexWithConfig(&rootNode, config)
 
 				specInfo = vacuumReport.SpecInfo

cmd/html_report.go

@@ -43,6 +43,7 @@ func GetHTMLReportCommand() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 
 			noStyleFlag, _ := cmd.Flags().GetBool("no-style")
+			baseFlag, _ := cmd.Flags().GetString("base")
 
 			// disable color and styling, for CI/CD use.
 			// https://github.com/daveshanley/vacuum/issues/234
@@ -91,7 +92,7 @@ func GetHTMLReportCommand() *cobra.Command {
 				customFunctions, _ := LoadCustomFunctions(functionsFlag)
 
 				rulesetFlag, _ := cmd.Flags().GetString("ruleset")
-				resultSet, ruleset, err = BuildResults(rulesetFlag, specBytes, customFunctions)
+				resultSet, ruleset, err = BuildResults(rulesetFlag, specBytes, customFunctions, baseFlag)
 				if err != nil {
 					pterm.Error.Printf("Failed to generate report: %v\n\n", err)
 					return err

cmd/lint.go

@@ -43,6 +43,7 @@ func GetLintCommand() *cobra.Command {
 			functionsFlag, _ := cmd.Flags().GetString("functions")
 			failSeverityFlag, _ := cmd.Flags().GetString("fail-severity")
 			noStyleFlag, _ := cmd.Flags().GetBool("no-style")
+			baseFlag, _ := cmd.Flags().GetString("base")
 
 			// disable color and styling, for CI/CD use.
 			// https://github.com/daveshanley/vacuum/issues/234
@@ -106,6 +107,7 @@ func GetLintCommand() *cobra.Command {
 				RuleSet:         selectedRS,
 				Spec:            specBytes,
 				CustomFunctions: customFunctions,
+				Base:            baseFlag,
 			})
 
 			results := result.Results

cmd/root.go

@@ -51,6 +51,7 @@ func init() {
 	rootCmd.PersistentFlags().BoolP("time", "t", false, "Show how long vacuum took to run")
 	rootCmd.PersistentFlags().StringP("ruleset", "r", "", "Path to a spectral ruleset configuration")
 	rootCmd.PersistentFlags().StringP("functions", "f", "", "Path to custom functions")
+	rootCmd.PersistentFlags().StringP("base", "p", "", "Base URL or path to use for resolving relative or remote references")
 
 	regErr := rootCmd.RegisterFlagCompletionFunc("functions", cobra.FixedCompletions(
 		[]string{"so"}, cobra.ShellCompDirectiveFilterFileExt,

cmd/shared_functions.go

@@ -68,12 +68,11 @@ func CheckFailureSeverity(failSeverityFlag string, errors int, warnings int, inf
 	if failSeverityFlag != model.SeverityError {
 		switch failSeverityFlag {
 		case model.SeverityWarn:
-			if warnings > 0 {
+			if warnings > 0 || errors > 0 {
 				return fmt.Errorf("failed linting, with %d errors and %d warnings", errors, warnings)
 			}
-			return nil
 		case model.SeverityInfo:
-			if informs > 0 {
+			if informs > 0 || warnings > 0 || errors > 0 {
 				return fmt.Errorf("failed linting, with %d errors, %d warnings and %d informs",
 					errors, warnings, informs)
 			}

cmd/spectral_report.go

@@ -43,6 +43,7 @@ func GetSpectralReportCommand() *cobra.Command {
 			stdIn, _ := cmd.Flags().GetBool("stdin")
 			stdOut, _ := cmd.Flags().GetBool("stdout")
 			noStyleFlag, _ := cmd.Flags().GetBool("no-style")
+			baseFlag, _ := cmd.Flags().GetString("base")
 
 			// disable color and styling, for CI/CD use.
 			// https://github.com/daveshanley/vacuum/issues/234
@@ -133,6 +134,7 @@ func GetSpectralReportCommand() *cobra.Command {
 				Spec:            specBytes,
 				CustomFunctions: customFunctions,
 				SilenceLogs:     true,
+				Base:            baseFlag,
 			})
 
 			resultSet := model.NewRuleResultSet(ruleset.Results)

cmd/vacuum_report.go

@@ -42,6 +42,8 @@ func GetVacuumReportCommand() *cobra.Command {
 			stdIn, _ := cmd.Flags().GetBool("stdin")
 			stdOut, _ := cmd.Flags().GetBool("stdout")
 			noStyleFlag, _ := cmd.Flags().GetBool("no-style")
+			baseFlag, _ := cmd.Flags().GetString("base")
+			junitFlag, _ := cmd.Flags().GetBool("junit")
 
 			// disable color and styling, for CI/CD use.
 			// https://github.com/daveshanley/vacuum/issues/234
@@ -134,13 +136,38 @@ func GetVacuumReportCommand() *cobra.Command {
 				Spec:            specBytes,
 				CustomFunctions: customFunctions,
 				SilenceLogs:     true,
+				Base:            baseFlag,
 			})
 
 			resultSet := model.NewRuleResultSet(ruleset.Results)
 			resultSet.SortResultsByLineNumber()
 
 			duration := time.Since(start)
 
+			// if we want jUnit output, then build the report and be done with it.
+			if junitFlag {
+				junitXML := vacuum_report.BuildJUnitReport(resultSet, start)
+				if stdOut {
+					fmt.Print(string(junitXML))
+					return nil
+				} else {
+
+					reportOutputName := fmt.Sprintf("%s-%s%s",
+						reportOutput, time.Now().Format("01-02-06-15_04_05"), ".xml")
+
+					err := os.WriteFile(reportOutputName, junitXML, 0664)
+					if err != nil {
+						pterm.Error.Printf("Unable to write junit report file: '%s': %s\n", reportOutputName, err.Error())
+						pterm.Println()
+						return err
+					}
+
+					pterm.Success.Printf("JUnit Report generated for '%s', written to '%s'\n", args[0], reportOutputName)
+					pterm.Println()
+					return nil
+				}
+			}
+
 			// pre-render
 			resultSet.PrepareForSerialization(ruleset.SpecInfo)
 
@@ -208,6 +235,7 @@ func GetVacuumReportCommand() *cobra.Command {
 	}
 	cmd.Flags().BoolP("stdin", "i", false, "Use stdin as input, instead of a file")
 	cmd.Flags().BoolP("stdout", "o", false, "Use stdout as output, instead of a file")
+	cmd.Flags().BoolP("junit", "j", false, "Generate report in JUnit format (cannot be compressed)")
 	cmd.Flags().BoolP("compress", "c", false, "Compress results using gzip")
 	cmd.Flags().BoolP("no-pretty", "n", false, "Render JSON with no formatting")
 	cmd.Flags().BoolP("no-style", "q", false, "Disable styling and color output, just plain text (useful for CI/CD)")

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/gizak/termui/v3 v3.1.0
 	github.com/json-iterator/go v1.1.12
 	github.com/mitchellh/mapstructure v1.5.0
-	github.com/pb33f/libopenapi v0.6.1
+	github.com/pb33f/libopenapi v0.7.0
 	github.com/pterm/pterm v0.12.54
 	github.com/santhosh-tekuri/jsonschema/v5 v5.2.0
 	github.com/spf13/cobra v1.6.1

go.sum

@@ -124,6 +124,8 @@ github.com/pb33f/libopenapi v0.6.0 h1:omj3g89XbT/RaafrzdRQFEDsyLRZsnkV7Q+1zCEhFd
 github.com/pb33f/libopenapi v0.6.0/go.mod h1:lvUmCtjgHUGVj6WzN3I5/CS9wkXtyN3Ykjh6ZZP5lrI=
 github.com/pb33f/libopenapi v0.6.1 h1:AXnfXFVVK+bXgUeLYPJqLk8y/8Ow4Nercx1dabT2xog=
 github.com/pb33f/libopenapi v0.6.1/go.mod h1:lvUmCtjgHUGVj6WzN3I5/CS9wkXtyN3Ykjh6ZZP5lrI=
+github.com/pb33f/libopenapi v0.7.0 h1:2mQgDa0UQs8/5Hd2z+KbgWvoGx0++N3ihMKihcAS5Mw=
+github.com/pb33f/libopenapi v0.7.0/go.mod h1:lvUmCtjgHUGVj6WzN3I5/CS9wkXtyN3Ykjh6ZZP5lrI=
 github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=

html-report/ui/package.json

@@ -16,14 +16,14 @@
     "test:watch": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"wtr --watch\""
   },
   "devDependencies": {
-    "@open-wc/eslint-config": "^7.0.0",
+    "@open-wc/eslint-config": "^10.0.0",
     "@types/chart.js": "^2.9.37",
     "@typescript-eslint/eslint-plugin": "^5.38.1",
     "@typescript-eslint/parser": "^5.38.1",
     "@web/dev-server-esbuild": "^0.3.3",
-    "@web/test-runner": "^0.14.0",
+    "@web/test-runner": "^0.15.1",
     "@web/test-runner-commands": "^0.6.5",
-    "@web/test-runner-playwright": "^0.8.10",
+    "@web/test-runner-playwright": "^0.9.0",
     "copy-webpack-plugin": "^11.0.0",
     "eslint": "^8.23.0",
     "eslint-config-prettier": "^8.5.0",
@@ -34,18 +34,18 @@
     "mini-css-extract-plugin": "^2.6.1",
     "prettier": "^2.7.1",
     "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0",
+    "webpack-cli": "^5.0.1",
     "webpack-dev-server": "^4.11.1"
   },
   "dependencies": {
     "@open-wc/testing": "^3.1.7",
-    "chart.js": "^3.9.1",
+    "chart.js": "^4.2.1",
     "css-loader": "^6.7.1",
     "lit": "^2.4.1",
     "style-loader": "^3.3.1",
     "terminal.css": "^0.7.2",
     "ts-loader": "^9.4.1",
-    "typescript": "^4.9.3"
+    "typescript": "^5.0.2"
   },
   "eslintConfig": {
     "parser": "@typescript-eslint/parser",