Refactored vacuum to use pb33f shared libraries

pb33f is now the source of truth for low level, shared models and concepts. The Resolver, Index and generic utilities have all been moved out. This means a smaller codebase for vacuum, and less moving parts for the application to manage. It will now become a sister of princess beef.
daveshanley · Jul 18, 2022 · 1b726e7 · 1b726e7
1 parent 81c92eb
commit 1b726e7
Show file tree

Hide file tree

Showing 134 changed files with 493 additions and 4,364 deletions.
diff --git a/cmd/dashboard.go b/cmd/dashboard.go
@@ -9,6 +9,8 @@ import (
 	"github.com/daveshanley/vacuum/model"
 	"github.com/daveshanley/vacuum/motor"
 	vacuum_report "github.com/daveshanley/vacuum/vacuum-report"
+	"github.com/pb33f/libopenapi/datamodel"
+	"github.com/pb33f/libopenapi/index"
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v3"
@@ -37,8 +39,8 @@ func GetDashboardCommand() *cobra.Command {
 
 			var resultSet *model.RuleResultSet
 			var ruleset *motor.RuleSetExecutionResult
-			var specIndex *model.SpecIndex
-			var specInfo *model.SpecInfo
+			var specIndex *index.SpecIndex
+			var specInfo *datamodel.SpecInfo
 
 			// if we have a pre-compiled report, jump straight to the end and collect $500
 			if vacuumReport == nil {
@@ -65,7 +67,7 @@ func GetDashboardCommand() *cobra.Command {
 					pterm.Println()
 					return err
 				}
-				specIndex = model.NewSpecIndex(&rootNode)
+				specIndex = index.NewSpecIndex(&rootNode)
 				specInfo = vacuumReport.SpecInfo
 				specInfo.Generated = vacuumReport.Generated
 			}

diff --git a/cmd/html_report.go b/cmd/html_report.go
@@ -11,6 +11,8 @@ import (
 	"github.com/daveshanley/vacuum/motor"
 	"github.com/daveshanley/vacuum/statistics"
 	vacuum_report "github.com/daveshanley/vacuum/vacuum-report"
+	"github.com/pb33f/libopenapi/datamodel"
+	"github.com/pb33f/libopenapi/index"
 	"github.com/pterm/pterm"
 	"github.com/spf13/cobra"
 	"io/ioutil"
@@ -55,8 +57,8 @@ func GetHTMLReportCommand() *cobra.Command {
 
 			var resultSet *model.RuleResultSet
 			var ruleset *motor.RuleSetExecutionResult
-			var specIndex *model.SpecIndex
-			var specInfo *model.SpecInfo
+			var specIndex *index.SpecIndex
+			var specInfo *datamodel.SpecInfo
 			var stats *reports.ReportStatistics
 
 			// if we have a pre-compiled report, jump straight to the end and collect $500

diff --git a/cui/dashboard.go b/cui/dashboard.go
@@ -4,6 +4,8 @@ import (
 	"github.com/daveshanley/vacuum/model"
 	ui "github.com/gizak/termui/v3"
 	"github.com/gizak/termui/v3/widgets"
+	"github.com/pb33f/libopenapi/datamodel"
+	"github.com/pb33f/libopenapi/index"
 )
 
 // Dashboard represents the dashboard controlling container
@@ -17,8 +19,8 @@ type Dashboard struct {
 	healthGaugeItems            []ui.GridItem
 	categoryHealthGauge         []CategoryGauge
 	resultSet                   *model.RuleResultSet
-	index                       *model.SpecIndex
-	info                        *model.SpecInfo
+	index                       *index.SpecIndex
+	info                        *datamodel.SpecInfo
 	selectedTabIndex            int
 	ruleCategories              []*model.RuleCategory
 	selectedCategory            *model.RuleCategory
@@ -32,7 +34,7 @@ type Dashboard struct {
 	uiEvents                    <-chan ui.Event
 }
 
-func CreateDashboard(resultSet *model.RuleResultSet, index *model.SpecIndex, info *model.SpecInfo) *Dashboard {
+func CreateDashboard(resultSet *model.RuleResultSet, index *index.SpecIndex, info *datamodel.SpecInfo) *Dashboard {
 	db := new(Dashboard)
 	db.resultSet = resultSet
 	db.index = index

diff --git a/cui/dashboard_test.go b/cui/dashboard_test.go
@@ -8,6 +8,8 @@ import (
 	"github.com/daveshanley/vacuum/motor"
 	"github.com/daveshanley/vacuum/rulesets"
 	ui "github.com/gizak/termui/v3"
+	"github.com/pb33f/libopenapi/datamodel"
+	"github.com/pb33f/libopenapi/index"
 	"github.com/stretchr/testify/assert"
 	"gopkg.in/yaml.v3"
 	"io/ioutil"
@@ -111,14 +113,14 @@ func TestDashboard_Render(t *testing.T) {
 	//}
 }
 
-func testBootDashboard() (*model.RuleResultSet, *model.SpecIndex, *model.SpecInfo) {
+func testBootDashboard() (*model.RuleResultSet, *index.SpecIndex, *datamodel.SpecInfo) {
 	var rootNode yaml.Node
 	yamlBytes, _ := ioutil.ReadFile("../model/test_files/burgershop.openapi.yaml")
 
-	info, _ := model.ExtractSpecInfo(yamlBytes)
+	info, _ := datamodel.ExtractSpecInfo(yamlBytes)
 
 	yaml.Unmarshal(yamlBytes, &rootNode)
-	index := model.NewSpecIndex(&rootNode)
+	index := index.NewSpecIndex(&rootNode)
 
 	// let's go ahead and lint the spec and pass the results to the dashboard.
 	defaultRuleSets := rulesets.BuildDefaultRuleSets()

diff --git a/cui/stats_chart.go b/cui/stats_chart.go
@@ -2,9 +2,10 @@ package cui
 
 import (
 	"fmt"
-	"github.com/daveshanley/vacuum/model"
 	ui "github.com/gizak/termui/v3"
 	"github.com/gizak/termui/v3/widgets"
+	"github.com/pb33f/libopenapi/datamodel"
+	"github.com/pb33f/libopenapi/index"
 )
 
 // StatsChart represents a bar chart showing statistics of the specification.
@@ -13,7 +14,7 @@ type StatsChart struct {
 }
 
 // NewStatsChart returns a new gauge widget that is ready to render
-func NewStatsChart(index *model.SpecIndex, info *model.SpecInfo) StatsChart {
+func NewStatsChart(index *index.SpecIndex, info *datamodel.SpecInfo) StatsChart {
 	bc := widgets.NewList()
 
 	//paramCount := len(index.GetAllParameters()) index. + len(index.GetAllParametersFromOperations())

diff --git a/cui/stats_chart_test.go b/cui/stats_chart_test.go
@@ -4,7 +4,8 @@
 package cui
 
 import (
-	"github.com/daveshanley/vacuum/model"
+	"github.com/pb33f/libopenapi/datamodel"
+	"github.com/pb33f/libopenapi/index"
 	"github.com/stretchr/testify/assert"
 	"gopkg.in/yaml.v3"
 	"io/ioutil"
@@ -15,9 +16,9 @@ func TestNewStatsChart(t *testing.T) {
 	var rootNode yaml.Node
 	yamlBytes, _ := ioutil.ReadFile("../model/test_files/burgershop.openapi.yaml")
 
-	info, _ := model.ExtractSpecInfo(yamlBytes)
+	info, _ := datamodel.ExtractSpecInfo(yamlBytes)
 	yaml.Unmarshal(yamlBytes, &rootNode)
-	index := model.NewSpecIndex(&rootNode)
+	index := index.NewSpecIndex(&rootNode)
 
 	chart := NewStatsChart(index, info)
 

diff --git a/functions/core/alphabetical.go b/functions/core/alphabetical.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 	"sort"
 	"strconv"

diff --git a/functions/core/alphabetical_test.go b/functions/core/alphabetical_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/casing.go b/functions/core/casing.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 	"regexp"
 	"strconv"

diff --git a/functions/core/casing_test.go b/functions/core/casing_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	gen_utils "github.com/daveshanley/vacuum/utils"
+	gen_utils "github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/defined.go b/functions/core/defined.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 )
 

diff --git a/functions/core/defined_test.go b/functions/core/defined_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/enumeration.go b/functions/core/enumeration.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 	"strings"
 )

diff --git a/functions/core/enumeration_test.go b/functions/core/enumeration_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/falsy.go b/functions/core/falsy.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 )
 

diff --git a/functions/core/falsy_test.go b/functions/core/falsy_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/length.go b/functions/core/length.go
@@ -5,7 +5,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 	"strconv"
 )

diff --git a/functions/core/length_test.go b/functions/core/length_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/pattern.go b/functions/core/pattern.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 	"regexp"
 )

diff --git a/functions/core/pattern_test.go b/functions/core/pattern_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/schema.go b/functions/core/schema.go
@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
 	"github.com/daveshanley/vacuum/parser"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 )
 

diff --git a/functions/core/schema_test.go b/functions/core/schema_test.go
@@ -3,7 +3,7 @@ package core
 import (
 	"github.com/daveshanley/vacuum/model"
 	"github.com/daveshanley/vacuum/parser"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/truthy.go b/functions/core/truthy.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 )
 

diff --git a/functions/core/truthy_test.go b/functions/core/truthy_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/undefined.go b/functions/core/undefined.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 )
 

diff --git a/functions/core/undefined_test.go b/functions/core/undefined_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/core/xor.go b/functions/core/xor.go
@@ -6,7 +6,7 @@ package core
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 	"strings"
 )

diff --git a/functions/core/xor_test.go b/functions/core/xor_test.go
@@ -2,7 +2,7 @@ package core
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )

diff --git a/functions/openapi/component_descriptions.go b/functions/openapi/component_descriptions.go
@@ -6,7 +6,7 @@ package openapi
 import (
 	"fmt"
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"gopkg.in/yaml.v3"
 	"strconv"
 	"strings"

diff --git a/functions/openapi/component_descriptions_test.go b/functions/openapi/component_descriptions_test.go
@@ -2,7 +2,7 @@ package openapi
 
 import (
 	"github.com/daveshanley/vacuum/model"
-	"github.com/daveshanley/vacuum/utils"
+	"github.com/pb33f/libopenapi/utils"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )