Merge pull request #1484 from VaibhavMalik4187/core-core-tests

Added Test Suite for core/core Package

core/core/kscore_test.go

@@ -0,0 +1,23 @@
+package core
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// The function should return a non-nil pointer.
+func TestNewKubescape_ReturnsNonNilPointer(t *testing.T) {
+	k := NewKubescape()
+	assert.NotNil(t, k)
+}
+
+// The function should not panic.
+func TestNewKubescape_DoesNotPanic(t *testing.T) {
+	defer func() {
+		if r := recover(); r != nil {
+			t.Errorf("Function panicked: %v", r)
+		}
+	}()
+	NewKubescape()
+}

core/core/list_test.go

@@ -0,0 +1,255 @@
+package core
+
+import (
+	"context"
+	"encoding/json"
+	"io"
+	"os"
+	"sort"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// Function receives a non-empty list of policies
+func TestNonEmptyListOfPolicies(t *testing.T) {
+	policies := []string{"policy1", "policy2", "policy3"}
+
+	// Redirect stdout to a buffer
+	rescueStdout := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w
+
+	jsonListFormat(context.Background(), "", policies)
+
+	w.Close()
+	got, _ := io.ReadAll(r)
+	os.Stdout = rescueStdout
+
+	// got := buf.String()
+	want := `[
+  "policy1",
+  "policy2",
+  "policy3"
+]
+`
+	assert.Equal(t, want, string(got))
+}
+
+// Function returns a valid JSON string
+func TestValidJsonString(t *testing.T) {
+	policies := []string{"policy1", "policy2", "policy3"}
+
+	// Redirect stdout to a buffer
+	rescueStdout := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w
+
+	jsonListFormat(context.Background(), "", policies)
+
+	w.Close()
+	out, _ := io.ReadAll(r)
+	os.Stdout = rescueStdout
+
+	var result []string
+	err := json.Unmarshal(out, &result)
+	assert.NoError(t, err)
+}
+
+// Function receives an empty list of policies
+func TestEmptyListOfPolicies(t *testing.T) {
+	policies := []string{}
+
+	// Redirect stdout to a buffer
+	rescueStdout := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w
+
+	jsonListFormat(context.Background(), "", policies)
+
+	w.Close()
+	got, _ := io.ReadAll(r)
+	os.Stdout = rescueStdout
+
+	want := "[]\n"
+
+	assert.Equal(t, want, string(got))
+}
+
+// Function receives a nil list of policies
+func TestNilListOfPolicies(t *testing.T) {
+	// Redirect stdout to a buffer
+	rescueStdout := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w
+
+	jsonListFormat(context.Background(), "", nil)
+
+	w.Close()
+	got, _ := io.ReadAll(r)
+	os.Stdout = rescueStdout
+
+	want := "null\n"
+
+	assert.Equal(t, want, string(got))
+}
+
+// Returns a 2D slice with one row for each policy in the input slice.
+func TestGeneratePolicyRows_NonEmptyPolicyList(t *testing.T) {
+	// Arrange
+	policies := []string{"policy1", "policy2", "policy3"}
+
+	// Act
+	result := generatePolicyRows(policies)
+
+	// Assert
+	assert.Equal(t, [][]string{{"policy1"}, {"policy2"}, {"policy3"}}, result)
+}
+
+// Returns an empty 2D slice for an empty list of policies.
+func TestGeneratePolicyRows_EmptyPolicyList(t *testing.T) {
+	// Arrange
+	policies := []string{}
+
+	// Act
+	got := generatePolicyRows(policies)
+
+	// Assert
+	assert.Empty(t, got)
+}
+
+// The function returns a list of rows, each containing a formatted string with control ID, control name, docs, and frameworks.
+func TestShortFormatControlRows_ReturnsListOfRowsWithFormattedString(t *testing.T) {
+	controlRows := [][]string{
+		{"ID1", "Control 1", "Docs 1", "Framework 1"},
+		{"ID2", "Control 2", "Docs 2", "Framework 2"},
+	}
+
+	want := [][]string{
+		{"Control ID   : ID1\nControl Name : Control 1\nDocs         : Docs 1\nFrameworks   : Framework 1"},
+		{"Control ID   : ID2\nControl Name : Control 2\nDocs         : Docs 2\nFrameworks   : Framework 2"},
+	}
+
+	got := shortFormatControlRows(controlRows)
+
+	assert.Equal(t, want, got)
+}
+
+// The function formats the control rows correctly, replacing newlines in the frameworks column with line breaks.
+func TestShortFormatControlRows_FormatsControlRowsCorrectly(t *testing.T) {
+	controlRows := [][]string{
+		{"ID1", "Control 1", "Docs 1", "Framework\n1"},
+		{"ID2", "Control 2", "Docs 2", "Framework\n2"},
+	}
+
+	want := [][]string{
+		{"Control ID   : ID1\nControl Name : Control 1\nDocs         : Docs 1\nFrameworks   : Framework 1"},
+		{"Control ID   : ID2\nControl Name : Control 2\nDocs         : Docs 2\nFrameworks   : Framework 2"},
+	}
+
+	result := shortFormatControlRows(controlRows)
+
+	assert.Equal(t, want, result)
+}
+
+// The function handles a control row with an empty control ID.
+func TestShortFormatControlRows_HandlesControlRowWithEmptyControlID(t *testing.T) {
+	controlRows := [][]string{
+		{"", "Control 1", "Docs 1", "Framework 1"},
+	}
+
+	want := [][]string{
+		{"Control ID   : \nControl Name : Control 1\nDocs         : Docs 1\nFrameworks   : Framework 1"},
+	}
+
+	got := shortFormatControlRows(controlRows)
+
+	assert.Equal(t, want, got)
+}
+
+// The function handles a control row with an empty control name.
+func TestShortFormatControlRows_HandlesControlRowWithEmptyControlName(t *testing.T) {
+	controlRows := [][]string{
+		{"ID1", "", "Docs 1", "Framework 1"},
+	}
+
+	want := [][]string{
+		{"Control ID   : ID1\nControl Name : \nDocs         : Docs 1\nFrameworks   : Framework 1"},
+	}
+
+	got := shortFormatControlRows(controlRows)
+
+	assert.Equal(t, want, got)
+}
+
+// Generates rows for each policy with ID, control, documentation, and framework
+func TestGenerateControlRowsWithAllFields(t *testing.T) {
+	policies := []string{
+		"1|Control 1|Framework 1",
+		"2|Control 2|Framework 2",
+		"3|Control 3|Framework 3",
+	}
+
+	want := [][]string{
+		{"1", "Control 1", "https://hub.armosec.io/docs/1", "Framework\n1"},
+		{"2", "Control 2", "https://hub.armosec.io/docs/2", "Framework\n2"},
+		{"3", "Control 3", "https://hub.armosec.io/docs/3", "Framework\n3"},
+	}
+
+	got := generateControlRows(policies)
+
+	assert.Equal(t, want, got)
+}
+
+// The function generates a table with the correct headers and rows based on the input policies.
+func TestGenerateTableWithCorrectHeadersAndRows(t *testing.T) {
+	// Arrange
+	ctx := context.Background()
+	policies := []string{
+		"1|Control 1|Framework 1",
+		"2|Control 2|Framework 2",
+		"3|Control 3|Framework 3",
+	}
+
+	// Redirect stdout to a buffer
+	rescueStdout := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w
+
+	prettyPrintControls(ctx, policies)
+
+	w.Close()
+	got, _ := io.ReadAll(r)
+	os.Stdout = rescueStdout
+
+	// got := buf.String()
+	want := `┌────────────┬──────────────┬───────────────────────────────┬────────────┐
+│ Control ID │ Control name │ Docs                          │ Frameworks │
+├────────────┼──────────────┼───────────────────────────────┼────────────┤
+│          1 │ Control 1    │ https://hub.armosec.io/docs/1 │ Framework  │
+│            │              │                               │          1 │
+├────────────┼──────────────┼───────────────────────────────┼────────────┤
+│          2 │ Control 2    │ https://hub.armosec.io/docs/2 │ Framework  │
+│            │              │                               │          2 │
+├────────────┼──────────────┼───────────────────────────────┼────────────┤
+│          3 │ Control 3    │ https://hub.armosec.io/docs/3 │ Framework  │
+│            │              │                               │          3 │
+└────────────┴──────────────┴───────────────────────────────┴────────────┘
+`
+
+	assert.Equal(t, want, string(got))
+}
+
+// Returns a non-empty list of supported actions when 'ListSupportActions' is called.
+func TestListSupportActionsNotEmpty(t *testing.T) {
+	actions := ListSupportActions()
+	assert.NotEmpty(t, actions)
+}
+
+func TestListSupportActionsReturnsSupportedActions(t *testing.T) {
+	got := ListSupportActions()
+	want := []string{"controls", "exceptions", "frameworks"}
+	sort.Strings(got)
+
+	assert.Equal(t, want, got)
+}

core/core/patch_test.go

@@ -0,0 +1,15 @@
+package core
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+// sets os.Stdout and os.Stderr to nil
+func TestSetsOsStdoutAndStderrToNil(t *testing.T) {
+	disableCopaLogger()
+	assert.Nil(t, os.Stdout)
+	assert.Nil(t, os.Stderr)
+}

core/core/scan_test.go

@@ -0,0 +1,46 @@
+package core
+
+import (
+	"testing"
+
+	"github.com/kubescape/kubescape/v3/core/cautils"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestIsPrioritizationScanType(t *testing.T) {
+	tests := []struct {
+		name cautils.ScanTypes
+		want bool
+	}{
+		{
+			name: cautils.ScanTypeCluster,
+			want: true,
+		},
+		{
+			name: cautils.ScanTypeRepo,
+			want: true,
+		},
+		{
+			name: cautils.ScanTypeImage,
+			want: false,
+		},
+		{
+			name: cautils.ScanTypeWorkload,
+			want: false,
+		},
+		{
+			name: cautils.ScanTypeFramework,
+			want: false,
+		},
+		{
+			name: cautils.ScanTypeControl,
+			want: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(string(tt.name), func(t *testing.T) {
+			assert.Equal(t, tt.want, isPrioritizationScanType(tt.name))
+		})
+	}
+}