improves tests for mermaidjs renderPathToComponent

Author: timbastin

Makefile

@@ -7,7 +7,7 @@ clean::
 	docker compose down -v && docker compose up -d
 
 mocks::
-	mockery --config=.mockery.yaml 
+	mockery --config=.mockery.yaml
 
 lint::
 	golangci-lint run ./...

internal/core/integrations/github_integration.go

@@ -666,7 +666,7 @@ func (g *githubIntegration) CreateIssue(ctx context.Context, asset models.Asset,
 
 	assetSlug := asset.Slug
 	labels := getLabels(&dependencyVuln, "open")
-	componentTree, err := RenderPathToComponent(g.componentRepository, asset.ID, assetVersionName, dependencyVuln.ScannerID, exp.AffectedComponentName)
+	componentTree, err := renderPathToComponent(g.componentRepository, asset.ID, assetVersionName, dependencyVuln.ScannerID, exp.AffectedComponentName)
 	if err != nil {
 		return err
 	}

internal/core/integrations/gitlab_integration.go

@@ -111,7 +111,7 @@ func NewGitLabIntegration(db core.DB) *gitlabIntegration {
 	assetRepository := repositories.NewAssetRepository(db)
 	assetVersionRepository := repositories.NewAssetVersionRepository(db)
 	projectRepository := repositories.NewProjectRepository(db)
-	componentRepositoy := repositories.NewComponentRepository(db)
+	componentRepository := repositories.NewComponentRepository(db)
 
 	frontendUrl := os.Getenv("FRONTEND_URL")
 	if frontendUrl == "" {
@@ -128,7 +128,7 @@ func NewGitLabIntegration(db core.DB) *gitlabIntegration {
 		assetVersionRepository:      assetVersionRepository,
 		externalUserRepository:      externalUserRepository,
 		projectRepository:           projectRepository,
-		componentRepository:         componentRepositoy,
+		componentRepository:         componentRepository,
 
 		gitlabClientFactory: func(id uuid.UUID) (gitlabClientFacade, error) {
 			integration, err := gitlabIntegrationRepository.Read(id)
@@ -1043,7 +1043,7 @@ func (g *gitlabIntegration) CreateIssue(ctx context.Context, asset models.Asset,
 
 	assetSlug := asset.Slug
 	labels := getLabels(&dependencyVuln, "open")
-	componentTree, err := RenderPathToComponent(g.componentRepository, asset.ID, assetVersionName, dependencyVuln.ScannerID, exp.AffectedComponentName)
+	componentTree, err := renderPathToComponent(g.componentRepository, asset.ID, assetVersionName, dependencyVuln.ScannerID, exp.AffectedComponentName)
 	if err != nil {
 		return err
 	}

internal/core/integrations/thirdparty_integration.go

@@ -161,7 +161,7 @@ func NewThirdPartyIntegrations(integrations ...core.ThirdPartyIntegration) *thir
 }
 
 // this function returns a string containing a mermaids js flow chart to the given pURL
-func RenderPathToComponent(componentRepository core.ComponentRepository, assetID uuid.UUID, assetVersionName string, scannerID string, pURL string) (string, error) {
+func renderPathToComponent(componentRepository core.ComponentRepository, assetID uuid.UUID, assetVersionName string, scannerID string, pURL string) (string, error) {
 
 	//basic string to tell markdown that we have a mermaid flow chart with given parameters
 	mermaidFlowChart := "mermaid \n %%{init: { 'theme':'dark' } }%%\n flowchart TD\n"
@@ -191,7 +191,7 @@ func RenderPathToComponent(componentRepository core.ComponentRepository, assetID
 
 	for i, componentName := range componentList[1:] {
 
-		nodeContent, err = BeautifyPURL(componentName)
+		nodeContent, err = beautifyPURL(componentName)
 		if err != nil {
 			nodeContent = componentName
 		}
@@ -204,8 +204,7 @@ func RenderPathToComponent(componentRepository core.ComponentRepository, assetID
 }
 
 // function to make purl look more visually appealing
-func BeautifyPURL(pURL string) (string, error) {
-
+func beautifyPURL(pURL string) (string, error) {
 	p, err := packageurl.FromString(pURL)
 	if err != nil {
 		slog.Error("cannot convert to purl struct")
@@ -217,5 +216,4 @@ func BeautifyPURL(pURL string) (string, error) {
 	} else {
 		return p.Namespace + "/" + p.Name, nil
 	}
-
 }

internal/core/integrations/thirdparty_integration_test.go

@@ -1,11 +1,10 @@
-package integrations_test
+package integrations
 
 import (
 	"fmt"
 	"testing"
 
 	"github.com/google/uuid"
-	"github.com/l3montree-dev/devguard/internal/core/integrations"
 	"github.com/l3montree-dev/devguard/internal/database/models"
 	"github.com/l3montree-dev/devguard/internal/utils"
 	"github.com/l3montree-dev/devguard/mocks"
@@ -14,7 +13,7 @@ import (
 )
 
 func TestRenderPathToComponent(t *testing.T) {
-	t.Run("Everythings works as expected with empty lists", func(t *testing.T) {
+	t.Run("Everything works as expected with empty lists", func(t *testing.T) {
 
 		components := []models.ComponentDependency{}
 		componentRepository := mocks.NewCoreComponentRepository(t)
@@ -25,7 +24,7 @@ func TestRenderPathToComponent(t *testing.T) {
 		scannerID := "SBOM-File-Upload"
 		pURL := "pkg:npm:test"
 
-		result, err := integrations.RenderPathToComponent(componentRepository, assetID, assetVersionName, scannerID, pURL)
+		result, err := renderPathToComponent(componentRepository, assetID, assetVersionName, scannerID, pURL)
 		if err != nil {
 			t.Fail()
 		}
@@ -42,15 +41,15 @@ func TestRenderPathToComponent(t *testing.T) {
 		scannerID := "SBOM-File-Upload"
 		pURL := "pkg:npm:test"
 
-		_, err := integrations.RenderPathToComponent(componentRepository, assetID, assetVersionName, scannerID, pURL)
+		_, err := renderPathToComponent(componentRepository, assetID, assetVersionName, scannerID, pURL)
 		if err == nil {
 			t.Fail()
 		}
 
 	})
 	t.Run("Everything works as expeted with a non empty component list", func(t *testing.T) {
 		components := []models.ComponentDependency{
-			{ComponentPurl: utils.Ptr("testPURL"), DependencyPurl: "testDependency"},
+			{ComponentPurl: nil, DependencyPurl: "testDependency"}, // root --> testDependency
 			{ComponentPurl: utils.Ptr("testomatL"), DependencyPurl: "testPURL"},
 			{ComponentPurl: utils.Ptr("testDependency"), DependencyPurl: "testPURL"},
 		}
@@ -62,37 +61,36 @@ func TestRenderPathToComponent(t *testing.T) {
 		scannerID := "SBOM-File-Upload"
 		pURL := "pkg:npm:test"
 
-		result, err := integrations.RenderPathToComponent(componentRepository, assetID, assetVersionName, scannerID, pURL)
+		result, err := renderPathToComponent(componentRepository, assetID, assetVersionName, scannerID, pURL)
 		if err != nil {
 			t.Fail()
 		}
 
 		//String for the empty graph + 1 node being root with a linebreak
-		assert.Equal(t, "```mermaid \n %%{init: { 'theme':'dark' } }%%\n flowchart TD\nroot\n```\n", result)
+		assert.Equal(t, "```mermaid \n %%{init: { 'theme':'dark' } }%%\n flowchart TD\nroot --> \nnode0[testDependency] --> \nnode1[testPURL]\n```\n", result)
 
 	})
 }
 
 func TestBeautifyPURL(t *testing.T) {
 	t.Run("empty String should also return an empty string back", func(t *testing.T) {
 		inputString := ""
-		result, _ := integrations.BeautifyPURL(inputString)
+		result, _ := beautifyPURL(inputString)
 		assert.Equal(t, "", result)
 	})
 	t.Run("invalid purl format should also be returned unchanged", func(t *testing.T) {
 		inputString := "this is definitely not a valid purl"
-		result, _ := integrations.BeautifyPURL(inputString)
+		result, _ := beautifyPURL(inputString)
 		assert.Equal(t, inputString, result)
 	})
 	t.Run("should return only the namespace and the name of a valid purl and cut the rest", func(t *testing.T) {
 		inputString := "pkg:npm/@ory/integrations@v0.0.1"
-		result, _ := integrations.BeautifyPURL(inputString)
+		result, _ := beautifyPURL(inputString)
 		assert.Equal(t, "@ory/integrations", result)
 	})
 	t.Run("should return no leading slash if the namespace is empty", func(t *testing.T) {
 		inputString := "pkg:npm/integrations@v0.0.1"
-		result, _ := integrations.BeautifyPURL(inputString)
+		result, _ := beautifyPURL(inputString)
 		assert.Equal(t, "integrations", result)
 	})
-
 }